Zum Hauptinhalt springen

Konfigurationsdatei

Konfigurationsdatei anlegen​

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.

Symfony-Einstellungen​

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://servicecenter.schulit.de/.

APP_NAME​

Dieser Wert beinhaltet den Namen der Anwendung. Standardmäßig ist dies SchulIT ServiceCenter, 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.

IDP_PROFILE_URL​

URL zur Seite Konto-Einstellungen im Single Sign-On. Dieser Link wird im Menü unter dem Benutzernamen angezeigt.

In der Regel: https://sso.example.com/profile

IDP_LOGOUT_URL​

URL zum Abmelden im Single Sign-On. Dieser Link wird angezeigt, wenn man sich nach dem Ausloggen für die Option Überall abmelden entscheidet.

In der Regel: https://sso.example.com/logout

IDP_METADATA_URL​

URL für den Download der XML-Konfiguration des Single Sign-Ons. Dies erspart das händische Herunterladen.

In der Regel: https://sso.example.com/metadata

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.

Datenbank​

DATABASE_URL​

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

mysql://USERNAME:PASSWORD@HOST:3306/NAME
  • USERNAME: Benutzername der Datenbank
  • PASSWORD: zugehöriges Passwort des Datenbankbenutzers
  • HOST: Hostname des Datenbankservers
  • NAME: Name der Datenbank

Weitere Informationen zur Verbindungszeichenfolge gibt es hier.

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