bitnami/gotrue
Bitnami container image for GoTrue
50K+
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.
docker run -it --name gotrue bitnami/gotrue
Looking to use GoTrue in production? Try VMware Tanzu Application Catalog, the commercial edition of the 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.
Dockerfile
linksLearn 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.
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 .
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
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 |
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.
docker-compose.yaml
file has been removed, as it was solely intended for internal testing purposes.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.
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.
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.