Konfiguration Backend Credentials

Mindbreeze InSpire

Mindbreeze GmbH, A-4020 Linz, 2018.

Diese Unterlagen sind streng vertraulich. Durch die Übermittlung und Präsentation dieser Unterlagen alleine werden keine Rechte an unserer Software, an unseren Dienstleistungen und Dienstleistungsresultaten oder sonstigen geschützten Rechten begründet. Die Weitergabe, Veröffentlichung oder Vervielfältigung ist nicht gestattet.

Aus Gründen der einfacheren Lesbarkeit wird auf die geschlechtsspezifische Differenzierung, z.B. Benutzer/-innen, verzichtet. Entsprechende Begriffe gelten im Sinne der Gleichbehandlung grundsätzlich für beide Geschlechter.

Einleitung

Diese Anleitung gilt für G7 Appliances.

Mindbreeze InSpire verwendet zur Verwaltung der Anmeldedaten die Softwarekomponente Keycloak. Im diesem Abschnitt werden die wichtigsten Anwendungsfälle (Passwort ändern, Benutzer anlegen…) beschrieben. Darüber hinaus finden Sie hier weiterführende Dokumentation: Keycloak 3.4 Server Administration

Passwort ändern

Bei der ersten Anmeldung im Management Center werden sie dazu aufgefordert das Passwort zu ändern. Möchten Sie zu einem späteren Zeitpunkt das Passwort eines Benutzers ändern, gehen Sie wie folgt vor: Navigieren Sie im Management Center zum Menüpunkt „Setup“, „Credentials“ und dann unter „Manage“ „Users“. Suchen Sie den betreffenden Benutzer mit der Suchfunktion, oder klicken Sie auf „View all users“ um eine Liste der Benutzer anzusehen. Klicken Sie bei dem betreffenden Benutzer auf „Edit“. Im Tab „Credential“ können Sie ein neues Passwort setzen. Mit der Einstellung „Temporary“ bestimmen Sie, ob der Benutzer beim nächsten Anmelden selbst das Passwort ändern muss. Bestätigen Sie Ihre Eingaben mit „Reset Password“.

Benutzer anlegen

Sie können mehrere Benutzer anlegen. Navigieren Sie im Management Center zum Menüpunkt „Setup“, „Credentials“ und dann unter „Manage“ „Users“. Klicken Sie rechts auf „Add user“ vergeben Sie anschließend den Benutzernamen „Username“ und klicken Sie auf „Save“. Wechseln Sie anschließend ins Tab „Credentials“ um ein Passwort zu setzten. Dies ist im vorherigen Abschnitt „Passwort ändern“ beschrieben. Nachdem Sie ein Passwort gesetzt haben müssen Sie dem Benutzer noch Rollen zuweisen, ansonsten ist der neue Benutzer nicht sinnvoll nutzbar. Dazu siehe folgenden Abschnitt „Rollen verwalten“. Um die Funktion „Passwort vergessen/zurücksetzen“ benutzen zu können, wird empfohlen für jeden Benutzer eine gültige E-Mail-Adresse anzugeben.

Rollen verwalten

Der Zugriff auf die verschiedenen Bereiche vom Management Center (z.B. „Reporting“, „Configuration“) werden mit Rollen geregelt. Beispielsweise muss ein Benutzer die Rolle „InSpire Config Administrator“ besitzen, um im Management Center den Punkt „Configuration“ benutzen zu können. Standardmäßig sind bereits mehrere „InSpire“-Rollen angelegt. Sie können die Liste aller verfügbaren Rollen folgendermaßen abrufen: Navigieren Sie im Management Center zum Menüpunkt „Setup“, „Credentials“ und dann unter „Configure“, „Roles“. Der Benutzer „admin“ besitzt standardmäßig alle Rollen. Sie können Benutzer wie folgt Rollen zuweisen oder entfernen: Navigieren Sie im Management Center zum Menüpunkt „Setup“, „Credentials“ und dann unter „Manage“ „Users“. Suchen Sie den betreffenden Benutzer mit der Suchfunktion, oder klicken Sie auf „View all users“ um eine Liste der Benutzer anzusehen. Klicken Sie bei dem betreffenden Benutzer auf „Edit“. Wechseln Sie zum Tab „Role Mappings“. Hier können Sie die Rollen zuweisen.

Standard Rollen

Im Auslieferungszustand sind mehrere Rollen vorkonfiguriert, die für den Betrieb erforderlich sind. Dieser Abschnitt beschreibt, welche Rollen das sind, und welche Bedeutung diese Rollen haben.

Die Rollen lassen sich in 2 Kategorien unterteilen:

Mindbreeze InSpire Rollen (Name beginnt mit „InSpire“)
Keycloak Administrationsrollen

Im Folgenden wird Mindbreeze „InSpire Management Center“ als MMC abgekürzt.

Beschreibung der Mindbreeze InSpire Rollen

Folgende Mindbreeze InSpire Rollen sind standardmäßig angelegt:

Rollenname	Beschreibung	Beispiele (Auszug)
„InSpire Administrator”	Zugriff auf MMC „Update” und „InSpire Global Settings“	Updates Installieren, Conainermanagement
„InSpire app.telemetry Administrator”	Zugriff auf MMC „Reporting“ (app.telemetry)	Diagnostik, Log-Dateien lesen, Feedback lesen. Diagostik-Konfiguration lesen und ändern.
„InSpire Application Impersonation“	Berechtigt im Client die Verwendung von „Trusted Peer Authentication“ Siehe Dokumentation: „Konfiguration von Trusted Peer Authentication für Mindbreeze InSpire“	„Trusted Peer Authentication“ im Client verwenden, Im Namen anderer Benutzer suchen.
„InSpire Config Administrator”	Zugriff auf MMC „Configuration”	Mindbreeze InSpire Konfiguration lesen und ändern
„InSpire Index User”	Zugriff auf die Diagnose-Servlets „filter“ und „index“	Index/Filter Status Abfragen, detaillierte Diagnosemöglichkeiten
„InSpire Index Writer”	Zugriff um Dokumente zu Indizieren	Dokumente indizieren oder löschen, Dokumente filtern, Zugriff für externe Konnektoren
„InSpire Overview User”	Grundlegender Zugriff auf das MMC
„InSpire Services Administrator”	Zugriff auf MMC „Services”	Nodes starten/stoppen, Reindex
„InSpire Webmin Administrator”	Zugriff auf MMC „System”	Dateien herunterladen, hochladen und bearbeiten, Zeitzonen verwalten
“InSpire Vocabulary Administrator”	Zugriff auf MMC „Synonyms, Replacements, Vocabulary“	Synonyme, Replacements und Vocabulary bearbeiten
“InSpire Relevance Administrator”	Zugriff auf Search Apps, Query Boosting, Relevance	Relvance und Boosting bearbeiten
“InSpire Resource Administrator”	Kombination aus InSpire Vocabulary Administrator und InSpire Relevance Administrator	Kombination aus den Rollen „InSpire Vocabulary- und InSpire Relevance Administrator“

Beschreibung der Keycloak Administrationsrollen

Folgende Keycloak Administrationsrollen sind standardmäßig angelegt:

Rollenname	Beschreibung	Beispiele (Auszug)
„admin“	Zugriff auf „Credentials“	Benutzer anlegen / löschen, Rollenzuordnungen ändern
„create-realm“	Nicht verwendet
„offline-access“	Nicht verwendet
„uma_authorization“	Nicht verwendet

Darüber hinaus finden Sie hier weiterführende Dokumentation: Keycloak 3.4 Server Administration

Konfiguration auf Mindbreeze-Standards zurücksetzen

Falls die Anmeldedaten-Verwaltung nicht mehr richtig funktioniert, kann die Anmeldedaten-Verwaltung auf Mindbreeze-Standards zurückgesetzt werden. Eine Fehlfunktion kann folgende Ursachen haben:

Das Passwort für den Administrator ist verloren gegangen
Eine für den Betrieb von Mindbreeze InSpire notwendige Konfiguration wurde verändert, dazu gehören folgende Teile der Konfiguration
- Rollen mit Namen beginnend mit „InSpire“
- Der Client „mindbreeze-inspire“
- Das Realm-Theme „mindbreeze“

Das Zurücksetzen auf Mindbreeze-Standards setzt das Passwort vom Administrator zurück und setzt die Konfiguration der für den Betrieb notwendigen Teile der Konfiguration zurück. Andere Teile der Konfiguration werden nicht verändert. Es wird empfohlen vor dem Zurücksetzten ein Backup anzufertigen.

Das Zurücksetzen auf Mindbreeze-Standards wird wie folgt durchgeführt:

Melden Sie sich auf dem Terminal der Appliance mit dem root-Benutzer an.
Navigieren Sie in das Verzeichnis /var/data/upload/image/keycloak/scripts
Führen Sie das Script reset_to_mindbreeze_defaults.sh aus, und lesen Sie sich die Warnhinweise aufmerksam durch. Führen Sie schließlich das Script erneut aus mit einem Parameter, den Sie aus den Warnhinweisen entnommen haben.
Das Zurücksetzen dauert einige Minuten, die Mindbreeze-Services sind während dieser Zeit nicht verfügbar.