Reference¶
Structured facts about NetRoll. These pages answer "what exactly does X do" and "what are the valid values for Y" — for how-to guidance, start from the section that matches your task.
Pages¶
- Configuration — every environment variable, its default, and whether an invalid value stops the app booting.
- HTTP API — every REST endpoint with its method, authorization, and error semantics.
- WebSocket protocol — snapshot and delta frames, the
sinceresume cursor, event kinds, and public-stream redaction. - Webhook payload — the on-close webhook request, its HMAC signature, and every payload field, with a worked example.
- Discord message — the on-close Discord announcement: the embed shape, its size caps, and why it carries no signature and no roster.
- Roles and permissions — the capability matrix across owners, net control, loggers, relays, participants, and viewers.
- Glossary — every term NetRoll uses, including the ones with a NetRoll-specific meaning.
- Vocabulary — the one word used for each concept, in code and in prose, and the synonyms that are rejected.
Where to go instead¶
| If you want to | Go to |
|---|---|
| Stand up an instance | Self-hosting quickstart |
| Understand how the code is shaped | ARCHITECTURE.md on GitHub |
| Run a net | Live sessions |
| Fix something that's broken | Troubleshooting |