Skip to content

Commit 5750dd4

Browse files
committed
Added missing language to code blocks and adjusted notes for better compatibility with mkdocs.
1 parent 1c855a1 commit 5750dd4

File tree

2 files changed

+25
-15
lines changed

2 files changed

+25
-15
lines changed

DOCKERHUB.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -23,8 +23,9 @@ Nginx or Letsencrypt.
2323

2424
## Quick Start
2525

26-
**NOTE**: The Docker command provided in this quick start is given as an example
27-
and parameters should be adjusted to your need.
26+
**NOTE**:
27+
The Docker command provided in this quick start is given as an example
28+
and parameters should be adjusted to your need.
2829

2930
Launch the Nginx Proxy Manager docker container with the following command:
3031
```shell
@@ -38,6 +39,7 @@ docker run -d \
3839
```
3940

4041
Where:
42+
4143
- `/docker/appdata/nginx-proxy-manager`: This is where the application stores its configuration, states, log and any files needing persistency.
4244

4345
Browse to `http://your-host-ip:8181` to access the Nginx Proxy Manager web interface.

README.md

Lines changed: 21 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -45,8 +45,9 @@ Nginx or Letsencrypt.
4545

4646
## Quick Start
4747

48-
**NOTE**: The Docker command provided in this quick start is given as an example
49-
and parameters should be adjusted to your need.
48+
**NOTE**:
49+
The Docker command provided in this quick start is given as an example
50+
and parameters should be adjusted to your need.
5051

5152
Launch the Nginx Proxy Manager docker container with the following command:
5253
```shell
@@ -60,6 +61,7 @@ docker run -d \
6061
```
6162

6263
Where:
64+
6365
- `/docker/appdata/nginx-proxy-manager`: This is where the application stores its configuration, states, log and any files needing persistency.
6466

6567
Browse to `http://your-host-ip:8181` to access the Nginx Proxy Manager web interface.
@@ -179,20 +181,23 @@ parameter(s) of an existing container. The general idea is to destroy and
179181
re-create the container:
180182
181183
1. Stop the container (if it is running):
182-
```
184+
```shell
183185
docker stop nginx-proxy-manager
184186
```
187+
185188
2. Remove the container:
186-
```
189+
```shell
187190
docker rm nginx-proxy-manager
188191
```
192+
189193
3. Create/start the container using the `docker run` command, by adjusting
190194
parameters as needed.
191195
192-
**NOTE**: Since all application's data is saved under the `/config` container
193-
folder, destroying and re-creating a container is not a problem: nothing is lost
194-
and the application comes back with the same state (as long as the mapping of
195-
the `/config` folder remains the same).
196+
**NOTE**:
197+
Since all application's data is saved under the `/config` container
198+
folder, destroying and re-creating a container is not a problem: nothing is
199+
lost and the application comes back with the same state (as long as the
200+
mapping of the `/config` folder remains the same).
196201
197202
## Docker Compose File
198203
@@ -245,17 +250,20 @@ Watchtower will seamlessly perform the necessary steps to update the container.
245250
Finally, the Docker image can be manually updated with these steps:
246251
247252
1. Fetch the latest image:
248-
```
253+
```shell
249254
docker pull jlesage/nginx-proxy-manager
250255
```
256+
251257
2. Stop the container:
252-
```
258+
```shell
253259
docker stop nginx-proxy-manager
254260
```
261+
255262
3. Remove the container:
256-
```
263+
```shell
257264
docker rm nginx-proxy-manager
258265
```
266+
259267
4. Create and start the container using the `docker run` command, with the
260268
the same parameters that were used when it was deployed initially.
261269
@@ -306,7 +314,7 @@ user owning the data volume on the host:
306314
id <username>
307315
308316
Which gives an output like this one:
309-
```
317+
```text
310318
uid=1000(myuser) gid=1000(myuser) groups=1000(myuser),4(adm),24(cdrom),27(sudo),46(plugdev),113(lpadmin)
311319
```
312320
@@ -318,7 +326,7 @@ be given the container.
318326
Assuming that container's ports are mapped to the same host's ports, the
319327
interface of the application can be accessed with a web browser at:
320328
321-
```
329+
```text
322330
http://<HOST IP ADDR>:8181
323331
```
324332

0 commit comments

Comments
 (0)