From b2b85e05a4c55120e61f1026d3a7d070ed6e2843 Mon Sep 17 00:00:00 2001 From: LinuxServer-CI Date: Sun, 1 Dec 2024 22:42:27 +0000 Subject: [PATCH] Bot Updating Documentation --- docs/images/docker-wireguard.md | 9 ++++++++- 1 file changed, 8 insertions(+), 1 deletion(-) diff --git a/docs/images/docker-wireguard.md b/docs/images/docker-wireguard.md index d1056e26f..fc64c829d 100644 --- a/docs/images/docker-wireguard.md +++ b/docs/images/docker-wireguard.md @@ -122,6 +122,10 @@ This image can be run with a read-only container filesystem. For details please To help you get started creating a container from this image you can either use docker-compose or the docker cli. +!!! info + + Unless a parameter is flaged as 'optional', it is *mandatory* and a value must be provided. + ### docker-compose (recommended, [click here for more info](https://docs.linuxserver.io/general/docker-compose)) ```yaml @@ -189,7 +193,7 @@ Containers are configured using parameters passed at runtime (such as those abov | Parameter | Function | | :----: | --- | -| `51820/udp` | wireguard port | +| `51820:51820/udp` | wireguard port | ### Environment Variables (`-e`) @@ -219,6 +223,9 @@ Containers are configured using parameters passed at runtime (such as those abov | Parameter | Function | | :-----: | --- | | `--sysctl=` | Required for client mode. | +| `--read-only=true` | Run container with a read-only filesystem. Please [read the docs](https://docs.linuxserver.io/misc/read-only/). | +| `--cap-add=NET_ADMIN` | Neccessary for Wireguard to create its VPN interface. | +| `--cap-add=SYS_MODULE` | Neccessary for loading Wireguard kernel module if it's not already loaded. | ### Portainer notice