Skip to content

Commit 377d131

Browse files
committed
Merge #8203: Clarify documentation for running a tor node
9e3ec74 Clarify documentation for running a tor node (Nathaniel Mahieu)
2 parents 223bf83 + 9e3ec74 commit 377d131

File tree

1 file changed

+14
-4
lines changed

1 file changed

+14
-4
lines changed

doc/tor.md

Lines changed: 14 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -95,12 +95,22 @@ Starting with Tor version 0.2.7.1 it is possible, through Tor's control socket
9595
API, to create and destroy 'ephemeral' hidden services programmatically.
9696
Bitcoin Core has been updated to make use of this.
9797

98-
This means that if Tor is running (and proper authorization is available),
99-
Bitcoin Core automatically creates a hidden service to listen on, without
100-
manual configuration. This will positively affect the number of available
101-
.onion nodes.
98+
This means that if Tor is running (and proper authentication has been configured),
99+
Bitcoin Core automatically creates a hidden service to listen on. This will positively
100+
affect the number of available .onion nodes.
102101

103102
This new feature is enabled by default if Bitcoin Core is listening, and
104103
a connection to Tor can be made. It can be configured with the `-listenonion`,
105104
`-torcontrol` and `-torpassword` settings. To show verbose debugging
106105
information, pass `-debug=tor`.
106+
107+
Connecting to Tor's control socket API requires one of two authentication methods to be
108+
configured. For cookie authentication the user running bitcoind must have write access
109+
to the `CookieAuthFile` specified in Tor configuration. In some cases this is
110+
preconfigured and the creation of a hidden service is automatic. If permission problems
111+
are seen with `-debug=tor` they can be resolved by adding both the user running tor and
112+
the user running bitcoind to the same group and setting permissions appropriately. On
113+
Debian-based systems the user running bitcoind can be added to the debian-tor group,
114+
which has the appropriate permissions. An alternative authentication method is the use
115+
of the `-torpassword` flag and a `hash-password` which can be enabled and specified in
116+
Tor configuration.

0 commit comments

Comments
 (0)