From 643d071de10a0d3171f50fe54126a7d01a96f3df Mon Sep 17 00:00:00 2001
From: moanos <julian-samuel@gebuehr.net>
Date: Thu, 2 Nov 2023 16:27:31 +0100
Subject: [PATCH] docs: Add basic docs for semaphore

---
 docs/services/semaphore.md | 43 ++++++++++++++++++++++++++++++++++++++
 1 file changed, 43 insertions(+)
 create mode 100644 docs/services/semaphore.md

diff --git a/docs/services/semaphore.md b/docs/services/semaphore.md
new file mode 100644
index 0000000..8e00ea1
--- /dev/null
+++ b/docs/services/semaphore.md
@@ -0,0 +1,43 @@
+# GoToSocial
+
+[Semaphore](https://www.ansible-semaphore.com/) is a responsive web UI for running Ansible playbooks. Installing it is powered by the [mother-of-all-self-hosting/ansible-role-semaphore](https://github.com/mother-of-all-self-hosting/ansible-role-semaphore) Ansible role.
+
+## Dependencies
+
+This service requires the following other services:
+
+- a [Postgres](postgres.md) database
+- a [Traefik](traefik.md) reverse-proxy server
+
+
+## Configuration
+
+To enable this service, add the following configuration to your `vars.yml` file and re-run the [installation](../installing.md) process:
+
+```yaml
+########################################################################
+#                                                                      #
+# semaphore                                                            #
+#                                                                      #
+########################################################################
+
+semaphore_enabled: true
+semaphore_hostname: semaphore.example.com
+semaphore_admin_password: STRONG_PASSWORD
+semaphore_admin_name: USERNAME
+semaphore_admin_email: user@example.org
+# Key for encrypting access keys in database.
+# It must be generated by using the following command: head -c32 /dev/urandom | base64
+semaphore_access_key_encryption: "PJOfV/7Q+ZDUxo2bgW8dgVbGJ6nNIJgEOyB3hcnVVz4="
+
+########################################################################
+#                                                                      #
+# /semaphore                                                           #
+#                                                                      #
+########################################################################
+```
+
+
+## Usage
+
+After [installing](../installing.md), you can log into you admin account by visiting the URL specified in `semaphore_hostname`.