diff options
| author | Jon Atack <jon@atack.com> | 2023-05-13 07:19:38 +0200 |
|---|---|---|
| committer | Jon Atack <jon@atack.com> | 2023-06-27 10:26:06 -0600 |
| commit | b505d59326ce04645ebef06b21286a4ffbcd3a23 (patch) | |
| tree | 1beae53eeb58c11e03ff732e7668d0ee013b37d6 /doc | |
| parent | 2880bb588a3529c87fb6e084d8bf99c23a82403f (diff) | |
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.
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/i2p.md | 13 |
1 files changed, 7 insertions, 6 deletions
diff --git a/doc/i2p.md b/doc/i2p.md index cfff426617..e6bc4fee22 100644 --- a/doc/i2p.md +++ b/doc/i2p.md @@ -9,14 +9,16 @@ started with I2P terminology. ## Run Bitcoin Core with an I2P router (proxy) -A running I2P router (proxy) with [SAM](https://geti2p.net/en/docs/api/samv3) -enabled is required. Options include: +A running I2P router (proxy) is required with the [SAM](https://geti2p.net/en/docs/api/samv3) +application bridge enabled. Options include: - [i2prouter (I2P Router)](https://geti2p.net), the official implementation in - Java + Java. The SAM bridge is not enabled by default; it must be started manually, + or configured to start automatically, in the Clients page in the + router console (`http://127.0.0.1:7657/configclients`) or in the `clients.config` file. - [i2pd (I2P Daemon)](https://github.com/PurpleI2P/i2pd) ([documentation](https://i2pd.readthedocs.io/en/latest)), a lighter - alternative in C++ + alternative in C++. It enables the SAM bridge by default. - [i2p-zero](https://github.com/i2p-zero/i2p-zero) - [other alternatives](https://en.wikipedia.org/wiki/I2P#Routers) @@ -118,8 +120,7 @@ to connect to the I2P network. Any I2P router that supports it can be used. ## Ports in I2P and Bitcoin Core -Bitcoin Core uses the [SAM v3.1](https://geti2p.net/en/docs/api/samv3) -protocol. One particularity of SAM v3.1 is that it does not support ports, +One particularity of SAM v3.1 is that it does not support ports, unlike newer versions of SAM (v3.2 and up) that do support them and default the port numbers to 0. From the point of view of peers that use newer versions of SAM or other protocols that support ports, a SAM v3.1 peer is connecting to them |