64 lines
3.2 KiB
Markdown
64 lines
3.2 KiB
Markdown
# Wireguard
|
|
|
|
This is a simple Docker image to run a Wireguard client. It includes a kill switch to ensure that any traffic not encrypted via Wireguard is dropped.
|
|
|
|
Wireguard is implemented as a kernel module, which is key to its performance and simplicity. However, this means that Wireguard _must_ be installed on the host operating system for this container to work properly. Instructions for installing Wireguard can be found [here](http://wireguard.com/install).
|
|
|
|
You will need a configuration file for your Wireguard interface. Many VPN providers will create this configuration file for you. For example, [here](http://mullvad.net/en/download/wireguard-config) is the configuration generator for Mullvad. Be sure to NOT include a kill switch in the configuration file, since the Docker image already has one.
|
|
|
|
Now simply mount the configuration file and run! For example, if your configuration file is located at `/path/to/conf/mullvad.conf`:
|
|
|
|
```bash
|
|
docker run --name wireguard \
|
|
--cap-add NET_ADMIN \
|
|
--cap-add SYS_MODULE \
|
|
--sysctl net.ipv4.conf.all.src_valid_mark=1 \
|
|
-v /path/to/conf/mullvad.conf:/etc/wireguard/mullvad.conf \
|
|
jordanpotter/wireguard
|
|
```
|
|
|
|
Afterwards, you can link other containers to this one:
|
|
|
|
```bash
|
|
docker run -it --rm \
|
|
--net=container:wireguard \
|
|
appropriate/curl http://httpbin.org/ip
|
|
```
|
|
|
|
## Local Network
|
|
|
|
If you wish to allow traffic to your local network, specify the subnet using the `LOCAL_NETWORK` environment variable:
|
|
|
|
```bash
|
|
docker run --name wireguard \
|
|
--cap-add NET_ADMIN \
|
|
--cap-add SYS_MODULE \
|
|
--sysctl net.ipv4.conf.all.src_valid_mark=1 \
|
|
-v /path/to/conf/mullvad.conf:/etc/wireguard/mullvad.conf \
|
|
-e LOCAL_NETWORK=10.0.0.0/8 \
|
|
jordanpotter/wireguard
|
|
```
|
|
|
|
Additionally, you can expose ports to allow your local network to access services linked to the Wireguard container:
|
|
|
|
```bash
|
|
docker run --name wireguard \
|
|
--cap-add NET_ADMIN \
|
|
--cap-add SYS_MODULE \
|
|
--sysctl net.ipv4.conf.all.src_valid_mark=1 \
|
|
-v /path/to/conf/mullvad.conf:/etc/wireguard/mullvad.conf \
|
|
-p 8080:80 \
|
|
jordanpotter/wireguard
|
|
```
|
|
|
|
```bash
|
|
docker run -it --rm \
|
|
--net=container:wireguard \
|
|
nginx
|
|
```
|
|
|
|
## Versioning
|
|
|
|
Wireguard is new technology and its behavior may change in the future. For this reason, it's recommended to specify an image tag when running this container, such as `jordanpotter/wireguard:2.1.0`.
|
|
|
|
The available tags are listed [here](https://hub.docker.com/r/jordanpotter/wireguard/tags).
|