Loheide-eu-mitarbeiterplatt.../docs/INSTALLATION.md
Friederich Loheide 51c94cd0cf
Some checks failed
CI / PHP 8.4 / mariadb:10.6 (pull_request) Successful in 1m37s
CI / PHP 8.3 / mariadb:10.6 (pull_request) Successful in 1m41s
CI / PHP 8.3 / mariadb:11.4 (pull_request) Successful in 1m40s
CI / PHP 8.4 / mariadb:11.4 (pull_request) Successful in 1m42s
CI / PHP 8.3 / mysql:8.0 (pull_request) Failing after 2m10s
CI / PHP 8.4 / mysql:8.0 (pull_request) Failing after 2m6s
CI / PHP 8.4 / mysql:8.4 (pull_request) Failing after 1m55s
CI / PHP 8.3 / mysql:8.4 (pull_request) Failing after 2m2s
CI / Build-Artefakte aktuell (pull_request) Successful in 52s
Anmeldung mit Microsoft Entra ID
- OpenID Connect mit PKCE, State und Nonce; ID-Token-Prüfung gegen die
  Microsoft-Schlüssel (Signatur, Mandant, App, Gültigkeit, Nonce) inkl.
  Neuladen bei Schlüsselwechsel
- Konto bei erster Anmeldung anlegen oder per E-Mail verknüpfen, optionale
  Domain-Beschränkung, deaktivierte Konten bleiben gesperrt
- Gruppen (inkl. Overage über Graph, transitiv) und App-Rollen → Rollen,
  additiv; nur Zuweisungen aus Entra werden abgeglichen, manuelle bleiben
- Profilfelder, Vorgesetzte*r und Profilfoto aus Graph, je Feld wählbar und
  im Portal schreibgeschützt; Fallback auf Token-Angaben, wenn Graph ausfällt
- Hintergrund-Abgleich mit Delta-Abfragen (Zeitbudget, Fortsetzung über
  nextLink/deltaLink), Offboarding deaktivierter/gelöschter Konten, optionale
  Vorab-Anlage, Fotos/Vorgesetzte rollierend, Gruppen und App-Rollen stündlich
- Admin „Anmeldung“: Einrichtung mit Umleitungs-URI und Berechtigungen,
  verschlüsseltes Geheimnis (nie im Browser), Gruppensuche, Status, „Mapping testen“
- Fix: @odata.nextLink/@odata.deltaLink wurden als Pfad gelesen – Folgeseiten fehlten
- Profilseite mit Vorgesetzter/m und Mitarbeitenden; Version 0.4.0

Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com>
2026-09-26 07:52:22 +00:00

87 lines
4.3 KiB
Markdown
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

# Installation und Betrieb
Diese Anleitung richtet sich an die IT bzw. an die Person, die das Portal beim
Hoster einrichtet. Shell-Zugang wird nicht benötigt.
## Voraussetzungen
- PHP **8.3** oder neuer mit den Erweiterungen `pdo_mysql`, `mbstring`,
`openssl`, `intl`, `gd`, `zip`, `fileinfo`, `tokenizer`, `ctype`, `xml`, `dom`
- **MySQL ab 8.0** oder **MariaDB ab 10.6** – eine leere Datenbank samt Benutzer
- Apache mit `mod_rewrite` (Einstellungen per `.htaccess` müssen erlaubt sein)
- Empfohlen: OPcache, `memory_limit` ≥ 128M, `upload_max_filesize` ≥ 8M, HTTPS
- Ausgehende HTTPS-Verbindungen zu `update.loheide.cloud` und
`api.loheide.cloud` (für Aktualisierungen und Rückmeldungen)
## Einrichtung
1. Das Installationsarchiv entpacken und **alle** Dateien per FTP/SFTP oder
Dateimanager in das gewünschte Verzeichnis hochladen.
2. Webroot festlegen:
- **Empfohlen:** Die Domain zeigt auf das Unterverzeichnis `public/`.
- Lässt der Hoster das nicht zu, zeigt die Domain auf das
Installationsverzeichnis – die mitgelieferte `.htaccess` leitet dann alle
Anfragen nach `public/` weiter.
3. Schreibrechte für den Webserver: `storage/`, `bootstrap/cache/`,
`public/uploads/` und – damit Aktualisierungen per Klick funktionieren – für
das gesamte Installationsverzeichnis.
4. Die Adresse des Portals im Browser aufrufen. Der Einrichtungsassistent führt
durch **Systemprüfung → Datenbank → Administrator**. Lizenz-E-Mail und
Lizenzschlüssel können dabei oder später eingetragen werden.
5. Mit dem Administratorkonto anmelden und unter **Administration →
Systemzustand** die Hinweise durchgehen.
> Solange die Einrichtung nicht abgeschlossen ist, kann jede Person, die die
> Adresse kennt, den Assistenten ausfüllen. Die Einrichtung daher direkt nach
> dem Hochladen abschließen.
## Anmeldung mit Microsoft Entra ID
1. Im [Microsoft Entra Admin Center](https://entra.microsoft.com) unter
**App-Registrierungen → Neue Registrierung** eine App anlegen
(„Nur Konten in diesem Organisationsverzeichnis“).
2. **Umleitungs-URI** (Plattform „Web“): die Adresse, die im Portal unter
**Administration → Anmeldung** angezeigt wird (`https://portal.firma.de/auth/entra/callback`).
3. **Zertifikate & Geheimnisse → Neuer geheimer Clientschlüssel** und den *Wert* notieren.
4. **API-Berechtigungen → Microsoft Graph:**
- delegiert: `User.Read`, `GroupMember.Read.All`
- für den Hintergrund-Abgleich zusätzlich als Anwendung: `User.Read.All`,
`GroupMember.Read.All`, `Application.Read.All` (nur für App-Rollen)
- danach **Administratorzustimmung erteilen**.
5. Im Portal unter **Administration → Anmeldung** Verzeichnis-ID,
Anwendungs-ID und Geheimnis eintragen, Gruppen den Rollen zuordnen und die
Anmeldung aktivieren. Mit **Mapping testen** lässt sich vorab prüfen,
welche Rollen eine Person erhalten wird.
Die Anmeldung mit Passwort bleibt für Notfälle erhalten (z. B. wenn Entra ID
nicht erreichbar ist). Den geheimen Clientschlüssel vor Ablauf erneuern – er
ist bei Microsoft befristet.
## Hintergrundaufgaben
Rückmeldungen, geplante Inhalte und Aufräumarbeiten laufen im Hintergrund. Die
genauen Angaben zeigt **Systemzustand** an.
- **Am besten:** Cronjob beim Hoster, jede Minute:
`cd /pfad/zum/portal && php artisan schedule:run`
- **Ohne Cron-Zugang:** die unter Systemzustand angezeigte geheime
Web-Cron-Adresse jede Minute von einem externen Cron-Dienst aufrufen lassen.
- **Ohne beides** laufen die Aufgaben beim Aufruf von Seiten mit – das
funktioniert, ist aber weniger zuverlässig.
## Aktualisierungen
Unter **Administration → Aktualisierung**: „Nach Updates suchen“ und „Jetzt
aktualisieren“. Das Portal zeigt währenddessen eine Wartungsseite, übernimmt
die neue Fassung, bringt die Datenbank auf den neuen Stand und ist nach
wenigen Minuten wieder erreichbar. `.env`, `storage/`, hochgeladene Dateien
und Plugins werden dabei nie verändert.
Voraussetzung ist eine gültige Lizenz. Ein Lizenzproblem schränkt die Nutzung
des Portals nicht ein – es verhindert nur den Bezug neuer Fassungen.
## Umzug auf einen anderen Server
Alle Dateien (inklusive `.env` und `storage/`) und die Datenbank übertragen.
Anschließend unter **Aktualisierung** die alte Installation abmelden bzw. die
Lizenz neu prüfen – jede Installation belegt einen Geräteplatz der Lizenz.