]> git.rkrishnan.org Git - tahoe-lafs/tahoe-lafs.git/commitdiff
docs/configuration.txt: document nickname, no_storage, readonly_storage
authorBrian Warner <warner@allmydata.com>
Tue, 5 Feb 2008 21:33:29 +0000 (14:33 -0700)
committerBrian Warner <warner@allmydata.com>
Tue, 5 Feb 2008 21:33:29 +0000 (14:33 -0700)
docs/configuration.txt

index 74b298fc471f6b81ca516477bb51fc5e22f86a07..4ea28e2e3828564e5d1ea2b43f2667ae7e4c4193 100644 (file)
@@ -20,6 +20,10 @@ furl is created by the introducer node and written into its base directory
 when it starts, whereupon it should be published to everyone who wishes to
 attach a client to that grid
 
+nickname (optional): The contents of this file will be displayed in
+management tools as this node's "nickname". If the file doesn't exist, the
+nickname will be set to "<unspecified>".
+
 webport (optional): This controls where the client's webserver should listen,
 providing filesystem access as defined in webapi.txt . This file contains a
 Twisted "strports" specification (as defined in
@@ -55,6 +59,17 @@ for debugging.  To cause the node to accept SSH connections on port 8022,
 symlink "authorized_keys.8022" to your ~/.ssh/authorized_keys file, and it
 will accept the same keys as the rest of your account.
 
+no_storage (optional): If this file is present (the contents do not matter),
+the node will not run a storage server, meaning that no shares will be stored
+on this node. Use this for clients who do not wish to provide storage
+service.
+
+readonly_storage (optional): If this file is present (the contents do not
+matter), the node will run a storage server but will not accept any shares,
+making it effectively read-only. Use this for storage servers which are being
+decommissioned: the storage/ directory could be mounted read-only, while
+shares are moved to other servers.
+
 sizelimit (optional): If present, this file establishes an upper bound (in
 bytes) on the amount of storage consumed by share data (data that your node
 holds on behalf of clients that are uploading files to the grid). To avoid