-
Notifications
You must be signed in to change notification settings - Fork 37.7k
doc: I2P documentation updates #26838
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
doc: I2P documentation updates #26838
Conversation
The following sections might be updated with supplementary metadata relevant to reviewers and maintainers. ReviewsSee the guideline for information on the review process.
If your review is incorrectly listed, please react with 👎 to this comment and the bot will ignore it on the next update. ConflictsReviewers, this pull request conflicts with the following ones:
If you consider this pull request important, please also help to review the conflicting pull requests. Ideally, start with the one that should be merged first. |
Thanks for this. You're on the right track here and we also appreciate the updates on your blog. Not sure of the audience (users vs. downstreams) for this doc vs. your blog, Elaborating my request from OP of the ticket, overall, the messaging that would be most helpful is:
Thanks again. |
Its the only i2p doc in this repository that users and developers can refer, update etc. for minimal and important things required to use i2p with bitcoin core. Not release specific. It was added in #22250 (2021) and updated multiple times since then. There is also a doc for Tor: /doc/tor.md |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
ACK 92f43b4 modulo the typo mentioned below
92f43b4
to
11f9b98
Compare
Done.
Dropped the versions in the documentation as they go stale. Presumably users will install current versions.
Done.
Indeed, this was discouraged in the documentation, as it takes a long time. |
Thanks for the feedback, everyone. Pushed an update and brought this out of draft. |
and also hoist the default setting to a constexpr and remove unused f-string operators in a related functional test.
as these go stale and users will generally install the current versions available.
11f9b98
to
3e1d294
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
ACK 3e1d294
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
ACK 3e1d294
These changes improve the I2P documentation.
Maybe this shouldn't be allowed by code ? |
I thought about this but would prefer not to limit it unless it's been shown that this is really causing a serious issue with the network, both in principle to not make an exception for one network, and also doing it several releases after adding I2P support, as any users that do would see their nodes not working anymore after upgrading to that release of Bitcoin Core. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
ACK 3e1d294
ACK |
ACK 3e1d294 Iin the last 24h of running my node I see the following stats via nethogs, for Bitcoin Core v24.0 with ~11 I2P peers, ~85 HTTP peers and ~13 onion peers: For contrast Tor has used ~600 MB of data total (figure shared with core-lightning). This is roughly the same usage pattern I saw which led me to try and limit I2P traffic only to bitcoin peers initially -- in fact a few months ago when monitoring for longer periods, I found I2P using more than double the bitcoind totals. I accept (and agree!) that we should want to and encourage contributing back to the wider I2P network for it's network health and, for me personally it's no issue, as I'm on an unmetered connection. But I still wonder whether a comment around "expected" I2P bandwidth usage might be warranted in a future PR to give a heads up to entities with limited resources? |
3e1d294 doc: remove recommended I2P router versions (jonatack) 295849a doc: update/clarify/de-emphasize I2P transient address section (jonatack) dffa319 doc: update bandwidth section of I2P documentation (jonatack) 0ed9cc5 doc: clarify -i2pacceptincoming help documentation (jonatack) Pull request description: Address the documentation updates requested in issue #26754, clarify/simplify the -i2pacceptincoming help, and a few other fixups. ACKs for top commit: willcl-ark: ACK 3e1d294 1440000bytes: ACK 3e1d294 w0xlt: ACK 3e1d294 vasild: ACK 3e1d294 Tree-SHA512: e647221884af34646b99150617f4d4cc8d5fce325a769294f49047b9d8c9c8ab2b365cfdd9f56b3bd0303da706233f03d24cececf6e161c53f04ed947751052a
@willcl-ark Interesting feedback (thanks!), worth measuring how much bandwidth is used after #26837 and upgrading to the latest releases, currently Java I2P 2.1.0 and i2pd 2.45.1. |
Address the documentation updates requested in issue #26754, clarify/simplify the -i2pacceptincoming help, and a few other fixups.