Skip to content

Commit b0ee47b

Browse files
vasildpinheadmz
authored andcommitted
doc: update tor.md to mention the new -proxy=addr:port=tor
Also change the formatting of `tor.md` to have more horizonal space for the text. Co-authored-by: Matthew Zipkin <[email protected]>
1 parent 3ff2a7c commit b0ee47b

File tree

1 file changed

+47
-27
lines changed

1 file changed

+47
-27
lines changed

doc/tor.md

Lines changed: 47 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -34,33 +34,53 @@ You can use the `getnodeaddresses` RPC to fetch a number of onion peers known to
3434
The first step is running Bitcoin Core behind a Tor proxy. This will already anonymize all
3535
outgoing connections, but more is possible.
3636

37-
-proxy=ip:port Set the proxy server. If SOCKS5 is selected (default), this proxy
38-
server will be used to try to reach .onion addresses as well.
39-
You need to use -noonion or -onion=0 to explicitly disable
40-
outbound access to onion services.
41-
42-
-onion=ip:port Set the proxy server to use for Tor onion services. You do not
43-
need to set this if it's the same as -proxy. You can use -onion=0
44-
to explicitly disable access to onion services.
45-
------------------------------------------------------------------
46-
Note: Only the -proxy option sets the proxy for DNS requests;
47-
with -onion they will not route over Tor, so use -proxy if you
48-
have privacy concerns.
49-
------------------------------------------------------------------
50-
51-
-listen When using -proxy, listening is disabled by default. If you want
52-
to manually configure an onion service (see section 3), you'll
53-
need to enable it explicitly.
54-
55-
-connect=X When behind a Tor proxy, you can specify .onion addresses instead
56-
-addnode=X of IP addresses or hostnames in these parameters. It requires
57-
-seednode=X SOCKS5. In Tor mode, such addresses can also be exchanged with
58-
other P2P nodes.
59-
60-
-onlynet=onion Make automatic outbound connections only to .onion addresses.
61-
Inbound and manual connections are not affected by this option.
62-
It can be specified multiple times to allow multiple networks,
63-
e.g. onlynet=onion, onlynet=i2p, onlynet=cjdns.
37+
-proxy=ip[:port]
38+
Set the proxy server. It will be used to try to reach .onion addresses
39+
as well. You need to use -noonion or -onion=0 to explicitly disable
40+
outbound access to onion services.
41+
42+
-proxy=ip[:port]=tor
43+
or
44+
-onion=ip[:port]
45+
Set the proxy server for reaching .onion addresses. You do not need to
46+
set this if it's the same as the generic -proxy. You can use -onion=0 to
47+
explicitly disable access to onion services.
48+
------------------------------------------------------------------------
49+
Note: The proxy for DNS requests is taken from
50+
-proxy=addr:port or
51+
-proxy=addr:port=ipv4 or
52+
-proxy=addr:port=ipv6
53+
(last one if multiple options are given). It is not taken from
54+
-proxy=addr:port=tor or
55+
-onion=addr:port.
56+
If no proxy for DNS requests is configured, then they will be done using
57+
the functions provided by the operating system, most likely resulting in
58+
them being done over the clearnet to the DNS servers of the internet
59+
service provider.
60+
------------------------------------------------------------------------
61+
62+
If -proxy or -onion is specified multiple times, later occurences override
63+
earlier ones and command line overrides the config file. UNIX domain sockets may
64+
be used for proxy connections. Set `-onion` or `-proxy` to the local socket path
65+
with the prefix `unix:` (e.g. `-onion=unix:/home/me/torsocket`).
66+
67+
-listen
68+
When using -proxy, listening is disabled by default. If you want to
69+
manually configure an onion service (see section 3), you'll need to
70+
enable it explicitly.
71+
72+
-connect=X
73+
-addnode=X
74+
-seednode=X
75+
When behind a Tor proxy, you can specify .onion addresses instead of IP
76+
addresses or hostnames in these parameters. Such addresses can also be
77+
exchanged with other P2P nodes.
78+
79+
-onlynet=onion
80+
Make automatic outbound connections only to .onion addresses. Inbound
81+
and manual connections are not affected by this option. It can be
82+
specified multiple times to allow multiple networks, e.g. onlynet=onion,
83+
onlynet=i2p, onlynet=cjdns.
6484

6585
In a typical situation, this suffices to run behind a Tor proxy:
6686

0 commit comments

Comments
 (0)