Ich nutze ForumISM (Notes) Version 3.6.6.2 auf einem Dominoserver, keinerlei Anwendungen der ForumSuite (Domino)
Grundsätzliche Vorgehensweise & benötigte Downloads
Installation ForumSuite (Domino)
ForumSuite (Domino) Installationspaket in der neuesten Version notwendig
Migration ForumISM (Notes) → ForumSuite (Domino)
Migrationsvorschläge “ForumISM Vorschlaege FGI 2021-06 Domino Migration”
Installation ForumSuite (Java)
ForumSuite (Domino) Installationspaket in der neuesten Version notwendig (ForumSuite-Domino.zip)
Plattformwechsel zu ForumSuite (Java) → Siehe Ich nutze ausschließlich Produkte in der ForumSuite (Domino)
ForumSuite (Java) Installationspaket in der neuesten Version notwendig (ForumSuite-JAVA-Atruvia.zip)
neueste Versionen der Vorschläge
Falls Sie die Funktion des Informationssicherheitsbeauftragten (ISB) an die GCS GmbH ausgelagert haben, halten Sie vor der Migration/dem Plattformwechsel bitte unbedingt Rücksprache mit dem für Sie zuständigen Berater.
Schritt für Schritt
Die Domino Version der ForumSuite wird in naher Zukunft nicht mehr weiterentwickelt.
Für den produktiven Einsatz nutzen Sie bitte die Java Version der ForumSuite
Sofern Sie bereits eine oder mehrere der unten genannten Anwendungen einsetzen, ist keine erneute Installation der Software sondern nur die Eingabe des für Ihr Unternehmen gültigen Lizenzschlüssels sowie ggf. die Installation der mitgelieferten Vorschläge für die Anwendung erforderlich.
Platzhalter
In der nachfolgenden Anleitung werden die folgenden Platzhalter verwendet:
<app> .. Platzhalter für das Kürzel der betroffenen Anwendung
<x.y.z.> .. Platzhalter für die aktuelle Versionsnummer
<katalog> .. Platzhalter für Katalogbezeichnung
<JJJJ>-<MM> .. Platzhalter für Jahr und Monat
Betroffene Produkte
Diese Anleitung bezieht sich auf folgende Web-Anwendungen der FORUM:
- ForumISM (ab Version 2020-09)
- ForumBCM (ab Version 2.0)
- ForumDSM
- ForumNSR
- ForumOSM
Aufbau der Software
Die Anwendungen der FORUM benötigen für den produktiven Einsatz eine sogenannte Frontend- und eine Backend-Datenbank.
Ergänzt werden diese um eine optionale Log-Datenbank sowie anwendungsabhängige Vorschlags/Katalog-Datenbanken.
Sämtliche Anwendungen sind bereits im Auslieferungszustand in der Frontend-Datenbank vorhanden und müssen für Ihren Einsatz lediglich mit einem Freischaltschlüssel aktiviert werden.
Vorhandene Anwendungen
Sofern Sie bereits eine oder mehrere der oben genannten Anwendungen einsetzen, ist keine erneute Installation der Software erforderlich.
In diesem Fall gehen Sie bitte wie folgt vor:
- Prüfen Sie, ob ggf. eine Aktualisierung der Frontend- oder Backend-Datenbank erforderlich ist. Nutzen Sie dazu die Updateanleitung für die zu installierende Anwendung.
- Aktivieren Sie die neue Anwendung mit Hilfe des Ihnen zur Verfügung gestellten Freischaltschlüssels.
Installieren Sie die zur neuen Anwendung gehörigen Vorschläge/Kataloge, wie im Abschnitt Installation der Vorschläge im Handbuch der entsprechenden Anwendung beschrieben.
- Es sind keine weiteren Schritte erforderlich – die Installation ist damit abgeschlossen.
Sollen Sie noch keine der genannten Anwendungen einsetzen, fahren Sie bitte mit der Installationsanleitung fort.
Installationsdateien
Sofern Sie die Installationsdateien als ZIP-Archiv erhalten haben, entpacken Sie das Archiv bitte zunächst in ein lokales Verzeichnis.
Kopieren Sie anschließend die folgenden Dateien in das lokale Datenverzeichnis Ihres Notes-Clients:
Dateiname | Erläuterung |
---|---|
forum_frontend_<x.y.z.>.ntf | Datenbankschablone für Frontend aller Web-Anwendungen der FORUM. |
forum_backend_<x.y.z.>.ntf
| Datenbankschablone für Backend aller Web-Anwendungen der FORUM. |
fislog.ntf | Datenbankschablone für die Log-Datei. |
| Datenbanken mit Vorschlägen für die einzelnen Anwendungen. Datenbanken mit Katalogen für bestimmte Anwendungen. |
Versuchen Sie es einfach mal mit der Eingabe der Umgebungsvariable %notesdata%
in der Adresszeile des Windows Explorers.
Übertragen Sie die Datenbanken und Schablonen niemals direkt über das Dateisystem auf den Domino Server, da diese hierbei beschädigt werden können.
Installation der Datenbanken
Frontend-Datenbank
Wählen Sie dazu in Ihrem IBM Notes Client über das Menü den Eintrag „Datei > Anwendung > Neu“ oder nutzen Sie die Tastenkombination Strg + n
.
Im erscheinenden Dialog passen Sie bitte Server und Dateinamen (Empfehlung: forum_frontend.nsf
) nach Ihren Wünschen an. Wählen Sie als Schablone FORUM Frontend <x.y.z>
.
Backend und Log-Datenbank
Wiederholen Sie den im vorangegangenen Abschnitt für die Frontend-Datenbank beschriebenen Vorgang bitte für das Backend der Anwendung forum_backend_<x.y.z.>.ntf
(Empfehlung Dateiname: forum_backend.nsf
) sowie für die Log-Datenbank fislog.ntf
(Dateiname: fislog.nsf
).
Achten Sie bitte darauf, dass alle Datenbanken im selben Verzeichnis auf dem Domino Server abgelegt werden (in gezeigten Beispiel werden die Anwendungen im Ordner web
des Dominoservers platziert).
Empfehlung für die Namensgebung der Frontend-Datenbank: forum_frontend.nsf
Empfehlung für die Namensgebung der Backend-Datenbank: forum_backend.nsf
Die Log-Datenbank sollte unter dem Dateinamen fislog.nsf
im selben Verzeichnis wie die Backend Datenbank erstellt werden.
Datenbanken signieren
Sofern die Frontend- oder Backend-Datenbank noch nicht korrekt signiert wurde, wird in der Notes-Maske ein entsprechender Hinweis angezeigt.
Signieren Sie die Datenbanken forum_frontend.nsf
und forum_backend.nsf
mit einer vertrauenswürdigen Notes-ID.
Hierzu wird entweder die ID eines speziellen Freigabe-Nutzers, eines Administrators oder die ID des Servers genutzt.
Die zur Freigabe verwendete Notes ID muss auf dem Domino Server die Berechtigung „Agenten oder XPages signieren, die im Namen des Aufrufers ausgeführt werden“ (engl.:„Sign agents or XPages to run on behalf of the invoker“) haben.
Sie können dies im Reiter Sicherheit des Serverdokuments überprüfen.
Wählen Sie im Dialog
ID des aktiven Benutzers
mit der die Signierung durchgeführt werden soll, deaktivieren Sie die Option „Nur vorhandene Signaturen aktualisieren“ und bestätigen Sie mit OK.
Erstellung Volltext-Index für die Backend-Datenbank
Um die Volltextsuche innerhalb der Anwendungen nutzen zu können ist es erforderlich, einen Volltext-Index für die Backend-Datenbank
zu erstellen.
Öffnen Sie zu Erstellung des Volltextindexes die Eigenschaften der Backend-Datenbank
als Administrator im IBM Notes Client und wechseln Sie in den vorletzen Reiter (Lupensymbol).
Lösen Sie die Erzeugung des Index über die Schaltfläche Index erstellen...
aus.
Die Indizierung von Anhängen sollte hierbei deaktiviert werden und das Aktualisierungsintervall den Wert Sofort aufweisen.
Installation der Vorschläge
Fügen Sie die Datenbank <app>_vorschlaege_<JJJJ>-<MM>.nsf/<app>_katalog_<katalog>_<JJJJ>-<MM>.nsf
zu Ihrem IBM Notes Arbeitsbereich hinzu.
Wählen Sie die Anwendung aus und erstellen Sie über die IBM Notes Funktion „Anwendung > Neue Kopie“ im Menü eine Kopie der Datenbank <app>_vorschlaege_<JJJJ>-<MM>.nsf/<app>_katalog_<katalog>_<JJJJ>-<MM>.nsf
auf Ihrem Domino Server.
Nutzen Sie als Zielverzeichnis den bereits oben für die Installation verwendeten Serverpfad.
Frontend und Backend-Datenbank verknüpfen
Öffnen Sie bitte die zuvor erstellte Frontend-Datenbank
im IBM Notes Client und begeben Sie sich in die Konfigurationsmaske.
Backend-Datenbank auswählen
Aktivieren Sie den Modus Bearbeiten
und wählen Sie die vorher erstellte Backend-Datenbank
über die entsprechende Schaltfläche auf Ihrem Domino-Server aus.
Frontend-Adresse setzen
Die Angabe der Frontend-Adresse ist für die Benachrichtigungsfunktion sowie zum Aufruf der Web-Anwendung aus dem Notes-Client heraus erforderlich.
Zur automatischen Ermittlung der Adresse können Sie die Schaltfläche Berechnen
verwenden.
Der Adresse wird automatisch gesetzt:
Beachten Sie, dass die korrekte Adresse des Domino-Servers aus technischen Gründen ggf. nicht korrekt ermittelt werden kann. Bitte prüfen Sie ermittelte Adresse und korrigieren Sie diese, sofern erforderlich.
Falls in Ihrem Domino Serverdokument die Option mit Hostnamen verknüpfen (engl: Bind to host name)
aktiv ist, müssen Sie den berechneten Wert <DOMINO_SERVER> durch den im Serverdokumente hinterlegten Wert Host Names
ersetzen.
Zeitgesteuerte Verarbeitung von Aufgaben / Benachrichtigungsfunktion
Voraussetzungen für die Aktivierung:
Die Funktionalität zur zeitgesteuerten Verarbeitung von Aufgaben (u.a. Benachrichtigung per E-Mail), muss mittels eines IBM Notes Clients durch Anpassung des Konfigurationsdokuments in der Frontend-Datenbank
aktiviert(1) werden.
Die Hinterlegung der Adresse des Frontends(2) ist für die Aktivierung zwingend erforderlich.
Für den Zugriff muss ein technischer Benutzer mit einem zugehörigen HTTP-Passwort(4) hinterlegt werden.
Der Benutzer benötigt nur das Recht öffentliche Dokumente lesen
in der Zugriffskontrollliste der Backend-Datenbank. Es sind keine weiteren Rechte erforderlich.
Die hinterlegten Zugangsdaten werden technisch über ein Leserfeld (Datenbankrolle [ADMIN] in der Frontend-Datenbank) vor unberechtigtem Zugriff geschützt.
Zur Anpassung der Konfiguration der Frontend-Datenbank muss diese durch einen Administrator im IBM Notes Client geöffnet werden.
Treten bei der zeitgesteuerten Verarbeitung Probleme oder Fehler auf, so werden diese direkt im Konfigurationsdokument unterhalb der Schaltfläche zur Aktivierung protokolliert.
Nach der einmaligen Aktivierung der zeitgesteuerten Aktivitäten kann die Benachrichtigungsfunktion individuell über die Konfigurationsseiten der aktiven Anwendungen im Browser angepasst werden.
Speichern der Konfiguration
Verlassen Sie die Maske über die Schaltfläche Speichern und Schließen.
Setzen der Berechtigungen für die Frontend-, die Backend-, die Log- und die Vorschlagsdatenbank
Um den sicheren Zugriff auf die Anwendung zu gewährleisten und den Benutzern abgestufte Rechte zuzuordnen, wurde ein Rechte- und Rollenkonzept umgesetzt.
Allgemeine Zugriffskontrollliste Frontend
Benutzer/Gruppe | Benutzertyp | Zugriff | Rolle(n) | Erläuterung |
---|---|---|---|---|
SERVER | Server oder Servergruppe | Manager | [ADMIN] | Server |
ADMINS | Person oder Personengruppe | Manager | [ADMIN] | Administratoren mit Berechtigung zur Anpassung der Zugriffskontrollliste (ACL) sowie zur Änderung der Anwendungskonfiguration (technische Administratoren) |
SIGNIERER | Person | Manager | [ADMIN] | Signierer der Anwendung (wenn nicht durch Server signiert) |
Default oder -Default- | unbestimmt | kein Zugriff | am Domino Web Server angemeldete Benutzer ohne explizite Zuordnung durch eine Gruppe/eines Personeneintrages in der Zugriffskontollliste der Anwendung | |
Anonymous | unbestimmt | kein Zugriff | am Domino Web Server nicht angemeldete Benutzer | |
MITARBEITER | Person oder Personengruppe | Leser | Mitarbeiter mit Anmeldeberechtigung in der Anwendung |
Erweiterte Zugriffskontrollliste: maximaler Internetnamens- und Kennwortzugriff = Editor
Allgemeine Zugriffskontrollliste Backend
Benutzer/Gruppe | Benutzertyp | Zugriff | Rolle(n) | Erläuterung |
---|---|---|---|---|
SERVER | Server oder Servergruppe | Manager | [ADMIN] | Server |
ADMINS | Person oder Personengruppe | Manager | [ADMIN] | Administratoren mit Berechtigung zur Anpassung der Zugriffskontrollliste (ACL) sowie zur Änderung der Anwendungskonfiguration (technische Administratoren) |
SIGNIERER | Person | Manager + Dokumente replizieren oder kopieren | [ADMIN] | Signierer der Anwendung (wenn nicht durch Server signiert) |
Default oder -Default- | unbestimmt | kein Zugriff | am Domino Web Server angemeldete Benutzer ohne explizite Zuordnung durch eine Gruppe/eines Personeneintrages in der Zugriffskontollliste der Anwendung | |
Anonymous | unbestimmt | kein Zugriff | am Domino Web Server nicht angemeldete Benutzer | |
MITARBEITER | Person oder Personengruppe | kein Zugriff + Öffentliche Dokumente lesen | Mitarbeiter innerhalb der Anwendungen | |
technischer Benutzer | Person | kein Zugriff + Öffentliche Dokumente lesen | Benutzer für die zeitgesteuerte Verarbeitung von Aufgaben (u.a. Versand von Nachrichten) |
Erweiterte Zugriffskontrollliste: maximaler Internetnamens- und Kennwortzugriff = Editor
Allgemeine Zugriffskontrollliste Log-Datenbank
Benutzer/Gruppe | Benutzertyp | Zugriff | Rolle(n) | Erläuterung |
---|---|---|---|---|
SERVER | Server oder Servergruppe | Manager | Server | |
ADMINS | Person oder Personengruppe | Manager | Administratoren mit Berechtigung zur Anpassung der Zugriffskontrollliste (ACL) | |
SIGNIERER | Person | Manager | Signierer der Anwendung (wenn nicht durch Server signiert) | |
Default oder -Default- | unbestimmt | Autor | am Domino Web Server angemeldete Benutzer ohne explizite Zuordnung durch eine Gruppe/eines Personeneintrages in der Zugriffskontollliste der Anwendung | |
Anonymous | unbestimmt | kein Zugriff | am Domino Web Server nicht angemeldete Benutzer |
Erweiterte Zugriffskontrollliste: maximaler Internetnamens- und Kennwortzugriff = Editor
Allgemeine Zugriffskontrollliste Vorschläge/Kataloge
Benutzer/Gruppe | Benutzertyp | Zugriff | Rolle(n) | Erläuterung |
---|---|---|---|---|
SERVER | Server oder Servergruppe | Manager | Server | |
ADMINS | Person oder Personengruppe | Manager | Administratoren mit Berechtigung zur Anpassung der Zugriffskontrollliste (ACL) | |
SIGNIERER | Person | Manager | Signierer der Anwendung (wenn nicht durch Server signiert) | |
Default oder -Default- | umbestimmt | kein Zugriff | am Domino Web Server angemeldete Benutzer ohne explizite Zuordnung durch eine Gruppe/eines Personeneintrages in der Zugriffskontollliste der Anwendung | |
Anonymous | unbestimmt | kein Zugriff | am Domino Web Server nicht angemeldete Benutzer |
Erweiterte Zugriffskontrollliste: maximaler Internetnamens- und Kennwortzugriff = Leser
ForumISM Zugriffskontrollliste (optional)
Die nachfolgende Kontrolle ist nur notwendig, wenn Sie ForumISM nutzen und Daten aus der Anwendung ForumISM importieren/exportieren möchten.
Benutzer/Gruppe | Benutzertyp | Zugriff | Rolle(n) | Erläuterung |
---|---|---|---|---|
SIGNIERER | Person oder Personengruppe | Manager | [ADMIN] | Der Signierer der ForumSuite benötigt die Rechte auf der Anwendung ForumISM für den Import/Export von Daten aus/nach ForumISM. |
Erweiterte Zugriffskontrollliste: maximaler Internetnamens- und Kennwortzugriff = Editor
Allgemeine Zugriffskontrollliste Log-Datenbank
Benutzer/Gruppe | Benutzertyp | Zugriff | Rolle(n) | Erläuterung |
---|---|---|---|---|
SERVER | Server oder Servergruppe | Manager | Server | |
ADMINS | Person oder Personengruppe | Manager | Administratoren mit Berechtigung zur Anpassung der Zugriffskontrollliste (ACL) | |
SIGNIERER | Person | Manager | Signierer der Anwendung (wenn nicht durch Server signiert) | |
Default oder -Default- | unbestimmt | Autor | am Domino Web Server angemeldete Benutzer ohne explizite Zuordnung durch eine Gruppe/eines Personeneintrages in der Zugriffskontollliste der Anwendung | |
Anonymous | unbestimmt | kein Zugriff | am Domino Web Server nicht angemeldete Benutzer |
Erweiterte Zugriffskontrollliste: maximaler Internetnamens- und Kennwortzugriff = Editor
Allgemeine Zugriffskontrollliste Vorschläge/Kataloge
Benutzer/Gruppe | Benutzertyp | Zugriff | Rolle(n) | Erläuterung |
---|---|---|---|---|
SERVER | Server oder Servergruppe | Manager | Server | |
ADMINS | Person oder Personengruppe | Manager | Administratoren mit Berechtigung zur Anpassung der Zugriffskontrollliste (ACL) | |
SIGNIERER | Person | Manager | Signierer der Anwendung (wenn nicht durch Server signiert) | |
Default oder -Default- | umbestimmt | kein Zugriff | am Domino Web Server angemeldete Benutzer ohne explizite Zuordnung durch eine Gruppe/eines Personeneintrages in der Zugriffskontollliste der Anwendung | |
Anonymous | unbestimmt | kein Zugriff | am Domino Web Server nicht angemeldete Benutzer |
Erweiterte Zugriffskontrollliste: maximaler Internetnamens- und Kennwortzugriff = Leser
ForumISM V3.6.x Zugriffskontrollliste (optional)
Die nachfolgende Kontrolle ist nur notwendig, wenn Sie die Notes-Version von ForumISM V3.6.x nutzen und Daten aus dieser Anwendung importieren/exportieren möchten.
Benutzer/Gruppe | Benutzertyp | Zugriff | Rolle(n) | Erläuterung |
---|---|---|---|---|
SIGNIERER | Person oder Personengruppe | Manager | [ADMIN] | Der Signierer der ForumSuite benötigt die Rechte auf der Anwendung ForumISM für den Import/Export von Daten aus/nach ForumISM. |
Erweiterte Zugriffskontrollliste: maximaler Internetnamens- und Kennwortzugriff = Editor
Die nachfolgende Anleitung beschreibt auf den jeweiligen Seiten die nötigen Schritte, um die bisher in Version 3.6.6.2 von ForumISM im Notes Client von Ihnen gepflegten Daten in die neue Plattform der ForumSuite für ForumISM Version 2024-04 oder höher zu übernehmen.
Vorbemerkungen
Datenhaltung und Plattform
Die Daten der bisherigen Version 3.6.6.2 von ForumISM wurden direkt in der Datenbank von ForumISM gespeichert. Mit dem Erscheinen von ForumOSM im Jahre 2016 wurde eine neue Software-Plattform – die sogenannte ForumSuite – ins Leben gerufen, auf welcher alle zukünftigen Produkte der FORUM betrieben werden. Auch unsere 2017 erschienenen Anwendungen ForumDSM ,ForumNSR und ForumBCM nutzen bereits diese neue Plattform. Die neu konzipierte Plattform ist dabei weitgehend unabhängig von proprietären Server-Mechanismen und nutzt moderne Browser-Technologien für das Frontend.
Bei der Version 1.x von ForumBCM (erschienen 2014) handelt sich zwar ebenfalls um eine Web-Anwendung. Die Version nutzte jedoch serverseitig eine andere Technologie, die mittlerweile nicht mehr weiterverfolgt wird. Das Produkt wurde mit Version 2.0 in die ForumSuite integriert.
Mit der neuen Version wird auch ForumISM auf die Plattform der ForumSuite umgestellt. Die Datenhaltung der neuen Version erfolgt daher ebenfalls in der Backend-Datenbank der ForumSuite und macht eine Migration erforderlich. Bei dieser Migration werden die von ForumISM genutzten Daten in das Backend der ForumSuite übertragen und zukünftig nur noch dort bearbeitet.
Die migrierte Notes-Version von ForumISM steht auch weiterhin unverändert zur Verfügung und sollte als Archiv aufbewahrt werden. Nach erfolgter Migration sollte die Arbeit nur noch in der ForumSuite in ForumISM erfolgen.
Betroffene Produkte
Diese Anleitung bezieht sich auf folgende Web-Anwendungen: | ||
---|---|---|
ForumBCM (ab Version 2.0) | ForumISM (ab Version 2020-09) | ForumOSM |
ForumCMS | ForumNMS | ForumTCM |
ForumDSM | ForumNSR | ForumWPC |
Aufbau der Software
Sowohl der für den Betrieb der Anwendung benötigte Webserver als auch die Datenbank zur Speicherung der Inhalte ist im Softwarepaket für die Java Plattform enthalten.
Für den Einsatz ist lediglich eine installierte 64bit Java 17 Runtime oder höher erforderlich, das Betriebssystem kann frei gewählt werden – siehe Java Plattform
Sämtliche Anwendungen der ForumSuite werden in einem einzigen Paket ausgeliefert. Für ihren Einsatz müssen diese nach dem Kauf nur noch mit einem Freischaltschlüssel aktiviert werden und die dazugehörigen Vorschläge eingespielt werden.
Vorhandene Anwendungen
Sofern Sie bereits eine oder mehrere der oben genannten Anwendungen auf der Java Plattform der ForumSuite einsetzen, ist keine erneute Installation der Software erforderlich.
In diesem Fall gehen Sie bitte wie folgt vor:
- Prüfen Sie, ob ggf. eine Aktualisierung erforderlich ist. Nutzen Sie dazu die Updateanleitung sowie die Versionshistorie für die zu installierende Anwendung.
- Aktivieren Sie die neue Anwendung mit Hilfe des Ihnen zur Verfügung gestellten Freischaltschlüssels.
Installieren Sie die zur neuen Anwendung gehörigen Vorschläge/Kataloge, wie im Abschnitt Installation der Vorschläge im Handbuch der entsprechenden Anwendung beschrieben.
- Es sind keine weiteren Schritte erforderlich – die Installation ist damit abgeschlossen.
Sollen Sie noch keine der oben genannten Anwendungen einsetzen, fahren Sie bitte mit der Installationsanleitung fort.
Prüfung
Bekannte nicht unterstützte Java Laufzeitumgebungen:
- Red Hat JRE / JDK
Bei Nutzung einer höheren Version als Java 21 LTS wird keine Garantie für die korrekte Funktionsweise der ForumSuite übernommen.
Die folgenden Tätigkeiten müssen alle auf dem Server der ForumSuite ausgeführt werden.
Prüfung IST Zustand
- Öffnen Sie bitte im
Windows Explorer
den Installationspfad der ForumSuite Bearbeiten Sie bitte die Datei
start_suite.cmd
Abbildung: Edit start_suite.cmdPrüfen Sie bitte nun den Pfad für den Aufruf der Laufzeitumgebung
Abbildung 1: in ForumSuite Ordner eingebettete Java RuntimeAbbildung 2: Java Runtime des BetriebssystemsIn diesem Fall fragen Sie die eingesetzte Version bitte über die
Eingabeaufforderung
mittels des Befehlsjava -version
ab.Abbildung 2.1: Abfrage Version der installierten Java Runtime
Sollten Sie mit einer installierten Java Runtime arbeiten (Abbildung 2), prüfen Sie bitte, ob noch andere Anwendungen diese Runtime nutzen/voraussetzen.
Falls ja, erfragen Sie bitte beim Hersteller, ob die Anwendung mit einer Java Runtime 17*
betrieben werden kann.
Update Java Runtime - Abbildung 1 (eingebettete Java Runtime)
- Laden Sie die portable Version 17 der Java Runtime von ADOPTIUM herunter ()
- Entpacken Sie den Inhalt des Archivs
- Kopieren Sie den Ordner
jdk-17*-jre
in den Ordner der ForumSuite - Stoppen Sie den Dienst der ForumSuite
Bearbeiten Sie bitte die Datei start_suite.cmd
Abbildung: Edit start_suite.cmdstart_suite.cmd - vorher
BASHFOR %%f IN (FORUM_Suite_*.jar) DO .\jdk-11.0.17+8-jre\bin\java -Djavax.net.ssl.trustStoreType=WINDOWS-ROOT -Xmx8G -jar %%f
start_suite.cmd - nachher (Beispiel)
BASH#Bitte den String jdk-17... entsprechend anpassen FOR %%f IN (FORUM_Suite_*.jar) DO .\jdk-17.N.N.N+N-jre\bin\java -Djavax.net.ssl.trustStoreType=WINDOWS-ROOT -Xmx8G -jar %%f
- Speichern und schließen Sie die Datei
start_suite.cmd
- Starten Sie den Dienst der ForumSuite
Update Java Runtime - Abbildung 2 (Java Runtime des Betriebssystems)
- Laden Sie die installierbare Version 17 der Java Runtime von ADOPTIUM herunter ()
- Stoppen Sie den Dienst der ForumSuite
- Deinstallieren Sie die Java 11 Runtime via
Systemsteuerung\Alle Systemsteuerungselemente\Programme und Features
Installieren Sie das Paket inkl. der Optionen
JAVA_HOME
undJavaSoft (Oracle)
Abbildung: Installationsparamter- Prüfung der Version über die
Eingabeaufforderung
mittels des Befehlsjava -version
.
Ergebnis sollte nun Version 17* sein. - Starten Sie den Dienst der ForumSuite
Nachfolgend wir die Aktualisierung unter Linux (hier: Debian Bullseye
) beschrieben.
Es wird davon ausgegangen, das die ForumSuite im systemd
eingebunden ist
ForumSuite stoppen
BASHsystemctl stop forumsuite.service
Java 11 deinstallieren
BASHapt remove openjdk-11-jre apt update;apt upgrade;apt autoremove;apt autoclean
Java 17 installieren
BASHapt install openjdk-17-jre
ForumSuite starten
BASHsystemctl start forumsuite.service
Installation
Für den Betrieb der ForumSuite Version > 2023-07.1 wird eine Java Runtime Java 17 vorausgesetzt.
Sofern Sie die Installationsdateien als ZIP-Archiv erhalten haben, entpacken Sie das Archiv in das Verzeichnis auf Ihrem Server, aus welchem der Betrieb erfolgen soll.
Das Verzeichnis sollte sich nicht in einem geschützten Windows-Ordner oder unterhalb eines Systemverzeichnisses, wie etwa C:\Windows
, D:\ProgramFiles
, D:\Programme, /bin, /sbin, /lib
o.ä. befinden.
Entpacken Sie die Dateien bitte in einem vom Betriebssystem nicht beanspruchtem Verzeichnis des jeweiligen Laufwerkes, wie z.B. C:\Apps\ForumSuite
, D:\Daten\ForumSuite
bzw. /opt/forum
.
Dieses Verzeichnis ist frei von Ihnen wählbar und wird im weiteren als Installationsverzeichnis bezeichnet.
Alle für den Betrieb benötigten Softwarekomponenten sind im Installationspaket enthalten.
Achten Sie auf ausreichend verfügbaren Platz auf dem Datenträger, auf welchem sich das Installationsverzeichnis befindet.
Der Platzbedarf ist dabei hauptsächlich von Anzahl und Umfang der von den Nutzern in den einzelnen Anwendungen hochgeladenen Dateianhänge abhängig.
In der Standardinstallation werden sowohl die Datenbank als auch sämtliche Anhänge unterhalb Installationsverzeichnisses abgelegt.
Dieser Artikel betrifft ausschließlich die Java Plattform.
Um die ForumSuite auf Basis der Java Plattform unter einem Windows Betriebssystem als Dienst (Service) zu starten, empfehlen wir den Einsatz eines Wrappers.
Unter https://github.com/kohsuke/winsw/releases können Sie sich – in Abhängigkeit des auf Ihrem Server installierten .NET-Frameworks – das entsprechende Hilfsprogramm in der aktuellsten Version herunterladen.
- Kopieren Sie die im Archiv enthaltene
WinSW.NET2.exe
oderWinSW.NET4.exe
in das Installationsverzeichnis Ihrer ForumSuite - Kopieren Sie die im Archiv enthaltene Datei
sample-minimal.xml
ebenfalls in das Installationsverzeichnis Ihrer ForumSuite und benennen Sie die Datei um inWinSW.NET2.xml
oderWinSW.NET4.xml
Passen Sie die Datei
WinSW.NET2.xml
oderWinSW.NET4.xml
entsprechend Ihren Bedürfnissen anBeispiel Konfiguration
XML<configuration> <!-- ID of the service. It should be unique across the Windows system--> <id>ForumSuite</id> <!-- Display name of the service --> <name>ForumSuite Service (powered by WinSW)</name> <!-- Service description --> <description>This service is a service created from a minimal configuration for ForumSuite</description> <!-- Path to the executable, which should be started --> <executable>C:\<VERZEICHNIS>\start_suite.cmd</executable> </configuration>
- Öffnen Sie die Eingabeaufforderung als Administrator
begeben Sie sich innerhalb des Eingabefensters in den Installationsordner der ForumSuite
Starten Sie die Datei
WinSW.NET2.exe
oderWinSW.NET4.exe
mit dem Zusatzparameterinstall
Beispiel Eingabeaufforderung
POWERSHELLC:\WINDOWS\system32>cd C:\APPS\FORUMSuite C:\APPS\FORUMSuite>WinSW.NET4.exe install 2019-10-17 16:47:18,717 INFO - Installing the service with id 'ForumSuite' C:\APPS\FORUMSuite>WinSW.NET4.exe start 2019-10-17 16:49:49,261 INFO - Starting the service with id 'ForumSuite'
Für den reibungslosen Betrieb der ForumSuite ist ein ausreichend dimensionierter verfügbarer Hauptspeicher für die Java Runtime Umgebung (der sog. Java Heap-Speicher) erforderlich.
Dieser muss für Java-Anwendungen im Vorfeld konfiguriert werden, da keine dynamische Zuweisung erfolgt.
Standardmäßig wird die Anwendung mit einem verfügbaren Heap-Speicher von 4 GB gestartet.
Sofern Ihr Server über 8 GB Hauptspeicher verfügt, ist keine Anpassung erforderlich.
Stehen dem Betriebssystem 12 GB RAM oder mehr zur Verfügung, können Sie den verfügbaren Heap-Speicher erhöhen.
Dies ist insbesondere dann empfehlenswert, wenn Sie mehrere Anwendungen der ForumSuite nutzen oder umfangreiche PDF-Dokumente erzeugen möchten.
Vorgehensweise
Gehen Sie zur Anpassung des Java Heap-Speichers wie folgt vor:
Bearbeiten Sie die Datei start_suite.cmd und ändern Sie den hinter dem Parameter -Xmx hinterlegten Wert.
Beispiel für die Erhöhung auf 8 GB Heap-Speicher:
java -Xmx8G -jar FORUM_Suite_X.Y.Z.jar
Bitte beachten Sie, dass auch dem Betriebssystem nach der Erhöhung des maximal verfügbaren Java Heap-Speichers noch ausreichend Speicher zur Verfügung steht (Empfehlung: mindestens 2 GB).
Für einen Server mit 16 GB RAM sollte die Java Heap Size entsprechend höchstens 14 GB (Empfehlung: 12 GB) betragen.
Konfiguration
Vor der Inbetriebnahme der Software ist eine Bearbeitung der Konfiguration erforderlich.
Anlegen der Konfiguration
Im Installationsverzeichnis befindet sich der Unterordner „config“.
Öffnen Sie diesen und benennen Sie die Datei application.properties.default in application.properties um oder kopieren Sie diese.
Bearbeiten Sie die Datei anschließend mit einem normalen Text-Editor.
Aufbau der Konfigurationsdatei
Die Einträge in der Datei bestehen aus einem Schlüssel gefolgt von einem Gleichheitszeichen (=) und dem Wert des Eintrags. Letzterer kann dabei auch leer sein.
Werte von Einträge können als Zeichenketten, Zahlen oder Wahr- und Falsch-Werte („true“ bzw. „false“) hinterlegt sein.
Kommentare werden durch Raute-Zeichen (#) am Anfang einer Zeile gekennzeichnet.
Die einzelnen Bereiche der Konfigurationsdateien sind durch Kommentare unterteilt.
Ändern Sie eigenmächtig bitte keine Werte im Bereich Interne Konfiguration, da ein fehlerfreier Betrieb der ForumSuite ansonsten ggf. nicht gewährleistet werden kann.
Anpassung der Einträge
Nachfolgend werden die anzupassenden Einträge näher beschrieben.
Erstnutzer
application.admin.user=
Mit diesem Eintrag wird die Login-Kennung des Erstnutzers definiert. Dieser Nutzer ist als technischer Administrator angelegt und kann unabhängig von eingerichteten Verzeichnisdiensten auf die Anwendung zugreifen – auch wenn erstere ggf. nicht erreichbar sind.
Beispiel: application.admin-user=admin
application.admin.password=
Über diesen Eintrag legen Sie das Kennwort für den Erstnutzer fest. Das Kennwort kann dabei im Klartext (nicht empfohlen) oder als Bcrypt-Hashwert hinterlegt werden.
Zur Erzeugung eines gültigen Passwort-Hashes können Sie das im Unterverzeichnis tools mitgelieferte Hilfsprogramm hash_password.cmd nutzen.
Starten Sie dazu einfach das Tool, geben das gewünschte Kennwort an der Eingabeaufforderung ein und kopieren anschließend den erzeugten Hashwert in die Zwischenablage, um diesen danach in die Konfigurationsdatei einfügen zu können.
Eine Online-Alternative zur Erzeugung von Hashwerten finden Sie unter https://bcrypt.online/
Beispiel: application.admin.password=$2a$12$dota0URv/ROPlpYInU0LCu5Cdv.hXRfFbvCxnAyuvTPPwOQZUV5Mi
Nach Einrichtung eines Verzeichnisdienstes können Sie den Erstnutzer durch Entfernen des Kennwortes und/oder des Nutzernamens deaktivieren.
Kommentieren Sie dazu die Einträge durch Voranstellen eines #-Zeichens aus oder Löschen Sie die Werte nach den Gleichheitszeichen.
Web-Adresse
application.frontend.url=http://<Server>.<domain>.<tld>/
server.port=80
In diesem Eintrag hinterlegen Sie die Adresse, unter welcher der Server innerhalb Ihres Unternehmens im Netzwerk per Browser erreichbar ist.
Die URL muss immer mit http:// oder https:// beginnen und endet mit einem Schrägstrich (/). Sie können eine IP-Adresse oder einen gültigen DNS-Namen verwenden, der auf den Server verweist.
Beispiel: application.frontend.url=http://app-server01.firma.lan
Hintergrund
Innerhalb der ForumSuite können Sie Aufgaben und Termine definieren. Über die integrierte E-Mail-Benachrichtigung können die zuständigen Nutzer auf die Aufgaben hingewiesen werden. Um den Verantwortlichen den direkten Aufruf der betroffenen Objekte zu ermöglichen, enthält die Benachrichtigung einen Link zur entsprechenden Aufgabe. Dieser Link kann leider nicht sicher automatisiert bei der Installation erkannt werden und muss daher manuell in der Konfiguration hinterlegt werden.
Bitte achten Sie darauf, dass die angegebene URL auch von allen Client Arbeitsplätzen erreichbar ist.
Sollte bereits ein anderer Webservice auf Port 80 auf dem Installationsserver laufen, können Sie dies entsprechend dem nachfolgenden Beispiel anpassen oder Sie wenden sich bitte an die FORUM Hotline zur Unterstützung bei der Anpassung.
#alternativ Aufruf über z.B. Port 8080
application.frontend.url=http://<Server>.<domain>.<tld>:8080/
# Interne Konfiguration Server:
# --- NUR NACH AUFFORDERUNG DURCH DEN SUPPORT ANPASSEN ---
server.port=8080
Einrichtung HTTPS
Anpassungen bereits vorhandener Parameter
Um die ForumSuite via HTTPS
aufrufen zu können, müssen der Konfigurationsdatei application.properties
weitere Parameter hinzugefügt werden.
ForumSuite > Version 2022-12.1
SSL Parameter application.properties
#KeyStore Parameter und Pfade
server.ssl.certificate=config/my-cert.crt
server.ssl.certificate-private-key=config/my-cert.key
server.ssl.trust-certificate=config/ca-cert.crt
Das Zertifikat sowie die Schlüsseldatei werden im Ordner config der ForumSuite mit abgelegt.
Das Zertifikat wird im Format .crt benötigt und die Schlüsseldatei im Format .key oder .pem.
Beachten Sie bitte das die Schlüsseldatei ohne Passwort sein muß.
Sollten Sie das Zertifikat nicht im richtigen Format vorliegen haben, so können Sie sich die benötigten Dateien ggf. auch selbst erstellen.
Für die Umwandlung / Extraktion können Sie entweder das Tool KeyStore Explorer unter Windows nutzen, oder mithilfe der Nachfolgenden Befehle z.B. aus einer .P12 Datei .
privaten Schlüssel extrahieren aus PFX
openssl pkcs12 -in certname.pfx -nocerts -out key.pem -nodes
Zertifikat extrahieren aus PFX
openssl pkcs12 -in certname.pfx -nokeys -out cert.pem
Passwort vom Schlüssel entfernen
openssl rsa -in c:\<Pfad>\schlüssel.pem -passin pass:'<Passwort>' -out c:\>Pfad>\server.key
Darüber hinaus muss in der Konfigurationsdatei application.properties
der Parameter für die Frontend URL
angepasst werden. Dieser wird für die Generierung der Links in EMail's verwendet.
zu aktualisierende Parameter in der Datei application.properties
#an dieser Stelle http durch https ersetzen
application.frontend.url=https://<Server>.<domain>.<tld>/
#alternativ mit Verschlüsselung z.B. über Port 8443
#application.frontend.url=https://<Server>.<domain>.<tld>:8443/
#Port über welchen die Anwendung aufgerufen werden soll - 8443 oder 443 (https Standard)
server.port=443
#alternativ mit Verschlüsselung z.B. über Port 8443
#server.port=8443
Nach erfolgreicher Anpassung der Parameter starten Sie den Dienst der ForumSuite bitte neu.
Verzeichnisdienste
# Konfiguration Active Directory:
application.ad.enabled=true oder false -- Pflichtangabe
application.ad.domain=Domainname -- Pflichtangabe
application.ad.url=Adresse des AD-Servers, z.B. ldap://ad-server.lan/ -- Pflichtangabe
application.ad.user.searchbase=Basis für Suche der Nutzer im AD, z.B. O=FIRMA (optional)
application.ad.user.searchfilter=Suchfilter für Nutzer, z.B. (&(objectClass=user)(sAMAccountName={1})) (optional, siehe Hinweis im Text)
Beim Active Directory (AD) handelt es sich um einen Verzeichnisdienst von Microsoft für Windows-Netzwerke. Das Active Directory ermöglicht es, die Struktur einer Organisation nachzubilden. Der erste Wert gibt ab, ob ein AD verbunden werden soll. Der Zweite definiert den Domainnamen und zum Schluss wird die Adresse des AD-Servers benötigt.
Sofern Sie eine eigene Angabe für den Suchfilter (application.ad.user.searchfilter) vornehmen, wird der Platzhalter {0} durch den Nutzernamen mit AD-Domain (nutzter@domain) ersetzt, der Platzhalter {1} durch den reinen Nutzernamen, wie er in der Anmeldemaske eingegeben wird.
Anpassen der Import Mappings
Zur Vereinfachung der Arbeit mit der ForumSuite empfehlen wir den Import von Mitarbeiter-Daten aus dem Active Directory. Der Import wird über eine Datei gesteuert.
Im Installationsverzeichnis befindet sich der Ordner „config“. Öffnen Sie diesen und benennen Sie die Datei import_mapping_ad.json5.sample in import_mapping_ad.json5 um.
Bearbeiten Sie die Datei anschließend mit einem normalen Text-Editor.
Anpassung der Datei start_suite
Anpassung der Datei start_suite.cmd
im Programmverzeichnis der ForumSuite durch hinzufügen des Parameters -Djavax.net.ssl.trustStoreType=WINDOWS-ROOT
start_suite.cmd
FOR %%f IN (FORUM_Suite_*.jar) DO java -Djavax.net.ssl.trustStoreType=WINDOWS-ROOT -Xmx4G -jar %%f
Anpassung der Datei application.properties
Anpassung der Datei application.properties
im Verzeichnis conf
des Programmverzeichnisses der ForumSuite durch Anpassung der Parameters application.ad.url
.
conf\application.properties
application.ad.url=ldaps://<server>.<domain>.<tld>:<port>
Die Angabe des Ports (Standard: 636) ist optional.
Nach der Anpassung der Werte ist der Neustart des ForumSuite Dienstes erforderlich.
Die Anbindung eines Lightweight Directory Access Protocol (LDAP) Dienstes stellt eine Alternative zur AD-Anbindung dar.
# Konfiguration LDAP:
application.ldap.enabled=true oder false -- Pflichtangabe
application.ldap.url=Adresse des LDAP-Servers, z.B. ldap://ldap-server.lan/ -- Pflichtangabe
application.ldap.username=Nutzername für LDAP-Zugriff (optional, nur wenn für den LDAP-Zugriff notwendig)
application.ldap.password=Kennwort für LDAP-Zugriff (optional, nur wenn für den LDAP-Zugriff notwendig)
application.ldap.user.searchbase=Basis für LDAP-Suche, z.B. O=FIRMA -- Pflichtangabe
application.ldap.user.searchfilter=Suchfilter für Nutzer, z.B. (|(cn={0})(mail={0})(displayName={0})) -- Pflichtangabe
Die Einträge searchbase und searchfilter sind abhängig von der Struktur Ihres LDAP-Verzeichnisses. Innerhalb des Eintrags searchfilter wird der Platzhalter {0} durch den Anmeldenamen ersetzt.
Werden beide Anbindungen (AD und LDAP) aktiviert, erfolgt für die Prüfung der Authentifizierung zuerst über das Active Directory und anschließend – sofern die Anmeldung per AD nicht erfolgreich war – über LDAP.
Falls Sie eine detailliertere Steuerung der Reihenfolge oder die Anbindung zusätzlicher AD/LDAP-Verzeichnisse benötigen, nutzen Sie bitte die im folgenden beschriebene erweiterte Konfiguration für die Verzeichnisdienste.
Einbindung weiterer Anmeldungsserver
Sofern erforderlich, können weitere Authentifizierung-Server können über die Konfigurationsdatei extra_auth_servers.json5
hinzugefügt werden.
Eine Authentifizierung der Benutzer wird dann in der Reihenfolge der Einträge in der Datei versucht.
- Umbenennen der Datei
./config/extra_auth_servers.json5.sample
nach./config/extra_auth_servers.json5
- Anpassung des Inhaltes der Datei
./config/extra_auth_servers.json5
Aufgrund der sequentiellen Abarbeitung der Anmeldungsserver können Log-Meldungen zu fehlgeschlagenen Anmeldeversuchen auftreten, die in diesem Fall normal sind.
Zur Diagnose von Problemen bei der Anmeldung (sowohl AD als auch LDAP) können Sie folgende Einträge zu den application.properties hinzufügen:
logging.level.org.springframework.security=DEBUG
logging.level.org.springframework.security.web=INFO
Festlegung technische Administratoren
Einzelnutzer
Beispiel; technische Administratoren in Datei config\application.poperties
application.adminusers=nutzer-01,nutzer-02,nutzer-03
An dieser Stelle legen Sie alle technischen Administratoren fest. Tragen Sie dazu alle Login-Kennungen derjenigen Nutzer aus Ihrem konfigurierten Verzeichnisdienst (siehe oben) ein, die mit dem entsprechenden Recht ausgestattet werden sollen. Trennen Sie mehrere Einträge mit Komma und fügen Sie keine zusätzlichen Leerzeichen ein.
Die technischen Administratoren haben zunächst keine Zugriffsberechtigung auf Inhalte der ForumSuite. Sie sind aber berechtigt, Mitarbeiter und Nutzer anzulegen sowie Zugriffsrechte zu erteilen.
Beispiel: application.adminusers=anton.admin,siegbert.sicher
ActiveDirectory (AD) Gruppe (Version > 2022-12.1)
Es kann auch eine Active Directory (AD) Gruppe mit technischen Administratoren in der Datei application.properties
hinterlegt werden.
Dies hat den Vorteil, das technische Administratoren an zentraler Stelle gepflegt werden können.
Beispiel; Gruppe mit technischen Administratoren in Datei config\application.properties
#Beispiel AD Gruppen-Parameter für technische Administratoren in der Datei application.properties
#Hier wurde eine Gruppe App-ForumSuite-techAdmins im ActiveDirectory angelegt und Mitarbeitern zugeordnet.
application.admingroups=App-ForumSuite-techAdmins
Die hinterlegte Gruppe darf am jeweiligen Benutzer nicht als primäre Standardgruppe hinterlegt sein.
Kommunikation
Mailserver-Anbindung
Die ForumSuite selbst kann keine E-Mails verschicken und benötigt daher die Anbindung an einen SMTP-Mailserver, um Nutzer per E-Mail über Aufgaben und Termine zu benachrichtigen.
# Konfiguration Mailserver:
spring.mail.host=Adresse des SMTP-Servers ohne Protokoll-Angabe, z.B. smtp-server.lan
spring.mail.port=Zielport, über den der SMTP-Server erreichbar ist, z.B. 25
spring.mail.username=Nutzername für Zugriff auf den SMTP-Server (optional, nur wenn für den Mailversand notwendig)
spring.mail.password=Kennwort für den Zugriff auf den SMTP-Server (optional, nur wenn für den Mailversand notwendig)
spring.mail.properties.mail.smtp.auth=true oder false — aktiviert/deaktiviert SMTP-Authentifizierung, Pflichtangabe
spring.mail.properties.mail.smtp.starttls.enable=true oder false — aktiviert/deaktiviert StartTLS Verschlüsselung, Pflichtangabe
In jedem Falle wird der Name der Mailserver und der zu nutzende SMTP-Port benötigt. Die weiteren Werte werden für eine ggf. erforderlich Authentifikation und Verschlüsselung benötigt.
Die ForumSuite ist ausschließlich für den Mailversand gedacht. Es können keine E-Mails empfangen werden.
Speicherort der Datenbank (optional)
application.database.file
Dieser Wert definiert den Speicherort der verwendeten Datenbank sowie des zugehörigen Volltext-Indexes. Normalerweise liegt dieser Ordner im Installationsverzeichnis – der Speicherort kann von Ihnen aber frei definiert werden, sofern dies erforderlich ist.
Für die Standardinstallation ist keine Anpassung notwendig.
Bitte achten Sie darauf, dass der Speicherort der Datenbank vom Server immer erreichbar ist und ausreichende Lese- und Schreibrechte existieren.
Verwenden Sie bei der Definition ausschließlich Forward-Slashes (/) zur Unterteilung der Pfade.
Standardwert: application.database.file=database/lucene_suite
Beispiel: application.database.file=//FILESERVER/FORUM-SUITE/database
Speicherort für Anhänge (optional)
application.uploads.path
Der Eintrag legt fest, wo die Software hochgeladene Anhänge ablegt. Standardmäßig liegt dieser Ordner im Installationsverzeichnis – der Speicherort kann von Ihnen aber frei definiert werden, sofern dies erforderlich ist.
Für die Standardinstallation ist keine Anpassung notwendig.
Bitte achten Sie darauf, dass das Verzeichnis vom Server immer erreichbar ist und ausreichende Lese- und Schreibrechte sowie genügend Speicherplatz vorhanden sind.
Verwenden Sie bei der Definition ausschließlich Forward-Slashes (/) zur Unterteilung der Pfade.
Standardwert: application.uploads.path=uploads
Beispiel: application.uploads.path=
//FILESERVER/FORUM-SUITE/uploads
Interne Konfiguration (nur nach Aufforderung ändern)
Über die Einträge in diesem Bereich können weitere, interne Parameter der Software gesteuert werden.
Bitte ändern Sie Einträge aus dem Bereich Interne Konfiguration nur nach Aufforderung durch den Support. Ansonsten kann es zum Ausfall oder Fehlfunktionen der ForumSuite kommen.
Vielen Dank für Ihr Verständnis!
Datensicherung
Automatische Datensicherung
application.backup.path=//FILESERVER/FORUM-SUITE/backups
Dieser Wert definiert den Speicherort der zu erstellenden Backups. Normalerweise liegt dieser Ordner im Installationsverzeichnis – der Speicherort kann von Ihnen aber frei definiert werden, sofern dies erforderlich ist.
Manuelle Datensicherung
Um eine Datensicherung vorzunehmen, gehen Sie wie folgt vor:
- beenden Sie die Anwendung (siehe „Beenden der Anwendung“ oben)
- sichern Sie das gesamte Installationsverzeichnis über ein Backup-Programm Ihrer Wahl oder durch einfaches Kopieren der enthaltenen Dateien auf ein Sicherungsmedium.
Sollten Sie die Datenbank oder Anhänge an einer anderen Stelle außerhalb des Installationsverzeichnisses abgelegt haben, müssen diese Speicherorte natürlich ebenfalls gesichert werden (geänderte Konfigurationseinträge für application.database.file bzw. application.uploads.path, siehe oben).
Konfiguration Import AD Benutzer
Neben der lokalen Benutzerverwaltung bietet die ForumSuite die Möglichkeit des Benutzerimports. Für die Java Plattform steht hierfür eine Schnittstelle zum Active Directory bereit.
Voraussetzungen
- Der Active Directory Server muss vom ForumSuite Server erreichbar sein
- Der Zugriff auf das Active Directory ist zulässig, ggf. mittels seperaten technischen AD-Nutzer
- Es existiert eine Konfigurationsdatei zur Steuerung des Active Directory Import
Konfiguration ForumSuite
In der Konfigurationsdatei für die ForumSuite application.properties wird der Pfad zur Konfigurationsdatei für den Active Directory Import angegeben.
Der Dateiname ist prinzipiell frei wählbar.
Einbindung Import Mapping Datei
application.ad.import.config.file=config/import_mapping_ad.json5
Konfiguration Active Directory Import
Allgemeiner lesender Zugriff auf das Active Directory
Der Zugriff benötigt einen Domainbenutzer, dessen Passwort und eine Beschreibung, wo im Active Directory die zu importierenden Nutzer zu finden sind.
Verwenden Sie vorzugsweise einen technischen Benutzer, dessen Passwort sich nicht ändert.
Konfiguration Import von Mitarbeitern aus dem AD
config: {
user: 'reader@ad.domain.lan',
// Das Passwort muss aus technischen Gründen im Klartext vorliegen.
password: 'xxxx',
// ab wo soll gesucht werden?
searchbase: 'OU=Nutzer,OU=Firma,DC=ad,DC=domain,DC=lan',
// Domäne hier im Beispiel: ad.domain.lan
// bei Zuordnung bitte auf Typ OU-Container oder CN-Container achten!!!
// Ordner entsprechend mit Unterordnern angeben z.B. Firma mit einem Unterordner Nutzer
// Welche Objekt sollen importiert werden
// Im Beispiel: alle Objekte vom Typ person und deren Account nicht deaktiviert ist
filter: '(&(objectClass=person)(!(userAccountControl:1.2.840.113556.1.4.803:=2)))'
}
Mapping der Daten Active Directory > ForumSuite - Mitarbeiter
// Mapping der Felder:
// Aufbau: <FeldName FORUM Mitarbeiter-Objekt> : { adId: <Attribut in AD> }
fieldmap: {
extid: {
// Eindeutige, idealerweise unveränderliche ID zur eindeutigen Identifikation des Mitarbeiters.
// (Diese sollte auch nach Namensänderungen erhalten bleiben.)
adId: 'sAMAccountName',
isPrimaryId: true,
isCaseInsensitive: true
},
kennung: {
// Login-Kennung des Mitarbeiters bei Authentifizierung über das Active Directory (normalweise 'sAMAccountName'):
adId: 'sAMAccountName'
},
// Persönliche Daten (sofern kein Import erwünscht, bitte Flag 'skip' für den Eintrag auf 'true' setzen):
nachname: {
adId: 'sn'
},
vorname: {
adId: 'givenName'
},
titel: {
adId: 'personalTitle'
},
email: {
adId: 'mail'
},
telefon: {
adId: 'telephoneNumber'
},
mobiltelefon: {
adId: 'mobile',
skipImport: true
},
telefonprivat: {
adId: 'homePhone',
skipImport: true
}
}
Sofern kein Import erwünscht, bitte Flag 'skipImport' für den Eintrag auf 'true' setzen.
Paging der Active Directory Daten
// Anzahl der pro Aufruf zu lesenden Datensätze (Paging).
// Hierdurch kann ein serverseitig vorhandes Limit umgegangen werden.
// (Standardwert: 1000 / ein Wert kleiner 1 deaktiviert die Paging-Funktion und verarbeitet nur
// die vom Server gelieferten - ggf. unvollständigen - Resultate)
pagesize: 1000
Das Paging ist nur in Fällen, mit sehr vielen AD Nutzern notwendig.
Optionale Funktionen
Authentifizierung von Benutzern ohne Verzeichnis (Active Directory oder LDAP)
Dieser Artikel betrifft ausschließlich die Java Plattform.
Der Einsatz der in die ForumSuite integrierten Benutzerverwaltung zur Authentifizierung von Nutzern wird nicht für den produktiven Betrieb empfohlen. Nutzen Sie nach Möglichkeit die Anbindung an ein Active Directory oder LDAP-Verzeichnis.
Eine weitere Möglichkeit für die Einrichtung von Benutzern außerhalb des zentralen Verzeichnisdienstes ist die Anlage und Passwortvergabe innerhalb der ForumSuite. Die Passworte werden in diesem Fall verschlüsselt in der Datenbank der ForumSuite abgelegt.
Anpassung der Datei
conf\application.propierties
durch Modifikation/Hinzufügen des Parametersapplication.auth.user.suite.enabled
.conf\application.properties
BASHapplication.auth.user.suite.enabled=true
Neustart des ForumSuite Dienstes nach Anpassung erforderlich.
Deaktivierung des AD/LDAP Importes
Abbildung: Deaktivierung AD/LDAP SyncAnlegen eines Mitarbeiters in der Mitarbeiterverwaltung.
Abbildung: Weg zur MitarbeiterverwlatungAbbildung: neu angelegter MitarbeiterMit den im Feld
Login-Kennung
hinterlegten Daten meldet sich der Benutzer dann an.Initiales Vergabe eines Passwortes durch den Administrator in der Benutzerverwaltung.
Abbildung:; Aufruf Nutzer in der BenutzerverwaltungAbbildung: Eingabemöglichkeit InitialkennwortNach speichern des Nutzerdokumentes kann sich der manuell angelegte Mitarbeiter mit der
Login-Kennung
und demPasswort
anmelden und über den oben beschriebenen Weg ein eigenes Kennwort vergeben.Falls der AD/LDAP Import vor der Anlage aktiv war, muss nun die Schnittstelle wieder aktiviert werden.
Single-Sign-On über Kerberos (SSO)
Zur Konfiguration eines Single-Sign-Ons mittels Kerberos beachten Sie bitte die nachfolgende Anleitung:
Einleitung
Zur Aktivierung des SingleSignOn (SSO) über Kerberos muss die Funktionalität im Active Directory (AD) des Unternehmens aktiviert und konfiguriert werden.
Darüber hinaus müssen Anpassungen in den Einstellungen der ForumSuite sowie ggf. für den auf dem Windows Desktop des Anwenders verwendeten Browsers vorgenommen werden.
Anpassung am Active Directory
Sämtliche nachfolgende Angaben zu Benutzern, Passworten, Servern und Domains müssen auf die für ihr Unternehmen gültigen Werte angepasst werden.
Registrieren des Dienstprinzipalnamens (SPN)
#Am AD Server auszuführen.
#In der Befehlszeile den Server auf welchem die ForumSuite gehostet wird hinterlegen.
#Die Angabe des Ports ist optional (falls abweichend von Standard HTTP Port). Notation: HTTP/server.domain.lan:<Port>
PS C:\>setspn -A HTTP/server.domain.lan Benutzer
Generierung KeyTab Datei
PS C:\>ktpass /out c:\fsuite.keytab /mapuser Benutzer@domain.lan /princ HTTP/server.domain.lan@DOMAIN.LAN /pass 'Password' /ptype KRB5_NT_PRINCIPAL /crypto All
Die erzeugte Datei im Ordner config
der ForumSuite ablegen und den Pfad im Parameter application.kerberos.keytab-location
hinterlegen (siehe nächster Abschnitt).
Notwendige Parameter in der Datei application.properties
der ForumSuite
Parameter | Defaultwert | Bedeutung | Beispiel |
---|---|---|---|
application.kerberos.enabled | false | Kerberos SSO aktiv? | application.kerberos.enabled=true |
application.kerberos.service-principal | (leer) | ServicePrincipalName | application.kerberos.service-principal=HTTP/server.domain.lan@DOMAIN.LAN |
application.kerberos.keytab-location | (leer) | Pfad zur Keytab-Datei des Services Bei relativen Angaben muss das Verzeichnis z.B. "config/" mit angegeben werden. | application.kerberos.keytab-location=config/fsuite.keytab |
application.kerberos.remove-domain | false | AD-Domain aus Login-Kennung entfernen? Falls ein "@" in der Kennung enthalten ist, werden als Nutzername nur die Zeichen davor behalten. Beispiel: Bei aktivierter Einstellung wird die Kennung "ad-benutzer@DOMAIN.LAN" zu "ad-benutzer". | application.kerberos.remove-domain=true |
application.kerberos.debug | false | Debug-Modus aktiv? | application.kerberos.debug=true |
Anpassung Browser
Zur Nutzung von Kerberos SSO müssen – sofern noch nicht erfolgt – Anpassungen der auf den Windows Desktop des Anwenders genutzten Browser vorgenommen werden.
Die nachfolgende Einstellung existiert nur für Windows! Unter MacOS und Linux ist die Einstellungsmöglichkeit für SSPI nicht vorhanden.
Fügen Sie die Domäne zum lokalen Intranet hinzu.
OAuth Microsoft Entra
Anwendung registrieren
Parameter config\application.properties
# Konfiguration Microsoft Entra ID Login (ehemals Azure Active Directory):
# - Pflichtangaben:
application.entra.enabled=true
# Entra ID Tenant-ID:
# https://learn.microsoft.com/de-de/entra/fundamentals/how-to-find-tenant
application.entra.tenant.id=
# Name der Entra ID Anwendung:
application.entra.app.name=
# Client-ID der Entra ID Anwendung:
application.entra.client.id=
# Client Secret der Entra ID Anwendung:
application.entra.client.secret=
# - optionale Parameter:
# Steuerung Entra ID Logout-Verhalten:
application.entra.logout.enabled=false
Für den Einsatz der ForumSuite haben Sie die Wahl zwischen zwei Plattformen:
- IBM/HCL Domino bzw. XWork Server ab Version 9.0.1FP8 (Windows oder Linux, kostenpflichtig), nachfolgend als „IBM/HCL Domino Plattform“ bezeichnet
- Beliebige Umgebung, welche eine 64 Bit Java 8 Runtime oder höher unterstützt (Windows, Linux oder MacOS X, keine Zusatzkosten), nachfolgend als „Java Plattform“ bezeichnet
Möchten Sie von der „IBM/HCL Domino Plattform“ in die „Java Plattform“ wechseln, sind die nachfolgend beschrieben Schritte notwendig.
Installieren Sie die Java Plattform wie in unserem Handbuch beschrieben unter Java Plattform installieren.
Hinweis für Version bis 2024-04:
Bitte beachten Sie, dass alle Versionsnummern der ForumSuite in beiden Plattformen identisch sein muss. Die betrifft die Version der ForumSuite und alle Vorschlagsdatenbanken.
Nur der technische Administrator ist berechtigt, den Export durchzuführen.
Starten Sie nun den kompletten Datenexport der Domino ForumSuite.
Zum Export der Daten aus der „IBM/HCL Domino Plattform“ gelangen Sie über die Startseite einer beliebigen Anwendung der ForumSuite und fügen am Ende der Browserzeile ein /export ein und bestätigen die Eingabe mitenter
.Daraufhin wird die folgende Seite geöffnet:
Abbildung: Datenexport aller Inhalte ( ab Version 2024-08)Bitte wählen Sie die Option „kompletter Datenbestand (alle Anwendungen inclusive Vorschläge)“ aus der Liste und betätigen Sie anschließend die Schaltfläche „Datenexport durchführen“.
Ab der Version 2024-08 erfolgt der Export immer incl. aller Vorschläge. Somit müssen Sie nach einem Import auf PaaS oder SaaS auch nicht nochmals hinzugefügt werden.
Nutzen sie eine ältere Version, so ist die Auswahl "kompletter Datenbestand (alle Anwendungen, keine Vorschläge)" richtig und die Vorschläge müssen im Anschluss neu hinzugefügt werden.
Je nach Umfang aller Datenbanken kann dieser Vorgang einige Zeit in Anspruch nehmen.
Währen des Exportes wird der Fortschritt sowie der erfolgreiche Abschluss des Exports angezeigt.
Bitte vermerken Sie die angezeigten Vorschläge mit den Versionsnummern. Diese werden spätern für die Installation der Java Plattform benötigt.
Nach einer erfolgreichen Erstellung der Exportdatei erhalten Sie zusätzlich einen Hinweis in der blauen Box rechts oben im Bild.
Sie können die Datei nun herunterladen. Nach dem Download wird die Datei automatisch vom Server gelöscht.
Abbildung: Datenexport aller Inhalte ( bis Version 2024-04)Abbildung: Datenexport aller Inhalte ( bis Version 2024-04)Abbildung: Datenexport aller Inhalte ( bis Version 2024-04)Öffnen Sie die ForumSuite der Java-Plattform und fügen am Ende der Browserzeile ein /install < V2022-03 bzw. /#/install => V2022-03 ein.
Bestätigen die Eingabe mit
enter
.Wählen Sie über Durchsuchen die entsprechende ZIP-Datei mit den zuvor aus der „IBM/HCL Domino Plattform“ exportierten Daten für den Import der Daten und betätigen Sie die Schaltfläche Installieren.
Abbildung: Aufruf der Installation zum ImportNach erfolgreichem Import führen Sie Bitte einen Neustart der Java Plattform durch.
Geben Sie anschließend bitte die Lizenzschlüssel für die einzelnen Anwendungen der ForumSuite ein, sofern noch nicht erfolgt.
Lizenznehmer und Schlüssel sind identisch mit den bereits in der Domino ForumSuite hinterlegten Daten.Hinterlegen Sie alle in der „IBM/HCL Domino Plattform“ genutzten Vorschlagsdatenbanken für die ForumSuite in der „Java Plattform“.
Eine Anleitung finden Sie unter Aktualisierung der Vorschläge/Kataloge.
Bitte beachten Sie, dass die Versionsnummern aller Vorschlagsdatenbanken von beiden Plattformen identisch sind.
- Nach erfolgreichem Import vergewissern Sie sich nochmal über den vollständigen Import durch eine Kontrolle.
- Bitte deaktivieren Sie in der Konfiguration der „IBM/HCL Domino Plattform“ die Benachrichtigung, um den Versand von Emails zu unterbinden.
- Ändern Sie bitte für die Revisionssicherheit in der „IBM/HCL Domino Plattform“ für die betreffenden Mitarbeiter die Berechtigungen in der Benutzerverwaltung auf den Status LESER.
Gern unterstützen wir Sie bei der Migration über eine Fernwartung. Der Preis für den zweistündigen Support beträgt 200,- EUR zuzüglich Umsatzsteuer. Bitte setzen Sie sich zur Terminabsprache mit uns in Verbindung.
Der Termin muss vorab mit der FORUM vereinbart werden, eine sofortiger Support über zwei Stunden ist derzeit nicht umsetzbar.
Die Fernwartung wird über TeamViewer durchgeführt. Bitte prüfen Sie vor der Teilnahme die Systemanforderungen, um Verbindungsprobleme zu vermeiden.