Skip to content

Commit 2cd71d3

Browse files
committed
Merge bitcoin/bitcoin#27937: doc: i2p documentation updates
11900e5 doc: simplify the router options in doc/i2p.md (Jon Atack) b505d59 doc: clarify when and how to launch the SAM bridge in doc/i2p.md (Jon Atack) Pull request description: 1. Clarify when and how to launch the SAM application bridge to address user questions and bitcoin/bitcoin#22759 (comment). The bridge is not enabled by default in the Java I2P Router, and the relevant info is somewhat difficult to find in its documentation. 2. Remove a duplicate sentence and link (the preceding paragraph begins with the same sentence and link). 3. Simplify the router options: - the Java I2P router and i2pd are the two routers have been heavily tested with Bitcoin Core and are what node operators and node software packages are using - [i2p-zero](https://github.com/i2p-zero/i2p-zero) hasn't been updated since July 2021 and its last release was in December 2020 - the other routers in the wikipedia page are niche and I haven't heard anyone report using them ACKs for top commit: fanquake: ACK 11900e5 Tree-SHA512: add5f40004feddc7829d658a5de30422f144ab8fa09ff1396d5d263ee86e39803595a2c50e2aa601d0df6da5eff4358c3f7f17e039dcd4952cb306596c6c0397
2 parents 47ab006 + 11900e5 commit 2cd71d3

File tree

1 file changed

+7
-8
lines changed

1 file changed

+7
-8
lines changed

doc/i2p.md

Lines changed: 7 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -9,16 +9,16 @@ started with I2P terminology.
99

1010
## Run Bitcoin Core with an I2P router (proxy)
1111

12-
A running I2P router (proxy) with [SAM](https://geti2p.net/en/docs/api/samv3)
13-
enabled is required. Options include:
12+
A running I2P router (proxy) is required with the [SAM](https://geti2p.net/en/docs/api/samv3)
13+
application bridge enabled. The following routers are recommended for use with Bitcoin Core:
1414

1515
- [i2prouter (I2P Router)](https://geti2p.net), the official implementation in
16-
Java
16+
Java. The SAM bridge is not enabled by default; it must be started manually,
17+
or configured to start automatically, in the Clients page in the
18+
router console (`http://127.0.0.1:7657/configclients`) or in the `clients.config` file.
1719
- [i2pd (I2P Daemon)](https://github.com/PurpleI2P/i2pd)
1820
([documentation](https://i2pd.readthedocs.io/en/latest)), a lighter
19-
alternative in C++
20-
- [i2p-zero](https://github.com/i2p-zero/i2p-zero)
21-
- [other alternatives](https://en.wikipedia.org/wiki/I2P#Routers)
21+
alternative in C++. It enables the SAM bridge by default.
2222

2323
Note the IP address and port the SAM proxy is listening to; usually, it is
2424
`127.0.0.1:7656`.
@@ -118,8 +118,7 @@ to connect to the I2P network. Any I2P router that supports it can be used.
118118

119119
## Ports in I2P and Bitcoin Core
120120

121-
Bitcoin Core uses the [SAM v3.1](https://geti2p.net/en/docs/api/samv3)
122-
protocol. One particularity of SAM v3.1 is that it does not support ports,
121+
One particularity of SAM v3.1 is that it does not support ports,
123122
unlike newer versions of SAM (v3.2 and up) that do support them and default the
124123
port numbers to 0. From the point of view of peers that use newer versions of
125124
SAM or other protocols that support ports, a SAM v3.1 peer is connecting to them

0 commit comments

Comments
 (0)