> ## Documentation Index
> Fetch the complete documentation index at: https://docs.kombify.io/llms.txt
> Use this file to discover all available pages before exploring further.

# stackkit backup

> Backups verwalten (Kopia-Engine)

Backups verwalten (Kopia-Engine).

Backups für dieses StackKit-Deployment verwalten.

Backups basieren auf Kopia (siehe ADR-0016) und laufen im lokalen kopia-agent-Service, den der Kit-Core rendert (Basement oder Cloud Standalone). Native configure-, status- und run-Aufrufe validieren den exakten lokalen Plan, die generierten Artefakte, die Owner-Verwahrung und den Apply-Nachweis erneut, bevor sie Kopia berühren. Repository, Quelle, Ausschlüsse, Service-Identität und Zugangsdaten gehören CUE oder der Owner-Verwahrung.

```bash theme={null}
stackkit backup [flags]
```

**Beispiele**

```bash theme={null}
# Configure the local Kopia repository after stackkit apply
stackkit backup configure

# Take a snapshot now
stackkit backup run

# Check repository readiness and the latest snapshot and restore receipts
stackkit backup status

# Restore a snapshot into isolated staging
stackkit backup restore sha256:<snapshot-anchor-id> --owner-approve
```

Unterbefehle: [`stackkit backup configure`](#stackkit-backup-configure), [`stackkit backup emergency-export`](#stackkit-backup-emergency-export), [`stackkit backup emergency-restore`](#stackkit-backup-emergency-restore), [`stackkit backup init`](#stackkit-backup-init), [`stackkit backup restore`](#stackkit-backup-restore), [`stackkit backup run`](#stackkit-backup-run), [`stackkit backup schedule`](#stackkit-backup-schedule), [`stackkit backup status`](#stackkit-backup-status), [`stackkit backup target`](#stackkit-backup-target)

## stackkit backup configure

Das von CUE gesteuerte lokale Kopia-Repository konfigurieren.

Das lokale Kopia-Repository anhand der exakten generierten StackSpec-v2-Backup-Richtlinie konfigurieren.

Repository-Pfad und kopia-agent-Service gehören CUE und lassen sich auf der Kommandozeile nicht überschreiben.

```bash theme={null}
stackkit backup configure [flags]
```

| Flag | Typ | Standard | Beschreibung |
| - | - | - | - |
| `--json` | bool | — | stackkit.command-result/v1-JSON ausgeben |

**Beispiele**

```bash theme={null}
# Configure the repository once the Basement core is applied
stackkit backup configure

# Configure it and print the command result as JSON
stackkit backup configure --json
```

## stackkit backup emergency-export

Ausgewählte lokale Daten als verschlüsseltes, portables Wiederherstellungsarchiv exportieren.

Ein portables, mit age verschlüsseltes tar/gzip-Archiv mit Prüfsummen pro Datei und einem Restore-Runbook erstellen. Gib einen öffentlichen age-Empfängerschlüssel und ein neues Zielverzeichnis außerhalb der Quellen an. Lässt du `--source` weg, wird der generierte v2-Backup-Vertrag exportiert (CUE-emergencyExport-Klassen plus die Volumes der Generate-/Apply-Source-Policy). Explizite CLASS=PATH-Quellen bleiben der Standalone-Weg, wenn kein generierter Vertrag vorliegt. Das Kopieren von Dateien beweist keine Anwendungskonsistenz; halte Schreibzugriffe an oder exportiere zuerst datenbanknative Dumps. Die Wiederherstellung stellt Daten bereit, ohne den ursprünglichen Host, Kopia oder ein kombify-Konto.

```bash theme={null}
stackkit backup emergency-export [flags]
```

| Flag | Typ | Standard | Beschreibung |
| - | - | - | - |
| `--format` | string | `tar.gz.age` | Portables Archivformat (tar.gz.age) |
| `--json` | bool | — | Den Archivbeleg als JSON ausgeben |
| `--large-media-mode` | string | `manifest-only` | Medienquellen: manifest-only, include oder exclude |
| `--recipient` | stringArray | — | Öffentlicher age-X25519-Empfängerschlüssel; für mehrere Wiederherstellungs-Owner wiederholen |
| `--source` | stringArray | — | Explizite CLASS=PATH-Quelle; wiederholen für config, secrets, platform-state, database, user-content, documents, photos, large-media, telemetry-timeseries, serverless-config oder cache-generated |
| `--target` | string | — | Neues Ausgabeverzeichnis; das übergeordnete Verzeichnis muss existieren |

**Beispiele**

```bash theme={null}
# Export the generated backup contract, encrypted to your age public key, into a new directory
stackkit backup emergency-export --recipient <age-public-key> --target /mnt/usb/stackkit-export

# Export explicit paths when no generated contract exists
stackkit backup emergency-export --recipient <age-public-key> --target /mnt/usb/stackkit-export --source config=/opt/stacks --source user-content=/opt/data
```

## stackkit backup emergency-restore

Einen portablen Export in ein neues Staging-Verzeichnis entschlüsseln und verifizieren.

```bash theme={null}
stackkit backup emergency-restore [flags]
```

| Flag | Typ | Standard | Beschreibung |
| - | - | - | - |
| `--archive` | string | — | Verschlüsseltes Notfallarchiv |
| `--identity-file` | string | — | Lokale age-Identitätsdatei; geheime Schlüssel gehören nie auf die Kommandozeile |
| `--json` | bool | — | Das verifizierte Staging-Ergebnis als JSON ausgeben |
| `--max-bytes` | int | `549755813888` | Maximale dekomprimierte Archivgröße in Bytes, einschließlich Metadaten |
| `--target` | string | — | Neues isoliertes Restore-Verzeichnis; das übergeordnete Verzeichnis muss existieren |

**Beispiele**

```bash theme={null}
# Decrypt and verify an export into a new staging directory with your age identity file
stackkit backup emergency-restore --archive <export-dir>/<archive>.tar.gz.age --identity-file ~/.config/age/key.txt --target ./restore-staging
```

## stackkit backup init

Anleitung für die Ersteinrichtung ausgeben.

Die Schritte der Ersteinrichtung für das Backup-Addon ausgeben.

Dieser Befehl ist schreibgeschützt. Er beschreibt den nativen Lifecycle, der den von CUE verwalteten lokalen kopia-agent vor der Repository-Konfiguration rendert und anwendet.

```bash theme={null}
stackkit backup init [flags]
```

## stackkit backup restore

Einen signierten Snapshot verifizieren und in isoliertes Staging wiederherstellen.

Einen inhaltsadressierten, vom Owner signierten Snapshot-Anker in das von CUE verwaltete isolierte Staging-Volume wiederherstellen. Die rohe Kopia-Snapshot-ID und der Staging-Pfad werden nicht vom Aufrufer bestimmt. `--owner-approve` hält die ausdrückliche lokale Owner-Autorisierung fest; dieser Befehl verlangt nie ein kombify-Konto oder einen Cloud-Service.

```bash theme={null}
stackkit backup restore <snapshot-anchor-id> [flags]
```

| Flag | Typ | Standard | Beschreibung |
| - | - | - | - |
| `--json` | bool | — | stackkit.command-result/v1-JSON ausgeben |
| `--operation-id` | string | — | Stabiler Idempotenzschlüssel für diese Staged-Restore-Operation |
| `--owner-approve` | bool | — | Diese Staged-Restore-Operation mit der etablierten lokalen Owner-Verwahrung autorisieren |

**Beispiele**

```bash theme={null}
# Restore a snapshot into isolated staging; the live volumes are not touched
stackkit backup restore sha256:<snapshot-anchor-id> --owner-approve

# Print the result as JSON: data.id is the restore result ID for restore activate, data.operationId is the restore operation ID for restore abandon
stackkit backup restore sha256:<snapshot-anchor-id> --owner-approve --json
```

Unterbefehle: [`stackkit backup restore abandon`](#stackkit-backup-restore-abandon), [`stackkit backup restore activate`](#stackkit-backup-restore-activate), [`stackkit backup restore recover`](#stackkit-backup-restore-recover)

### stackkit backup restore abandon

Eine ausstehende oder bereitgestellte Restore-Operation verwerfen.

```bash theme={null}
stackkit backup restore abandon <restore-operation-id> [flags]
```

| Flag | Typ | Standard | Beschreibung |
| - | - | - | - |
| `--json` | bool | — | stackkit.command-result/v1-JSON ausgeben |
| `--owner-approve` | bool | — | Dieses Verwerfen der Wiederherstellung mit der etablierten lokalen Owner-Verwahrung autorisieren |

**Beispiele**

```bash theme={null}
# Discard a staged restore you do not want to activate
stackkit backup restore abandon <restore-operation-id> --owner-approve
```

### stackkit backup restore activate

Eine verifizierte bereitgestellte Wiederherstellung in die Live-Volumes des Kit-Cores aktivieren.

```bash theme={null}
stackkit backup restore activate <restore-result-id> [flags]
```

| Flag | Typ | Standard | Beschreibung |
| - | - | - | - |
| `--json` | bool | — | stackkit.command-result/v1-JSON ausgeben |
| `--operation-id` | string | — | Stabiler Idempotenzschlüssel für diese Live-Restore-Aktivierung |
| `--owner-approve` | bool | — | Die Live-Aktivierung mit der etablierten lokalen Owner-Verwahrung autorisieren |

**Beispiele**

```bash theme={null}
# Replace the live volumes with a verified staged restore
stackkit backup restore activate sha256:<restore-result-id> --owner-approve

# Name the activation operation so an interrupted run can be recovered by that ID
stackkit backup restore activate sha256:<restore-result-id> --owner-approve --operation-id restore-activate-2026-09-18
```

### stackkit backup restore recover

Eine unterbrochene Wiederherstellung wiederherstellen oder ihr committetes Ergebnis abschließen.

Die exakte, vom Owner freigegebene Restore-Aktivierung wiederherstellen. Vor dem Commit stellt die Recovery die vorherigen Live-Volumes wieder her. Nach dem Commit bewahrt sie die aktivierten Daten und setzt das Aufräumen des Ergebnisses und die Anwendungs-Finalisierung fort. Wird die Recovery für eine abgeschlossene Operation wiederholt, liefert sie deren ursprüngliches signiertes Ergebnis zurück. `--rollback` ist erforderlich.

```bash theme={null}
stackkit backup restore recover <activation-operation-id> [flags]
```

| Flag | Typ | Standard | Beschreibung |
| - | - | - | - |
| `--json` | bool | — | stackkit.command-result/v1-JSON ausgeben |
| `--owner-approve` | bool | — | Die Recovery mit der etablierten lokalen Owner-Verwahrung autorisieren |
| `--rollback` | bool | — | Den Rollback autorisieren, falls die unterbrochene Aktivierung nicht committet wurde |

**Beispiele**

```bash theme={null}
# Recover an interrupted activation by its operation ID
stackkit backup restore recover restore-activate-2026-09-18 --rollback --owner-approve
```

## stackkit backup run

Jetzt einen Snapshot erzwingen (außerhalb des Zeitplans).

```bash theme={null}
stackkit backup run [flags]
```

| Flag | Typ | Standard | Beschreibung |
| - | - | - | - |
| `--json` | bool | — | stackkit.command-result/v1-JSON ausgeben |
| `--operation-id` | string | — | Stabiler Idempotenzschlüssel für diese Snapshot-Operation |
| `--scheduled` | bool | — | Nur über die aktuelle signierte lokale Zeitplan-Autorisierung ausführen |

**Beispiele**

```bash theme={null}
# Take a snapshot now; data.id in the JSON result is the snapshot anchor ID for backup restore
stackkit backup run --json

# Use your own operation ID so a retry cannot create a second snapshot
stackkit backup run --operation-id manual-2026-09-18
```

## stackkit backup schedule

Den vom Owner freigegebenen lokalen Backup-Timer steuern.

```bash theme={null}
stackkit backup schedule [flags]
```

| Flag | Typ | Standard | Beschreibung |
| - | - | - | - |
| `--json` | bool | — | stackkit.command-result/v1-JSON ausgeben |

Unterbefehle: [`stackkit backup schedule disable`](#stackkit-backup-schedule-disable), [`stackkit backup schedule enable`](#stackkit-backup-schedule-enable), [`stackkit backup schedule status`](#stackkit-backup-schedule-status)

### stackkit backup schedule disable

Die geplante Backup-Ausführung widerrufen und ihren Timer stoppen.

```bash theme={null}
stackkit backup schedule disable [flags]
```

| Flag | Typ | Standard | Beschreibung |
| - | - | - | - |
| `--owner-approve` | bool | — | Die lokale Autorität für geplante Backups widerrufen |

Geerbt von [`stackkit backup schedule`](#stackkit-backup-schedule):

| Flag | Typ | Standard | Beschreibung |
| - | - | - | - |
| `--json` | bool | — | stackkit.command-result/v1-JSON ausgeben |

**Beispiele**

```bash theme={null}
# Stop scheduled snapshots and revoke their authorization
stackkit backup schedule disable --owner-approve
```

### stackkit backup schedule enable

Die exakte CUE-Backup-Taktung freigeben und aktivieren.

```bash theme={null}
stackkit backup schedule enable [flags]
```

| Flag | Typ | Standard | Beschreibung |
| - | - | - | - |
| `--owner-approve` | bool | — | Diesen exakten Plan, diese CLI und die lokale Backup-Taktung freigeben |

Geerbt von [`stackkit backup schedule`](#stackkit-backup-schedule):

| Flag | Typ | Standard | Beschreibung |
| - | - | - | - |
| `--json` | bool | — | stackkit.command-result/v1-JSON ausgeben |

**Beispiele**

```bash theme={null}
# Approve the backup cadence from the applied plan and start its timer
stackkit backup schedule enable --owner-approve
```

### stackkit backup schedule status

Timer, Autorisierung und letzten geplanten Snapshot getrennt anzeigen.

```bash theme={null}
stackkit backup schedule status [flags]
```

Geerbt von [`stackkit backup schedule`](#stackkit-backup-schedule):

| Flag | Typ | Standard | Beschreibung |
| - | - | - | - |
| `--json` | bool | — | stackkit.command-result/v1-JSON ausgeben |

**Beispiele**

```bash theme={null}
# Show the timer, its authorization, and the last scheduled snapshot
stackkit backup schedule status

# The same status as JSON
stackkit backup schedule status --json
```

## stackkit backup status

Den Status des lokalen Kopia-Repositorys anzeigen.

```bash theme={null}
stackkit backup status [flags]
```

| Flag | Typ | Standard | Beschreibung |
| - | - | - | - |
| `--json` | bool | — | stackkit.command-result/v1-JSON ausgeben |

**Beispiele**

```bash theme={null}
# Show repository readiness, coverage, and the latest snapshot and restore receipts
stackkit backup status

# The same status as JSON
stackkit backup status --json
```

## stackkit backup target

Ein vom Owner bereitgestelltes S3-Ziel an die generierte Backup-Richtlinie binden.

```bash theme={null}
stackkit backup target [flags]
```

Unterbefehle: [`stackkit backup target import`](#stackkit-backup-target-import), [`stackkit backup target recipient`](#stackkit-backup-target-recipient), [`stackkit backup target status`](#stackkit-backup-target-status)

### stackkit backup target import

Verschlüsselte S3-Verwahrung aus JSON über stdin importieren.

Die JSON-Felder endpoint, bucket, prefix, region, accessKeyId, secretAccessKey und passphrase über stdin importieren. Die Passphrase ist ein String für ein bestehendes Kopia-Repository. Es werden nur opake Zielreferenzen ausgegeben. Das importiert die Verwahrung; es erstellt keinen Bucket und verifiziert keine Offsite-Bereitschaft.

```bash theme={null}
stackkit backup target import [flags]
```

| Flag | Typ | Standard | Beschreibung |
| - | - | - | - |
| `--candidate-digest` | string | — | Exakter sha256-Digest des installierten StackKits-Release-Kandidaten |
| `--owner-approve` | bool | — | Dieses exakte lokale Backup-Ziel autorisieren |
| `--rebind` | bool | — | Plan- und Quellen-Autorität erneuern und dabei das bestehende Ziel samt Zugangsdaten beibehalten |
| `--sealed` | bool | — | Einen versiegelten Host-Zustellungs-Envelope statt unverschlüsseltem JSON über stdin lesen |
| `--tenant-ref` | string | — | Tenant, an den die versiegelte Zustellung adressiert sein muss (mit `--sealed` erforderlich) |

**Beispiele**

```bash theme={null}
# Import the S3 target from a private JSON file with the fields listed above
stackkit backup target import --owner-approve < s3-target.json
```

### stackkit backup target recipient

Den Empfängerschlüssel dieses Nodes für versiegelte Zustellungen nachweisen.

Erstellt einmalig den separaten Verschlüsselungs-Empfängerschlüssel dieses Nodes und gibt eine mit dem lokalen Owner-Schlüssel signierte Erklärung aus. Diese bindet den öffentlichen Schlüssel an diese Site und diesen Node und beantwortet die Challenge des Aufrufers. Der private Schlüssel verlässt die lokale Verwahrung nie. Eine zustellende Autorität versiegelt das Backup-Zielmaterial für diesen Schlüssel; importiere es mit `backup target import --sealed`.

```bash theme={null}
stackkit backup target recipient [flags]
```

| Flag | Typ | Standard | Beschreibung |
| - | - | - | - |
| `--challenge` | string | — | Frischer Wert der zustellenden Autorität, den die Erklärung zurückgeben muss |
| `--owner-approve` | bool | — | Den Empfängerschlüssel dieses Nodes autorisieren |
| `--source-generation` | bool | — | Die beibehaltene Generierung mit ihrer installierten attestierten Quelle verifizieren, bevor dieselbe Verwahrung erneuert wird |

**Beispiele**

```bash theme={null}
stackkit backup target recipient --challenge "$CHALLENGE" --owner-approve
```

### stackkit backup target status

Die lokale Ziel-Verwahrung verifizieren, ohne S3 zu kontaktieren.

```bash theme={null}
stackkit backup target status [flags]
```

**Beispiele**

```bash theme={null}
# Confirm the imported target custody is intact
stackkit backup target status
```


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.