updated readme

This commit is contained in:
Daniel Wolf 2018-12-27 12:07:35 -05:00
parent 8e794d6695
commit cc89856f0a
1 changed files with 29 additions and 7 deletions

View File

@ -1,24 +1,46 @@
[GitHub](https://github.com/nephatrine/docker-nginx-ssl) |
[Git Repo](https://code.nephatrine.net/nephatrine/docker-nginx-ssl) |
[DockerHub](https://hub.docker.com/r/nephatrine/nginx-ssl/) |
[unRAID](https://github.com/nephatrine/unraid-docker-templates)
[unRAID Template](https://github.com/nephatrine/unraid-docker-templates)
# NGINX+SSL (Certbot/LetsEncrypt) Docker
# NGINX Application Container
This docker is intended to be used as a reverse proxy/cache to access other dockers. You can certainly serve static content, but tools like PHP or MySQL are not included.
This docker container manages the NGINX application, a lightweight web server and reverse proxy.
- [docker-base-alpine](https://code.nephatrine.net/nephatrine/docker-base-alpine)
- [CertBot](https://certbot.eff.org/)
- [NGINX](https://www.nginx.com/)
## Configuration
- ``{config}/etc/crontab``: Crontab Entries
- ``{config}/etc/logrotate.conf``: Logrotate General Configuration
- ``{config}/etc/logrotate.d/*``: Logrotate Per-Application Configuration
- ``{config}/etc/mime.types``: NGINX MIME Types
- ``{config}/etc/nginx.conf``: NGINX General Configuration
- ``{config}/etc/nginx.d/*``: NGINX Per-Site Configuration
- ``{config}/ssl/live/{site}/``: SSL/TLS certificates
This container is primarily intended to be used as a reverse proxy/cache to access other dockers. You can certainly serve static content, but tools like PHP or MySQL are not included.
Certbot is installed and can request SSL certificats from LetsEncrypt on your behalf assuming you have entered the appropriate values. DNS challenges are not supported until I can come up with a good way to automate it. Unfortunately, that means wildcard certificates cannot be requested at this time.
**NOTE:** If you have trouble connecting from an older device or browser when using HTTPS, you may need to change the ciphers allowed in ``{config}/etc/nginx.d/_ssl.inc`` to be more permissive.
## Settings
## Ports
See the [base image](https://github.com/nephatrine/docker-base-alpine) for additional settings.
- **80/tcp:** HTTP Port
- **443/tcp:** HTTPS Port
## Variables
- **ADMINIP:** Administrative Access IP
- **DNSADDR:** Resolver IPs (Space-Delimited)
- **PUID:** Volume Owner UID
- **PGID:** Volume Owner GID
- **SSLEMAIL:** LetsEncrypt Email Address
- **SSLDOMAINS:** LetsEncrypt (Sub)domains (comma-delimited)
- **TZ:** Time Zone
## Mount Points
- **/mnt/config:** Configuration Volume
- **/mnt/config:** Configuration/Logs