You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

21 lines
1.1 KiB

  1. # folder-backup-s3
  2. Backup a folder in a docker container to S3
  3. ## Basic usuage
  4. ```sh
  5. $ docker run -e S3_ACCESS_KEY_ID=key -e S3_SECRET_ACCESS_KEY=secret -e S3_BUCKET=my-bucket -e S3_PREFIX=backup -e MYSQL_USER=user -e MYSQL_PASSWORD=password -e MYSQL_HOST=localhost gameboy1990/folder-backup-s3
  6. ```
  7. ## Environment variables
  8. - `DATA_PATH` your data folder to backup *required*
  9. - `S3_ACCESS_KEY_ID` your AWS access key *required*
  10. - `S3_SECRET_ACCESS_KEY` your AWS secret key *required*
  11. - `S3_BUCKET` your AWS S3 bucket path *required*
  12. - `S3_PREFIX` path prefix in your bucket (default: 'folder-backup')
  13. - `S3_REGION` the AWS S3 bucket region (default: us-west-1)
  14. - `S3_ENDPOINT` the AWS Endpoint URL, for S3 Compliant APIs such as [minio](https://minio.io) (default: none)
  15. - `S3_S3V4` set to `yes` to enable AWS Signature Version 4, required for [minio](https://minio.io) servers (default: no)
  16. - `SCHEDULE` backup schedule time, see explainatons below
  17. - `DELETE_OLDER_THAN` delete files older than e.g. "30 days" reference arguments from [date](https://ss64.com/bash/date.html)