Skip to content

Commit dfc4ce1

Browse files
Saibatojonatack
authored andcommitted
doc: update -proxy, -onion and -onlynet info in tor.md
Improve the description of what these options do with regards to tor or network traffic. Some of the wording is from a laanwj review in PR 19358.
1 parent 784a278 commit dfc4ce1

File tree

1 file changed

+11
-2
lines changed

1 file changed

+11
-2
lines changed

doc/tor.md

Lines changed: 11 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -23,10 +23,15 @@ outgoing connections, but more is possible.
2323

2424
-proxy=ip:port Set the proxy server. If SOCKS5 is selected (default), this proxy
2525
server will be used to try to reach .onion addresses as well.
26+
You need to use -noonion or -onion=0 to explicitly disable
27+
outbound access to onion services.
2628

2729
-onion=ip:port Set the proxy server to use for Tor onion services. You do not
28-
need to set this if it's the same as -proxy. You can use -noonion
30+
need to set this if it's the same as -proxy. You can use -onion=0
2931
to explicitly disable access to onion services.
32+
Note: Only the -proxy option sets the proxy for DNS requests;
33+
with -onion they will not route over Tor, so use -proxy if you
34+
have privacy concerns.
3035

3136
-listen When using -proxy, listening is disabled by default. If you want
3237
to run an onion service (see next section), you'll need to enable
@@ -40,7 +45,11 @@ outgoing connections, but more is possible.
4045
-onlynet=onion Make outgoing connections only to .onion addresses. Incoming
4146
connections are not affected by this option. This option can be
4247
specified multiple times to allow multiple network types, e.g.
43-
ipv4, ipv6, or onion.
48+
ipv4, ipv6 or onion. If you use this option with values other
49+
than onion you *cannot* disable onion connections; outgoing onion
50+
connections will be enabled when you use -proxy or -onion. Use
51+
-noonion or -onion=0 if you want to be sure there are no outbound
52+
onion connections over the default proxy or your defined -proxy.
4453

4554
In a typical situation, this suffices to run behind a Tor proxy:
4655

0 commit comments

Comments
 (0)