Skip to content

Commit b7e6624

Browse files
Bot Updating Templated Files
1 parent 24fb50a commit b7e6624

File tree

1 file changed

+6
-2
lines changed

1 file changed

+6
-2
lines changed

README.md

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -132,7 +132,6 @@ Keep in mind that this var will only be considered when the confs are regenerate
132132

133133
Don't forget to set the necessary POSTUP and POSTDOWN rules in your client's peer conf for lan access.
134134

135-
136135
## Read-Only Operation
137136

138137
This image can be run with a read-only container filesystem. For details please [read the docs](https://docs.linuxserver.io/misc/read-only/).
@@ -146,6 +145,9 @@ This image can be run with a read-only container filesystem. For details please
146145

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

148+
>[!NOTE]
149+
>Unless a parameter is flaged as 'optional', it is *mandatory* and a value must be provided.
150+
149151
### docker-compose (recommended, [click here for more info](https://docs.linuxserver.io/general/docker-compose))
150152

151153
```yaml
@@ -211,7 +213,7 @@ Containers are configured using parameters passed at runtime (such as those abov
211213

212214
| Parameter | Function |
213215
| :----: | --- |
214-
| `-p 51820/udp` | wireguard port |
216+
| `-p 51820:51820/udp` | wireguard port |
215217
| `-e PUID=1000` | for UserID - see below for explanation |
216218
| `-e PGID=1000` | for GroupID - see below for explanation |
217219
| `-e TZ=Etc/UTC` | specify a timezone to use, see this [list](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones#List). |
@@ -227,6 +229,8 @@ Containers are configured using parameters passed at runtime (such as those abov
227229
| `-v /lib/modules` | Host kernel modules for situations where they're not already loaded. |
228230
| `--sysctl=` | Required for client mode. |
229231
| `--read-only=true` | Run container with a read-only filesystem. Please [read the docs](https://docs.linuxserver.io/misc/read-only/). |
232+
| `--cap-add=NET_ADMIN` | Neccessary for Wireguard to create its VPN interface. |
233+
| `--cap-add=SYS_MODULE` | Neccessary for loading Wireguard kernel module if it's not already loaded. |
230234

231235
### Portainer notice
232236

0 commit comments

Comments
 (0)