garethgeorge/backrest

By garethgeorge

Updated 10 days ago

Backrest is a web UI and orchestrator for restic backup.

Image
26

1M+

garethgeorge/backrest repository overview

Overview

Backrest is a web UI wrapper for restic. It is intended to be used as a self-hosted application for managing backups of your data.

Features today are:

  • Configure multiple repositories (e.g. local storage, sftp, s3, b2, any supported restic service)
  • Configure scheduled backups to each repository.
  • Manually trigger a backup.
  • Scheduled forget operations to release old data.
  • Browse snapshot history.
  • Browse snapshot files.

See https://github.com/garethgeorge/backrest for a more detailed overview.

Running

docker run -p 9898:9898 -e BACKREST_PORT=9898 -e BACKREST_DATA=/data -e XDG_CACHE_HOME=/cache -v $(pwd)/.backrest/config:/.config/backrest -v $(pwd)/.backrest/data:/data -v $(pwd)/.backrest/cache:/cache garethgeorge/backrest:latest

Running with Compose

version: "3.2"
services:
  backrest:
    image: garethgeorge/backrest:latest
    container_name: backrest
    hostname: backrest
    volumes:
      - ./backrest/data:/data
      - ./backrest/config:/config
      - ./backrest/cache:/cache
      - /MY-BACKUP-DATA:/userdata # [optional] mount local paths to backup here.
      - /MY-REPOS:/repos # [optional] mount repos if using local storage, not necessary for remotes e.g. B2, S3, etc.
    environment:
      - BACKREST_DATA=/data # path for backrest data. restic binary and the database are placed here.
      - BACKREST_CONFIG=/config/config.json # path for the backrest config file.
      - XDG_CACHE_HOME=/cache # path for the restic cache which greatly improves performance.
      - TZ=America/Los_Angeles # set the timezone for the container, used as the timezone for cron jobs.
    restart: unless-stopped
    ports:
      - 9898:9898

Configuration

Environment Variables

  • BACKREST_PORT - the port to bind to. Defaults to 9898.
  • BACKREST_CONFIG - the path to the config file. Defaults to $HOME/.config/resticui/config.json or if $XDG_CONFIG_HOME is set, $XDG_CONFIG_HOME/resticui/config.json.
  • BACKREST_DATA - the path to the data directory. Defaults to $HOME/.local/share/resticui or if $XDG_DATA_HOME is set, $XDG_DATA_HOME/resticui.
  • BACKREST_RESTIC_COMMAND - the path to the restic binary. Defaults managed version of restic which will be downloaded and installed in the data directory.
  • XDG_CACHE_HOME -- the path to the cache directory. This is propagated to restic.

Tag summary

Content type

Image

Digest

sha256:b85297975

Size

80 MB

Last updated

10 days ago

docker pull garethgeorge/backrest:v1.14.1-alpine