Skip to content

Commit ce2be2f

Browse files
Bot Updating Templated Files
1 parent 4693fa0 commit ce2be2f

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
@@ -134,11 +134,13 @@ Keep in mind that this var will only be considered when the confs are regenerate
134134

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

137-
138137
## Usage
139138

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

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

144146
```yaml
@@ -204,7 +206,7 @@ Containers are configured using parameters passed at runtime (such as those abov
204206

205207
| Parameter | Function |
206208
| :----: | --- |
207-
| `-p 51820/udp` | wireguard port |
209+
| `-p 51820:51820/udp` | wireguard port |
208210
| `-e PUID=1000` | for UserID - see below for explanation |
209211
| `-e PGID=1000` | for GroupID - see below for explanation |
210212
| `-e TZ=Etc/UTC` | specify a timezone to use, see this [list](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones#List). |
@@ -219,6 +221,8 @@ Containers are configured using parameters passed at runtime (such as those abov
219221
| `-v /config` | Contains all relevant configuration files. |
220222
| `-v /lib/modules` | Maps host's modules folder. Only required if compiling wireguard modules. |
221223
| `--sysctl=` | Required for client mode. |
224+
| `--cap-add=NET_ADMIN` | Neccessary for Wireguard to create its VPN interface. |
225+
| `--cap-add=SYS_MODULE` | Neccessary for loading Wireguard kernel module if it's not already loaded. |
222226

223227
### Portainer notice
224228

0 commit comments

Comments
 (0)