diff --git a/README.md b/README.md index 6e4dc12..c3b2d05 100644 --- a/README.md +++ b/README.md @@ -303,3 +303,30 @@ Alle Webhooks: | Ein neuer Nutzer hat sich registriert |
x-webhook-action: signup|
{
// Vorname des Nutzers
firstname: string,
// Nachname des Nutzers
lastname: string,
// Geburtstag des Nutzers im YYYY-MM-DD format
birthday: string,
// Telefonnummer des Nutzers. `null` wenn keine angegeben wurde
telephone: string \| null,
// Spielername des Nutzers
username: string,
// Minecraft-Edition des Nutzers
edition: 'java' \| 'bedrock'
// UUID des Nutzers. null wenn keine UUID ermittelt werden konnte
uuid: string \| null,
// IP-Adresse des Users
ip: string
} |
| Ein neuer Report wurde erstellt | x-webhook-action: report|
{
// Username des Reporters. `null` wenn der Report vom System gemacht wurde
reporter: string \| null,
// Username des reporteten Spielers. `null` wenn Spieler unbekannt ist
reported: string \| null,
// Grund des Reports
reason: string
} |
| Ein neuer Strike wurde erstellt | x-webhook-action: strike|
{
// UUID des Spielers, der gestriked wurde uuid: string
} |
+
+## Environment Variables
+
+| Name | Default | Beschreibung |
+| --------------------- | -------------------------- | -------------------------------------------------------------------------------------------------- |
+| `HOST` | `0.0.0.0` | Bind-Adresse des Webservers |
+| `PORT` | `8080` | Port des Webservers |
+| `ROOT_URL` | `http://localhost:4321` | Vollständige öffentliche URL inklusive Subpath|
+| `DATABASE_URI` | - | MariaDB URI. Muss gesetzt sein. |
+| `API_SECRET` | - | Basic-Auth-Passwort für externe API-Endpunkte. Ohne Wert ist die API-Authentifizierung deaktiviert |
+| `ADMIN_USER` | - | Benutzername für den default Admin User. Ohne Wert ist der Admin User deaktiviert |
+| `ADMIN_PASSWORD` | - | Passwort für den default Admin User. Ohne Wert ist der Admin User deaktiviert |
+| `ADMIN_COOKIE` | `muelleel` | Name des Admin-Session-Cookies |
+| `UPLOAD_PATH` | - | Verzeichnis für Report-Anhänge. Ohne Wert sind Uploads deaktiviert |
+| `VIDEO_PATH` | - | Verzeichnis für Videos. Ohne Wert sind die Video-Routen deaktiviert |
+| `CACHE_PATH` | OS-Temp-Verzeichnis | Verzeichnis für generierte Caches, z.B. Video Thumbnails |
+| `MAX_UPLOAD_BYTES` | `20971520` | Maximale Gesamtgröße aller Report-Anhänge eines Reports in Bytes |
+| `START_DATE` | `1970-01-01` | Startdatum/Startzeit für Countdown und Anmeldung |
+| `WEBHOOK_ENDPOINT` | - | Kommaseparierte Liste von Webhook-URLs |
+| `STATISTICS_ENDPOINT` | - | Endpoint für Live-Statistiken. Ohne Wert werden keine Statistiken geladen |
+| `STATISTICS_INTERVAL` | `1800` | Abfrageintervall für Live-Statistiken in Sekunden |
+| `TEAMSPEAK_LINK` | `http://example.com` | Link zum TeamSpeak-Server |
+| `DISCORD_LINK` | `http://example.com` | Link zum Discord-Server |
+| `PAYPAL_LINK` | `http://example.com` | Link für PayPal Spenden |
+| `SERVER_IP` | `http://example.com` | Öffentliche Minecraft-Server-Adresse |
+| `OPENXBL_API_KEY` | - | API-Key für die Xbox-/Bedrock-UUID-Suche. Ohne Key schlägt die Bedrock-UUID-Ermittlung fehl |
+| `LOG_LEVEL` | Dev: `debug`, Prod: `warn` | Log-Level, als `trace`, `debug`, `info`, `warn` oder `error` |