# s3sync-awscliv2

s3sync-awscliv2 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/2396/s3sync-awscliv2

## 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. This app has been based on the already available s3sync, however that was outdated, this version contains AWS CLI V2 and doesn't rely on extra python packages.

## Platform availability

Available on 1 of 10 platforms: Unraid.

## Health score

44/100 (Fair), based on 3 of 4 factors.
- Maintained: 72 (last commit 25 days ago)
- Popular: 6 (1 GitHub stars)
- Easy to install: 35 (1 install platform, install notes, Docker image)

## Links

- Docker Hub: https://hub.docker.com/r/jvdgt/docker-s3sync
- Unraid: https://ca.unraid.net/apps/s3sync-awscliv2-1h4hw4n1oso5tv?q=s3sync-awscliv2

## Common questions

### Which local folders does s3sync back up?

Mount the folders you want to back up under the /data directory in the container.

### Which environment variables should I set for basic use?

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

### Can I pass --delete or other AWS sync flags?

Yes, put extra aws s3 sync parameters in S3SYNCPARAMS. If you use --delete, it removes files not present in the synced folders inside the specified S3 prefix.

### How often does the sync run?

It runs every hour by default with CRON_SCHEDULE set to 0 * * * *. You can change it using standard CRON notation, but a more frequent schedule is not advised.

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