S3sync

This application backs up every folder mounted at `/data/` to a given AWS S3 path using the `aws s3 sync` command.

  • Backup
  • Cloud
This application backs up every folder mounted at `/data/` to a given AWS S3 path using the `aws s3 sync` command. It requires a pair of (IAM) Access and Secret Keys. You can supply the usual s3 sync parameters such as `--delete` and everything else. The cron schedule defines how often the sync command is executed, and it uses a lockfile to avoid parallel executions.

Platform availability

Available on 1 of 10 platforms

  • Unraid
  • TrueNAS (not listed)
  • Umbrel (not listed)
  • ZimaOS (not listed)
  • Proxmox (not listed)
  • Helm (not listed)
  • Mac (not listed)
  • Windows (not listed)
  • Linux (not listed)
  • Any server (not listed)

Health score?A 0-100 score computed nightly from four factors: maintained (40%: recent commits and steady activity), popular (25%: GitHub stars, log scale), easy to install (20%: platforms, install notes, setup guides, Docker image) and light to run (15%: minimum RAM, ARM support). When the source code has been checked, a fifth factor, security check (20%: automated scan for committed secrets, unsafe desktop-app settings, known-vulnerable dependencies and project hygiene; any serious finding caps it at 20), is added. Factors without data are left out and the rest are rescaled.

12/100 Low

Maintained
0last commit 2018 days ago
Popular
123 GitHub stars
Easy to install
351 install platform, install notes, Docker image
Light to run
No data

Based on 3 of 4 factors.

Availability: platform listings confirmed today, links checked 42 days ago

GitHub stars
3
Open issues
2
Last commit
2021-05-13
Activity
stale

Checked 18 days ago - source: GitHub (what-name/docker-s3sync)

Resources & Compatibility

ARM (e.g. Raspberry Pi) is not supported.

Checked 54 days ago - source: Docker Hub image tags and published docs

First-install notes

  • Credentials and paths Set ACCESS_KEY and SECRET_KEY, mount source folders under /data, and configure the target S3 path and cron schedule. source

Fetched 45 days ago - each note links to its source

Alternatives

No alternatives collected yet.

Common questions

How do I choose which local folders are backed up?

Mount the local folders you want to protect under /data in the container. s3sync backs up folders mounted there to the S3 path.

Which environment variables does s3sync need for AWS S3?

Set ACCESS_KEY, SECRET_KEY, REGION, and S3PATH. You can also set S3SYNCPARAMS for extra aws s3 sync parameters.

Will --delete remove files outside the synced folders?

If S3PATH points to a prefix and S3SYNCPARAMS includes --delete, the prefix is deleted and only the synced folders and files remain inside that prefix.

Is there an Unraid package?

s3sync is listed in Unraid Community Applications. Search for s3sync in CA to install it.

Why does it fail for a US bucket with uppercase or unusual characters?

For a US bucket with uppercase or unusual characters, set AWS_CALLING_FORMAT to REGULAR. That value is the default.

Answers sourced from github.com, s3sync.net

Community

Collected 48 days ago - public community threads