Skip to content

Commit a69d541

Browse files
committed
Updated README.
1 parent 9bc78f9 commit a69d541

File tree

1 file changed

+29
-29
lines changed

1 file changed

+29
-29
lines changed

README.md

Lines changed: 29 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -79,15 +79,15 @@ docker run [-d] \
7979
8080
| Parameter | Description |
8181
|-----------|-------------|
82-
| -d | Run the container in the background. If not set, the container runs in the foreground. |
83-
| -e | Pass an environment variable to the container. See the [Environment Variables](#environment-variables) section for more details. |
84-
| -v | Set a volume mapping (allows to share a folder/file between the host and the container). See the [Data Volumes](#data-volumes) section for more details. |
85-
| -p | Set a network port mapping (exposes an internal container port to the host). See the [Ports](#ports) section for more details. |
82+
| -d | Run the container in the background. If not set, the container runs in the foreground. |
83+
| -e | Pass an environment variable to the container. See the [Environment Variables](#environment-variables) section for more details. |
84+
| -v | Set a volume mapping (allows to share a folder/file between the host and the container). See the [Data Volumes](#data-volumes) section for more details. |
85+
| -p | Set a network port mapping (exposes an internal container port to the host). See the [Ports](#ports) section for more details. |
8686
8787
### Environment Variables
8888
8989
To customize some properties of the container, the following environment
90-
variables can be passed via the `-e` parameter (one for each variable). Value
90+
variables can be passed via the `-e` parameter (one for each variable). Value
9191
of this parameter has the format `<VARIABLE_NAME>=<VALUE>`.
9292
9393
| Variable | Description | Default |
@@ -108,7 +108,7 @@ of this parameter has the format `<VARIABLE_NAME>=<VALUE>`.
108108
#### Deployment Considerations
109109
110110
Many tools used to manage Docker containers extract environment variables
111-
defined by the Docker image and use them to create/deploy the container. For
111+
defined by the Docker image and use them to create/deploy the container. For
112112
example, this is done by:
113113
- The Docker application on Synology NAS
114114
- The Container Station on QNAP NAS
@@ -120,33 +120,33 @@ variables to fit its needs, it can also be confusing and dangerous to keep all
120120
of them.
121121
122122
A good practice is to set/keep only the variables that are needed for the
123-
container to behave as desired in a specific setup. If the value of variable is
124-
kept to its default value, it means that it can be removed. Keep in mind that
123+
container to behave as desired in a specific setup. If the value of variable is
124+
kept to its default value, it means that it can be removed. Keep in mind that
125125
all variables are optional, meaning that none of them is required for the
126126
container to start.
127127
128128
Removing environment variables that are not needed provides some advantages:
129129
130-
- Prevents keeping variables that are no longer used by the container. Over
130+
- Prevents keeping variables that are no longer used by the container. Over
131131
time, with image updates, some variables might be removed.
132-
- Allows the Docker image to change/fix a default value. Again, with image
132+
- Allows the Docker image to change/fix a default value. Again, with image
133133
updates, the default value of a variable might be changed to fix an issue,
134134
or to better support a new feature.
135135
- Prevents changes to a variable that might affect the correct function of
136-
the container. Some undocumented variables, like `PATH` or `ENV`, are
137-
required to be exposed, but are not meant to be changed by users. However,
136+
the container. Some undocumented variables, like `PATH` or `ENV`, are
137+
required to be exposed, but are not meant to be changed by users. However,
138138
container management tools still show these variables to users.
139139
- There is a bug with the Container Station on QNAP and the Docker application
140140
on Synology, where an environment variable without value might not be
141-
allowed. This behavior is wrong: it's absolutely fine to have a variable
142-
without value. In fact, this container does have variables without value by
143-
default. Thus, removing unneeded variables is a good way to prevent
141+
allowed. This behavior is wrong: it's absolutely fine to have a variable
142+
without value. In fact, this container does have variables without value by
143+
default. Thus, removing unneeded variables is a good way to prevent
144144
deployment issue on these devices.
145145
146146
### Data Volumes
147147
148-
The following table describes data volumes used by the container. The mappings
149-
are set via the `-v` parameter. Each mapping is specified with the following
148+
The following table describes data volumes used by the container. The mappings
149+
are set via the `-v` parameter. Each mapping is specified with the following
150150
format: `<HOST_DIR>:<CONTAINER_DIR>[:PERMISSIONS]`.
151151
152152
| Container path | Permissions | Description |
@@ -158,8 +158,8 @@ format: `<HOST_DIR>:<CONTAINER_DIR>[:PERMISSIONS]`.
158158
Here is the list of ports used by the container.
159159
160160
When using the default bridge network, ports can be mapped to the host via the
161-
`-p` parameter (one per port mapping). Each mapping is defined with the
162-
following format: `<HOST_PORT>:<CONTAINER_PORT>`. The port number used inside
161+
`-p` parameter (one per port mapping). Each mapping is defined with the
162+
following format: `<HOST_PORT>:<CONTAINER_PORT>`. The port number used inside
163163
the container might not be changeable, but you are free to use any port on the
164164
host side.
165165
@@ -178,7 +178,7 @@ As can be seen, environment variables, volume and port mappings are all specifie
178178
while creating the container.
179179
180180
The following steps describe the method used to add, remove or update
181-
parameter(s) of an existing container. The general idea is to destroy and
181+
parameter(s) of an existing container. The general idea is to destroy and
182182
re-create the container:
183183
184184
1. Stop the container (if it is running):
@@ -205,7 +205,7 @@ docker rm nginx-proxy-manager
205205
Here is an example of a `docker-compose.yml` file that can be used with
206206
[Docker Compose](https://docs.docker.com/compose/overview/).
207207
208-
Make sure to adjust according to your needs. Note that only mandatory network
208+
Make sure to adjust according to your needs. Note that only mandatory network
209209
ports are part of the example.
210210
211211
```yaml
@@ -223,11 +223,11 @@ services:
223223
224224
## Docker Image Versioning
225225
226-
Each release of a Docker image is versioned. Prior to october 2022, the
226+
Each release of a Docker image is versioned. Prior to october 2022, the
227227
[semantic versioning](https://semver.org) was used as the versioning scheme.
228228
229229
Since then, versioning scheme changed to
230-
[calendar versioning](https://calver.org). The format used is `YY.MM.SEQUENCE`,
230+
[calendar versioning](https://calver.org). The format used is `YY.MM.SEQUENCE`,
231231
where:
232232
- `YY` is the zero-padded year (relative to year 2000).
233233
- `MM` is the zero-padded month.
@@ -238,10 +238,10 @@ where:
238238
239239
Because features are added, issues are fixed, or simply because a new version
240240
of the containerized application is integrated, the Docker image is regularly
241-
updated. Different methods can be used to update the Docker image.
241+
updated. Different methods can be used to update the Docker image.
242242
243243
The system used to run the container may have a built-in way to update
244-
containers. If so, this could be your primary way to update Docker images.
244+
containers. If so, this could be your primary way to update Docker images.
245245
246246
An other way is to have the image be automatically updated with [Watchtower].
247247
Watchtower is a container-based solution for automating Docker image updates.
@@ -279,12 +279,12 @@ container image.
279279
2. Click on *Registry* in the left pane.
280280
3. In the search bar, type the name of the container (`jlesage/nginx-proxy-manager`).
281281
4. Select the image, click *Download* and then choose the `latest` tag.
282-
5. Wait for the download to complete. A notification will appear once done.
282+
5. Wait for the download to complete. A notification will appear once done.
283283
6. Click on *Container* in the left pane.
284284
7. Select your Nginx Proxy Manager container.
285285
8. Stop it by clicking *Action*->*Stop*.
286286
9. Clear the container by clicking *Action*->*Reset* (or *Action*->*Clear* if
287-
you don't have the latest *Docker* application). This removes the
287+
you don't have the latest *Docker* application). This removes the
288288
container while keeping its configuration.
289289
10. Start the container again by clicking *Action*->*Start*. **NOTE**: The
290290
container may temporarily disappear from the list while it is re-created.
@@ -300,8 +300,8 @@ For unRAID, a container image can be updated by following these steps:
300300
## User/Group IDs
301301
302302
When using data volumes (`-v` flags), permissions issues can occur between the
303-
host and the container. For example, the user within the container may not
304-
exist on the host. This could prevent the host from properly accessing files
303+
host and the container. For example, the user within the container may not
304+
exist on the host. This could prevent the host from properly accessing files
305305
and folders on the shared volume.
306306
307307
To avoid any problem, you can specify the user the application should run as.

0 commit comments

Comments
 (0)