initial commit

README.md

@@ -0,0 +1,58 @@
+# TK Wiki Newsletter Admin
+
+Produktionsnahes internes Tool zur Erstellung von Thomas-Krenn.AG Newslettern auf Basis der letzten Wiki-Änderungen.
+
+## Funktionen
+
+- Login und Benutzerverwaltung mit RBAC (`admin`, `editor`, `reader`)
+- Verpflichtender CSRF-Schutz auf allen POST-Formularen
+- Filter in der Web-UI:
+  - Zeitraum in Tagen
+  - Nur bearbeitete Artikel
+  - Kategorie
+- Datenquelle: MediaWiki API (`recentchanges`)
+- Export:
+  - Plain Text (für Outlook)
+  - Raw HTML
+- Optionaler SMTP-Versand:
+  - UI-konfigurierbar
+  - Verteilerlisten
+  - tägliche Zeitplanung
+  - Versandprotokoll
+- Docker/Compose Betrieb
+
+## Start mit Docker
+
+1. Konfiguration anlegen:
+
+   ```bash
+   cp .env.example .env
+   ```
+
+2. Wichtige Werte in `.env` setzen:
+   - `SECRET_KEY`
+   - `ADMIN_BOOTSTRAP_EMAIL`
+   - `ADMIN_BOOTSTRAP_PASSWORD`
+
+3. Start:
+
+   ```bash
+   docker compose up --build -d
+   ```
+
+4. Zugriff:
+   - [http://localhost:8000/login](http://localhost:8000/login)
+
+## Sicherheits-Hinweise für Produktion
+
+- Reverse Proxy (z. B. Nginx/Traefik) mit TLS vor den Container setzen.
+- `SECRET_KEY` lang und zufällig setzen.
+- Bootstrap-Admin-Passwort nach erstem Login ändern.
+- Netzwerkzugriff auf interne IPs/Netze beschränken.
+- Regelmäßige Backups des `data` Volumes.
+
+## Rollenmodell
+
+- `reader`: darf Ergebnisse sehen
+- `editor`: darf Newsletter generieren und sofort versenden
+- `admin`: zusätzlich Benutzerverwaltung und SMTP-Konfiguration