Skip to content
Bitnami Docker Image for OAuth2 Proxy
Branch: master
Clone or download
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.github Add Issues/PRs autoclose Mar 28, 2019
3 3.2.0-debian-9-r31 release Jul 19, 2019
LICENSE Update LICENSE Jun 21, 2018
README.md 3.2.0-debian-9-r31 release Jul 19, 2019
docker-compose.yml 3.1.0-debian-9-r36 release Mar 21, 2019
test.yaml 0.20180625.74543-debian-9-r95 release Nov 28, 2018

README.md

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.

https://github.com/pusher/oauth2_proxy

TL;DR;

$ docker run --name oauth2-proxy bitnami/oauth2-proxy:latest

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 which gives you a small base container image and the familiarity of a leading linux distribution.
  • All Bitnami images available in Docker Hub are signed with Docker Content Trust (DTC). You can use DOCKER_CONTENT_TRUST=1 to verify the integrity of the images.
  • Bitnami container images are released daily with the latest distribution packages available.

This CVE scan report contains a security report with all open CVEs. To get the list of actionable security issues, find the "latest" tag, click the vulnerability report link under the corresponding "Security scan" field and then select the "Only show fixable" filter on the next page.

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.

How to deploy OAuth2 in Kubernetes?

You can find an example for testing in the file test.yaml. To launch this sample file run:

$ kubectl apply -f test.yaml

NOTE: If you are pulling from a private containers registry, replace the image name with the full URL to the docker image. E.g.

  • image: 'your-registry/image-name:your-version'

Supported tags and respective Dockerfile links

NOTE: Debian 8 images have been deprecated in favor of Debian 9 images. Bitnami will not longer publish new Docker images based on Debian 8.

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

Subscribe to project updates by watching the bitnami/oauth2-proxy GitHub repo.

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.

$ 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 in the Docker Hub Registry.

$ docker pull bitnami/oauth2-proxy:[TAG]

If you wish, you can also build the image yourself.

$ docker build -t bitnami/oauth2-proxy:latest https://github.com/bitnami/bitnami-docker-oauth2-proxy.git

Connecting to other containers

Using Docker container 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

$ docker network create oauth2-proxy-network --driver bridge

Step 2: Launch the Blacbox_exporter container within your network

Use the --network <NETWORK> argument to the docker run command to attach the container to the oauth2-proxy-network network.

$ 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

There is varying support for collectors on each operating system.

Collectors are enabled by providing a --collector. flag. Collectors that are enabled by default can be disabled by providing a --no-collector. flag. Further information

Logging

The Bitnami oauth2-proxy Docker image sends the container logs to the stdout. To view the logs:

$ docker logs oauth2-proxy

You can configure the containers logging driver 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

$ docker pull bitnami/oauth2-proxy:latest

Step 2: Stop and backup the currently running container

Stop the currently running container using the command

$ docker stop oauth2-proxy

Next, take a snapshot of the persistent volume /path/to/oauth2-proxy-persistence using:

$ 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

$ docker rm -v oauth2-proxy

Step 4: Run the new image

Re-create your container from the new image, restoring your backup if necessary.

$ docker run --name oauth2-proxy bitnami/oauth2-proxy:latest

Contributing

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

Issues

  • 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 2019 Bitnami

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.

You can’t perform that action at this time.