]> Git Repo - VerusCoin.git/blobdiff - doc/tor.md
Merge branch 'dev' of https://github.com/miketout/VerusCoin into dev
[VerusCoin.git] / doc / tor.md
index 384bae3873c987d3c29261d6e47cb8b91ec071df..1e412e69adf98312be15d81f3a5720a676d47a7e 100644 (file)
@@ -1,18 +1,17 @@
-*** Warning: Do not assume Tor support does the correct thing in Zcash; better Tor support is a future feature goal. ***
+*** Warning: Do not assume Tor support does the correct thing in Komodo; better Tor support is a future feature goal. ***
 
 TOR SUPPORT IN ZCASH
-====================
 
-It is possible to run Zcash as a Tor hidden service, and connect to such services.
+It is possible to run Komodo as a Tor hidden service, and connect to such services.
 
-The following directions assume you have a Tor proxy running on port 9050. Many distributions default to having a SOCKS proxy listening on port 9050, but others may not. In particular, the Tor Browser Bundle defaults to listening on a random port. See [Tor Project FAQ:TBBSocksPort](https://www.torproject.org/docs/faq.html.en#TBBSocksPort) for how to properly
+The following directions assume you have a Tor proxy running on port 9050. Many distributions default to having a SOCKS proxy listening on port 9050, but others may not. In particular, the Tor Browser Bundle defaults to listening on port 9150. See [Tor Project FAQ:TBBSocksPort](https://www.torproject.org/docs/faq.html.en#TBBSocksPort) for how to properly
 configure Tor.
 
 
-1. Run Zcash behind a Tor proxy
+1. Run Komodo behind a Tor proxy
 -------------------------------
 
-The first step is running Zcash behind a Tor proxy. This will already make all
+The first step is running Komodo behind a Tor proxy. This will already make all
 outgoing connections be anonymized, but more is possible.
 
        -proxy=ip:port  Set the proxy server. If SOCKS5 is selected (default), this proxy
@@ -33,10 +32,10 @@ outgoing connections be anonymized, but more is possible.
 
 In a typical situation, this suffices to run behind a Tor proxy:
 
-       ./zcashd -proxy=127.0.0.1:9050
+       ./komodod -proxy=127.0.0.1:9050
 
 
-2. Run a Zcash hidden server
+2. Run a Komodo hidden server
 ----------------------------
 
 If you configure your Tor system accordingly, it is possible to make your node also
@@ -44,13 +43,13 @@ reachable from the Tor network. Add these lines to your /etc/tor/torrc (or equiv
 config file):
 
        HiddenServiceDir /var/lib/tor/zcash-service/
-       HiddenServicePort 8233 127.0.0.1:8233
-       HiddenServicePort 18233 127.0.0.1:18233
+       HiddenServicePort 7771 127.0.0.1:7771
+       HiddenServicePort 17771 127.0.0.1:17771
 
 The directory can be different of course, but (both) port numbers should be equal to
-your zcashd's P2P listen port (8233 by default).
+your komodod's P2P listen port (7771 by default).
 
-       -externalip=X   You can tell Zcash about its publicly reachable address using
+       -externalip=X   You can tell Komodo about its publicly reachable address using
                        this option, and this can be a .onion address. Given the above
                        configuration, you can find your onion address in
                        /var/lib/tor/zcash-service/hostname. Onion addresses are given
@@ -70,20 +69,25 @@ your zcashd's P2P listen port (8233 by default).
 
 In a typical situation, where you're only reachable via Tor, this should suffice:
 
-       ./zcashd -proxy=127.0.0.1:9050 -externalip=zctestseie6wxgio.onion -listen
+       ./komodod -proxy=127.0.0.1:9050 -externalip=zctestseie6wxgio.onion -listen
+
+(obviously, replace the Onion address with your own). It should be noted that you still
+listen on all devices and another node could establish a clearnet connection, when knowing
+your address. To mitigate this, additionally bind the address of your Tor proxy:
+
+       ./zcashd ... -bind=127.0.0.1
 
-(obviously, replace the Onion address with your own). If you don't care too much
-about hiding your node, and want to be reachable on IPv4 as well, additionally
-specify:
+If you don't care too much about hiding your node, and want to be reachable on IPv4
+as well, use `discover` instead:
 
-       ./zcashd ... -discover
+       ./komodod ... -discover
 
-and open port 8233 on your firewall (or use -upnp).
+and open port 7771 on your firewall (or use -upnp).
 
 If you only want to use Tor to reach onion addresses, but not use it as a proxy
 for normal IPv4/IPv6 communication, use:
 
-       ./zcashd -onion=127.0.0.1:9050 -externalip=zctestseie6wxgio.onion -discover
+       ./komodod -onion=127.0.0.1:9050 -externalip=zctestseie6wxgio.onion -discover
 
 
 3. Automatically listen on Tor
@@ -91,35 +95,47 @@ for normal IPv4/IPv6 communication, use:
 
 Starting with Tor version 0.2.7.1 it is possible, through Tor's control socket
 API, to create and destroy 'ephemeral' hidden services programmatically.
-Zcash has been updated to make use of this.
-
-This means that if Tor is running (and proper authorization is available),
-Zcash automatically creates a hidden service to listen on, without
-manual configuration. This will positively affect the number of available
-.onion nodes.
-
-This new feature is enabled by default if Zcash is listening, and
-a connection to Tor can be made. It can be configured with the `-listenonion`,
-`-torcontrol` and `-torpassword` settings. To show verbose debugging
-information, pass `-debug=tor`.
-
-
-4. Connect to a Zcash hidden server
+Komodo has been updated to make use of this.
+
+This means that if Tor is running (and proper authentication has been configured),
+Komodo automatically creates a hidden service to listen on. Komodo will also use Tor
+automatically to connect to other .onion nodes if the control socket can be
+successfully opened. This will positively affect the number of available .onion
+nodes and their usage.
+
+This new feature is enabled by default if Komodo is listening (`-listen`), and
+requires a Tor connection to work. It can be explicitly disabled with `-listenonion=0`
+and, if not disabled, configured using the `-torcontrol` and `-torpassword` settings.
+To show verbose debugging information, pass `-debug=tor`.
+
+Connecting to Tor's control socket API requires one of two authentication methods to be 
+configured. For cookie authentication the user running komodod must have write access 
+to the `CookieAuthFile` specified in Tor configuration. In some cases this is 
+preconfigured and the creation of a hidden service is automatic. If permission problems 
+are seen with `-debug=tor` they can be resolved by adding both the user running tor and 
+the user running komodod to the same group and setting permissions appropriately. On 
+Debian-based systems the user running komodod can be added to the debian-tor group, 
+which has the appropriate permissions. An alternative authentication method is the use 
+of the `-torpassword` flag and a `hash-password` which can be enabled and specified in 
+Tor configuration.
+
+
+4. Connect to a Komodo hidden server
 -----------------------------------
 
 To test your set-up, you might want to try connecting via Tor on a different computer to just a
-a single Zcash hidden server. Launch zcashd as follows:
+a single Komodo hidden server. Launch komodod as follows:
 
-       ./zcashd -onion=127.0.0.1:9050 -connect=zctestseie6wxgio.onion
+       ./komodod -onion=127.0.0.1:9050 -connect=zctestseie6wxgio.onion
 
-Now use zcash-cli to verify there is only a single peer connection.
+Now use komodo-cli to verify there is only a single peer connection.
 
-       zcash-cli getpeerinfo
+       komodo-cli getpeerinfo
 
        [
            {
                "id" : 1,
-               "addr" : "zctestseie6wxgio.onion:18233",
+               "addr" : "zctestseie6wxgio.onion:17770",
                ...
                "version" : 170002,
                "subver" : "/MagicBean:1.0.0/",
@@ -129,4 +145,11 @@ Now use zcash-cli to verify there is only a single peer connection.
 
 To connect to multiple Tor nodes, use:
 
-       ./zcashd -onion=127.0.0.1:9050 -addnode=zctestseie6wxgio.onion -dnsseed=0 -onlynet=onion
+       ./komodod -onion=127.0.0.1:9050 -addnode=zctestseie6wxgio.onion -dnsseed=0 -onlynet=onion
+=======
+TOR SUPPORT IN ZCASH
+====================
+
+This document has been relocated to https://zcash.readthedocs.io/en/latest/rtd_pages/tor.html
+
+The source for this document is available at https://gitlab.com/zcash-docs/zcash-docs/blob/master/source/rtd_pages/tor.rst
This page took 0.027708 seconds and 4 git commands to generate.