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
Copy file name to clipboardExpand all lines: README.md
+3-3Lines changed: 3 additions & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -3,10 +3,10 @@
3
3
This mod gives SWAG the ability to auto-detect running containers via labels and automatically enable reverse proxy for them.
4
4
5
5
## Requirements:
6
-
- This mod needs the [universal-docker mod](https://github.com/linuxserver/docker-mods/tree/universal-docker) installed and set up with either mapping `docker.sock` or setting the environment variable `DOCKER_HOST=remoteaddress`.
6
+
- This mod needs either mapping `docker.sock` or setting the environment variable `DOCKER_HOST=remoteaddress` (see section below for [security consideration](#security-consideration)).
7
7
- Other containers to be auto-detected and reverse proxied should be in the same [user defined bridge network](https://docs.linuxserver.io/general/swag#docker-networking) as SWAG.
8
8
- Containers to be auto-detected and reverse proxied must have a label `swag=enable` at a minimum.
9
-
- To benefit from curated preset proxy confs we provide, the container name must match the container names that are suggested in our readme examples (ie. `radarr` and not `Radarr-4K`).
9
+
- To benefit from curated preset proxy confs we provide, either the container name must match the container names that are suggested in our readme examples (ie. `radarr` and not `Radarr-4K`), or the `swag_preset_conf` label must be set.
10
10
11
11
## Labels:
12
12
-`swag=enable` - required for auto-detection
@@ -21,7 +21,7 @@ This mod gives SWAG the ability to auto-detect running containers via labels and
21
21
-`swag_preset_conf=confname` - *optional* - allows defining a preset conf to use if the container name does not match one (if the conf name is `radarr.subdomain.conf.sample`, set this value to `radarr`). If the container name matches an existing conf, this var will be ignored.
22
22
23
23
24
-
In SWAG docker arguments, set an environment variable `DOCKER_MODS=linuxserver/mods:universal-docker|linuxserver/mods:swag-auto-proxy` and either add a volume mapping for `/var/run/docker.sock:/var/run/docker.sock:ro`, or set an environment var `DOCKER_HOST=remoteaddress`.
24
+
In SWAG docker arguments, set an environment variable `DOCKER_MODS=linuxserver/mods:swag-auto-proxy` and either add a volume mapping for `/var/run/docker.sock:/var/run/docker.sock:ro`, or set an environment var `DOCKER_HOST=remoteaddress`.
25
25
26
26
## Security Consideration:
27
27
Mapping the `docker.sock`, especially in a publicly accessible container is a security liability. Since this mod only needs read-only access to the docker api, the recommended method is to proxy the `docker.sock` via a solution like [our docker socket proxy](https://github.com/linuxserver/docker-socket-proxy), limit the access, and set `DOCKER_HOST=` to point to the proxy address.
0 commit comments