Skip to content

Commit 8609665

Browse files
committed
Fix admonitions
1 parent c220e53 commit 8609665

2 files changed

Lines changed: 8 additions & 16 deletions

File tree

README.md

Lines changed: 4 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -70,15 +70,13 @@ Mapping `docker.sock` is a potential security liability because docker has root
7070

7171
### Multiple Hosts
7272

73-
>[!NOTE]
74-
>Make sure you fully understand what you're doing before you try and set this up as there are lots of ways it can go wrong if you're just guessing.
73+
?+note[Security](|Make sure you fully understand what you're doing before you try and set this up as there are lots of ways it can go wrong if you're just guessing.|)
7574

7675
Modmanager can query & download mods for remote hosts, as well as the one on which it is installed. At a very basic level if you're just using the `DOCKER_MODS` env and not docker discovery, simply mount the `/modcache` folder on your remote host(s), ensuring it is mapped for all participating containers.
7776

7877
If you are using docker discovery, our only supported means for connecting to remote hosts is [our socket proxy container](https://github.com/linuxserver/docker-socket-proxy/). Run an instance on each remote host:
7978

80-
>[!WARNING]
81-
>DO NOT expose a socket proxy to your LAN if it allows any write operations (`POST=1`, `ALLOW_RESTART=1`, etc) or exposes any API elements that are not absolutely necessary. NEVER expose a socket proxy to your WAN.
79+
?+warning[Security](|DO NOT expose a socket proxy to your LAN if it allows any write operations (`POST=1`, `ALLOW_RESTART=1`, etc) or exposes any API elements that are not absolutely necessary. NEVER expose a socket proxy to your WAN.|)
8280

8381
```yml
8482
modmanager-dockerproxy:
@@ -109,8 +107,7 @@ As above you will need to mount the `/modcache` folder on your remote host(s), e
109107

110108
To help you get started creating a container from this image you can either use docker compose or the docker cli.
111109

112-
>[!NOTE]
113-
>Unless a parameter is flaged as 'optional', it is *mandatory* and a value must be provided.
110+
?+note[Params](|Unless a parameter is flaged as 'optional', it is *mandatory* and a value must be provided.|)
114111

115112
### docker compose (recommended, [click here for more info](https://docs.linuxserver.io/general/docker-compose))
116113

@@ -250,8 +247,7 @@ docker image prune
250247

251248
### Image Update Notifications - Diun (Docker Image Update Notifier)
252249

253-
>[!TIP]
254-
>We recommend [Diun](https://crazymax.dev/diun/) for update notifications. Other tools that automatically update containers unattended are not recommended or supported.
250+
?+tip[Diun](|We recommend [Diun](https://crazymax.dev/diun/) for update notifications. Other tools that automatically update containers unattended are not recommended or supported.|)
255251

256252
## Building locally
257253

readme-vars.yml

Lines changed: 4 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -74,15 +74,13 @@ full_custom_readme: |
7474
7575
### Multiple Hosts
7676
77-
>[!NOTE]
78-
>Make sure you fully understand what you're doing before you try and set this up as there are lots of ways it can go wrong if you're just guessing.
77+
?+note[Security](|Make sure you fully understand what you're doing before you try and set this up as there are lots of ways it can go wrong if you're just guessing.|)
7978
8079
Modmanager can query & download mods for remote hosts, as well as the one on which it is installed. At a very basic level if you're just using the `DOCKER_MODS` env and not docker discovery, simply mount the `/modcache` folder on your remote host(s), ensuring it is mapped for all participating containers.
8180
8281
If you are using docker discovery, our only supported means for connecting to remote hosts is [our socket proxy container](https://github.com/linuxserver/docker-socket-proxy/). Run an instance on each remote host:
8382
84-
>[!WARNING]
85-
>DO NOT expose a socket proxy to your LAN if it allows any write operations (`POST=1`, `ALLOW_RESTART=1`, etc) or exposes any API elements that are not absolutely necessary. NEVER expose a socket proxy to your WAN.
83+
?+warning[Security](|DO NOT expose a socket proxy to your LAN if it allows any write operations (`POST=1`, `ALLOW_RESTART=1`, etc) or exposes any API elements that are not absolutely necessary. NEVER expose a socket proxy to your WAN.|)
8684
8785
```yml
8886
modmanager-dockerproxy:
@@ -113,8 +111,7 @@ full_custom_readme: |
113111
114112
To help you get started creating a container from this image you can either use docker compose or the docker cli.
115113
116-
>[!NOTE]
117-
>Unless a parameter is flaged as 'optional', it is *mandatory* and a value must be provided.
114+
?+note[Params](|Unless a parameter is flaged as 'optional', it is *mandatory* and a value must be provided.|)
118115
119116
### docker compose (recommended, [click here for more info](https://docs.linuxserver.io/general/docker-compose))
120117
@@ -254,8 +251,7 @@ full_custom_readme: |
254251
255252
### Image Update Notifications - Diun (Docker Image Update Notifier)
256253
257-
>[!TIP]
258-
>We recommend [Diun](https://crazymax.dev/diun/) for update notifications. Other tools that automatically update containers unattended are not recommended or supported.
254+
?+tip[Diun](|We recommend [Diun](https://crazymax.dev/diun/) for update notifications. Other tools that automatically update containers unattended are not recommended or supported.|)
259255
260256
## Building locally
261257

0 commit comments

Comments
 (0)