auberge 0.15.10

CLI tool for managing self-hosted infrastructure with Ansible
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51

# auberge backup restore

Restore application data from a backup. Alias: `auberge b r`.

```bash
auberge backup restore [OPTIONS] [BACKUP_ID]
```

`BACKUP_ID` is a timestamp (`YYYY-MM-DD_HH-MM-SS`) or `latest`. Omit to be prompted (newest first).

## Arguments

| Argument    | Description                                 |
| ----------- | ------------------------------------------- |
| `BACKUP_ID` | Timestamp or `latest` (omit to be prompted) |

## Options

| Option                   | Description                             | Default                                                              |
| ------------------------ | --------------------------------------- | -------------------------------------------------------------------- |
| `-H, --host HOST`        | Target host                             | Interactive                                                          |
| `-F, --from-host HOST`   | Source host (cross-host migration)      | Same as target                                                       |
| `-a, --apps APPS`        | Apps to restore (comma-separated)       | Prompt (pick from apps in the backup); required when non-interactive |
| `-k, --ssh-key PATH`     | SSH private key                         | `~/.ssh/identities/{host}/{user}`                                    |
| `-n, --dry-run`          | Preview without restoring               | false                                                                |
| `-y, --yes`              | Skip confirmation prompt                | false                                                                |
| `--skip-playbook-unsafe` | Skip Ansible playbook run after restore | false                                                                |

## Examples

```bash
auberge backup restore latest --host myserver              # prompts to pick apps
auberge backup restore latest --host myserver --apps baikal,freshrss
auberge backup restore 2024-01-27_14-30-00 --host myserver
auberge backup restore latest --host newserver --from-host oldserver  # migration
auberge backup restore latest --host myserver --dry-run
```

## What gets restored

Every path the backup directory holds, including optional ones. `backup create --include-music` stages `/srv/music`; restoring that backup pushes it back. There is no `--include-music` on `restore` — the backup is the record of what was collected, and a restore never drops part of it.

`rsync --delete` applies to each restored path: files on the target that the backup lacks are removed. `--dry-run` lists the paths per app before anything is overwritten.

## Gotchas

!> Cross-host migration runs a pre-flight check (SSH, services, disk ≥120% of backup size), creates an emergency backup tagged `pre-migration-{timestamp}` on the target, then requires you to retype the target hostname to confirm. After restore, Ansible playbooks run automatically to fix ownership and permissions. Use `--skip-playbook-unsafe` only as a last resort; if skipped, run manually: `cd ansible && ansible-playbook playbooks/apps.yml --tags <apps>`.

- **SSH/service failures**: verify key and run `auberge ansible run` to install missing apps first.
- **Insufficient disk**: free space or exclude large apps with `--apps`.
- **Services fail after restore**: check ownership with `ls -la /var/lib/<app>`, then rerun playbooks.