Compare commits

...

3 Commits

Author SHA1 Message Date
Asif Bacchus
6206ed49ff build(GIT): only include helper scripts in export archives 2021-01-15 06:28:43 -07:00
Asif Bacchus
478af79158 fix(README): fix incorrect link 2021-01-15 06:28:11 -07:00
Asif Bacchus
6f9d0ae7df style(README): force line breaks on contents items 2021-01-15 06:21:34 -07:00
3 changed files with 29 additions and 22 deletions

6
.gitattributes vendored
View File

@ -73,8 +73,12 @@
# #
# Exclude files from exporting # Exclude files from exporting
# only export helper scripts
# #
.gitattributes export-ignore .gitattributes export-ignore
.gitignore export-ignore .gitignore export-ignore
.vscode/* export-ignore .vscode export-ignore
.idea export-ignore
build export-ignore
README.md export-ignore

2
.gitignore vendored
View File

@ -10,4 +10,4 @@
ab-nginx.params ab-nginx.params
# don't track checksums -- no point # don't track checksums -- no point
checksums.sha256* checksums.sha256*

View File

@ -4,23 +4,23 @@ # ab-nginx
## Contents ## Contents
[Alternate repository](#alternate-repository) [Alternate repository](#alternate-repository)<br>
[Documentation and scripts](#documentation-and-scripts) [Documentation and scripts](#documentation-and-scripts)<br>
[Permissions](#permissions) [Permissions](#permissions)<br>
[Container layout](#container-layout) [Container layout](#container-layout)<br>
[Content directory](#content-directory) [Content directory](#content-directory)<br>
[Configuration directory](#configuration-directory) [Configuration directory](#configuration-directory)<br>
[Quick-start](#quick-start) [Quick-start](#quick-start)<br>
[Mounting content](#mounting-content) [Mounting content](#mounting-content)<br>
[Mounting configurations](#mounting-configurations) [Mounting configurations](#mounting-configurations)<br>
[Mounting server-blocks](#mounting-server-blocks) [Mounting server-blocks](#mounting-server-blocks)<br>
[TLS](#tls) [TLS](#tls)<br>
[Environment variables](#environment-variables) [Environment variables](#environment-variables)<br>
[Shell mode](#shell-mode) [Shell mode](#shell-mode)<br>
[Drop to shell before NGINX loads](#drop-to-shell-before-nginx-loads) [Drop to shell before NGINX loads](#drop-to-shell-before-nginx-loads)<br>
[Enter a running container](#enter-a-running-container) [Enter a running container](#enter-a-running-container)<br>
[Logs](#logs) [Logs](#logs)<br>
[Final thoughts](#final-thoughts)#final-thoughts) [Final thoughts](#final-thoughts)
## Alternate repository ## Alternate repository
@ -34,9 +34,13 @@ ## 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.app/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 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.app/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 dont 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 dont 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 youll need to rebuild the container using the [Dockerfile in the git repo](#https://git.asifbacchus.app/ab-docker/ab-nginx). The process would be something like this: If you need to change the UID, then youll need to rebuild the container using
the [Dockerfile in the git repo](https://git.asifbacchus.app/ab-docker/ab-nginx). The process would be something like
this:
```bash ```bash
# clone the repo # clone the repo
@ -249,4 +253,3 @@ ## Final thoughts
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.asifbachus.app/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.asifbachus.app/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!** **All the best and have fun!**