hrektts/nginx-proxy repository overview

⁠docker-nginx-proxy

Dockerfile to build a nginx container image that proxies requests to subdirectories.

⁠Quick Start

The easiest way to launch the container is using docker-compose⁠:

wget https://raw.githubusercontent.com/hrektts/docker-nginx-proxy/master/docker-compose.yml
docker-compose up

Otherwise, you can launch the container using the docker command line:

docker run -d -p 80:80 -v /var/run/docker.sock:/tmp/docker.sock:ro hrektts/nginx-proxy

Then start any containers you want to be proxied with an environment variable PROXY_SUBDIR=/subdirectory:

docker run -e PROXY_SUBDIR=/subdirecroty ...

The containers being proxied must expose the port to be proxied, either by using the EXPOSE directive in their Dockerfile or by using the --expose flag to docker run or docker create.

⁠HTTPS

HTTPS support can be enabled as follows:

docker run -d -p 80:80 -p 443:443 -v /path/to/certs:/etc/nginx/certs \
    -v /var/run/docker.sock:/tmp/docker.sock:ro hrektts/nginx-proxy

The default path to look for the SSL certificates is /etc/nginx/certs. To enable HTTPS support, this directory must contain a private key and a certificate named /etc/nginx/certs/default.key and /etc/nginx/certs/default.crt respectively, these can however be changed using the SSL_KEY_PATH and SSL_CERTIFICATE_PATH configuration parameters.

⁠Configuration Parameters

Below is the complete list of available options.

⁠For the proxy container

• NGINX_HSTS_ENABLED: Option for turning off the HSTS configuration. Applicable only when SSL is in use. Defaults to true.
• NGINX_HSTS_MAXAGE: Option for setting the HSTS max-age. Applicable only when SSL is in use. Defaults to 31536000.
• SSL_CERTIFICATE_PATH: Location of the ssl certificate. Defaults to /etc/nginx/certs/default.crt.
• SSL_KEY_PATH: Location of the ssl private key. Defaults to /etc/nginx/certs/default.key.
• SSL_DHPARAM_PATH: Location of the dhparam file. Defaults to /etc/nginx/certs/default.dhparam.pem.

⁠For the backend container

• PROXY_SUBDIR: The relative url of the backend service, e.g. /backend.
• PROXY_MAX_OBJECT_SIZE: Maximum size of a object to be uploaded in byte. The default value of Nginx is used if no other value has been specified.
• VIRTUAL_PROTO: The communication protocol between the proxy container and the backend container. Defaults to http.
• VIRTUAL_PORT: The port to be proxied. Defaults to 80.

⁠References

• jwilder/nginx-proxy⁠