Skip to content

Update ENVIRONMENT.rst to reflect nature of PGHOME, PGROOT and PGDATA #1192

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
robinp wants to merge 1 commit into
base: trigger
Choose a base branch
from
+3 −3
Open

Update ENVIRONMENT.rst to reflect nature of PGHOME, PGROOT and PGDATA #1192

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions ENVIRONMENT.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,14 +9,14 @@ Environment Configuration Settings
- **ETCD_CACERT**: Etcd CA certificate. If present it will enable validation.
- **ETCD_CERT**: Etcd client certificate.
- **ETCD_KEY**: Etcd client certificate key. Can be empty if the key is part of certificate.
- **PGHOME**: filesystem path where to put PostgreSQL home directory (/home/postgres by default)
- **APIPORT**: TCP port to Patroni API connections (8008 by default)
- **BACKUP_SCHEDULE**: cron schedule for doing backups via WAL-G ('00 01 * * *' by default)
- **CLONE_TARGET_TIMELINE**: timeline id of the backup for restore, 'latest' by default.
- **CRONTAB**: anything that you want to run periodically as a cron job (empty by default)
- **PGROOT**: a directory where we put the pgdata (by default /home/postgres/pgroot). One may adjust it to point to the mount point of the persistent volume, such as EBS.
- **PGHOME**: filesystem path where to put PostgreSQL home directory (/home/postgres by default). Only docker-build-time env var!

@hughcapet hughcapet Apr 21, 2026

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

what do you mean by "docker-build-time env var"? this variable is also available at runtime.
Or your point is about this env var being not configurable at runtime?

- **PGROOT**: a directory where we put the pgdata (by default PGHOME/pgdata/pgroot). One may adjust it to point to the mount point of the persistent volume, such as EBS. Only docker-build-time env var!
- **PGDATA**: location of PostgreSQL data directory, by default PGROOT/data. Only docker-build-time env var!
- **WALE_TMPDIR** or **WALG_TMPDIR**: directory to store WAL-G temporary files. PGROOT/../tmp by default, make sure it has a few GBs of free space.
- **PGDATA**: location of PostgreSQL data directory, by default PGROOT/pgdata.
- **PGUSER_STANDBY**: username for the replication user, 'standby' by default.
- **PGPASSWORD_STANDBY**: a password for the replication user, 'standby' by default.
- **STANDBY_HOST**: hostname or IP address of the primary to stream from.
Expand Down