Added Dockerfile to simplify compilation process (see #1)

.gitignore

@@ -0,0 +1 @@
+artifacts/

Dockerfile

@@ -0,0 +1,11 @@
+FROM ubuntu:18.04
+
+ENV IS_IN_CONTAINER 1
+
+RUN apt-get update \
+ && apt-get -qy install git python3 wget ca-certificates \
+ && mkdir -p /build/source
+
+COPY . /source/WireGuard
+
+ENTRYPOINT exec /source/WireGuard/build.sh

README.rst

@@ -25,7 +25,7 @@ DS213j armada370 *N/A*       No (Kernel version too old)
 DS218j armada38x 6.2         Yes
 ====== ========= =========== ===========================
 
-The minimun required kernel version is 3.10. If you have a kernel version lower
+The minimum required kernel version is 3.10. If you have a kernel version lower
 than that, WireGuard will not work. You can check your kernel version by
 logging in through SSH and running the ``uname -a`` command.
 
@@ -53,49 +53,34 @@ runs ``wg-quick up wg0`` on startup.
 
 Compiling
 ---------
-I've used docker to compile everything as ``pkgscripts-ng`` clutters the file
+I've used docker to compile everything, as ``pkgscripts-ng`` clutters the file
-system quite a bit. Start by setting up a new docker container and enter a bash
+system quite a bit. First create a docker image by running the following
-prompt inside it:
+command in this repository:
 
 .. code-block:: bash
 
-    sudo docker create -it --privileged --name synobuild ubuntu
+    sudo docker build -t synobuild .
-    sudo docker start synobuild
-    sudo docker exec -it synobuild bash
 
-Now we can setup the build toolchain inside the Docker container:
+Now we can build for any platform and DSM version using:
 
 .. code-block:: bash
 
-    apt-get update
+    sudo docker run --rm --privileged --env PACKAGE_ARCH=<arch> --env DSM_VER=<dsm-ver> -v $(pwd)/artifacts:/result_spk synobuild
-    apt-get install git python3 wget ca-certificates
-    git clone https://github.com/SynologyOpenSource/pkgscripts-ng
-    mkdir source
-    git clone https://github.com/runfalk/synology-wireguard /source/WireGuard
 
-The next step is figuring out which platform and DSM version to compile for.
+You should replace ``<arch>`` with your NAS's package arch. Using
-Using `this table <https://www.synology.com/en-global/knowledgebase/DSM/tutorial/General/What_kind_of_CPU_does_my_NAS_have>`_
+`this table <https://www.synology.com/en-global/knowledgebase/DSM/tutorial/General/What_kind_of_CPU_does_my_NAS_have>`_
-you can figure out how the next command should look like. In my case it's:
+you can figure out which one to use. Note that the package arch must be
+lowercase. ``<dsm-ver>`` should be replaced with the version of DSM you are
+compiling for.
+
+For the DS218j that I have, the complete command looks like this:
 
 .. code-block:: bash
 
-    pkgscripts-ng/EnvDeploy -p armada38x -v 6.2
+    sudo docker run --rm --privileged --env PACKAGE_ARCH=armada38x --env DSM_VER=6.2 -v $(pwd)/artifacts:/result_spk synobuild
-    cp /etc/ssl/certs/ca-certificates.crt /build_env/*/etc/ssl/certs/
 
-The second command is very important, or the package build will fail on SSL
+If everything worked you should have a directory called ``artifacts`` that
-errors. Now we can build an SPK package:
+contains your SPK files.
-
-.. code-block:: bash
-
-    pkgscripts-ng/PkgCreate.py -p armada38x -v 6.2 -S --build-opt=-J --print-log -c WireGuard
-
-There should now be an SPK in ``/result_spk``. You can now exit the docker
-container and extract the SPKs:
-
-.. code-block:: bash
-
-    sudo docker cp synobuild:/result_spk/WireGuard-0.0.20190227/WireGuard-armada38x-0.0.20190227.spk .
-    sudo docker cp synobuild:/result_spk/WireGuard-0.0.20190227/WireGuard-armada38x-0.0.20190227_debug.spk .
 
 
 Credits
@@ -103,5 +88,5 @@ Credits
 I based a lot of this work on
 `this guide <https://www.reddit.com/r/synology/comments/a2erre/guide_intermediate_how_to_install_wireguard_vpn/>`_
 by Reddit user `akhener <https://www.reddit.com/user/akhener>`_. However, I had
-to modify their instructions a lot since my NAS has an ARM which made cross
+to modify their instructions a lot since my NAS has an ARM CPU which made cross
 compilation a lot trickier.

build.sh

@@ -0,0 +1,72 @@
+#!/bin/bash
+if [ -z ${IS_IN_CONTAINER+x} ]; then
+    echo "This script expect to be run inside a docker container" 1>&2
+    exit 1
+fi
+
+if [ -z ${PACKAGE_ARCH+x} ]; then
+    echo "PACKAGE_ARCH is undefined. Please find and set you package arch:" 1>&2
+    echo "https://www.synology.com/en-global/knowledgebase/DSM/tutorial/Compatibility_Peripherals/What_kind_of_CPU_does_my_NAS_have" 1>&2
+    exit 2
+fi
+
+if [ -z ${DSM_VER+x} ]; then
+    echo "DSM_VER is undefined. This should a version number like 6.2" 1>&2
+    exit 3
+fi
+
+# Ensure that we are working directly in the root file system. Though this
+# should always be the case in containers.
+cd /
+
+# Make the script quit if there are errors
+set -e
+
+# Fetch Synology toolchain
+if [ ! -d /pkgscripts-ng ]; then
+    git clone https://github.com/SynologyOpenSource/pkgscripts-ng
+fi
+
+# Install the toolchain for the given package arch and DSM version
+build_env="/build_env/ds.$PACKAGE_ARCH-$DSM_VER"
+if [ ! -d "$build_env" ]; then
+    pkgscripts-ng/EnvDeploy -p $PACKAGE_ARCH -v $DSM_VER
+
+    # Ensure the installed toolchain has support for CA signed certificates.
+    # Without this wget on https:// will fail
+    cp /etc/ssl/certs/ca-certificates.crt "$build_env/etc/ssl/certs/"
+fi
+
+# Disable quit if errors to allow printing of logfiles
+set +e
+
+# Build packages
+#   -p              package arch
+#   -v              DSM version
+#   -S              no signing
+#   --build-opt=-J  prevent parallel building (required)
+#   --print-log     save build logs
+#   -c WireGuard    project path in /source
+pkgscripts-ng/PkgCreate.py \
+    -p $PACKAGE_ARCH \
+    -v $DSM_VER \
+    -S \
+    --build-opt=-J \
+    --print-log \
+    -c WireGuard
+
+# Save package builder exit code. This allows us to print the logfiles and give
+# a non-zero exit code on errors.
+pkg_status=$?
+
+echo "Build log"
+echo "========="
+cat "$build_env/logs.build"
+echo
+
+echo "Install log"
+echo "==========="
+cat "$build_env/logs.install"
+echo
+
+exit $pkg_status