[](https://github.com/linuxserver "view the source for all of our repositories.")
[](https://github.com/linuxserver "view the source for all of our repositories.")
[](https://opencollective.com/linuxserver "please consider helping us by either donating or contributing to our budget")
[](https://opencollective.com/linuxserver "please consider helping us by either donating or contributing to our budget")
The [LinuxServer.io](https://linuxserver.io) team brings you another container release featuring:-
The [LinuxServer.io](https://linuxserver.io) team brings you another container release featuring:
* regular and timely application updates
* regular and timely application updates
* easy user mappings (PGID, PUID)
* easy user mappings (PGID, PUID)
@ -71,6 +71,7 @@ docker create \
-e SERVERPORT=51820 `#optional` \
-e SERVERPORT=51820 `#optional` \
-e PEERS=1 `#optional` \
-e PEERS=1 `#optional` \
-e PEERDNS=8.8.8.8 `#optional` \
-e PEERDNS=8.8.8.8 `#optional` \
-e INTERNAL_SUBNET=10.13.13.0 `#optional` \
-p 51820:51820/udp \
-p 51820:51820/udp \
-v /path/to/appdata/config:/config \
-v /path/to/appdata/config:/config \
-v /lib/modules:/lib/modules \
-v /lib/modules:/lib/modules \
@ -85,6 +86,7 @@ docker create \
Compatible with docker-compose v2 schemas.
Compatible with docker-compose v2 schemas.
```
```
---
version: "2.1"
version: "2.1"
services:
services:
wireguard:
wireguard:
@ -101,6 +103,7 @@ services:
- SERVERPORT=51820 #optional
- SERVERPORT=51820 #optional
- PEERS=1 #optional
- PEERS=1 #optional
- PEERDNS=8.8.8.8 #optional
- PEERDNS=8.8.8.8 #optional
- INTERNAL_SUBNET=10.13.13.0 #optional
volumes:
volumes:
- /path/to/appdata/config:/config
- /path/to/appdata/config:/config
- /lib/modules:/lib/modules
- /lib/modules:/lib/modules
@ -109,7 +112,6 @@ services:
sysctls:
sysctls:
- net.ipv4.conf.all.src_valid_mark=1
- net.ipv4.conf.all.src_valid_mark=1
restart: unless-stopped
restart: unless-stopped
```
```
## Parameters
## Parameters
@ -122,10 +124,11 @@ Container images are configured using parameters passed at runtime (such as thos
| `-e PUID=1000` | for UserID - see below for explanation |
| `-e PUID=1000` | for UserID - see below for explanation |
| `-e PGID=1000` | for GroupID - see below for explanation |
| `-e PGID=1000` | for GroupID - see below for explanation |
| `-e TZ=Europe/London` | Specify a timezone to use EG Europe/London |
| `-e TZ=Europe/London` | Specify a timezone to use EG Europe/London |
| `-e SERVERURL=wireguard.domain.com` | External IP or domain name for docker host. Required for server mode. |
| `-e SERVERURL=wireguard.domain.com` | External IP or domain name for docker host. Used in server mode. If set to `auto`, the container will try to determine and set the external IP automatically |
| `-e SERVERPORT=51820` | External port for docker host. Required for server mode. |
| `-e SERVERPORT=51820` | External port for docker host. Used in server mode. |
| `-e PEERS=1` | Number of peers to create confs for. Required for server mode. |
| `-e PEERS=1` | Number of peers to create confs for. Required for server mode. |
| `-e PEERDNS=8.8.8.8` | DNS server set in peer/client configs. |
| `-e PEERDNS=8.8.8.8` | DNS server set in peer/client configs. Used in server mode. |
| `-e INTERNAL_SUBNET=10.13.13.0` | Internal subnet for the wireguard and server and peers (only change if it clashes). Used in server mode. |
| `-v /config` | Contains all relevant configuration files. |
| `-v /config` | Contains all relevant configuration files. |
@ -166,17 +169,24 @@ If you're on a debian/ubuntu based host with a custom or downstream distro provi
This can be run as a server or a client, based on the parameters used.
This can be run as a server or a client, based on the parameters used.
## Server Mode
## Server Mode
Pass the environment variables `SERVERURL`, `SERVERPORT`, `PEERS` and `PEERDNS`, and the container will generate all necessary confs for both the server and the clients. The client config qr codes will be output in the docker log. They will also be saved in text and png format under `/config/peerX`.
If the environment variable `PEERS` is set to a number, the container will run in server mode and the necessary server and peer/client confs will be generated. The peer/client config qr codes will be output in the docker log. They will also be saved in text and png format under `/config/peerX`.
Variables `SERVERURL`, `SERVERPORT`, `INTERNAL_SUBNET` and `PEERDNS` are optional variables used for server mode. Any changes to these environment variables will trigger regeneration of server and peer confs. Peer/client confs will be recreated with existing private/public keys. Delete the peer folders for the keys to be recreated along with the confs.
If there is an existing `/config/wg0.conf`, the above environment variables won't have any affect. To add more peers/clients later on, you can run `docker exec -it wireguard /app/add-peer` while the container is running.
To add more peers/clients later on, you can run `docker exec -it wireguard /app/add-peer` while the container is running.
To display the QR codes of active peers again, you can use the following command and list the peer numbers as arguments: `docker exec -it wireguard /app/show-peer 1 4 5` (Keep in mind that the QR codes are also stored as PNGs in the config folder).
To display the QR codes of active peers again, you can use the following command and list the peer numbers as arguments: `docker exec -it wireguard /app/show-peer 1 4 5` (Keep in mind that the QR codes are also stored as PNGs in the config folder).
To recreate all server and client confs, set the above env vars, delete `/config/wg0.conf` and restart the container. Client confs will be recreated with existing private/public keys. Delete the peer folders for the keys to be recreated along with the confs.
The templates used for server and peer confs are saved under `/config/templates`. Advanced users can modify these templates and force conf generation by deleting `/config/wg0.conf` and restarting the container.
## Client Mode
## Client Mode
Drop your client conf into the config folder as `/config/wg0.conf` and start the container.
Do not set the `PEERS` environment variable. Drop your client conf into the config folder as `/config/wg0.conf` and start the container.
## Docker Mods
[](https://mods.linuxserver.io/?mod=wireguard "view available mods for this container.")
We publish various [Docker Mods](https://github.com/linuxserver/docker-mods) to enable additional functionality within the containers. The list of Mods available for this image (if any) can be accessed via the dynamic badge above.
## Support Info
## Support Info
@ -243,5 +253,6 @@ Once registered you can define the dockerfile to use with `-f Dockerfile.aarch64
## Versions
## Versions
* **05.04.20:** - Add `INTERNAL_SUBNET` variable to prevent subnet clashes. Add templates for server and peer confs.
* **01.04.20:** - Add `show-peer` script and include info on host installed headers.
* **01.04.20:** - Add `show-peer` script and include info on host installed headers.
- {name:"sysctl", name_compose:"sysctls", value:"net.ipv4.conf.all.src_valid_mark=1", desc:"Required for client mode."}
- {name:"sysctl", name_compose:"sysctls", value:["net.ipv4.conf.all.src_valid_mark=1"], desc:"Required for client mode.", array:"true"}
# optional container parameters
# optional container parameters
opt_param_usage_include_env:true
opt_param_usage_include_env:true
opt_param_env_vars:
opt_param_env_vars:
- {env_var:"SERVERURL", env_value:"wireguard.domain.com", desc:"External IP or domain name for docker host. Required for server mode."}
- {env_var:"SERVERURL", env_value:"wireguard.domain.com", desc:"External IP or domain name for docker host. Used in server mode. If set to `auto`, the container will try to determine and set the external IP automatically"}
- {env_var:"SERVERPORT", env_value:"51820", desc:"External port for docker host. Required for server mode."}
- {env_var:"SERVERPORT", env_value:"51820", desc:"External port for docker host. Used in server mode."}
- {env_var:"PEERS", env_value:"1", desc:"Number of peers to create confs for. Required for server mode."}
- {env_var:"PEERS", env_value:"1", desc:"Number of peers to create confs for. Required for server mode."}
- {env_var:"PEERDNS", env_value:"8.8.8.8", desc:"DNS server set in peer/client configs."}
- {env_var:"PEERDNS", env_value:"8.8.8.8", desc:"DNS server set in peer/client configs. Used in server mode."}
- {env_var:"INTERNAL_SUBNET", env_value:"10.13.13.0", desc:"Internal subnet for the wireguard and server and peers (only change if it clashes). Used in server mode."}
optional_block_1:false
optional_block_1:false
optional_block_1_items:""
optional_block_1_items:""
custom_compose:|
version:"2.1"
services:
wireguard:
image:linuxserver/wireguard
container_name:wireguard
cap_add:
- NET_ADMIN
- SYS_MODULE
environment:
- PUID=1000
- PGID=1000
- TZ=Europe/London
- SERVERURL=wireguard.domain.com#optional
- SERVERPORT=51820#optional
- PEERS=1#optional
- PEERDNS=8.8.8.8#optional
volumes:
- /path/to/appdata/config:/config
- /lib/modules:/lib/modules
ports:
- 51820:51820/udp
sysctls:
- net.ipv4.conf.all.src_valid_mark=1
restart:unless-stopped
# application setup block
# application setup block
app_setup_block_enabled:true
app_setup_block_enabled:true
app_setup_block:|
app_setup_block:|
@ -84,18 +59,21 @@ app_setup_block: |
This can be run as a server or a client, based on the parameters used.
This can be run as a server or a client, based on the parameters used.
## Server Mode
## Server Mode
Pass the environment variables `SERVERURL`, `SERVERPORT`, `PEERS` and `PEERDNS`, and the container will generate all necessary confs for both the server and the clients. The client config qr codes will be output in the docker log. They will also be saved in text and png format under `/config/peerX`.
If the environment variable `PEERS` is set to a number, the container will run in server mode and the necessary server and peer/client confs will be generated. The peer/client config qr codes will be output in the docker log. They will also be saved in text and png format under `/config/peerX`.
Variables `SERVERURL`, `SERVERPORT`, `INTERNAL_SUBNET` and `PEERDNS` are optional variables used for server mode. Any changes to these environment variables will trigger regeneration of server and peer confs. Peer/client confs will be recreated with existing private/public keys. Delete the peer folders for the keys to be recreated along with the confs.
If there is an existing `/config/wg0.conf`, the above environment variables won't have any affect. To add more peers/clients later on, you can run `docker exec -it wireguard /app/add-peer` while the container is running.
To add more peers/clients later on, you can run `docker exec -it wireguard /app/add-peer` while the container is running.
To display the QR codes of active peers again, you can use the following command and list the peer numbers as arguments:`docker exec -it wireguard /app/show-peer 1 4 5` (Keep in mind that the QR codes are also stored as PNGs in the config folder).
To display the QR codes of active peers again, you can use the following command and list the peer numbers as arguments:`docker exec -it wireguard /app/show-peer 1 4 5` (Keep in mind that the QR codes are also stored as PNGs in the config folder).
To recreate all server and client confs, set the above env vars, delete `/config/wg0.conf` and restart the container. Client confs will be recreated with existing private/public keys. Delete the peer folders for the keys to be recreated along with the confs.
The templates used for server and peer confs are saved under `/config/templates`. Advanced users can modify these templates and force conf generation by deleting `/config/wg0.conf` and restarting the container.
## Client Mode
## Client Mode
Drop your client conf into the config folder as `/config/wg0.conf` and start the container.
Do not set the `PEERS` environment variable. Drop your client conf into the config folder as `/config/wg0.conf` and start the container.
# changelog
# changelog
changelogs:
changelogs:
- {date:"05.04.20:", desc:"Add `INTERNAL_SUBNET` variable to prevent subnet clashes. Add templates for server and peer confs."}
- {date:"01.04.20:", desc:"Add `show-peer` script and include info on host installed headers."}
- {date:"01.04.20:", desc:"Add `show-peer` script and include info on host installed headers."}
aptalca
4 years ago
committed by
GitHub