System documentation, API references, and configuration guides for Reticulum-Go.
These documents describe Reticulum-Go, a Go implementation of the Reticulum Network Stack. Use them to integrate, operate, or extend the stack.
Documentation is organized by language under docs/. English lives in docs/en/. Additional languages can be added as sibling directories (for example docs/de/) without changing the English tree.
| Document | Summary |
|---|---|
| Overview | What Reticulum-Go is, goals, feature status, relationship to Python Reticulum |
| Architecture | Layered design, data flow, major components, deployment models |
| Getting started | Requirements, build, install, first run, basic troubleshooting |
| Configuration | Config file format, paths, keys, interface blocks |
| Package map | pkg/ layout, responsibilities, entry points |
| API reference | Task-first Go API: recipes, types, Python map, concurrency |
| Transport | Routing, path table, announces, forwarding, persistence |
| Interfaces | UDP, TCP, Auto, I2P, Backbone, Serial, WebSocket, QUIC, WebTransport, DNS rendezvous, VSOCK, HTTPS, IFAC, reconnect |
| Identity and destinations | Keys, hashes, destination types, announces, requests |
| Links, channels, and resources | Links, reliable channel, stream buffer, file transfer |
| Cryptography | Primitives, key formats, IFAC, ratchets, verification |
| Security | Reporting, sandbox, dos_protection, supply chain, release verification, local mesh health |
| Compatibility | Parity with Python RNS, gaps, Go-only extensions |
| Control API | Localhost JSON and WebSocket API for non-Go clients, Dart and Flutter |
| librns | C ABI map, supported surface, events, build and smoke, Odin bindings |
| CLI utilities | reticulum-go subcommands (status, slow, zen, id, probe, path, cp, pageserver), shared-instance RPC with Python |
| Embedding and WebAssembly | pkg/node, WASM, browser integration |
| Firecracker microvm | Guest rootfs, VSOCK host bridge, nested VM networking |
| Development and testing | Make/manual targets, code quality, crossref, interop, CI |
| Examples | Example programs and how to run them |
| File | Purpose |
|---|---|
| README.md | Project entry point, features, install/build |
| COMPATIBILITY.md | Detailed compatibility matrix and interop methodology (also summarized in compatibility.md) |
| deviations.md | Intentional differences from Python RNS and local hardening bounds |
| AUTHORS.md | Authorship and attribution |
| SECURITY.md | Vulnerability reporting and supply-chain detail (also summarized in security.md) |
| LICENSE | Reticulum License |
- Reticulum manual (Python API and protocol authority)
- Reticulum cryptography overview
- Python reference implementation
Go application authors should start with API reference and Examples, then use the Python manual when comparing wire semantics.