From c41c61980984fd4cf574bbfdbdeccebcd3cae108 Mon Sep 17 00:00:00 2001 From: LinuxServer-CI Date: Thu, 9 Apr 2020 19:59:32 +0000 Subject: [PATCH] Bot Updating Documentation --- images/docker-wireguard.md | 13 +++++++++---- 1 file changed, 9 insertions(+), 4 deletions(-) diff --git a/images/docker-wireguard.md b/images/docker-wireguard.md index c2f87873a..03fa5fe78 100755 --- a/images/docker-wireguard.md +++ b/images/docker-wireguard.md @@ -24,6 +24,8 @@ The architectures supported by this image are: | Architecture | Tag | | :----: | --- | | x86-64 | amd64-latest | +| arm64 | arm64v8-latest | +| armhf | arm32v7-latest | ## Usage @@ -43,7 +45,7 @@ docker create \ -e SERVERURL=wireguard.domain.com `#optional` \ -e SERVERPORT=51820 `#optional` \ -e PEERS=1 `#optional` \ - -e PEERDNS=8.8.8.8 `#optional` \ + -e PEERDNS=auto `#optional` \ -e INTERNAL_SUBNET=10.13.13.0 `#optional` \ -p 51820:51820/udp \ -v /path/to/appdata/config:/config \ @@ -75,7 +77,7 @@ services: - SERVERURL=wireguard.domain.com #optional - SERVERPORT=51820 #optional - PEERS=1 #optional - - PEERDNS=8.8.8.8 #optional + - PEERDNS=auto #optional - INTERNAL_SUBNET=10.13.13.0 #optional volumes: - /path/to/appdata/config:/config @@ -108,7 +110,7 @@ Docker images are configured using parameters passed at runtime (such as those a | `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 | | `SERVERPORT=51820` | External port for docker host. Used in server mode. | | `PEERS=1` | Number of peers to create confs for. Required for server mode. | -| `PEERDNS=8.8.8.8` | DNS server set in peer/client configs. Used in server mode. | +| `PEERDNS=auto` | DNS server set in peer/client configs (can be set as `8.8.8.8`). Used in server mode. Defaults to `auto`, which uses wireguard docker host's DNS via included CoreDNS forward. | | `INTERNAL_SUBNET=10.13.13.0` | Internal subnet for the wireguard and server and peers (only change if it clashes). Used in server mode. | ### Volume Mappings (`-v`) @@ -140,10 +142,12 @@ In this instance `PUID=1000` and `PGID=1000`, to find yours use `id user` as bel ## Application Setup -This image is designed for Ubuntu and Debian x86_64 systems only. During container start, it will download the necessary kernel headers and build the kernel module (until kernel 5.6, which has the module built-in, goes mainstream). +This image is designed for Ubuntu and Debian based systems only. During container start, it will download the necessary kernel headers and build the kernel module (until kernel 5.6, which has the module built-in, goes mainstream). If you're on a debian/ubuntu based host with a custom or downstream distro provided kernel (ie. Pop!_OS), the container won't be able to install the kernel headers from the regular ubuntu and debian repos. In those cases, you can try installing the headers on the host via `sudo apt install linux-headers-$(uname -r)` (if distro version) and then add a volume mapping for `/usr/src:/usr/src`, or if custom built, map the location of the existing headers to allow the container to use host installed headers to build the kernel module (tested successful on Pop!_OS, ymmv). +With regards to arm32/64 devices, Raspberry Pi 2-4 running the [official ubuntu images](https://ubuntu.com/download/raspberry-pi) or Raspbian Buster are supported out of the box. For all other devices and OSes, you can try installing the kernel headers on the host, and mapping `/usr/src:/usr/src` and it may just work (no guarantees). + This can be run as a server or a client, based on the parameters used. ## Server Mode @@ -180,6 +184,7 @@ We publish various [Docker Mods](https://github.com/linuxserver/docker-mods) to ## Versions +* **08.04.20:** - Add arm32/64 builds and enable multi-arch (rpi4 with ubuntu and raspbian buster tested). Add CoreDNS for `PEERDNS=auto` setting. Update the `add-peer`/`show-peer` scripts to utilize the templates and the `INTERNAL_SUBNET` var (previously missed, oops). * **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. * **31.03.20:** - Initial Release.