Instanz-Backup mit Restore per CLI #109

Closed
opened 2026-11-05 12:05:34 +01:00 by miko · 1 comment
Owner

Part of #105

Blocked by: #108

Admins können die ganze Instanz als Backup exportieren und in einer neuen, leeren Instanz wiederherstellen, für Backups und Umzüge.

Entscheidungen

  • Inhalt: alles, sodass ein Restore die Instanz exakt wiederherstellt.
    • Kategorien samt Category Images
    • Anleitungen mit Working Copy, allen Versionen und gelöschten Anleitungen
    • Pages samt Page Images, Menü und Einstellungen
    • Benutzer (ID beim Identity Provider, Name, E-Mail, zuletzt bekannte Rolle)
    • alle Dateien
  • Rollen werden wie gehabt bei der nächsten Anmeldung aus den Gruppen des Identity Providers neu abgeleitet (ADR-0009).
  • Format: dasselbe ZIP-Format wie beim Export einzelner Anleitungen (#108), erweitert um die Instanz-Daten, mit gemeinsamer formatVersion.
  • Export im Admin-Menü als gestreamter ZIP-Download. Backups mit allen Bildern können mehrere GB groß werden.
  • Restore als CLI-Befehl im Container, z. B. docker compose exec kataba npm run restore -- backup.zip, nicht über den Browser.
  • Der Restore funktioniert nur in eine leere Instanz (direkt nach der Installation). Ein Zusammenführen oder Überschreiben gibt es nicht.
  • Nicht Teil dieses Tickets: zeitgesteuerte automatische Backups.
  • Doku:
    • Neue ADR: Backup-Format mit formatVersion, Restore nur in eine leere Instanz und per CLI.
    • Abschnitt zu Backup und Restore im README.
    • GLOSSARY.md: Eintrag Backup ergänzen.
Part of #105 Blocked by: #108 Admins können die ganze Instanz als Backup exportieren und in einer neuen, leeren Instanz wiederherstellen, für Backups und Umzüge. ## Entscheidungen - **Inhalt**: **alles**, sodass ein Restore die Instanz exakt wiederherstellt. - Kategorien samt Category Images - Anleitungen mit Working Copy, **allen Versionen** und gelöschten Anleitungen - Pages samt Page Images, Menü und Einstellungen - Benutzer (ID beim Identity Provider, Name, E-Mail, zuletzt bekannte Rolle) - alle Dateien - Rollen werden wie gehabt bei der nächsten Anmeldung aus den Gruppen des Identity Providers neu abgeleitet (ADR-0009). - **Format**: dasselbe ZIP-Format wie beim Export einzelner Anleitungen (#108), erweitert um die Instanz-Daten, mit gemeinsamer `formatVersion`. - **Export** im Admin-Menü als **gestreamter ZIP-Download**. Backups mit allen Bildern können mehrere GB groß werden. - **Restore** als **CLI-Befehl im Container**, z. B. `docker compose exec kataba npm run restore -- backup.zip`, nicht über den Browser. - Der Restore funktioniert **nur in eine leere Instanz** (direkt nach der Installation). Ein Zusammenführen oder Überschreiben gibt es nicht. - **Nicht Teil dieses Tickets**: zeitgesteuerte automatische Backups. - Doku: - Neue ADR: Backup-Format mit `formatVersion`, Restore nur in eine leere Instanz und per CLI. - Abschnitt zu Backup und Restore im README. - GLOSSARY.md: Eintrag **Backup** ergänzen.
miko referenced this issue from a commit 2026-11-05 18:25:03 +01:00
Author
Owner

Implemented in #122: "Download backup" in the admin menu streams the whole instance as a ZIP (same format version as guide packages), and npm run restore -- <backup.zip> restores it into an empty instance only (ADR-0023). A restore inside the built image is still to be checked once #121 is fixed.

Implemented in #122: "Download backup" in the admin menu streams the whole instance as a ZIP (same format version as guide packages), and `npm run restore -- <backup.zip>` restores it into an empty instance only (ADR-0023). A restore inside the built image is still to be checked once #121 is fixed.
miko closed this issue 2026-11-05 18:25:48 +01:00
Sign in to join this conversation.
No project
No assignees
1 participant
Notifications
Due date
The due date is invalid or out of range. Please use the format "yyyy-mm-dd".

No due date set.

Depends on
Reference
MassiveDynamic/kataba#109
No description provided.