diff --git a/readme.md b/readme.md index 979db2c..a893db4 100644 --- a/readme.md +++ b/readme.md @@ -1,4 +1,72 @@ -- `tools/update-plankton` -- `tools/build` -- `/tmp/mimir/mimir -c misc/conf-ramsch.mmr.json run` +# mimir + +Werkzeug zum Erstellen von Backup-Skripten anhand einer JSON-Beschreibung + + +## Erstellung + +### Voraussetzungen + +- TypeScript-Compiler + + +### Anweisungen + +- `tools/build` (Schalter `-h` nutzer für Hilfe) + + +## Verwendung + +### Voraussetzungen + +- Node.js + + +### Anweisungen + +`mimir` erzeugt Shell-Skripte, welche, wenn man sie ausführt, die eigentliche Arbeit übernehmen. + +Zum Einrichten des Backup-Ziels, muss einmalig der Befehl `init` verwendet werden: + +```bash +mimir -c conf.mmr.json init +``` + +Die Ausgabe dessen kann leer sein, was hieße, dass keine Schritte zur Einrichtung notwendig sind. + + +Danach können Backups ausgelöst werden mittels des Befehls `run`: + +```bash +mimir -c conf.mmr.json run +``` + +Hier könnte die Ausgabe bspw. wie folgt aussehen: + +``` +## images + +echo '-- images' +mkdir --parents /tmp/mimir/2025-09-22/images +tar --create --directory=/usr/share/images/desktop-base . > /tmp/mimir/2025-09-22/images/files.tar +mkdir --parents /tmp/backup/2025-09-22/images +mv /tmp/mimir/2025-09-22/images/* /tmp/backup/2025-09-22/images/ +rm --recursive /tmp/mimir/* +``` + + +## Dokumentation + +### Targets + +- `local` +- `borg` + + +### Concerns + +- `files` +- `postgresql_dump` + +