From 8691c40fc1ed9788e3cb6b55e31ee8bb041ffc62 Mon Sep 17 00:00:00 2001
From: Mathew Guest <mat@zavage.net>
Date: Fri, 30 Aug 2024 01:00:49 -0600
Subject: [PATCH] doc: starting some documentation

---
 README.md | 36 ++++++++++++++++++++++++++++++++++++
 1 file changed, 36 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..8ce831c
--- /dev/null
+++ b/README.md
@@ -0,0 +1,36 @@
+** Zavage act_runner for Gitea **
+
+---------------------------------
+Included is what's needed for act_runner to run on servbox host and provide a docker-runner
+to Gitea instance. This is systemd units and configuration.
+
+[[__TOC__]]
+
+Installation
+------------
+1. provision gitea-runner user, with home directory and clone this repo inside of it.
+1. Install docker-rootless, provision sid and gid ranges 
+1. Install 3 systemd units, 2 user-level and 1-system level to run dbus, docker (rootless), and act_runner
+1. Install .bashrc or .profile config for user to connect to dbus, needed for systemd
+1. Start and enable the systemd units/services
+1. Verify it works
+
+```
+su -l gitea-runner
+systemctl --user [start/enable/status] docker.service
+systemctl --user [start/enable/status] dbus-gitea-runner.service
+
+
+# system-level: (run as root)
+systemctl [start/enable/status] gitea-act-runner.service
+
+# Check:
+journalctl --user -u docker.service
+journalctl gitea-act-runner.service
+```
+
+See also
+--------
+ * Mathew Guest: mat@zavage.net
+
+