From d09173cbf79f5a2145e2c22c2de9a2486aa2f0ef Mon Sep 17 00:00:00 2001 From: str4d Date: Mon, 8 Sep 2014 03:26:55 +0000 Subject: [PATCH] Expanded explanation of [node]anonymize --- docs/anonymity-configuration.rst | 25 +++++++++++++++++++++---- 1 file changed, 21 insertions(+), 4 deletions(-) diff --git a/docs/anonymity-configuration.rst b/docs/anonymity-configuration.rst index 59dea773c..1be1c7909 100644 --- a/docs/anonymity-configuration.rst +++ b/docs/anonymity-configuration.rst @@ -186,14 +186,31 @@ configuration is necessary. Configuration ============= -:: +Tahoe-LAFS provides a configuration flag for explicitly stating whether or not +anonymity is required for a node:: [node] anonymize = (boolean, optional) -This specifies two changes in behavior: - 1. Transform all non-Tor client endpoints into Tor client endpoints. - 2. Force ``tub.location`` to be set to "safe" values. +Setting ``anonymize = True`` causes several changes in the behavior of +Tahoe-LAFS: + +1. Tahoe-LAFS will not start if any of the configuration options in ``tahoe.cfg`` + would compromise the identity of the node. In particular, ``tub.location`` + is forced to have "safe" values. +2. Tahoe-LAFS will not make any outgoing connections that are not over a + supported anonymizing network. + + * If a server's FURL contains one or more location hints for anonymizing + networks, Tahoe-LAFS will prefer those hints to connect to the server. + An anonymizing network location hint will only be used if the correct + modules are installed. + * If a server's FURL contains no location hints for anonymizing networks + (or Tahoe-LAFS could not contact the server via any of the provided + anonymizing network location hints), and the user has the required modules + for Tor installed, Tahoe-LAFS will connect to the server using Tor as an + anonymizing proxy. + * In all other cases, Tahoe-LAFS will never connect to the server. This option is **critical** to preserving the client's anonymity (client use-case 3 from `Use cases`_, above). It is also necessary to