Setup:Installation Manual/Webservices/Extended Search

This document describes the installation of the extended search for BlueSpice. Please take into account, that the Apache Tomcat server must be installed and configured completely.

Tips for this Document

• Please, read this manual completely and work through the single installtion steps one after another. 
• For editing the configuration files with a text editor, the files must be saved in UTF-8 coding without BOM (Byte Order Mark).
• The placeholder <installpath-bluespice> stands for the path to your BlueSpice installation, e.g C:\inetpub\wwwroot\bluespice (Windows) or /var/www/bluespice (Linux).
• The placeholder <tomcat-webapps> stands for the path to the Webapps directory of your Tomcat server, e.g. C:\Program Files\Apache Software Foundation\Tomcat 8.5\webapps (Windows) or /var/lib/tomcat8/webapps (Linux).

Setting-up the Solr-Cores

Create the following directory:

/opt/bluespice/data (Linux)
C:\BlueSpice\bluespice_data (Windows)

left Wollen Sie davon abweichend ein anderes Verzeichnis wählen, so lesen Sie die Hinweise zur individuellen Ordnerstruktur für fortgeschrittene Anwender.

Verschieben Sie den Ordner "solr" aus dem Verzeichnis

If you are going to use a different directory, please read Notes regarding a individual directory structure for advanced users.

Move the directory "solr" from <installpath-bluespice>/extensions/BlueSpiceExtensions/ExtendedSearch/webservices in diesen soeben angelegten Ordner. Wechseln Sie in diesen Ordner und gehen in den Unterordner  to the just created directory.  

Switch to this directory and go to the subfolder bluespice/conf/lang. Wählen Sie die Choose stopword_<LANG>.txt, die Ihrer Sprache entspricht und ersetzen Sie die Datei there, which matches your language and replace the file stopwords.txt im Ordner in the folder bluespice/conf (eine Ebene höher) durch diese Datei. leftUnter Linux übergeben Sie bitte unbedingt den Ordner one level higher) with this file.

With Linux, please transfer the folder /opt/bluespice/data/solr rekursiv dem User und der Gruppe, unter der der Tomcat-Server läuft.Konfiguration recursively to the user and group, under which the Tomcat server is running. 

Configurating Tomcat

Der Tomcat-Server muss das Verzeichnis zum Solr-Core kennen. Im folgenden wird beschrieben, wie dies konfiguriert wird. The Tomcat server needs to know the directory to the Solr core. The following describes how to configure this. 

Linux

Die Distributionen unterscheiden sich an dieser Stelle, je nach Ort der Konfigurationsdatei. Wie es in der von Ihnen verwendeten Distribution konfiguriert werden muss entnehmen Sie bitte der jeweiligen Dokumentation des Distributors. Folgende Schritte erklären die Konfiguration am Beispiel Debian/Ubuntu und Tomcat 8:

Öffnen Sie die Datei The distributions differ at this point regarding the configuration file. How this needs to be configured with the distribution you are using can be found in the documentation of the distributor. The following steps explain the configuration using Debian/Ubuntu and Tomcat 8:

Open the file /etc/default/tomcat8 und fügen ganz am Ende folgende Zeile ein:  and ad the following line at the end: 

JAVA_OPTS="${JAVA_OPTS} -Dsolr.solr.home=/opt/bluespice/data/solr"

Speichern und verlassen Sie die Datei wieder. Save the changes and exit the file. 

Windows

Öffnen Sie die Konfigurationsoberfläche von Tomcat und wechseln Sie in die Registerkarte Open the configuration interface of Tomcat and switch to the tab "Java". Fügen Sie im Feld At the fiel "Java Options" als letzten Punkt die Zeile , add this as the last point in the line:

-Dsolr.solr.home=C:\BlueSpice\bluespice_data\solr

hinzu.

center

Speichern Sie Ihre Einstellung durch Klick auf "Übernehmencenter

Save this settings by clicking at "Apply".

Kopieren der Solr Anwendung

Verschieben Sie die Datei "solr.war" aus dem Verzeichnis <installpath-bluespice>/extensions/BlueSpiceExtensions/ExtendedSearch/webservices nach <tomcat-webapps>

Neustart Tomcat

Starten Sie den Tomcat Webserver neu, siehe auch Neustart von Tomcat.

Aktivieren der Erweiterten Suche in BlueSpice

Wechseln Sie in das Verzeichnis <installpath-bluespice>/extensions/BlueSpiceExtensions. Sofern die Datei BlueSpiceExtensions.local.php noch nicht existiert kopieren Sie bitte nun die Datei BlueSpiceExtensions.default.php und legen Sie im selben Ordner unter dem Namen BlueSpiceExtensions.local.php ab. Öffnen Sie diese Datei in einem Texteditor.

Scrollen Sie ans Ende der Datei. Dort finden Sie folgende Zeile:

#require_once( __DIR__."/ExtendedSearch/ExtendedSearch.setup.php" );

Entfernen Sie hier das erste Zeichen (#), speichern die Datei ab und verlassen Sie diese wieder.

Öffnen Sie nun eine Kommandozeile und wechseln in den Ordner <installpath-bluespice>. Führen Sie dort folgenden Befehl aus:

                php maintenance/update.php (Linux)
php maintenance\update.php (Windows))

            

left Achten Sie unter Windows darauf, dass die Umgebungsvariablen korrekt gesetzt sind, um auf den Befehl "php" zugreifen zu können.

left Beachten Sie unter Linux, dass Sie nach dem Ausführen der update.php die Dateisystemrechte neu anpassen müssen..

Sobald das Script mit der Meldung "Done" abgeschlossen ist führen Sie ein weiteres Maintenance-Script aus, um den Suchindex erstmalig anzulegen:

                php extensions/BlueSpiceExtensions/ExtendedSearch/maintenance/searchUpdate.php (Linux)
php extensions\BlueSpiceExtensions\ExtendedSearch\maintenance\searchUpdate.php (Windows))

            

Die Ausführung des Scripts kann, je nach Menge der von Ihnen möglicherweise bereits angelegten Inhalte, etwas Zeit in Anspruch nehmen. Sobald das Script durchgelaufen ist ist die Erweiterte Suche erfolgreich installiert und einsatzbereit.