docs(readme): sync Docker examples with actual Dockerfile and docker-compose.yml (#8) - #78
Open
ghzhost wants to merge 2 commits into
Open
docs(readme): sync Docker examples with actual Dockerfile and docker-compose.yml (#8)#78ghzhost wants to merge 2 commits into
ghzhost wants to merge 2 commits into
Conversation
added 2 commits
September 3, 2026 03:35
) - Add pg_isready-based healthcheck for the db (postgres:16-alpine) service so depends_on waits until Postgres is ready to accept connections, not just until the container has started. - Add curl /health-based healthcheck for the api service using the existing GET /health liveness probe. - Upgrade depends_on: [db] to depends_on: db: condition: service_healthy so the API container only starts after the DB is proven healthy. - Add curl to the Dockerfile runtime stage so the healthcheck command is available in the final image. Fixes StellarSend#10
…compose.yml (StellarSend#8) The README's Docker section showed a Dockerfile and docker-compose.yml that diverged from the actual root files in several ways. Reconcile them: Dockerfile snippet: - Update base image from rust:1.75-slim-bookworm to rust:slim-bookworm - Remove extraneous WORKDIR /app and COPY migrations in the runtime stage - Install curl in runtime stage (needed for the healthcheck probe) - Copy binary to /usr/local/bin/stellarsend (matches actual Dockerfile) - Fix CMD to use bare binary name: CMD ["stellarsend"] - Fix EXPOSE from 8080 to 3000 docker-compose.yml snippet: - Remove obsolete version: "3.9" (deprecated in Compose v2) - Switch from inline environment: block to env_file: - .env (matches real file) - Add healthcheck blocks for db (pg_isready) and api (curl /health), consistent with what StellarSend#10 introduced to the actual docker-compose.yml - Use depends_on: db: condition: service_healthy All curl examples and port references throughout the README: - Replace localhost:8080 with localhost:3000 - Replace PORT default 8080 with 3000 - Update 'server binds to 0.0.0.0:8080' prose to 3000 Fixes StellarSend#8
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Fixes #8 — the README's Docker section showed a
Dockerfilesnippet anddocker-compose.ymlthat diverged from the actual root files.Changes
Dockerfile snippet in README:
rust:1.75-slim-bookworm→rust:slim-bookwormWORKDIR /appandCOPY migrationsfrom the runtime stagecurlto runtime dependencies (needed for the/healthhealthcheck)/usr/local/bin/stellarsend(matches actualDockerfile)CMDto bare binary name:CMD ["stellarsend"]EXPOSEfrom8080→3000docker-compose.ymlsnippet in README:version: "3.9"(deprecated in Compose v2)environment:block toenv_file: - .env(matches real file)healthcheck:blocks fordb(pg_isready) andapi(curl /health), consistent with the fix introduced in docker-compose.yml has no healthchecks for api or db services #10depends_on: db: condition: service_healthyAll curl examples and prose throughout the README:
localhost:8080→localhost:3000PORTdefault from8080→3000http://0.0.0.0:8080" prose to3000Closes #8