openso/postgres
Watch
1
0
Fork
You've already forked postgres
 0
Code Issues Pull requests Packages 1 Activity Actions

docs: expand README with usage, environment, and startup details #2

Merged
MHE merged 1 commit from docs-expand-readme-usage-compose-example into main 2026-11-01 13:27:17 +01:00
Conversation 0 Commits 1 Files changed 1 +86 -29
MHE commented 2026-11-01 13:26:14 +01:00
Owner
Copy link

What changed

Rewrites README.md to document how to use the image end to end.

  • Adds a Use section with a Compose example: wrapper command, POSTGRES_PASSWORD_FILE Docker secret, vector/pg_stat_statements switches, healthcheck, and a \dx verification step.
  • Adds an Environment table describing each boolean switch (empty/unset vs true), including POSTGRES_SHARED_PRELOAD_LIBRARIES and POSTGRES_AUTO_UPDATE_EXTENSIONS.
  • Clarifies the startup sequence and notes how enabling a switch on an existing database takes effect on the next start.
  • Adds a statement that this repository is the single image for all apps and majors; new majors change the FROM pin here.
  • Moves Build and Contents to the end and drops the duplicated environment and version-bump text.

Why

The previous README mixed build, contents, and runtime details and did not show how a deployment should start the container or supply the password. This makes the image usable from the README alone and keeps secrets out of the Compose file.

No code or image behavior changes; documentation only.

## What changed Rewrites `README.md` to document how to use the image end to end. - Adds a **Use** section with a Compose example: wrapper command, `POSTGRES_PASSWORD_FILE` Docker secret, `vector`/`pg_stat_statements` switches, healthcheck, and a `\dx` verification step. - Adds an **Environment** table describing each boolean switch (empty/unset vs `true`), including `POSTGRES_SHARED_PRELOAD_LIBRARIES` and `POSTGRES_AUTO_UPDATE_EXTENSIONS`. - Clarifies the startup sequence and notes how enabling a switch on an existing database takes effect on the next start. - Adds a statement that this repository is the single image for all apps and majors; new majors change the `FROM` pin here. - Moves **Build** and **Contents** to the end and drops the duplicated environment and version-bump text. ## Why The previous README mixed build, contents, and runtime details and did not show how a deployment should start the container or supply the password. This makes the image usable from the README alone and keeps secrets out of the Compose file. No code or image behavior changes; documentation only.
Expand README with usage, environment, and startup docs
All checks were successful
ci / compose (pull_request) Successful in 13s
Details
ci / shellcheck (pull_request) Successful in 2s
Details
ci / conventions (pull_request) Successful in 2s
Details
ci / image (pull_request) Successful in 38s
Details
dfd87ae949
MHE merged commit 8a7f0a6991 into main 2026-11-01 13:27:17 +01:00
MHE deleted branch docs-expand-readme-usage-compose-example 2026-11-01 13:27:22 +01:00
Sign in to join this conversation.
Reviewers
No reviewers
Labels
Clear labels
No items
No labels
Milestone
Clear milestone
No items
No milestone
Assignees
Clear assignees
No assignees
1 participant
Notifications
Due date
The due date is invalid or out of range. Please use the format "yyyy-mm-dd".

No due date set.

Dependencies

No dependencies set

Reference
openso/postgres!2
No description provided.