diff --git a/doc/configuration-file-optional-settings.xml b/doc/configuration-file-optional-settings.xml index 67d7aed9..66f575ff 100644 --- a/doc/configuration-file-optional-settings.xml +++ b/doc/configuration-file-optional-settings.xml @@ -140,6 +140,43 @@ ssh_options='-q -o ConnectTimeout=10' + + pg_bindir (string) + + pg_bindir configuration file parameter + + + + + Path to the PostgreSQL binary directory (location of pg_ctl, + pg_basebackup etc.). Only required + if these are not in the system PATH. + + + + When &repmgr; is executed via SSH (e.g. when running + repmgr standby switchover, + repmgr cluster matrix or + repmgr cluster crosscheck, + or if it is executed as cronjob), a login shell will not be used and only the + default system PATH will be set. Therefore it's recommended to set + pg_bindir so &repmgr; can correctly invoke binaries on a remote + system and avoid potential path issues. + + + + + Debian/Ubuntu users: you will probably need to set this to the directory where + pg_ctl is located, e.g. /usr/lib/postgresql/9.6/bin/. + + + NOTE: pg_bindir is only used when &repmgr; directly + executes PostgreSQL binaries; any user-defined scripts + must be specified with the full path. + + + +