Experimental systemd service for dovesnap.

TODO: work through most install/upgrade scenarios and test.
Tested manually working with own "dovesnap" user, "docker" group.

Author: anarkiwi

README.md

@@ -13,6 +13,10 @@ See also https://docs.faucet.nz for FAUCET documentation, including monitoring d
 * Optionally: additional physical interfaces to connect other hosts also running dovesnap
 * non-netfilter iptables. For Debian/Ubuntu, follow the legacy option at https://wiki.debian.org/iptables (`update-alternatives --set iptables /usr/sbin/iptables-legacy`). This requirement will be addressed in a future version.
 
+### Installing as a systemd service
+
+The `install.sh` and `uninstall.sh` scripts can be used to install and uninstall dovesnap as a systemd managed service. An upgrade can be accomplished by executing a `git pull` within `~dovesnap` as the `dovesnap` user, and restarting the service. Persistent configuration is stored in `~dovesnap/service.env`.
+
 ### QuickStart Instructions
 
 These instructions describe the most basic use of dovesnap - creating a docker network with Internet access, where dovesnap provides all the FAUCET infrastructure. See below for more advanced usage.

dovesnap.service

@@ -0,0 +1,22 @@
+# TODO: copy default service.env, install dovesnap.service and enable/start.
+[Unit]
+Description=dovesnap
+Requires=docker.service
+After=docker.service
+
+[Service]
+Restart=always
+# TODO: create dovesnap user, add to docker group.
+User=dovesnap
+Group=docker
+WorkingDirectory=/home/dovesnap/dovesnap
+EnvironmentFile=/home/dovesnap/service.env
+ExecStartPre=/usr/local/bin/docker-compose build
+ExecStartPre=-mkdir -p ${FAUCET_PREFIX}
+# DOCKERFILES without {} as contains spaces.
+ExecStartPre=-/usr/local/bin/docker-compose $DOCKERFILES down
+ExecStart=/usr/local/bin/docker-compose $DOCKERFILES up
+ExecStop=/usr/local/bin/docker-compose $DOCKERFILES down
+
+[Install]
+WantedBy=multi-user.target

install.sh

@@ -0,0 +1,38 @@
+#!/bin/sh
+
+echo installing dovesnap
+
+giturl=$1
+
+for dep in docker docker-compose git ; do
+	depv=$($dep --version 2>/dev/null)
+	if [ "$depv" = "" ] ; then
+		echo $dep not installed.
+		exit 1
+	fi
+done
+
+if [ -f /etc/systemd/system/dovesnap.service ] ; then
+	echo dovesnap service already installed.
+	exit 1
+fi
+
+dovesnapid=$(id dovesnap 2>/dev/null)
+if [ "$dovesnapid" != "" ] ; then
+	echo dovesnap user already exists.
+	exit 1
+fi
+
+sudo useradd -m dovesnap -G docker
+if [ "$giturl" = "" ] ; then
+	sudo -u dovesnap -s eval 'cd ~dovesnap && git clone https://github.com/iqtlabs/dovesnap && cd ~dovesnap/dovesnap && git fetch --all --tags && git checkout $(git describe --tags --abbrev=0)' || exit
+else
+	sudo -u dovesnap -s eval "cd ~dovesnap && git clone $giturl" || exit
+fi
+sudo -u dovesnap -s eval 'cp ~dovesnap/dovesnap/service.env ~dovesnap' || exit
+sudo cp ~dovesnap/dovesnap/dovesnap.service /etc/systemd/system || exit
+sudo systemctl daemon-reload || exit
+sudo systemctl enable dovesnap || exit
+sudo systemctl start dovesnap
+
+echo dovesnap installed

service.env

@@ -0,0 +1,4 @@
+# Where FAUCET will store dovesnap managed config.
+FAUCET_PREFIX=/home/dovesnap/faucet
+# TODO: optionally use remote FAUCET/RPC service.
+DOCKERFILES=-f docker-compose.yml -f docker-compose-standalone.yml

uninstall.sh

@@ -0,0 +1,21 @@
+#!/bin/sh
+
+echo uninstalling dovesnap
+
+if [ ! -f /etc/systemd/system/dovesnap.service ] ; then
+	echo dovesnap service not installed.
+	exit 1
+fi
+
+dovesnapid=$(id dovesnap)
+if [ "$dovesnapid" = "" ] ; then
+	echo no dovesnap user.
+	exit 1
+fi
+
+sudo service dovesnap stop || true
+sudo systemctl disable dovesnap
+sudo rm -f /etc/systemd/system/dovesnap.service
+sudo userdel -r dovesnap
+
+echo dovesnap uninstalled