{"id":16368247,"url":"https://github.com/bfren/docker-backup","last_synced_at":"2026-05-05T06:37:16.652Z","repository":{"id":104360529,"uuid":"578517952","full_name":"bfren/docker-backup","owner":"bfren","description":"Docker image providing automated and encrypted backups to any storage provider supported by rclone.","archived":false,"fork":false,"pushed_at":"2024-07-30T15:42:49.000Z","size":64,"stargazers_count":1,"open_issues_count":2,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2024-12-31T06:44:10.200Z","etag":null,"topics":["backup","docker","duplicity","rclone"],"latest_commit_sha":null,"homepage":"","language":"Shell","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/bfren.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":".github/FUNDING.yml","license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null},"funding":{"github":"bfren","patreon":"bfren"}},"created_at":"2022-12-15T08:46:46.000Z","updated_at":"2024-10-06T20:58:49.000Z","dependencies_parsed_at":"2024-02-06T07:00:34.294Z","dependency_job_id":null,"html_url":"https://github.com/bfren/docker-backup","commit_stats":null,"previous_names":[],"tags_count":38,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bfren%2Fdocker-backup","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bfren%2Fdocker-backup/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bfren%2Fdocker-backup/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bfren%2Fdocker-backup/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/bfren","download_url":"https://codeload.github.com/bfren/docker-backup/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":239869146,"owners_count":19710482,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["backup","docker","duplicity","rclone"],"created_at":"2024-10-11T02:52:06.719Z","updated_at":"2026-02-26T12:30:17.614Z","avatar_url":"https://github.com/bfren.png","language":"Shell","funding_links":["https://github.com/sponsors/bfren","https://patreon.com/bfren"],"categories":[],"sub_categories":[],"readme":"# Docker Backup\n\n![GitHub release (latest by date)](https://img.shields.io/github/v/release/bfren/docker-backup) ![Docker Pulls](https://img.shields.io/endpoint?url=https%3A%2F%2Fbfren.dev%2Fdocker%2Fpulls%2Fbackup) ![Docker Image Size](https://img.shields.io/endpoint?url=https%3A%2F%2Fbfren.dev%2Fdocker%2Fsize%2Fbackup) ![GitHub Workflow Status](https://img.shields.io/github/actions/workflow/status/bfren/docker-backup/dev.yml?branch=main)\n\n[Docker Repository](https://hub.docker.com/r/bfren/backup) - [bfren ecosystem](https://github.com/bfren/docker)\n\nUses [Duplicity](https://duplicity.gitlab.io/) and [rclone](https://rclone.org/) to perform scheduled backups, using end-to-end encryption.\n\nUsage:\n\n```bash\n# start container\n#  .. see docker-compose.yml for a sample file\ndocker compose up -d\n\n# configure rclone\n#  .. ensure the remote storage name is the same as environment variable BACKUP_RCLONE_STORAGE\ndocker exec -it backup rclone-config\n\n# run an initial full backup\ndocker exec backup dup-full\n\n# verify backup files\ndocker exec backup dup-verify\n\n# list backup files\ndocker exec backup dup-list\n\n# restore a file or directory\n#  .. restored file or directory will be put in the /restore volume\ndocker exec backup dup-restore-file /path/to/file/or/directory\n```\n\n## Contents\n\n* [Volumes](#volumes)\n* [Licence / Copyright](#licence)\n\n## Volumes\n\n| Volume     | Purpose                                                        |\n| ---------- | -------------------------------------------------------------- |\n| `/b`       | Anything mounted in here will be backed up.                    |\n| `/config`  | Persistent duplicity and rclone configuration, plus log files. |\n| `/restore` | Restored files and directories are placed in here.             |\n\n## Environment Variables\n\n| Variable                          | Values  | Description                                                                                                    | Default                              |\n| --------------------------------- | ------- | -------------------------------------------------------------------------------------------------------------- | ------------------------------------ |\n| `BACKUP_COMMAND`                  | string  | The command to run on the schedule set by `BACKUP_CRON`.                                                       | dup-default                          |\n| `BACKUP_CRON`                     | string  | Cron schedule on which backup will be run.                                                                     | 0 0 \\* \\* \\* - every day at midnight |\n| `BACKUP_PASSPHRASE`               | string  | End-to-end encryption passphrase - if changed, backups cannot be restored.                                     | *None* - required                    |\n| `BACKUP_DUPLICITY_FULL_EVERY`     | string  | How often to run a full backup (see [here](https://duplicity.gitlab.io/stable/duplicity.1.html#time-formats)). | 1M - one month                       |\n| `BACKUP_DUPLICITY_KEEP_FULL`      | integer | How many full backups to keep - more than this will be removed as part of the schedule.                        | 3                                    |\n| `BACKUP_DUPLICITY_VERBOSITY`      | string  | The output verbosity of duplicity operations (error, warning, notice, info, debug).                            | notice                               |\n| `BACKUP_DUPLICITY_VOLSIZE_IN_MB`  | integer | The size (in MB) of each volume in the backup set.                                                             | 200                                  |\n| `BACKUP_RCLONE_STORAGE`           | string  | The name of the (configured) rclone storage provider.                                                          | *None* - required                    |\n| `BACKUP_RCLONE_PATH`              | string  | The root path within the storage provider in which to put backup files.                                        | /                                    |\n| `BACKUP_RCLONE_CUSTOM_CMD`        | string  | Use with BACKUP_COMMAND=rclone-custom to run rclone however you want using the configuration in `/config`.     | *None*                               |\n| `BACKUP_RCLONE_CUSTOM_ARG`        | string  | Use with BACKUP_COMMAND=rclone-custom to run rclone however you want using the configuration in `/config`.     | *None*                               |\n\nAdditionally you can use `RCLONE_` to [configure rclone](https://rclone.org/docs/#environment-variables).  By default `RCLONE_CHECKSUM` is `true` to enable file checking based on checksum and date, not size.\n\n## Licence\n\n\u003e [MIT](https://mit.bfren.dev/2022)\n\n## Copyright\n\n\u003e Copyright (c) 2022-2023 [bfren](https://bfren.dev) (unless otherwise stated)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbfren%2Fdocker-backup","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fbfren%2Fdocker-backup","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbfren%2Fdocker-backup/lists"}