Complete Environment Variable Description

+ Undocumented environment variables
+ Required / defaults description
~ Order alphabetically
This commit is contained in:
Jonas Thelemann
2019-03-19 20:18:09 +01:00
parent 459fafd9ae
commit 700796b6e2
+13 -11
View File
@@ -51,17 +51,19 @@ Most variables are the same as in the [official postgres image](https://hub.dock
| env variable | description |
|--|--|
| POSTGRES_HOST | postgres connection parameter; postgres host to connect to. |
| POSTGRES_DB | comma or space separated list of postgres databases to backup. |
| POSTGRES_USER | postgres connection parameter; postgres user to connect with. |
| POSTGRES_PASSWORD | postgres connection parameter; postgres password to connect with. |
| POSTGRES_PASSWORD_FILE | alternative to POSTGRES_PASSWORD, useful with docker secrets. |
| POSTGRES_EXTRA_OPTS | additional options for `pg_dump`. |
| SCHEDULE | [cron-schedule](http://godoc.org/github.com/robfig/cron#hdr-Predefined_schedules) specifying the interval between postgres backups. |
| BACKUP_KEEP_DAYS | number of daily backups to keep before removal. |
| BACKUP_KEEP_WEEKS | number of weekkly backups to keep before removal. |
| BACKUP_KEEP_MONTHS | number of monthly backups to keep before removal. |
| HEALTHCHECK_PORT | Port listening for cron-schedule health check. |
| BACKUP_DIR | Directory to save the backup at. Defaults to `/backups`. |
| BACKUP_KEEP_DAYS | Number of daily backups to keep before removal. Defaults to `7`. |
| BACKUP_KEEP_WEEKS | Number of weekkly backups to keep before removal. Defaults to `4`. |
| BACKUP_KEEP_MONTHS | Number of monthly backups to keep before removal. Defaults to `6`. |
| HEALTHCHECK_PORT | Port listening for cron-schedule health check. Defaults to `8080`. |
| POSTGRES_DB | Comma or space separated list of postgres databases to backup. Required. |
| POSTGRES_EXTRA_OPTS | Additional options for `pg_dump`. Defaults to `-Z9`. |
| POSTGRES_HOST | Postgres connection parameter; postgres host to connect to. Required. |
| POSTGRES_PASSWORD | Postgres connection parameter; postgres password to connect with. Required. |
| POSTGRES_PASSWORD_FILE | Alternative to POSTGRES_PASSWORD, useful with docker secrets. |
| POSTGRES_PORT | Postgres connection parameter; postgres port to connect to. Defaults to `5432`. |
| POSTGRES_USER | Postgres connection parameter; postgres user to connect with. Required. |
| SCHEDULE | [Cron-schedule](http://godoc.org/github.com/robfig/cron#hdr-Predefined_schedules) specifying the interval between postgres backups. Defaults to `@daily`. |
### Manual Backups