IRIS Ersteinrichtung - Versionsgeschichte

Ddang am 26. April 2023 um 13:16 Uhr

2023-04-26T13:16:41Z

Ddang am 26. April 2023 um 12:58 Uhr

2023-04-26T12:58:38Z

Sbaumbach am 8. März 2023 um 13:01 Uhr

2023-03-08T13:01:28Z

Sbaumbach am 16. Februar 2023 um 15:33 Uhr

2023-02-16T15:33:08Z

Sbaumbach am 9. Februar 2023 um 16:16 Uhr

2023-02-09T16:16:04Z

Sbaumbach am 9. Februar 2023 um 15:56 Uhr

2023-02-09T15:56:38Z

Sbaumbach am 9. Februar 2023 um 15:55 Uhr

2023-02-09T15:55:32Z

Sbaumbach am 9. Februar 2023 um 15:53 Uhr

2023-02-09T15:53:43Z

Sbaumbach am 9. Februar 2023 um 15:42 Uhr

2023-02-09T15:42:54Z

Sbaumbach: Die Seite wurde neu angelegt: „KoBei der Ersteinrichtung von IRIS legen Sie die Basis-URL fest und konfigurieren einen SMTP-Account. == Konfigurator öffnen == === Docker === Unter Docker…“

2023-02-09T15:34:15Z

Die Seite wurde neu angelegt: „KoBei der Ersteinrichtung von IRIS legen Sie die Basis-URL fest und konfigurieren einen SMTP-Account. == Konfigurator öffnen == === Docker === Unter Docker…“

Neue Seite

KoBei der Ersteinrichtung von IRIS legen Sie die Basis-URL fest und konfigurieren einen SMTP-Account.

== Konfigurator öffnen ==

=== Docker ===
Unter Docker verwenden Sie den Befehl:<syntaxhighlight lang="bash" line="1" start="1">
docker exec -i -t iris bash
</syntaxhighlight>um auf dem Docker-Container direkt zu arbeiten.

Alle Einstellungen bleiben fest bestehen, sind also nur für die Ersteinrichtung notwendig.

Wechseln in das Verzeichnis account:<syntaxhighlight lang="bash" line="1" start="1">
cd account
</syntaxhighlight>Konfigurator ausführen:<syntaxhighlight lang="bash" line="1" start="1">
java -jar account.jar CONFIGURE_ALL
</syntaxhighlight>

=== Windows ===
Öffnen Sie eine CMD oder PowerShell und wechseln in das Verzeichnis [iris]\account

dann führen Sie folgenden Befehl aus:<syntaxhighlight lang="powershell" line="1" start="1">
.\jre\bin\java.exe -jar account.jar CONFIGURE_ALL
</syntaxhighlight>

== Konfiguration ==

=== Base 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 ====
Geben Sie true ein, wenn die Verbindung mit dem SMTP Server verschlüsselt werden soll, andernfalls false

==== SMTP sender email ====
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.

Geben Sie password oder oauth2 je nach Wahl ein.

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.

Hinweis: Bei der Passwort-Eingabe wird das Passwort nicht angezeigt, auch keine **** als Ersatz.

==== Send test email ====
Geben Sie y ein, um eine Test-Email zu versenden (empfohlen)

==== Receiver ====
Geben Sie die E-Mail Adresse vom Empfänger der Test-Email ein

=== SMTP mit OAuth2 ===
Wählen Sie beim SMTP authentication type oauth2 aus.

==== Configured OAuth2 clients ====
Im Standard gibt es noch keine angelegten OAuth2 Clients.

Wählen Sie c um einen neuen Client zu erstellen.

Sie erhalten sofort 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).

==== 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.

@@ Zeile 8: / Zeile 8: @@
 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.
+Loggen Sie sich hierzu über einen Admin-Account in IRIS ein.
 Sie finden dann links einen Menüpunkt namens "System settings".

← Nächstältere Version		Version vom 26. April 2023, 12:58 Uhr
Zeile 1:		Zeile 1:
		+	[[en:IRIS_Initial_setup]]
		+
	Bei der Ersteinrichtung von [[IRIS Cloudsystem\|IRIS]] legen Sie die Basis-URL fest und konfigurieren einen SMTP-Account.		Bei der Ersteinrichtung von [[IRIS Cloudsystem\|IRIS]] legen Sie die Basis-URL fest und konfigurieren einen SMTP-Account.

← Nächstältere Version		Version vom 16. Februar 2023, 15:33 Uhr
Zeile 1:		Zeile 1:
−	Bei der Ersteinrichtung von [[IRIS]] legen Sie die Basis-URL fest und konfigurieren einen SMTP-Account.	+	Bei der Ersteinrichtung von [[IRIS Cloudsystem\|IRIS]] legen Sie die Basis-URL fest und konfigurieren einen SMTP-Account.

	Momentan ist der Konfigurator für diese Einstellungen Kommandozeilen-basiert.		Momentan ist der Konfigurator für diese Einstellungen Kommandozeilen-basiert.

← Nächstältere Version		Version vom 9. Februar 2023, 16:16 Uhr
Zeile 1:		Zeile 1:
−	Bei der Ersteinrichtung von IRIS legen Sie die Basis-URL fest und konfigurieren einen SMTP-Account.	+	Bei der Ersteinrichtung von [[IRIS]] legen Sie die Basis-URL fest und konfigurieren einen SMTP-Account.

	Momentan ist der Konfigurator für diese Einstellungen Kommandozeilen-basiert.		Momentan ist der Konfigurator für diese Einstellungen Kommandozeilen-basiert.

@@ Zeile 72: / Zeile 72: @@
 ==== Receiver ====
 Geben Sie die E-Mail Adresse vom Empfänger der Test-Email ein
 === SMTP mit OAuth2 ===
 Um OAuth2 als SMTP-Authentifizierung zu nutzen, wählen Sie bei SMTP authentication type oauth2 aus.
-Tipp: Sie können die reine Konfiguration von OAuth2 Clients auch über die Startoption OAUTH2 statt CONFIGURE_ALL ausführen.
+Tipp: Sie können die reine Konfiguration von OAuth2 Clients auch über die Startoption "OAUTH2" statt "CONFIGURE_ALL" ausführen.
 Somit müssen Sie nicht jedes mal die grundsätzlichen SMTP Parameter eingeben, sollte die Konfiguration nicht beim ersten Mal funktionieren.

@@ Zeile 1: / Zeile 1: @@
 Bei der Ersteinrichtung von [[IRIS Cloudsystem|IRIS]] legen Sie die Basis-URL fest und konfigurieren einen SMTP-Account.
-Momentan ist der Konfigurator für diese Einstellungen Kommandozeilen-basiert.
+Diese Konfiguration ist für die weitere Funktion von IRIS unbedingt erforderlich.
-Ein Web-Interface für diese Konfiguration ist in Planung.
+== Web-Interface öffnen ==
-== Konfigurator öffnen ==
+Loggen Sie sich hierzu über einen Admin-Account in IRIRS ein.
-=== Docker ===
+Sie finden dann links einen Menüpunkt namens "System settings".
-Wechseln in das Verzeichnis account:<syntaxhighlight lang="bash" line="1" start="1">
+Hinweis zum Admin-Account:
-=== Windows ===
+Beim ersten Start wird Ihnen ein Benutzer "root@localhost" automatisch erstellt.
-dann führen Sie folgenden Befehl aus:<syntaxhighlight lang="powershell" line="1" start="1">
+Das Passwort finden Sie im Log und sieht ungefähr so aus:
-.\jre\bin\java.exe -jar account.jar CONFIGURE_ALL
+-02-08 17:22:38.926 -08 WARN  [main] (init.ServiceInitializer:166) - A new user has been created.:
-</syntaxhighlight>
+ Username: root@localhost
 == Konfiguration ==
-=== Base Settings ===
+=== General Settings ===
 ==== Base URL ====
@@ Zeile 43: / Zeile 47: @@
 ==== TLS ====
-Geben Sie true ein, wenn die Verbindung mit dem SMTP Server verschlüsselt werden soll, andernfalls false
+Aktivieren Sie das Häkchen, wenn die Verbindung mit dem SMTP Server per TLS verschlüsselt werden soll, andernfalls nicht
-==== SMTP sender email ====
+==== SMTP sender e-mail address ====
 Die Absender E-Mail Adresse von dem IRIS aus Mails verschicken soll.
@@ Zeile 56: / Zeile 60: @@
 Die Password-Authentifizierung ist einfacher einzurichten, Sie müssen allerdings auch sicherstellen, dass das Passwort nicht abläuft.
-Geben Sie password oder oauth2 je nach Wahl ein.
+Wählen Sie Password oder OAuth2 aus.
 Die OAuth2-Authentifizierung wird weiter unten beschrieben.
 ==== SMTP password ====
-(Nur bei Authentifizierungs-Typ password)
+(Nur bei Authentifizierungs-Typ Password)
 Das Password, mit dem sich IRIS beim SMTP Server anmelden soll.
-Hinweis: Bei der Passwort-Eingabe wird das Passwort nicht angezeigt, auch keine **** als Ersatz.
+==== Test E-Mail ====
-==== Send test email ====
+Bitte beachten Sie, dass zu diesem Zeitpunkt noch keine Einstellungen gespeichert wurden.
-Geben Sie y ein, um eine Test-Email zu versenden (empfohlen)
 === SMTP mit OAuth2 ===
-Falls Sie als SMTP-Authentifizierung password gewählt haben, können Sie dieses Kapitel überspringen.
+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.
+Um OAuth2 als SMTP-Authentifizierung zu nutzen, wählen Sie bei SMTP authentication type OAuth2 aus.
-Tipp: Sie können die reine Konfiguration von OAuth2 Clients auch über die Startoption "OAUTH2" statt "CONFIGURE_ALL" ausführen.
+Bitte tragen Sie die restlichen Einstellungen unter System configuration bis auf das Token ein und speichern diese Einstellungen.
-Somit müssen Sie nicht jedes mal die grundsätzlichen SMTP Parameter eingeben, sollte die Konfiguration nicht beim ersten Mal funktionieren.
+Danach gehen Sie in IRIS bitte in den Menüpunkt "OAuth2 Clients".
-==== Configured OAuth2 clients ====
+==== OAuth2 clients ====
 Im Standard gibt es noch keine angelegten OAuth2 Clients.
-Wählen Sie c um einen neuen Client zu erstellen.
+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).
-Sie erhalten sofort 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 ====
@@ Zeile 128: / Zeile 132: @@
 ==== Erstellte Anwendung autorisieren ====
-Wählen Sie die neu erstellte Anwendung über die Zahleneingabe aus und sagen Sie bei "Run initial authorization" y.
+Sobald Sie den Client erstellt haben, klicken Sie bitte in dem neu erstellten Client auf den Button "Authorize".
-Nach Bestätigung der Autorisierungsanfrage sollte ein Token an IRIS gesendet worden sein.
+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.
-Sie werden hierbei im Log eine Meldung sehen mit "Valid token received".
+Achtung: Bitte seien Sie sich bewusst, unter welchem Account Sie die Freigabe auf der Seite des E-Mail Betreibers durchführen.
-Danach können Sie genauso wie bei der Passwort-Authentifizierung eine Test-E-Mail verschicken.
+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.

@@ Zeile 69: / Zeile 69: @@
 Geben Sie die E-Mail Adresse vom Empfänger der Test-Email ein
-=== SMTP mit OAuth2 ===
+== SMTP mit OAuth2 ==
 Wählen Sie beim SMTP authentication type oauth2 aus.
 ==== Configured OAuth2 clients ====
@@ Zeile 93: / Zeile 97: @@
 Bei einer unter Azure angelegten App, die nur von Ihrer Organisation verwendbar ist, verwenden Sie diese URL:
-<nowiki>https://login.microsoftonline.com/organization/oauth2/v2.0/authorize</nowiki>
+<nowiki>https://login.microsoftonline.com/organizations/oauth2/v2.0/authorize</nowiki>
 ==== Token URL ====
@@ Zeile 100: / Zeile 104: @@
 Bei einer unter Azure angelegten App, die nur von Ihrer Organisation verwendbar ist, verwenden Sie diese URL:
-<nowiki>https://login.microsoftonline.com/organization/oauth2/v2.0/token</nowiki>
+<nowiki>https://login.microsoftonline.com/organizations/oauth2/v2.0/token</nowiki>
 ==== Refresh Token URL ====
@@ Zeile 107: / Zeile 111: @@
 Bei einer unter Azure angelegten App, die nur von Ihrer Organisation verwendbar ist, verwenden Sie diese URL:
-<nowiki>https://login.microsoftonline.com/organization/oauth2/v2.0/token</nowiki>
+<nowiki>https://login.microsoftonline.com/organizations/oauth2/v2.0/token</nowiki>
 ==== Scope ====
@@ Zeile 120: / Zeile 124: @@
 Es wird ein Link erstellt, den Sie im Browser aufrufen müssen.

← Nächstältere Version		Version vom 9. Februar 2023, 15:42 Uhr
Zeile 87:		Zeile 87:
	==== Client Secret ====		==== Client Secret ====
	Das Client Secret erhalten Sie nach der Registrierung des OAuth2 Clients bei Ihrem E-Mail Provider.		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/organization/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/organization/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/organization/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 ====
		+	Wählen Sie die neu erstellte Anwendung über die Zahleneingabe aus und sagen Sie bei "Run initial authorization" y.
		+
		+	Es wird ein Link erstellt, den Sie im Browser aufrufen müssen.