Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/dtan4/nginx-basic-auth-proxy
Docker image of Nginx Proxy with Basic Auth
https://github.com/dtan4/nginx-basic-auth-proxy
nginx
Last synced: 2 months ago
JSON representation
Docker image of Nginx Proxy with Basic Auth
- Host: GitHub
- URL: https://github.com/dtan4/nginx-basic-auth-proxy
- Owner: dtan4
- License: mit
- Created: 2017-02-09T10:45:31.000Z (almost 8 years ago)
- Default Branch: master
- Last Pushed: 2020-09-25T13:45:08.000Z (over 4 years ago)
- Last Synced: 2024-11-09T02:27:45.667Z (3 months ago)
- Topics: nginx
- Language: Shell
- Homepage:
- Size: 13.7 KB
- Stars: 90
- Watchers: 9
- Forks: 62
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Docker image of Nginx Proxy with Basic Auth
[](https://quay.io/repository/dtan4/nginx-basic-auth-proxy)
Simple HTTP Proxy with Basic Authentication
```
w/ user:pass +------------------------+ +-------------+
User ---------------> | nginx-basic-auth-proxy | ---> | HTTP Server |
+------------------------+ +-------------+
```
## Run
```bash
$ docker run \
--rm \
--name nginx-basic-auth-proxy \
-p 8080:80 \
-p 8090:8090 \
-e BASIC_AUTH_USERNAME=username \
-e BASIC_AUTH_PASSWORD=password \
-e PROXY_PASS=https://www.google.com \
-e SERVER_NAME=proxy.dtan4.net \
-e PORT=80 \
quay.io/dtan4/nginx-basic-auth-proxy
```
Access to http://localhost:8080 , then browser asks you username and password.
You can also try complete HTTP-proxy example using Docker Compose.
hello-world web application cannot be accessed without authentication.
```bash
$ docker-compose up
# http://localhost:8080/
# - Username: username
# - Password: password
```
### Endpoint for monitoring
`:8090/nginx_status` returns the metrics of Nginx.
```sh-session
$ curl localhost:8090/nginx_status
Active connections: 1
server accepts handled requests
8 8 8
Reading: 0 Writing: 1 Waiting: 0
```
## Environment variables
### Required
|Key|Description|
|---|---|
|`BASIC_AUTH_USERNAME`|Basic auth username|
|`BASIC_AUTH_PASSWORD`|Basic auth password|
|`PROXY_PASS`|Proxy destination URL|
### Optional
|Key|Description|Default|
|---|---|---|
|`SERVER_NAME`|Value for `server_name` directive|`example.com`|
|`PORT`|Value for `listen` directive|`80`|
|`CLIENT_MAX_BODY_SIZE`|Value for `client_max_body_size` directive|`1m`|
|`PROXY_READ_TIMEOUT`|Value for `proxy_read_timeout` directive|`60s`|
|`WORKER_PROCESSES`|Value for `worker_processes` directive|`auto`|
## Author
Daisuke Fujita ([@dtan4](https://github.com/dtan4))
## License
[](LICENSE)