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

pull w0xlt wants to merge 1 commits into bitcoin:master from w0xlt:update-cjdns-doc changing 1 files +31 −31
  1. 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.

  2. DrahtBot added the label Docs on Mar 12, 2026
  3. 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 brunoerg
    Concept ACK jonatack, mzumsande

    If your review is incorrectly listed, please copy-paste <!–meta-tag:bot-skip–> into the comment that the bot should ignore.

  4. w0xlt commented at 1:59 am on March 12, 2026: contributor
    CI error is unrelated.
  5. DrahtBot added the label CI failed on Mar 12, 2026
  6. 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.
  7. DrahtBot removed the label CI failed on Mar 12, 2026
  8. w0xlt force-pushed on Mar 12, 2026
  9. w0xlt commented at 6:01 pm on March 12, 2026: contributor
    Thanks for the initial feedback @jonatack . Changes applied.
  10. 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.
  11. 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.
  12. brunoerg commented at 2:41 pm on March 16, 2026: contributor
    Concept ACK
  13. doc: update cjdns.md for current upstream changes 4330f7c7c5
  14. w0xlt force-pushed on Mar 17, 2026
  15. 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:

    0bruno@bruno-MS-Challenger-B850M-PLUS:~/projects/cjdns(master)$ cjdnstool peers show
    166.55.66.140:3478  v22.0000.0000.0000.0015.l58k958qvhtrw772mkr6mqsfdpktlukghvf7njsrswfy4t1kvld0.k ESTABLISHED in 0kb/s out 0kb/s "seeded_peer"
    286.38.247.222:3478 v22.0000.0000.0000.0013.ncxfftn0g95r1yz94q54h3jvy70094dfu9gx3vpmu04frwff8sk0.k ESTABLISHED in 0kb/s out 1kb/s LOS 5 "seeded_peer"
    
  16. DrahtBot requested review from jonatack on Mar 18, 2026
  17. 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.


github-metadata-mirror

This is a metadata mirror of the GitHub repository bitcoin/bitcoin. This site is not affiliated with GitHub. Content is generated from a GitHub metadata backup.
generated: 2026-03-24 09:13 UTC

This site is hosted by @0xB10C
More mirrored repositories can be found on mirror.b10c.me