{"id":17062896,"url":"https://github.com/bretfisher/docker-vackup","last_synced_at":"2025-04-08T09:11:18.237Z","repository":{"id":37009428,"uuid":"269491218","full_name":"BretFisher/docker-vackup","owner":"BretFisher","description":"Script to easily backup and restore docker volumes","archived":false,"fork":false,"pushed_at":"2024-11-01T19:40:25.000Z","size":20,"stargazers_count":436,"open_issues_count":16,"forks_count":76,"subscribers_count":11,"default_branch":"main","last_synced_at":"2025-04-02T23:33:11.041Z","etag":null,"topics":["backup","containers","docker","volumes"],"latest_commit_sha":null,"homepage":"","language":"Shell","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"unlicense","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/BretFisher.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE.txt","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},"funding":{"custom":"bretfisher.com/members"}},"created_at":"2020-06-05T00:08:15.000Z","updated_at":"2025-03-20T19:37:04.000Z","dependencies_parsed_at":"2025-01-19T04:48:18.073Z","dependency_job_id":null,"html_url":"https://github.com/BretFisher/docker-vackup","commit_stats":{"total_commits":20,"total_committers":3,"mean_commits":6.666666666666667,"dds":"0.44999999999999996","last_synced_commit":"2a8a73136302af0bebeb7f210fc14be868ab2958"},"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/BretFisher%2Fdocker-vackup","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/BretFisher%2Fdocker-vackup/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/BretFisher%2Fdocker-vackup/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/BretFisher%2Fdocker-vackup/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/BretFisher","download_url":"https://codeload.github.com/BretFisher/docker-vackup/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247809964,"owners_count":20999816,"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","containers","docker","volumes"],"created_at":"2024-10-14T10:51:01.089Z","updated_at":"2025-04-08T09:11:18.181Z","avatar_url":"https://github.com/BretFisher.png","language":"Shell","funding_links":["bretfisher.com/members"],"categories":[],"sub_categories":[],"readme":"# Vackup: Backup and Restore Docker Volumes\n\n[![Lint Code Base](https://github.com/BretFisher/docker-vackup/actions/workflows/linter.yml/badge.svg)](https://github.com/BretFisher/docker-vackup/actions/workflows/linter.yml)\n\n**This is now an [Official Docker Desktop Extension called \"Volumes Backup \u0026 Share\"](https://hub.docker.com/extensions/docker/volumes-backup-extension) which has more features, but I'll keep this repo around for historial purposes.**\n\nVackup: (contraction of \"volume backup\")\n\nEasily backup and restore Docker volumes using either tarballs or container images.\nIt's designed for running from any host/container where you have the docker CLI.\n\nNote that for open files like databases,\nit's usually better to use their preferred backup tool to create a backup file,\nbut if you stored that file on a Docker volume,\nthis could still be a way you get the Docker volume into a image or tarball\nfor moving to remote storage for safe keeping.\n\n`export`/`import` commands copy files between a local tarball and a volume.\nFor making volume backups and restores.\n\n`save`/`load` commands copy files between an image and a volume.\nFor when you want to use image registries as a way to push/pull volume data.\n\nUsage:\n\n`vackup export VOLUME FILE`\n  Creates a gzip'ed tarball in current directory from a volume\n\n`vackup import FILE VOLUME`\n  Extracts a gzip'ed tarball into a volume\n\n`vackup save VOLUME IMAGE`\n  Copies the volume contents to a busybox image in the /volume-data directory\n\n`vackup load IMAGE VOLUME`\n  Copies /volume-data contents from an image to a volume\n\n## Install\n\nDownload the `vackup` file in this repository to your local machine in your shell path and make it executable.\n\n```shell\nsudo curl -sSL https://raw.githubusercontent.com/BretFisher/docker-vackup/main/vackup -o /usr/local/bin/vackup \u0026\u0026 sudo chmod +x /usr/local/bin/vackup\n```\n\n## Error conditions\n\nIf any of the commands fail, the script will check to see if a `VACKUP_FAILURE_SCRIPT`\nenvironment variable is set.  If so it will run it and pass the line number the error\nhappened on and the exit code from the failed command.  Eg,\n\n```shell\n# /opt/bin/vackup-failed.sh\nLINE_NUMBER=$1\nEXIT_CODE=$2\nsend_slack_webhook \"Vackup failed on line number ${LINE_NUMBER} with exit code ${EXIT_CODE}!\"\n```\n\n```shell\nexport VACKUP_FAILURE_SCRIPT=/opt/bin/vackup-failed.sh\n./vackup export ......\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbretfisher%2Fdocker-vackup","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fbretfisher%2Fdocker-vackup","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbretfisher%2Fdocker-vackup/lists"}