readme: added "Amazon Web Services (AWS) Remote Backups" to TOC

This commit is contained in:
Sameer Naik 2015-05-08 22:03:16 +05:30
parent d0df4a24e9
commit 6fa0bad07e

View File

@ -49,6 +49,7 @@
- [Creating Backups](#creating-backups)
- [Restoring Backups](#restoring-backups)
- [Automated Backups](#automated-backups)
+ [Amazon Web Services (AWS) Remote Backups](#amazon-web-services-aws-remote-backups)
- [Shell Access](#shell-access)
- [Upgrading](#upgrading)
- [Rake Tasks](#rake-tasks)
@ -850,7 +851,7 @@ Daily backups are created at `GITLAB_BACKUP_TIME` which defaults to `04:00` ever
By default, when automated backups are enabled, backups are held for a period of 7 days. While when automated backups are disabled, the backups are held for an infinite period of time. This can behavior can be configured via the `GITLAB_BACKUP_EXPIRY` option.
## Automatic Amazon Web Services (AWS) S3 Uploads
### Amazon Web Services (AWS) Remote Backups
The image can be configured to automatically upload the backups to an AWS S3 bucket. To enable automatic AWS backups first add `-e 'AWS_BACKUPS=true'` to the docker run command. In addition `AWS_BACKUP_REGION` and `AWS_BACKUP_BUCKET` must be properly configured to point to the desired AWS location. Finally an IAM user must be configured with appropriate access permission and their AWS keys exposed through `AWS_BACKUP_ACCESS_KEY_ID` and `AWS_BACKUP_SECRET_ACCESS_KEY`.