Skip to content

Backrest Backrest

Description / nameInput element
Container Registry
Container Configuration Root Path
Timezone
User ID
Group ID
Backrest Host Port
Backrest /config Path
Backrest /data Path

Build Status Last Commit OCI Pulls

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
Daemonless daemonless/backrest
Source garethgeorge/backrest
Website garethgeorge.github.io/backrest

Version Tags

Multi-arch manifests — resolve automatically to the right image for your platform.

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.
Tag Description Best For
latest-amd64 Upstream Binary. Built from official release. Most users — recommended.
pkg-amd64 FreeBSD Quarterly. Uses stable, tested packages. Production stability.
pkg-latest-amd64 FreeBSD Latest. Rolling package updates. Staying current.
Tag Description Best For
latest-aarch64 Upstream Binary. Built from official release. Most users — recommended.
pkg-aarch64 FreeBSD Quarterly. Uses stable, tested packages. Production stability.
pkg-latest-aarch64 FreeBSD Latest. Rolling package updates. Staying current.

Before deploying, ensure your host environment is ready. See the Quick Start Guide for host setup instructions, including the security model for host vs. container privileges.

Deployment

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
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: always

Save as compose.yaml, then run podman-compose up -d.

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.

1
2
3
4
5
6
7
8
9
# .env

DIRECTOR_PROJECT=backrest
PUID=1000
PGID=1000
TZ=UTC
BACKREST_PORT=
BACKREST_CONFIG=
BACKREST_DATA=

 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
# 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_PATH: /config
      - BACKREST_DATA_PATH: /data
volumes:
  BACKREST_CONFIG_PATH:
    device: '/containers/backrest'
  BACKREST_DATA_PATH:
    device: '/containers/backrest/data'

1
2
3
4
5
6
7
# 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.

Experimental

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}.

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
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

Interactive Configuration

Parameters

Environment Variables

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)

Volumes

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

Ports

Port Protocol Description
9898 TCP Web UI

Implementation Details

  • Architectures: amd64, aarch64
  • User: bsd (UID/GID set via PUID/PGID). Defaults to 1000:1000.
  • Base: Built on ghcr.io/daemonless/base (FreeBSD 15.1).

Need help? Join our Discord community.