NetRoll documentation¶
NetRoll by N1CCK is a browser-first app for running amateur-radio nets — coordinated on-air meetups where stations check in, exchange signal reports, and follow a net-control-moderated agenda. This documentation covers running a net, joining one, self-hosting an instance, and working on the code.
Start here¶
Create an account — three minutes, and everything else follows from it. Then run your first net, or join someone else's.
Just want to watch a net? That needs no account at all — go straight to join a net.
Or jump to your track¶
- Run nets — you're a net owner or net control station (NCS) and want a live session with stations checking in.
- Self-host NetRoll — you want to run your own instance. Nothing in NetRoll depends on infrastructure operated by N1CCK.
- Work on the code? Read CONTRIBUTING.md on GitHub; the code's shape is in ARCHITECTURE.md.
Sections¶
These follow the order you'd meet them: learn it, set a net up, run it, then the operator track, with lookup material last.
| Section | What's in it |
|---|---|
| Getting started | Create an account, then run or join your first net |
| Nets | Create, schedule, publish, and co-own a net definition |
| Live sessions | Run a net: check-ins, roster, roles, handoff, export |
| Your account | Sign-in, callsign, QRZ credentials, data rights |
| Troubleshooting | Fixes organized by what you're seeing |
| Self-hosting | Deploy and operate your own instance |
| Reference | Configuration, HTTP API, WebSocket protocol, roles, glossary, vocabulary |
New to the terminology?¶
NetRoll uses amateur-radio net vocabulary throughout — net, NCS, check-in, roll call, precedence, relay. The glossary defines every term the app uses, including the ones that mean something specific inside NetRoll (a net definition is not the same thing as a net session).