# S3Backup

S3Backup is a Docker container that schedules routine backups of mounted local folders to Amazon S3 or Glacier using s3cmd. It is open source and self-hosted, installable on Docker Hub and Unraid.

Canonical page: https://ourlocalhost.com/app/1265/s3backup

## Description

S3Backup is a Docker container that schedules routine backups of mounted local folders to Amazon S3 or Glacier using s3cmd.

## Platform availability

Available on 1 of 9 platforms: Unraid.

## Health score

14/100 (Low), based on 4 of 4 factors.
- Maintained: 0 (last commit 2600 days ago)
- Popular: 22 (12 GitHub stars)
- Easy to install: 35 (1 install platform, install notes, Docker image)
- Light to run: 10 (32 GB minimum RAM)

## Links

- GitHub: https://github.com/joch/docker-s3backup
- Docker Hub: https://hub.docker.com/r/joch/s3backup
- Unraid: https://ca.unraid.net/apps/s3backup-1h917z41df184c?q=S3Backup

## Common questions

### How do I tell S3Backup which local folders to back up?

Mount the directories you want backed up into the container under the /data directory.

### Which environment variables are required to configure S3Backup?

Set ACCESS_KEY, SECRET_KEY, and S3PATH for your AWS credentials and S3 destination. S3CMDPARAMS is optional and can contain extra s3cmd parameters.

### How often does S3Backup run by default, and how can I change that?

It runs once every hour by default. Set CRON_SCHEDULE using standard CRON notation to change the schedule.

### Can I pass additional s3cmd options to the backup job?

Yes, add extra s3cmd parameters with the S3CMDPARAMS environment variable.

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