LAB-linuxserver/docker-wireguard
1
0
Fork 0
mirror of https://github.com/linuxserver/docker-wireguard.git synced 2026-02-20 05:45:43 +08:00
Code Issues Packages Projects Releases Wiki Activity

Bot Updating Templated Files

Browse Source
This commit is contained in:
LinuxServer-CI 2024-12-01 22:40:25 +00:00
parent 4693fa0bb9
commit ce2be2fbc6
No known key found for this signature in database
1 changed files with 6 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
README.md
View File

@ -134,11 +134,13 @@ Keep in mind that this var will only be considered when the confs are regenerate
Don't forget to set the necessary POSTUP and POSTDOWN rules in your client's peer conf for lan access.
## Usage
To help you get started creating a container from this image you can either use docker-compose or the docker cli.
>[!NOTE]
>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
@ -204,7 +206,7 @@ Containers are configured using parameters passed at runtime (such as those abov
| Parameter | Function |
| :----: | --- |
| `-p 51820/udp` | wireguard port |
| `-p 51820:51820/udp` | wireguard port |
| `-e PUID=1000` | for UserID - see below for explanation |
| `-e PGID=1000` | for GroupID - see below for explanation |
| `-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
| `-v /config` | Contains all relevant configuration files. |
| `-v /lib/modules` | Maps host's modules folder. Only required if compiling wireguard modules. |
| `--sysctl=` | Required for client mode. |
| `--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