https://github.com/altaris/s3backup

Dockerized restic + rclone

https://github.com/altaris/s3backup

Science Score: 13.0%

This score indicates how likely this project is to be science-related based on various indicators:

  • CITATION.cff file
  • codemeta.json file
    Found codemeta.json file
  • .zenodo.json file
  • DOI references
  • Academic publication links
  • Academic email domains
  • Institutional organization owner
  • JOSS paper metadata
  • Scientific vocabulary similarity
    Low similarity (7.5%) to scientific vocabulary

Keywords

docker rclone restic s3
Last synced: 6 months ago · JSON representation

Repository

Dockerized restic + rclone

Basic Info
  • Host: GitHub
  • Owner: altaris
  • License: mit
  • Language: Shell
  • Default Branch: master
  • Size: 21.5 KB
Statistics
  • Stars: 0
  • Watchers: 2
  • Forks: 0
  • Open Issues: 0
  • Releases: 0
Topics
docker rclone restic s3
Created over 6 years ago · Last pushed about 1 year ago
Metadata Files
Readme License

README.md

s3backup

License DockerHub

This docker image performs incremental backups of a given volume to an s3 storage using restic and rclone.

Quickstart

sh docker run \ --rm \ --volume your-volume:/rootfs:ro \ --env RESTIC_PASSWORD="..." \ --env S3_ACCESS_KEY="..." \ --env S3_ENDPOINT="po.ta.to" \ --env S3_PATH="bucket/folder" \ --env S3_REGION="us-east-1" \ --env S3_SECRET_KEY="..." \ altaris/s3backup backup

Environment variables

  • RCLONE_EXTRA_CONFIG (default: empty): Extra configuration for rclone. For example, for a Scaleway endpoint, you might want to set it to acl private env_auth false.
  • RCLONE_MAX_TRY (default: 5): Number of attempts to connect to container rclone server; set this to higher values on slower systems.
  • RESTIC_DURATION (default: 10y): Duration for which backups should be kept, see here.
  • RESTIC_PASSWORD: Password of the restic repository.
  • ROOTFS_PATH (default: /rootfs): Absolute path where the volume is mounted.
  • S3_ACCESS_KEY: S3 access key.
  • S3_ENDPOINT: S3 endpoint.
  • S3_REGION: S3 region.
  • S3_SECRET_KEY: S3 secret key.
  • S3_PATH: Path of the restic repository, e.g. bucket/foo.
  • S3_PROVIDER (default: AWS): Any S3 provided supported by rclone, see here.

 Mount a restic repository

This will mount the restic repository at /mnt/restic, and the latest snapshot will be available at /mnt/restic/snapshots/latest/rootfs.

sh sudo docker run \ --rm \ --env RESTIC_PASSWORD="..." \ --env S3_ACCESS_KEY="..." \ --env S3_ENDPOINT="po.ta.to" \ --env S3_PATH="bucket/folder" \ --env S3_REGION="us-east-1" \ --env S3_SECRET_KEY="..." \ --mount type=bind,src="$MOUNT_POINT",dst=/mnt/restic,bind-propagation=shared \ --privileged \ altaris/s3backup "$@"

Owner

  • Name: Cédric
  • Login: altaris
  • Kind: user
  • Location: Japan
  • Company: RIKEN

GitHub Events

Total
  • Push event: 3
Last Year
  • Push event: 3

Issues and Pull Requests

Last synced: 12 months ago

All Time
  • Total issues: 0
  • Total pull requests: 0
  • Average time to close issues: N/A
  • Average time to close pull requests: N/A
  • Total issue authors: 0
  • Total pull request authors: 0
  • Average comments per issue: 0
  • Average comments per pull request: 0
  • Merged pull requests: 0
  • Bot issues: 0
  • Bot pull requests: 0
Past Year
  • Issues: 0
  • Pull requests: 0
  • Average time to close issues: N/A
  • Average time to close pull requests: N/A
  • Issue authors: 0
  • Pull request authors: 0
  • Average comments per issue: 0
  • Average comments per pull request: 0
  • Merged pull requests: 0
  • Bot issues: 0
  • Bot pull requests: 0
Top Authors
Issue Authors
Pull Request Authors
Top Labels
Issue Labels
Pull Request Labels