You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Nginx Proxy Manager enables you to easily forward to your websites running at home or otherwise, including free SSL, without having to know too much about Nginx or Letsencrypt.
12
+
Nginx Proxy Manager enables you to easily forward to your websites running at
13
+
home or otherwise, including free SSL, without having to know too much about
14
+
Nginx or Letsencrypt.
11
15
12
16
---
13
17
@@ -17,7 +21,7 @@ Nginx Proxy Manager enables you to easily forward to your websites running at ho
17
21
and parameters should be adjusted to your need.
18
22
19
23
Launch the Nginx Proxy Manager docker container with the following command:
20
-
```
24
+
```shell
21
25
docker run -d \
22
26
--name=nginx-proxy-manager \
23
27
-p 8181:8181 \
@@ -28,7 +32,7 @@ docker run -d \
28
32
```
29
33
30
34
Where:
31
-
-`/docker/appdata/nginx-proxy-manager`: This is where the application stores its configuration, log and any files needing persistency.
35
+
-`/docker/appdata/nginx-proxy-manager`: This is where the application stores its configuration, states, log and any files needing persistency.
32
36
33
37
Browse to `http://your-host-ip:8181` to access the Nginx Proxy Manager web interface.
Nginx Proxy Manager enables you to easily forward to your websites running at home or otherwise, including free SSL, without having to know too much about Nginx or Letsencrypt.
12
+
Nginx Proxy Manager enables you to easily forward to your websites running at
13
+
home or otherwise, including free SSL, without having to know too much about
14
+
Nginx or Letsencrypt.
11
15
12
16
---
13
17
14
18
## Table of Content
15
19
16
-
*[Docker container for Nginx Proxy Manager](#docker-container-for-nginx-proxy-manager)
17
-
* [Table of Content](#table-of-content)
18
-
* [Quick Start](#quick-start)
19
-
* [Usage](#usage)
20
-
* [Environment Variables](#environment-variables)
21
-
* [Data Volumes](#data-volumes)
22
-
* [Ports](#ports)
23
-
* [Changing Parameters of a Running Container](#changing-parameters-of-a-running-container)
|`USER_ID`| ID of the user the application runs as. See [User/Group IDs](#usergroup-ids) to better understand when this should be set. | `1000` |
84
88
|`GROUP_ID`| ID of the group the application runs as. See [User/Group IDs](#usergroup-ids) to better understand when this should be set. | `1000` |
85
-
|`SUP_GROUP_IDS`| Comma-separated list of supplementary group IDs of the application. | (unset) |
86
-
|`UMASK`| Mask that controls how file permissions are set for newly created files. The value of the mask is in octal notation. By default, this variable is not set and the default umask of `022` is used, meaning that newly created files are readable by everyone, but only writable by the owner. See the following online umask calculator: http://wintelguy.com/umask-calc.pl| (unset) |
87
-
|`TZ`|[TimeZone] of the container. Timezone can also be set by mapping `/etc/localtime` between the host and the container. |`Etc/UTC`|
88
-
|`KEEP_APP_RUNNING`| When set to `1`, the application will be automatically restarted if it crashes or if a user quits it. |`0`|
89
-
|`APP_NICENESS`| Priority at which the application should run. A niceness value of -20 is the highest priority and 19 is the lowest priority. By default, niceness is not set, meaning that the default niceness of 0 is used. **NOTE**: A negative niceness (priority increase) requires additional permissions. In this case, the container should be run with the docker option `--cap-add=SYS_NICE`. | (unset) |
90
-
|`CLEAN_TMP_DIR`| When set to `1`, all files in the `/tmp` directory are deleted during the container startup. |`1`|
89
+
|`SUP_GROUP_IDS`| Comma-separated list of supplementary group IDs of the application. | (no value) |
90
+
|`UMASK`| Mask that controls how file permissions are setfornewly created files. The value of the mask isin octal notation. By default, the default umask value is `0022`, meaning that newly created files are readable by everyone, but only writable by the owner. See the online umask calculator at http://wintelguy.com/umask-calc.pl. |`0022`|
91
+
|`LANG`| Set the [locale](https://en.wikipedia.org/wiki/Locale_(computer_software)), which defines the application's language, **if supported**. Format of the locale is `language[_territory][.codeset]`, where language is an [ISO 639 language code](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes), territory is an [ISO 3166 country code](https://en.wikipedia.org/wiki/ISO_3166-1#Current_codes) and codeset is a character set, like `UTF-8`. For example, Australian English using the UTF-8 encoding is `en_AU.UTF-8`. | `en_US.UTF-8` |
92
+
|`TZ`| [TimeZone](http://en.wikipedia.org/wiki/List_of_tz_database_time_zones) used by the container. Timezone can also be set by mapping `/etc/localtime` between the host and the container. | `Etc/UTC` |
93
+
|`KEEP_APP_RUNNING`| When set to `1`, the application will be automatically restarted when it crashes or terminates. | `0` |
94
+
|`APP_NICENESS`| Priority at which the application should run. A niceness value of -20 is the highest priority and 19 is the lowest priority. The default niceness value is 0. **NOTE**: A negative niceness (priority increase) requires additional permissions. In this case, the container should be run with the docker option `--cap-add=SYS_NICE`. | `0` |
95
+
|`INSTALL_PACKAGES`| Space-separated list of packages to install during the startup of the container. Packages are installed from the repository of the Linux distribution this container is based on. **ATTENTION**: Container functionality can be affected when installing a package that overrides existing container files (e.g. binaries). | (no value) |
96
+
|`CONTAINER_DEBUG`| Set to `1` to enable debug logging. | `0` |
91
97
|`DISABLE_IPV6`| When set to `1`, IPv6 support is disabled. This is needed when IPv6 is not enabled/supported on the host. | `0` |
92
98
99
+
#### Deployment Considerations
100
+
101
+
Many tools used to manage Docker containers extract environment variables
102
+
defined by the Docker image and use them to create/deploy the container. For
103
+
example, this is done by:
104
+
- The Docker application on Synology NAS
105
+
- The Container Station on QNAP NAS
106
+
- Portainer
107
+
- etc.
108
+
109
+
While this can be useful for the user to adjust the value of environment
110
+
variables to fit its needs, it can also be confusing and dangerous to keep all
111
+
of them.
112
+
113
+
A good pratice is to set/keep only the variables that are needed for the
114
+
container to behave as desired in a specific setup. If the value of variable is
115
+
kept to its default value, it means that it can be removed. Keep in mind that
116
+
all variables are optional, meaning that none of them is required for the
117
+
container to start.
118
+
119
+
Removing environment variables that are not needed provides some advantages:
120
+
121
+
- Prevents keeping variables that are no longer used by the container. Over
122
+
time, with image updates, some variables might be removed.
123
+
- Allows the Docker image to change/fix a default value. Again, with image
124
+
updates, the default value of a variable might be changed to fix an issue,
125
+
or to better support a new feature.
126
+
- Prevents changes to a variable that might affect the correct function of
127
+
the container. Some undocumented variables, like `PATH` or `ENV`, are
128
+
required to be exposed, but are not meant to be changed by users. However,
129
+
container management tools still show these variables to users.
130
+
- There is a bug with the Container Station on QNAP and the Docker application
131
+
on Synology, where an environment variable without value might not be
132
+
allowed. This behavior is wrong: it's absolutely fine to have a variable
133
+
without value. In fact, this container does have variables without value by
134
+
default. Thus, removing uneeded variables is a good way to prevent
135
+
deployment issue on these devices.
136
+
93
137
### Data Volumes
94
138
95
139
The following table describes data volumes used by the container. The mappings
0 commit comments