Restic¶

Restic is a backup program that is fast, efficient and secure. It supports the three major operating systems (Linux, macOS, Windows) and a few smaller ones (FreeBSD, OpenBSD).

Features:¶

• Full Rclone Support.
• Runs default every day at 2am.
• Multiple jobs possible.
• Automatic configuration and repository creation.

Configuration¶

All settings can be found here: /opt/appdata/restic/restic/restic.env

USER VALUES¶

RESTIC - SETTINGS¶

RCLONE - SETTINGS¶

NOTIFICATION - SETTINGS¶

Apprise has been integrated into Uploader and is defaulted to format all notifications in Markdown. Please refer to the Apprise documentation for more information.

Setup Restic Backup¶

Install Container¶

Install from homelabarr-ce>apps>backup menu

Configure NAS Backup Storage¶

Set up your backup destination for local NAS storage:

Option 1: Direct Local Path

# For local backup storage (recommended for NAS setups)
RESTIC_REPOSITORY="/mnt/backups/restic-repo"

Option 2: Network Share via RClone Create /opt/appdata/restic/rclone/rclone.conf for network storage:

[nas-backup]
type = local

Or for SMB/CIFS shares:

[nas-smb]
type = smb
host = nas.local
user = backup-user
pass = backup-password
share = backups

ENV Setup¶

nano /opt/appdata/restic/restic/restic.env

For direct local storage:

RESTIC_REPOSITORY="/mnt/backups/restic-repo"
RESTIC_PASSWORD="your-secure-backup-password"

For network storage:

RESTIC_REPOSITORY="rclone:nas-backup:restic-repo"
RESTIC_PASSWORD="your-secure-backup-password"

Restart Container¶

After changes, sudo docker restart restic

Restic Commands¶

Manual Backup

docker exec -it restic bash
source /app/restic/restic.sh
resticbackup

docker exec -it restic bash
source /app/restic/restic.sh
resticrestore-full

docker exec -it restic bash
source /app/restic/restic.sh
resticrestore <APPNAME>

docker exec -it restic bash
source /app/restic/restic.sh
resticsnapshots

docker exec -it restic bash
source /app/restic/restic.sh
source /config/restic/restic.env
$(which restic) restore <SNAPSHOT_ID> --repo "${RESTIC_REPOSITORY}" --password-command "$(which echo) ${RESTIC_PASSWORD}" --target "/" --tag "${RESTIC_TAG}" --option rclone.args="serve restic --stdio --checkers=16 --drive-chunk-size=32M --drive-use-trash=false --fast-list --config=/config/rclone/rclone.conf" --include "${RESTIC_FOLDER}/<NAMEOFAPP>"

Configuration¶

All settings can be found here: /opt/appdata/restic/restic/restic.env

USER VALUES¶

RESTIC - SETTINGS¶

RCLONE - SETTINGS¶

NOTIFICATION - SETTINGS¶

Apprise has been integrated into Uploader and is defaulted to format all notifications in Markdown. Please refer to the Apprise documentation for more information.

Setup Restic Backup¶

Create Service Account¶

Create Rclone.conf¶

ENV Setup¶

Deploy Container¶

Restic Backup Commands¶

Support¶

Kindly report any issues on GitHub or

• Join our for Support