Dokumentation
Die vollständige Dokumentation liegt neben dem Code im öffentlichen Repository und ändert sich im selben Commit wie die Funktion, die sie beschreibt. Sie ist auf Englisch; diese Seite ist die Karte.
- Anleitung zum HostenAlles für die Person, die den Server betreibt, von der ersten Installation bis zu Backups und Reparaturen.
- Entwickler-Doku (englisch)Bots, die SDKs, Webhooks und die REST- und Gateway-Referenz.
Einrichten
| Wenn du … | Lies |
|---|---|
| vom leeren Ordner aus installieren willst, mit Prüfung jedes Schritts | Quick start |
| auf Synology, Unraid, einem VPS oder einem Raspberry Pi installierst | Platform notes |
| HTTPS mit Caddy, Synology, Nginx Proxy Manager oder nginx einrichtest | Reverse proxy |
| die richtigen Ports öffnen und sehen willst, was der Server nach außen schickt | Network ports |
| ohne den Assistenten von Hand installieren willst | Deployment |
| ein Wort wie STUN, TURN oder NAT nachschlagen willst | Glossary |
Betreiben
| Wenn du … | Lies |
|---|---|
| aktualisieren, sichern oder einen Image-Tag wählen willst | Updating |
| wissen willst, was sich pro Version geändert hat, oder zurückgehen musst | Upgrade notes |
| eine Einstellung ändern, TURN ergänzen, überwachen oder wiederherstellen willst | Operations |
| „Keine Medienverbindung“ oder „Verbindung getrennt“ beheben willst | Voice troubleshooting |
| schnelle Antworten zu Domains, Cloudflare oder Tunneln suchst | FAQ |
Benutzen
| Thema | Lies |
|---|---|
| Rollen, Berechtigungen und private Kanäle | Roles and permissions |
| Moderation, Automod und das Audit-Log | Moderation |
| Talks, Stages und Lobbys | Talks |
| Foren, das Wiki und Events | Forums, Wiki, Events |
| Die Struktur eines bestehenden Servers übernehmen | Server-Import |
| Die Desktop-App | Desktop app |
Darauf aufbauen
| Thema | Lies |
|---|---|
| Bots, die REST-API und das Gateway | Bots |
| Eingehende und ausgehende Webhooks | Webhooks |
| Was stabile API ist und wie sie sich ändern darf | API stability |
| Komponenten, Datenfluss und Kapazität | Architecture |
| Bauen, testen und beitragen | Development, Contributing |
| Was getestet ist und was noch nicht | Product status |
Die API-Referenz ist in den Server eingebaut: Mit API_DOCS_ENABLED=true finden angemeldete Mitglieder sie unter /api/docs.