„README.md“ ändern

This commit is contained in:
sqrt1764 2022-12-10 16:12:48 +01:00
parent 8c7e8fbe05
commit c8cd8ac1a4

View file

@ -1,2 +1,27 @@
# ansible-role-lstu Lstu
=====
Diese Rolle installiert [Lstu](https://framagit.org/fiat-tux/hat-softwares/lstu), ein Kurzlink-Dienst. Sie umfasst:
- Einrichtung der Datenbank
- Zertifikatserstellung und Einrichtung des Reverse Proxies
- Einrichtung der automatischen Aktualisierung per cron (geplant?)
# Ausführen der Rolle
- Festlegen der Variablen:
| Variable | Ort | Beschreibung |
|----------|-----|--------------|
| `lstu.domain` | `host_vars` | Domain unter der der Diest erreichbar ist |
| `lstu.path` | `host_vars` | Pfad im Dateisystem, in dem Lstu liegt |
| `lstu.contact` | `host_vars` | Kontakt Email, die auf dem UI angezeigt wird |
| `lstu.admin_passwd` | `host_vars` | Passwort zur Verwaltung von Statistik und Links |
| `database_host` | `group_vars` | Mysql/MariaDB Datenbankserver |
| `gateway_host` | `group_vars` | Webproxy |
- Ausführen des Playbooks mit:
```Shell
ansible-playbook playbooks/lstu.yml
```
# Nacharbeiten
Nach der Erstinstallation kann die Datei `lstu.conf` angepasst werden.