Permalink
Browse files

Update 'tor-integration' doc

  • Loading branch information...
crwood committed Oct 25, 2018
1 parent f30f50e commit 632745a72a0846ee8c38799565c4d23660b2cb51
Showing with 6 additions and 6 deletions.
  1. +6 −6 docs/tor-integration.md
View
@@ -1,4 +1,4 @@
Tor integration (WORK IN PROGRESS)
Tor integration
===============
**WARNING: Tor integration in Gridsync is currently _experimental_ and is being made available for preliminary user-testing purposes only. As such -- and so long as this notice remains -- it should be considered both unsafe and/or subject to change; do not rely upon this (yet)!**
@@ -17,25 +17,25 @@ Beginning in version 0.4 (to be released), Gridsync provides built-in support fo
Prerequisites
-------------
Currently, Gridsync will only offer the option to connect via Tor on systems where a `tor` daemon is already running and with a working "control port" exposed; upon startup, Gridsync will search for an available control port at the following locations:
In order to route the above-mentioned connections over Tor, Gridsync requires that a Tor daemon be installed and running and configured to expose an available control port at one the following locations:
* `/var/run/tor/control` (UNIX socket): The default on Debian-based GNU/Linux systems
* `localhost:9051` (TCP): The standard control port for standalone `tor` daemons
* `localhost:9151` (TCP): The standard control port for TorBrowser's embedded `tor` daemon
If Gridsync _cannot_ find a running Tor daemon at any one of the above locations, the option to create new connections over the Tor network will be disabled, while any existing grid connections previously-configured to use Tor will fail (with an error-message) until a new/working `tor` daemon is launched.
If Gridsync _cannot_ find a running Tor daemon at any one of the above locations, any grid connections configured to use Tor will fail (with an error-message) until a new/working `tor` daemon is launched with a control port exposed. Gridsync will not attempt to connect without Tor for any connection that has Tor enabled.
(Note: In the future, Gridsync may offer the option to launch/configure a Tor daemon automatically on startup or when needed; see [Issue #??](https://github.com/gridsync/gridsync/issues))
Usage
-----
If Gridsync finds a running `tor` daemon at any one of the above-mentioned locations, the "Connect over the Tor network" checkbox will be enabled on invite dialogs (i.e., the initial/first-run "welcome" screen and the "add new folder from invite code" window). Switching this checkbox "on" will force any subsequent connections associated with that invitation/connection to be tunneled through the Tor network, in particular: 1) connecting to the `magic-wormhole` server, 2) fetching any service icons, and 3) the resulting Tahoe-LAFS connection(s) to the storage grid.
To enabled Tor for a given connection, users can simply check/enable the "Connect over the Tor network" checkbox (found on either the initial/first-run "welcome" screen or the "add new folder from invite code" window) while entering an invite code. Switching this checkbox "on" before proceeding with an invite will force any subsequent connections associated with that invitation/connection to be tunneled through the Tor network, in particular: 1) connecting to the `magic-wormhole` server, 2) fetching any service icons, and 3) the resulting Tahoe-LAFS connection(s) to the storage grid.
Alternatively, users may choose to enable Tor connections from the manual configuration dialog (i.e., by selecting "Tor" from the "Connections" combobox/dropdown menu).
Alternatively, users may choose to enable Tor for a given connection from the manual configuration dialog (i.e., by selecting "Tor" from the "Connections" combobox/dropdown menu).
(Note: To help protect against accidental de-anonymization, Gridsync does not provide the option to disable Tor connections once enabled; users wishing to connect to an existing Tor-enabled grid _without_ Tor should create a new connection to that grid with Tor disabled)
(Note: Currently, Gridsync does not provide the option to disable Tor connections once enabled; users wishing to connect to an existing Tor-enabled grid _without_ Tor should create a new connection to that grid with Tor disabled; see [Issue #100](https://github.com/gridsync/gridsync/issues/100))
Other notes

0 comments on commit 632745a

Please sign in to comment.