mirror of
https://github.com/mother-of-all-self-hosting/mash-playbook
synced 2024-11-13 23:57:06 +00:00
docs: Add basic docs for semaphore
This commit is contained in:
parent
cccae8a376
commit
643d071de1
1 changed files with 43 additions and 0 deletions
43
docs/services/semaphore.md
Normal file
43
docs/services/semaphore.md
Normal file
|
@ -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`.
|
Loading…
Reference in a new issue