From 5b3e496bb29019c1b4e381dd19cd6d21c8147216 Mon Sep 17 00:00:00 2001 From: Roman Vanicek Date: Tue, 9 Apr 2024 02:02:57 +0200 Subject: [PATCH] Fix doc regarding pg_hba.conf --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index bd0da27..2fdd465 100644 --- a/README.md +++ b/README.md @@ -2,7 +2,7 @@ Postgres image with PostGIS and pg_auto_failover extensions that allows running # How to use this image -The expected configuration is at least two `worker` nodes with one `monitor` node. The container is expected to have one or more peer configuration containers that implement query load balancing (activated using `AUTOCONFIG_LOCAL_PEER` and/or `AUTOCONFIG_REMOTE_PEERS`). One of such implementations is [docker-pgpool](/docker-pgpool) that implements read-only/read-write splitting and load balancing using `pgpool`. Another is [docker-pgtraefik](/docker-pgtraefik) that load balances all traffic to the primary node. +The expected configuration is at least two `worker` nodes with one `monitor` node. The container is expected to have one or more peer configuration containers that implement query load balancing (activated using `AUTOCONFIG_LOCAL_PEER` and/or `AUTOCONFIG_REMOTE_PEERS`). One of such implementations is [docker-pgpool](docker-pgpool) that implements read-only/read-write splitting and load balancing using `pgpool`. Another is [docker-pgtraefik](docker-pgtraefik) that load balances all traffic to the primary node. The configuration peers act as servers and this image connects to them. They can run either locally communicating over a socket or remotely over HTTP. @@ -32,7 +32,7 @@ The configuration peers act as servers and this image connects to them. They can - `POSTGRES_PASSWORD` or `POSTGRES_PASSWORD_FILE` password (resp. path to file with the password) that is set for the user Postgres admin user - `AUTOCONFIG_LINK_HBA_CONF` path to `pg_hba.conf` file that shall be linked to after the Postgres storage gets initialized (Postgres refuses to initialize non-empty directory with `pg_hba.conf` volume-binded from docker host). Default none. Optional. -This image does not deploy nor touch the Postgres file `pg_hba.conf`. You are expected to deploy it by whatever tools you have for it into some directory outside of `PGDATA`. However following rules are required for `pg_auto_failure` to work on monitor: +This image does optionally deploy but does not modify the Postgres file `pg_hba.conf` using `AUTOCONFIG_LINK_HBA_CONF`. If you do not provide one then `pg_auto_failover` modifies the one you already have. However following rules are required for `pg_auto_failure` to work on monitor: - `local all all` - `host pg_auto_failover autoctl_node scram-sha-256` (for each worker)