192 lines
8.4 KiB
Markdown
192 lines
8.4 KiB
Markdown
# Bitnami Secure Image for OAuth2 Proxy
|
||
|
||
## What is OAuth2 Proxy?
|
||
|
||
> A reverse proxy and static file server that provides authentication using Providers (Google, GitHub, and others) to validate accounts by email, domain or group.
|
||
|
||
[Overview of OAuth2 Proxy](https://github.com/oauth2-proxy/oauth2-proxy)
|
||
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 --name oauth2-proxy bitnami/oauth2-proxy:latest
|
||
```
|
||
|
||
## Why use Bitnami Secure Images?
|
||
|
||
Those are hardened, minimal CVE images built and maintained by Bitnami. Bitnami Secure Images are based on the cloud-optimized, security-hardened enterprise [OS Photon Linux](https://vmware.github.io/photon/). Why choose BSI images?
|
||
|
||
- Hardened secure images of popular open source software with Near-Zero Vulnerabilities
|
||
- Vulnerability Triage & Prioritization with VEX Statements, KEV and EPSS Scores
|
||
- Compliance focus with FIPS, STIG, and air-gap options, including secure bill of materials (SBOM)
|
||
- Software supply chain provenance attestation through in-toto
|
||
- First class support for the internet’s favorite Helm charts
|
||
|
||
Each image comes with valuable security metadata. You can view the metadata in [our public catalog here](https://app-catalog.vmware.com/bitnami/apps). Note: Some data is only available with [commercial subscriptions to BSI](https://bitnami.com/).
|
||
|
||
|
||
|
||
|
||
If you are looking for our previous generation of images based on Debian Linux, please see the [Bitnami Legacy registry](https://hub.docker.com/u/bitnamilegacy).
|
||
|
||
## Why use a non-root container?
|
||
|
||
Non-root container images add an extra layer of security and are generally recommended for production environments. However, because they run as a non-root user, privileged tasks are typically off-limits. Learn more about non-root containers [in our docs](https://techdocs.broadcom.com/us/en/vmware-tanzu/application-catalog/tanzu-application-catalog/services/tac-doc/apps-tutorials-work-with-non-root-containers-index.html).
|
||
|
||
## 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://techdocs.broadcom.com/us/en/vmware-tanzu/application-catalog/tanzu-application-catalog/services/tac-doc/apps-tutorials-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 oauth2-proxy Docker Image is to pull the prebuilt image from the [Docker Hub Registry](https://hub.docker.com/r/bitnami/oauth2-proxy).
|
||
|
||
```console
|
||
docker pull bitnami/oauth2-proxy: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/oauth2-proxy/tags/) in the Docker Hub Registry.
|
||
|
||
```console
|
||
docker pull bitnami/oauth2-proxy:[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 .
|
||
```
|
||
|
||
## Connecting to other containers
|
||
|
||
Using [Docker container networking](https://docs.docker.com/engine/userguide/networking/), a different server running inside a container can easily be accessed by your application containers and vice-versa.
|
||
|
||
Containers attached to the same network can communicate with each other using the container name as the hostname.
|
||
|
||
### Using the Command Line
|
||
|
||
#### Step 1: Create a network
|
||
|
||
```console
|
||
docker network create oauth2-proxy-network --driver bridge
|
||
```
|
||
|
||
#### Step 2: Launch the Oauth2-proxy container within your network
|
||
|
||
Use the `--network <NETWORK>` argument to the `docker run` command to attach the container to the `oauth2-proxy-network` network.
|
||
|
||
```console
|
||
docker run --name oauth2-proxy-node1 --network oauth2-proxy-network bitnami/oauth2-proxy:latest
|
||
```
|
||
|
||
#### Step 3: Run another containers
|
||
|
||
We can launch another containers using the same flag (`--network NETWORK`) in the `docker run` command. If you also set a name to your container, you will be able to use it as hostname in your network.
|
||
|
||
## Configuration
|
||
|
||
Oauth2-proxy can be configured via config file, command line options or environment variables.
|
||
[Further information](https://oauth2-proxy.github.io/oauth2-proxy/configuration/overview)
|
||
|
||
### FIPS configuration in Bitnami Secure Images
|
||
|
||
The Bitnami OAuth2 Proxy Docker image from the [Bitnami Secure Images](https://go-vmware.broadcom.com/contact-us) 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`.
|
||
|
||
## Logging
|
||
|
||
The Bitnami oauth2-proxy Docker image sends the container logs to the `stdout`. To view the logs:
|
||
|
||
```console
|
||
docker logs oauth2-proxy
|
||
```
|
||
|
||
You can configure the containers [logging driver](https://docs.docker.com/engine/admin/logging/overview/) using the `--log-driver` option if you wish to consume the container logs differently. In the default configuration docker uses the `json-file` driver.
|
||
|
||
## Maintenance
|
||
|
||
### Upgrade this image
|
||
|
||
Bitnami provides up-to-date versions of oauth2-proxy, 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/oauth2-proxy:latest
|
||
```
|
||
|
||
#### Step 2: Stop and backup the currently running container
|
||
|
||
Stop the currently running container using the command
|
||
|
||
```console
|
||
docker stop oauth2-proxy
|
||
```
|
||
|
||
Next, take a snapshot of the persistent volume `/path/to/oauth2-proxy-persistence` using:
|
||
|
||
```console
|
||
rsync -a /path/to/oauth2-proxy-persistence /path/to/oauth2-proxy-persistence.bkp.$(date +%Y%m%d-%H.%M.%S)
|
||
```
|
||
|
||
You can use this snapshot to restore the database state should the upgrade fail.
|
||
|
||
#### Step 3: Remove the currently running container
|
||
|
||
```console
|
||
docker rm -v oauth2-proxy
|
||
```
|
||
|
||
#### Step 4: Run the new image
|
||
|
||
Re-create your container from the new image, restoring your backup if necessary.
|
||
|
||
```console
|
||
docker run --name oauth2-proxy bitnami/oauth2-proxy:latest
|
||
```
|
||
|
||
## 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 container. You can request new features by creating an [issue](https://github.com/bitnami/containers/issues/new) or submitting a [pull
|
||
request](https://github.com/bitnami/containers/pulls/new) 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 include the following information in your issue: -->
|
||
|
||
- Host OS and version
|
||
- Docker version (`docker version`)
|
||
- Output of `docker info`
|
||
- Version of this container
|
||
- The command you used to run the container, and any relevant output you saw (masking any sensitive information)
|
||
|
||
## 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.
|