SKOOR Webservice Installation

Voraussetzungen

Installation

Installieren Sie das eranger-webservice-Paket aus dem SKOOR-Repository:

# yum install eranger-webservice
eranger-jre and eranger-phantomjs will be installed as dependent packages.

Das Paket wird die folgenden Änderungen am System vornehmen:

  1. Installieren Sie SKOOR Webservice im Verzeichnis /opt/eranger/eranger-webservice (Spring Boot App)
  2. Konfigurieren Sie den Dienst, einschließlich des automatischen Starts beim Booten
  3. Erstellen Sie die Webdienstkonfiguration in /etc/opt/eranger/eranger-webservice.cfg
  4. Erstellen Sie die Reverse-Proxy-Konfiguration in /etc/httpd/conf.d/eranger-webservice-proxy.conf
    /eranger-webservice -> http://localhost:8090/
  5. Konfigurieren Sie die Protokollrotation in /etc/logrotate.d/eranger-webservice.conf
  6. Starten Sie den Webdienst
  7. Laden Sie die Apache-Konfiguration neu

Dienst starten / stoppen / neu starten /status

Der eRanger Webservice ist als Linux-Dienst konfiguriert und kann mit den entsprechenden Befehlen verwaltet werden:

# service eranger-webservice start
# service eranger-webservice stop
# service eranger-webservice restart
# service eranger-webservice status

oder

# systemctl start eranger-webservice
# systemctl stop eranger-webservice
# systemctl restart eranger-webservice
# systemctl status eranger-webservice

Benutzerdefinierte Konfiguration

Die Standardkonfiguration sollte ohne Änderungen sofort einsatzbereit sein.

Folgende Änderungen können bei Bedarf vorgenommen werden:

Tomcat-Port

Sollte der Standardport 8090 nicht verfügbar sein, kann dieser in der Datei „/opt/eranger/eranger-webservice/eranger-webservice.conf“ geändert werden:

/opt/eranger/eranger-webservice/eranger-webservice.conf
# Spring Boot service config file
# Has to be in the same directory as the JAR file
MODE=service
JAVA_HOME=/opt/eranger/eranger-jre/current
APP_NAME=eranger-webservice
JAVA_OPTS="-Dserver.port=8091"
PID_FOLDER=/var/opt/run/eranger
LOG_FOLDER=/var/log/eranger
LOG_FILENAME=eranger-webservice.log

Derselbe Port muss in der Reverse-Proxy-Konfiguration in "/etc/httpd/conf.d/eranger-webservice-proxy.conf" konfiguriert werden:

/etc/httpd/conf.d/eranger-webservice-proxy.conf
# mod_proxy setup for using httpd as a reverse proxy for tomcat
# has to placed in /etc/httpd/conf.d
ProxyPass /eranger-webservice http://localhost:8091/
ProxyPassReverse /eranger-webservice http://localhost:8091/
<Location "/eranger-webservice">
  setOutputFilter DEFLATE
  Require all granted
  Satisfy Any
  Order allow,deny
  Allow from all
</Location>

PID-Datei

In der Standardkonfiguration wird eine PID-Datei nach "/var/opt/run/eranger" geschrieben.

Wird ein anderer Pfad bevorzugt, kann dieser in der Datei „/opt/eranger/eranger-webservice/eranger-webservice.conf“ konfiguriert werden.

/opt/eranger/eranger-webservice/eranger-webservice.conf
# Spring Boot service config file
# Has to be in the same directory as the JAR file
MODE=service
JAVA_HOME=/opt/eranger/eranger-jre/current
APP_NAME=eranger-webservice
JAVA_OPTS="-Dserver.port=8091"
PID_FOLDER=/new/pid/path

Mehrere Mandanten

Der Webservice ist in der Lage, Daten von mehreren SKOOR Engine Backends unter Verwendung der tenantId abzurufen.

Um zusätzliche Backends zu konfigurieren, muss man einen separaten eranger-webservice- .cfg-Konfigurationsdatei im Ordner /etc/opt/eranger. Diese Datei ist im Grunde eine Kopie der Standarddatei eranger-webservice.cfg mit einer tenanc-spezifischen eranger-Adresse.

/etc/opt/eranger/eranger-websevice-<tenantId>.cfg
# eRanger Server Address
eranger.address=<host of Skoor server>

Sie müssen files.root oder reviews.root nicht ändern. Der Webserver übernimmt die Trennung dieser Ordner selbst.


Nachdem die Konfiguration gespeichert wurde, sollten Sie in der Lage sein, Daten von der konfigurierten SKOOR Engine abzurufen, indem Sie entweder den HTTP-Anforderungsheader X-Tenant-Id oder den URL-Parameter tenantId angeben.