nginx-reloaded is a simple and straightforward alternative to the default nginx Docker image which adds support for automatic silent reloads anytime nginx.conf is updated.
By providing a thin layer on top of the standard nginx:latest this image leverages inotify to watch the conf file and run silent reloads in the background on changes without using a sidecar or other complicated workarounds. It was primairly designed to run in Kubernetes environments that use a ConfigMap to mount and update server configuration.
- Automatic Silent Reload: With the help of
inotify-tools, nginx can detect changes in thenginx.confand reload without any disruption. - Minimalistic Design: Built on top of the official nginx Docker image,
nginx-reloadedis lightweight and straightforward. - Custom Path Support: You can specify a custom path for
nginx.confusing theNGINX_RELOADED_PATHenvironment variable.
To get started with nginx-reloaded, ensure you have Docker installed and running.
-
Build the Docker image:
docker build -t nginx-reloaded:latest . -
Run the Docker container:
docker run -d --name nginx-reloaded-container nginx-reloaded:latest
To provide your custom nginx.conf mount it to /etc/nginx/nginx-reloaded/nginx.conf when running your container.
docker run -d --name nginx-reloaded-container -v /path/to/your/nginx.conf:/etc/nginx/nginx-reloaded/nginx.conf nginx-reloaded:latestTo use a custom path for nginx.conf, set the NGINX_RELOADED_PATH environment variable when running the Docker container.
docker run -d --name nginx-reloaded-container -e NGINX_RELOADED_PATH=/path/to/your/nginx.conf nginx-reloaded:latestThe magic behind the auto-reloading feature is inotify-tools. When the nginx.conf undergoes changes like modifications or deletion, the inotifywait loop detects these alterations and reloads nginx.
For further details, refer to the provided Dockerfile and entrypoint.sh.
This project is designed and maintained by Eflyn. Contributions, feedback, and issues are welcome.