# S3sync

S3sync is a self-hosted backup app. This application backs up every folder mounted at /data/ to a given AWS S3 path using the aws s3 sync command. It is open source and self-hosted, installable on Docker Hub and Unraid.

Canonical page: https://ourlocalhost.com/app/1456/s3sync

## Description

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 9 platforms: Unraid.

## Health score

12/100 (Low), based on 3 of 4 factors.
- Maintained: 0 (last commit 1988 days ago)
- Popular: 12 (3 GitHub stars)
- Easy to install: 35 (1 install platform, install notes, Docker image)

## Links

- Docker Hub: https://hub.docker.com/repository/docker/whatname/docker-s3sync
- Unraid: https://ca.unraid.net/apps/s3sync-1fkj69c1yesm50?q=s3sync

## 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.

---
Source: Our Local Host (https://ourlocalhost.com/app/1456/s3sync), the self-hosted and open-source app directory.