Version: GSB 7Installationsanleitung
Das GSB Adminportal ist eine optionale Komponente des GSB und wird als eigenständiges Modul des GSB ausgeliefert. Die Installation und Basiskonfiguration des GSB Adminportals ist somit nicht in der Standard-Installationsanleitung enthalten, sondern wird an dieser Stelle explizit dokumentiert. Die Installation und Konfiguration des GSB Adminportals wird mit Hilfe des Standard GSB-Deployments, also mit dem Skript gsbinstall durchgeführt.
Neben dem eigentlichen GSB Adminportal wird noch eine SingleSignOn-Komponente auf Basis des Central Authentication Service (CAS) benötigt. CAS wird für die Authentisierung am GSB Adminportal und GSBAdmin-Mandanten benötigt. Wird eine in der Infrastruktur einer Hosting-Plattform vorhandene Piwik-Installation ebenfalls in das GSB Adminportal eingebunden, so muss Piwik auch mit CAS gekoppelt werden.
Voraussetzungen
Die Installationsvoraussetzungen des GSB-Kerns müssen gegeben sein, das heißt, die Schritte zur Vorbereitung und Aktivierung eines GSB-Release müssen durchgeführt (s.a. GSB Installationsvoraussetzungen) worden sein.
Weiterhin wird für das GSB Adminportal ein GSB-konformer LDAP-Server benötigt, der als Beistellung und Installationsvoraussetzung für die GSB-Infrastruktur installiert und konfiguriert werden muss. Informationen zur GSB-konformen Einrichtung des LDAP-Servers finden sich in den LDAP-Installationshinweisen.
Installation des GSB Adminportals
Das GSB Adminportal ist im GSB-Release parallel zum GSB-Kern als eigenständige Komponente enthalten. Das Verzeichnis "AdminPortal" enthält die Portal-Software sowie Vorlagendateien, die für das Deployment des Portals benötigt werden.
Bereitstellung der Liferay-Basis
Für die Installation des GSB Adminportals ist zunächst das zugrundeliegende Liferay-Portal bereitzustellen. Eine für das GSB Adminportal angepasste Version des Liferay-Portals befindet sich im Ordner Software/GSB in der Datei liferay-portal-war-gsb-patched-6.2.5.1.war. Diese Datei ist in das Verzeichnis ~cmadmin/admin/extern zu kopieren.
Vorbereitung der Build-Properties
Die für das GSB Adminportal benötigten Build-Properties müssen aus dem Verzeichnis Adminportal/buildProperties in den Ordner ~cmadmin/admin/config unter Beibehaltung der Verzeichnisstruktur kopiert werden. Für die Installation und den Betrieb des Portals werden die folgenden Dateien benötigt:
- build_ap_tomcat_adminportal.properties enthält alle Build-Properties, die für die Installation und Konfiguration des GSB Adminportal Tomcat-Servers benötigt werden.
- webapps/build_ap_webapp_adminportal.properties enthält die Build-Properties für die Installation und Konfiguration der Adminportal Webapplikation.
Anpassung der Hostnamen
Als Vorlage enthalten die Build-Properties Beispielwerte für eine Reihe von Hostnamen. Diese müssen an die konkreten Servernamen der Hostingplattform angepasst werden. Folgende Hostnamen müssen angepasst werden:
- Adminportal_web_server_host Servername, auf dem der GSB Adminportal Tomcat installiert ist.
- database.domain.example Name des Datenbank Servers
- Adminportal_ldap_host Name des LDAP-Server
- cas_server_host Servername des Central-Authentication-Service
Einrichtung der Datenbank
Die Konfiguration der Datenbank wird in den build_ap_webapp_adminportal.properties vorgenommen. Der angegebene Datenbank Nutzer samt Passwort muss existieren und Zugang zur Datenbank "Adminportal" haben. Bei der Neuinstallation des GSB Adminportals werden initial die Tabellen angelegt, wenn die Datenbank "Adminportal" leer ist. Weitere Informationen zum Anlegen eines Datenbanknutzers finden sich in der GSB-Installationsanleitung im Kapitel Anlegen der Datenbankuser.
Aktivierung
Nachdem die Build-Properties kopiert und angepasst worden sind, muss die Komponente "Adminportal" noch aktiviert werden. Details zur Aktivierung finden sich in der GSB-Installationsanleitung im Kapitel "Aktivierung von Komponenten". Die Aktivierung des GSB Adminportals wird mit dem folgenden Kommando durchgeführt.
<syntaxhighlight lang="xml" enclose="div">gsbinstall activateComponent $GSB_ADMIN_HOME/config/build_ap_tomcat_adminportal.properties</syntaxhighlight>
Nach Aktivierung des GSB Adminportals ist dieses unter dem Komponentennamen "adminportaltomcat" auf dem Server registriert und kann unter diesem Namen installiert und aktualisiert werden.
Installation
Die Installation des GSB Adminportals kann im Rahmen einer Komplettinstallation der GSB-Komponenten eines Servers durchgeführt werden (s.a. Installation der Komponenten).
<syntaxhighlight lang="xml" enclose="div">gsbinstall rebuildSystem</syntaxhighlight>
Alternativ kann das GSB Adminportal auch mit Hilfe des rebuildComponent Deployments mit folgenden Kommando installiert werden.
<syntaxhighlight lang="xml" enclose="div">gsbinstall rebuildComponent adminportaltomcat</syntaxhighlight>
Hinweis: Nach einer Erstinstallation des GSB Adminportals muss dieses vor der ersten Nutzung zweimal gestartet werden. Beim ersten Start des GSB Adminportals werden noch einige Initialisierungen vorgenommen, die für die anschließende produktive Nutzung benötigt werden. Die Initialisierung des Portals benötigt ca. 3-4 Minuten. Im Anschluss an die Initialisierung werden keine weiteren Logmeldungen mehr in das Logfile catalina.out geschrieben, so dass zu diesem Zeitpunkt das Portal gestoppt und anschließend wieder gestartet werden kann.
Installation CAS
Der Central Authentication Service (CAS) ist im GSB-Release parallel zum GSB-Kern als eigenständige Komponente enthalten. Das Verzeichnis "CAS" enthält die CAS Software sowie Vorlagendateien, die für das Deployment der CAS-Komponente benötigt werden.
Vorbereitung der Build-Properties
Die für den CAS benötigten Build-Properties müssen zunächst aus dem Verzeichnis CAS/buildProperties in den Ordner ~cmadmin/admin/config kopiert werden. Für die Installation und den Betrieb des CAS werden die folgenden Dateien benötigt:
- build_ap_tomcat_cas.properties enthält alle Build-Properties, die für die Installation und Konfiguration des CAS Tomcat-Servers benötigt werden.
- webapps/build_ap_webapp_cas.properties enthält alle Build-Properties, die für die Konfiguration der CAS Webapplikation benötigt werden.
Anpassung der Build-Properties
Als Vorlage enthalten die Build-Properties Beispielwerte für eine Reihe von Hostnamen. Diese müssen an die konkreten Servernamen der Hostingplattform angepasst werden. Folgende Hostnamen müssen angepasst werden:
- cas_server_host Servername, auf dem der CAS Tomcat installiert ist.
- cas_ldap_host Name des LDAP-Server
Aktivierung
Nachdem die Build-Properties kopiert und angepasst worden sind, muss die Komponente "CAS" noch aktiviert werden. Details zur Aktivierung finden sich in der GSB-Installationsanleitung im Kapitel "Aktivierung von Komponenten". Die Aktivierung des CAS wird mit dem folgenden Kommando durchgeführt:
<syntaxhighlight lang="xml" enclose="div">gsbinstall activateComponent $GSB_ADMIN_HOME/config/build_ap_tomcat_cas.properties </syntaxhighlight>
Nach Aktivierung des CAS ist dieser unter dem Komponentennamen "castomcat" auf dem Server registriert und kann unter diesem Namen installiert und aktualisiert werden.
Installation
Die Installation des CAS kann im Rahmen einer Komplettinstallation der GSB-Komponenten eines Servers durchgeführt werden (s.a. Installation der Komponenten).
<syntaxhighlight lang="xml" enclose="div">gsbinstall rebuildSystem</syntaxhighlight>
Alternativ kann der CAS auch mit Hilfe des rebuildComponent Deployments mit folgendem Kommando installiert werden.
<syntaxhighlight lang="xml" enclose="div">gsbinstall rebuildComponent castomcat</syntaxhighlight>
Einbindung in den GSB-Webserver
Der Zugriff auf das GSB Adminportal und den CAS-Server erfolgt über einen vorgeschalteten Webserver. Hierzu wird in einem GSB-Apache ein VirtualHost konfiguriert, der für die Beantwortung von GSB Adminportal- und CAS-Server -Anfragen zuständig ist. Die Konfiguration des entsprechenden VirtualHost befindet sich in dem "Pseudomandanten" Adminportal.
Anbindung an den GSBAdmin
Um Inhalte mittels CAS und SSO im GSB Adminportal anzeigen zu können, muss der GSBAdmin mit CAS konfiguriert werden. In den Build-Properties der CAE, sieht die Konfiguration wie folgt aus:
Datei build_cm_webapp_cae.properties
- cae_enable_proxyportlet=true aktiviert die Authentisierung mittels CAS über das Proxyportlet
- cas_url=http://adminportal.domain.example/cas Name des CAS Servers