supabase-postgres-meta

packaged by Chainguard

Chainguard Container for supabase-postgres-meta

A RESTful API for managing your Postgres. Fetch tables, add roles, and run queries

Chainguard Containers are regularly-updated, secure-by-default container images.

Download this Container Image

For those with access, this container image is available on cgr.dev:

docker pull cgr.dev/ORGANIZATION/supabase-postgres-meta:latest

Be sure to replace the ORGANIZATION placeholder with the name used for your organization's private repository within the Chainguard Registry.

Compatibility Notes

postgres-meta is a RESTful API for a PostgreSQL database. It lets you inspect schemas, tables, and columns, create and drop tables and columns, and run SQL queries over HTTP. It is built with TypeScript on Node.js and licensed under the Apache License 2.0. Refer to the upstream README for the complete API.

Chainguard's supabase-postgres-meta image is comparable to the upstream supabase/postgres-meta image on Docker Hub, with these differences:

• The image runs as the nonroot user (UID 65532) by default. The upstream image runs as root.
• The application lives under /usr/share/postgres-meta. /usr/src/app links to it so the upstream working directory and command still work.

The image keeps the upstream entrypoint (docker-entrypoint.sh), command (node dist/server/server.js), and PG_META_PORT=8080 default.

Security: postgres-meta has no built-in authentication. Any client that can reach its port can read database metadata and run SQL as the database user in its connection string. Only expose it inside a trusted network, or put an authenticating proxy in front of it.

Prerequisites

To follow the examples in this guide, you need:

• Access to the Chainguard Registry for cgr.dev/ORGANIZATION/supabase-postgres-meta. Refer to Authenticating with the Chainguard Registry.
• For the Docker example: Docker and curl.
• For the Helm example: a Kubernetes cluster, kubectl, and Helm.
• A PostgreSQL database that postgres-meta can reach. The Docker example starts one with the Chainguard postgres image.

Getting Started

First, start a PostgreSQL container on a shared network:

docker network create pgmeta-net

docker run -d --name pg --network pgmeta-net \
  -e POSTGRES_PASSWORD=postgres \
  -e POSTGRES_DB=postgres \
  cgr.dev/ORGANIZATION/postgres:latest

Next, run postgres-meta and point it at the database. The 127.0.0.1 prefix publishes port 8080 on the loopback interface only, so other hosts cannot reach the unauthenticated API:

docker run -d --name pgmeta --network pgmeta-net -p 127.0.0.1:8080:8080 \
  -e PG_META_DB_URL="postgresql://postgres:postgres@pg:5432/postgres" \
  cgr.dev/ORGANIZATION/supabase-postgres-meta:latest

Check that the server is healthy:

curl -fsS http://localhost:8080/health

List the schemas in the database:

curl -fsS http://localhost:8080/schemas

List the tables in the public schema:

curl -fsS "http://localhost:8080/tables?included_schemas=public"

Run a SQL query:

curl -fsS -X POST http://localhost:8080/query \
  -H 'Content-Type: application/json' \
  -d '{"query":"select 1 as answer;"}'

When you are done, remove the containers and network:

docker rm -f pgmeta pg
docker network rm pgmeta-net

Deploying with Helm

postgres-meta is usually deployed as one component of the full Supabase stack. The community Supabase Helm chart deploys it alongside the other Supabase services, and its image.meta values select the postgres-meta image.

Add the chart repository:

helm repo add supabase https://supabase-community.github.io/supabase-kubernetes
helm repo update

Create a values file that points the postgres-meta component at the Chainguard image:

cat > values.yaml <<EOF
image:
  meta:
    repository: cgr.dev/ORGANIZATION/supabase-postgres-meta
    tag: latest
EOF

Install the chart with the values file:

helm install supabase supabase/supabase \
  --namespace supabase --create-namespace \
  --values values.yaml

This example replaces only the postgres-meta image. The chart's other components, such as the database, auth, REST, realtime, and storage services, keep their upstream images. In particular, the chart's database uses Supabase's extended PostgreSQL image, which ships extensions and initialization scripts the other services depend on, so don't swap it for a plain PostgreSQL image. Chainguard has not validated replacements for those companion images with this chart.

If you pull from a private Chainguard registry, create an image pull secret in the namespace and reference it with image.meta.pullSecrets in values.yaml. Refer to the chart's values.yaml for the database connection and other settings.

Configuration

You configure postgres-meta with environment variables. For example, to serve the API to other containers on the same network while connecting to a database that requires TLS, set:

• PG_META_DB_URL: The PostgreSQL connection string, such as postgresql://user:password@db:5432/postgres?sslmode=require. postgres-meta uses this connection for every request that does not supply its own, so give it a database user with only the privileges your clients need.
• PG_META_HOST: The address the HTTP server binds to. Keep the default to listen on all container interfaces, and control exposure with the container's port mapping or a Kubernetes Service.
• PG_META_PORT: The port the HTTP server listens on. The image sets it to 8080, matching upstream; change it only if that port conflicts with another service.

The image exposes port 8080/tcp. Refer to the upstream README for the full list of settings.

Documentation and Resources

• postgres-meta GitHub repository
• Supabase documentation

What are Chainguard Containers?

Chainguard's free tier of Starter container images are built with Wolfi, our minimal Linux undistro.

All other Chainguard Containers are built with Chainguard OS, Chainguard's minimal Linux operating system designed to produce container images that meet the requirements of a more secure software supply chain.

The main features of Chainguard Containers include:

• Minimal design, without unnecessary software bloat
• Daily builds to ensure container images are up-to-date with available security patches
• High quality build-time SBOMs attesting to the provenance of all artifacts within the image
• Verifiable signatures provided by Sigstore
• Reproducible builds with Cosign and apko (read more about reproducibility)

For cases where you need container images with shells and package managers to build or debug, most Chainguard Containers come paired with a development, or -dev, variant.

In all other cases, including Chainguard Containers tagged as :latest or with a specific version number, the container images include only an open-source application and its runtime dependencies. These minimal container images typically do not contain a shell or package manager.

Although the -dev container image variants have similar security features as their more minimal versions, they include additional software that is typically not necessary in production environments. We recommend using multi-stage builds to copy artifacts from the -dev variant into a more minimal production image.

Need additional packages?

To improve security, Chainguard Containers include only essential dependencies. Need more packages? Chainguard customers can use Custom Assembly to add packages, either through the Console, chainctl, or API.

To use Custom Assembly in the Chainguard Console: navigate to the image you'd like to customize in your Organization's list of images, and click on the Customize image button at the top of the page.

Learn More

Refer to our Chainguard Containers documentation on Chainguard Academy. Chainguard also offers VMs and Libraries — contact us for access.

Trademarks

This software listing is packaged by Chainguard. The trademarks set forth in this offering are owned by their respective companies, and use of them does not imply any affiliation, sponsorship, or endorsement by such companies.