Skip to content

Commit b505d59

Browse files
committed
doc: clarify when and how to launch the SAM bridge in doc/i2p.md
The SAM application bridge is not enabled by default in the Java I2P Router, and the relevant info is somewhat difficult to find in its documentation. Also, remove a duplicate sentence; the preceding paragraph begins with the same.
1 parent 2880bb5 commit b505d59

File tree

1 file changed

+7
-6
lines changed

1 file changed

+7
-6
lines changed

doc/i2p.md

Lines changed: 7 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -9,14 +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. Options include:
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++
21+
alternative in C++. It enables the SAM bridge by default.
2022
- [i2p-zero](https://github.com/i2p-zero/i2p-zero)
2123
- [other alternatives](https://en.wikipedia.org/wiki/I2P#Routers)
2224

@@ -118,8 +120,7 @@ to connect to the I2P network. Any I2P router that supports it can be used.
118120

119121
## Ports in I2P and Bitcoin Core
120122

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,
123+
One particularity of SAM v3.1 is that it does not support ports,
123124
unlike newer versions of SAM (v3.2 and up) that do support them and default the
124125
port numbers to 0. From the point of view of peers that use newer versions of
125126
SAM or other protocols that support ports, a SAM v3.1 peer is connecting to them

0 commit comments

Comments
 (0)