IRIS Initial setup: Unterschied zwischen den Versionen
Ddang (Diskussion | Beiträge) (Die Seite wurde neu angelegt: „de:IRIS_Ersteinrichtung“) |
Ddang (Diskussion | Beiträge) |
||
Zeile 1: | Zeile 1: | ||
[[de:IRIS_Ersteinrichtung]] | [[de:IRIS_Ersteinrichtung]] | ||
+ | |||
+ | Bei der Ersteinrichtung von [[IRIS Cloudsystem|IRIS]] legen Sie die Basis-URL fest und konfigurieren einen SMTP-Account. | ||
+ | |||
+ | Diese Konfiguration ist für die weitere Funktion von IRIS unbedingt erforderlich. | ||
+ | |||
+ | == Web-Interface öffnen == | ||
+ | Die Konfiguration kann nach dem ersten Start von IRIS über das Web-Interface erreicht werden. | ||
+ | |||
+ | Loggen Sie sich hierzu über einen Admin-Account in IRIRS ein. | ||
+ | |||
+ | Sie finden dann links einen Menüpunkt namens "System settings". | ||
+ | |||
+ | |||
+ | Hinweis zum Admin-Account: | ||
+ | |||
+ | Beim ersten Start wird Ihnen ein Benutzer "root@localhost" automatisch erstellt. | ||
+ | |||
+ | Das Passwort finden Sie im Log und sieht ungefähr so aus: | ||
+ | 2023-02-08 17:22:38.926 -08 WARN [main] (init.ServiceInitializer:166) - A new user has been created.: | ||
+ | Username: root@localhost | ||
+ | Password: P6oV-GK3GYsdnn_5usDg1tBmn00 | ||
+ | Please login with this user and change your password immediately! | ||
+ | |||
+ | |||
+ | Wir empfehlen dringend, das Passwort als erstes zu ändern, hierzu können Sie nach dem Log-In rechts oben auf den Benutzer und dann "Change Password" klicken. | ||
+ | |||
+ | Ein Passwort muss mindestens 12 Zeichen lang sein und mindestens 3 der folgenden Kriterien entsprechen: | ||
+ | |||
+ | * Enthält Großbuchstaben A-Z | ||
+ | * Enthält Kleinbuchstaben a-z | ||
+ | * Enthält Nummern 0-9 | ||
+ | * Enthält Sonderzeichen !%$§~ä#... | ||
+ | |||
+ | == Konfiguration == | ||
+ | |||
+ | === General Settings === | ||
+ | |||
+ | ==== Base URL ==== | ||
+ | Die URL, von dem IRIS erreichbar sein wird. Entspricht der (Sub-)Domain ohne Pfadangabe und ohne abschließendem Slash, z.B. <nowiki>https://iris.firmenname.de</nowiki> | ||
+ | |||
+ | === SMTP Settings === | ||
+ | |||
+ | ==== SMTP host ==== | ||
+ | Der Servername von Ihrem SMTP Server, bei Microsoft 365 ist das z.B. smtp.office365.com | ||
+ | |||
+ | ==== SMTP port ==== | ||
+ | Der Port, auf dem Ihr SMTP Server hört, bei Microsoft 356 ist das z.B. 587 | ||
+ | |||
+ | ==== TLS ==== | ||
+ | Aktivieren Sie das Häkchen, wenn die Verbindung mit dem SMTP Server per TLS verschlüsselt werden soll, andernfalls nicht | ||
+ | |||
+ | ==== SMTP sender e-mail address ==== | ||
+ | Die Absender E-Mail Adresse von dem IRIS aus Mails verschicken soll. | ||
+ | |||
+ | ==== SMTP username ==== | ||
+ | Der Benutzername, mit dem man sich beim SMTP Server anmeldet. Manchmal identisch mit der Absender E-Mail. | ||
+ | |||
+ | ==== SMTP authentication type ==== | ||
+ | IRIS unterstützt die Anmeldung per Password oder auch OAuth2. | ||
+ | |||
+ | Die Password-Authentifizierung ist einfacher einzurichten, Sie müssen allerdings auch sicherstellen, dass das Passwort nicht abläuft. | ||
+ | |||
+ | Wählen Sie Password oder OAuth2 aus. | ||
+ | |||
+ | Die OAuth2-Authentifizierung wird weiter unten beschrieben. | ||
+ | |||
+ | ==== SMTP password ==== | ||
+ | (Nur bei Authentifizierungs-Typ Password) | ||
+ | |||
+ | Das Password, mit dem sich IRIS beim SMTP Server anmelden soll. | ||
+ | |||
+ | ==== Test E-Mail ==== | ||
+ | Wenn Sie alle Einstellungen eingetragen haben, können Sie über diesen Button eine Test-E-Mail versenden. | ||
+ | |||
+ | Bitte beachten Sie, dass zu diesem Zeitpunkt noch keine Einstellungen gespeichert wurden. | ||
+ | |||
+ | Es wird mit den momentan im Browser eingetragenen (ungespeicherten) Einstellungen getestet. | ||
+ | |||
+ | |||
+ | |||
+ | === SMTP mit OAuth2 === | ||
+ | Falls Sie als SMTP-Authentifizierung Password gewählt haben, können Sie dieses Kapitel überspringen. | ||
+ | |||
+ | Um OAuth2 als SMTP-Authentifizierung zu nutzen, wählen Sie bei SMTP authentication type OAuth2 aus. | ||
+ | |||
+ | Bitte tragen Sie die restlichen Einstellungen unter System configuration bis auf das Token ein und speichern diese Einstellungen. | ||
+ | |||
+ | Danach gehen Sie in IRIS bitte in den Menüpunkt "OAuth2 Clients". | ||
+ | |||
+ | ==== OAuth2 clients ==== | ||
+ | Im Standard gibt es noch keine angelegten OAuth2 Clients. | ||
+ | |||
+ | Nachdem Sie in der Systemkonfiguration eine Base URL gespeichert haben, erhalten Sie in diesem Menü eine Redirect URI, die Sie bei der Registrierung des OAuth2 Clients bei Ihrem E-Mail Provider verwenden können (bei Microsoft 365 müssen Sie unter portal.azure.com eine neue App-Registrierung vornehmen, wo Sie diese Redirect URI eintragen müssen). | ||
+ | |||
+ | Klicken Sie auf den Button "New app", um einen neuen OAuth2 client zu erstellen. | ||
+ | |||
+ | ==== Name ==== | ||
+ | Den Namen, den Sie hier eingeben, dient nur als Referenz für Sie. | ||
+ | |||
+ | ==== Client ID ==== | ||
+ | Die Client ID erhalten Sie nach der Registrierung des OAuth2 Clients bei Ihrem E-Mail Provider. | ||
+ | |||
+ | ==== Client Secret ==== | ||
+ | Das Client Secret erhalten Sie nach der Registrierung des OAuth2 Clients bei Ihrem E-Mail Provider. | ||
+ | |||
+ | ==== Authorization URL ==== | ||
+ | Das ist die URL, die IRIS bei der ersten Autorisierung per Browser öffnen soll. | ||
+ | |||
+ | Bei einer unter Azure angelegten App, die nur von Ihrer Organisation verwendbar ist, verwenden Sie diese URL: | ||
+ | |||
+ | <nowiki>https://login.microsoftonline.com/organizations/oauth2/v2.0/authorize</nowiki> | ||
+ | |||
+ | ==== Token URL ==== | ||
+ | Das ist die URL, die IRIS zum Anfordern eines Tokens aufrufen soll. | ||
+ | |||
+ | Bei einer unter Azure angelegten App, die nur von Ihrer Organisation verwendbar ist, verwenden Sie diese URL: | ||
+ | |||
+ | <nowiki>https://login.microsoftonline.com/organizations/oauth2/v2.0/token</nowiki> | ||
+ | |||
+ | ==== Refresh Token URL ==== | ||
+ | Das ist die URL, die IRIS zum Anfordern eines Refresh-Tokens aufrufen soll. | ||
+ | |||
+ | Bei einer unter Azure angelegten App, die nur von Ihrer Organisation verwendbar ist, verwenden Sie diese URL: | ||
+ | |||
+ | <nowiki>https://login.microsoftonline.com/organizations/oauth2/v2.0/token</nowiki> | ||
+ | |||
+ | ==== Scope ==== | ||
+ | Den Scope, den IRIS bei einer Token-Anfrage anfordern soll. | ||
+ | |||
+ | Bei einer unter Azure angelegten App verwenden Sie diesen Scope: | ||
+ | |||
+ | offline_access <nowiki>https://outlook.office.com/SMTP.Send</nowiki> | ||
+ | |||
+ | ==== Erstellte Anwendung autorisieren ==== | ||
+ | Sobald Sie den Client erstellt haben, klicken Sie bitte in dem neu erstellten Client auf den Button "Authorize". | ||
+ | |||
+ | Danach öffnet sich ein Browser-Fenster, wo Sie sich auf der Seite des E-Mail Betreibers (z.B. Microsoft) einloggen können und den Zugriff Ihrer Anwendung bestätigen können. | ||
+ | |||
+ | Achtung: Bitte seien Sie sich bewusst, unter welchem Account Sie die Freigabe auf der Seite des E-Mail Betreibers durchführen. | ||
+ | |||
+ | Sollten Sie für E-Mails einen anderen als Ihrem eigenen Account (auf Seite des E-Mail Betreibers) verwenden möchten, müssen Sie sich zuerst auf der Seite des Betreibers ausloggen oder ggf. die Authorisierung über ein privates Browser-Fenster öffnen. |
Version vom 26. April 2023, 14:59 Uhr
Bei der Ersteinrichtung von IRIS legen Sie die Basis-URL fest und konfigurieren einen SMTP-Account.
Diese Konfiguration ist für die weitere Funktion von IRIS unbedingt erforderlich.
Web-Interface öffnen
Die Konfiguration kann nach dem ersten Start von IRIS über das Web-Interface erreicht werden.
Loggen Sie sich hierzu über einen Admin-Account in IRIRS ein.
Sie finden dann links einen Menüpunkt namens "System settings".
Hinweis zum Admin-Account:
Beim ersten Start wird Ihnen ein Benutzer "root@localhost" automatisch erstellt.
Das Passwort finden Sie im Log und sieht ungefähr so aus:
2023-02-08 17:22:38.926 -08 WARN [main] (init.ServiceInitializer:166) - A new user has been created.: Username: root@localhost Password: P6oV-GK3GYsdnn_5usDg1tBmn00 Please login with this user and change your password immediately!
Wir empfehlen dringend, das Passwort als erstes zu ändern, hierzu können Sie nach dem Log-In rechts oben auf den Benutzer und dann "Change Password" klicken.
Ein Passwort muss mindestens 12 Zeichen lang sein und mindestens 3 der folgenden Kriterien entsprechen:
- Enthält Großbuchstaben A-Z
- Enthält Kleinbuchstaben a-z
- Enthält Nummern 0-9
- Enthält Sonderzeichen !%$§~ä#...
Konfiguration
General Settings
Base URL
Die URL, von dem IRIS erreichbar sein wird. Entspricht der (Sub-)Domain ohne Pfadangabe und ohne abschließendem Slash, z.B. https://iris.firmenname.de
SMTP Settings
SMTP host
Der Servername von Ihrem SMTP Server, bei Microsoft 365 ist das z.B. smtp.office365.com
SMTP port
Der Port, auf dem Ihr SMTP Server hört, bei Microsoft 356 ist das z.B. 587
TLS
Aktivieren Sie das Häkchen, wenn die Verbindung mit dem SMTP Server per TLS verschlüsselt werden soll, andernfalls nicht
SMTP sender e-mail address
Die Absender E-Mail Adresse von dem IRIS aus Mails verschicken soll.
SMTP username
Der Benutzername, mit dem man sich beim SMTP Server anmeldet. Manchmal identisch mit der Absender E-Mail.
SMTP authentication type
IRIS unterstützt die Anmeldung per Password oder auch OAuth2.
Die Password-Authentifizierung ist einfacher einzurichten, Sie müssen allerdings auch sicherstellen, dass das Passwort nicht abläuft.
Wählen Sie Password oder OAuth2 aus.
Die OAuth2-Authentifizierung wird weiter unten beschrieben.
SMTP password
(Nur bei Authentifizierungs-Typ Password)
Das Password, mit dem sich IRIS beim SMTP Server anmelden soll.
Test E-Mail
Wenn Sie alle Einstellungen eingetragen haben, können Sie über diesen Button eine Test-E-Mail versenden.
Bitte beachten Sie, dass zu diesem Zeitpunkt noch keine Einstellungen gespeichert wurden.
Es wird mit den momentan im Browser eingetragenen (ungespeicherten) Einstellungen getestet.
SMTP mit OAuth2
Falls Sie als SMTP-Authentifizierung Password gewählt haben, können Sie dieses Kapitel überspringen.
Um OAuth2 als SMTP-Authentifizierung zu nutzen, wählen Sie bei SMTP authentication type OAuth2 aus.
Bitte tragen Sie die restlichen Einstellungen unter System configuration bis auf das Token ein und speichern diese Einstellungen.
Danach gehen Sie in IRIS bitte in den Menüpunkt "OAuth2 Clients".
OAuth2 clients
Im Standard gibt es noch keine angelegten OAuth2 Clients.
Nachdem Sie in der Systemkonfiguration eine Base URL gespeichert haben, erhalten Sie in diesem Menü eine Redirect URI, die Sie bei der Registrierung des OAuth2 Clients bei Ihrem E-Mail Provider verwenden können (bei Microsoft 365 müssen Sie unter portal.azure.com eine neue App-Registrierung vornehmen, wo Sie diese Redirect URI eintragen müssen).
Klicken Sie auf den Button "New app", um einen neuen OAuth2 client zu erstellen.
Name
Den Namen, den Sie hier eingeben, dient nur als Referenz für Sie.
Client ID
Die Client ID erhalten Sie nach der Registrierung des OAuth2 Clients bei Ihrem E-Mail Provider.
Client Secret
Das Client Secret erhalten Sie nach der Registrierung des OAuth2 Clients bei Ihrem E-Mail Provider.
Authorization URL
Das ist die URL, die IRIS bei der ersten Autorisierung per Browser öffnen soll.
Bei einer unter Azure angelegten App, die nur von Ihrer Organisation verwendbar ist, verwenden Sie diese URL:
https://login.microsoftonline.com/organizations/oauth2/v2.0/authorize
Token URL
Das ist die URL, die IRIS zum Anfordern eines Tokens aufrufen soll.
Bei einer unter Azure angelegten App, die nur von Ihrer Organisation verwendbar ist, verwenden Sie diese URL:
https://login.microsoftonline.com/organizations/oauth2/v2.0/token
Refresh Token URL
Das ist die URL, die IRIS zum Anfordern eines Refresh-Tokens aufrufen soll.
Bei einer unter Azure angelegten App, die nur von Ihrer Organisation verwendbar ist, verwenden Sie diese URL:
https://login.microsoftonline.com/organizations/oauth2/v2.0/token
Scope
Den Scope, den IRIS bei einer Token-Anfrage anfordern soll.
Bei einer unter Azure angelegten App verwenden Sie diesen Scope:
offline_access https://outlook.office.com/SMTP.Send
Erstellte Anwendung autorisieren
Sobald Sie den Client erstellt haben, klicken Sie bitte in dem neu erstellten Client auf den Button "Authorize".
Danach öffnet sich ein Browser-Fenster, wo Sie sich auf der Seite des E-Mail Betreibers (z.B. Microsoft) einloggen können und den Zugriff Ihrer Anwendung bestätigen können.
Achtung: Bitte seien Sie sich bewusst, unter welchem Account Sie die Freigabe auf der Seite des E-Mail Betreibers durchführen.
Sollten Sie für E-Mails einen anderen als Ihrem eigenen Account (auf Seite des E-Mail Betreibers) verwenden möchten, müssen Sie sich zuerst auf der Seite des Betreibers ausloggen oder ggf. die Authorisierung über ein privates Browser-Fenster öffnen.