doc: i2p documentation updates #27937

pull jonatack wants to merge 2 commits into bitcoin:master from jonatack:2023-06-clarify-SAM-bridge-instructions-in-i2p-doc changing 1 files +7 −8

jonatack commented at 9:32 PM on June 22, 2023: contributor
1. Clarify when and how to launch the SAM application bridge to address user questions and #22759 (comment). The bridge is not enabled by default in the Java I2P Router, and the relevant info is somewhat difficult to find in its documentation.
2. Remove a duplicate sentence and link (the preceding paragraph begins with the same sentence and link).
3. Simplify the router options:
  
  the Java I2P router and i2pd are the two routers have been heavily tested with Bitcoin Core and are what node operators and node software packages are using
  
  i2p-zero hasn't been updated since July 2021 and its last release was in December 2020
  
  the other routers in the wikipedia page are niche and I haven't heard anyone report using them
DrahtBot commented at 9:33 PM on June 22, 2023: contributor



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



Reviews

See the guideline for information on the review process.

Type Reviewers

ACK fanquake

Concept ACK jarolrod

If your review is incorrectly listed, please react with 👎 to this comment and the bot will ignore it on the next update.
DrahtBot added the label Docs on Jun 22, 2023
DrahtBot added the label CI failed on Jun 22, 2023
DrahtBot removed the label CI failed on Jun 22, 2023

Type	Reviewers
ACK	fanquake
Concept ACK	jarolrod

in doc/i2p.md:121 in 3a5b2c4634 outdated

 117 | @@ -118,8 +118,7 @@ to connect to the I2P network. Any I2P router that supports it can be used.
 118 |  
 119 |  ## Ports in I2P and Bitcoin Core
 120 |  
 121 | -Bitcoin Core uses the [SAM v3.1](https://geti2p.net/en/docs/api/samv3)
 122 | -protocol. One particularity of SAM v3.1 is that it does not support ports,
 123 | +One particularity of SAM v3.1 is that it does not support ports,

jarolrod commented at 12:36 AM on June 24, 2023:

I would squash commit 6c874b59d1a577b0349c1a04e7e329efba326d37 into 4988ad4ea94c848f1109a88fd7a955d2234090a8

jonatack commented at 4:28 PM on June 27, 2023:

Done.

jarolrod commented at 12:37 AM on June 24, 2023: member

Concept ACK

Just finished going through setting this up with core on a clean ubuntu install. The changes here are nice cleanups for the documentation, which is important to get people up and running with these alternative networks.

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.

b505d59326

doc: simplify the router options in doc/i2p.md

- the Java I2P router and i2pd are the two routers have been heavily tested
  with Bitcoin Core and are what people and node software packages use

- i2p-zero (https://github.com/i2p-zero/i2p-zero) hasn't been updated since
  July 2021 and its last release was in December 2020

- the other routers in the wikipedia page are niche

11900e5a8a

jonatack force-pushed on Jun 27, 2023
fanquake approved
fanquake commented at 9:08 AM on June 30, 2023: member

ACK 11900e5a8aa4647e50e8d97fc9a8b35e9e20772b
fanquake merged this on Jun 30, 2023
fanquake closed this on Jun 30, 2023
jonatack deleted the branch on Jun 30, 2023
sidhujag referenced this in commit 8486474ba6 on Jun 30, 2023
kwvg referenced this in commit f32bb98ef3 on May 27, 2024
kwvg referenced this in commit eea481085c on May 28, 2024
PastaPastaPasta referenced this in commit 0a23820923 on May 29, 2024
PastaPastaPasta referenced this in commit 76b8ffdf12 on May 29, 2024
bitcoin locked this on Jun 29, 2024

Contributors

Labels

Linked (view graph)

#22759 I2P: Creating SAM session with 127.0.0.1:7656

doc: i2p documentation updates #27937

Reviews