SKOOR Webservice Konfiguration

Dienst starten / stoppen / neu starten / Status

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

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

Konfiguration

Die Standardkonfiguration sollte ohne Änderungen sofort funktionieren.

Die folgenden Änderungen können bei Bedarf vorgenommen werden:

AI-Anbieter

AI-Provider werden hauptsächlich für die Generierung von Code aus natürlicher Sprache verwendet. Ein Beispiel ist die Text2SQL-Funktion für Datenabfragen.

SKOOR unterstützt derzeit die folgenden Provider:

  • SKOOR AI

    • Wird von SKOOR betrieben, keine Notwendigkeit, Daten mit anderen Drittanbietern auszutauschen.

    • Gut als Startpunkt.

    • Bietet grundlegende Genauigkeit und Leistung.

    • HTTPS-Verbindung zu ai.skoor.com erforderlich.

    • In jeder SKOOR Installation bereits vorkonfiguriert.

  • OpenAI

    • Wahrscheinlich der fortschrittlichste Anbieter.

    • Benötigt ein API-Abonnement von OpenAI.

    • HTTPS-Verbindung zu OpenAI API Servern erforderlich.

  • Google Gemini

    • Ähnliche Genauigkeit wie OpenAI.

    • Relativ schnell.

    • Benötigt einen API-Schlüssel von Google Cloud.

    • HTTPS-Verbindung zu Google Cloud Servern erforderlich.

AI-Einstellungen (z. B. API-Schlüssel) können unter /etc/opt/eranger/eranger-webservice.cfg konfiguriert werden.

ai.enable=true 
                        # Enables or disables the AI features
ai.openaiApiKey=<key>
                        # API key can be obtained from OpenAI 
ai.googleVertexAiApiKey=/etc/opt/eranger/googleVertexAiKey.json
                        # Google JSON API key can be obtained from the Google Cloud Console.
ai.googleVertexAiProjectId=<google-project-id>
                        
ai.googleVertexAiLocation=<location>
                        # Location of the AI servers. Zurich is europe-west6

Es kann nur eines von google oder openai gleichzeitig aktiv sein. Wenn weder google noch openai konfiguriert ist, wird automatisch SKOOR AI verwendet.

Tomcat-Anschluss

Wenn der Standardport 8090 nicht verfügbar ist, kann er 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

Der gleiche 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.

Wenn ein anderer Pfad bevorzugt wird, 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

Mehrfache Mandantenfähigkeit

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 eine separate eranger-webservice-<tenantId>.cfg Konfigurationsdatei im Ordner /etc/opt/eranger bereitstellen. Diese Datei ist im Grunde eine Kopie der Standarddatei eranger-webservice.cfg mit einer mieterspezifischen eranger-Adresse.

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

Sie müssen files.root oder reports.root nicht ändern. Der Webserver kümmert sich selbst um die Trennung dieser Verzeichnisse.

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