Update README

.gitignore

@@ -0,0 +1,2 @@
+variables.conf
+.disabled

README.md

@@ -11,6 +11,14 @@ Version 2 implementation works roughly as follows:
   * if changes are detected, it runs install script (if present).
 
 ### Files
-* `conf-sync.sh`
+* `conf-sync.sh` is the main script, which updates the files.
+* `variables.conf.template` contains examples variables definitions, and should be copied locally to `variables.conf`
+  (with any required modifications).
+* `systemd-templates/` contains Systemd units templates for running the script unattended.
 #### Installation
-* `install.sh`
+* `install.sh` script copies Systemd templates to their destination, and enables conf-sync timer.
+
+### TODO
+* Add install support for OpenBSD
+* Replace desktop/server timer choice in one line in install script
+* Add `$sudo` in install script

conf-sync.sh

@@ -0,0 +1,37 @@
+#!/usr/bin/env bash
+
+run_directory=$(dirname $(readlink -f "$0"))
+source "$run_directory/variables.conf"
+
+for dir in $sync_directory/*; do
+  git -C $dir rev-parse 2>/dev/null >/dev/null
+  if [ "$?" -ne 0 ]; then
+    echo "$dir: not a Git repo"
+    continue
+  fi
+  if [ -f $dir/.disabled ]; then
+    echo "$dir update is disabled."
+    continue
+  fi
+  git -C $dir fetch 2>/dev/null >/dev/null
+  UPSTREAM=${1:-'@{u}'}
+  LOCAL=$(git -C $dir rev-parse @)
+  REMOTE=$(git -C $dir rev-parse "$UPSTREAM")
+  BASE=$(git -C $dir merge-base @ "$UPSTREAM")
+  if [ $LOCAL = $REMOTE ]; then
+      echo "$dir: up-to-date"
+  elif [ $LOCAL = $BASE ]; then
+      echo "pulling $dir"
+      git -C $dir pull 2>/dev/null >/dev/null
+      if [ -e $dir/install.sh ]; then
+        echo "Running $dir's install script..."
+        $dir/install.sh
+      fi
+  elif [ $REMOTE = $BASE ]; then
+      echo "WARNING: $dir is ahead of remote!"
+  else
+      echo "WARNING: $dir and remote have diverged!"
+  fi
+done
+
+exit 0

install.sh

@@ -0,0 +1,45 @@
+#!/usr/bin/env bash
+
+run_directory=$(dirname $(readlink -f "$0"))
+user=$(whoami)
+
+source "$run_directory/variables.conf"
+
+if [ -f $run_directory/.disabled ]; then
+  echo "Installation is disabled. Exiting..."
+  exit 0
+fi
+
+if [[ $user != 'root' ]]; then
+  sudo="sudo"
+else
+  sudo=""
+fi
+
+# NOTE: the handling of init/service manager comes from this discussion:
+# https://unix.stackexchange.com/questions/18209/detect-init-system-using-the-shell
+
+if [ -e /run/systemd/system ]; then # service manager is Systemd
+  echo "Copying Systemd units to system directory..."
+  $sudo cp $run_directory/systemd-templates/conf-sync.service /etc/systemd/system/
+  $sudo sed -i -e "s/PH_USER/$(whoami)/g" /etc/systemd/system/conf-sync.service
+  $sudo sed -i -e "s:PH_DIRECTORY:$run_directory:g" /etc/systemd/system/conf-sync.service
+  if [ "$client_type" = "server" ]; then # TODO could be replaced in one line: cp conf-sync-$client_type
+    $sudo cp $run_directory/systemd-templates/conf-sync-server.timer /etc/systemd/system/conf-sync.timer
+  else
+    $sudo cp $run_directory/systemd-templates/conf-sync-desktop.timer /etc/systemd/system/conf-sync.timer
+  fi
+  echo "Reloading Systemd..."
+  $sudo systemctl daemon-reload
+  echo "Enabling timer (not starting it, either do it manually or reboot)..."
+  $sudo systemctl enable conf-sync.timer
+elif [ "$(uname)" = "OpenBSD" ]; then
+  echo "ERROR: OpenBSD is not yet supported, but this is planned."
+  exit 0
+else
+  echo "ERROR: could not determine a supported system. Exiting."
+  exit 1
+fi
+
+echo "Finished install. Exiting..."
+exit 0

systemd-templates/conf-sync-desktop.timer

@@ -0,0 +1,9 @@
+[Unit]
+Description=Run conf-sync after boot (for desktops)
+
+[Timer]
+Unit=conf-sync.service
+OnBootSec=5min
+
+[Install]
+WantedBy=timers.target

systemd-templates/conf-sync-server.timer

@@ -0,0 +1,10 @@
+[Unit]
+Description=Run conf-sync daily (for servers)
+
+[Timer]
+Unit=conf-sync.service
+OnCalendar=*-*-* 06:00:00
+Persistent=true
+
+[Install]
+WantedBy=timers.target

systemd-templates/conf-sync.service

@@ -0,0 +1,8 @@
+[Unit]
+Description=Configuration files synchronisation
+After=network.target
+
+[Service]
+Type=oneshot
+User=PH_USER
+ExecStart=PH_DIRECTORY/conf-sync.sh

variables.conf.template

@@ -0,0 +1,6 @@
+#!/usr/bin/env bash
+
+# Copy this file as variables.conf, with the correct values
+
+sync_directory=/home/$(whoami)/.sync
+client_type="desktop" # change to server if needed