From c706a9e8a1743bba6f45f21c23d0ca786a326bd9 Mon Sep 17 00:00:00 2001 From: SnapOtter Date: Tue, 21 Jul 2026 18:35:24 +0800 Subject: [PATCH] docs(deploy): pin pg_isready to POSTGRES_DB and flag the default password (#606) Add -d snapotter to the guide's Compose healthcheck examples so they match the shipped compose fix (#595), and note "change this" next to the default POSTGRES_PASSWORD. English guide only; locale docs regenerate through the i18n pipeline. Refs #592 --- apps/docs/guide/configuration.md | 4 ++-- apps/docs/guide/deployment.md | 6 +++--- apps/docs/guide/docker-tags.md | 4 ++-- apps/docs/guide/getting-started.md | 4 ++-- apps/docs/guide/low-resource.md | 2 +- apps/docs/guide/security.md | 4 ++-- 6 files changed, 12 insertions(+), 12 deletions(-) diff --git a/apps/docs/guide/configuration.md b/apps/docs/guide/configuration.md index 04fc4de7..d8dd674f 100644 --- a/apps/docs/guide/configuration.md +++ b/apps/docs/guide/configuration.md @@ -121,13 +121,13 @@ services: image: postgres:17-alpine environment: POSTGRES_USER: snapotter - POSTGRES_PASSWORD: snapotter + POSTGRES_PASSWORD: snapotter # Change this for non-local deployments POSTGRES_DB: snapotter volumes: - SnapOtter-pgdata:/var/lib/postgresql/data restart: unless-stopped healthcheck: - test: ["CMD-SHELL", "pg_isready -U snapotter"] + test: ["CMD-SHELL", "pg_isready -U snapotter -d snapotter"] interval: 10s timeout: 5s retries: 12 diff --git a/apps/docs/guide/deployment.md b/apps/docs/guide/deployment.md index a8481e22..7d85bd87 100644 --- a/apps/docs/guide/deployment.md +++ b/apps/docs/guide/deployment.md @@ -73,7 +73,7 @@ services: - SnapOtter-pgdata:/var/lib/postgresql/data restart: unless-stopped healthcheck: - test: ["CMD-SHELL", "pg_isready -U snapotter"] + test: ["CMD-SHELL", "pg_isready -U snapotter -d snapotter"] interval: 10s timeout: 5s retries: 12 @@ -161,13 +161,13 @@ services: container_name: SnapOtter-postgres environment: POSTGRES_USER: snapotter - POSTGRES_PASSWORD: snapotter + POSTGRES_PASSWORD: snapotter # Change this for non-local deployments POSTGRES_DB: snapotter volumes: - SnapOtter-pgdata:/var/lib/postgresql/data restart: unless-stopped healthcheck: - test: ["CMD-SHELL", "pg_isready -U snapotter"] + test: ["CMD-SHELL", "pg_isready -U snapotter -d snapotter"] interval: 10s timeout: 5s retries: 12 diff --git a/apps/docs/guide/docker-tags.md b/apps/docs/guide/docker-tags.md index eee008ce..85eeae57 100644 --- a/apps/docs/guide/docker-tags.md +++ b/apps/docs/guide/docker-tags.md @@ -90,13 +90,13 @@ services: image: postgres:17-alpine environment: POSTGRES_USER: snapotter - POSTGRES_PASSWORD: snapotter + POSTGRES_PASSWORD: snapotter # Change this for non-local deployments POSTGRES_DB: snapotter volumes: - SnapOtter-pgdata:/var/lib/postgresql/data restart: unless-stopped healthcheck: - test: ["CMD-SHELL", "pg_isready -U snapotter"] + test: ["CMD-SHELL", "pg_isready -U snapotter -d snapotter"] interval: 10s timeout: 5s retries: 12 diff --git a/apps/docs/guide/getting-started.md b/apps/docs/guide/getting-started.md index 216b7501..ceea3197 100644 --- a/apps/docs/guide/getting-started.md +++ b/apps/docs/guide/getting-started.md @@ -75,13 +75,13 @@ services: image: postgres:17-alpine environment: POSTGRES_USER: snapotter - POSTGRES_PASSWORD: snapotter + POSTGRES_PASSWORD: snapotter # Change this for non-local deployments POSTGRES_DB: snapotter volumes: - SnapOtter-pgdata:/var/lib/postgresql/data restart: unless-stopped healthcheck: - test: ["CMD-SHELL", "pg_isready -U snapotter"] + test: ["CMD-SHELL", "pg_isready -U snapotter -d snapotter"] interval: 10s timeout: 5s retries: 12 diff --git a/apps/docs/guide/low-resource.md b/apps/docs/guide/low-resource.md index 7a1eb84a..56355e12 100644 --- a/apps/docs/guide/low-resource.md +++ b/apps/docs/guide/low-resource.md @@ -54,7 +54,7 @@ services: image: postgres:17-alpine environment: - POSTGRES_USER=snapotter - - POSTGRES_PASSWORD=snapotter + - POSTGRES_PASSWORD=snapotter # Change this for non-local deployments - POSTGRES_DB=snapotter volumes: - ./postgres-data:/var/lib/postgresql/data diff --git a/apps/docs/guide/security.md b/apps/docs/guide/security.md index 6d2cee97..be668c02 100644 --- a/apps/docs/guide/security.md +++ b/apps/docs/guide/security.md @@ -72,13 +72,13 @@ services: image: postgres:17-alpine environment: POSTGRES_USER: snapotter - POSTGRES_PASSWORD: snapotter + POSTGRES_PASSWORD: snapotter # Change this for non-local deployments POSTGRES_DB: snapotter volumes: - SnapOtter-pgdata:/var/lib/postgresql/data restart: unless-stopped healthcheck: - test: ["CMD-SHELL", "pg_isready -U snapotter"] + test: ["CMD-SHELL", "pg_isready -U snapotter -d snapotter"] interval: 10s timeout: 5s retries: 12