Parsoid/JS/Setup

Before you begin
If you are using Parsoid in conjunction with VisualEditor, note that they are developed in parallel and upgrades to one often require a corresponding upgrade to the other. If in doubt, please check the Extension:VisualEditor page and follow its setup instructions first.

Of course, Parsoid can be used stand-alone (to convert wikitext to HTML DOM and vice-versa) and if you don't need VisualEditor, you can ignore the above.

If you are a developer, or if you lack access to sudo apt-get because you're on shared hosting, you probably want to follow the Developer Setup instructions. This page documents setup for a typical user of Parsoid using the native software packaging for your operating system. (Although, if your preferred operating system is not listed here, you might try the developer setup instructions &mdash; good luck!)

If your shared hosting doesn't allow you to install Parsoid, you can also try this workaround: Installation on a shared host.

If you run into problems, consult the troubleshooting pages. If you'd like to contribute your problems and suggested solutions to others, we encourage you to add that information to the troubleshooting pages, in order to keep this page of typical installation instructions as clear and simple as possible.

First you will need to install Parsoid. After this is done, skip to the section of this page in order to ensure that Parsoid can talk to your mediawiki instance.

Please note that Parsoid 0.10.0 may not work with node 12, as described on Phabricator.

Ubuntu / Debian
These packages work on all architectures and with current distros: Ubuntu 14+ and Debian testing, unstable or wheezy (stable) with backports enabled . See the manual installation on Linux or Mac OS X instructions if your distribution is older & doesn't have nodejs ≥ v8.x available.

Import the repository gpg key: (key created on 2019-06-13 with validity 2029-04-23)

If the last command above isn't working (gpgkeys: key AF380A3036A03444 canot be retrieved), you can try another key server. This one should work : or (if the firewall is blocking)

Add the Wikimedia repository: On ubuntu 16.04 you may need to install "software-properties-common" in order to run "apt-add-repository" sudo apt-get install software-properties-common
 * Ubuntu


 * Debian

With Jessie and Stretch, first make sure you have backports enabled, because nodejs 4.x is too old to run the latest release of Parsoid. Then, add the parsoid repository:

Install:

Then, open the config file in  and update it to reflect your API URL. See the section below for details.

Notes: Caveats about the deb: Error loading data from server: internal_api_error_Exception: [0db2f13b5ceecfae5a4c1a98] Exception caught: PHP cURL extension missing. Check https://www.mediawiki.org/wiki/Manual:CURL. Would you like to retry? solved with apt install php-curl systemctl reload apache2 PS: after posting this noticed https://www.mediawiki.org/wiki/Extension:VisualEditor#Troubleshooting  mentions similar.
 * Modifications brought to the configuration file will only become active after restarting the service by.
 * The repository will contain the latest available version of Parsoid. Older versions can be installed manually.
 * The default port used is 8142 (not 8000 so you'll need to, for example, change  in LocalSettings.php).
 * The log file is, and is automatically rotated.
 * With nodejs version 4.x (default version included in debian), parsoid may fail to start. Upgrading nodejs (version 10.x worked in one case) version may be required to solve the issue.
 * If you are on an older distribution and nodejs >= v4 is not available, see the Nodejs installation instructions. You might be able to get a recent packaged version of nodejs.  If you have to install node.js from source (we recommend nave), you'll need to use the Parsoid/Developer Setup instructions.
 * Some folks report that you should also ensure that curl is installed as well: .  Please add some more details here if you find this to be true on your setup.
 * 2018-09-20 during our upgrade from mw v29 to 31, We already had curl installed. when i tested ve got this:

Arch
Parsoid is available in AUR under aur/parsoid (release version) or aur/parsoid-git (development version). Install however you would usually install AUR packages. Enable and start the parsoid service and configure per below. Remember to restart the service for changes to take effect.

This installs to  by default.

RedHat/CentOS 7
Parsoid is available from the Git repository.

Try creating an empty directory and checking out a copy of Parsoid:

If you want to use a specific branch, use something like



This should dump everything you need into the current directory. Copy the default configuration (which configures the Parsoid server to listen at http://localhost:8000 ):

Edit this file per (below), then start the server with:

At this point, opening a browser to localhost:8000 should display a page with links to the Parsoid documentation on www.mediawiki.org

As one final step, change your startup files (init.d) to add a task to relaunch  on server startup.

RedHat/CentOS 8
Edit config.yaml. You may need to change uri parameter. Often localhost uri works, and default setting may be ok.

Create this systemd unit file:

Create :

Publish, add and activate the newly defined firewalld service.

Enable the systemd service and verify if Parsoid is reachable.

Vagrant
If you are using the MediaWiki-Vagrant virtual machine, the  role sets up a working Parsoid. If you use the  role, it will enable parsoid as well.

Windows
Requirements:
 * Install Nodejs x86
 * Install Git x86

With nodejs you have to install the build tools using PowerShell 32-bit (as administrator) (this may take a while) npm install --global --production windows-build-tools

You may need to update your npm version to avoid errors

npm -g install npm@latest

npm@next is broken. See https://github.com/npm/npm/issues/16037

If your current directory is in C:\windows\system32, Perform the following command

cd $env:userprofile

Install parsoid npm install parsoid Note: if you get errors 'no such file or directory on 'c:\user\{username}\package.json' run the following:

npm init

or enter the directory in which the package.json file should be located:

%USERPROFILE%\node_modules\parsoid\ Copy the default config and configure parsoid

copy %USERPROFILE%\node_modules\parsoid\localsettings.example.js %USERPROFILE%\node_modules\parsoid\localsettings.js

If you use the config.yaml configuration file, copy that file from the example:

copy %USERPROFILE%\node_modules\parsoid\config.example.yaml %USERPROFILE%\node_modules\parsoid\config.yaml

and edit the content according to your wiki installation.

Run parsoid or on Windows 10+

cd %APPDATA%\npm\node_modules\parsoid node bin/server.js You should open your php.ini file and uncomment the next php modules: otherwise you will get troubles with Parsoid
 * extension=php_curl.dll
 * extension=php_openssl.dll

Docker
This is a version of Parsoid created by community. The original repository can be found at TheNets's GitHub.

Versions available:,  ,  ,.

The images was created over Alpine image.

Requirements

 * Docker installed

How to run
To start Parsoid run the command below. Just pay attention to the MediaWiki version and choose a compatible Parsoid version.

Examples
How to add more than one domain: How to expose on a specific port: (You can use arbitrary port numbers which are not already in use) For more information about Docker setup, check the GitHub page.

Configuration
You can find an example configuration file on github.

Starting with Parsoid 0.6.0, the configuration file is located here:

If the  file for your wiki is not in the default   edit the   file and modify the   parameter to point to the correct location:

The  property gives the API path to your local wiki. The  property is optional; it defaults to the hostname used in the   property if not explicitly set, but it can be an arbitrary string (it doesn't actually have to resolve in DNS).

If your wiki is inside a reverse proxy configuration or similar, you can set the hostname in  to an internal hostname or IP that actually points to your wiki internal IP address, to avoid requests going to the public IP address and then routed back again to the internal server. However, be sure that your web server actually routes requests with that hostname to the wiki (if the server is configured to serve different things for multiple sites or subdomains).

For example: you have a wiki at  with a public IP behind a proxy, and the actual application server is on a second internal server which only serves requests to the wiki when accessed from the   hostname but not with other hostnames (because it serves various different websites). You may need to set an  alias of   and set up your web server to have   as an alias to. Then you can use that hostname in the uri property.

By default, Parsoid opens a UDP socket and send each minute some metrics about the Parsoid heap to a statsD server. If you want to send instead these metrics to the logging backend (with the "trace" log level), add in :

localsettings.js (or settings.js) as configuration file
If you prefer to use  as your configuration file, in the   file uncomment the   path like this: and comment,   and   parameters like this:

In this approach the configuration file lives in one of the following locations:
 * (if you have installed from our Linux packages)
 * (if you have followed the developer setup instructions)

Most configuration options are described in the file itself. The only required edit is to update it to reflect your API URL, something like:

The  is an arbitrarily-selected short string identifying your local wiki, used in log messages. The  is also optional, an arbitrary unique string will be generated if it is omitted. Make sure that the VisualEditor configuration uses the same "domain" and/or "prefix" values as Parsoid. (See the VisualEditor configuration instructions.)

Multiple wikis sharing the same parsoid service
If you have multiple wikis, make sure the  string (and/or   if you are using   as config file) is unique for each. Multiple wikis sharing a single host might need to explicitly set the  property to an arbitrary unique string for each wiki.

Example of configuration in  for multiple wikis:

Example of configuration in  for multiple wikis:

See ../Troubleshooting for additional troubleshooting help.

See Parsoid/Setup/RESTBase for information on how to configure a local RESTBase instance between your local VisualEditor and local Parsoid.

The Parsoid/Setup/RESTBase/Arbitrary domains page describes advanced RESTBase setup, but it may offer additional insight about the purpose of the  and   properties.