Skip to content

Commit e98c51f

Browse files
vasildpinheadmz
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 ca5781e commit e98c51f

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
@@ -32,33 +32,53 @@ You can use the `getnodeaddresses` RPC to fetch a number of onion peers known to
3232
The first step is running Bitcoin Core behind a Tor proxy. This will already anonymize all
3333
outgoing connections, but more is possible.
3434

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

6383
In a typical situation, this suffices to run behind a Tor proxy:
6484

0 commit comments

Comments
 (0)