IRIS Initial setup: Unterschied zwischen den Versionen
Ddang (Diskussion | Beiträge) |
Ddang (Diskussion | Beiträge) |
||
| Zeile 40: | Zeile 40: | ||
==== Base URL ==== | ==== Base URL ==== | ||
| − | URL that leads to IRIS. It is equivalent to the (Sub-)Domain without path specification and without trailing slash, e.g. <nowiki>https://iris.firmenname.de</nowiki> | + | The URL that leads to IRIS. It is equivalent to the (Sub-)Domain without path specification and without trailing slash, e.g. <nowiki>https://iris.firmenname.de</nowiki> |
=== SMTP Settings === | === SMTP Settings === | ||
==== SMTP host ==== | ==== SMTP host ==== | ||
| − | + | The server name of your SMTP server, e.g. smtp.office356.com for Microsoft 356 | |
==== SMTP port ==== | ==== SMTP port ==== | ||
| − | + | The port uesd by your SMTP server, e.g. 587 for Microsoft 356 | |
==== TLS ==== | ==== TLS ==== | ||
| − | + | Place the checkmark only if the connection with the SMTP server should be encoded via TLS. | |
==== SMTP sender e-mail address ==== | ==== SMTP sender e-mail address ==== | ||
| − | + | The sender e-mail address which IRIS should use for sending mails. | |
==== SMTP username ==== | ==== SMTP username ==== | ||
| − | + | The username used to login to the SMTP server. Sometimes identical with the sender e-mail. | |
==== SMTP authentication type ==== | ==== SMTP authentication type ==== | ||
| − | IRIS | + | IRIS supports the login via password or OAuth2 as well. |
| − | + | The password authentification is easier to setup, but you have to make sure that the password does not expire. | |
| − | + | Choose between password and OAuth2. | |
| − | + | The OAuth2 authentification is explained further down. | |
==== SMTP password ==== | ==== SMTP password ==== | ||
| − | ( | + | (Only for password authentification) |
| − | + | The password which IRIS should use to login to the SMTP server. | |
==== Test E-Mail ==== | ==== Test E-Mail ==== | ||
Version vom 3. Mai 2023, 14:58 Uhr
At the initial setup for IRIS, you determine the base url and configure a SMTP-Account.
This configuration is necessary for further functionality of IRIS.
Open Web-Interface
The configuration can be accessed over the Web-Interface after the first launch of IRIS.
For that, you need to log in to IRIS with an admin-account.
On the left, you will find a menu option called "System Settings".
Note for the admin-account:
At the first launch, a user "root@localhost" will automatically be generated for you.
You can find the password in the log, which looks like following:
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!
We strongly recommend to change the password immediately, here you can go to user on the top right after the login, and then click "Change Password".
A password must contain at least 12 characters and fulfill at least 3 of the following conditions:
- contains uppercase letters A-Z
- contains lowercase letters a-z
- contains numbers 0-9
- contains special characters !%$§~ä#...
Konfiguration
General Settings
Base URL
The URL that leads to IRIS. It is equivalent to the (Sub-)Domain without path specification and without trailing slash, e.g. https://iris.firmenname.de
SMTP Settings
SMTP host
The server name of your SMTP server, e.g. smtp.office356.com for Microsoft 356
SMTP port
The port uesd by your SMTP server, e.g. 587 for Microsoft 356
TLS
Place the checkmark only if the connection with the SMTP server should be encoded via TLS.
SMTP sender e-mail address
The sender e-mail address which IRIS should use for sending mails.
SMTP username
The username used to login to the SMTP server. Sometimes identical with the sender e-mail.
SMTP authentication type
IRIS supports the login via password or OAuth2 as well.
The password authentification is easier to setup, but you have to make sure that the password does not expire.
Choose between password and OAuth2.
The OAuth2 authentification is explained further down.
SMTP password
(Only for password authentification)
The password which IRIS should use to login to the SMTP server.
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.