From 0db2dacb04dc5056f9ba5ac70e0c21fdfc68be68 Mon Sep 17 00:00:00 2001 From: PauRE Date: Thu, 7 Mar 2019 15:32:12 +0100 Subject: [PATCH] Update README.md fixes #11 Text provided by @WilliamTheMarsman, thanks. --- README.md | 17 +++++++++++++++++ 1 file changed, 17 insertions(+) diff --git a/README.md b/README.md index 552fbf5..7ec9886 100644 --- a/README.md +++ b/README.md @@ -47,6 +47,23 @@ services: ``` +### Environment Variables +Most variables are the same as [postgres official image](https://hub.docker.com/_/postgres/). + +| env variable | description | +|--|--| +| POSTGRES_HOST | postgres connection parameter; postgres host. | +| POSTGRES_DB | postgres connection parameter; postgres database to connect to. | +| 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, to use with docker secrets. | +| POSTGRES_EXTRA_OPTS | additional options to supply `pg_dump` when creating back-ups. | +| SCHEDULE | [cron-schedule](http://godoc.org/github.com/robfig/cron#hdr-Predefined_schedules) specifying the interval between taking postgres backups. | +| BACKUP_KEEP_DAYS | number of days to keep backups before removing. | +| BACKUP_KEEP_WEEKS | number of weeks to keep backups before removing. | +| BACKUP_KEEP_MONTHS | number of months to keep backups before removing. | +| HEALTHCHECK_PORT | Port listening for cron-schedule health check. | + ### Manual Backups By default it makes daily backups but you can start a manual one by running the command `/backup.sh`.