{"id":13446671,"url":"https://github.com/offen/docker-volume-backup","last_synced_at":"2026-02-26T11:23:01.064Z","repository":{"id":37096796,"uuid":"354002444","full_name":"offen/docker-volume-backup","owner":"offen","description":"Backup Docker volumes locally or to any S3, WebDAV, Azure Blob Storage, Dropbox, Google Drive or SSH compatible storage","archived":false,"fork":false,"pushed_at":"2026-01-13T07:03:58.000Z","size":1429,"stargazers_count":3287,"open_issues_count":26,"forks_count":122,"subscribers_count":10,"default_branch":"main","last_synced_at":"2026-01-13T10:25:12.200Z","etag":null,"topics":["backup","docker","docker-compose","docker-swarm","docker-volume","s3","ssh","webdav"],"latest_commit_sha":null,"homepage":"https://offen.github.io/docker-volume-backup/","language":"Go","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mpl-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/offen.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"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,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null},"funding":{"github":"offen","patreon":"offen"}},"created_at":"2021-04-02T11:45:32.000Z","updated_at":"2026-01-13T07:04:01.000Z","dependencies_parsed_at":"2023-09-29T07:00:02.255Z","dependency_job_id":"40d3c385-5a79-4020-a8cc-bfc78c79c05a","html_url":"https://github.com/offen/docker-volume-backup","commit_stats":{"total_commits":417,"total_committers":32,"mean_commits":13.03125,"dds":"0.36690647482014394","last_synced_commit":"e0fcbd27e58948acb11a1fbdfec07f474a136623"},"previous_names":[],"tags_count":121,"template":false,"template_full_name":null,"purl":"pkg:github/offen/docker-volume-backup","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/offen%2Fdocker-volume-backup","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/offen%2Fdocker-volume-backup/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/offen%2Fdocker-volume-backup/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/offen%2Fdocker-volume-backup/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/offen","download_url":"https://codeload.github.com/offen/docker-volume-backup/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/offen%2Fdocker-volume-backup/sbom","scorecard":{"id":456588,"data":{"date":"2025-08-11","repo":{"name":"github.com/offen/docker-volume-backup","commit":"a552403a4459dafcdac02fd811e37527ea786873"},"scorecard":{"version":"v5.2.1-40-gf6ed084d","commit":"f6ed084d17c9236477efd66e5b258b9d4cc7b389"},"score":5.2,"checks":[{"name":"Maintained","score":10,"reason":"30 commit(s) and 15 issue activity found in the last 90 days -- score normalized to 10","details":null,"documentation":{"short":"Determines if the project is \"actively maintained\".","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#maintained"}},{"name":"Code-Review","score":0,"reason":"Found 1/30 approved changesets -- score normalized to 0","details":null,"documentation":{"short":"Determines if the project requires human code review before pull requests (aka merge requests) are merged.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#code-review"}},{"name":"Dangerous-Workflow","score":10,"reason":"no dangerous workflow patterns detected","details":null,"documentation":{"short":"Determines if the project's GitHub Action workflows avoid dangerous patterns.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#dangerous-workflow"}},{"name":"Token-Permissions","score":0,"reason":"detected GitHub workflow tokens with excessive permissions","details":["Info: jobLevel 'contents' permission set to 'read': .github/workflows/release.yml:13","Info: topLevel 'contents' permission set to 'read': .github/workflows/deploy-docs.yml:12","Info: topLevel 'contents' permission set to 'read': .github/workflows/golangci-lint.yml:9","Info: topLevel 'pull-requests' permission set to 'read': .github/workflows/golangci-lint.yml:11","Warn: no topLevel permission defined: .github/workflows/release.yml:1","Warn: no topLevel permission defined: .github/workflows/test.yml:1","Warn: no topLevel permission defined: .github/workflows/unit.yml:1","Info: no jobLevel write permissions found"],"documentation":{"short":"Determines if the project's workflows follow the principle of least privilege.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#token-permissions"}},{"name":"Binary-Artifacts","score":10,"reason":"no binaries found in the repo","details":null,"documentation":{"short":"Determines if the project has generated executable (binary) artifacts in the source repository.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#binary-artifacts"}},{"name":"CII-Best-Practices","score":0,"reason":"no effort to earn an OpenSSF best practices badge detected","details":null,"documentation":{"short":"Determines if the project has an OpenSSF (formerly CII) Best Practices Badge.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#cii-best-practices"}},{"name":"Fuzzing","score":0,"reason":"project is not fuzzed","details":["Warn: no fuzzer integrations found"],"documentation":{"short":"Determines if the project uses fuzzing.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#fuzzing"}},{"name":"License","score":10,"reason":"license file detected","details":["Info: project has a license file: LICENSE:0","Info: FSF or OSI recognized license: Mozilla Public License 2.0: LICENSE:0"],"documentation":{"short":"Determines if the project has defined a license.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#license"}},{"name":"Signed-Releases","score":-1,"reason":"no releases found","details":null,"documentation":{"short":"Determines if the project cryptographically signs release artifacts.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#signed-releases"}},{"name":"Packaging","score":10,"reason":"packaging workflow detected","details":["Info: Project packages its releases by way of GitHub Actions.: .github/workflows/release.yml:8"],"documentation":{"short":"Determines if the project is published as a package that others can easily download, install, easily update, and uninstall.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#packaging"}},{"name":"Branch-Protection","score":-1,"reason":"internal error: error during branchesHandler.setup: internal error: githubv4.Query: Resource not accessible by integration","details":null,"documentation":{"short":"Determines if the default and release branches are protected with GitHub's branch protection settings.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#branch-protection"}},{"name":"Security-Policy","score":0,"reason":"security policy file not detected","details":["Warn: no security policy file detected","Warn: no security file to analyze","Warn: no security file to analyze","Warn: no security file to analyze"],"documentation":{"short":"Determines if the project has published a security policy.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#security-policy"}},{"name":"Pinned-Dependencies","score":0,"reason":"dependency not pinned by hash detected -- score normalized to 0","details":["Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/deploy-docs.yml:25: update your workflow using https://app.stepsecurity.io/secureworkflow/offen/docker-volume-backup/deploy-docs.yml/main?enable=pin","Warn: third-party GitHubAction not pinned by hash: .github/workflows/deploy-docs.yml:27: update your workflow using https://app.stepsecurity.io/secureworkflow/offen/docker-volume-backup/deploy-docs.yml/main?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/deploy-docs.yml:35: update your workflow using https://app.stepsecurity.io/secureworkflow/offen/docker-volume-backup/deploy-docs.yml/main?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/deploy-docs.yml:42: update your workflow using https://app.stepsecurity.io/secureworkflow/offen/docker-volume-backup/deploy-docs.yml/main?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/deploy-docs.yml:55: update your workflow using https://app.stepsecurity.io/secureworkflow/offen/docker-volume-backup/deploy-docs.yml/main?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/golangci-lint.yml:18: update your workflow using https://app.stepsecurity.io/secureworkflow/offen/docker-volume-backup/golangci-lint.yml/main?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/golangci-lint.yml:19: update your workflow using https://app.stepsecurity.io/secureworkflow/offen/docker-volume-backup/golangci-lint.yml/main?enable=pin","Warn: third-party GitHubAction not pinned by hash: .github/workflows/golangci-lint.yml:24: update your workflow using https://app.stepsecurity.io/secureworkflow/offen/docker-volume-backup/golangci-lint.yml/main?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/release.yml:16: update your workflow using https://app.stepsecurity.io/secureworkflow/offen/docker-volume-backup/release.yml/main?enable=pin","Warn: third-party GitHubAction not pinned by hash: .github/workflows/release.yml:25: update your workflow using https://app.stepsecurity.io/secureworkflow/offen/docker-volume-backup/release.yml/main?enable=pin","Warn: third-party GitHubAction not pinned by hash: .github/workflows/release.yml:51: update your workflow using https://app.stepsecurity.io/secureworkflow/offen/docker-volume-backup/release.yml/main?enable=pin","Warn: third-party GitHubAction not pinned by hash: .github/workflows/release.yml:54: update your workflow using https://app.stepsecurity.io/secureworkflow/offen/docker-volume-backup/release.yml/main?enable=pin","Warn: third-party GitHubAction not pinned by hash: .github/workflows/release.yml:57: update your workflow using https://app.stepsecurity.io/secureworkflow/offen/docker-volume-backup/release.yml/main?enable=pin","Warn: third-party GitHubAction not pinned by hash: .github/workflows/release.yml:63: update your workflow using https://app.stepsecurity.io/secureworkflow/offen/docker-volume-backup/release.yml/main?enable=pin","Warn: third-party GitHubAction not pinned by hash: .github/workflows/release.yml:86: update your workflow using https://app.stepsecurity.io/secureworkflow/offen/docker-volume-backup/release.yml/main?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/test.yml:13: update your workflow using https://app.stepsecurity.io/secureworkflow/offen/docker-volume-backup/test.yml/main?enable=pin","Warn: third-party GitHubAction not pinned by hash: .github/workflows/test.yml:16: update your workflow using https://app.stepsecurity.io/secureworkflow/offen/docker-volume-backup/test.yml/main?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/unit.yml:13: update your workflow using https://app.stepsecurity.io/secureworkflow/offen/docker-volume-backup/unit.yml/main?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/unit.yml:15: update your workflow using https://app.stepsecurity.io/secureworkflow/offen/docker-volume-backup/unit.yml/main?enable=pin","Warn: containerImage not pinned by hash: Dockerfile:4","Warn: containerImage not pinned by hash: Dockerfile:12: pin your Docker image by updating alpine:3.22 to alpine:3.22@sha256:4bcff63911fcb4448bd4fdacec207030997caf25e9bea4045fa6c8c44de311d1","Warn: containerImage not pinned by hash: test/Dockerfile:1: pin your Docker image by updating docker:28-dind to docker:28-dind@sha256:c0872aae4791ff427e6eda52769afa04f17b5cf756f8267e0d52774c99d5c9de","Warn: containerImage not pinned by hash: test/extend/Dockerfile:2","Info:   0 out of  10 GitHub-owned GitHubAction dependencies pinned","Info:   0 out of   9 third-party GitHubAction dependencies pinned","Info:   0 out of   4 containerImage dependencies pinned"],"documentation":{"short":"Determines if the project has declared and pinned the dependencies of its build process.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#pinned-dependencies"}},{"name":"SAST","score":0,"reason":"SAST tool is not run on all commits -- score normalized to 0","details":["Warn: 0 commits out of 23 are checked with a SAST tool"],"documentation":{"short":"Determines if the project uses static code analysis.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#sast"}},{"name":"Vulnerabilities","score":10,"reason":"0 existing vulnerabilities detected","details":null,"documentation":{"short":"Determines if the project has open, known unfixed vulnerabilities.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#vulnerabilities"}}]},"last_synced_at":"2025-08-19T09:51:19.216Z","repository_id":37096796,"created_at":"2025-08-19T09:51:19.216Z","updated_at":"2025-08-19T09:51:19.216Z"},"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":28486938,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-01-16T22:54:02.790Z","status":"ssl_error","status_checked_at":"2026-01-16T22:50:10.344Z","response_time":107,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.6:443 state=error: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"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","docker-compose","docker-swarm","docker-volume","s3","ssh","webdav"],"created_at":"2024-07-31T05:00:56.219Z","updated_at":"2026-01-16T22:55:56.947Z","avatar_url":"https://github.com/offen.png","language":"Go","readme":"\u003ca href=\"https://www.offen.software/\"\u003e\n    \u003cimg src=\"https://offen.github.io/press-kit/avatars/avatar-OS-header.svg\" alt=\"offen.software logo\" title=\"offen.software\" width=\"60px\"/\u003e\n\u003c/a\u003e\n\n# docker-volume-backup\n\nBackup Docker volumes locally or to any S3, WebDAV, Azure Blob Storage, Dropbox, Google Drive or SSH compatible storage.\n\nThe [offen/docker-volume-backup](https://hub.docker.com/r/offen/docker-volume-backup) Docker image can be used as a lightweight (below 25MB) companion container to an existing Docker setup.\nIt handles __recurring or one-off backups of Docker volumes__ to a __local directory__, __any S3, WebDAV, Azure Blob Storage, Dropbox, Google Drive or SSH compatible storage (or any combination thereof) and rotates away old backups__ if configured. It also supports __encrypting your backups using GPG__ and __sending notifications for (failed) backup runs__.\n\nDocumentation is found at \u003chttps://offen.github.io/docker-volume-backup\u003e\n  - [Quickstart](https://offen.github.io/docker-volume-backup)\n  - [Configuration Reference](https://offen.github.io/docker-volume-backup/reference/)\n  - [How Tos](https://offen.github.io/docker-volume-backup/how-tos/)\n  - [Recipes](https://offen.github.io/docker-volume-backup/recipes/)\n\n---\n\n## Quickstart\n\n### Recurring backups in a compose setup\n\nAdd a `backup` service to your compose setup and mount the volumes you would like to see backed up:\n\n```yml\nservices:\n  volume-consumer:\n    build:\n      context: ./my-app\n    volumes:\n      - data:/var/my-app\n    labels:\n      # This means the container will be stopped during backup to ensure\n      # backup integrity. You can omit this label if stopping during backup\n      # not required.\n      - docker-volume-backup.stop-during-backup=true\n\n  backup:\n    # In production, it is advised to lock your image tag to a proper\n    # release version instead of using `latest`.\n    # Check https://github.com/offen/docker-volume-backup/releases\n    # for a list of available releases.\n    image: offen/docker-volume-backup:latest\n    restart: always\n    env_file: ./backup.env # see below for configuration reference\n    volumes:\n      - data:/backup/my-app-backup:ro\n      # Mounting the Docker socket allows the script to stop and restart\n      # the container during backup. You can omit this if you don't want\n      # to stop the container. In case you need to proxy the socket, you can\n      # also provide a location by setting `DOCKER_HOST` in the container\n      - /var/run/docker.sock:/var/run/docker.sock:ro\n      # If you mount a local directory or volume to `/archive` a local\n      # copy of the backup will be stored there. You can override the\n      # location inside of the container by setting `BACKUP_ARCHIVE`.\n      # You can omit this if you do not want to keep local backups.\n      - /path/to/local_backups:/archive\nvolumes:\n  data:\n```\n\n### One-off backups using Docker CLI\n\nTo run a one time backup, mount the volume you would like to see backed up into a container and run the `backup` command:\n\n```console\ndocker run --rm \\\n  -v data:/backup/data \\\n  --env AWS_ACCESS_KEY_ID=\"\u003cxxx\u003e\" \\\n  --env AWS_SECRET_ACCESS_KEY=\"\u003cxxx\u003e\" \\\n  --env AWS_S3_BUCKET_NAME=\"\u003cxxx\u003e\" \\\n  --entrypoint backup \\\n  offen/docker-volume-backup:v2\n```\n\nAlternatively, pass a `--env-file` in order to use a full config as described [in the docs](https://offen.github.io/docker-volume-backup/reference/).\n\n### Looking for help?\n\nIn case your are looking for help or guidance on how to incorporate docker-volume-backup into your existing setup, consider [becoming a sponsor](https://github.com/sponsors/offen?frequency=one-time) and book a one hour consulting session.\n\n---\n\nCopyright \u0026copy; 2026 \u003ca target=\"_blank\" href=\"https://www.offen.software\"\u003eoffen.software\u003c/a\u003e and contributors.\nDistributed under the \u003ca href=\"https://github.com/offen/docker-volume-backup/tree/main/LICENSE\"\u003eMPL-2.0 License\u003c/a\u003e.\n","funding_links":["https://github.com/sponsors/offen","https://patreon.com/offen","https://github.com/sponsors/offen?frequency=one-time"],"categories":["Container Operations","Software Packages","Go","docker","Go Tools","软件包"],"sub_categories":["Volume Management / Data","DevOps Tools","DevOps 工具"],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Foffen%2Fdocker-volume-backup","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Foffen%2Fdocker-volume-backup","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Foffen%2Fdocker-volume-backup/lists"}