Web Variante in Go V0.1
This commit is contained in:
1 parent
f9e3e94629
commit
692b9b6ef8
60 files changed
+13140
No files matched your search
+186
@@ -0,0 +1,186 @@
|
||||
# LektorenPlan Web
|
||||
|
||||
Browserbasierte, funktional entsprechende Umsetzung der macOS-App
|
||||
**LektorenPlan**: Gottesdienstplan, Gottesdienstordnung, Teamverwaltung,
|
||||
Statistik, Austausch, liturgischer Kalender, PDF/ Druck und eine
|
||||
Mehrbenutzerverwaltung mit Mandanten.
|
||||
|
||||
Die Webversion läuft als einzelner Go-Prozess mit einer SQLite-Datenbank. Sie
|
||||
ist **CGO-frei** und lässt sich damit unkompliziert für Linux/arm64 (z. B.
|
||||
Raspberry Pi, ARM-Server, Docker) bauen. Die bestehende macOS-App bleibt
|
||||
unverändert nutzbar.
|
||||
|
||||
## Funktionsumfang
|
||||
|
||||
- **Gottesdienstplan** mit Tageszeilen, Lesungen, Kirchenspalten, Feiertagen
|
||||
und farblich markierter Liturgie
|
||||
- **Automatische Planung** mit Ausschlüssen, Präferenzen, Fairness und
|
||||
Doppelrollen-Regeln; manuelle Nachsteuerung inklusive Sperren
|
||||
- **Gottesdienstordnung** mit wiederkehrenden Vorlagen, Ausnahmen und
|
||||
Sondergottesdiensten (auch außerhalb der Kirche)
|
||||
- **Team & Abwesenheiten** mit Rollen, Präferenzen, Monatslimits und
|
||||
Einsatzhistorie
|
||||
- **Statistik** über Besetzung, Fairness, Monatsverlauf und Kirchenverteilung
|
||||
- **Austausch** per JSON-Export und zweistufigem Import mit Vorschau
|
||||
- **Liturgischer Kalender** für das Erzbistum Köln mit Online-Aktualisierung,
|
||||
Offline-Snapshot und lokaler Berechnung als Rückfallebene
|
||||
- **PDF/Druck** in zwei Varianten: A4 quer als vollständiger Plan und A4 hoch
|
||||
als kompakte Gottesdienstliste
|
||||
- **Mandanten, Konten und Kirchen** zentral über die Administration verwalten
|
||||
|
||||
## Schnellstart
|
||||
|
||||
Voraussetzung: Go 1.27 oder neuer.
|
||||
|
||||
```bash
|
||||
cd web
|
||||
go run . -seed-demo -demo
|
||||
```
|
||||
|
||||
Anschließend <http://localhost:8080> öffnen.
|
||||
|
||||
Die Demo-Datenbank wird beim ersten Start angelegt. Mit den dokumentierten
|
||||
Demo-Zugängen erhält man sofort einen vollständigen Plan:
|
||||
|
||||
| Konto | Passwort | Rolle |
|
||||
|----------|------------|---------------|
|
||||
| `admin` | `admin123` | Administrator |
|
||||
| `editor` | `editor123`| Redakteur |
|
||||
| `reader` | `reader123`| Leser |
|
||||
|
||||
> Die Demo-Zugänge sind ausschließlich für lokale Tests gedacht. In einer
|
||||
> produktiven Installation `-seed-demo` weglassen und ein eigenes
|
||||
> Administratorkonto anlegen.
|
||||
|
||||
Ohne `-seed-demo` und ohne vorhandene Konten erzeugt der Server automatisch
|
||||
einen Administrator. Wird kein Passwort übergeben, wird ein einmaliges
|
||||
Zufallspasswort im Log ausgegeben:
|
||||
|
||||
```bash
|
||||
go run . -db /var/lib/lektorenplan/lektorenplan.db \
|
||||
-admin-user admin -admin-password 'ein-sicheres-passwort'
|
||||
```
|
||||
|
||||
## Konfiguration
|
||||
|
||||
Alle Flags lassen sich auch über Umgebungsvariablen setzen:
|
||||
|
||||
| Flag | Umgebungsvariable | Standard | Bedeutung |
|
||||
|------|-------------------|----------|-----------|
|
||||
| `-addr` | `LP_ADDR` | `:8080` | HTTP-Listenadresse |
|
||||
| `-db` | `LP_DB` | `lektorenplan.db` | Pfad zur SQLite-Datei |
|
||||
| `-seed-demo` | `LP_SEED_DEMO` | `false` | Demo-Mandanten und Demo-Konten anlegen |
|
||||
| `-admin-user` | `LP_ADMIN_USER` | `admin` | Benutzername des ersten Administrators |
|
||||
| `-admin-password` | `LP_ADMIN_PASSWORD` | – | Passwort des ersten Administrators |
|
||||
| `-secure-cookies` | `LP_SECURE_COOKIES` | `false` | Cookies nur über HTTPS senden |
|
||||
| `-demo` | `LP_DEMO_MODE` | `false` | Demo-Hinweis in der Oberfläche anzeigen |
|
||||
| `-sync-liturgy` | `LP_SYNC_LITURGY` | `true` | Liturgischen Kalender täglich im Hintergrund aktualisieren |
|
||||
|
||||
## Rollen und Mandanten
|
||||
|
||||
Jedes Konto hat genau eine globale Rolle:
|
||||
|
||||
- **Administrator** verwaltet alle Mandanten, Konten und Kirchen und darf überall
|
||||
planen.
|
||||
- **Redakteur** bearbeitet die ihm freigegebenen Mandanten.
|
||||
- **Leser** sieht die ihm freigegebenen Mandanten ausschließlich lesend.
|
||||
|
||||
Planungsdaten (Kirchen, Personen, Vorlagen, Gottesdienste, Einteilungen,
|
||||
Abwesenheiten und Einstellungen) sind immer einem Mandanten zugeordnet.
|
||||
Administratoren sehen alle Mandanten; Redakteure und Leser nur die in
|
||||
`memberships` eingetragenen. Der aktive Mandant wird über die Seitenleiste
|
||||
gewechselt.
|
||||
|
||||
## Bauen und testen
|
||||
|
||||
```bash
|
||||
cd web
|
||||
|
||||
gofmt -l .
|
||||
go vet ./...
|
||||
go test ./...
|
||||
go build ./...
|
||||
|
||||
# statisches Linux/arm64-Binary
|
||||
./scripts/build-linux-arm64.sh
|
||||
# → dist/lektorenplan-linux-arm64
|
||||
```
|
||||
|
||||
Das Binary ist statisch gelinkt und benötigt auf dem Zielsystem weder libc
|
||||
noch eine SQLite-Installation.
|
||||
|
||||
## Deployment (Linux/arm64)
|
||||
|
||||
Beispiel für eine Installation unter `/opt/lektorenplan`:
|
||||
|
||||
```bash
|
||||
# Binary auf den Server kopieren
|
||||
scp dist/lektorenplan-linux-arm64 server:/tmp/lektorenplan
|
||||
|
||||
ssh server
|
||||
sudo useradd --system --home /opt/lektorenplan --shell /usr/sbin/nologin lektorenplan
|
||||
sudo install -d -o lektorenplan -g lektorenplan /opt/lektorenplan /var/lib/lektorenplan
|
||||
sudo install -m 0755 -o lektorenplan -g lektorenplan \
|
||||
/tmp/lektorenplan /opt/lektorenplan/lektorenplan
|
||||
```
|
||||
|
||||
Dienst einrichten (Vorlage: [`scripts/lektorenplan.service`](scripts/lektorenplan.service)):
|
||||
|
||||
```bash
|
||||
sudo cp scripts/lektorenplan.service /etc/systemd/system/
|
||||
sudo systemctl daemon-reload
|
||||
sudo systemctl enable --now lektorenplan
|
||||
```
|
||||
|
||||
Empfohlen ist ein Reverse Proxy mit TLS (Caddy, nginx oder Traefik), der auf
|
||||
`127.0.0.1:8080` weiterleitet. Dabei `LP_SECURE_COOKIES=true` setzen. Der
|
||||
Server sollte nicht direkt öffentlich erreichbar sein.
|
||||
|
||||
### Betrieb und Sicherheit
|
||||
|
||||
- **Backups:** SQLite-Datei regelmäßig sichern, idealerweise mit
|
||||
`sqlite3 /var/lib/lektorenplan/lektorenplan.db ".backup ..."` oder im
|
||||
laufenden Betrieb über einen Dateisystem-Snapshot. WAL-Dateien
|
||||
(`-wal`, `-shm`) gehören zum konsistenten Stand.
|
||||
- **Passwörter:** bcrypt-Hashes, serverseitige Sitzungen, HttpOnly-Cookies,
|
||||
CSRF-Schutz auf allen schreibenden Formularen.
|
||||
- **Erster Login:** Nach dem Anlegen des Administrators das Initialpasswort
|
||||
ändern und Demo-Konten entfernen bzw. deaktivieren.
|
||||
- **Updates:** Neue Binärdatei austauschen und Dienst neu starten. Das
|
||||
Datenbankschema wird beim Start automatisch migriert.
|
||||
- **Netzwerk:** Der Prozess lauscht standardmäßig auf allen Interfaces. Für
|
||||
einen Proxy-Betrieb `-addr 127.0.0.1:8080` verwenden.
|
||||
|
||||
## Projektstruktur
|
||||
|
||||
```
|
||||
web/
|
||||
├── main.go Start, Flags, Bootstrap, täglicher Liturgie-Sync
|
||||
├── domain/ Modelle, Datumslogik, Planer, Statistik, Liturgie
|
||||
├── liturgy/ Online-API, Offline-Snapshot, lokale Berechnung
|
||||
├── store/ SQLite-Schema, Mandanten, Konten, Planungsdaten
|
||||
├── pdf/ PDF-Renderer (A4 quer und A4 hoch)
|
||||
├── web/ HTTP-Server, Handler, Templates, CSS/JS
|
||||
│ ├── templates/ serverseitige html/template-Seiten
|
||||
│ └── static/ Stylesheet und progressive JavaScript-Helfer
|
||||
└── scripts/ Build- und Deployment-Vorlagen
|
||||
```
|
||||
|
||||
## Liturgische Daten
|
||||
|
||||
Der liturgische Kalender stammt von
|
||||
[www.eucharistiefeier.de](https://www.eucharistiefeier.de). Für die Jahre
|
||||
2025–2028 ist ein Offline-Snapshot eingebettet. Die Anwendung aktualisiert den
|
||||
aktuellen und den Folgejahrgang täglich im Hintergrund, sofern
|
||||
`LP_SYNC_LITURGY` nicht deaktiviert ist. Schlägt der Online-Abruf fehl, werden
|
||||
fehlende Tage lokal berechnet, damit Planung und PDF-Export weiterhin
|
||||
funktionieren.
|
||||
|
||||
> Daten von www.eucharistiefeier.de – fair use, ausschließlich zur Anzeige.
|
||||
> Die Daten bleiben Eigentum der Quelle.
|
||||
|
||||
## Hinweis zur macOS-App
|
||||
|
||||
Die Webversion liegt vollständig unter `web/` und verwendet ein eigenes
|
||||
Go-Modul. Die SwiftUI-App unter `Sources/` wird dadurch nicht verändert. Beide
|
||||
Varianten können parallel gebaut und betrieben werden.
|
||||
Reference in new issue
Block a user