From 358a77d168fb71e117565d7cb0756f6215c07415 Mon Sep 17 00:00:00 2001
From: surtur <a_mirre@utb.cz>
Date: Sat, 26 Mar 2022 03:11:11 +0100
Subject: [PATCH] update README.md

---
 README.md | 45 +++++++++++++++++++++++++--------------------
 1 file changed, 25 insertions(+), 20 deletions(-)

diff --git a/README.md b/README.md
index 3f29377..3cda436 100644
--- a/README.md
+++ b/README.md
@@ -1,32 +1,37 @@
-# drone.dotya.ml
+# [drone-ci-configs](https://git.dotya.ml/dotya.ml/drone-ci-configs)
 
 this repo holds
-* docker-compose.yml for [drone](https://drone.io) instance
-* drone-related env files
-* `systemd` Unit file to easily start/stop the instance as a service
+* `docker-compose.yml` for [drone.dotya.ml instance](https://drone.dotya.ml) of
+  [Drone CI](https://drone.io)
+* drone-related env files (`server.env`, `runner-docker.env`)
+* `systemd` *Unit* file to easily start/stop the instance service and `systemd`
+  *Slice* file to control its resource usage
 
-#### prepare environment
+### prepare environment
 
 ```bash
-mkdir -pv /etc/drone
+mkdir -pv /etc/drone /etc/systemd/system/drone.service.d
 ```
-* put `docker-compose.yml` + env files in there
-
-* put `drone.service` `systemd` unit file in `/etc/systemd/system/drone.service`
+* unless running with unprivileged user, copy `drone.service` and `drone.slice`
+  files to `/etc/systemd/system` and `override.conf` into
+  `/etc/systemd/system/drone.service.d`
 
 * reload `systemd` daemon
+  ```bash
+  systemctl daemon-reload
+  ```
 
-```bash
-systemctl daemon-reload
-```
+* let `drone.service` start automatically on system startup and start the
+  service immediately
+  ```bash
+  systemctl enable --now drone.service
+  ```
 
-enable running `drone` "service" after system startup and start `drone` now
+alternatively, copy the folder structure `etc` to your `/etc`
 
-```bash
-systemctl enable --now drone.service
-```
+### notes
 
-#### notes
-
-* in current set-up you also need a web proxy server (such as `nginx`) to forward traffic to and from `drone` that runs exclusively on localhost
-* this set-up works with Gitea in mind, although it shouldn't be too hard to change the configs to work with other git providers
+* using this set-up a reverse proxy (such as `nginx`) is also needed to forward
+  traffic to and from `drone` server that listens exclusively on localhost
+* this set-up works with Gitea in mind, although it shouldn't be too hard to
+  change the configs to work with other git providers (see `server.env` file)