DB config, including port, through libpq env vars (#1647)

Use libpq PG* environment variables for DB configuration handling and provide backward compatibility for legacy DB_* environment variables

Author: brontolosone

.env.template

@@ -15,10 +15,12 @@ HTTPS_PORT=443
 # SERVICE_NODE_OPTIONS=
 
 # Optional: connect to a custom database server
-# DB_HOST=
-# DB_USER=
-# DB_PASSWORD=
-# DB_NAME=
+# PGHOST=
+# PGUSER=
+# PGPASSWORD=
+# PGDATABASE=
+# Refer to the installation documentation (https://docs.getodk.org/central-install/)
+# to learn about advanced database configuration.
 
 # Optional: configure a custom mail server
 # EMAIL_FROM=

docker-compose.yml

@@ -47,17 +47,13 @@ services:
     volumes:
       - secrets:/etc/secrets
       - /data/transfer:/data/transfer
+    env_file: .env
     environment:
       - DOMAIN=${DOMAIN}
       - SYSADMIN_EMAIL=${SYSADMIN_EMAIL}
       - HTTPS_PORT=${HTTPS_PORT:-443}
       - NODE_OPTIONS=${SERVICE_NODE_OPTIONS:-}
-      - DB_HOST=${DB_HOST:-postgres14}
-      - DB_USER=${DB_USER:-odk}
-      - DB_PASSWORD=${DB_PASSWORD:-odk}
       - DB_POOL_SIZE=${DB_POOL_SIZE:-10}
-      - DB_NAME=${DB_NAME:-odk}
-      - DB_SSL=${DB_SSL:-null}
       - EMAIL_FROM=${EMAIL_FROM:-no-reply@$DOMAIN}
       - EMAIL_HOST=${EMAIL_HOST:-mail}
       - EMAIL_PORT=${EMAIL_PORT:-25}
@@ -79,7 +75,7 @@ services:
       - S3_SECRET_KEY=${S3_SECRET_KEY:-}
       - S3_BUCKET_NAME=${S3_BUCKET_NAME:-}
       - SESSION_LIFETIME=${SESSION_LIFETIME:-86400}
-    command: [ "wait-for-it", "${DB_HOST:-postgres14}:5432", "--", "./start-odk.sh" ]
+    command: [ "./start-odk.sh" ]
     restart: always
     logging:
       driver: local

files/service/config.json.template

@@ -1,11 +1,10 @@
 {
   "default": {
     "database": {
-      "host": "${DB_HOST}",
-      "user": "${DB_USER}",
-      "password": "${DB_PASSWORD}",
-      "database": "${DB_NAME}",
-      "ssl": ${DB_SSL},
+      "host": "",
+      "user": "",
+      "password": "",
+      "database": "",
       "maximumPoolSize": ${DB_POOL_SIZE}
     },
     "email": {

files/service/scripts/start-odk.sh

@@ -17,6 +17,27 @@ SENTRY_TAGS="{ \"version.central\": \"$(cat sentry-versions/central)\", \"versio
 # shellcheck disable=SC2090
 export SENTRY_TAGS
 
+# handle legacy DB_SSL configuration, as we couldn't conditionally template that in docker-compose.yml
+if [[ -v DB_SSL && "${DB_SSL}" = "true" ]]; then
+  if [[ -v PGSSLMODE && -v PGREQUIRESSL ]]; then
+    export PGSSLMODE="require"
+  else
+    echo "Fatal: legacy 'DB_SSL=true' specified, but PGSSLMODE or PGREQUIRESSL has already been set. To resolve ambiguity, remove 'DB_SSL=true' from your .env file." > /dev/stderr
+    exit 100
+  fi
+fi
+
+# handle other legacy DB_* configuration, and fill in our defaults if nothing is specified
+# When these PG* variables are _defined_ (even if _empty_), they will be left as-is.
+[[ -v PGHOST ]] || export PGHOST=${DB_HOST:-postgres14}
+[[ -v PGUSER ]] || export PGUSER=${DB_USER:-odk}
+[[ -v PGPASSWORD ]] || export PGPASSWORD=${DB_PASSWORD:-odk}
+[[ -v PGDATABASE ]] || export PGDATABASE=${DB_NAME:-odk}
+[[ -v PGAPPNAME ]] || export PGAPPNAME=odkcentral
+
+echo "waiting for PostgreSQL to become connectable to..."
+while ! (psql --no-password --quiet --command "" > /dev/null 2>&1 || (echo "sleeping 1 second waiting for a database connection"; false)); do sleep 1; done
+
 echo "running migrations.."
 node ./lib/bin/run-migrations
 

server

@@ -48,7 +48,6 @@ RUN apt-get update \
     && apt-get install -y --no-install-recommends \
         gpg \
         cron \
-        wait-for-it \
         procps \
         postgresql-client-14 \
         netcat-traditional \