bitnami/gotrue

Verified Publisher

By VMware

Updated 4 days ago

Bitnami container image for GoTrue

Image
API Management
Security
1

50K+

Bitnami package 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

Why use Bitnami Images?

  • Bitnami closely tracks upstream source changes and promptly publishes new versions of this image using our automated systems.
  • With Bitnami images the latest bug fixes and features are available as soon as possible.
  • 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.
  • All our images are based on minideb -a minimalist Debian based container image that gives you a small base container image and the familiarity of a leading Linux distribution- or scratch -an explicitly empty image-.
  • All Bitnami images available in Docker Hub are signed with Notation. Check this post to know how to verify the integrity of the images.
  • Bitnami container images are released on a regular basis with the latest distribution packages available.

Looking to use GoTrue in production? Try VMware Tanzu Application Catalog, the commercial edition of the Bitnami catalog.

Only latest stable branch maintained in the free Bitnami catalog

Starting December 10th 2024, only the latest stable branch of any container will receive updates in the free Bitnami catalog. To access up-to-date releases for all upstream-supported branches, consider upgrading to Bitnami Premium. Previous versions already released will not be deleted. They are still available to pull from DockerHub.

Please check the Bitnami Premium page in our partner Arrow Electronics for more information.

Supported tags and respective Dockerfile links

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

NameDescriptionDefault Value
DB_HOSTDatabase hostlocalhost
DB_PORTDatabase port number5432
DB_NAMEDatabase namepostgres
DB_USERDatabase user usernamepostgres
DB_PASSWORDDatabase passwordnil
DB_SSLDatabase SSL connection enableddisable
GOTRUE_DB_DATABASE_URLDatabase URLpostgresql://${DB_USER}:${DB_PASSWORD}@${DB_HOST}:${DB_PORT}/${DB_NAME}?search_path=auth&sslmode=${DB_SSL}
GOTRUE_URI_ALLOW_LIST*
GOTRUE_OPERATOR_TOKENOperator tokennil
GOTRUE_JWT_SECRETJWT Secretnil
GOTRUE_SITE_URLhttp://localhost:80
GOTRUE_API_PORT9999
GOTRUE_API_HOST0.0.0.0
API_EXTERNAL_URLThe URL on which Gotrue might be accessed athttp://localhost:9999
GOTRUE_DISABLE_SIGNUPfalse
GOTRUE_DB_DRIVERpostgres
GOTRUE_DB_MIGRATIONS_PATH${GOTRUE_BASE_DIR}
GOTRUE_JWT_DEFAULT_GROUP_NAMEauthenticated
GOTRUE_JWT_ADMIN_ROLESservice_role
GOTRUE_JWT_AUDauthenticated
GOTRUE_JWT_EXP3600
GOTRUE_EXTERNAL_EMAIL_ENABLEDtrue
GOTRUE_MAILER_AUTOCONFIRMtrue
GOTRUE_SMTP_ADMIN_EMAILyour-mail@example.com
GOTRUE_SMTP_HOSTsmtp.exmaple.com
GOTRUE_SMTP_PORT587
GOTRUE_SMTP_SENDER_NAMEyour-mail@example.com
GOTRUE_EXTERNAL_PHONE_ENABLEDfalse
GOTRUE_SMS_AUTOCONFIRMfalse
GOTRUE_MAILER_URLPATHS_INVITEhttp://localhost:80/auth/v1/verify
GOTRUE_MAILER_URLPATHS_CONFIRMATIONhttp://localhost:80/auth/v1/verify
GOTRUE_MAILER_URLPATHS_RECOVERYhttp://localhost:80/auth/v1/verify
GOTRUE_MAILER_URLPATHS_EMAIL_CHANGEhttp://localhost:80/auth/v1/verify

Read-only environment variables

NameDescriptionValue
GOTRUE_BASE_DIRgotrue installation directory.${BITNAMI_ROOT_DIR}/gotrue
GOTRUE_LOGS_DIRDirectory where gotrue logs are stored.${GOTRUE_BASE_DIR}/logs
GOTRUE_LOG_FILEDirectory where gotrue logs are stored.${GOTRUE_LOGS_DIR}/gotrue.log
GOTRUE_BIN_DIRgotrue directory for binary executables.${GOTRUE_BASE_DIR}/bin
GOTRUE_DAEMON_USERpostgrest system user.supabase
GOTRUE_DAEMON_GROUPpostgrest 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.

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.

Docker Pull Command

docker pull bitnami/gotrue
Bitnami