English Version

Zurück zur Übersicht

LeaveFlow: Installation

Voraussetzungen

Du brauchst Docker mit dem Compose-Plugin (docker compose) und Git. PHP und MariaDB musst du nicht selbst installieren, beides liefert der Compose-Stack. Die weiteren Anforderungen stehen auf der Übersichtsseite.

Installation

1. Repository klonen:

   git clone https://github.com/markus-michalski/leaveflow.git
   cd leaveflow
   

2. Container starten (baut das Image und startet App, Datenbank, Mailpit und OpenLDAP):

   docker compose up -d --build
   

   Beim ersten Start installiert der Container die Composer-Abhängigkeiten selbst und baut das Tailwind-Stylesheet. Das dauert einen Moment, den Fortschritt siehst du mit docker compose logs -f app.

3. Datenbankmigrationen ausführen:

   docker compose exec -u app app php bin/console doctrine:migrations:migrate --no-interaction
   

4. Die Anwendung im Browser öffnen: http://localhost:8080. Solange noch kein Unternehmen existiert, leitet LeaveFlow jede Seite auf den Einrichtungsassistenten unter /setup um.

Der Stack ist ein Entwicklungs-Stack: compose.yaml baut das Docker-Ziel dev und setzt APP_ENV: dev. Die Host-Ports kommen aus compose.override.yaml (8080:80, 8443:443 und 3306, 1025, 8025 für Datenbank und Mailpit). Das Dockerfile enthält zusätzlich ein Ziel prod, eine fertige Produktions-Compose-Datei liefert das Repository nicht mit.

Einrichtungsassistent

Der Assistent unter /setup prüft zuerst die Systemvoraussetzungen und legt danach Unternehmen und ersten Admin an.

Solange eine Prüfung rot ist, lässt sich das Formular nicht absenden. Das Formular verlangt Firmenname, Admin-E-Mail und ein Admin-Passwort mit mindestens 12 Zeichen. Der Assistent legt ausschließlich das Unternehmen und das Admin-Konto an und ist einmalig. Nach der Anlage zeigt er die Abschlussseite unter /setup/done mit einer Liste der nächsten Schritte und der Schaltfläche Zur Anmeldung, die zur Anmeldeseite führt.

Der Assistent legt weder Urlaubsarten noch Standorte, Teams oder Mitarbeiter an. Das erledigst du danach im Admin-Menü, die Reihenfolge steht im Admin-Leitfaden.

Konfiguration über Umgebungsvariablen

Symfony liest .env, .env.local und .env.dev. Umgebungsvariablen, die der Container direkt erhält, haben Vorrang vor allen diesen Dateien.

compose.yaml setzt DATABASE_URL (mit dem Passwort !ChangeMe!) und MAILER_DSN (smtp://mailer:1025) fest als Umgebungsvariablen des Containers. Werte aus .env.local greifen für diese beiden Variablen deshalb nicht. Zum Ändern passt du compose.yaml an und änderst das Datenbankpasswort an allen drei Stellen (MARIADB_PASSWORD, MARIADB_ROOT_PASSWORD und DATABASE_URL).

Es gibt keine Variable APP_URL. Die Basis-URL für Links außerhalb von Browser-Anfragen setzt DEFAULT_URI.

SERVER_NAME wertet Docker Compose beim Start aus der Shell-Umgebung oder der .env im Projektverzeichnis aus, nicht aus .env.local. Den Schlüssel für APP_LDAP_ENCRYPTION_KEY erzeugst du mit:

php -r "echo base64_encode(random_bytes(SODIUM_CRYPTO_SECRETBOX_KEYBYTES)) . PHP_EOL;"

Ohne diesen Schlüssel lassen sich Slack-Token, Slack-Signing-Secret und das LDAP-Bind-Passwort nicht speichern. Wer den Schlüssel später ändert, kann bereits gespeicherte Werte nicht mehr entschlüsseln.

HTTPS und Domain

Die PHP-Konfiguration setzt Session-Cookies mit session.cookie_secure = 1. Betreibe die Instanz deshalb außerhalb von localhost hinter HTTPS und setze DEFAULT_URI auf die öffentliche Adresse. Der integrierte Webserver (Caddy in FrankenPHP) bedient die in SERVER_NAME angegebene Adresse.

Update

git pull
docker compose up -d --build
make install
docker compose exec -u app app php bin/console doctrine:migrations:migrate --no-interaction

Offene Migrationen zeigt dir der Einrichtungsassistent nicht mehr an, sobald ein Unternehmen existiert. Spiele sie deshalb nach jedem Update ein.

Entwicklungsumgebung

make fixtures leert die Datenbank vollständig, bevor die Demo-Daten geladen werden. Führe den Befehl niemals gegen eine Instanz mit echten Daten aus.

Nach make fixtures gibt es das Demo-Unternehmen mit Standorten, Teams, Mitarbeitern, sieben Urlaubsarten und drei Testkonten.

Mailpit, der E-Mail-Catcher des Stacks, ist unter http://localhost:8025 erreichbar.