Zum Hauptinhalt springen

Konfigurationsdatei

Die Vorlage für die Konfigurationsdatei befindet sich in der Datei .env. Von dieser Datei muss eine Kopie .env.local erzeugt werden:

$ cp .env .env.local

Konfigurationsdatei anpassen​

Anschließend muss die Konfigurationsdatei angepasst werden.

Die folgenden zwei Einstellungen werden für die Konfiguration des Symfony Frameworks verwendet.

APP_ENV​

Dieser Wert muss immer prod enthalten, sodass das System in der Produktionsumgebung ist.

Achtung

In einer Produktionsumgebung niemals dev verwenden.

APP_SECRET​

Dieser Wert muss eine zufällige Zeichenfolge beinhalten. Mit dem folgenden Kommando kann eine entsprechende Zeichenfolge erstellt werden:

$ openssl rand -base64 32

Allgemeine Einstellungen​

APP_URL​

Dieser Wert beinhaltet die URL zur Instanz, bspw. https://icc.schulit.de/.

APP_NAME​

Dieser Wert beinhaltet den Namen der Anwendung. Standardmäßig ist dies Information & Communication Center, kann aber beliebig geändert werden, um z.B. den Schulnamen zu integrieren.

Dieses Logo wird im Footer der Website angezeigt. Es werden alle Formate unterstützt, die auch von Browsern unterstützt werden. Die Maße des Logos können frei gewählt werden. Das Logo wird automatisch auf eine Höhe von 80px vergrößert oder verkleinert (vom Browser).

Für das Logo sollte im Ordner public/images/ liegen. Der Pfad wird relativ zum public-Ordner angegeben.

Beispiel: Ist das Logo unter public/images/logo.svg gespeichert, muss images/logo.svg für den Parameter eingetragen werden.

Dieses Logo wird oben in der Navigationsleiste angezeigt. Es werden alle Formate unterstützt, die auch von Browsern unterstützt werden. Das Logo sollte quadratisch sein und wird automatisch auf eine Breite bzw. Höhe von 32px vergrößert.

Für das Logo sollte im Ordner public/images/ liegen. Der Pfad wird relativ zum public-Ordner angegeben.

Beispiel: Ist das Logo unter public/images/smalllogo.svg gespeichert, muss images/smalllogo.svg für den Parameter eingetragen werden.

SAML_ENTITY_ID​

Die sogenannte Entity ID dieses Identity Providers. Hier trägt man in der Regel die URL des Dienstes ein, also denselben Wert wie in APP_URL.

MAILER_FROM​

Die Absende-E-Mail-Adresse für ausgehende E-Mails.

MAILER_LIMIT​

Die Anzahl an E-Mails, die maximal pro Intervall (siehe MAILER_INTERVAL) versendet werden dürfen. Das ist wichtig, da das System Massen-Mails versendet (z.B. bei neuem Vertretungsplan oder neuen Mitteilungen).

MAILER_INTERVAL​

Das Intervall, in dem die in MAILER_LIMIT angegebene Anzahl an E-Mails verschickt werden darf.

Gewusst

Hier muss ein von PHP als gültiger Wert für relative Zeitangaben eingetragen werden, bspw. 1 minute, 1 hour. Siehe PHP Dokumentation

Gewusst (Microsoft 365)

Für Microsoft 365 findet man die entsprechenden Limits hier. Praktischerweise sind die Limits (30 E-Mails pro 1 Minute) bereits in der Standardkonfiguration abgedeckt.

CRON_PASSWORD​

Das Passwort für den Cronjob-Benutzer, sofern Cronjobs via HTTPs ausgeführt werden. Details siehe Cronjobs.

info

Der Konfigurationsparameter können zunächst übersprungen werden und zu einem späteren Zeitpunkt konfiguriert werden.

IMPORT_PSK​

Der Preshared-Key, der für den Import von Daten über die API-Schnittstelle verwendet wird.

NOTIFICATIONS_ENABLED​

Gibt an, ob das Benachrichtigungssystem grundsätzlich aktiviert (true) ist oder nicht (false).

ROOM_STATUS​

Gibt an, ob der Raumstatus aus dem ServiceCenter abgerufen werden soll (true) oder nicht (false). Siehe Raum- & Ressourcenreservierung.

SERVICECENTER_URL​

Die URL zum ServiceCenter (z.B. https://sc.schulit.de/). Wird für den Raumstatus benötigt (siehe ROOM_STATUS). Der Wert wird für den Fall, dass der Raumstatus deaktiviert ist, ignoriert.

SERVICECENTER_APITOKEN​

Das API-Token zum Abrufen des Raumstatus aus dem ServiceCenter. Der Wert wird für den Fall, dass der Raumstatus deaktiviert ist, ignoriert.

AUDIT_ENABLED​

Gibt an, ob der Auditierungsmechanismus aktiviert ist (true) oder nicht (false). Mehr unter Auditierung.

AUDIT_RETENTION_DAYS​

Gibt an, wie lange Einträge im Auditlog behalten werden (in Tagen). Täglich läuft ein Cronjob, welcher alte Einträge aus der Datenbank entfernt (und diese anschließend mittels OPTIMIZE TABLE optimiert).

Für einen Wert von 0 werden alle Einträge behalten. Das kann jedoch sehr große Datenbanken erzeugen.

Empfohlener Wert: 30 Tage

Mehr zur Aufbewahrungsrichtlinie gibt es Mehr unter hier.

PUSHOVER_TOKEN​

Für den Fall, dass Benachrichtigungen via Pushover gesendet werden sollen, muss das entsprechende Token hier hinterlegt werden.

DB_SECRET​

Mit diesem Schlüssel werden Einträge in der Datenbank verschlüsselt (aktuell Titel und Inhalte von privaten Nachrichten). Es wird ein 32 Byte langer hexadezimaler Schlüssel ([0-9a-fA-F]) benötigt. Die Erstellung gelingt zum Beispiel mittels OpenSSL:

$ openssl rand -hex 32

Datenbank​

DATABASE_URL​

Verbindungszeichenfolge für die Datenbankverbindung, welche sich wie folgt zusammensetzt:

mysql://USERNAME:PASSWORD@HOST:3306/NAME?serverVersion=mariadb-10.4.0&charset=utf8mb4
  • USERNAME: Benutzername der Datenbank
  • PASSWORD: zugehöriges Passwort des Datenbankbenutzers
  • HOST: Hostname des Datenbankservers
  • NAME: Name der Datenbank
  • den Parameter serverVersion entsprechend der MariaDB-Version anpassen (er kann aber auch auf 10.4 belassen werden, obwohl man eine höhere Version einsetzt)

Weitere Informationen zur Verbindungszeichenfolge gibt es hier.

LOCK_DSN​

Diesen Parameter NICHT verändern. Standardmäßig ist er auf semaphore konfiguriert.

E-Mail​

Damit das System E-Mails versenden kann, muss eine entsprechende Verbindungszeichenfolge zum Verbinden mit einem E-Mail-Postfach konfiguriert werden.

Beispiele:

  • Generischer SMTP-Versand: smtp://SMTPSERVER:465?encryption=ssl&auth_mode=login&username=USERNAME&password=PASSWORD
  • Google Mail-Postfach: gmail://USERNAME:PASSWORD@localhost
  • Microsoft 365-Postfach: smtp://EMAIL:PASSWORD@smtp.office365.com:587

Dabei sind die Parameter SMTPSERVER, USERNAME und PASSWORD entsprechend anzupassen.

Wichtig

Alle Parameter müssen URL-enkodiert angegeben werden. Zum Beispiel muss das @-Zeichen durch %40 ersetzt werden. Siehe Wikipedia

PHP-Executable​

Wenn Cronjobs ausgeführt werden, werden diese in einem separaten Prozess mithilfe dieser PHP Executable ausgeführt. Diese Variable muss auf die entsprechende PHP-Version (z.B. /usr/bin/php oder /usr/bin/php8.2) gesetzt werden. Anderenfalls kann die Ausführung von Cronjobs fehlerhaft sein.

Den Pfad zur PHP-Executable findet man entweder in der Dokumentation des Webhosters oder man findet sie z.B. mittels which heraus:

$ which php
$ which php8.2

MESSENGER_TRANSPORT_DSN​

Diesen Parameter NICHT verändern. Standardmäßig ist er auf doctrine://default konfiguriert.