Skip to content

Conversation

jonatack
Copy link
Member

@jonatack jonatack commented Mar 29, 2022

and improve the informational links. CJDNS functions with a friend-of-a-friend topology and a key hurdle to getting started is to find a public peer and set up an outbound connection to it. This update makes doing it much easier for people getting started.

Credit to Vasil Dimov for an IRC suggestion in October 2021 and to stickies-v for IRC discussions this week and the testing guide that led me to redo these steps, provide feedback at #24706 and refine the added documentation here.

@DrahtBot DrahtBot added the Docs label Mar 29, 2022
@jonatack jonatack mentioned this pull request Mar 29, 2022
Copy link
Contributor

@stickies-v stickies-v left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good, I like the additional info. Even though there's some information duplication, including the friend finding process should make things a lot easier for new users.

Left a few comments, but beyond that pretty much good to go for me.

@jonatack jonatack force-pushed the doc-cjdns-how-to-find-a-friend branch from 0a7bc97 to 0156505 Compare March 30, 2022 12:12
@jonatack
Copy link
Member Author

jonatack commented Mar 30, 2022

Thank you for the feedback, @stickies-v, updated per git diff 0a7bc97 0156505

@jonatack jonatack force-pushed the doc-cjdns-how-to-find-a-friend branch from 0156505 to 3c2f7d8 Compare March 30, 2022 14:48
Copy link
Contributor

@stickies-v stickies-v left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

ACK 3c2f7d8

Copy link
Contributor

@brunoerg brunoerg left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

ACK 3c2f7d8

I followed it when testing v23 and the steps added here worked fine and was helpful.

fanquake added a commit that referenced this pull request Mar 31, 2022
174af33 util: Add inotify_rm_watch to syscall sandbox (AllowFileSystem) (Hennadii Stepanov)
ded10fe build: Fix Boost.Process test for Boost 1.78 (Hennadii Stepanov)
26c2f23 build: Fix Boost.Process detection on macOS arm64 (Hennadii Stepanov)
85f85c7 util: add linkat to syscall sandbox (AllowFileSystem) (fanquake)
eaa0419 contrib: fix signet miner (sighash mismatch) (Sebastian Falbesoner)
235b042 rpc: Exclude descriptor when address is excluded (MarcoFalke)
b05a59b ci: Temporarily use clang-13 to work around clang-14 TSan bug (MarcoFalke)
65b9667 doc, init: add links to doc/cjdns.md (Jon Atack)
7a553d4 doc: update i2p.md with cjdns, improve local addresses section (Jon Atack)
4148396 doc: update tor.md with cjdns and getnodeaddresses, fix tor grep, (Jon Atack)
4690e8a doc: create initial doc/cjdns.md for cjdns how-to documentation (Jon Atack)
5d24f61 Clarify in -maxtimeadjustment that only outbound peers influence time data (Jon Atack)
b1646f1 test: set segwit height back to 0 on regtest (Martin Zumsande)
ef6a37b rpc: rename getdeploymentinfo status-next to status_next (Jon Atack)
2a6fcf9 init, doc: improve -onlynet help and tor/i2p documentation (Jon Atack)

Pull request description:

  Backport the following to 23.x:

  - #24468
  - #24528
  - #24527
  - #24609
  - #24555
  - #24663
  - #24572
  - #24636
  - #24553
  - #24659
  - #24521
  - #24523
  - #24690
  - #24710

  Possibly also:
  - #24579
  - #24691

ACKs for top commit:
  laanwj:
    List-of-commits ACK 174af33, I think we should merge this and move forward with rc3..
  hebasto:
    ACK 174af33

Tree-SHA512: 5a493e1652b780b527767d6ca9e67012abd2fa5573496e85e0d8aa4bed3eb332bfcd72610b8dfb954ff274d42450623233c96c479de2085b9c8344ba5abf1935
doc/cjdns.md Outdated
@@ -23,17 +24,37 @@ somewhat centralized. I2P connections have a source address and I2P is slow.
CJDNS is fast but does not hide the sender and the recipient from intermediate
routers.

## Installing CJDNS and connecting to the network
## Installing CJDNS and finding a friend to connect to the network
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should it still be called a friend if it's simply a random active public peer selected from a list? 😄

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Kind of like a dating app? 😄

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

You're right, though, "peer" would be better here, done.

@laanwj
Copy link
Member

laanwj commented Apr 1, 2022

ACK 3c2f7d8

@jonatack jonatack force-pushed the doc-cjdns-how-to-find-a-friend branch from 3c2f7d8 to 6a02355 Compare April 1, 2022 14:12
@jonatack
Copy link
Member Author

jonatack commented Apr 1, 2022

Thanks for the reviews and feedback; updated with the following change.

diff --git a/doc/cjdns.md b/doc/cjdns.md
index e0e31ef130..b69564729f 100644
--- a/doc/cjdns.md
+++ b/doc/cjdns.md
@@ -24,7 +24,7 @@ somewhat centralized. I2P connections have a source address and I2P is slow.
 CJDNS is fast but does not hide the sender and the recipient from intermediate
 routers.
 
-## Installing CJDNS and finding a friend to connect to the network
+## Installing CJDNS and finding a peer to connect to the network
 
 To install and set up CJDNS, follow the instructions at
 https://github.com/cjdelisle/cjdns#how-to-install-cjdns.

Copy link
Contributor

@stickies-v stickies-v left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

re-ACK 6a02355 even though I wasn't opposed to the "friend" terminology since it's the language CJDNS seems to use to denominate the peers you connect to directly in general. Not worth bikeshedding over though.

@dunxen
Copy link
Contributor

dunxen commented Apr 1, 2022

ACK 6a02355

Copy link
Contributor

@lsilva01 lsilva01 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Strong ACK 6a02355

I skipped this step when setting up the CJDNS for the first time.
So I think it's good to reinforce this in the documentation.

@laanwj laanwj merged commit fe66dad into bitcoin:master Apr 5, 2022
@jonatack jonatack deleted the doc-cjdns-how-to-find-a-friend branch April 5, 2022 13:52
sidhujag pushed a commit to syscoin/syscoin that referenced this pull request Apr 5, 2022
@bitcoin bitcoin locked and limited conversation to collaborators Apr 5, 2023
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

7 participants