VisualEditor (SoftInstall)

Visual Editor is Java based editor. It works with Parsoid server, RESTbase, and SQLite DB. Parsoid is called from client side. The port, 8142 should be open to world.

Parsoid

Installation

Parsoid is not included in ubuntu package repository. Following commands are required to install Parsoid.

$ sudo apt-key advanced --keyserver keys.gnupg.net --recv-keys 90E9F83F22250DD7
$ sudo apt-add-repository "deb https://releases.wikimedia.org/debian jessie-mediawiki main"
$ sudo apt-get update
$ sudo apt-get install apt-transport-https
$ sudo apt-get update && sudo apt-get install parsoid

Parsoid is installed at /etc/mediawiki/parsoid/. Configuration file is /etc/mediawiki/parsoid/config.yaml. We need to specify location of api.php.

mwApis:
       - # This is the only required parameter,
         # the URL of you MediaWiki API endpoint.
         uri: 'http://localhost/api.php'
         # The "domain" is used for communication with Visual Editor
         # and RESTBase.  It defaults to the hostname portion of
         # the `uri` property below, but you can manually set it
         # to an arbitrary string.
         domain: 'localhost'  

• Note that space should be used. (not tab key)

User parsoid is created.

$ sudo useradd -r -s /sbin/nologin -d /dev/null -M -c 'Unprivileged system account for Parsoid' parsoid

Daemon

Parsoid is serving TCP port 8142. Daemon is controlled by;

$ sudo service parsoid start
$ sudo service parsoid stop

Any error will be recorded at /var/log/parsoid/parsoid.log

You can check daemon status by

$ ps -ax|grep parsoid

Node js

Node.js is used to install RESTbase software. Node.js is Javascript runtime platform.

Installation

$ sudo apt-get update
$ sudo apt-get install nodejs
$ sudo apt-get install npm

RESTbase

RESTbase is installed at /var/lib/restbase. It uses SQLite database engine.

Install

$ cd /var/lib
$ sudo git clone https://github.com/wikimedia/restbase.git
$ sudo npm install

• sqlite3 and restbase-mod-table-sqlite should be presented at node_modules directory.
• npm requires lots of memory during execution. It is good to stop "apache2" and "mysql" before executing npm.

create config.yaml by copying config.example.yaml. Edit as follows

       paths:
         /{domain:atomic.snu.ac.kr}:
           x-modules:
             - path: projects/example.yaml
               options:
                 action:
                   # XXX Check API URL!
                   apiUriTemplate: http://atomic.snu.ac.kr/api.php
                   # XXX Check the base RESTBase URI
                   baseUriTemplate: "{{'http://{domain}:7231/{domain}/v1'}}"
                 parsoid:
                   # XXX Check Parsoid URL!
                   host: http://localhost:8142
                 table:
                   backend: sqlite
                   dbname: /var/lib/restbase/db.sqlite3

MediaWiki settings

LocalSettings.php should be modified as following.

wfLoadExtension( 'VisualEditor');
$wgDefaultUserOptions['visualeditor-enable'] = 1;
$wgVirtualRestConfig['modules']['parsoid'] = array(
// URL to the Parsoid instance
// Use port 8142 if you use the Debian package
// 'url' => 'http://localhost:8000',
'url' => 'http://localhost:8142',
// Parsoid "domain", see below (optional)
'domain' => 'localhost',
// Parsoid "prefix", see below (optional)
'prefix' => 'atomic'
);
$wgSessionsInObjectCache = true;
$wgVirtualRestConfig['modules']['parsoid']['forwardCookies'] = true;

Problems

"편집" and "원본편집" will appear at menu tab. When parsoid is down, clicking "편집" has no effect. In this case, check running status of parsoid daemon, and fix it.