Skip to content

Commit bebcf78

Browse files
committed
Update i2p.md and tor.md regarding -onlynet config option
1 parent d67330d commit bebcf78

File tree

2 files changed

+29
-14
lines changed

2 files changed

+29
-14
lines changed

doc/i2p.md

Lines changed: 24 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -42,15 +42,30 @@ named `i2p_private_key` in the Bitcoin Core data directory.
4242

4343
## Additional configuration options related to I2P
4444

45-
You may set the `debug=i2p` config logging option to have additional
46-
information in the debug log about your I2P configuration and connections. Run
47-
`bitcoin-cli help logging` for more information.
48-
49-
It is possible to restrict outgoing connections in the usual way with
50-
`onlynet=i2p`. I2P support was added to Bitcoin Core in version 22.0 (mid-2021)
51-
and there may be fewer I2P peers than Tor or IP ones. Therefore, using
52-
`onlynet=i2p` alone (without other `onlynet=`) may make a node more susceptible
53-
to [Sybil attacks](https://en.bitcoin.it/wiki/Weaknesses#Sybil_attack). Use
45+
```
46+
-debug=i2p
47+
```
48+
49+
Set the `debug=i2p` config logging option to see additional information in the
50+
debug log about your I2P configuration and connections. Run `bitcoin-cli help
51+
logging` for more information.
52+
53+
```
54+
-onlynet=i2p
55+
```
56+
57+
Make outgoing connections only to I2P addresses. Incoming connections are not
58+
affected by this option. It can be specified multiple times to allow multiple
59+
network types, e.g. onlynet=ipv4, onlynet=ipv6, onlynet=onion, onlynet=i2p.
60+
61+
Warning: if you use -onlynet with values other than onion, and the -onion or
62+
-proxy option is set, then outgoing onion connections will still be made; use
63+
-noonion or -onion=0 to disable outbound onion connections in this case.
64+
65+
I2P support was added to Bitcoin Core in version 22.0 and there may be fewer I2P
66+
peers than Tor or IP ones. Therefore, using I2P alone without other networks may
67+
make a node more susceptible to [Sybil
68+
attacks](https://en.bitcoin.it/wiki/Weaknesses#Sybil_attack). You can use
5469
`bitcoin-cli -addrinfo` to see the number of I2P addresses known to your node.
5570

5671
Another consideration with `onlynet=i2p` is that the initial blocks download

doc/tor.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -57,11 +57,11 @@ outgoing connections, but more is possible.
5757
-onlynet=onion Make outgoing connections only to .onion addresses. Incoming
5858
connections are not affected by this option. This option can be
5959
specified multiple times to allow multiple network types, e.g.
60-
ipv4, ipv6 or onion. If you use this option with values other
61-
than onion you *cannot* disable onion connections; outgoing onion
62-
connections will be enabled when you use -proxy or -onion. Use
63-
-noonion or -onion=0 if you want to be sure there are no outbound
64-
onion connections over the default proxy or your defined -proxy.
60+
onlynet=ipv4, onlynet=ipv6, onlynet=onion, onlynet=i2p.
61+
Warning: if you use -onlynet with values other than onion, and
62+
the -onion or -proxy option is set, then outgoing onion
63+
connections will still be made; use -noonion or -onion=0 to
64+
disable outbound onion connections in this case.
6565

6666
In a typical situation, this suffices to run behind a Tor proxy:
6767

0 commit comments

Comments
 (0)