Skip to content

docs: Add quick start, comparison and Docker Hub sync - #18

Merged
ruxwez merged 1 commit into
mainfrom
docs/promote-image
Oct 25, 2026
Merged

ruxwez merged 1 commit into
mainfrom
docs/promote-image

Conversation

@ruxwez

@ruxwez ruxwez commented Oct 25, 2026

Copy link
Copy Markdown
Owner

Summary

Gets the repo and the Docker Hub page ready to share the image with other people.

README (EN/ES)

  • Badges: CI, Docker pulls, latest release, license.
  • A short pitch: the official image plus pgvector, PostGIS and pgmq, with immutable tags and amd64 + arm64.
  • Quick start with docker run and Docker Compose. The volume path shown is the PG 18 one, with a note for 17 and older.
  • An example that uses all three extensions together.
  • A comparison with the single-extension images. It only lists facts checked on their PG 18 tags; for example, postgis/postgis:18-3.6 is amd64-only.
  • Snippets for a GitHub Actions service container and Testcontainers (Java, Python).

Docker Hub sync. The new dockerhub-description.yml workflow pushes README.md and a short description to the Docker Hub page whenever the README changes on main. Relative links are turned into absolute GitHub URLs. Today the Docker Hub page still shows an old description that doesn't mention pgmq.

Testing

  • The Compose file and the example SQL were run against the published ruxwez/postgres:18-v1. The query returns "Café Central", and the pgmq send/read works.
  • The data directory is /var/lib/postgresql/18/docker, which confirms the volume path.
  • actionlint passes.
  • Docker Hub limits are met: the short description is 80/100 characters and the README is 6.3/25 KB.

Not tested here:

  • The Testcontainers snippets weren't run.
  • The sync workflow only runs after merge. If it fails with an authorization error, the DOCKER_PERSONAL_KEY token needs the Read, Write, Delete scope.

🤖 Generated with Claude Code

https://claude.ai/code/session_01QTN7At86i5TYDmozENSNv8

- README: badges, a short pitch, docker run / Compose quick start, an
  example using pgvector, PostGIS and pgmq together, a comparison with
  the single-extension images, and snippets for GitHub Actions and
  Testcontainers.
- New workflow keeps the Docker Hub description in sync with README.md.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01QTN7At86i5TYDmozENSNv8
@ruxwez
ruxwez merged commit e308570 into main Oct 25, 2026
14 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant