Restic Agent

Backups done right... as agent!

This is a wrapper application for Restic that:

Automatically creates a repository
Starts scheduled backups
Can start backups HTTP triggered
Integrates database dump methods
Presents prometheus metrics
Logs in JSON

Usage

Restic-agent can be configured by environment variables and command line arguments.

Base environment variables:

RESTIC_REPOSITORY: repository name
RESTIC_PASSWORD: repository password
RESTIC_HOSTNAME: overwrite hostname for snapshots
RUN_ON_BOOT: run a backup on startup
SCHEDULE: cron schedule (with seconds)
DEBUG: enable verbose output

Docker Compose

Just add a restic-agent for simple backups:

services:
  #
  # some productive services...
  #

  backup:
    image: clemens321/restic-agent:latest
    restart: unless-stopped
    command:
      - "--volume=/data/app"
    volumes:
      # Bind whatever directories to the backup container.
      # You can safely bind the same directory to multiple containers.
      - "app_data:/data/app"
    environment:
      # start backup every day at 2am
      - "SCHEDULE=0 0 2 * * *"
      - "RESTIC_REPOSITORY=rest:https://foo:pass@host:8000/foo"
      - "RESTIC_PASSWORD=${MY_RESTIC_PASSWORD:-secret}"

HTTP endpoints

Start and status

/start Start a backup set in background
/run Start a backup set and wait for completion
/running Check if a backup job is running (true/false)
/initialize Explicitly initialize the repository

Prometheus metrics

As /metrics restic-agent provides various prometheus metrics:

backups_all_total: The total number of backups attempted, including failures.
backups_successful_total: The total number of backups that succeeded.
backups_failed_total: The total number of backups that failed.
backup_duration_milliseconds: The duration of backups in milliseconds.
backup_files_new: Amount of new files.
backup_files_changed: Amount of files with changes.
backup_files_unmodified: Amount of files unmodified since last backup.
backup_files_processed: Total number of files scanned by the backup for changes.
backup_added_bytes: Total number of bytes added to the repository.
backup_processed_bytes: Total number of bytes scanned by the backup for changes

Backup modules

Volumes

Command line options:

--volume=/data/path: volume path to snapshot
--volume=/data/path1,/data/path2: multiple volumes in one step

Can be applied multiple times to add multiple restic steps.

PostgreSQL

Currently only one database is supported, confgured through environment variables

Environment options:

POSTGRES_NAME (Virtual) filename in backup, default is "/psql--.dmp"
POSTGRES_HOST Host or service name of database server/container
POSTGRES_DB
POSTGRES_USER
POSTGRES_PASSWORD

dodgex/restic-agent