Difference between revisions of "WikiServer - Getting VisualEditor working properly"
(13 intermediate revisions by 2 users not shown) | |||
Line 1: | Line 1: | ||
− | <span style="color:#e74c3c"> | + | <span style="color:#e74c3c">'''<big>Note:</big>'''<big> Apparently, This is being rolled into WikiMedia 1.35 by default. '''w00t!!!'''</big></span> |
− | ==Installing VisualEditor (MediaWiki 1.34 or earlier...)== | + | ==<s>Installing VisualEditor (MediaWiki 1.34 or earlier...)</s>== |
− | <span style="color:#e74c3c">'''<big>Note:</big>''' This is still a work in progress... Multi-Wiki is a bit of a fail.</span> | + | <span style="color:#e74c3c"><s>'''<big>Note:</big>''' This is still a work in progress... Multi-Wiki is a bit of a fail.</s></span> |
− | + | '''<big><s>"F*** THIS...WAIT FOR 1.35!"</s></big>''' | |
− | < | + | <s>(or carry on here if you really want to. It'll work. It's just fugly...)</s> |
− | + | [[mediawikiwiki:Extension:VisualEditor|<s>Extension:VisualEditor</s>]] | |
− | + | <u>'''''<s>VisualEditor does not currently work with private wikis. Supposedly, there are workarounds.</s>'''''</u> | |
− | |||
− | + | <u>'''''<s>Oh look! The instructions below for 1.35 do work with 1.34...</s>'''''</u> | |
− | |||
− | + | ===<s>Requirements</s>=== | |
− | |||
− | |||
− | |||
− | |||
− | |||
− | < | + | *<s>Parsoid 0.11.0</s> |
+ | *<s>Node.js 12</s> | ||
− | ==== | + | ====<s>Parsoid Install</s>==== |
+ | <s>https://www.mediawiki.org/wiki/Parsoid/Setup</s> | ||
− | + | *<code><s>sudo apt install dirmngr</s></code> | |
+ | *<code><s>sudo apt-key advanced --keyserver keys.gnupg.net --recv-keys AF380A3036A03444</s></code> | ||
+ | *<code><s>echo "deb <nowiki>https://releases.wikimedia.org/debian</nowiki> jessie-mediawiki main" | sudo tee /etc/apt/sources.list.d/parsoid.list</s></code> | ||
+ | *<code><s>sudo apt install apt-transport-https</s></code> | ||
+ | *<code><s>sudo apt update && sudo apt install parsoid</s></code> | ||
+ | *<code><s>sudo vim /etc/mediawiki/parsoid/config.yaml</s></code> | ||
− | + | <u>'''''<s>This will require further fuckery for the multi-wiki setup with private wiki!</s>'''''</u> | |
− | |||
− | |||
− | |||
− | |||
− | wfLoadExtension( 'VisualEditor' ); | + | ====<s>VisualEditor Install</s>==== |
+ | |||
+ | <s>Find the current version via: [[mediawikiwiki:Special:ExtensionDistributor/VisualEditor|Download MediaWiki extension]]</s> | ||
+ | |||
+ | *<code><s>wget <nowiki>https://extdist.wmflabs.org/dist/extensions/VisualEditor-REL1_34-74116a7.tar.gz</nowiki></s></code> | ||
+ | **'''<s>This URL will change!</s>''' | ||
+ | *<code><s>tar -xzf VisualEditor-REL1_34-74116a7.tar.gz</s></code> | ||
+ | *<code><s>sudo rsync -av VisualEditor /var/www/html/wiki/extensions</s></code> | ||
+ | *<code><s>sudo vim /var/www/html/wiki/LocalSettings.php</s></code> | ||
+ | |||
+ | <s>wfLoadExtension( 'VisualEditor' ); | ||
// Enable by default for everybody | // Enable by default for everybody | ||
$wgDefaultUserOptions['visualeditor-enable'] = 1; | $wgDefaultUserOptions['visualeditor-enable'] = 1; | ||
Line 53: | Line 59: | ||
// Parsoid "prefix", see below (optional) | // Parsoid "prefix", see below (optional) | ||
'prefix' => 'localhost' | 'prefix' => 'localhost' | ||
− | ); | + | );</s> |
− | |||
− | |||
+ | ===<s>Multiple Wiki Configuration</s>=== | ||
− | Repeat the parts above where stuff is done in the /wiki/ folder | + | <s>Repeat the parts above where stuff is done in the /wiki/ folder</s> |
− | (but use the folder for your second wiki... duh...) | + | <s>(but use the folder for your second wiki... duh...)</s> |
− | *<code>sudo vim /etc/mediawiki/parsoid/config.yaml</code> | + | *<code><s>sudo vim /etc/mediawiki/parsoid/config.yaml</s></code> |
− | mwApis: | + | <s>mwApis: |
- # This is the only required parameter, | - # This is the only required parameter, | ||
# the URL of you MediaWiki API endpoint. | # the URL of you MediaWiki API endpoint. | ||
Line 73: | Line 78: | ||
uri: '<nowiki>http://labnotes.tinkernow.net/api.php'</nowiki> | uri: '<nowiki>http://labnotes.tinkernow.net/api.php'</nowiki> | ||
domain: 'notes' | domain: 'notes' | ||
− | prefix: 'notes' | + | prefix: 'notes'</s> |
− | *<code>sudo service parsoid restart</code> | + | *<code><s>sudo service parsoid restart</s></code> |
− | *<code>sudo vim /var/www/html/wiki/LocalSettings.php</code> | + | *<code><s>sudo vim /var/www/html/wiki/LocalSettings.php</s></code> |
− | wfLoadExtension( 'VisualEditor' ); | + | <s>wfLoadExtension( 'VisualEditor' ); |
// Enable by default for everybody | // Enable by default for everybody | ||
Line 95: | Line 100: | ||
$wgVirtualRestConfig['modules']['parsoid'] = array( | $wgVirtualRestConfig['modules']['parsoid'] = array( | ||
− | |||
'url' => '<nowiki>http://localhost:8142'</nowiki>, | 'url' => '<nowiki>http://localhost:8142'</nowiki>, | ||
'domain' => 'wiki', | 'domain' => 'wiki', | ||
'prefix' => 'wiki' | 'prefix' => 'wiki' | ||
− | ) | + | );</s> |
− | *<code>sudo vim /var/www/html/notes/LocalSettings.php</code> | + | *<code><s>sudo vim /var/www/html/notes/LocalSettings.php</s></code> |
− | wfLoadExtension( 'VisualEditor' ); | + | <s>wfLoadExtension( 'VisualEditor' ); |
// Enable by default for everybody | // Enable by default for everybody | ||
Line 123: | Line 127: | ||
'url' => '<nowiki>http://localhost:8142'</nowiki>, | 'url' => '<nowiki>http://localhost:8142'</nowiki>, | ||
'domain' => 'notes', | 'domain' => 'notes', | ||
− | 'prefix' => 'notes' | + | 'prefix' => 'notes' |
− | + | );</s> | |
− | ); | ||
==VisualEditor on MediaWiki 1.35 or newer== | ==VisualEditor on MediaWiki 1.35 or newer== | ||
Line 141: | Line 144: | ||
#*(details coming...) | #*(details coming...) | ||
#*Download the extension (do this ON the server...): | #*Download the extension (do this ON the server...): | ||
− | #**<code>wget <nowiki>https://extdist.wmflabs.org/dist/extensions/NetworkAuth-REL1_35-9f2e881.tar.gz</nowiki></code> | + | #*<s>For version 1.34</s> |
+ | #**<code><s>wget <nowiki>https://extdist.wmflabs.org/dist/extensions/NetworkAuth-REL1_34-68393b9.tar.gz</nowiki></s></code> | ||
+ | #*For version 1.35 | ||
+ | #**<code><nowiki>wget https://extdist.wmflabs.org/dist/extensions/NetworkAuth-REL1_35-9f2e881.tar.gz</nowiki></code> | ||
#**(You may need to find the latest or possibly correct version at some point...) | #**(You may need to find the latest or possibly correct version at some point...) | ||
#*Copy it into your Private Wiki: | #*Copy it into your Private Wiki: | ||
− | #**<code>tar -xzf NetworkAuth- | + | #**<code>sudo tar -xzf NetworkAuth-*.tar.gz -C /var/www/privatewiki/extensions</code> |
#**(do adjust for the ACTUAL root of your wiki...) | #**(do adjust for the ACTUAL root of your wiki...) | ||
#Create a user named "'''parsoid'''" on your wiki. | #Create a user named "'''parsoid'''" on your wiki. |
Latest revision as of 15:49, 26 September 2020
Note: Apparently, This is being rolled into WikiMedia 1.35 by default. w00t!!!
Contents
Installing VisualEditor (MediaWiki 1.34 or earlier...)
Note: This is still a work in progress... Multi-Wiki is a bit of a fail.
"F*** THIS...WAIT FOR 1.35!"
(or carry on here if you really want to. It'll work. It's just fugly...)
VisualEditor does not currently work with private wikis. Supposedly, there are workarounds.
Oh look! The instructions below for 1.35 do work with 1.34...
Requirements
Parsoid 0.11.0Node.js 12
Parsoid Install
https://www.mediawiki.org/wiki/Parsoid/Setup
sudo apt install dirmngrsudo apt-key advanced --keyserver keys.gnupg.net --recv-keys AF380A3036A03444echo "deb https://releases.wikimedia.org/debian jessie-mediawiki main" | sudo tee /etc/apt/sources.list.d/parsoid.listsudo apt install apt-transport-httpssudo apt update && sudo apt install parsoidsudo vim /etc/mediawiki/parsoid/config.yaml
This will require further fuckery for the multi-wiki setup with private wiki!
VisualEditor Install
Find the current version via: Download MediaWiki extension
wget https://extdist.wmflabs.org/dist/extensions/VisualEditor-REL1_34-74116a7.tar.gzThis URL will change!
tar -xzf VisualEditor-REL1_34-74116a7.tar.gzsudo rsync -av VisualEditor /var/www/html/wiki/extensionssudo vim /var/www/html/wiki/LocalSettings.php
wfLoadExtension( 'VisualEditor' ); // Enable by default for everybody $wgDefaultUserOptions['visualeditor-enable'] = 1; // Optional: Set VisualEditor as the default for anonymous users // otherwise they will have to switch to VE // $wgDefaultUserOptions['visualeditor-editor'] = "visualeditor"; // Don't allow users to disable it $wgHiddenPrefs[] = 'visualeditor-enable'; // OPTIONAL: Enable VisualEditor's experimental code features #$wgDefaultUserOptions['visualeditor-enable-experimental'] = 1; $wgVirtualRestConfig['modules']['parsoid'] = array( // URL to the Parsoid instance // Use port 8142 if you use the Debian package 'url' => 'http://localhost:8142', // Parsoid "domain", see below (optional) 'domain' => 'localhost', // Parsoid "prefix", see below (optional) 'prefix' => 'localhost' );
Multiple Wiki Configuration
Repeat the parts above where stuff is done in the /wiki/ folder
(but use the folder for your second wiki... duh...)
sudo vim /etc/mediawiki/parsoid/config.yaml
mwApis: - # This is the only required parameter, # the URL of you MediaWiki API endpoint. uri: 'http://wiki.tinkernow.net/api.php' domain: 'wiki' prefix: 'wiki' - # and another MediaWiki uri: 'http://labnotes.tinkernow.net/api.php' domain: 'notes' prefix: 'notes'
sudo service parsoid restartsudo vim /var/www/html/wiki/LocalSettings.php
wfLoadExtension( 'VisualEditor' ); // Enable by default for everybody $wgDefaultUserOptions['visualeditor-enable'] = 1; // Optional: Set VisualEditor as the default for anonymous users // otherwise they will have to switch to VE // $wgDefaultUserOptions['visualeditor-editor'] = "visualeditor"; // Don't allow users to disable it $wgHiddenPrefs[] = 'visualeditor-enable'; // OPTIONAL: Enable VisualEditor's experimental code features #$wgDefaultUserOptions['visualeditor-enable-experimental'] = 1; $wgVirtualRestConfig['modules']['parsoid'] = array( 'url' => 'http://localhost:8142', 'domain' => 'wiki', 'prefix' => 'wiki' );
sudo vim /var/www/html/notes/LocalSettings.php
wfLoadExtension( 'VisualEditor' ); // Enable by default for everybody $wgDefaultUserOptions['visualeditor-enable'] = 1; // Optional: Set VisualEditor as the default for anonymous users // otherwise they will have to switch to VE // $wgDefaultUserOptions['visualeditor-editor'] = "visualeditor"; // Don't allow users to disable it $wgHiddenPrefs[] = 'visualeditor-enable'; // OPTIONAL: Enable VisualEditor's experimental code features #$wgDefaultUserOptions['visualeditor-enable-experimental'] = 1; #$wgVirtualRestConfig['modules']['parsoid']['forwardCookies'] = true; $wgVirtualRestConfig['modules']['parsoid'] = array( 'url' => 'http://localhost:8142', 'domain' => 'notes', 'prefix' => 'notes' );
VisualEditor on MediaWiki 1.35 or newer
Why yes... It IS rolled in.
Either enable it during setup or add
WfLoadExtension( 'VisualEditor' );
to the list in LocalSettings.php
.
Enabling VisualEditor on a Private Wiki
- Install the NetworkAuth extension
- (details coming...)
- Download the extension (do this ON the server...):
For version 1.34wget https://extdist.wmflabs.org/dist/extensions/NetworkAuth-REL1_34-68393b9.tar.gz
- For version 1.35
wget https://extdist.wmflabs.org/dist/extensions/NetworkAuth-REL1_35-9f2e881.tar.gz
- (You may need to find the latest or possibly correct version at some point...)
- Copy it into your Private Wiki:
sudo tar -xzf NetworkAuth-*.tar.gz -C /var/www/privatewiki/extensions
- (do adjust for the ACTUAL root of your wiki...)
- Create a user named "parsoid" on your wiki.
- Add the following to
LocalSettings.php
on your Private Wiki:- replace 127.0.0.1 with the actual IP address of your Wiki Server
require_once "$IP/extensions/NetworkAuth/NetworkAuth.php"; $wgNetworkAuthUsers[] = [ 'iprange' => [ '127.0.0.1' ], 'user' => 'parsoid' ];
- enjoy