doc: Add I2P guidance related to bandwidth and i2pd software version by willcl-ark · Pull Request #25993 · bitcoin/bitcoin

willcl-ark · 2022-09-03T20:32:31Z

Add some general guidance on lowering bandwidth usage when using I2P routers.

ghost · 2022-09-03T21:16:43Z

Concept ACK

jonatack

Some initial thoughts.

doc/i2p.md

jonatack · 2022-09-05T11:02:41Z

doc/i2p.md

Suggested change

`transittunnels` options. For example to limit total I2P traffic to 256KB/s,

`transittunnels` options in the `i2pd/contrib/i2pd.conf` file. For example, to limit total I2P traffic to 256KB/s

Will test some of your recommendations, thanks!

👍🏼 I did test that disabling the transit traffic still permitted connections to and from the SAM proxy, and it worked between my two nodes. I also double checked on libera-chat#i2pd-dev that this is intended behaviour, and it is. So if you want only bitcoin traffic on your I2P proxy, you can disable everything else for ultimate minimum bandwidth-usage!

I think I might leave out the conf file path: 1) It might be in different locations for different people (e.g. /etc/i2pd/i2pd.conf or /var/lib/i2pd/i2pd.conf etc.) and 2) people might just be running with command line args.

Suggestions

## Bandwidth -I2P routers may route a large amount of general network traffic with default -settings enabled. Check your router's configuration to limit the amount of this -traffic that is being relayed. - -For `i2pd` controlling the amount of bandwidth being shared with the wider -network can be achieved by modifying the `bandwidth`, `share` and -`transittunnels` options. For example to limit total I2P traffic to 256KB/s, -and share 50% of this limit for a maximum of 20 transit tunnels you can use: +I2P routers may route a large amount of general network traffic with their +default settings. Check your router's configuration to limit the amount of +traffic relayed, if desired. + +With `i2pd`, the amount of bandwidth shared with the wider network can be +adjusted with the `bandwidth`, `share` and `transittunnels` options in +`i2pd.conf`. For example, to limit I2P traffic to 256KB/s and share 50% of this +limit for a maximum of 20 transit tunnels:

I think I might leave out the conf file path: 1) It might be in different locations for different people (e.g. /etc/i2pd/i2pd.conf or /var/lib/i2pd/i2pd.conf etc.) and 2) people might just be running with command line args.

Agree WRT the path. Maybe give the conf filename for both i2pd and i2p router or for neither.

I believe this is addressed here in response to vasild's comment.

I believe this is addressed here in response to vasild's comment.

How?

Mind having a look at #25993 (comment)? It would fix a few punctuation/grammar issues and improve clarity/brevity.

Ok I have adopted the changes from #25993 (comment)

How?

As the final clause now reads:

Similar bandwidth configuration options in the Java I2P router can be found in the `http://127.0.0.1:7657/config`, under the "Bandwidth" tab.

Which I think, is roughly the equivalent of the i2p router conf file?

vasild

The first commit looks ok (modulo the nits below). I am not sure about the second one - i2pd was tested and it worked with 2.35. Was it broken after 2.35 and then fixed in 2.42?

doc/i2p.md

willcl-ark · 2022-09-05T16:05:12Z

The first commit looks ok (modulo the nits below). I am not sure about the second one - i2pd was tested and it worked with 2.35. Was it broken after 2.35 and then fixed in 2.42?

Hmmm, I was trying on a totally fresh Debian install, and a not-so-fresh Ubuntu install. On Ubuntu apt served me 2.41 which worked. However Debain bullseye was serving me 2.36, which did not work, and resulted in crashing with log messages like this. Installing 2.41 did not seem to work, but I grabbed the 2.42 release and it just worked perfectly, so thought recommending this might be worthwhile.

willcl-ark · 2022-09-05T16:24:38Z

Dropped the i2pd version recommendation for now, as it seems like this could be a system issue on my side.
Integrated spelling nits and added paragraph on where to find the bandwidth config from the Java router.

vasild

ACK 27b9e098d163c292753cdd3df9cefefa28b648f8

Rspigler · 2022-09-06T20:06:24Z

Is i2pd used more often than the official I2p router? (that's what I use)

willcl-ark · 2022-09-06T22:11:47Z

Is i2pd used more often than the official I2p router? (that's what I use)

Possibly....

Rspigler · 2022-09-06T23:43:21Z

I wasn't sure how I felt about giving implementation-specific directions, but I missed that you also gave them for the i2p router, which IMO covers the 2 major implementations, so Concept ACK from me. Sorry

vasild

ACK 6119adcafd7b3379629ab64c2b0243a838900c24

DrahtBot · 2022-09-23T04:13:52Z

The following sections might be updated with supplementary metadata relevant to reviewers and maintainers.

Conflicts

No conflicts as of last run.

jonatack

The PR description needs to be updated.

doc/i2p.md

Adds some general guidance on lowering bandwidth usage when using I2P routers.

willcl-ark · 2022-10-03T09:38:35Z

The PR description needs to be updated.

Description updated and changes incorporated

jonatack

ACK 874c861

Thanks for updating!

jonatack · 2022-10-03T11:03:17Z

doc/i2p.md

+can set the `notransit` option to `true`.
+
+Similar bandwidth configuration options for the Java I2P router can be found in
+`http://127.0.0.1:7657/config` under the "Bandwidth" tab.


Ignore unless you need to retouch: dropping the backticks could make this a clickable URL.

Suggested change

`http://127.0.0.1:7657/config` under the "Bandwidth" tab.

http://127.0.0.1:7657/config under the "Bandwidth" tab.

Thanks @jonatack

Will indeed amend if I retouch.

hernanmarino

ACK 874c861

pablomartin4btc

ACK 874c861.

Very useful info as I was testing I2P on v.24 a few weeks ago and I didn't know you could setup this options (bandwidth, share and transittunnels).

…2pd sof…

willcl-ark force-pushed the i2pd_bandwidth branch from 3482311 to 0dbb919 Compare September 3, 2022 20:34

DrahtBot added the Docs label Sep 3, 2022

fanquake requested review from jonatack and vasild September 4, 2022 09:12

jonatack reviewed Sep 5, 2022

View reviewed changes

vasild reviewed Sep 5, 2022

View reviewed changes

doc/i2p.md Outdated Show resolved Hide resolved

doc/i2p.md Outdated Show resolved Hide resolved

doc/i2p.md Outdated Show resolved Hide resolved

willcl-ark force-pushed the i2pd_bandwidth branch from 0dbb919 to 27b9e09 Compare September 5, 2022 16:23

vasild approved these changes Sep 6, 2022

View reviewed changes

kristapsk mentioned this pull request Sep 6, 2022

[FEATURE REQ] Add bandwidth limiting guidance to I2P guide raspibolt/raspibolt#1086

Closed

willcl-ark force-pushed the i2pd_bandwidth branch from 27b9e09 to 6119adc Compare September 19, 2022 14:48

vasild approved these changes Sep 19, 2022

View reviewed changes

jonatack reviewed Sep 23, 2022

View reviewed changes

doc/i2p.md Outdated Show resolved Hide resolved

doc/i2p.md Outdated Show resolved Hide resolved

doc: Add I2P bandwidth guidance to i2p.md

874c861

Adds some general guidance on lowering bandwidth usage when using I2P routers.

willcl-ark force-pushed the i2pd_bandwidth branch from 6119adc to 874c861 Compare October 3, 2022 09:36

jonatack approved these changes Oct 3, 2022

View reviewed changes

hernanmarino reviewed Oct 28, 2022

View reviewed changes

hernanmarino approved these changes Oct 28, 2022

View reviewed changes

pablomartin4btc approved these changes Oct 28, 2022

View reviewed changes

fanquake merged commit 71abee8 into bitcoin:master Dec 5, 2022

sidhujag pushed a commit to syscoin/syscoin that referenced this pull request Dec 5, 2022

Merge bitcoin#25993: doc: Add I2P guidance related to bandwidth and i…

138a09e

…2pd sof…

bitcoin locked and limited conversation to collaborators Dec 5, 2023

	`transittunnels` options. For example to limit total I2P traffic to 256KB/s,
	`transittunnels` options in the `i2pd/contrib/i2pd.conf` file. For example, to limit total I2P traffic to 256KB/s

	`http://127.0.0.1:7657/config` under the "Bandwidth" tab.
	http://127.0.0.1:7657/config under the "Bandwidth" tab.

Conversation

willcl-ark commented Sep 3, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

ghost commented Sep 3, 2022 • edited by ghost Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

jonatack left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

jonatack Sep 5, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

jonatack Sep 14, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

vasild left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

willcl-ark commented Sep 5, 2022

Uh oh!

willcl-ark commented Sep 5, 2022

Uh oh!

vasild left a comment

Choose a reason for hiding this comment

Uh oh!

Rspigler commented Sep 6, 2022

Uh oh!

willcl-ark commented Sep 6, 2022

Uh oh!

Rspigler commented Sep 6, 2022

Uh oh!

vasild left a comment

Choose a reason for hiding this comment

Uh oh!

DrahtBot commented Sep 23, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Conflicts

Uh oh!

jonatack left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

willcl-ark commented Oct 3, 2022

Uh oh!

jonatack left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

hernanmarino left a comment

Choose a reason for hiding this comment

Uh oh!

pablomartin4btc left a comment

Choose a reason for hiding this comment

Uh oh!

willcl-ark commented Sep 3, 2022 •

edited

Loading

ghost commented Sep 3, 2022 •

edited by ghost

Loading

jonatack Sep 5, 2022 •

edited

Loading

jonatack Sep 14, 2022 •

edited

Loading

DrahtBot commented Sep 23, 2022 •

edited

Loading

jonatack left a comment •

edited

Loading