Installation von Parsoid

Systemvoraussetzung

Die Installation von Parsoid erfordert die Installation von Node.js.

Überprüft werden kann die Installation durch

$ nodejs --version
$ node -v
$ npm -v

Installation und Konfiguration

Linux

Parsoid installieren

Es wird auf die Installation aus Paketquellen der Distribution verzichtet. Installiert wird Parsoid unter /usr/local.

Hierzu wechseln wir dorthin

$ cd /usr/local

Holen von Parsoid:

$ git clone https://gerrit.wikimedia.org/r/p/mediawiki/services/parsoid parsoid

Installation von Parsoid:

$ cd parsoid
$ npm install

Überprüfung der Installation:

$ npm test

Anlegen der Default-Konfiguration:

$ cp config.example.yaml config.yaml

Parsoid konfigurieren

Öffnen der Datei config.yaml:

$ vi /usr/local/parsoid/config.yaml

Für die grundlegende Installation von Parsoid ist das Anpassen der URL zur MediaWiki api (uri:) und der domain (domain:) ausreichend. Wir empfehlen unbedingt, niemals mit "localhost" zu arbeiten sondern mit dem tatsächlichen vhost-Alias, mit dem das MediaWiki auch von außen erreichbar ist. So vermeiden werden zusätzliche Apache-Konfigurationen vermieden.

Bei Benutzung des Alias sollte dieser unbedingt mit einer Loopback-IP (127.0.0.1) in der /etc/hosts hinterlegt werden! Dabei ist außerdem darauf zu achten, dass der Webserver nicht auf die externe IP bindet.

Parsoid manuell starten

Parsoid kann manuell mit Konsolenausgabe gestartet werden:

$ npm start

Parsoid als Daemon starten

Hierzu gibt es mehrere Möglichkeiten. Am ehesten bietet sich pm2 an, da dies mehrere Anwendungen/Dienste in nodejs vereinigt.

Installation von pm2:

$ npm install -g pm2

Starten von Parsoid als Daemon via pm2:

$ pm2 start /usr/local/parsoid/bin/server.js

Speichern der pm2 Prozessliste - dies fügt Parsoid zu den pm2-Diensten fest hinzu:

$ pm2 save

pm2 in den System-Autostart legen:

# Render startup-script for a specific platform, the [platform] could be one of:
#   ubuntu|centos|redhat|gentoo|systemd|darwin|amazon
$ pm2 startup [platform]

Windows

Öffnen Sie eine Konsole mit Administratorberechtigungen und wechseln Sie dort in das Installationsverzeichnis von Node.js (wenn Sie sich an unsere Empfehlungen zur Ordnerstruktur unter Windows gehalten haben \bluespice\bin\nodejs). Führen Sie dort den Befehl npm install parsoid aus.

Die Konfiguration von Parsoid unter Windows ist nahezu identisch zu Parsoid unter Linux. In dieser Anleitung gibt es dennoch eine Unterscheidung der entsprechenden Artikel aufgrund der unterschiedlichen Pfade im Dateisystem. Auch hier halten wir uns an oben erwähnte Ordnerstruktur und gehen entsprechend von den Pfaden in dieser Dokumentation aus.

Anlegen der Konfigurationsdatei

Legen Sie die Datei \bluespice\etc\parsoid.yaml an. Kopieren Sie folgenden Inhalt in diese:

worker_heartbeat_timeout: 300000

logging:
    level: info

services:
  # Geben Sie hier bei "module" den absoluten Pfad der index.js
  # im Unterordner "lib" des parsoid-Moduls von nodejs an.
  # Der erste "/" stellt dabei die oberste Ebene Ihres Laufwerks
  # dar. Nutzen Sie keine "\" sondern "/"
  - module: /bluespice/bin/nodejs/node_modules/parsoid/lib/index.js
    entrypoint: apiServiceWorker
    conf:
        mwApis:
        # Geben Sie bei "uri" die URL an, unter der Sie die api.php
        # Ihrer MediaWiki-Installation erreichen können. Dies muss
        # keine öffentliche Adresse sein, Sie können durchaus mit
        # "localhost" arbeiten, sofern Ihr Webserver entsprechend
        # darauf konfiguriert ist.
        - uri: 'http://localhost/api.php'
          domain: 'bluespice'

Die beiden relevanten Änderungen, die Sie selber bei Bedarf anpassen müssen ("module" und "uri") sind im entsprechenden Kommentar darüber erklärt.

Speichern und schließen Sie die Datei.

Aktivieren von VisualEditor in BlueSpice

Wechseln Sie in das Verzeichnis <installpath-bluespice>/settings.d. Öffnen Sie die Dateien
020-BlueSpiceVisualEditorConnector.php und
020-VisualEditor.php
in einem Texteditor.

In der zweiten Zeile finden Sie einen Code, der bei beiden Erweiterungen diese deaktiviert:

return; // Disabled. Needs Parsoid

Fügen Sie wahlweise ein Kommentarzeichen (#) an den Anfang dieser Zeile ein oder löschen Sie diese Zeile komplett, speichern die beiden Dateien 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))

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

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, ist der VisualEditor erfolgreich aktiviert.