63 lines
2.8 KiB
Markdown
63 lines
2.8 KiB
Markdown
# Mailcow Birthday Daemon 🎂
|
||
|
||
> **Fork-Hinweis:** Dieses Projekt ist ein Fork von [Marco98/mailcow-birthday-daemon](https://github.com/Marco98/mailcow-birthday-daemon) und wird hier eigenständig weiterentwickelt.
|
||
|
||
> **Hinweis zur Entwicklung:** Dieses Projekt wird mit Unterstützung von KI-gestützten Entwicklungswerkzeugen gepflegt. Go ist nicht meine primäre Sprache – umso wichtiger sind sauberer Code, Tests und transparente Entwicklung.
|
||
|
||
Ein einfacher Daemon, der automatisch einen Geburtstagskalender für jede Mailcow-Mailbox erzeugt und synchronisiert. Es ist kein Benutzereingriff erforderlich – alles läuft vollautomatisch.
|
||
|
||
|
||
|
||
## Kurzübersicht
|
||
|
||
- Liest Geburtstage aus allen CardDAV-Adressbüchern jeder Mailbox
|
||
- Erstellt und synchronisiert automatisch einen Geburtstagskalender pro Benutzer
|
||
- Synchronisation alle **15 Minuten**
|
||
- Läuft als Docker-Container direkt im Mailcow-Stack
|
||
|
||
## Schnellstart
|
||
|
||
Den folgenden Abschnitt in eine `docker-compose.override.yml` im Mailcow-Verzeichnis (z. B. `/opt/mailcow-dockerized`) einfügen:
|
||
|
||
> **Wichtig:** Da `mailcow-dockerized` die eigene `docker-compose.yml` bei Updates überschreibt, müssen eigene Anpassungen immer in der `docker-compose.override.yml` erfolgen. Docker Compose lädt diese Datei automatisch und mergt sie mit der Hauptkonfiguration – eigene Änderungen gehen dadurch bei Mailcow-Updates nicht verloren.
|
||
|
||
```yaml
|
||
services:
|
||
birthdaydaemon:
|
||
image: git.techniverse.net/scriptos/mailcow-birthday-daemon:latest
|
||
restart: always
|
||
depends_on:
|
||
- nginx-mailcow
|
||
networks:
|
||
- mailcow-network
|
||
environment:
|
||
- MAILCOW_BASE=https://mail.example.com
|
||
- MAILCOW_APIKEY=DEIN-APIKEY-HIER
|
||
volumes:
|
||
- birthdaydaemon:/data
|
||
|
||
volumes:
|
||
birthdaydaemon:
|
||
```
|
||
|
||
Anschließend starten:
|
||
|
||
```bash
|
||
cd /opt/mailcow-dockerized
|
||
docker compose up -d
|
||
```
|
||
|
||
> Alle verfügbaren Image-Tags sind in der [Container Registry](https://git.techniverse.net/scriptos/-/packages/container/mailcow-birthday-daemon) einsehbar.
|
||
|
||
## Dokumentation
|
||
|
||
Die vollständige Dokumentation befindet sich im Ordner [`docs/`](docs/README.md).
|
||
|
||
<p align="center">
|
||
<img src="https://assets.techniverse.net/f1/git/graphics/gray0-catonline.svg" alt="">
|
||
</p>
|
||
|
||
<p align="center">
|
||
<img src="https://assets.techniverse.net/f1/logos/small/license.png" alt="License" width="15" height="15"> <a href="./LICENSE">License</a> | <img src="https://assets.techniverse.net/f1/logos/small/matrix2.svg" alt="Matrix" width="15" height="15"> <a href="https://matrix.to/#/#community:techniverse.net">Matrix</a> | <img src="https://assets.techniverse.net/f1/logos/small/mastodon2.svg" alt="Mastodon" width="15" height="15"> <a href="https://social.techniverse.net/@donnerwolke">Mastodon</a>
|
||
</p>
|