docker-library / docker-library/docs

Request: adding Docker health check to `postgres/README.md`

Open
#2,391 6 comments 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Shell
Stars
5.3k
Forks
2.2k
Avg merge
1d 18h
Merged PRs (30d)
11

Description

It would be good to add a healthcheck to the postgres/README.md.

There are some possible starting points posed here: https://stackoverflow.com/questions/65115627/safe-ways-to-specify-postgres-parameters-for-healthchecks-in-docker-compose


Aside: running the below:

---
version: "3.8"
services:
    postgres:
        image: postgres:latest
        environment:
            POSTGRES_USER: user
            POSTGRES_PASSWORD: pass
            POSTGRES_DB: db
docker compose up postgres --detach 
docker compose run postgres pg_isready --username user --dbname db

I can never get pg_isready to output something besides /var/run/postgresql:5432 - no response

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Read postgres/README.md and the Docker Compose healthcheck documentation, using the pg_isready example in the issue as the entry point. Done means the README documents a working PostgreSQL healthcheck and clarifies the shown pg_isready invocation’s behavior.

Written by the indexing model from the issue text.

Assessment

Tech stack
docker, postgresql
Domain
databases, documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.