nginx-sidecar-basic-auth

This is a Docker image that provides an nginx proxy server enforcing HTTP basic authentication on every request (exception OPTIONS). It is suitable for operation within OpenShift, e.g. as a sidecar container.

Configuration

Configuration is provided using environment variables:

Environment	Description	Default Value
`PORT`	Port to listen on	`8087`
`FORWARD_HOST`	Hostname of the backend server to proxy to	`localhost`
`FORWARD_PORT`	Port of the backend server to proxy to	`8080`
`BASIC_AUTH_USERNAME`	Username to use for authentication	`admin`
`BASIC_AUTH_PASSWORD`	Password to use for authentication	`admin`
`PROXY_READ_TIMEOUT`	Defines a timeout for reading a response from the proxied server	`60s`
`PROXY_SEND_TIMEOUT`	Sets a timeout for transmitting a request to the proxied server	`60s`
`CLIENT_MAX_BODY_SIZE`	Sets the maximum allowed size of the client request body	`1m`
`PROXY_REQUEST_BUFFERING`	Enables or disables buffering of a client request body	`on`
`PROXY_BUFFERING`	Enables or disables buffering of responses from the proxied server	`on`
`WEBSOCKET_PATH`	Activates websocket handling on the given path	(none)
`FORWARD_WEBSOCKET_PATH`	If the remote path differs from `WEBSOCKET_PATH`, use this	(none)

Usage

Docker

Start the container and link it with your backend (alternatively, use Docker networks):

docker run -d --name nginx-basic-auth -p 8087:8087 \
  --link backend:backend \
  -e FORWARD_HOST=backend \
  -e FORWARD_PORT=3000 \
  xscys/nginx-sidecar-basic-auth

OpenShift Sidecar Usage

Add the sidecar container next to your application container in your deployment configuration:

- image: xscys/nginx-sidecar-basic-auth
  imagePullPolicy: Always
  name: auth-proxy
  ports:
    - containerPort: 8087
      protocol: TCP
  env:
    - name: FORWARD_PORT
      value: ${BACKEND_CONTAINER_PORT}

License