bitnami-containers/bitnami/gotrue
Juan José Martos debbf7dffa
[bitnami/*] Modify containers' READMEs title (#87908)
[bitnami/*][TNZ-62332] Modify containers' READMEs title

Signed-off-by: Jota Martos <jota.martos@broadcom.com>
2025-10-27 11:32:47 +01:00
..
2/debian-12
README.md [bitnami/*] Modify containers' READMEs title (#87908) 2025-10-27 11:32:47 +01:00

README.md

Bitnami Secure Image for GoTrue

What is GoTrue?

GoTrue is an API written in Golang that can handle user registration and authentication for Jamstack projects. Based on OAuth2 and JWT, fetures user signup, authentication and custom user data.

Overview of GoTrue Trademarks: This software listing is packaged by Bitnami. The respective trademarks mentioned in the offering are owned by the respective companies, and use of them does not imply any affiliation or endorsement.

TL;DR

docker run -it --name gotrue bitnami/gotrue

⚠️ Important Notice: Upcoming changes to the Bitnami Catalog

Beginning August 28th, 2025, Bitnami will evolve its public catalog to offer a curated set of hardened, security-focused images under the new Bitnami Secure Images initiative. As part of this transition:

  • Granting community users access for the first time to security-optimized versions of popular container images.
  • Bitnami will begin deprecating support for non-hardened, Debian-based software images in its free tier and will gradually remove non-latest tags from the public catalog. As a result, community users will have access to a reduced number of hardened images. These images are published only under the “latest” tag and are intended for development purposes
  • Starting August 28th, over two weeks, all existing container images, including older or versioned tags (e.g., 2.50.0, 10.6), will be migrated from the public catalog (docker.io/bitnami) to the “Bitnami Legacy” repository (docker.io/bitnamilegacy), where they will no longer receive updates.
  • For production workloads and long-term support, users are encouraged to adopt Bitnami Secure Images, which include hardened containers, smaller attack surfaces, CVE transparency (via VEX/KEV), SBOMs, and enterprise support.

These changes aim to improve the security posture of all Bitnami users by promoting best practices for software supply chain integrity and up-to-date deployments. For more details, visit the Bitnami Secure Images announcement.

Why use Bitnami Secure Images?

  • Bitnami Secure Images and Helm charts are built to make open source more secure and enterprise ready.
  • Triage security vulnerabilities faster, with transparency into CVE risks using industry standard Vulnerability Exploitability Exchange (VEX), KEV, and EPSS scores.
  • Our hardened images use a minimal OS (Photon Linux), which reduces the attack surface while maintaining extensibility through the use of an industry standard package format.
  • Stay more secure and compliant with continuously built images updated within hours of upstream patches.
  • Bitnami containers, virtual machines and cloud images use the same components and configuration approach - making it easy to switch between formats based on your project needs.
  • Hardened images come with attestation signatures (Notation), SBOMs, virus scan reports and other metadata produced in an SLSA-3 compliant software factory.

Only a subset of BSI applications are available for free. Looking to access the entire catalog of applications as well as enterprise support? Try the commercial edition of Bitnami Secure Images today.

Learn more about the Bitnami tagging policy and the difference between rolling tags and immutable tags in our documentation page.

You can see the equivalence between the different tags by taking a look at the tags-info.yaml file present in the branch folder, i.e bitnami/ASSET/BRANCH/DISTRO/tags-info.yaml.

Subscribe to project updates by watching the bitnami/containers GitHub repo.

Get this image

The recommended way to get the Bitnami GoTrue Docker Image is to pull the prebuilt image from the Docker Hub Registry.

docker pull bitnami/gotrue:latest

To use a specific version, you can pull a versioned tag. You can view the list of available versions in the Docker Hub Registry.

docker pull bitnami/gotrue:[TAG]

If you wish, you can also build the image yourself by cloning the repository, changing to the directory containing the Dockerfile and executing the docker build command. Remember to replace the APP, VERSION and OPERATING-SYSTEM path placeholders in the example command below with the correct values.

git clone https://github.com/bitnami/containers.git
cd bitnami/APP/VERSION/OPERATING-SYSTEM
docker build -t bitnami/APP:latest .

Maintenance

Upgrade this image

Bitnami provides up-to-date versions of GoTrue, including security patches, soon after they are made upstream. We recommend that you follow these steps to upgrade your container.

Step 1: Get the updated image

docker pull bitnami/gotrue:latest

Step 2: Remove the currently running container

docker rm -v gotrue

Step 3: Run the new image

Re-create your container from the new image.

docker run --name gotrue bitnami/gotrue:latest

Configuration

Environment variables

Customizable environment variables

Name Description Default Value
DB_HOST Database host localhost
DB_PORT Database port number 5432
DB_NAME Database name postgres
DB_USER Database user username postgres
DB_PASSWORD Database password nil
DB_SSL Database SSL connection enabled disable
GOTRUE_DB_DATABASE_URL Database URL postgresql://${DB_USER}:${DB_PASSWORD}@${DB_HOST}:${DB_PORT}/${DB_NAME}?search_path=auth&sslmode=${DB_SSL}
GOTRUE_URI_ALLOW_LIST *
GOTRUE_OPERATOR_TOKEN Operator token nil
GOTRUE_JWT_SECRET JWT Secret nil
GOTRUE_SITE_URL http://localhost:80
GOTRUE_API_PORT 9999
GOTRUE_API_HOST 0.0.0.0
API_EXTERNAL_URL The URL on which Gotrue might be accessed at http://localhost:9999
GOTRUE_DISABLE_SIGNUP false
GOTRUE_DB_DRIVER postgres
GOTRUE_DB_MIGRATIONS_PATH ${GOTRUE_BASE_DIR}
GOTRUE_JWT_DEFAULT_GROUP_NAME authenticated
GOTRUE_JWT_ADMIN_ROLES service_role
GOTRUE_JWT_AUD authenticated
GOTRUE_JWT_EXP 3600
GOTRUE_EXTERNAL_EMAIL_ENABLED true
GOTRUE_MAILER_AUTOCONFIRM true
GOTRUE_SMTP_ADMIN_EMAIL your-mail@example.com
GOTRUE_SMTP_HOST smtp.exmaple.com
GOTRUE_SMTP_PORT 587
GOTRUE_SMTP_SENDER_NAME your-mail@example.com
GOTRUE_EXTERNAL_PHONE_ENABLED false
GOTRUE_SMS_AUTOCONFIRM false
GOTRUE_MAILER_URLPATHS_INVITE http://localhost:80/auth/v1/verify
GOTRUE_MAILER_URLPATHS_CONFIRMATION http://localhost:80/auth/v1/verify
GOTRUE_MAILER_URLPATHS_RECOVERY http://localhost:80/auth/v1/verify
GOTRUE_MAILER_URLPATHS_EMAIL_CHANGE http://localhost:80/auth/v1/verify

Read-only environment variables

Name Description Value
GOTRUE_BASE_DIR gotrue installation directory. ${BITNAMI_ROOT_DIR}/gotrue
GOTRUE_LOGS_DIR Directory where gotrue logs are stored. ${GOTRUE_BASE_DIR}/logs
GOTRUE_LOG_FILE Directory where gotrue logs are stored. ${GOTRUE_LOGS_DIR}/gotrue.log
GOTRUE_BIN_DIR gotrue directory for binary executables. ${GOTRUE_BASE_DIR}/bin
GOTRUE_DAEMON_USER postgrest system user. supabase
GOTRUE_DAEMON_GROUP postgrest system group. supabase

Running commands

To run commands inside this container you can use docker run, for example to execute gotrue --help you can follow the example below:

docker run --rm --name gotrue bitnami/gotrue:latest --help

Check the official GoTrue documentation for more information about how to use GoTrue.

FIPS configuration in Bitnami Secure Images

The Bitnami GoTrue Docker image from the Bitnami Secure Images catalog includes extra features and settings to configure the container with FIPS capabilities. You can configure the next environment variables:

  • OPENSSL_FIPS: whether OpenSSL runs in FIPS mode or not. yes (default), no.

Notable Changes

Starting January 16, 2024

  • The docker-compose.yaml file has been removed, as it was solely intended for internal testing purposes.

Contributing

We'd love for you to contribute to this Docker image. You can request new features by creating an issue or submitting a pull request with your contribution.

Issues

If you encountered a problem running this container, you can file an issue. For us to provide better support, be sure to fill the issue template.

License

Copyright © 2025 Broadcom. The term "Broadcom" refers to Broadcom Inc. and/or its subsidiaries.

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.