docs: Dokumentation auf Feature-Stand von master aktualisiert #18

Merged
scriptos merged 2 commits from docs into master 2026-03-29 22:47:31 +00:00
4 changed files with 16 additions and 4 deletions
+10 -1
View File
@@ -10,8 +10,17 @@ Ein einfacher Daemon, der automatisch einen Geburtstagskalender für jede Mailco
## Kurzübersicht
- Liest Geburtstage aus allen CardDAV-Adressbüchern jeder Mailbox
- Liest Geburtstage und Jahrestage aus allen CardDAV-Adressbüchern jeder Mailbox
- Erstellt und synchronisiert automatisch einen Geburtstagskalender pro Benutzer
- Konfigurierbarer Kalendername (`CALENDAR_NAME`) und Kalenderfarbe (`CALENDAR_COLOR`)
- Optionale Benachrichtigungen (VALARM) zur konfigurierbarer Uhrzeit
- Konfigurierbares Sync-Intervall (`SYNC_INTERVAL`) und Event-Horizont (`EVENT_YEARS`)
- Mailboxen einzeln ausschließbar via `MAILBOX_EXCLUDE`
- Automatische App-Passwort-Verwaltung (persistent im State-File)
- Integrierter Cleanup-Befehl bei doppelten Kalendern nach Umbenennung
- Startup-Connectivity-Check, Graceful Shutdown und Docker-Healthcheck
- Hairpin-NAT-Lösung via `MAILCOW_RESOLVE_HOST` für Docker-Netze
- Strukturiertes Logging mit konfigurierbarem Log-Level
- Synchronisation standardmäßig alle **15 Minuten** (konfigurierbar über `SYNC_INTERVAL`)
- Läuft als Docker-Container direkt im Mailcow-Stack
+4 -2
View File
@@ -12,7 +12,9 @@ Willkommen in der Dokumentation des **Mailcow Birthday Daemon** 🎂
## Kurzübersicht
- Automatischer Geburtstagskalender für jede Mailcow-Mailbox
- Liest Geburtstage aus allen CardDAV-Adressbüchern
- Liest Geburtstage und Jahrestage aus allen CardDAV-Adressbüchern
- Optionale Benachrichtigungen (VALARM) zur konfigurierbaren Uhrzeit
- Konfigurierbares Sync-Intervall, Event-Horizont und Kalenderfarbe
- Mailboxen einzeln ausschließbar, strukturiertes Logging mit Log-Level
- Docker-Healthcheck, Graceful Shutdown und Startup-Connectivity-Check
- Läuft als Docker-Container im Mailcow-Stack via `docker-compose.override.yml`
- Synchronisation alle 15 Minuten, vollständig automatisch
+1 -1
View File
@@ -52,7 +52,7 @@ Die Variable kann jederzeit auch bei bestehenden Installationen per Upda
## Synchronisationsintervall
Der Synchronisationszyklus läuft standardmäßig alle **15 Minuten** automatisch. Das Intervall kann über die Umgebungsvariable `SYNC_INTERVAL` angepasst werden (z. B. `SYNC_INTERVAL=30m`). Details zu den möglichen Werten finden sich in der [Umgebungsvariablen-Tabelle](schnellstart.md#umgebungsvariablen).
Der Synchronisationszyklus läuft standardmäßig alle **15 Minuten** automatisch. Das Intervall kann über die Umgebungsvariable `SYNC_INTERVAL` angepasst werden (z. B. `SYNC_INTERVAL=30m`). Details zu den möglichen Werten finden sich in der [Umgebungsvariablen-Tabelle](schnellstart.md#umgebungsvariablen).
## Graceful Shutdown
+1
View File
@@ -72,6 +72,7 @@ docker compose pull birthdaydaemon && docker compose up -d --no-deps birthdaydae
| `EVENT_YEARS` | Nein | `10` | Anzahl der Jahre, für die Geburtstags-Events im Voraus erzeugt werden. Gültige Werte: `1``30`. Kleinere Werte können die Performance in Kalender-Clients verbessern. |
| `MAILBOX_EXCLUDE` | Nein | | Kommagetrennte Liste von Mailadressen, die von der Synchronisation ausgeschlossen werden (z. B. `admin@example.com,noreply@example.com`). Standardmäßig erhalten alle aktiven Mailboxen einen Geburtstagskalender. |
| `LOG_LEVEL` | Nein | `info` | Log-Verbosity: `debug`, `info`, `warn` oder `error`. Im `debug`-Modus werden einzelne Kalendereinträge (hinzugefügt/entfernt) und Kontaktdetails geloggt. |
## API-Key erstellen
Den API-Key findet man im Admin-Panel unter Konfiguration → Zugang → Administratordetails bearbeiten → API → Lese-/Schreibzugriff.