diff --git a/README.md b/README.md index ccdd67b..47559df 100644 --- a/README.md +++ b/README.md @@ -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. +