quico-containers/nginx_hls_proxy
1
0
Fork 0
Code Issues 1 Pull Requests Packages Projects Releases Wiki Activity

docs(ping): Introduce ping sidecar container (#1)

Browse Source
This commit is contained in:
hygienic-books 2023-10-08 16:44:28 +02:00
parent 020975158d
commit 884c8a50ae
1 changed files with 4 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
README.md
View File

@ -6,6 +6,10 @@ Search and replace all mentions of FIXME with sensible content in this file and
Docker Compose files to spin up an instance of Nginx. Docker Compose files to spin up an instance of Nginx.
Nginx comes with an optional sidecar container we're calling `ping` whose purpose is to do health checks. If you want Nginx to bind to a specific virtual IP address you're going to want to use `ping`, it will quite literally ping the virtual IP address for you and report a successful health check once the address becomes reachable. Only then will Nginx start up. Management on your Docker host of a virtual IP address can happen via `iproute2`/`ip addr add`, `keepalived` or similar mechanisms and is out of scope of this repository.
Feel free to run Nginx without `ping` if you have no need for a virtual IP address. Continue reading for details on how to start with and without the `ping` sidecar container.
# How to run # How to run
Add a `COMPOSE_ENV` file and save its location as a shell variable along with the location where this repo lives, here for example `/opt/containers/nginx` plus all other variables. At [env/fqdn_context.env.example](env/fqdn_context.env.example) you'll find an example environment file. Add a `COMPOSE_ENV` file and save its location as a shell variable along with the location where this repo lives, here for example `/opt/containers/nginx` plus all other variables. At [env/fqdn_context.env.example](env/fqdn_context.env.example) you'll find an example environment file.