From b9e5163d959a1eb62ba981f83c32516ffca9809b Mon Sep 17 00:00:00 2001
From: Barrow1990 <42769333+Barrow1990@users.noreply.github.com>
Date: Mon, 26 Aug 2024 17:51:52 +0100
Subject: [PATCH] Semaphoreui request (#303)

* semaphoreui initial documentation

* updated index with semaphoreui

* updated semaphoreui docs to compensate for issues

* updated mkdocs with semaphoreui
---
 docs/sandbox/apps/semaphoreui.md | 72 ++++++++++++++++++++++++++++++++
 docs/sandbox/index.md            |  1 +
 mkdocs.yml                       |  1 +
 3 files changed, 74 insertions(+)
 create mode 100644 docs/sandbox/apps/semaphoreui.md

diff --git a/docs/sandbox/apps/semaphoreui.md b/docs/sandbox/apps/semaphoreui.md
new file mode 100644
index 000000000..66060ca0c
--- /dev/null
+++ b/docs/sandbox/apps/semaphoreui.md
@@ -0,0 +1,72 @@
+# SemaphoreUI
+
+## What is it?
+
+[Semaphore UI](https://github.com/semaphoreui/semaphore) is a modern UI for Ansible, Terraform, OpenTofu and Pulumi. It lets you easily run Ansible playbooks, get notifications about fails, control access to deployment system.
+
+If your project has grown and deploying from the terminal is no longer for you then Semaphore UI is what you need.
+
+| Details     |             |             |             |
+|-------------|-------------|-------------|-------------|
+| [:material-home: Project home](https://semaphoreui.com){: .header-icons } | [:octicons-link-16: Docs](https://docs.semaphoreui.com/user-guide/projects){: .header-icons } | [:octicons-mark-github-16: Github](https://github.com/semaphoreui/semaphore?tab=readme-ov-file){: .header-icons } | [:material-docker: Docker](https://hub.docker.com/r/semaphoreui/semaphore){: .header-icons }|
+
+### 1. Installation
+
+``` shell
+
+sb install sandbox-semaphoreui
+
+```
+
+### 2. URL
+
+- To access the Syncthing dashboard, visit `https://semaphoreui._yourdomain.com_`
+
+### 3. Setup
+
+### 4. Additional Settings
+
+The default installation utilises a seperate postgres database. There is an option for this package to utilise mariadb / mysql but this isnt what this guide will be based on.
+
+To enable email notifications, set these [inventory](../saltbox/inventory/index.md) entries to your desired values:
+
+``` yaml title="Semaphoreui Email Settings"
+
+SEMAPHORE_EMAIL_ALERT: "true" # (1)!
+SEMAPHORE_EMAIL_SENDER: ""  # (2)!
+SEMAPHORE_EMAIL_HOST: "localhost"  # (3)!¿˘˘˘˘˘˘˘˘˘¿¿˘˘˘˘˘˘˘˘˘˘˘˘˘˘˘˘˘˘˘˘˘˘˘˘˘˘˘˘˘˘˘˘˘
+SEMAPHORE_EMAIL_PORT: "25"  # (4)!¿˘˘˘˘˘˘
+SEMAPHORE_EMAIL_USERNAME: ""  # (5)!
+SEMAPHORE_EMAIL_PASSWORD: ""  # (6)!
+SEMAPHORE_EMAIL_SECURE: ""  # (7)!
+```
+
+1. Flag which enables email alerts. Can be `true` or '`false`.
+2. The email address you want to send to. Replace `""` with the email address you want to send to
+3. Replace `localhost` with your email host. IE: `smtp-relay.gmail.com`
+4. Replace `25` with your email port. IE: `587`
+5. Replace `""` with your email username if necessary.
+6. Replace `""` with your email password if necessary.
+7. Use `SSL` or `TLS` for communication with the SMTP server. Can be `true` or '`false`.
+
+``` yaml title="Semaphoreui Telgram Settings"
+
+SEMAPHORE_TELEGRAM_ALERT: ""  # (1)!
+SEMAPHORE_TELEGRAM_CHAT: ""  # (2)!
+SEMAPHORE_TELEGRAM_TOKEN: ""  # (3)!
+```
+
+1. Flag which enables telegram alerts. Can be `true` or '`false`.
+2. The chat id of which you want to send the message to
+3. Your Telegram bot token
+
+``` yaml title="Semaphoreui Telgram Settings"
+
+SEMAPHORE_SLACK_ALERT: ""  # (1)!
+SEMAPHORE_SLACK_URL: ""  # (2)!
+```
+
+1. Flag which enables telegram alerts. Can be `true` or '`false`.
+2. Your slack URL
+
+Redeploy the Semaphoreui role to apply any of the above changes.
diff --git a/docs/sandbox/index.md b/docs/sandbox/index.md
index 49c04b0f1..781f6fb7e 100644
--- a/docs/sandbox/index.md
+++ b/docs/sandbox/index.md
@@ -120,6 +120,7 @@ tags:
 - **[rfloodx](../sandbox/apps/rfloodx.md)**  - tag - `rfloodx`
 - **[rocketchat](../sandbox/apps/rocketchat.md)**  - tag - `rocketchat`
 - **[sabthrottle](../sandbox/apps/sabthrottle.md)**  - tag - `sandbox-sabthrottle`
+- **[semaphoreui](../sandbox/apps/semaphoreui.md)**  - tag - `sandbox-semaphoreui`
 - **[sarotate](../sandbox/apps/sarotate.md)**  - tag - `sandbox-sarotate`
 - **[speedtest](../sandbox/apps/speedtest.md)**  - tag - `sandbox-speedtest`
 - **[sqlitebrowser](../sandbox/apps/sqlitebrowser.md)**  - tag - `sandbox-sqlitebrowser`
diff --git a/mkdocs.yml b/mkdocs.yml
index 0964ebb38..9afa17a44 100644
--- a/mkdocs.yml
+++ b/mkdocs.yml
@@ -188,6 +188,7 @@ nav:
           - Mcrouter: sandbox/apps/mcrouter.md
           - OliveTin: sandbox/apps/olivetin.md
           - Reposilite: sandbox/apps/reposilite.md
+          - SepahoreUI: sandbox/apps/semasoreui.md
           - Tika: sandbox/apps/tika.md
         - Downloading:
           - AirDC++: sandbox/apps/airdcpp.md