docs: Handbuchseite, README und Fahrplan fuer M6

Der Wartungsplaner steht als offener Punkt drin, nicht als Haken.

Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
This commit is contained in:
Florian Wilde
2026-09-12 04:51:38 +02:00
co-authored by Claude Opus 5
parent 3c7cdbbbf3
commit 475b1d5c08
5 changed files with 263 additions and 12 deletions
+46 -3
View File
@@ -33,8 +33,12 @@ wird.
Bereich, wie voll der heutige Tag schon ist
- **Wochenplanung** per Ziehen und Ablegen: Aufgaben werden zu echten
Kalenderterminen, Verschiebungen im Kalender kommen zurück
- **Benachrichtigungen** per Web-Push und E-Mail: Tagesüberblick, fällige
Aufgaben, Vorlauf vor einem Zeitblock — mit Ruhezeiten und ab Werk still
- **Benachrichtigungen** per Web-Push, E-Mail und Telegram: Tagesüberblick,
fällige Aufgaben, Vorlauf vor einem Zeitblock — mit Ruhezeiten und ab Werk
still
- **Integrationen**: Zammad-Tickets werden zu Aufgaben, Telegram erfasst und
hakt ab, und der Spiegel bringt dienstliche Belegung nach Hause — ohne
Titel
- Anmeldung über einen OIDC-Anbieter, über Passkeys oder mit E-Mail und
Passwort — je Instanz einzeln zuschaltbar
- Rollen `Benutzer` und `Verwaltung`; jede schreibende Aktion wird
@@ -45,7 +49,7 @@ wird.
### Geplant
Integrationen, Schnellerfassung vom Handy und ein MCP-Server.
Schnellerfassung vom Handy, eine öffentliche API und ein MCP-Server.
Siehe [ROADMAP.md](ROADMAP.md).
## Bildergalerie
@@ -63,6 +67,7 @@ Siehe [ROADMAP.md](ROADMAP.md).
| Bereiche | ![Bereiche, hell](docs/bilder/bereiche-hell-schreibtisch.png) | ![Bereiche, dunkel](docs/bilder/bereiche-dunkel-schreibtisch.png) |
| Einstellungen | ![Einstellungen, hell](docs/bilder/einstellungen-hell-schreibtisch.png) | ![Einstellungen, dunkel](docs/bilder/einstellungen-dunkel-schreibtisch.png) |
| Meldungen | ![Benachrichtigungen, hell](docs/bilder/benachrichtigungen-hell-schreibtisch.png) | ![Benachrichtigungen, dunkel](docs/bilder/benachrichtigungen-dunkel-schreibtisch.png) |
| Integrationen | ![Integrationen, hell](docs/bilder/integrationen-hell-schreibtisch.png) | ![Integrationen, dunkel](docs/bilder/integrationen-dunkel-schreibtisch.png) |
| Protokoll | ![Protokoll, hell](docs/bilder/protokoll-hell-schreibtisch.png) | ![Protokoll, dunkel](docs/bilder/protokoll-dunkel-schreibtisch.png) |
Alle Bilder entstehen mit `npm run screenshots` in einer Wegwerf-Instanz mit
@@ -171,6 +176,44 @@ Klartextadresse nicht.
Was der Planer wann meldet, steht im
[Handbuch](docs/handbuch/benachrichtigungen.md).
### Integrationen
Welche Integration eine Instanz überhaupt darf, entscheidet `INSTANZ` — nicht
die Konfiguration. Ein Zammad-Token in der Instanz `daheim` bleibt wirkungslos.
| Variable | Standard | Bedeutung |
| ------------------- | ------------------- | ---------------------------------------------------------------- |
| `ZAMMAD_URL` | _(leer)_ | Adresse der Zammad-Instanz, nur `firma` |
| `ZAMMAD_TOKEN` | _(leer)_ | Token aus **Profil → Token-Zugriff** |
| `ZAMMAD_ABFRAGE` | `owner_id:me AND …` | Suchausdruck; was darauf passt, wird zur Aufgabe |
| `TELEGRAM_TOKEN` | _(leer)_ | Bot-Token von [@BotFather](https://t.me/BotFather), nur `daheim` |
| `SPIEGEL_GEHEIMNIS` | _(leer)_ | Gemeinsames Geheimnis beider Instanzen |
| `SPIEGEL_ZIEL` | _(leer)_ | Adresse der empfangenden Instanz; nur auf der sendenden Seite |
**Zammad** liest nur. Ein Ticket schließt man im Ticketsystem — sonst weiß die
Kollegin nicht, warum es plötzlich zu ist. Umgekehrt schließt der Planer eine
Aufgabe, sobald Zammad das Ticket als erledigt meldet.
**Telegram** braucht keinen Webhook und damit keine von außen erreichbare
Adresse. Welche Chats mitreden dürfen, wird in der Anwendung unter
**Integrationen** gekoppelt: Knopf drücken, Code an den Bot schicken, fertig.
Nachrichten aus unbekannten Chats werden verworfen, ohne zu antworten.
**Der Spiegel** geht in eine Richtung: `firma` sendet, `daheim` empfängt.
Hinüber gehen Belegungen **ohne Titel** — daheim ist zu sehen, _dass_ die Zeit
weg ist, nicht woran gearbeitet wird — und jene Aufgaben, die einzeln zum
Spiegeln markiert wurden. Jede Sendung ist mit dem gemeinsamen Geheimnis
signiert und älter als fünf Minuten wertlos.
Das Geheimnis erzeugst du wie das Sitzungsgeheimnis:
```bash
openssl rand -base64 32
```
Was der Alltag damit anfängt, steht im
[Handbuch](docs/handbuch/integrationen.md).
### Einrichtung und Sonstiges
| Variable | Standard | Bedeutung |