ExternalVendorCode/tahoe-lafs
1
0
Fork 0
mirror of https://github.com/tahoe-lafs/tahoe-lafs.git synced 2024-12-26 08:01:06 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

docs: improve reveal-IP-address description

Browse Source
This commit is contained in:
Brian Warner 2016-09-02 09:18:47 -07:00
parent d0da17adeb
commit c17217699e
1 changed files with 14 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

20
docs/configuration.rst
View File

@ -336,9 +336,20 @@ set the ``tub.location`` option described below.
``reveal-IP-address = (boolean, optional, defaults to True)``
This is a safety flag. If False, any of the following configuration
problems will cause ``tahoe start`` to throw a PrivacyError instead of
starting the node:
This is a safety flag. When set to False (aka "private mode"), the node
will refuse to start if any of the other configuration options would
reveal the node's IP address to servers or the external network. This
flag does not directly affect the node's behavior: its only power is to
veto node startup when something looks unsafe.
The default is True (non-private mode), because setting it to False
requires the installation of additional libraries (use ``pip install
tahoe-lafs[tor]`` and/or ``pip install tahoe-lafs[i2p]`` to get them) as
well as additional non-python software (Tor/I2P daemons). Performance is
also generally reduced when operating in private mode.
When False, any of the following configuration problems will cause
``tahoe start`` to throw a PrivacyError instead of starting the node:
* ``[node] tub.location`` contains any ``tcp:`` hints
@ -348,9 +359,6 @@ set the ``tub.location`` option described below.
* ``[connections] tcp =`` is set to ``tcp`` (or left as the default),
rather than being set to ``tor``
These configuration problems would reveal the node's IP address to
servers and external networks.
Connection Management
=====================