Update README with instructions

This commit is contained in:
Jordan Potter 2019-02-14 12:00:51 -08:00
parent 3cbb38e5e9
commit fa70bb976d

View file

@ -1,2 +1,23 @@
# docker-wireguard # Wireguard
Basic container running a wireguard client This is a simple docker image to run a wireguard client.
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.
Now simply mount the configuration file and run:
```bash
docker run --name wireguard \
--cap-add=NET_ADMIN
-v /path/to/conf/mullvadus2.conf:/etc/wireguard/mullvadus2.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
```