diff --git a/docs/services/semaphore.md b/docs/services/semaphore.md new file mode 100644 index 0000000..fde6c08 --- /dev/null +++ b/docs/services/semaphore.md @@ -0,0 +1,43 @@ +# Semaphore + +[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`. diff --git a/docs/supported-services.md b/docs/supported-services.md index 7c28809..35aa295 100644 --- a/docs/supported-services.md +++ b/docs/supported-services.md @@ -59,6 +59,7 @@ | [Redis](https://redis.io/) | An in-memory data store used by millions of developers as a database, cache, streaming engine, and message broker. | [Link](services/redis.md) | | [Roundcube](https://roundcube.net/) | A browser-based multilingual IMAP client with an application-like user interface | [Link](services/roundcube.md) | | [rumqttd](https://github.com/bytebeamio/rumqtt) | A high performance, embeddable [MQTT](https://en.wikipedia.org/wiki/MQTT) broker | [Link](services/rumqttd.md) | +| [Ansible Semaphore](https://www.ansible-semaphore.com/) | A responsive web UI for running Ansible playbooks | [Link](services/semaphore.md) | | [Soft Serve](https://github.com/charmbracelet/soft-serve) | A tasty, self-hostable [Git](https://git-scm.com/) server for the command line | [Link](services/soft-serve.md) | | [Syncthing](https://syncthing.net/) | A continuous file synchronization program which synchronizes files between two or more computers in real time | [Link](services/syncthing.md) | | [Telegraf](https://www.influxdata.com/time-series-platform/telegraf/) | An open source server agent to help you collect metrics from your stacks, sensors, and systems. | [Link](services/telegraf.md) |