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.
49 | +git clone https://github.com/hyperboria/peers hyperboria-peers 50 | +cd hyperboria-peers 51 | +./testAvailable.py 52 | +``` 53 | + 54 | +and to choose a friend from among the peers returned in the
I think it would be prudent to recommend adding a few, say, 3-5 friends instead of just one?
Done
53 | + 54 | +and to choose a friend from among the peers returned in the 55 | +`hyperboria-peers/<continent/<country>/<city>` directories. 56 | + 57 | +You can then copy/paste its credentials into the relevant IPv4 or IPv6 58 | +"connectTo" JSON object in the `cjdroute.conf` file in your CJDNS directory and
Maybe this is platform specific, but I'm not sure there always is a "CJDNS directory"? Perhaps you could phrase it as "in the cjdroute.conf file you created in the setup phase"?
Done
50 | +cd hyperboria-peers 51 | +./testAvailable.py 52 | +``` 53 | + 54 | +and to choose a friend from among the peers returned in the 55 | +`hyperboria-peers/<continent/<country>/<city>` directories.
Phrasing is slightly ambiguous I think. Maybe you could rephrase that the script prints the location of the credentials and the pinging result, and then user can go fetch the credentials from that location and copy/paste into config? Just highlights a bit more the user action required to actually go into the folders based on script output.
Done
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.
Thank you for the feedback, @stickies-v, updated per git diff 0a7bc97 0156505
54 | +For each peer, the `./testAvailable.py` script prints the filename of the peer's 55 | +credentials followed by the ping result. 56 | + 57 | +Choose one or several peers, copy their credentials from their respective files, 58 | +paste them into the relevant IPv4 or IPv6 "connectTo" JSON object in the 59 | +`cjdroute.conf` you created in step ["1. Generate a new configuration
nit: missing word "file" after cjdroute.conf
thanks, added
ACK 3c2f7d8
ACK 3c2f7d883531a7d21e53446b25e53909226f67a4
I followed it when testing v23 and the steps added here worked fine and was helpful.
23 | @@ -23,17 +24,37 @@ somewhat centralized. I2P connections have a source address and I2P is slow. 24 | CJDNS is fast but does not hide the sender and the recipient from intermediate 25 | routers. 26 | 27 | -## Installing CJDNS and connecting to the network 28 | +## Installing CJDNS and finding a friend to connect to the network
Should it still be called a friend if it's simply a random active public peer selected from a list? :smile:
Kind of like a dating app? :smile:
You're right, though, "peer" would be better here, done.
ACK 3c2f7d883531a7d21e53446b25e53909226f67a4
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.
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.
ACK 6a02355
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.