Installing Parsoid on Linux

Parsoid is the rendering service for the Visual Editor. The steps listed here are optional and only required if you plan to use them in your BlueSpice installation. After your BlueSpice Installation, you still have to activate VisualEditor.

Installation

Important! Please make sure to use the correct version of Parsoid during installation. The currently supported version is Parsoid 0.10.0.

The installation from package sources of the distribution will be omitted. Parsoid is installed under /opt. Go there with the following command:

cd /opt

To download Parsoid, the software "git" must be installed(apt install git). Start the download with:

git clone --depth 1 --branch v0.10.0 https://gerrit.wikimedia.org/r/p/mediawiki/services/parsoid parsoid

Install Parsoid with the following commands:

cd parsoid; \
npm install

Create the configuration file

In the BlueSpice codebase, you can find two files in the folder extensions/BlueSpiceVisualEditorConnector/docs/parsoid:

• config.yaml
• localsettings.js

Copy them to the folder /opt/parsoid.

Parsoid is already fully configured and should work in standard setup without further changes.

If rights are missing, run "sudo nautilus" in the terminal and copy the files from "extensions/BlueSpiceVisualEditorConnector/docs/parsoid" to "/opt/parsoid".

Installing Parsoid and checking the configuration

To test the installation and the configuration, run the command node bin/server.js in the /opt/parsoid folder.

Parsoid should now start without an error message.

Quit Parsoid by pressing "Ctrl+C". Keep the command prompt open and go to the next step.

Installing Parsoid as a service

To run Parsoid in the background in the future, you must additionally install pm2 via Node.js:

npm install -g pm2

Then start Parsoid via pm2:

pm2 start /opt/parsoid/bin/server.js

Now save the pm2 process list — this adds parsoid to the pm2 services:

pm2 save

Finally, add pm2 to the system startup:

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

Next Step

If you have completed all steps successfully, you can proceed to the next step " Python".