{"id":13618036,"url":"https://github.com/futurevision/docker-aws-s3-sync","last_synced_at":"2025-04-14T10:30:54.572Z","repository":{"id":79113261,"uuid":"78279146","full_name":"futurevision/docker-aws-s3-sync","owner":"futurevision","description":"Docker container to sync a folder to Amazon S3","archived":false,"fork":false,"pushed_at":"2018-08-07T06:27:03.000Z","size":5,"stargazers_count":21,"open_issues_count":1,"forks_count":30,"subscribers_count":4,"default_branch":"master","last_synced_at":"2024-11-08T03:36:27.606Z","etag":null,"topics":["alpine","alpine-linux","aws","backup","docker","docker-container","s3","s3-bucket","sync"],"latest_commit_sha":null,"homepage":null,"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/futurevision.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}},"created_at":"2017-01-07T12:59:32.000Z","updated_at":"2021-11-05T09:26:46.000Z","dependencies_parsed_at":null,"dependency_job_id":"af7bee4b-889b-4110-9fb3-36d2cba410c6","html_url":"https://github.com/futurevision/docker-aws-s3-sync","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/futurevision%2Fdocker-aws-s3-sync","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/futurevision%2Fdocker-aws-s3-sync/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/futurevision%2Fdocker-aws-s3-sync/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/futurevision%2Fdocker-aws-s3-sync/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/futurevision","download_url":"https://codeload.github.com/futurevision/docker-aws-s3-sync/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248862567,"owners_count":21173830,"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":["alpine","alpine-linux","aws","backup","docker","docker-container","s3","s3-bucket","sync"],"created_at":"2024-08-01T20:01:53.088Z","updated_at":"2025-04-14T10:30:54.310Z","avatar_url":"https://github.com/futurevision.png","language":"Shell","funding_links":[],"categories":["HarmonyOS"],"sub_categories":["Windows Manager"],"readme":"[![](https://images.microbadger.com/badges/image/futurevision/aws-s3-sync.svg)](https://microbadger.com/images/futurevision/aws-s3-sync \"Get your own image badge on microbadger.com\")\n[![](https://images.microbadger.com/badges/version/futurevision/aws-s3-sync.svg)](https://microbadger.com/images/futurevision/aws-s3-sync \"Get your own version badge on microbadger.com\")\n\n\n# futurevision/aws-s3-sync\n\nDocker container that periodically syncs a folder to Amazon S3 using the [AWS Command Line Interface tool](https://aws.amazon.com/cli/) and cron.\n\n## Usage\n\n    docker run -d [OPTIONS] futurevision/aws-s3-sync\n\n\n### Required Parameters:\n\n* `-e KEY=\u003cKEY\u003e`: User Access Key\n* `-e SECRET=\u003cSECRET\u003e`: User Access Secret\n* `-e REGION=\u003cREGION\u003e`: Region of your bucket\n* `-e BUCKET=\u003cBUCKET\u003e`: The name of your bucket\n* `-v /path/to/backup:/data:ro`: mount target local folder to container's data folder. Content of this folder will be synced with S3 bucket.\n\n### Optional parameters:\n\n* `-e PARAMS=`: parameters to pass to the sync command ([full list here](http://docs.aws.amazon.com/cli/latest/reference/s3/sync.html)).\n* `-e BUCKET_PATH=\u003cBUCKET_PATH\u003e`: The path of your s3 bucket where the files should be synced to (must start with a slash), defaults to \"/\" to sync to bucket root\n* `-e CRON_SCHEDULE=\"0 1 * * *\"`: specifies when cron job starts ([details](http://en.wikipedia.org/wiki/Cron)), defaults to `0 1 * * *` (runs every night at 1:00).\n* `now`: run container once and exit (no cron scheduling).\n\n## Examples:\n\nSync every hour with cron schedule (container keeps running):\n\n    docker run -d \\\n        -e KEY=mykey \\\n        -e SECRET=mysecret \\\n\t\t-e REGION=region \\\n        -e BUCKET=mybucket \\\n        -e CRON_SCHEDULE=\"0 * * * *\" \\\n\t\t-e BUCKET_PATH=/path \\\n        -v /home/user/data:/data:ro \\\n        futurevision/aws-s3-sync\n\nSync just once (container is deleted afterwards):\n\n    docker run --rm \\\n        -e KEY=mykey \\\n        -e SECRET=mysecret \\\n\t\t-e REGION=region \\\n        -e BUCKET=mybucket \\\n        -v /home/user/data:/data:ro \\\n        futurevision/aws-s3-sync now\n\n## Credits\n\nThis container is heavily inspired by [istepanov/backup-to-s3](https://github.com/istepanov/docker-backup-to-s3/blob/master/README.md).\n\nThe main difference is that this container is using Alpine Linux instead of Debian to be more light weight. It also uses a different method of using the AWS CLI tool.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ffuturevision%2Fdocker-aws-s3-sync","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ffuturevision%2Fdocker-aws-s3-sync","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ffuturevision%2Fdocker-aws-s3-sync/lists"}