aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorJon Atack <jon@atack.com>2021-08-07 00:42:46 +0200
committerW. J. van der Laan <laanwj@protonmail.com>2021-08-26 14:43:41 +0200
commitf95b655ba9abd3f2cf79cdb3640656f3d60214fb (patch)
tree5ab63024769ec0825520ff34385b1ab08e91a79d
parent59d4afc272e280fdbb0b48a0a88a07d0cea7b6bc (diff)
downloadbitcoin-f95b655ba9abd3f2cf79cdb3640656f3d60214fb.tar.xz
Improve doc/i2p.md regarding I2P router options/versions
Github-Pull: bitcoin/bitcoin#22648 Rebased-From: b87a9c4d13329a6236124d4b93580c4df8107b32 Tree-SHA512: 3567e6dbfb7c3f410ea84d3f005c86be0283f92e1be1bc2a7ce93240a0b8460b985b3cec5873a19eade52dc1d78ca383c99e023d0bb4247048ae7e43b47522a5
-rw-r--r--doc/i2p.md21
1 files changed, 16 insertions, 5 deletions
diff --git a/doc/i2p.md b/doc/i2p.md
index 3a507a25ab..22ab9ad524 100644
--- a/doc/i2p.md
+++ b/doc/i2p.md
@@ -10,11 +10,22 @@ 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 (there is an [official one](https://geti2p.net) and
-[a few alternatives](https://en.wikipedia.org/wiki/I2P#Routers)). Notice the IP
-address and port the SAM proxy is listening to; usually, it is
-`127.0.0.1:7656`. Once it is up and running with SAM enabled, use the following
-Bitcoin Core options:
+enabled is required. Options include:
+
+- [i2prouter (I2P Router)](https://geti2p.net), the official implementation in
+ Java
+- [i2pd (I2P Daemon)](https://github.com/PurpleI2P/i2pd)
+ ([documentation](https://i2pd.readthedocs.io/en/latest)), a lighter
+ alternative in C++ (successfully tested with version 2.23 and up; version 2.36
+ or later recommended)
+- [i2p-zero](https://github.com/i2p-zero/i2p-zero)
+- [other alternatives](https://en.wikipedia.org/wiki/I2P#Routers)
+
+Note the IP address and port the SAM proxy is listening to; usually, it is
+`127.0.0.1:7656`.
+
+Once an I2P router with SAM enabled is up and running, use the following Bitcoin
+Core configuration options:
```
-i2psam=<ip:port>