Usage

Web UI

Using the fsbackup web interface to monitor backups, browse snapshots, and run jobs.

The fsbackup web UI is a FastAPI + HTMX interface that runs inside the Docker container alongside the backup scripts.

Accessing the UI

By default the web UI binds to port 8080. Open http://<backup-server>:8080 in your browser.

If AUTH_ENABLED=true in your stack.env, you'll be prompted to log in with the password matching AUTH_PASSWORD_HASH.

Dashboard

The dashboard shows:

Last run status for each class (exit code, timestamp)
Per-target success/failure counts
Snapshot delta metrics (files transferred, created, deleted, bytes)
Mirror status
S3 export status
Orphan count

Browsing snapshots

The Snapshots page lets you browse the snapshot tree by tier, date, class, and target. You can navigate into any snapshot and see its contents.

Running jobs manually

The Run Jobs page lets you trigger any script directly from the UI:

Run the doctor for a class
Run the runner (daily/monthly) for a class, with optional --dry-run or --target filter
Run promotion, mirror, retention, or S3 export

All jobs stream their output to the page in real time.

Browsing S3

The S3 page shows all objects currently stored in the configured S3 bucket, organized by tier and class. You can download individual archives directly from the UI.

Restore

The Restore page provides a guided interface for restoring files from a snapshot. See Restoring data for details.

Authentication setup

Generate a bcrypt hash for your password:

htpasswd -nbB "" yourpassword | cut -d: -f2

Set it in stack.env:

AUTH_ENABLED=true
AUTH_PASSWORD_HASH=$$2y$$10$$...    # escape $ as $$ in Docker Compose env files

Scheduling

How to configure the backup schedule using the supercronic crontab or systemd timers.

Running jobs manually

How to run fsbackup scripts manually via docker exec or the command line.