From 2f34f06591a26d0a5a7481c25ea2541dffba24ba Mon Sep 17 00:00:00 2001
From: Patrick Cernko <pcernko@mpi-klsb.mpg.de>
Date: Wed, 14 May 2025 14:37:17 +0200
Subject: [PATCH 1/2] support and instructions for manual install using systemd
 services (tested with Debian 12 only)

---
 docker/sidekiq-entrypoint.sh     |   0
 docker/web-entrypoint.sh         |   0
 systemd/README.md                | 113 +++++++++++++++++++++++++++++++
 systemd/dawarich-sidekiq.service |  14 ++++
 systemd/dawarich.service         |  14 ++++
 systemd/environment              |  34 ++++++++++
 systemd/install.sh               |  44 ++++++++++++
 7 files changed, 219 insertions(+)
 mode change 100644 => 100755 docker/sidekiq-entrypoint.sh
 mode change 100644 => 100755 docker/web-entrypoint.sh
 create mode 100644 systemd/README.md
 create mode 100644 systemd/dawarich-sidekiq.service
 create mode 100644 systemd/dawarich.service
 create mode 100644 systemd/environment
 create mode 100644 systemd/install.sh

diff --git a/docker/sidekiq-entrypoint.sh b/docker/sidekiq-entrypoint.sh
old mode 100644
new mode 100755
diff --git a/docker/web-entrypoint.sh b/docker/web-entrypoint.sh
old mode 100644
new mode 100755
diff --git a/systemd/README.md b/systemd/README.md
new file mode 100644
index 00000000..aafece8b
--- /dev/null
+++ b/systemd/README.md
@@ -0,0 +1,113 @@
+# Installing dawarich with systemd
+
+This guide is based on my experience setting up dawarich on Debian 12.
+
+## Prerequisites
+
+### Postgresql
+
+You need a recent version of [Postgresql](https://www.postgresql.org/)
+with [PostGIS](https://postgis.net/) support.
+
+In Debian you can install it with
+```sh
+apt install postgresql-postgis
+```
+
+If you do not want to run the database on the same host as the
+dawarich service, you need to reconfigure Postgresql to allow
+connections from that host.
+
+Dawarich will populate it's database itself and only needs a user
+account to do so. This account needs to have superuser capabilities as
+the database population includes enabling the postgis extention:
+```sh
+sudo -u postgres psql <<EOF
+CREATE USER test PASSWORD 'UseAStrongPasswordAndKeepItSecret';
+ALTER USER test WITH SUPERUSER;
+EOF
+```
+
+
+### Redis
+
+Install a recent version of [Redis](https://redis.io/).
+
+In Debian you can install it with
+```sh
+apt install redis-server
+```
+
+If you do not want to run the redis service on the same host as the
+dawarich service, you need to reconfigure redis to accept connection
+from that host and most likely configure authentication.
+
+
+### System User account
+
+Create an account that will run the ruby services of dawarich. Of
+course, you can choose another directory for it's HOME.
+
+```sh
+adduser --system --home /service/dawarich dawarich
+```
+
+### Ruby
+
+Dawarich currently uses [Ruby](https://www.ruby-lang.org/) version
+3.4.1 (yes, exactly this one). At least on Debian, this version is not
+available at all in the package repositories. So I installed Ruby by
+compiling from source:
+
+```sh
+apt install build-essential pkg-config libpq-dev libffi-dev libyaml-dev zlib1g-dev
+
+# compile & install as unprivileged user
+sudo -u dawarich bash
+
+# download
+cd ~
+mkdir src
+cd src
+wget https://cache.ruby-lang.org/pub/ruby/3.4/ruby-3.4.1.tar.gz
+
+# unpack
+tar -xzf ruby-3.4.1.tar.gz
+cd ~/ruby-3.4.1
+
+# build & install
+./configure --prefix $HOME/ruby-3.4.1
+make all test install
+
+# allow easy replacement of used ruby installation
+ln -s ruby-3.4.1 ~dawarich/ruby
+
+exit # sudo -u dawarich bash
+```
+
+
+## Install dawarich
+
+0. Clone the repo to `/service/dawarich/dawarich` and install dependencies.
+```sh
+# install as unprivileged user
+sudo -u dawarich bash
+
+cd ~
+git clone https://github.com/Freika/dawarich.git
+cd dawarich
+
+# install dependencies
+bash systemd/install.sh
+
+exit # sudo -u dawarich bash
+```
+
+0. Install, enable and start systemd services
+```sh
+# install systemd services
+install systemd/dawarich.service systemd/dawarich-sidekiq.service /etc/systemd/system
+systemctl daemon-reload
+systemctl enable --now dawarich.service dawarich-sidekiq.service
+systemctl status dawarich.service dawarich-sidekiq.service
+```
diff --git a/systemd/dawarich-sidekiq.service b/systemd/dawarich-sidekiq.service
new file mode 100644
index 00000000..9745a4fb
--- /dev/null
+++ b/systemd/dawarich-sidekiq.service
@@ -0,0 +1,14 @@
+[Unit]
+Description=DaWarIch SideKiq Service
+Wants=network-online.target system-postgresql.slice redis-server.service
+After=network-online.target system-postgresql.slice redis-server.service
+
+[Service]
+Type=simple
+User=dawarich
+WorkingDirectory=/service/dawarich/dawarich
+EnvironmentFile=-/service/dawarich/dawarich/systemd/environment
+ExecStart=/service/dawarich/dawarich/docker/sidekiq-entrypoint.sh sidekiq
+
+[Install]
+WantedBy=multi-user.target
\ No newline at end of file
diff --git a/systemd/dawarich.service b/systemd/dawarich.service
new file mode 100644
index 00000000..fc21aefd
--- /dev/null
+++ b/systemd/dawarich.service
@@ -0,0 +1,14 @@
+[Unit]
+Description=DaWarIch Service
+Wants=network-online.target system-postgresql.slice redis-server.service
+After=network-online.target system-postgresql.slice redis-server.service
+
+[Service]
+Type=simple
+User=dawarich
+WorkingDirectory=/service/dawarich/dawarich
+EnvironmentFile=-/service/dawarich/dawarich/systemd/environment
+ExecStart=/service/dawarich/dawarich/docker/web-entrypoint.sh bin/rails server -p 3000 -b ::
+
+[Install]
+WantedBy=multi-user.target
\ No newline at end of file
diff --git a/systemd/environment b/systemd/environment
new file mode 100644
index 00000000..feb4ad52
--- /dev/null
+++ b/systemd/environment
@@ -0,0 +1,34 @@
+# this file is used by systemd, do not use $VAR as it won't be expanded!
+
+# set PATH and GEM_HOME for locally installed ruby
+PATH=/service/dawarich/ruby/bin:/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin
+GEM_HOME=/service/dawarich/ruby/lib/ruby/gems/3.4.0
+
+# from docker/Dockerfile.dev
+APP_PATH=/service/dawarich/dawarich
+BUNDLE_VERSION=2.5.21
+RAILS_LOG_TO_STDOUT=true
+RAILS_PORT=3000
+RAILS_ENV=development
+SELF_HOSTED=true
+
+# from docker/docker-compose.yml
+RAILS_ENV=development
+REDIS_URL=redis://localhost:6379/0
+DATABASE_HOST=localhost
+DATABASE_USERNAME=dawarich
+DATABASE_PASSWORD=ayophaing8bafohnoeGa
+DATABASE_NAME=dawarich
+MIN_MINUTES_SPENT_IN_CITY=60
+APPLICATION_HOSTS=localhost
+TIME_ZONE=Europe/London
+APPLICATION_PROTOCOL=http
+DISTANCE_UNIT=km
+PROMETHEUS_EXPORTER_ENABLED=false
+PROMETHEUS_EXPORTER_HOST=0.0.0.0
+PROMETHEUS_EXPORTER_PORT=9394
+SELF_HOSTED=true
+
+# Local variables:
+# mode: sh
+# End:
diff --git a/systemd/install.sh b/systemd/install.sh
new file mode 100644
index 00000000..22f4cf4a
--- /dev/null
+++ b/systemd/install.sh
@@ -0,0 +1,44 @@
+#!/bin/bash
+
+set -euo pipefail
+
+dirname=${0%/*}
+if [ "$dirname" != "systemd" ]; then
+    echo "This installed must be called in the repository root!" >&2
+    exit 1
+fi
+
+# make shellcheck happy (vars are defined in while loop below)
+BUNDLE_VERSION=''
+GEM_HOME=''
+# "source" "$dirname"/environment and EXPORT all vars
+# export all vars from env
+envfile="$dirname"/environment
+while IFS='#' read -r line; do
+    if [[ "$line" =~ ^([A-Z0-9_]+)=\"?(.*)\"?$ ]]; then
+        k=${BASH_REMATCH[1]}
+        v=${BASH_REMATCH[2]}
+        export "$k"="$v"
+    fi
+done < "$envfile"
+
+if [ "$APP_PATH" != "$PWD" ]; then
+    echo "Error: APP_PATH (defined in $envfile) != $PWD!" >&2
+    exit 1
+fi
+
+set -x
+
+# from docker/Dockerfile.dev
+
+# Update gem system and install bundler
+gem update --system 3.6.2
+gem install bundler --version "$BUNDLE_VERSION"
+rm -rf "$GEM_HOME"/cache/*
+
+# Install all gems into the image
+bundle config set --local path 'vendor/bundle'
+bundle install --jobs 4 --retry 3
+rm -rf vendor/bundle/ruby/3.4.1/cache/*.gem
+
+exit 0

From 0394b31630a88231d8a8cfea527e4c6ba9b4d189 Mon Sep 17 00:00:00 2001
From: Patrick Cernko <errror@errror.org>
Date: Mon, 14 Jul 2025 05:36:57 +0200
Subject: [PATCH 2/2] fixed created postgresql username thanks to @sshaikh for
 reporting

---
 systemd/README.md | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)

diff --git a/systemd/README.md b/systemd/README.md
index aafece8b..4a93bae2 100644
--- a/systemd/README.md
+++ b/systemd/README.md
@@ -23,8 +23,8 @@ account to do so. This account needs to have superuser capabilities as
 the database population includes enabling the postgis extention:
 ```sh
 sudo -u postgres psql <<EOF
-CREATE USER test PASSWORD 'UseAStrongPasswordAndKeepItSecret';
-ALTER USER test WITH SUPERUSER;
+CREATE USER dawarich PASSWORD 'UseAStrongPasswordAndKeepItSecret';
+ALTER USER dawarich WITH SUPERUSER;
 EOF
 ```