Auberge

Selfware for managing my self-hosted FOSS stack, built around Ansible automation. No Docker bloat, runs lean on a 1€/month 1GB VPS (IONOS Linux VPS XS).

Installation

cargo install auberge

Quick Start

Add your VPS as a host:

auberge host add my-vps 194.164.53.11
# Prompts for SSH user and port (defaults to current user, port 22)

Deploy the full stack:

auberge ansible run
# 1. Select your VPS host
# 2. Select "auberge" playbook for the complete stack
# 3. Sit back while it configures everything

Available commands:

# Host management
auberge host add <name> <ip>   # Add a VPS host
auberge host list              # List all hosts
auberge host remove <name>     # Remove a host

# Deployment
auberge ansible run            # Interactive playbook execution
auberge ansible bootstrap      # Initial VPS setup (first time only)
auberge ansible check          # Dry-run to preview changes

# Backup & Restore
auberge backup create          # Backup app data (calendar, RSS, music DB, books)
auberge backup list            # List available backups
auberge backup restore latest  # Restore from backup
auberge backup export-opml     # Export FreshRSS feeds to OPML
auberge backup import-opml     # Import OPML to FreshRSS

# Other
auberge dns <subcommand>       # DNS management via Cloudflare
auberge ssh keygen             # Generate SSH keys for hosts

Backup & Restore

Auberge includes built-in backup and restore for all application data. See docs/backup.md for comprehensive documentation.

Create Backups

# Backup all apps for a host
auberge backup create --host my-vps

# Backup specific apps only
auberge backup create --apps radicale,freshrss

# Include music files (large, excluded by default)
auberge backup create --include-music

# Dry run to preview
auberge backup create --dry-run

Backups are stored locally in ~/.local/share/auberge/backups/ with this structure:

backups/
└── my-vps/
    ├── radicale/
    │   ├── 2026-01-23_14-30-00/
    │   └── latest -> 2026-01-23_14-30-00
    ├── freshrss/
    ├── navidrome/
    ├── calibre/
    └── webdav/

List Backups

# List all backups
auberge backup list

# Filter by host or app
auberge backup list --host my-vps --app radicale

# Output as JSON or YAML
auberge backup list --format json

Restore from Backup

# Restore latest backup for all apps
auberge backup restore latest --host my-vps

# Restore specific apps only
auberge backup restore latest --apps radicale,freshrss

# Restore a specific backup by timestamp
auberge backup restore 2026-01-23_14-30-00

# Dry run to preview
auberge backup restore latest --dry-run

Cross-Host Restore (Migration)

Restore backups from one host to another (useful for VPS provider migration or disaster recovery):

# Restore from old-vps to new-vps
auberge backup restore latest --from-host old-vps --host new-vps

# Dry run to preview cross-host restore
auberge backup restore latest --from-host old-vps --host new-vps --dry-run

Cross-host restore includes comprehensive safety checks:

• Pre-flight validation: Verifies SSH connectivity, service existence, and disk space on target
• Hostname confirmation: Requires typing the target hostname to prevent accidents
• Emergency backup: Automatically backs up target host's current state before overwriting
• Post-restore guidance: Shows required manual steps (DNS updates, config regeneration, health checks)

Important: Cross-host restore may require additional steps after completion:

1. Re-run ansible to regenerate host-specific configs: auberge ansible run --host new-vps
2. Update DNS records if domain names changed
3. Verify SSL certificates are valid for the new host
4. Check service logs for errors: journalctl -u <service> --since "5 minutes ago"

OPML Export/Import (FreshRSS)

# Export feeds to OPML file
auberge backup export-opml --host my-vps --output feeds.opml

# Import OPML file
auberge backup import-opml --host my-vps --input feeds.opml

SSH Key Configuration

Backup operations support flexible SSH key configuration. See docs/ssh.md for details on:

• Using custom SSH keys per host
• Ad-hoc key overrides with --ssh-key flag
• Default SSH key derivation

What's backed up:

• Radicale: Calendar and contact data, configuration
• FreshRSS: SQLite database, configuration
• Navidrome: Database and configuration (music files excluded by default)
• Calibre: Book library and metadata
• WebDAV: All files

Stack

Infrastructure

Required VPS Provider Firewall Ports:

• Custom SSH port: Set via SSH_PORT environment variable (shown in CLI warnings)
• 80 (HTTP): For HTTP traffic and ACME challenges
• 443 (HTTPS): For HTTPS traffic
• 853 (DNS over TLS): For Blocky DNS service

Apps

Develop

See develop.md for local development setup.

Playbooks

Playbooks are organized in layers:

Run individual layers with tags:

auberge ansible run --tags hardening  # Security layer only
auberge ansible run --tags caddy      # Just the reverse proxy