Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

[bitnami/gotrue] Release 2.155.2-debian-12-r0 #69228

Merged
merged 1 commit into from
Jul 12, 2024
Merged

[bitnami/gotrue] Release 2.155.2-debian-12-r0 #69228

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 5 additions & 5 deletions bitnami/gotrue/2/debian-12/Dockerfile
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,15 +7,15 @@ ARG TARGETARCH

LABEL com.vmware.cp.artifact.flavor="sha256:c50c90cfd9d12b445b011e6ad529f1ad3daea45c26d20b00732fae3cd71f6a83" \
org.opencontainers.image.base.name="docker.io/bitnami/minideb:bookworm" \
org.opencontainers.image.created="2024-07-04T23:07:17Z" \
org.opencontainers.image.created="2024-07-12T13:50:50Z" \
org.opencontainers.image.description="Application packaged by Broadcom, Inc." \
org.opencontainers.image.documentation="https://github.com/bitnami/containers/tree/main/bitnami/gotrue/README.md" \
org.opencontainers.image.licenses="Apache-2.0" \
org.opencontainers.image.ref.name="2.155.1-debian-12-r0" \
org.opencontainers.image.ref.name="2.155.2-debian-12-r0" \
org.opencontainers.image.source="https://github.com/bitnami/containers/tree/main/bitnami/gotrue" \
org.opencontainers.image.title="gotrue" \
org.opencontainers.image.vendor="Broadcom, Inc." \
org.opencontainers.image.version="2.155.1"
org.opencontainers.image.version="2.155.2"

ENV HOME="/" \
OS_ARCH="${TARGETARCH:-amd64}" \
Expand All @@ -28,7 +28,7 @@ SHELL ["/bin/bash", "-o", "errexit", "-o", "nounset", "-o", "pipefail", "-c"]
RUN install_packages ca-certificates curl procps
RUN mkdir -p /tmp/bitnami/pkg/cache/ ; cd /tmp/bitnami/pkg/cache/ ; \
COMPONENTS=( \
"gotrue-2.155.1-0-linux-${OS_ARCH}-debian-12" \
"gotrue-2.155.2-0-linux-${OS_ARCH}-debian-12" \
) ; \
for COMPONENT in "${COMPONENTS[@]}"; do \
if [ ! -f "${COMPONENT}.tar.gz" ]; then \
Expand All @@ -45,7 +45,7 @@ RUN apt-get autoremove --purge -y curl && \
RUN useradd -r -u 1001 -g root gotrue
RUN find / -perm /6000 -type f -exec chmod a-s {} \; || true

ENV APP_VERSION="2.155.1" \
ENV APP_VERSION="2.155.2" \
BITNAMI_APP_NAME="gotrue" \
PATH="/opt/bitnami/gotrue/bin:$PATH"

Expand Down
174 changes: 174 additions & 0 deletions bitnami/gotrue/2/debian-12/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,174 @@
# 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](https://github.com/netlify/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

```console
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**](https://github.com/bitnami/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](https://notaryproject.dev/). [Check this post](https://blog.bitnami.com/2024/03/bitnami-packaged-containers-and-helm.html) 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](https://bitnami.com/enterprise), the commercial edition of the Bitnami catalog.

## 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](https://docs.vmware.com/en/VMware-Tanzu-Application-Catalog/services/tutorials/GUID-understand-rolling-tags-containers-index.html).

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](https://github.com/bitnami/containers).

## Get this image

The recommended way to get the Bitnami GoTrue Docker Image is to pull the prebuilt image from the [Docker Hub Registry](https://hub.docker.com/r/bitnami/gotrue).

```console
docker pull bitnami/gotrue:latest
```

To use a specific version, you can pull a versioned tag. You can view the [list of available versions](https://hub.docker.com/r/bitnami/gotrue/tags/) in the Docker Hub Registry.

```console
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.

```console
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

```console
docker pull bitnami/gotrue:latest
```

#### Step 2: Remove the currently running container

```console
docker rm -v gotrue
```

#### Step 3: Run the new image

Re-create your container from the new image.

```console
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` | | `[email protected]` |
| `GOTRUE_SMTP_HOST` | | `smtp.exmaple.com` |
| `GOTRUE_SMTP_PORT` | | `587` |
| `GOTRUE_SMTP_SENDER_NAME` | | `[email protected]` |
| `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:

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

Check the [official GoTrue documentation](https://github.com/netlify/gotrue) 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](https://github.com/bitnami/containers/issues) or submitting a [pull request](https://github.com/bitnami/containers/pulls) with your contribution.

## Issues

If you encountered a problem running this container, you can file an [issue](https://github.com/bitnami/containers/issues/new/choose). For us to provide better support, be sure to fill the issue template.

## License

Copyright © 2024 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.
2 changes: 1 addition & 1 deletion bitnami/gotrue/2/debian-12/prebuildfs/opt/bitnami/.bitnami_components.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,6 @@
"arch": "amd64",
"distro": "debian-12",
"type": "NAMI",
"version": "2.155.1-0"
"version": "2.155.2-0"
}
}
2 changes: 1 addition & 1 deletion bitnami/gotrue/2/debian-12/tags-info.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
rolling-tags:
- "2"
- 2-debian-12
- 2.155.1
- 2.155.2
- latest
Loading