doc: update cjdns.md for current cjdns installation and peering #34811

w0xlt commented at 1:25 AM on March 12, 2026: contributor

Update doc/cjdns.md. Users following the current doc hit dead links when trying to set up cjdns peering. The upstream cjdns project has reorganized its README and now supports automatic peering, making most of the existing instructions obsolete.

Summary

Remove broken links to cjdns README sections ("2. Find a friend", "3. Connect your node to your friend's node") that no longer exist upstream
Remove reference to hyperboria/peers repo and testAvailable.py (last updated Feb 2024, likely stale)
Add cjdns.sh as recommended install method alongside building from source
Document automatic peering via DNS seeding (default since cjdns v22), which makes manual peer discovery unnecessary for most users
Simplify manual peering instructions with a clear connectTo example and link to upstream doc/peering.md
Add cjdnstool peers show as the way to verify network connectivity

The Bitcoin Core-specific sections (-cjdnsreachable, -onlynet=cjdns, admin commands, etc.) are unchanged.

DrahtBot added the label Docs on Mar 12, 2026

DrahtBot commented at 1:25 AM on March 12, 2026: 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	stratospher, brunoerg, naiyoma, achow101
Concept ACK	jonatack, mzumsande

If your review is incorrectly listed, please copy-paste <code></code> into the comment that the bot should ignore.

w0xlt commented at 1:59 AM on March 12, 2026: contributor

CI error is unrelated.

DrahtBot added the label CI failed on Mar 12, 2026

jonatack commented at 3:56 AM on March 12, 2026: member

Concept ACK, thanks for picking this up. The manual "find a friend" step has likely been a key obstacle to adoption of this network and to automating its use with a simple toggle in node-in-a-box packages.

Two comments at first glance:

Maybe use "CJDNS" or "cjdns" consistently.
Don't reformat lines that otherwise aren't being changed.

DrahtBot removed the label CI failed on Mar 12, 2026

w0xlt force-pushed on Mar 12, 2026

w0xlt commented at 6:01 PM on March 12, 2026: contributor

Thanks for the initial feedback @jonatack . Changes applied.

in doc/cjdns.md:35 in d29f3b3494

  32 | +
  33 | +### Option 1: Using cjdns.sh (recommended for Linux amd64)
  34 | +
  35 | +If you're on Linux with an amd64 processor, you can install pre-built binaries:
  36 | +
  37 | +    curl -s https://pkt.cash/special/cjdns/cjdns.sh | sudo sh

sedited commented at 12:39 PM on March 13, 2026:

I don't think including this here is a good idea. Isn't it enough to refer to the cjdns readme above, which contains the same instructions?

brunoerg commented at 2:41 PM on March 16, 2026:

I agree with @sedited. I think this kind of documentation is hard to maintain by our side and pointing to the cjdns readme should be enough since it contains the required instructions to build it (e.g https://github.com/cjdelisle/cjdns?tab=readme-ov-file#how-to-install-cjdns which points to https://github.com/cjdelisle/cjdns.sh).

darosior commented at 6:25 PM on March 17, 2026:

I agree. Our documentation shouldn't suggest curl | sudo shing a third-party-hosted script.

w0xlt commented at 8:22 PM on March 17, 2026:

Done in 4330f7c7c5. Thanks.

brunoerg commented at 2:04 PM on March 18, 2026:

PR description has to be updated.

sedited commented at 12:55 PM on March 13, 2026: contributor

I'm not sure about making the installation instructions that elaborate. Linking to the upstream instructions seems good enough to me.

brunoerg commented at 2:41 PM on March 16, 2026: contributor

Concept ACK

w0xlt force-pushed on Mar 17, 2026

brunoerg commented at 2:03 PM on March 18, 2026: contributor

ACK 4330f7c7c54b36459c111cf6638cbefbcfe2206b

I just installed and ran CJDNS v22, tested that it automatically discovered and connected to other peers and it's working with Bitcoin Core - didn't test the manual peering:

bruno@bruno-MS-Challenger-B850M-PLUS:~/projects/cjdns(master)$ cjdnstool peers show
66.55.66.140:3478  v22.0000.0000.0000.0015.l58k958qvhtrw772mkr6mqsfdpktlukghvf7njsrswfy4t1kvld0.k ESTABLISHED in 0kb/s out 0kb/s "seeded_peer"
86.38.247.222:3478 v22.0000.0000.0000.0013.ncxfftn0g95r1yz94q54h3jvy70094dfu9gx3vpmu04frwff8sk0.k ESTABLISHED in 0kb/s out 1kb/s LOS 5 "seeded_peer"

DrahtBot requested review from jonatack on Mar 18, 2026

mzumsande commented at 2:32 PM on March 18, 2026: contributor

Concept ACK

Hopefully this will lead to more people using it. If no meaningful adoption happens (last time I checked there were <10 nodes available on mainnet, mostly run by devs) we should think about removing cjdns in some future version.

doc: update cjdns.md for current upstream changes 6b99a3e4f0

in doc/cjdns.md:60 in 4330f7c7c5

  77 | +        "login": "your-login",
  78 | +        "password": "the-password-they-gave-you",
  79 | +        "publicKey": "theirPublicKeyEndingWith.k"
  80 | +    }
  81 | +}
  82 | +```

sedited commented at 11:14 AM on March 20, 2026:

Is this really useful by itself? How do you get these peer details? Seems like this is all clearer described in their own documentation. Maybe collapse these subsections together, something like:

### Connecting to the CJDNS network

As of CJDNS v22, nodes automatically discover and connect to peers via DNS
seeding. After installation, you can verify that your node has peers:

    cjdnstool peers show

If you see peers with status `ESTABLISHED`, your node is connected and no
further peering setup is needed.

Manual peering may be useful if you want to guarantee a connection to a specific
node, or if you have disabled DNS seeding for privacy reasons. See [doc/peering.md](https://github.com/cjdelisle/cjdns/blob/master/doc/peering.md)
in the CJDNS repository for details.

w0xlt commented at 9:59 PM on March 24, 2026:

Done. Thanks.

w0xlt force-pushed on Mar 24, 2026

in doc/cjdns.md:34 in 6b99a3e4f0

  38 | -in the CJDNS documentation.
  39 | +## Connecting to the CJDNS network
  40 |  
  41 | -One quick way to accomplish these two steps is to query for available public
  42 | -peers on [Hyperboria](https://github.com/hyperboria) by running the following:
  43 | +As of CJDNS v22, nodes automatically discover and connect to peers via DNS

stratospher commented at 3:23 PM on March 27, 2026:

6b99a3e: looks like CJDNS v22 was 3 years ago and CJDNS v22.1 from last year did the DNS seed auto-peering - https://github.com/cjdelisle/cjdns/blob/master/CHANGELOG.md#version-221---seedy

stratospher commented at 3:30 PM on March 27, 2026: contributor

ACK 6b99a3e. worked on nixos.

cjdns nixpkgs didn’t do DNS seed auto-peering by default. so had to do cjdroute --genconf first and specify that in configuration.nix. still this looks way easier than before!

DrahtBot requested review from brunoerg on Mar 27, 2026

DrahtBot requested review from mzumsande on Mar 27, 2026

brunoerg commented at 4:58 PM on March 27, 2026: contributor

reACK 6b99a3e4f0e05bf6753231dfead62ef3f32d6a9d

4330f7c7c54b36459c111cf6638cbefbcfe2206b..6b99a3e4f0e05bf6753231dfead62ef3f32d6a9d: Removed information about manual peering.

naiyoma commented at 2:15 PM on March 30, 2026: contributor

TestedACK 6b99a3e4f0e05bf6753231dfead62ef3f32d6a9d Followed the instructions, I was able to set up CJDNS and could see 2 peers

./cjdnstool peers show
152.70.198.213:3478 v22.0000.0000.0000.0015.2wlrw5rk1y7znp2gm6vg8k5szq4fcbcvmuglj6cr9bu7m9np2wp0.k ESTABLISHED in 0kb/s out 0kb/s "seeded_peer"
185.181.60.251:3401 v22.0000.0000.0000.0013.5sgs8q6md75qmcm9hnj2l3sfqnsk8dg0jnbm1fwpv5lh0udgbsy0.k ESTABLISHED in 0kb/s out 0kb/s "seeded_peer"

Add cjdns.sh as recommended install method alongside building from source

Could you also update the description?

achow101 commented at 8:58 PM on March 30, 2026: member

ACK 6b99a3e4f0e05bf6753231dfead62ef3f32d6a9d

achow101 merged this on Mar 30, 2026

achow101 closed this on Mar 30, 2026