Parsoid (Deprecated) - Revision history

Lchristopherson: Lchristopherson moved page Parsoid to Parsoid (Deprecated) without leaving a redirect

2022-04-14T18:42:21Z

Lchristopherson moved page Parsoid to Parsoid (Deprecated) without leaving a redirect

← Older revision	Revision as of 18:42, 14 April 2022
(No difference)

Lchristopherson at 15:43, 31 March 2022

2022-03-31T15:43:54Z

← Older revision		Revision as of 15:43, 31 March 2022
Line 1:		Line 1:
			[[Category:Webserver]]
	==Introduction==		==Introduction==
	Parsoid is the back-end for VisualEditor (VE). Essentially, it takes the HTML contents from VE and parses it into wikitext, which is the syntax that MediaWiki uses to display pages. It runs off of node.js and can be installed as a service from a package through <code>apt-get</code>, but I've only been able to get it to work when using the running developer setup through PM2.		Parsoid is the back-end for VisualEditor (VE). Essentially, it takes the HTML contents from VE and parses it into wikitext, which is the syntax that MediaWiki uses to display pages. It runs off of node.js and can be installed as a service from a package through <code>apt-get</code>, but I've only been able to get it to work when using the running developer setup through PM2.

Tgriego at 16:26, 17 December 2018

2018-12-17T16:26:05Z

← Older revision		Revision as of 16:26, 17 December 2018
Line 54:		Line 54:
	I'm not sure why this happens, but navigate to <code>/etc/mediawiki/parsoid/lib/config</code> and run <code>sudo vim ParsoidConfig.js</code> and change the following line from true to false:<pre>		I'm not sure why this happens, but navigate to <code>/etc/mediawiki/parsoid/lib/config</code> and run <code>sudo vim ParsoidConfig.js</code> and change the following line from true to false:<pre>
	ParsoidConfig.prototype.strictAcceptCheck = false;		ParsoidConfig.prototype.strictAcceptCheck = false;
	</pre>Alternatively, you can add the following to <code>/etc/mediawiki/parsoid/config.yaml</code> above the line that reads <code>mwApis:</code>:~~<pre>~~		</pre>Alternatively, you can add the following to <code>/etc/mediawiki/parsoid/config.yaml</code> above the line that reads <code>mwApis:</code>:
	strictAcceptCheck: false		strictAcceptCheck: false
	~~</pre>~~

	===Other===		===Other===

Tgriego at 16:12, 17 December 2018

2018-12-17T16:12:55Z

Tgriego at 16:12, 17 December 2018

2018-12-17T16:12:29Z

← Older revision		Revision as of 16:12, 17 December 2018
Line 58:		Line 58:
	</pre>		</pre>

	=== Other ===		===Other===
	If you're getting other errors, try doing the following:		If you're getting other errors, try doing the following:

	* Restart the Parsoid service (if you've installed Parsoid through aptitude)		*Restart the Parsoid service (if you've installed Parsoid through aptitude)
	** <code>sudo systemctl restart parsoid</code>		**<code>sudo systemctl restart parsoid</code>
	* Check your configuration		*Check your configuration
	** Verify that the uri/api url are correct in <code>config.yaml</code>		**Verify that the uri/api url are correct in <code>config.yaml</code>
			*[[mediawikiwiki:Parsoid/Troubleshooting#Check_that_your_localhost_interwiki_is_set_up_correctly\|Make sure that your API url is accessible and functioning properly]]
			*Are you using the Parsoid package?
			**Try using the [[mediawikiwiki:Parsoid/Developer_Setup\|developer build]]
			* The other steps found on [[mediawikiwiki:Parsoid/Troubleshooting\|this article]]
	*		*

Tgriego at 16:10, 17 December 2018

2018-12-17T16:10:05Z

← Older revision		Revision as of 16:10, 17 December 2018
Line 51:		Line 51:
	This happens when you don't have cURL installed. It can be fixed by running <code>sudo apt-get install php7.2-curl</code> and then <code>sudo systemctl restart php7.2-fpm</code>. If you aren't running PHP 7.2, then change the version number in the packages to accommodate your current configuration.		This happens when you don't have cURL installed. It can be fixed by running <code>sudo apt-get install php7.2-curl</code> and then <code>sudo systemctl restart php7.2-fpm</code>. If you aren't running PHP 7.2, then change the version number in the packages to accommodate your current configuration.

	=== HTTP Error 406 ===		===HTTP Error 406===
	I'm not sure why this happens, but navigate to <code>/etc/mediawiki/parsoid/lib/config</code> and run <code>sudo vim ParsoidConfig.js</code> and change the following line from true to false:<pre>		I'm not sure why this happens, but navigate to <code>/etc/mediawiki/parsoid/lib/config</code> and run <code>sudo vim ParsoidConfig.js</code> and change the following line from true to false:<pre>
	ParsoidConfig.prototype.strictAcceptCheck = false;		ParsoidConfig.prototype.strictAcceptCheck = false;
	</pre>Alternatively, you can add the following to <code>/etc/mediawiki/parsoid/config.yaml</code> above the line that reads <code>mwApis:</code>:		</pre>Alternatively, you can add the following to <code>/etc/mediawiki/parsoid/config.yaml</code> above the line that reads <code>mwApis:</code>:<pre>
			strictAcceptCheck: false
			</pre>

			=== Other ===
			If you're getting other errors, try doing the following:

			* Restart the Parsoid service (if you've installed Parsoid through aptitude)
			** <code>sudo systemctl restart parsoid</code>
			* Check your configuration
			** Verify that the uri/api url are correct in <code>config.yaml</code>
			*

Tgriego at 16:06, 17 December 2018

2018-12-17T16:06:31Z

← Older revision		Revision as of 16:06, 17 December 2018
Line 50:		Line 50:
	===HTTP Error 500===		===HTTP Error 500===
	This happens when you don't have cURL installed. It can be fixed by running <code>sudo apt-get install php7.2-curl</code> and then <code>sudo systemctl restart php7.2-fpm</code>. If you aren't running PHP 7.2, then change the version number in the packages to accommodate your current configuration.		This happens when you don't have cURL installed. It can be fixed by running <code>sudo apt-get install php7.2-curl</code> and then <code>sudo systemctl restart php7.2-fpm</code>. If you aren't running PHP 7.2, then change the version number in the packages to accommodate your current configuration.

			=== HTTP Error 406 ===
			I'm not sure why this happens, but navigate to <code>/etc/mediawiki/parsoid/lib/config</code> and run <code>sudo vim ParsoidConfig.js</code> and change the following line from true to false:<pre>
			ParsoidConfig.prototype.strictAcceptCheck = false;
			</pre>Alternatively, you can add the following to <code>/etc/mediawiki/parsoid/config.yaml</code> above the line that reads <code>mwApis:</code>:

Tgriego at 16:02, 17 December 2018

2018-12-17T16:02:27Z

← Older revision		Revision as of 16:02, 17 December 2018
Line 36:		Line 36:

	[[File:Pm2 list.png\|left\|frameless\|851x851px]].		[[File:Pm2 list.png\|left\|frameless\|851x851px]].

	.

	.		.

Tgriego at 16:02, 17 December 2018

2018-12-17T16:02:07Z

← Older revision		Revision as of 16:02, 17 December 2018
Line 28:		Line 28:
	"prefix" => "localhost"		"prefix" => "localhost"
	);		);
	</pre>For our wiki's configuration, we replaced localhost with the IP on the <code>eth0</code> interface. This can be checked by running <code>ifconfig eth0</code>. If you're running a private wiki, add this to the bottom of your configuration as well:		</pre>For our wiki's configuration, we replaced localhost with the IP on the <code>eth0</code> interface. This can be checked by running <code>ifconfig eth0</code>. If you're running a private wiki, add this to the bottom of your configuration as well:<pre>
	$wgSessionsInObjectCache = true;		$wgSessionsInObjectCache = true;
			$wgVirtualRestConfig["modules"]["parsoid"]["forwardCookies"] = true;
			</pre>''Note: Please be aware that there are security implications by sending cookie headers to Parsoid over HTTP.''
	==PM2==		==PM2==
	In order to run the developer setup of Parsoid headless and in the background, you'll want to use [https://www.npmjs.com/package/pm2 PM2]. You can install it by running <code>sudo npm install pm2 -g</code>. npm (node package manager) should come pre-installed with node.js and is used to install packages for node.js. Once you've installed PM2, navigate to <code>/etc/mediawiki/parsoid</code> and run the command <code>sudo pm2 start npm -- start</code>. This should start an instance of Parsoid in the background, and you can check if it's there by running <code>sudo pm2 list</code>.		In order to run the developer setup of Parsoid headless and in the background, you'll want to use [https://www.npmjs.com/package/pm2 PM2]. You can install it by running <code>sudo npm install pm2 -g</code>. npm (node package manager) should come pre-installed with node.js and is used to install packages for node.js. Once you've installed PM2, navigate to <code>/etc/mediawiki/parsoid</code> and run the command <code>sudo pm2 start npm -- start</code>. This should start an instance of Parsoid in the background, and you can check if it's there by running <code>sudo pm2 list</code>.

Tgriego at 15:59, 17 December 2018

2018-12-17T15:59:41Z

← Older revision		Revision as of 15:59, 17 December 2018
Line 17:		Line 17:
	# It defaults to the hostname portion of the `uri` property below, but you can manually set it to an arbitrary string.		# It defaults to the hostname portion of the `uri` property below, but you can manually set it to an arbitrary string.
	domain: 'localhost' # optional		domain: 'localhost' # optional
	</pre>		</pre>Modify the value of the uri to properly point to your wiki's API file, and then the domain to match the domain. Make sure that the uri and domain match, so for instance if you use <code>localhost</code> in the uri, make sure that you use it in the domain as well. Next, you'll want to configure <code>LocalSettings.php</code> for MediaWiki. Navigate to your wiki's root directory and then run <code>sudo vim LocalSettings.php</code>. At the bottom, add the following:<pre>
			wfLoadExtension("VisualEditor");

			$wgDefaultUserOptions["visualeditor-enable"] = 1;
			$wgHiddenPrefs[] = "visualeditor-enable";

			$wgVirtualRestConfig["modules"]["parsoid"] = array(
			"url" => "http://localhost:8000",
			"domain" => "localhost",
			"prefix" => "localhost"
			);
			</pre>For our wiki's configuration, we replaced localhost with the IP on the <code>eth0</code> interface. This can be checked by running <code>ifconfig eth0</code>. If you're running a private wiki, add this to the bottom of your configuration as well:
			$wgSessionsInObjectCache = true;

	==PM2==		==PM2==
	In order to run the developer setup of Parsoid headless and in the background, you'll want to use [https://www.npmjs.com/package/pm2 PM2]. You can install it by running <code>sudo npm install pm2 -g</code>. npm (node package manager) should come pre-installed with node.js and is used to install packages for node.js. Once you've installed PM2, navigate to <code>/etc/mediawiki/parsoid</code> and run the command <code>sudo pm2 start npm -- start</code>. This should start an instance of Parsoid in the background, and you can check if it's there by running <code>sudo pm2 list</code>.		In order to run the developer setup of Parsoid headless and in the background, you'll want to use [https://www.npmjs.com/package/pm2 PM2]. You can install it by running <code>sudo npm install pm2 -g</code>. npm (node package manager) should come pre-installed with node.js and is used to install packages for node.js. Once you've installed PM2, navigate to <code>/etc/mediawiki/parsoid</code> and run the command <code>sudo pm2 start npm -- start</code>. This should start an instance of Parsoid in the background, and you can check if it's there by running <code>sudo pm2 list</code>.

	[[File:Pm2 list.png\|left\|frameless\|851x851px]]		[[File:Pm2 list.png\|left\|frameless\|851x851px]].

			.

			.

			.

			.

			.

	==Troubleshooting==		==Troubleshooting==
	Parsoid can be a pain if it isn't working, so here are a few things that you can try if Parsoid is throwing some errors:		Parsoid can be a pain if it isn't working, so here are a few things that you can try if Parsoid is throwing some errors:

	=== HTTP Error 500 ===		===HTTP Error 500===
	This happens when you don't have cURL installed. It can be fixed by running <code>sudo apt-get install php7.2-curl</code> and then <code>sudo systemctl restart php7.2-fpm</code>. If you aren't running PHP 7.2, then change the version number in the packages to accommodate your current configuration.		This happens when you don't have cURL installed. It can be fixed by running <code>sudo apt-get install php7.2-curl</code> and then <code>sudo systemctl restart php7.2-fpm</code>. If you aren't running PHP 7.2, then change the version number in the packages to accommodate your current configuration.