Difference between revisions of "Setup:Installation Guide/System Preparation/Linux/Parsoid"
← Setup:Installation Guide/System Preparation/Linux/Parsoid
[quality revision] | [quality revision] |
m (Text replacement - "[[en:{{PAGENAME}}]]" to "[[en:{{FULLPAGENAME}}]]") |
(Tag: Visual edit) |
Contents
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[edit | edit source]
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[edit | edit source]
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[edit | edit source]
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[edit | edit source]
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[edit | edit source]
If you have completed all steps successfully, you can proceed to the next step " Python".
{{DISPLAYTITLE:Installing Parsoid on Linux}} __TOC__ {{Template:Optional|text=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.}} == Installation == The After your BlueSpice Installation, you still have to [[Setup:Installation Guide/Advanced/VisualEditor Configuration|activate VisualEditor]].}} ==Installation== {{Box Note|boxtype=important|Note text=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: <pre>cd /opt</pre> To download Parsoid, the software "git" must be installed(<code>apt install git</code>). Start the download with: <pre>git clone --depth 1 --branch v0.10.0 https://gerrit.wikimedia.org/r/p/mediawiki/services/parsoid parsoid</pre> Install Parsoid with the following commands: <pre>cd parsoid; \ npm install</pre> ==Create the configuration file== In the BlueSpice codebase, you can find two files in the folder <code>extensions/BlueSpiceVisualEditorConnector/docs/parsoid</code>: * *config.yaml * localsettings.js Copy them to the folder <code>/opt/parsoid</code>. Parsoid is already fully configured and should work in standard setup without further changes. =={{Hint|text=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 <code>node bin\/server.js </code> in the <code>/opt/parsoid </code> 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: <pre>npm install -g pm2</pre> Then start Parsoid via pm2: <pre>pm2 start /opt/parsoid/bin/server.js</pre> Now save the pm2 process list — this adds parsoid to the pm2 services: <pre>pm2 save</pre> Finally, add pm2 to the system startup: <pre># Render startup-script for a specific platform, the [platform] could be one of: # ubuntu|centos|redhat|gentoo|systemd|darwin|amazon pm2 startup [platform]</pre> ==Next Step== If you have completed all steps successfully, you can proceed to the next step "[[Setup: Installation Guide/System Preparation/Linux/Python | Python]]". [[en:{{FULLPAGENAME}}]] [[de:etup:Installationsanleitung/Systemvorbereitung/Linux/Parsoid]]
(5 intermediate revisions by 3 users not shown) | |||
Line 1: | Line 1: | ||
− | {{DISPLAYTITLE:Installing Parsoid}} | + | {{DISPLAYTITLE:Installing Parsoid on Linux}} |
__TOC__ | __TOC__ | ||
− | {{Template:Optional|text=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.}} | + | {{Template:Optional|text=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 [[Setup:Installation Guide/Advanced/VisualEditor Configuration|activate VisualEditor]].}} |
− | == Installation == | + | ==Installation== |
+ | {{Box Note|boxtype=important|Note text=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: | The installation from package sources of the distribution will be omitted. Parsoid is installed under /opt. Go there with the following command: | ||
Line 21: | Line 24: | ||
==Create the configuration file== | ==Create the configuration file== | ||
In the BlueSpice codebase, you can find two files in the folder <code>extensions/BlueSpiceVisualEditorConnector/docs/parsoid</code>: | In the BlueSpice codebase, you can find two files in the folder <code>extensions/BlueSpiceVisualEditorConnector/docs/parsoid</code>: | ||
− | * config.yaml | + | |
− | * localsettings.js | + | *config.yaml |
+ | *localsettings.js | ||
Copy them to the folder <code>/opt/parsoid</code>. | Copy them to the folder <code>/opt/parsoid</code>. | ||
Line 28: | Line 32: | ||
Parsoid is already fully configured and should work in standard setup without further changes. | Parsoid is already fully configured and should work in standard setup without further changes. | ||
− | ==Installing Parsoid and checking the configuration == | + | {{Hint|text=If rights are missing, run "sudo nautilus" in the terminal and copy the files from "extensions/BlueSpiceVisualEditorConnector/docs/parsoid" to "/opt/parsoid".}} |
− | To test the installation and the configuration, run the command <code>node bin | + | |
+ | ==Installing Parsoid and checking the configuration== | ||
+ | To test the installation and the configuration, run the command <code>node bin/server.js </code> in the <code>/opt/parsoid </code> folder. | ||
Parsoid should now start without an error message. | Parsoid should now start without an error message. | ||
Line 35: | Line 41: | ||
Quit Parsoid by pressing "Ctrl+C". Keep the command prompt open and go to the next step. | Quit Parsoid by pressing "Ctrl+C". Keep the command prompt open and go to the next step. | ||
− | == Installing Parsoid as a service == | + | ==Installing Parsoid as a service== |
To run Parsoid in the background in the future, you must additionally install pm2 via Node.js: | To run Parsoid in the background in the future, you must additionally install pm2 via Node.js: | ||
Line 58: | Line 64: | ||
− | [[en:{{FULLPAGENAME}}]][[de:etup:Installationsanleitung/Systemvorbereitung/Linux/Parsoid]] | + | [[en:{{FULLPAGENAME}}]] |
+ | [[de:etup:Installationsanleitung/Systemvorbereitung/Linux/Parsoid]] |