Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/beevelop/docker-nginx-basic-auth

:closed_lock_with_key: Simple Docker image for basic authentication
https://github.com/beevelop/docker-nginx-basic-auth

authentication container-image containerization docker docker-image nginx

Last synced: about 2 hours ago
JSON representation

:closed_lock_with_key: Simple Docker image for basic authentication

Host: GitHub
URL: https://github.com/beevelop/docker-nginx-basic-auth
Owner: beevelop
License: mit
Created: 2016-06-25T07:05:11.000Z (over 8 years ago)
Default Branch: latest
Last Pushed: 2023-10-18T21:53:28.000Z (about 1 year ago)
Last Synced: 2024-12-18T11:07:40.235Z (8 days ago)
Topics: authentication, container-image, containerization, docker, docker-image, nginx
Language: Dockerfile
Homepage: https://beevelop.com
Size: 25.4 KB
Stars: 150
Watchers: 7
Forks: 98
Open Issues: 7
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

README

        ![GitHub Workflow Status](https://img.shields.io/github/actions/workflow/status/beevelop/docker-nginx-basic-auth/docker.yml?style=for-the-badge)

![Docker Pulls](https://img.shields.io/docker/pulls/beevelop/nginx-basic-auth.svg?style=for-the-badge)

![Docker Stars](https://img.shields.io/docker/stars/beevelop/nginx-basic-auth?style=for-the-badge)

![Docker Image Size (tag)](https://img.shields.io/docker/image-size/beevelop/nginx-basic-auth/latest?style=for-the-badge)

![License](https://img.shields.io/github/license/beevelop/docker-nginx-basic-auth?style=for-the-badge)

[![GitHub release](https://img.shields.io/github/release/beevelop/docker-nginx-basic-auth.svg?style=for-the-badge)](https://github.com/beevelop/docker-nginx-basic-auth/releases)

![GitHub Release Date](https://img.shields.io/github/release-date/beevelop/docker-nginx-basic-auth?style=for-the-badge)

![CalVer](https://img.shields.io/badge/CalVer-YYYY.MM.MICRO-22bfda.svg?style=for-the-badge)

[![Beevelop](https://img.shields.io/badge/-%20Made%20with%20%F0%9F%8D%AF%20by%20%F0%9F%90%9Dvelop-blue.svg?style=for-the-badge)](https://beevelop.com)

# nginx-basic-auth

---

> Simple Docker image to provide basic authentication for a single other container.

## Quickstart

```bash

docker run -d --name web dockercloud/hello-world

docker run -d -p 80:80 --link web:web --name auth beevelop/nginx-basic-auth

```

Try accessing and logging in with username `foo` and password `bar`.

## Advanced

```bash

docker run -d \

           -e HTPASSWD='foo:$apr1$odHl5EJN$KbxMfo86Qdve2FH4owePn.' \

           -e FORWARD_PORT=1337 \

           --link web:web -p 8080:80 \

           --name auth \

           beevelop/nginx-basic-auth

```

> Use single quotes to prevent unwanted interpretation of `$` signs!

## Configuration

- `HTPASSWD` (default: `foo:$apr1$odHl5EJN$KbxMfo86Qdve2FH4owePn.`): Will be written to the .htpasswd file on launch (non-persistent)

- `FORWARD_PORT` (default: `80`): Port of the **source** container that should be forwarded

- `FORWARD_HOST` (default: `web`): Hostname of the **source** container that should be forwarded

  > The container does not need any volumes to be mounted! Nonetheless you will find all interesting files at `/etc/nginx/*`.

## Multiple Users

Multiple Users are possible by separating the users by newline. To pass the newlines properly you need to use Shell Quoting (like `$'foo\nbar'`):

```

docker run -d --link web:web --name auth \

           -e HTPASSWD=$'foo:$apr1$odHl5EJN$KbxMfo86Qdve2FH4owePn.\ntest:$apr1$LKkW8P4Y$P1X/r2YyaexhVL1LzZAQm.' \

           beevelop/nginx-basic-auth

```

results in 2 users (`foo:bar` and `test:test`).

## Troubleshooting

```

nginx: [emerg] host not found in upstream "web" in /etc/nginx/conf.d/auth.conf:80

```

- You need to link the container as `web` (`--link foobar:web`)

---

- SSL is unsupported ATM, but might be available in the near future. For now it might be a suitable solution to use another reverse proxy (e.g. `jwilder/nginx-proxy`) that acts as a central gateway. You just need to configure the `VIRTUAL_HOST` env and disable port forwarding.