Skip to main content

restic-profile

English | 简体中文

GitHub Actions Workflow Status PyPI - Version PyPI - Version Docs

Profile-based restic wrapper, deployed with Ansible.

This repository is an Ansible collection (ak1ra_lab.restic_profile) that installs and configures the restic-profile CLI on local or remote hosts:

  • restic-profile CLI - reads a TOML config and runs restic backup / forget / prune with hooks and IM notifications.
  • restic_profile role - deploys the CLI, renders the TOML config, and manages one systemd timer per profile (including user-level systemd_scope: user).
  • restic_rest_server role - deploys a rest-server instance for remote backup storage.

Deploy with Ansible

You need Ansible on the control node - see Ansible toolchain for a uv-based setup. Clone the repo and install this collection with its dependencies into the project-local tree:

git clone https://github.com/ak1ra-lab/restic-profile.git
cd restic-profile
ansible-galaxy collection install --collections-path .ansible/collections -r requirements.yaml
ansible-galaxy collection install --force --collections-path .ansible/collections .

Then pick an example from Ansible examples, fill in your host_vars, and run the playbook. Building restic from source (restic_profile_restic_install_source: go_build) also needs a go toolchain on the control node.

Development

Only needed to work on src/restic_profile or the roles and plugins:

uv sync --group dev
just lint
just typecheck
just test
ansible-lint

To develop ak1ra_lab.general alongside this repo, clone ansible-collection-general next to this checkout and run just ansible-collection-install - it installs this collection plus your local ../ansible-collection-general (skipping ansible.posix/community.general, which come from your user-level Ansible).

Documentation

https://ak1ra-lab.github.io/restic-profile/ - configuration lives in mkdocs.yml.

Download files

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

Source Distribution

restic_profile_cli-0.4.1.tar.gz (162.3 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

restic_profile_cli-0.4.1-py3-none-any.whl (19.4 kB view details)

Uploaded Python 3

File details

Details for the file restic_profile_cli-0.4.1.tar.gz.

File metadata

  • Download URL: restic_profile_cli-0.4.1.tar.gz
  • Upload date:
  • Size: 162.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/7.0.0 CPython/3.13.14

File hashes

Hashes for restic_profile_cli-0.4.1.tar.gz
Algorithm Hash digest
SHA256 cb12528919568134031dac455ac760d289b5e794bf8e471dd05103add9fad4a5
MD5 c327eafa0f206a089650641f6e1670e0
BLAKE2b-256 b00b3898ebaf5e542356f47ceb11be2f9b833b1b16b70d4ed41fa10065c2f077

See more details on using hashes here.

Provenance

The following attestation bundles were made for restic_profile_cli-0.4.1.tar.gz:

Publisher: publish-to-pypi.yaml on ak1ra-lab/restic-profile

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file restic_profile_cli-0.4.1-py3-none-any.whl.

File metadata

File hashes

Hashes for restic_profile_cli-0.4.1-py3-none-any.whl
Algorithm Hash digest
SHA256 5026365695f693c3cd0e6bf241387f7b47ad4d0428db43545314e3d061f61bf8
MD5 6ef9e6e709113442839fe620b7841a83
BLAKE2b-256 9b259d32033e5c71a21625907a6b39da2e8d90837c3486f30c93c3ad01322261

See more details on using hashes here.

Provenance

The following attestation bundles were made for restic_profile_cli-0.4.1-py3-none-any.whl:

Publisher: publish-to-pypi.yaml on ak1ra-lab/restic-profile

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Release history Release notifications | RSS feed

This release

0.4.1 This release

2 files

0.4.0

2 files

0.3.0

2 files

0.2.1

2 files

0.2.0

2 files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page