Visual editor

From Organic Design
Revision as of 18:11, 22 May 2015 by (talk) (Change source-code blocks to standard format)

I'm creating a local page for this as it was quite difficult to install so I want some of my own notes for future reference. The main page for the extension is at MW:Extension:VisualEditor.

First download and unpack a snapshot for the extension corresponding to the wiki version as usual, then install nodejs with apt, but if your repo has an older version than 0.8, then remove it and install from NodeSource using the following commands (see this for details).

curl -sL | sudo bash -
apt-get install nodejs

Now install the paisoid package via apt (see MW:Parsoid/Setup for more detail). First add the key for the deb,

gpg --keyserver --recv-keys 6BF6E273
gpg -a --export 6BF6E273 | sudo apt-key add -

Then add the following to you /etc/apt/sources.list (only amd64 is available),

deb [arch=amd64] wmf-production main

Then udpate and install it,

apt-get update
apt-get install parsoid

Edit the parsoid configuration (/etc/mediawiki/parsoid/settings.js) adding a line for each wiki in the wikia that will be using the editor, e.g.

parsoidConfig.setInterwiki( '123', '' );

You may also like to lock down the parsoid daemon so it can only be accessed from the local host which you can do by editing /etc/default/parsoid and changing the INTERFACE setting from to


Restart the parsoid daemon and then test that you can read a page as follows (note the wiki ID matching the setting above):

/etc/init.d/parsoid restart
wget http://localhost:8142/123/Main_Page

Include the extension and its settings in the wiki's LocalSettings.php, e.g.

include( "$IP/extensions/VisualEditor/VisualEditor.php" );

// Enable by default for everybody
$wgDefaultUserOptions['visualeditor-enable'] = 1;

// Don't allow users to disable it
$wgHiddenPrefs[] = 'visualeditor-enable';

// OPTIONAL: Enable VisualEditor's experimental code features
#$wgDefaultUserOptions['visualeditor-enable-experimental'] = 1;

// Specify which wiki from the parsoid configuration we're using
$wgVisualEditorParsoidURL = 'http://localhost:8142';
$wgVisualEditorParsoidPrefix = '123';

// Add organicdesign to the supported skins
$wgVisualEditorSupportedSkins[] = 'organicdesign';

// Namespaces to enable VisualEditor in
$wgVisualEditorNamespaces[] = NS_USER_TALK

Private wikis

If you're running a private wiki (no public editing allowed) then you'll need to also set the following, but note that this means your cookie data is being sent over HTTP, so make sure you only do this if the parsoid daemon is on the localhost.

$wgSessionsInObjectCache = true;
$wgVisualEditorParsoidForwardCookies = true;


If you're system is running an SSD and you've gone through the SSD Optimisation checklist then you'll need to edit the start case in the /etc/init.d/parsoid file and have it create the /var/log/parsoid directory owned by parsoid. See the Nginx and MariaDB examples on that page for details.