aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorsaibato <saibato.naga@pm.me>2020-06-26 17:54:09 +0000
committerJon Atack <jon@atack.com>2021-01-25 21:31:08 +0100
commitdfc4ce12735c405519de9e35b150052af23924a5 (patch)
tree5d7a7cf74345c6a126007d1d3990891e7ad25bd3
parent784a278e872ea498dbc313a5a41a8d9f912adb7c (diff)
downloadbitcoin-dfc4ce12735c405519de9e35b150052af23924a5.tar.xz
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.
-rw-r--r--doc/tor.md13
1 files changed, 11 insertions, 2 deletions
diff --git a/doc/tor.md b/doc/tor.md
index 1ba7137b8e..e70c2ebd64 100644
--- a/doc/tor.md
+++ b/doc/tor.md
@@ -23,10 +23,15 @@ outgoing connections, but more is possible.
-proxy=ip:port Set the proxy server. If SOCKS5 is selected (default), this proxy
server will be used to try to reach .onion addresses as well.
+ You need to use -noonion or -onion=0 to explicitly disable
+ outbound access to onion services.
-onion=ip:port Set the proxy server to use for Tor onion services. You do not
- need to set this if it's the same as -proxy. You can use -noonion
+ need to set this if it's the same as -proxy. You can use -onion=0
to explicitly disable access to onion services.
+ Note: Only the -proxy option sets the proxy for DNS requests;
+ with -onion they will not route over Tor, so use -proxy if you
+ have privacy concerns.
-listen When using -proxy, listening is disabled by default. If you want
to run an onion service (see next section), you'll need to enable
@@ -40,7 +45,11 @@ outgoing connections, but more is possible.
-onlynet=onion Make outgoing connections only to .onion addresses. Incoming
connections are not affected by this option. This option can be
specified multiple times to allow multiple network types, e.g.
- ipv4, ipv6, or onion.
+ ipv4, ipv6 or onion. If you use this option with values other
+ than onion you *cannot* disable onion connections; outgoing onion
+ connections will be enabled when you use -proxy or -onion. Use
+ -noonion or -onion=0 if you want to be sure there are no outbound
+ onion connections over the default proxy or your defined -proxy.
In a typical situation, this suffices to run behind a Tor proxy: