X-Git-Url: https://git.rkrishnan.org/?a=blobdiff_plain;f=docs%2Fconfiguration.rst;h=f9179376a02c2ec9fa375e1b66f1f86d506accbd;hb=96eaca6a6dbea0f743694a9836993694f14b2f35;hp=ac75cca76cbbe476cd736f620e303a36b782988e;hpb=d349f0710b2216cbe854482fd3e95371490670d3;p=tahoe-lafs%2Ftahoe-lafs.git

diff --git a/docs/configuration.rst b/docs/configuration.rst
index ac75cca7..f9179376 100644
--- a/docs/configuration.rst
+++ b/docs/configuration.rst
@@ -396,6 +396,31 @@ Client Configuration
 .. _performance.rst: performance.rst
 .. _mutable.rst: specifications/mutable.rst
 
+``peers.preferred = (string, optional)``
+
+    This is an optional comma-separated list of Node IDs of servers that will
+    be tried first when selecting storage servers for reading or writing.
+
+    Servers should be identified here by their Node ID as it appears in the web
+    ui, underneath the server's nickname. For storage servers running tahoe
+    versions >=1.10 (if the introducer is also running tahoe >=1.10) this will
+    be a "Node Key" (which is prefixed with 'v0-'). For older nodes, it will be
+    a TubID instead. When a preferred server (and/or the introducer) is
+    upgraded to 1.10 or later, clients must adjust their configs accordingly.
+
+    Every node selected for upload, whether preferred or not, will still
+    receive the same number of shares (one, if there are ``N`` or more servers
+    accepting uploads). Preferred nodes are simply moved to the front of the
+    server selection lists computed for each file.
+
+    This is useful if a subset of your nodes have different availability or
+    connectivity characteristics than the rest of the grid. For instance, if
+    there are more than ``N`` servers on the grid, and ``K`` or more of them
+    are at a single physical location, it would make sense for clients at that
+    location to prefer their local servers so that they can maintain access to
+    all of their uploads without using the internet.
+
+
 Frontend Configuration
 ======================