update readme for new version
This commit is contained in:
parent
f7a6d924d9
commit
3db6ade0bd
128
README.md
128
README.md
@ -1,63 +1,93 @@
|
||||
# ab-nginx
|
||||
|
||||
Containerized fully-functional implementation of NGINX running on Alpine **as a fully NON-ROOT user**. The container by default is a 'blank slate' that just serves files out of the box. Changing configuration, server blocks and content is accomplished with bind-mounts using a sensible, simple directory structure. The container auto-detects mounted certificates and switches to TLS automatically. [Helper scripts](https://git.asifbacchus.dev/ab-docker/ab-nginx/releases) in the git repo make certificate mounting easier, allow for custom docker networks and more. The container by default can be used as a Let’s Encrypt endpoint with tools like certbot.
|
||||
Containerized fully-functional implementation of NGINX running on Alpine **as a fully NON-ROOT user**. The container by default is a 'blank slate' that just serves files out of the box. Changing configuration, server blocks and content is accomplished with bind-mounts using a sensible, simple directory structure. The container auto-detects mounted certificates and switches to TLS automatically. Available [Helper scripts](https://asifbacchus.dev/public/docker/nginx/ab-nginx/) make certificate mounting easier, allow for custom docker networks and more. The container by default can be used as a Let’s Encrypt endpoint with tools like certbot.
|
||||
|
||||
**Version 5.x adds the following features:**
|
||||
|
||||
- container auto-generates missing Diffie-Hellman Parameters (‘dhparams’) when using TLSv1.2
|
||||
- included a script within the container to generate self-signed certificates with a *group* readable private key so they can be shared between services in a stack by aligning container and host GIDs
|
||||
- helper scripts have been moved out of the ‘releases’ and hosted separately as straight-downloads so there is no need to clone the entire repo -- located at: [https://asifbacchus.dev/public/docker/nginx/ab-nginx/](https://asifbacchus.dev/public/docker/nginx/ab-nginx/)
|
||||
|
||||
## Contents
|
||||
|
||||
[Alternate repository](#alternate-repository)<br>
|
||||
[Documentation and scripts](#documentation-and-scripts)<br>
|
||||
[Permissions](#permissions)<br>
|
||||
[Container layout](#container-layout)<br>
|
||||
[Content directory](#content-directory)<br>
|
||||
[Configuration directory](#configuration-directory)<br>
|
||||
[Quick-start](#quick-start)<br>
|
||||
[Mounting content](#mounting-content)<br>
|
||||
[Mounting configurations](#mounting-configurations)<br>
|
||||
[Mounting server-blocks](#mounting-server-blocks)<br>
|
||||
[TLS](#tls)<br>
|
||||
[Environment variables](#environment-variables)<br>
|
||||
[Shell mode](#shell-mode)<br>
|
||||
[Drop to shell before NGINX loads](#drop-to-shell-before-nginx-loads)<br>
|
||||
[Enter a running container](#enter-a-running-container)<br>
|
||||
[Logs](#logs)<br>
|
||||
[Final thoughts](#final-thoughts)
|
||||
<!-- toc -->
|
||||
|
||||
- [Alternate repository](#alternate-repository)
|
||||
- [Signed containers](#signed-containers)
|
||||
- [Documentation and scripts](#documentation-and-scripts)
|
||||
- [Permissions](#permissions)
|
||||
* [Option 1: rebuild container with different UID/GID](#option-1-rebuild-container-with-different-uidgid)
|
||||
* [Option 2: specify UID/GID at runtime](#option-2-specify-uidgid-at-runtime)
|
||||
- [Container layout](#container-layout)
|
||||
* [Content directory](#content-directory)
|
||||
* [Configuration directory](#configuration-directory)
|
||||
- [Quick-start](#quick-start)
|
||||
* [Mounting content](#mounting-content)
|
||||
* [Mounting configurations](#mounting-configurations)
|
||||
* [Mounting server-blocks](#mounting-server-blocks)
|
||||
- [TLS](#tls)
|
||||
* [Generate a self-signed certificate](#generate-a-self-signed-certificate)
|
||||
- [Environment variables](#environment-variables)
|
||||
- [Shell mode](#shell-mode)
|
||||
* [Drop to shell before NGINX loads](#drop-to-shell-before-nginx-loads)
|
||||
* [Enter a running container](#enter-a-running-container)
|
||||
- [Logs](#logs)
|
||||
- [Final thoughts](#final-thoughts)
|
||||
|
||||
<!-- tocstop -->
|
||||
|
||||
## Alternate repository
|
||||
|
||||
Throughout this document, I reference my repository on DockerHub (`asifbacchus/ab-nginx:tag`). You may also feel free to pull directly from my private registry instead, especially if you need signed containers. Simply use `docker.asifbacchus.dev/nginx/ab-nginx:tag`. I usually sign major dot-version releases (1.18, 1.19, etc.) as well as the 'latest' image.
|
||||
Throughout this document, I reference my repository on DockerHub (`asifbacchus/ab-nginx:tag`). You may also feel free to pull directly from my private registry instead which is guaranteed to have the most up-to-date releases. Simply use `docker.asifbacchus.dev/nginx/ab-nginx:tag`.
|
||||
|
||||
## Signed containers
|
||||
|
||||
Starting with the 5.x releases, I am no longer using Docker Notary to sign images. Instead, I’m using [CodeNotary](https://codenotary.io). This has several advantages, most notably that it doesn’t matter whether you use DockerHub or my private repo they will both have the same verifiable signature. To verify the signature, you would have to use CodeNotary’s vcn tool -- visit their site for the most up-to-date instructions.
|
||||
|
||||
## Documentation and scripts
|
||||
|
||||
Check out the [repo wiki](https://git.asifbacchus.dev/ab-docker/ab-nginx/wiki) for detailed examples and documentation about the container and the [helper scripts](https://git.asifbacchus.dev/ab-docker/ab-nginx/releases) which are located [here](https://git.asifbacchus.dev/ab-docker/ab-nginx/releases).
|
||||
Check out the [repo wiki](https://git.asifbacchus.dev/ab-docker/ab-nginx/wiki) for detailed examples and documentation about the container and the [helper scripts](https://asifbacchus.dev/public/docker/nginx/ab-nginx/).
|
||||
|
||||
## Permissions
|
||||
|
||||
The container does **NOT** run under the root account. It runs under a user named *www-docker* with a UID of 8080. **This means any files you mount into the container need to be readable (and/or writable depending on your use-case) by UID 8080**. This does not mean just content files, it also includes configurations, server-blocks and *certificates*! Before mounting your files, ensure this is the case. There are more detailed instructions in the [wiki](https://git.asifbacchus.dev/ab-docker/ab-nginx/wiki) if you need help setting file permissions.
|
||||
The container does **NOT** run under the root account. It runs under a user named *www-docker* with a UID and GID of 8080. **This means any files you mount into the container need to be readable (and/or writable depending on your use-case) by UID 8080 or GID 8080**. This does not just mean content files, it also includes configurations, server-blocks and *certificates*! Before mounting your files, ensure this is the case. There are more detailed instructions in the [wiki](https://git.asifbacchus.dev/ab-docker/ab-nginx/wiki) if you need help setting file permissions.
|
||||
|
||||
This is a significant change versus most other NGINX implementations/containers where the main process is run as root
|
||||
and the *worker processes* run as a limited user. In those cases, permissions don’t matter since NGINX can always use
|
||||
the root account to read any files (and especially certificates!) it needs. Please understand this difference.
|
||||
This is a significant change versus most other NGINX implementations/containers where the main process is run as root and the *worker processes* run as a limited user. In those cases, permissions don’t matter since NGINX can always use the root account to read any files (and especially certificates!) it needs. Please understand this difference.
|
||||
|
||||
If you need to change the UID, then you’ll need to rebuild the container using
|
||||
the [Dockerfile in the git repo](https://git.asifbacchus.dev/ab-docker/ab-nginx). The process would be something like
|
||||
this:
|
||||
Most often you will end up wanting to change the container user’s GID so that you can assign it and related services appropriate permissions. To do this, you have two options:
|
||||
|
||||
### Option 1: rebuild container with different UID/GID
|
||||
|
||||
If you are integrating this container as part of a stack, then it might just make sense to “hard-code” the UID and/or GID to whatever works best for your environment. Fortunately, that’s pretty easy. Clone the [git repo](https://git.asifbacchus.dev/ab-docker/ab-nginx) and rebuild the container:
|
||||
|
||||
```bash
|
||||
# clone the repo
|
||||
cd /usr/local/src
|
||||
git clone https://git.asifbacchus.dev/ab-docker/ab-nginx
|
||||
|
||||
# change to the proper directory and build the container
|
||||
# change directory and build
|
||||
cd ab-nginx/build
|
||||
docker build --build-arg BUILD_DATE=$(date -u +'%Y-%m-%dT%H:%M:%SZ') --build-arg UID=xxxx -t name:tag .
|
||||
docker build --build-arg UID=xxxx --build-arg GID=yyyy --build-arg BUILD_DATE=$(date -u +'%Y-%m-%dT%H:%M:%SZ') -t name:tag .
|
||||
```
|
||||
|
||||
Of course, replace *xxxx* with your desired UID for the *www-docker* user. Also, replace *name:tag* with whatever you want to tag your image.
|
||||
- `UID=xxxx`: optional -- replace ‘xxxx’ with desired UID for www-docker user, in most cases the default is fine
|
||||
- `GID=yyyy`: replace ‘yyyy’ with desired GID for www-docker user --> this is probably what you want to change
|
||||
- `BUILD_DATE`: optional -- applies container build date in a standardized label
|
||||
- `name:tag`: you may, of course, name and tag your container anything you like
|
||||
|
||||
### Option 2: specify UID/GID at runtime
|
||||
|
||||
You may find it easier and more flexible to just specify the UID and/or GID at runtime. Again, you most likely want to set the GID so that it matches, say, your webdev user group and the container can then read and serve those files. Pretty easy, just add `--user "uid:gid"` to your docker run command. Here’s an example where the GID is changed to 6000:
|
||||
|
||||
```bash
|
||||
docker run -d ... --user "8080:6000" ... asifbacchus/ab-nginx:latest
|
||||
```
|
||||
|
||||
## Container layout
|
||||
|
||||
### Content directory
|
||||
|
||||
All content is served from the NGINX default `/usr/share/nginx/html` directory within the container. The default set up serves everything found here and in all child directories. To use your own content (this point of this whole thing, right? :wink:) bind-mount your content to the container’s webroot: `-v /my/webstuff:/usr/share/nginx/html`. **Remember that UID 8080 must be able to read these files!**
|
||||
All content is served from the NGINX default `/usr/share/nginx/html` directory within the container. The default set up serves everything found here and in all child directories. Bind-mount your content to the container’s webroot: `-v /my/webstuff:/usr/share/nginx/html`. **Remember that the container UID or GID must be able to read these files!**
|
||||
|
||||
### Configuration directory
|
||||
|
||||
@ -82,11 +112,11 @@ ### Configuration directory
|
||||
├── ssl_certs.conf – (hard-coded for the container, best not to touch)
|
||||
```
|
||||
|
||||
Locations with \**starred descriptions** are designed to be overwritten via bind-mounts to customize the container. For more details on all of these files and what they do, please refer to the [repo wiki](https://git.asifbacchus.dev/ab-docker/ab-nginx/wiki). **Remember that UID 8080 needs to be able to read any files you choose to bind-mount over the container defaults!**
|
||||
Locations with \**starred descriptions** are designed to be overwritten via bind-mounts to customize the container. For more details on all of these files and what they do, please refer to the [repo wiki](https://git.asifbacchus.dev/ab-docker/ab-nginx/wiki). **Remember that the container UID or GID needs to be able to read any files you choose to bind-mount over the container defaults!**
|
||||
|
||||
## Quick-start
|
||||
|
||||
At it’s most basic, all you need to do is mount a directory with content to serve. For more advanced deployments, you can also mount various configurations. In most cases, you’ll also want to mount certificates so that SSL/TLS is an option. **Remember that UID 8080 must be able to read everything you bind-mount!** Let’s run through some examples:
|
||||
At its most basic, all you need to do is mount a directory with content to serve. For more advanced deployments, you can also mount various configurations. In most cases, you’ll also want to mount certificates so that SSL/TLS is an option. **Remember that the container’s UID/GID must be able to read everything you bind-mount!** Let’s run through some examples:
|
||||
|
||||
### Mounting content
|
||||
|
||||
@ -157,12 +187,12 @@ ## TLS
|
||||
| Full-chain certificate<br />(certificate concatenated with intermediates and root CA) | /certs/fullchain.pem |
|
||||
| Private key | /certs/privkey.pem |
|
||||
| Certificate chain<br />(intermediates concatenated with root CA) | /certs/chain.pem |
|
||||
| DH Parameters file<br />(NOT required for TLS 1.3-only mode) | /certs/dhparam.pem |
|
||||
| DH Parameters file<br />(Container will generate this file if not provided)<br />(NOT required for TLS 1.3-only mode) | /certs/dhparam.pem |
|
||||
|
||||
Once those files are available, you can run the container as follows:
|
||||
|
||||
```bash
|
||||
# TLS 1.2 (requires: fullchain.pem, privkey.pem, chain.pem and dhparam.pem)
|
||||
# TLS 1.2 (allows TLSv1.2 and TLSv1.3)
|
||||
docker run -d --name nginx --restart unless-stopped \
|
||||
-p 80:80 \
|
||||
-p 443:443 \
|
||||
@ -171,7 +201,7 @@ # TLS 1.2 (requires: fullchain.pem, privkey.pem, chain.pem and dhparam.pem)
|
||||
-e SERVER_NAMES="domain.tld www.domain.tld" \
|
||||
asifbacchus/ab-nginx:latest
|
||||
|
||||
# TLS 1.3 only mode (requires fullchain.pem, privkey.pem and chain.pem)
|
||||
# TLS 1.3 only mode
|
||||
docker run -d --name nginx --restart unless-stopped \
|
||||
-p 80:80 \
|
||||
-p 443:443 \
|
||||
@ -184,11 +214,25 @@ # TLS 1.3 only mode (requires fullchain.pem, privkey.pem and chain.pem)
|
||||
|
||||
The container will load a secure configuration automatically, require SSL connections and redirect HTTP to HTTPS. If you want to enforce HSTS, simply set the HSTS environment variable to true by adding `-e HSTS=TRUE` before specifying the container name. Careful about doing this while testing though! Also, certificates should always be mounted read-only (`:ro`) for security reasons!
|
||||
|
||||
You may have noticed I also specified the `SERVER_NAMES` variable. This is necessary or SSL will not work since the hostname the server responds to must match the certificate being presented. **Make sure you set this environment variable to match your certificates!** N.B. If you are using your own server-blocks, then this environment variable is **NOT** required – it is only used by the container when auto-configuring the default server-blocks.
|
||||
You may have noticed I also specified the `SERVER_NAMES` variable. This is necessary or SSL will not work since the hostname the server responds to must match the certificate being presented. **Make sure you set this environment variable to match your certificates!**
|
||||
|
||||
> N.B. If you are using your own server-blocks, then this environment variable is **NOT** required – it is only used by the container when auto-configuring the default server-blocks.
|
||||
|
||||
If you want to integrate with Let's Encrypt, please refer to the [wiki](https://git.asifbacchus.dev/ab-docker/ab-nginx/wiki).
|
||||
|
||||
Finally, I’d remind you once again that UID 8080 must be able to read your certificate files! It is common practice to restrict the private key to root readability only (i.e. chown root:root & chmod 600/400) but, that would stop the NGINX user in the container from reading it and NGINX will exit with an error. I address ways to allow your certificate files to remain secure but still readable by the NGINX user in the [wiki](https://git.asifbacchus.dev/ab-docker/ab-nginx/wiki).
|
||||
Finally, I’d remind you once again that the container’s UID/GID must be able to read your certificate files! It is common practice to restrict the private key to root readability only (i.e. chown root:root & chmod 600/400) but, that would stop the NGINX user in the container from reading it and NGINX will exit with an error. I address ways to allow your certificate files to remain secure but still readable by the NGINX user in the [wiki](https://git.asifbacchus.dev/ab-docker/ab-nginx/wiki). As a quick hint, it’s easiest to accomplish by changing the container GID!
|
||||
|
||||
### Generate a self-signed certificate
|
||||
|
||||
If you are testing a set-up or for whatever other reason want to use a self-signed certificate, the container can generate one for you. To make integration easier, the container does a trick with the *private key* by generating it with 6**4**0 permissions instead of 600 permissions. This means any member of the same group as the container can use this generated certificate-key pair. However, to make this work, you need to ensure the GID is set properly as mentioned in the [specify UID/GID at runtime](#option-2-specify-uidgid-at-runtime) section above. I’ll use GID=6000 in the following example.
|
||||
|
||||
To generate a certificate, invoke the container with the `generate-cert hostname` parameter. Let’s use server.example.com:
|
||||
|
||||
```bash
|
||||
docker run --rm -v /mycerts:/certs asifbacchus/ab-nginx generate-cert server.example.com
|
||||
```
|
||||
|
||||
In this example, your self-signed certificate (*fullchain.pem*), private key (*privkey.pem*) and certification chain/bundle (*chain.pem*) will be saved, group-readable, in your */mycerts/* directory on the host. Remember to import the certificate on any clients or you will get warnings!
|
||||
|
||||
## Environment variables
|
||||
|
||||
@ -210,14 +254,14 @@ ## Shell mode
|
||||
|
||||
### Drop to shell before NGINX loads
|
||||
|
||||
This is useful to verify where things mounted, etc. This is also useful if some configuration is causing NGINX to panic and shutting down the container. Note that I’m using the `--rm` flag to auto-remove the container when I exit since there is no point in keeping a shell-mode instantiation around.
|
||||
This is useful to verify where things mounted, etc. This is also useful if some configuration is causing NGINX to panic and shut down the container. Note that I’m using the `--rm` flag to auto-remove the container when I exit since there is no point in keeping a shell-mode instantiation around.
|
||||
|
||||
```bash
|
||||
docker run -it --rm \
|
||||
-v ~/web:/usr/share/nginx/html \
|
||||
-v ~/nginx/config:/etc/nginx/config \
|
||||
-v ~/nginx/servers:/etc/nginx/sites \
|
||||
-v ~/certs:/certs \
|
||||
-v ~/certs:/certs:ro \
|
||||
asifbacchus/ab-nginx /bin/sh
|
||||
```
|
||||
|
||||
@ -248,8 +292,8 @@ # show last 10 lines and follow from there in realtime (ctrl-c to stop)
|
||||
|
||||
## Final thoughts
|
||||
|
||||
I think that's everything to get you going if you are already familiar with docker and with NGINX in general. If you need more help, please [refer to the wiki](https://git.asifbacchus.dev/ab-docker/ab-nginx/wiki). I've explained everything there in detail. Also, check out the [helper scripts](https://git.asifbacchus.dev/ab-docker/ab-nginx/releases) especially if you are deploying certificates. The scripts take care of all the docker command-lines for you so you have much less typing!
|
||||
I think that's everything to get you going if you are already familiar with docker and with NGINX in general. If you need more help, please [refer to the wiki](https://git.asifbacchus.dev/ab-docker/ab-nginx/wiki). I've explained everything there in detail. Also, check out the [helper scripts](https://asifbacchus.dev/public/docker/nginx/ab-nginx/) especially if you are deploying certificates. The scripts take care of all the docker command-lines for you so you have much less typing!
|
||||
|
||||
If I've forgotten anything, you find any bugs or you have suggestions, please file an issue either on my private [git server ](https://git.asifbacchus.dev/ab-docker/ab-nginx) or on [github](https://github.com/asifbacchus/ab-nginx). Also, I am *not* affiliated with NGINX in any way, so please **do not** bother them with any issues you find with this container. Bother me instead, I actually enjoy it!
|
||||
If I've forgotten anything, you find any bugs or you have suggestions, please file an issue either on my private [git server](https://git.asifbacchus.dev/ab-docker/ab-nginx) or on [github](https://github.com/asifbacchus/ab-nginx). Also, I am *not* affiliated with NGINX in any way, so please **do not** bother them with any issues you find with this container. Bother me instead, I actually enjoy it!
|
||||
|
||||
**All the best and have fun!**
|
||||
|
||||
Loading…
Reference in New Issue
Block a user