cjdns/doc/index.md

Hyperboria

The privacy-friendly network without borders

We're a community of local Wifi initiatives, programmers, and enthusiasts. We run a peer-to-peer IPv6 network with automatic end-to-end encryption, distributed IP address allocation, and DHT-based Source Routing.

• Existing applications Just Work
• Low entry barriers for users and ISPs
• Runs on Linux, Android, OpenWrt, OS X, and many others

Hyperboria is based on the cjdns routing protocol.

You can contribute to its documentaion: https://github.com/hyperboria/docs

About Hyperboria

• Asking Questions TODO
• Peering
• Security
• Meshlocals
  • Meshlocals around the world
  • Starting a Meshlocal
• FAQ
• Achievements
• Glossary

The cjdns routing protocol

• About
  • Goals (russian)
  • Original whitepaper
  • Brief intro
  • Security Specification
• Installation
  • Most Linuxes TODO
  • OpenWrt
  • Android TODO
  • Firefox OS TODO
  • macOS
  • Debian Wheezy
  • Debian Jessie
  • Arch
  • Fedora
  • FreeBSD TODO
  • OpenBSD TODO
  • Windows
  • Building on Windows
  • Securing your Windows system
• Usage
  • Setup
  • Operator guidelines
  • Securing your system
  • Tools TODO
  • Third party tools
  • Admin API
• Working with cjdns
  • Anatomy of cjdroute
  • Peering over UDP
  • nodeinfo.json
  • Changelog
• HowTo
  • Using cjdns as a VPN
  • Shorewall and VPN gateway
  • NAT gateway for non-cjdns nodes
  • Autostart at login
  • Run as non-root user
• Troubleshooting
  • Read this first
  • Memory leaks
  • SecComp
  • Analyzing network IO
  • Known issues
  • Black Hole
  • Secret Santa
  • Configurator timeout
    • Firewall on localhost
    • UDP overflow
  • Hidden Peers
  • OS/distro-specific quirks
  • Reporting bugs

Random notes, work-in-progress, inbox

These notes are unstructured, and most of them likely outdated.

• Interesting links
• ansuz' Q&A with Arceliar
• cjdns-core
• cryptography
• cjdroute.conf
• ./do
• DNS ideas
• DJC layer model
• Benchmarks
• Fun with the switch

More of this in notes/.