jlusiardi
/
docker_nginx_auto_proxy
1
0
Fork 0
Code Issues Pull Requests Projects Releases 2 Wiki Activity

updated documentation

This commit is contained in:
Joachim Lusiardi 2015-01-22 11:34:41 +01:00
parent 79b6019152
commit 293d4b60ee
1 changed files with 15 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

24
README.md
View File

@ -1,13 +1,19 @@
# Automated Nginx reverse Proxy for Docker Webservices
This image attaches to the docker event queue and creates/removes proxy settings in the contained nginx.
## Requirements
1. installed nginx
2. adapted nginx configuration to include the directory of the generated config files
3. docker daemon must be configured to listen to TCP port
4. Executing user must be able to send HUG signals to ngix master process
## Starting the container
The container is started as:
`docker run --name auto_proxy -d -v /var/run/docker.sock:/var/run/docker.sock -p 80:80 docker_nginx_auto_proxy`
The socket must be handed in so the container can get the events.
## How it works
1. Creates a directory in */tmp* for the generated config files
2. Attaches to the stream of events from the Docker daemon
3. On every event, it scans all container for avaiable environment variable *PROXY_DATA*
Containers that should be proxied neet meta information in the environment variable *PROXY_DATA* available.
This variable must be of the following format:
`PROXY_DATA=server_name:test.com,port:80`
The following options are possible:
* **server_name**(required) the name of the virtual host
* **port**(optional, defaults to 80) the port on the target container
* **ip**(optional, defaults to listen on all IPs) the IP on which the proxy should listen.
* **location**(optional) if the proxied web application is not running on the /-path