Skip to content

Commit ce4c462

Browse files
committed
Lots of formatting and content tweaks
1 parent 78cdd38 commit ce4c462

2 files changed

Lines changed: 38 additions & 38 deletions

File tree

README.md

Lines changed: 19 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -52,7 +52,7 @@ The architectures supported by this image are:
5252

5353
## Application Setup
5454

55-
You can specify mods to download via the `DOCKER_MODS` environment variable like any other container, or allow discovery through docker by mounting the docker socket into the container (or configuring a suitable alternative endpoint via DOCKER_HOST).
55+
You can specify mods to download via the `DOCKER_MODS` environment variable like any other container, or allow discovery through docker by mounting the docker socket into the container (or configuring a suitable alternative endpoint via the built-in `DOCKER_HOST` environment variable).
5656

5757
The Modmanager container will download all needed mods on startup and then check for updates every 6 hours; if you're using docker discovery it will automatically pick up any new mods.
5858

@@ -64,38 +64,38 @@ Note that the Modmanager container itself does not support applying mods *or* cu
6464

6565
### Security considerations
6666

67-
Mapping `docker.sock` is a potential security liability because docker has root access on the host and any process that has full access to `docker.sock` would also have root access on the host. Docker api has no built-in way to set limitations on access, however, you can use a proxy for the `docker.sock` via a solution like [our docker socket proxy](https://github.com/linuxserver/docker-socket-proxy), which adds the ability to limit access. Then you would just set `DOCKER_HOST=` environment variable to point to the proxy address.
67+
Mapping `docker.sock` is a potential security liability because docker has root access on the host and any process that has full access to `docker.sock` would therefore also have root access on the host. The docker API has no built-in way to set limitations on access, however, you can use a proxy for `docker.sock` via a solution like [our docker socket proxy](https://github.com/linuxserver/docker-socket-proxy), which adds the ability to limit API access to specific endpoints.
6868

6969
### Multiple Hosts
7070

7171
>[!NOTE]
7272
>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.
7373
74-
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 the docker integration, simply mount the `/modcache` folder on your remote host(s), ensuring it is mapped for all participating containers.
74+
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 the docker integration, simply mount the `/modcache` folder on your remote host(s), ensuring it is mapped for all participating containers.
7575

76-
If you are using the docker integration, our only supported means for connecting to remote hosts is [our socket proxy container](). Run an instance on each remote host:
76+
If you are using the docker integration, 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:
7777

7878
>[!WARNING]
79-
>DO NOT expose a socket proxy to your LAN that allows any write operations (`POST=1`, `ALLOW_RESTART=1`, etc) or that exposes any more information than is absolutely necessary. NEVER expose a socket proxy to your WAN.
79+
>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.
8080
8181
```yml
8282
modmanager-dockerproxy:
83-
image: lscr.io/linuxserver/socket-proxy:latest
84-
container_name: modmanager-dockerproxy
85-
environment:
86-
- CONTAINERS=1
87-
- POST=0
88-
volumes:
89-
- /var/run/docker.sock:/var/run/docker.sock:ro
90-
tmpfs:
91-
- /run:exec
92-
ports:
93-
- 2375:2375
94-
restart: unless-stopped
95-
read_only: true
83+
image: lscr.io/linuxserver/socket-proxy:latest
84+
container_name: modmanager-dockerproxy
85+
environment:
86+
- CONTAINERS=1
87+
- POST=0
88+
volumes:
89+
- /var/run/docker.sock:/var/run/docker.sock:ro
90+
tmpfs:
91+
- /run:exec
92+
ports:
93+
- 2375:2375
94+
restart: unless-stopped
95+
read_only: true
9696
```
9797
98-
And then add it to the `DOCKER_MODS_EXTRA_HOSTS` env using the full protocol and port, e.g.
98+
And then add it to the `DOCKER_MODS_EXTRA_HOSTS` env using the full protocol and port, separating multiple servers with a pipe (`\|`), e.g.
9999

100100
```yaml
101101
- DOCKER_MODS_EXTRA_HOSTS=tcp://host1.example.com:2375|tcp://host2.example.com:2375|tcp://192.168.0.5:2375

readme-vars.yml

Lines changed: 19 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -56,7 +56,7 @@ full_custom_readme: |
5656
5757
## Application Setup
5858
59-
You can specify mods to download via the `DOCKER_MODS` environment variable like any other container, or allow discovery through docker by mounting the docker socket into the container (or configuring a suitable alternative endpoint via DOCKER_HOST).
59+
You can specify mods to download via the `DOCKER_MODS` environment variable like any other container, or allow discovery through docker by mounting the docker socket into the container (or configuring a suitable alternative endpoint via the built-in `DOCKER_HOST` environment variable).
6060
6161
The Modmanager container will download all needed mods on startup and then check for updates every 6 hours; if you're using docker discovery it will automatically pick up any new mods.
6262
@@ -68,38 +68,38 @@ full_custom_readme: |
6868
6969
### Security considerations
7070
71-
Mapping `docker.sock` is a potential security liability because docker has root access on the host and any process that has full access to `docker.sock` would also have root access on the host. Docker api has no built-in way to set limitations on access, however, you can use a proxy for the `docker.sock` via a solution like [our docker socket proxy](https://github.com/linuxserver/docker-socket-proxy), which adds the ability to limit access. Then you would just set `DOCKER_HOST=` environment variable to point to the proxy address.
71+
Mapping `docker.sock` is a potential security liability because docker has root access on the host and any process that has full access to `docker.sock` would therefore also have root access on the host. The docker API has no built-in way to set limitations on access, however, you can use a proxy for `docker.sock` via a solution like [our docker socket proxy](https://github.com/linuxserver/docker-socket-proxy), which adds the ability to limit API access to specific endpoints.
7272
7373
### Multiple Hosts
7474
7575
>[!NOTE]
7676
>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.
7777
78-
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 the docker integration, simply mount the `/modcache` folder on your remote host(s), ensuring it is mapped for all participating containers.
78+
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 the docker integration, simply mount the `/modcache` folder on your remote host(s), ensuring it is mapped for all participating containers.
7979
80-
If you are using the docker integration, our only supported means for connecting to remote hosts is [our socket proxy container](). Run an instance on each remote host:
80+
If you are using the docker integration, 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:
8181
8282
>[!WARNING]
83-
>DO NOT expose a socket proxy to your LAN that allows any write operations (`POST=1`, `ALLOW_RESTART=1`, etc) or that exposes any more information than is absolutely necessary. NEVER expose a socket proxy to your WAN.
83+
>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.
8484
8585
```yml
8686
modmanager-dockerproxy:
87-
image: lscr.io/linuxserver/socket-proxy:latest
88-
container_name: modmanager-dockerproxy
89-
environment:
90-
- CONTAINERS=1
91-
- POST=0
92-
volumes:
93-
- /var/run/docker.sock:/var/run/docker.sock:ro
94-
tmpfs:
95-
- /run:exec
96-
ports:
97-
- 2375:2375
98-
restart: unless-stopped
99-
read_only: true
87+
image: lscr.io/linuxserver/socket-proxy:latest
88+
container_name: modmanager-dockerproxy
89+
environment:
90+
- CONTAINERS=1
91+
- POST=0
92+
volumes:
93+
- /var/run/docker.sock:/var/run/docker.sock:ro
94+
tmpfs:
95+
- /run:exec
96+
ports:
97+
- 2375:2375
98+
restart: unless-stopped
99+
read_only: true
100100
```
101101
102-
And then add it to the `DOCKER_MODS_EXTRA_HOSTS` env using the full protocol and port, e.g.
102+
And then add it to the `DOCKER_MODS_EXTRA_HOSTS` env using the full protocol and port, separating multiple servers with a pipe (`\|`), e.g.
103103
104104
```yaml
105105
- DOCKER_MODS_EXTRA_HOSTS=tcp://host1.example.com:2375|tcp://host2.example.com:2375|tcp://192.168.0.5:2375

0 commit comments

Comments
 (0)