{"id":13567659,"url":"https://github.com/dokku/docker-s3backup","last_synced_at":"2025-10-06T12:07:17.136Z","repository":{"id":39867995,"uuid":"72410925","full_name":"dokku/docker-s3backup","owner":"dokku","description":"Backups streaming to S3 via s3gof3r in Docker","archived":false,"fork":false,"pushed_at":"2024-09-22T03:58:31.000Z","size":150,"stargazers_count":31,"open_issues_count":0,"forks_count":13,"subscribers_count":4,"default_branch":"main","last_synced_at":"2024-10-30T00:56:02.461Z","etag":null,"topics":["aws","docker","docker-image","dokku","paas","s3"],"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/dokku.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},"funding":{"github":"dokku","open_collective":"dokku","patreon":"dokku"}},"created_at":"2016-10-31T06:57:08.000Z","updated_at":"2024-09-22T03:58:33.000Z","dependencies_parsed_at":"2023-02-16T16:01:01.812Z","dependency_job_id":"3816d2a4-0941-4af6-b1f6-048837a5ea31","html_url":"https://github.com/dokku/docker-s3backup","commit_stats":{"total_commits":125,"total_committers":12,"mean_commits":"10.416666666666666","dds":0.64,"last_synced_commit":"f868140a5789dad161f13a7777de7e023ec93f8d"},"previous_names":[],"tags_count":25,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dokku%2Fdocker-s3backup","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dokku%2Fdocker-s3backup/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dokku%2Fdocker-s3backup/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dokku%2Fdocker-s3backup/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/dokku","download_url":"https://codeload.github.com/dokku/docker-s3backup/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":246469333,"owners_count":20782707,"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":["aws","docker","docker-image","dokku","paas","s3"],"created_at":"2024-08-01T13:02:38.196Z","updated_at":"2025-10-06T12:07:17.073Z","avatar_url":"https://github.com/dokku.png","language":"Shell","funding_links":["https://github.com/sponsors/dokku","https://opencollective.com/dokku","https://patreon.com/dokku"],"categories":["Shell"],"sub_categories":[],"readme":"# docker-s3backup\n\n[![dokku/s3backup](http://dockeri.co/image/dokku/s3backup)](https://hub.docker.com/r/dokku/s3backup/)\n\n## Info\n\nDocker image that creates and streams a tar backup of a host volume to Amazon S3 storage.\n\n+ Lightweight: Based on the [Alpine](https://github.com/gliderlabs/docker-alpine) base image\n+ Fast: Backups are streamed directly to S3 with [awscli](https://docs.aws.amazon.com/cli/latest/reference/s3/cp.html)\n+ Versatile: Can also be used with selfhosted S3-compatible services like [minio](https://github.com/minio/minio)\n\n## Usage\n\nRun the automated build, specifying your AWS credentials, bucket name, and backup path.\n\n```shell\ndocker run -it \\\n      -e AWS_ACCESS_KEY_ID=ID \\\n      -e AWS_SECRET_ACCESS_KEY=KEY \\\n      -e BUCKET_NAME=backups \\\n      -e BACKUP_NAME=backup \\\n      -v /path/to/backup:/backup dokku/s3backup\n```\n\n### Advanced Usage\n\nExample with different region, different S3 storage class, different signature version and call to S3-compatible\nservice (different endpoint url)\n\n```shell\ndocker run -it \\\n      -e AWS_ACCESS_KEY_ID=ID \\\n      -e AWS_SECRET_ACCESS_KEY=KEY \\\n      -e AWS_DEFAULT_REGION=us-east-1 \\\n      -e AWS_SIGNATURE_VERSION=s3v4 \\\n      -e S3_STORAGE_CLASS=STANDARD_IA \\\n      -e ENDPOINT_URL=https://YOURAPIURL \\\n      -e BUCKET_NAME=backups \\\n      -e BACKUP_NAME=backup \\\n      -v /path/to/backup:/backup dokku/s3backup\n```\n\n### Encryption\n\nYou can optionally encrypt your backup using GnuPG. To do so, set ENCRYPTION_KEY. This would encrypt the backup with the\npassphrase \"your_secret_passphrase\". The cypher algorithm used is AES256.\n\n```shell\ndocker run -it \\\n      -e AWS_ACCESS_KEY_ID=ID \\\n      -e AWS_SECRET_ACCESS_KEY=KEY \\\n      -e BUCKET_NAME=backups \\\n      -e BACKUP_NAME=backup \\\n      -e ENCRYPTION_KEY=your_secret_passphrase\n      -v /path/to/backup:/backup dokku/s3backup\n```\n\nYou can also use a GPG public key to encrypt the backup. To do so, set ENCRYPTION_KEY to the public key. This would\nencrypt the backup with the public key. **The backup can only be decrypted with the corresponding private key**, making\nit impossible to encrypt your data even if the backups and all the configuration files are compromised.\n\n```shell\ndocker run -it \\\n      -e AWS_ACCESS_KEY_ID=ID \\\n      -e AWS_SECRET_ACCESS_KEY=KEY \\\n      -e BUCKET_NAME=backups \\\n      -e BACKUP_NAME=backup \\\n      -e ENCRYPT_WITH_PUBLIC_KEY_ID=public_key_id \\\n      -v /path/to/backup:/backup dokku/s3backup\n```\n\nIn the above command, replace `public_key_id` with the ID (or, even better, the fingerprint) of your GPG public key. The\nbackup will be encrypted using this\npublic key and can only be decrypted with the corresponding private key. Please note that the public key must be\navailable on the keyserver specified by the KEYSERVER environment variable. By default, this is set\nto `hkp://keyserver.ubuntu.com` and can be overridden by setting the KEYSERVER environment variable:\n\n```shell\ndocker run -it \\\n      -e AWS_ACCESS_KEY_ID=ID \\\n      -e AWS_SECRET_ACCESS_KEY=KEY \\\n      -e BUCKET_NAME=backups \\\n      -e BACKUP_NAME=backup \\\n      -e ENCRYPT_WITH_PUBLIC_KEY_ID=public_key_id \\\n      -e KEYSERVER=hkp://pgp.mit.edu \\\n      -v /path/to/backup:/backup dokku/s3backup\n```\n\n## Building\n\nFirst, build the image.\n\n```shell\ndocker build -t s3backup .\n```\n\nThen run the image, specifying your AWS credentials, bucket name, and backup path.\n\n```shell\ndocker run -it \\\n      -e AWS_ACCESS_KEY_ID=ID \\\n      -e AWS_SECRET_ACCESS_KEY=KEY \\\n      -e BUCKET_NAME=backups \\\n      -e BACKUP_NAME=backup \\\n      -v /path/to/backup:/backup s3backup\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdokku%2Fdocker-s3backup","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fdokku%2Fdocker-s3backup","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdokku%2Fdocker-s3backup/lists"}