diff --git a/README.md b/README.md index 7dae9117..44ea46c3 100644 --- a/README.md +++ b/README.md @@ -788,6 +788,11 @@ Below is the complete list of available options that can be used to customize yo - **GOOGLE_ANALYTICS_ID**: Google Analytics ID. No defaults. - **PIWIK_URL**: Sets the Piwik URL. No defaults. - **PIWIK_SITE_ID**: Sets the Piwik site ID. No defaults. +- **AWS_BACKUPS**: Enables automatic uploads to an Amazon S3 instance. Defaults to `false`. +- **AWS_BACKUP_REGION**: AWS region. No defaults. +- **AWS_BACKUP_ACCESS_KEY_ID**: AWS access key id. No defaults. +- **AWS_BACKUP_SECRET_ACCESS_KEY**: AWS secret access key. No defaults. +- **AWS_BACKUP_BUCKET**: AWS bucket for backup uploads. No defaults. # Maintenance @@ -844,6 +849,14 @@ 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 + +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`. + +More details about the appropriate IAM user properties can found on [doc.gitlab.com](http://doc.gitlab.com/ce/raketasks/backup_restore.html#upload-backups-to-remote-cloud-storage) + +AWS uploads are performed alongside normal backups, both through the appropriate `app:rake` command and when an automatic backup is performed. + ## Shell Access For debugging and maintenance purposes you may want access the containers shell. If you are using docker version `1.3.0` or higher you can access a running containers shell using `docker exec` command.