gotrue

packaged by Chainguard

Chainguard Container for gotrue

Chainguard image for GoTrue, a JWT-based authentication server by Supabase for managing users and issuing access tokens.

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/gotrue:latest

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

Compatibility Notes

Chainguard's GoTrue image is designed to be a drop-in replacement for the upstream supabase/gotrue image. Like most other Chainguard container images, the production variant includes only the minimum dependencies needed to function and does not include things like a shell or package manager.

The entrypoint is set to /usr/bin/gotrue. The gotrue binary supports subcommands such as serve (default behavior) and migrate for running database migrations.

Getting Started

GoTrue requires a PostgreSQL database to function. The following example demonstrates running GoTrue with a PostgreSQL container using Docker.

First, create a Docker network for the containers to communicate:

docker network create gotrue-net

Start a PostgreSQL container:

docker run -d --name gotrue-db --network gotrue-net \
  -e POSTGRES_DB=gotrue \
  -e POSTGRES_USER=gotrue \
  -e POSTGRES_PASSWORD=secret \
  cgr.dev/ORGANIZATION/postgres:latest

Run database migrations:

docker run --rm --network gotrue-net \
  -e GOTRUE_DB_DATABASE_URL="postgres://gotrue:secret@gotrue-db:5432/gotrue?sslmode=disable" \
  -e GOTRUE_DB_DRIVER=postgres \
  cgr.dev/ORGANIZATION/gotrue:latest migrate

Start the GoTrue server:

docker run -d --name gotrue --network gotrue-net \
  -e GOTRUE_DB_DATABASE_URL="postgres://gotrue:secret@gotrue-db:5432/gotrue?sslmode=disable" \
  -e GOTRUE_DB_DRIVER=postgres \
  -e GOTRUE_JWT_SECRET=super-secret-jwt-token-with-at-least-32-characters-long \
  -e GOTRUE_SITE_URL=http://localhost:3000 \
  -e API_EXTERNAL_URL=http://localhost:9999 \
  -e GOTRUE_API_HOST=0.0.0.0 \
  -e GOTRUE_API_PORT=9999 \
  -p 9999:9999 \
  cgr.dev/ORGANIZATION/gotrue:latest

Verify the server is running by checking the health endpoint:

curl http://localhost:9999/health

You should receive a JSON response indicating the server is healthy:

{
  "version": "",
  "name": "",
  "description": ""
}

Documentation and Resources

• Supabase Auth GitHub Repository
• Supabase Auth API Reference
• GoTrue Contributing Guide

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.