Backrest is a web-accessible backup solution built on top of restic. Backrest provides a WebUI which wraps the restic CLI and makes it easy to create repos, browse snapshots, and restore files. Additionally, Backrest can run in the background and take an opinionated approach to scheduling snapshots and orchestrating repo health operations.
| Port | 9898 |
| Registry | ghcr.io/daemonless/backrest |
| Source | https://github.com/garethgeorge/backrest |
| Website | https://garethgeorge.github.io/backrest |
| Tag | Description | Best For |
|---|---|---|
latest |
Upstream Binary. Built from official release. | Most users — recommended. |
pkg |
FreeBSD Quarterly. Uses stable, tested packages. | Production stability. |
pkg-latest |
FreeBSD Latest. Rolling package updates. | Staying current. |
Before deploying, ensure your host environment is ready. See the Quick Start Guide for host setup instructions.
services:
backrest:
image: "ghcr.io/daemonless/backrest:latest"
container_name: backrest
environment:
- PUID=1000 # User ID for the application process
- PGID=1000 # Group ID for the application process
- TZ=UTC # Timezone for the container
- BACKREST_PORT= # Address and port to bind to (default: 0.0.0.0:9898)
- BACKREST_CONFIG= # Path to configuration file (default: /config/config.json)
- BACKREST_DATA= # Path to internal data directory (default: /config/data)
volumes:
- "/containers/backrest:/config"
- "/containers/backrest/data:/data"
ports:
- "9898:9898"
# always (not unless-stopped) so FreeBSD's podman rc.d auto-starts it at boot
restart: alwaysSave as compose.yaml, then run podman-compose up -d.
.env:
# .env
DIRECTOR_PROJECT=backrest
PUID=1000
PGID=1000
TZ=UTC
BACKREST_PORT=
BACKREST_CONFIG=
BACKREST_DATA=
appjail-director.yml:
# appjail-director.yml
options:
- virtualnet: ':<random> default'
- nat:
services:
backrest:
name: backrest
options:
- container: 'args:--pull'
- expose: '9898:9898 proto:tcp'
oci:
user: root
environment:
- PUID: !ENV '${PUID}'
- PGID: !ENV '${PGID}'
- TZ: !ENV '${TZ}'
- BACKREST_PORT: !ENV '${BACKREST_PORT}'
- BACKREST_CONFIG: !ENV '${BACKREST_CONFIG}'
- BACKREST_DATA: !ENV '${BACKREST_DATA}'
volumes:
- backrest: /config
- backrest_data: /data
volumes:
backrest:
device: '/containers/backrest'
backrest_data:
device: '/containers/backrest/data'Makejail:
# Makejail
ARG tag=latest
OPTION container=boot
OPTION overwrite=force
OPTION from=ghcr.io/daemonless/backrest:${tag}
Save the files above, then run appjail-director up.
Warning
Exposing ports in AppJail means that your service can be reached from remote hosts. If that is not your intention, do not expose the ports and communicate with the service using the jail's IPv4 address or hostname assigned by the virtual network.
To avoid exposing ports, just remove the expose option in your appjail-director.yml or from your command-line arguments.
Warning
Bastille's OCI support is experimental. It requires buildah and shares the host network stack (inherit). Mount volumes with --volume HOST JAIL; without it, image-declared volumes are stored under ${bastille_volumesdir}/${jail}.
services:
backrest:
name: backrest
image: "ghcr.io/daemonless/backrest:latest"
network:
- mode: host
environment:
- PUID=1000
- PGID=1000
- TZ=UTC
- BACKREST_PORT=
- BACKREST_CONFIG=
- BACKREST_DATA=
volumes:
- "/containers/backrest:/config"
- "/containers/backrest/data:/data"Save as bastille-compose.yml, then run bastille up.
Access at: http://localhost:9898
| Variable | Default | Description |
|---|---|---|
PUID |
1000 |
User ID for the application process |
PGID |
1000 |
Group ID for the application process |
TZ |
UTC |
Timezone for the container |
BACKREST_PORT |
`` | Address and port to bind to (default: 0.0.0.0:9898) |
BACKREST_CONFIG |
`` | Path to configuration file (default: /config/config.json) |
BACKREST_DATA |
`` | Path to internal data directory (default: /config/data) |
| Path | Description |
|---|---|
/config |
Configuration directory (config.json, cache, and state) |
/data |
Files to back up, or a local repository; mounted as-is, never re-owned |
| Port | Protocol | Description |
|---|---|---|
9898 |
TCP | Web UI |
Architectures: amd64, aarch64
User: bsd (UID/GID via PUID/PGID, defaults to 1000:1000)
Base: FreeBSD 15.1
Need help? Join our Discord community.