docs: standardize readme format

This commit is contained in:
Simon Cornet 2026-04-10 09:00:18 +02:00
commit 04419189d9

View file

@ -1,13 +1,34 @@
# Overview # Ansible Role: Semaphore
This role configures [SemaphoreUI](<https://semaphoreui.com/>) server, for reasons. Install and configure [Semaphore UI](https://semaphoreui.com/) - a modern UI for Ansible.
## Supported Operating Systems ## Variables
| Operating System | Version | | Variable | Required | Default | Description |
| --- | ----- | |----------|----------|---------|-------------|
| Debian | 13 | | `mitogen_version` | No | `0.3.45` | Mitogen version to install |
| `semaphore_admin_username` | No | `admin` | Admin username |
| `semaphore_admin_password` | Yes | `admin` | Admin password |
| `semaphore_admin_name` | No | `Administrator` | Admin display name |
| `semaphore_admin_email` | No | `admin@example.com` | Admin email |
| `semaphore_runner_token` | Yes | `runner-token` | Runner authentication token |
| `semaphore_email_sender` | No | `semaphore@example.com` | Email sender address |
| `semaphore_email_host` | No | `smtp` | SMTP host |
| `semaphore_email_port` | No | `465` | SMTP port |
| `semaphore_email_username` | No | `smtp-user` | SMTP username |
| `semaphore_email_password` | Yes | `smtp-pass` | SMTP password |
| `semaphore_ansible_ssh_key` | Yes | - | Ansible SSH private key |
| `semaphore_ssh_config` | No | - | SSH config content |
## Tags ## Example
This role has no tags. ```yaml
mitogen_version: "0.3.45"
semaphore_admin_username: "admin"
semaphore_admin_password: "secure_password"
semaphore_admin_email: "admin@example.com"
semaphore_runner_token: "secure-runner-token"
semaphore_email_host: "smtp.example.com"
semaphore_email_password: "smtp_password"
semaphore_ansible_ssh_key: "{{ vault_ansible_ssh_key }}"
```