Skip to content

Commit dffa319

Browse files
committed
doc: update bandwidth section of I2P documentation
1 parent 0ed9cc5 commit dffa319

File tree

1 file changed

+22
-11
lines changed

1 file changed

+22
-11
lines changed

doc/i2p.md

Lines changed: 22 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -134,14 +134,19 @@ port (`TO_PORT`) is always set to 0 and is not in the control of Bitcoin Core.
134134

135135
## Bandwidth
136136

137-
I2P routers may route a large amount of general network traffic with their
138-
default settings. Check your router's configuration to limit the amount of this
139-
traffic relayed, if desired.
137+
By default, your node shares bandwidth and transit tunnels with the I2P network
138+
in order to increase your anonymity with cover traffic, help the I2P router used
139+
by your node integrate optimally with the network, and give back to the network.
140+
It's important that the nodes of a popular application like Bitcoin contribute
141+
as much to the I2P network as they consume.
140142

141-
With `i2pd`, the amount of bandwidth being shared with the wider network can be
142-
adjusted with the `bandwidth`, `share` and `transittunnels` options in your
143-
`i2pd.conf` file. For example, to limit total I2P traffic to 256KB/s and share
144-
50% of this limit for a maximum of 20 transit tunnels:
143+
It is possible, though strongly discouraged, to change your I2P router
144+
configuration to limit the amount of I2P traffic relayed by your node.
145+
146+
With `i2pd`, this can be done by adjusting the `bandwidth`, `share` and
147+
`transittunnels` options in your `i2pd.conf` file. For example, to limit total
148+
I2P traffic to 256KB/s and share 50% of this limit for a maximum of 20 transit
149+
tunnels:
145150

146151
```
147152
bandwidth = 256
@@ -151,9 +156,15 @@ share = 50
151156
transittunnels = 20
152157
```
153158

154-
If you prefer not to relay any public I2P traffic and only permit I2P traffic
155-
from programs which are connecting via the SAM proxy, e.g. Bitcoin Core, you
156-
can set the `notransit` option to `true`.
157-
158159
Similar bandwidth configuration options for the Java I2P router can be found in
159160
`http://127.0.0.1:7657/config` under the "Bandwidth" tab.
161+
162+
Before doing this, please see the "Participating Traffic Considerations" section
163+
in [Embedding I2P in your Application](https://geti2p.net/en/docs/applications/embedding).
164+
165+
In most cases, the default router settings should work fine.
166+
167+
## Bundling I2P in a Bitcoin application
168+
169+
Please see the "General Guidance for Developers" section in https://geti2p.net/en/docs/api/samv3
170+
if you are developing a downstream application that may be bundling I2P with Bitcoin.

0 commit comments

Comments
 (0)