Skip to main content

A wrapper script for Restic backup software that inits, creates, prunes and checks backups

Project description

python version Code style: black Travis (.com) PyPI Stackshare: runrestic PyPI - Downloads

Runrestic

runrestic is a simple Python wrapper script for the Restic backup software that initiates a backup, prunes any old backups according to a retention policy, and validates backups for consistency. The script supports specifying your settings in a declarative configuration file rather than having to put them all on the command-line, and handles common errors.

Example config

repositories = [
    "/tmp/restic-repo",
    "sftp:user@host:/srv/restic-repo",
    "s3:s3.amazonaws.com/bucket_name"
    ]

[environment]
RESTIC_PASSWORD = "CHANGEME"

[backup]
sources = [
    "/home",
    "/var"
    ]

[prune]
keep-last =  3
keep-hourly =  5

Alternatively you can also just use JSON. For a more comprehensive example see the example.toml or check the schema.json

Getting started

Installing runrestic and restic

To install runrestic, run the following command to download and install it:

sudo pip3 install --upgrade runrestic

You can either manually download and install [Restic](https://restic.net/) or you can just run `runrestic` and it'll try to download it for you.

Initializing and running

Once you have restic and runrestic ready, you should put a config file in on of the scanned locations, namely:

  • /etc/runrestic.toml
  • /etc/runrestic/example.toml
  • ~/.config/runrestic/example.toml
  • /etc/runrestic.json
  • /etc/runrestic/example.json
  • ~/.config/runrestic/example.json

Afterwards, run

runrestic init # to initialize all the repos in `repositories`

runrestic  # without actions will do: runrestic backup prune check
# or
runrestic [action]

Certain `restic` flags like `--dry-run/-n` are built into `runrestic` as well and will be passed to restic where applicable.

If, however, you need to pass along arbitrary other flags you can now add them to the end of your runrestic call like so:

runrestic backup -- --one-file-system

Logs for restic and hooks

The output of restic and the configured pre/post-hooks is added to the runrestic logs at the level defined in [execution] proc_log_level (default: DEBUG), which can be overwritten with the CLI option -p/--proc-log-level.

For process log levels greater than INFO the output of file names is suppressed and for log levels greater than WARNING restic is executed with the --quiet option. If the process log level is set to DEBUG, then restic is executed with the --verbose option.

It is also possible to add restic progress messages to the logs by using the CLI option --show-progress INTERVAL where the INTERVAL is the number of seconds between the progress messages.

Restic shell

To use the options defined in runrestic with restic (e.g. for a backup restore), you can use the shell action:

runrestic shell

If you are using multiple repositories or configurations, you can select one now.

Prometheus / Grafana metrics

@d-matt created a nice dashboard for Grafana here: https://grafana.com/grafana/dashboards/11064/revisions

systemd timer or cron

If you want to run runrestic automatically, say once a day, the you can configure a job runner to invoke it periodically.

systemd

If you're using systemd instead of cron to run jobs, download the sample systemd service file and the sample systemd timer file. Then, from the directory where you downloaded them:

sudo mv runrestic.service runrestic.timer /etc/systemd/system/
sudo systemctl enable runrestic.timer
sudo systemctl start runrestic.timer

cron

If you're using cron, download the sample cron file. Then, from the directory where you downloaded it:

sudo mv runrestic /etc/cron.d/runrestic
sudo chmod +x /etc/cron.d/runrestic

Changelog

  • v0.5.29

    • Support Python 3.12
    • Updated devcontainer to Ubuntu 24.04 (noble)
  • v0.5.28

    • Allow jsonschema >= 4.0
  • v0.5.27

    • Fix output parsing for new restic version 0.14.0
    • Introduce failsafe output parser which supports default values
  • v0.5.26

    • Add output messages from restic and pre/post-hook commands to runrestic logs.
    • New CLI argument --show-progress INTERVAL for the restic progress update interval in seconds (default None)
  • v0.5.25

    • Drop support for Python 3.6, add support for Python 3.9 and 3.10, update dependencies
  • v0.5.24

    • Exit the script with returncode = 1 if there was an error in any of the tasks
  • v0.5.23

    • support JSON config files.
  • v0.5.21

    • fix issue where "check" does not count towards overall "errors"-metric
  • v0.5! Expect breaking changes.

    • metrics output is a bit different
    • see new parallel and retry_* options.

Ansible

@tabic wrote an ansible role, you can find it here: https://github.com/outwire/ansible-role-restic . (I have neither checked nor tested it.)

Development

This project is managed with poetry

Install it if not already present:

curl -sSL https://raw.githubusercontent.com/python-poetry/poetry/master/get-poetry.py | python
# or
pip install --user poetry

Installing dependencies

poetry install

Running Tests

poetry run pytest

Using VScode devcontainer

The project contains a .devcontainer folder with the settings for VScode to develop inside container. The Python virtual environment created by poetry is stored outside the container in the projects path .virtualenvs so that it survives container rebuilds.

The Ubuntu 24.04 based container uses Python 3.12 as system version and includes minimal Python 3.8 to 3.11 versions for creating virtual environments in any of those versions.

It is possible to switch the Python version used by poetry with the command poetry env use <version>, see poetry managing environments for more details.

Thanks

This project was initially based on borgmatic but has since evolved into something else.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

runrestic-0.5.29.tar.gz (30.4 kB view details)

Uploaded Source

Built Distribution

runrestic-0.5.29-py3-none-any.whl (32.4 kB view details)

Uploaded Python 3

File details

Details for the file runrestic-0.5.29.tar.gz.

File metadata

  • Download URL: runrestic-0.5.29.tar.gz
  • Upload date:
  • Size: 30.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/2.1.2 CPython/3.12.3 Linux/6.11.0-112021-tuxedo

File hashes

Hashes for runrestic-0.5.29.tar.gz
Algorithm Hash digest
SHA256 a7037e9650e12b86067168437697129ac95b523d53dedd06aa6f965e3688dcf8
MD5 5827488f50679fb112712fea74abeffc
BLAKE2b-256 129cc908a6eda4eed6a070cb6279f5c815f5987d7b1500e857e4e359c90b0c7b

See more details on using hashes here.

File details

Details for the file runrestic-0.5.29-py3-none-any.whl.

File metadata

  • Download URL: runrestic-0.5.29-py3-none-any.whl
  • Upload date:
  • Size: 32.4 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/2.1.2 CPython/3.12.3 Linux/6.11.0-112021-tuxedo

File hashes

Hashes for runrestic-0.5.29-py3-none-any.whl
Algorithm Hash digest
SHA256 c0eb93f1edb2579978e74abc588d643a9bb651fb15bc1fc1e955c4399183010a
MD5 1fdc092d6139044555dec4e1d17f188e
BLAKE2b-256 770dc37ce0f6d86b4f2a34b4bcbfff5ef5e7dd142e9ead893a243b405c7eb982

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page