Handbuch auf MkDocs-Basis, mit Bildschirmfotos aus dem Programm

26 Kapitel in vier Teilen, in der Reihenfolge, in der man sie braucht:
erst sichern, dann Dateien holen, dann ganze Maschinen wiederherstellen,
dahinter der Nachschlagteil.

Gebaut wird mit MkDocs + Material. Bewusst ohne Netzabhaengigkeiten:
keine Schriften vom CDN (font: false), Volltextsuche mit deutschem
Stemming liegt neben den Seiten. Im Notfall steht vielleicht das halbe
Netz - dann nuetzt eine Doku im Internet nichts.

  handbuch/bauen.sh              baut handbuch/site/
  handbuch/bauen.sh ansehen      Vorschau auf 127.0.0.1:8000

install.sh nimmt das gebaute Handbuch mit nach
/usr/share/doc/pvesnap/handbuch/ - falls es vorliegt. Auf dem Host selbst
wird nichts gebaut, mkdocs gehoert nicht auf einen Hypervisor.

Die 28 Bildschirmfotos sind nicht abfotografiert, sondern erzeugt: Der
echte Programmcode laeuft in einem Pseudo-Terminal gegen einen erfundenen
Proxmox-Host (Attrappen fuer pvesh, perl und rbd), pyte baut den Bildschirm
nach, heraus faellt ein SVG. Damit stimmen sie garantiert mit dem Programm
ueberein, sind reproduzierbar und enthalten keine echten Daten. Die
Werkstatt dafuer liegt unter handbuch/werkstatt/ samt LIESMICH.md.

Nebenbei: die Schlussmeldung von install.sh warb noch mit --exchange,
das mit dem eingebauten Austauschlaufwerk weggefallen ist.

Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>

handbuch/docs/index.md

@@ -0,0 +1,107 @@
+# pvesnap
+
+**pvesnap** legt nach Zeitplan Snapshots von Proxmox-VMs und -Containern an,
+räumt alte wieder weg — und hilft danach dabei, an die Daten darin zu kommen.
+
+Das ist der Teil, den andere Werkzeuge gern offen lassen. Einen Snapshot
+anzulegen ist leicht. Ihn im Ernstfall zu *benutzen*, wenn die Datenbank
+gelöscht wurde und der Chef daneben steht, ist die eigentliche Arbeit. Dafür
+gibt es hier drei Wege — vom einzelnen Verzeichnis bis zur kompletten Maschine,
+die läuft, als wäre nie etwas gewesen.
+
+---
+
+## Die vier Werkzeuge
+
+<div class="grid cards" markdown>
+
+- **`pvesnap`** — der Dienst
+
+    Legt Snapshots nach Zeitplan an und löscht sie nach Vorhaltezeit wieder.
+    Eingestellt wird alles in einer INI-Datei oder im
+    [Konfigurationseditor](sichern/editor.md).
+
+- **`pvesnap-explorer`** — zwei Fenster im Terminal
+
+    Wie der Midnight Commander: links der Snapshot, rechts der Host. Dateien
+    herüberkopieren, fertig. → [Kapitel](holen/explorer.md)
+
+- **`pvesnap-web`** — im Browser
+
+    Dasselbe im Webbrowser, auch vom Arbeitsplatz aus, mit den Proxmox-Benutzern
+    als Anmeldung. Verzeichnisse kommen als ZIP. → [Kapitel](holen/web.md)
+
+- **`pvesnap-recovery`** — der Snapshot als laufende Maschine
+
+    Startet den Snapshot als eigenständige VM — abgeschottet zum Hineinschauen
+    oder mit vollem Netz als echte Wiederherstellung.
+    → [Kapitel](wiederherstellen/index.md)
+
+</div>
+
+---
+
+## Wo fange ich an?
+
+| Ich will … | → |
+|---|---|
+| das Ganze erst einmal zum Laufen bringen | [Schnellstart](schnellstart.md) |
+| es sauber installieren | [Installation](installation.md) |
+| einen Zeitplan einrichten | [Sichern](sichern/index.md) |
+| eine einzelne Datei zurückholen | [Der Explorer](holen/explorer.md) |
+| jemandem ohne Shell-Zugang etwas herausgeben | [Die Web-Oberfläche](holen/web.md) |
+| einen Datenbank-Dump aus einem Snapshot ziehen | [Wiederherstellen](wiederherstellen/index.md) |
+| wissen, was ein bestimmter Parameter tut | [Nachschlagen](nachschlagen/index.md) |
+| verstehen, warum etwas nicht geht | [Fehlersuche](nachschlagen/fehlersuche.md) |
+
+---
+
+## Das Wichtigste vorweg
+
+!!! warning "Ein Snapshot ist kein Backup"
+
+    Snapshots liegen auf demselben Storage wie die VM. Stirbt das Storage,
+    sind beide weg. pvesnap ersetzt kein `vzdump` und keinen Proxmox Backup
+    Server — es ergänzt sie um etwas, das die nicht können: einen Stand von vor
+    zwanzig Minuten, in Sekunden verfügbar.
+
+    Die beiden Werkzeuge lösen unterschiedliche Probleme:
+
+    | | Backup | Snapshot |
+    |---|---|---|
+    | Schützt vor | Ausfall des Storages, Brand, Verschlüsselung | Fehlbedienung, missratenem Update, gelöschter Tabelle |
+    | Liegt | woanders | daneben |
+    | Zurück in | Stunden | Sekunden |
+
+!!! tip "pvesnap fasst fremde Snapshots nie an"
+
+    Gelöscht wird ausschließlich, was exakt auf das eigene
+    [Namensschema](sichern/index.md#namensschema) passt. Ein von Hand angelegter
+    Snapshot `vor-update` bleibt liegen, bis du ihn selbst entfernst.
+
+---
+
+## Ein Blick voraus
+
+So sieht die Übersicht aus, wenn zwei Snapshots als Maschinen laufen:
+
+![Übersicht der Wiederherstellungen](bilder/recovery-uebersicht.svg)
+
+Und so der Weg an die Dateien darin — links der Snapshot, rechts der Host:
+
+![Der Explorer mit zwei Fenstern](bilder/explorer-fenster.svg)
+
+---
+
+## Voraussetzungen
+
+* **Proxmox VE**, Version 7 oder neuer
+* **root** auf dem Host — `pvesh` und das Einbinden von Snapshots verlangen es
+* **Python 3.9+** — bringt Proxmox selbst mit
+* Ein Storage, das Snapshots kann: Ceph/RBD, ZFS, LVM-thin oder qcow2 auf
+  `dir`/`nfs`. Was jeweils geht, steht unter
+  [Speicherarten](nachschlagen/speicher.md).
+
+Der Dienst selbst braucht **keine zusätzlichen Python-Pakete**. Für die
+Austauschlaufwerke werden `parted` und `exfatprogs` nachinstalliert — das
+erledigt das Installationsskript.