Merge pull request #3 from linuxserver/templates

aptalca · web-flow · commit 0c18b6efc5dc · 2020-04-07T19:48:19.000-04:00
Add templates, add subnet interface var
diff --git a/.github/FUNDING.yml b/.github/FUNDING.yml
@@ -1 +1,2 @@
 open_collective: linuxserver
+custom: ["https://www.wireguard.com/donations/",]
diff --git a/README.md b/README.md
@@ -7,7 +7,7 @@
 [![GitHub](https://img.shields.io/static/v1.svg?style=flat-square&color=E68523&label=linuxserver.io&message=GitHub&logo=github&logoColor=FFFFFF)](https://github.com/linuxserver "view the source for all of our repositories.")
 [![Open Collective](https://img.shields.io/opencollective/all/linuxserver.svg?style=flat-square&color=E68523&label=Supporters&logo=open%20collective&logoColor=FFFFFF)](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
  * easy user mappings (PGID, PUID)
@@ -71,6 +71,7 @@ docker create \
   -e SERVERPORT=51820 `#optional` \
   -e PEERS=1 `#optional` \
   -e PEERDNS=8.8.8.8 `#optional` \
+  -e INTERNAL_SUBNET=10.13.13.0 `#optional` \
   -p 51820:51820/udp \
   -v /path/to/appdata/config:/config \
   -v /lib/modules:/lib/modules \
@@ -85,6 +86,7 @@ docker create \
 Compatible with docker-compose v2 schemas.
 
 ```
+---
 version: "2.1"
 services:
   wireguard:
@@ -101,6 +103,7 @@ services:
       - SERVERPORT=51820 #optional
       - PEERS=1 #optional
       - PEERDNS=8.8.8.8 #optional
+      - INTERNAL_SUBNET=10.13.13.0 #optional
     volumes:
       - /path/to/appdata/config:/config
       - /lib/modules:/lib/modules
@@ -109,7 +112,6 @@ services:
     sysctls:
       - net.ipv4.conf.all.src_valid_mark=1
     restart: unless-stopped
-
 ```
 
 ## 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 PGID=1000` | for GroupID - see below for explanation |
 | `-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 SERVERPORT=51820` | External port 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. Used in 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 /lib/modules` | Maps host's modules folder. |
 | `--sysctl=` | Required for client mode. |
@@ -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. 
 
 ## 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 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
-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
+[![Docker Mods](https://img.shields.io/badge/dynamic/yaml?style=for-the-badge&color=E68523&label=mods&query=%24.mods%5B%27wireguard%27%5D.mod_count&url=https%3A%2F%2Fraw.githubusercontent.com%2Flinuxserver%2Fdocker-mods%2Fmaster%2Fmod-list.yml)](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
@@ -243,5 +253,6 @@ Once registered you can define the dockerfile to use with `-f Dockerfile.aarch64
 
 ## 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.
 * **31.03.20:** - Initial Release.
diff --git a/jenkins-vars.yml b/jenkins-vars.yml
@@ -25,3 +25,5 @@ repo_vars:
   - CI_DOCKERENV='TZ=US/Pacific'
   - CI_AUTH='user:password'
   - CI_WEBPATH=''
+sponsor_links:
+  - { name: "WireGuard", url: "https://www.wireguard.com/donations/" }
diff --git a/readme-vars.yml b/readme-vars.yml
@@ -35,45 +35,20 @@ cap_add_param_vars:
   - { cap_add_var: "NET_ADMIN" }
   - { cap_add_var: "SYS_MODULE" }
 custom_params:
-  - { 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
 opt_param_usage_include_env: true
 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: "SERVERPORT", env_value: "51820", desc: "External port 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. Used in 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_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
 app_setup_block_enabled: true
 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. 
 
   ## 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 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
-  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
 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: "31.03.20:", desc: "Initial Release." }
diff --git a/root/defaults/peer.conf b/root/defaults/peer.conf
@@ -0,0 +1,10 @@
+[Interface]
+Address = ${INTERFACE}.$(( $i + 1 ))
+PrivateKey = $(cat /config/peer${i}/privatekey-peer${i})
+ListenPort = 51820
+DNS = ${PEERDNS}
+
+[Peer]
+PublicKey = $(cat /config/server/publickey-server)
+Endpoint = ${SERVERURL}:${SERVERPORT}
+AllowedIPs = 0.0.0.0/0, ::/0
diff --git a/root/defaults/server.conf b/root/defaults/server.conf
@@ -0,0 +1,6 @@
+[Interface]
+Address = ${INTERFACE}.1
+ListenPort = 51820
+PrivateKey = $(cat /config/server/privatekey-server)
+PostUp = iptables -A FORWARD -i %i -j ACCEPT; iptables -A FORWARD -o %i -j ACCEPT; iptables -t nat -A POSTROUTING -o eth0 -j MASQUERADE
+PostDown = iptables -D FORWARD -i %i -j ACCEPT; iptables -D FORWARD -o %i -j ACCEPT; iptables -t nat -D POSTROUTING -o eth0 -j MASQUERADE
diff --git a/root/donate.txt b/root/donate.txt
@@ -0,0 +1 @@
+WireGuard: https://www.wireguard.com/donations/
diff --git a/root/etc/cont-init.d/30-config b/root/etc/cont-init.d/30-config
@@ -1,6 +1,6 @@
 #!/usr/bin/with-contenv bash
 
-mkdir -p /config
+mkdir -p /config/templates
 
 # install headers and wireguard
 apt-get update
@@ -53,59 +53,100 @@ else
     wireguard
 fi
 
+# prepare symlinks
 rm -rf /etc/wireguard
 mkdir -p /etc/wireguard
 ln -s /config/wg0.conf /etc/wireguard/wg0.conf
+# prepare templates
+[[ ! -f /config/templates/server.conf ]] && \
+  cp /defaults/server.conf /config/templates/server.conf
+[[ ! -f /config/templates/peer.conf ]] && \
+  cp /defaults/peer.conf /config/templates/peer.conf
 
-if [ ! -f /config/wg0.conf ] && [ -n "$PEERS" ] && [ -n "$SERVERURL" ]; then
-  SERVERPORT=${SERVERPORT:-51820}
-  PEERDNS=${PEERDNS:-8.8.8.8}
+generate_confs () {
   mkdir -p /config/server
   if [ ! -f /config/server/privatekey-server ]; then
     umask 077
     wg genkey | tee /config/server/privatekey-server | wg pubkey > /config/server/publickey-server
   fi
+  eval "`printf %s`
   cat <<DUDE > /config/wg0.conf
-[Interface]
-Address = 10.13.13.1
-ListenPort = 51820
-PrivateKey = $(cat /config/server/privatekey-server)
-PostUp = iptables -A FORWARD -i %i -j ACCEPT; iptables -A FORWARD -o %i -j ACCEPT; iptables -t nat -A POSTROUTING -o eth0 -j MASQUERADE
-PostDown = iptables -D FORWARD -i %i -j ACCEPT; iptables -D FORWARD -o %i -j ACCEPT; iptables -t nat -D POSTROUTING -o eth0 -j MASQUERADE
+`cat /config/templates/server.conf`
 
-DUDE
-  if ! [[ $PEERS =~ ^[0-9]+$ ]]; then
-    echo "PEERS is not set to an integer, setting it to 1"
-    PEERS="1"
-  fi
+DUDE"
   for i in $(seq 1 $PEERS); do
     mkdir -p /config/peer${i}
-    if [ ! -f /config/peer${i}/privatekey-peer${i} ]; then
+    if [ ! -f "/config/peer${i}/privatekey-peer${i}" ]; then
       umask 077
       wg genkey | tee /config/peer${i}/privatekey-peer${i} | wg pubkey > /config/peer${i}/publickey-peer${i}
     fi
+    eval "`printf %s`
     cat <<DUDE > /config/peer${i}/peer${i}.conf
-[Interface]
-Address = 10.13.13.$(( $i + 1 ))
-PrivateKey = $(cat /config/peer${i}/privatekey-peer${i})
-ListenPort = 51820
-DNS = ${PEERDNS}
-
-[Peer]
-PublicKey = $(cat /config/server/publickey-server)
-Endpoint = ${SERVERURL}:${SERVERPORT}
-AllowedIPs = 0.0.0.0/0, ::/0
-DUDE
+`cat /config/templates/peer.conf`
+DUDE"
     cat <<DUDE >> /config/wg0.conf
 [Peer]
 PublicKey = $(cat /config/peer${i}/publickey-peer${i})
-AllowedIPs = 10.13.13.$(( $i + 1 ))/32
+AllowedIPs = ${INTERFACE}.$(( $i + 1 ))/32
 
 DUDE
     echo "PEER ${i} QR code:"
     qrencode -t ansiutf8 < /config/peer${i}/peer${i}.conf
     qrencode -o /config/peer${i}/peer${i}.png < /config/peer${i}/peer${i}.conf
   done
+}
+
+save_vars () {
+  cat <<DUDE > /config/.donoteditthisfile
+ORIG_SERVERURL=$SERVERURL
+ORIG_SERVERPORT=#SERVER_PORT
+ORIG_PEERDNS=$PEERDNS
+ORIG_PEERS=$PEERS
+ORIG_INTERFACE=$INTERFACE
+DUDE
+}
+
+if [ -n "$PEERS" ]; then
+  echo "Server mode is selected"
+  if ! [[ "$PEERS" =~ ^[0-9]+$ ]]; then
+    echo "PEERS is not set to an integer, setting it to 1"
+    PEERS="1"
+  fi
+  if [ -z "$SERVERURL" ] || [ "$SERVERURL" = "auto" ]; then
+    SERVERURL=$(curl icanhazip.com)
+    echo "SERVERURL var is either not set or is set to \"auto\", setting external IP to auto detected value of $SERVERURL"
+  else
+    echo "External server address is set to $SERVERURL"
+  fi
+  SERVERPORT=${SERVERPORT:-51820}
+  echo "External server port is set to ${SERVERPORT}. Make sure that port is properly forwarded to port 51820 inside this container"
+  PEERDNS=${PEERDNS:-8.8.8.8}
+  echo "DNS server is set to $PEERDNS"
+  INTERNAL_SUBNET=${INTERNAL_SUBNET:-10.13.13.0}
+  echo "Internal subnet is set to $INTERNAL_SUBNET"
+  INTERFACE=$(echo "$INTERNAL_SUBNET" | awk 'BEGIN{FS=OFS="."} NF--')
+  if [ ! -f /config/wg0.conf ]; then
+    echo "No found wg0.conf found (maybe an initial install), generating 1 server and $PEERS peer/client confs"
+    generate_confs
+    save_vars
+  else
+    echo "Server mode is selected"
+    [[ -f /config/.donoteditthisfile ]] && \
+      . /config/.donoteditthisfile
+    if [ "$SERVERURL" != "$ORIG_SERVERURL" ] || [ "$SERVERPORT" != "$ORIG_SERVERPORT" ] || [ "$PEERDNS" != "$ORIG_PEERDNS" ] || [ "$PEERS" != "$ORIG_PEERS" ] || [ "$INTERFACE" != "$ORIG_INTERFACE" ]; then
+      echo "Server related environment variables changed, regenerating 1 server and $PEERS peer/client confs"
+      generate_confs
+      save_vars
+    else
+      echo "No changes to parameters. Existing configs are used."
+    fi
+  fi
+else
+  echo "Client mode selected."
+  if [ !-f /config/wg0.conf ]; then
+    "No client conf found. Provide your own client conf as \"/config/wg0.conf\" and restart the container."
+    sleep infinity
+  fi
 fi
 
 # permissions

Original file line number	Diff line number	Diff line change
`@@ -1 +1,2 @@`
`1`	`1`	`open_collective: linuxserver`
	`2`	`+custom: ["https://www.wireguard.com/donations/",]`
Original file line number	Diff line number	Diff line change
`@@ -0,0 +1 @@`
	`1`	`+WireGuard: https://www.wireguard.com/donations/`