Note:3: Difference between revisions
No edit summary |
No edit summary |
||
| (15 intermediate revisions by the same user not shown) | |||
| Line 1: | Line 1: | ||
{{Note | {{Note | ||
|title=Installing Visual Editor | |title=Installing Visual Editor and Parsoid | ||
|tags=Visual Editor, Parsoid | |tags=Visual Editor, Parsoid | ||
}} | }} | ||
| Line 8: | Line 8: | ||
* Install Parsoid | * Install Parsoid | ||
** https://www.mediawiki.org/wiki/Parsoid/Setup | ** https://www.mediawiki.org/wiki/Parsoid/Setup | ||
** It appears to be OK to use the jessie repo for stretch. | |||
** Edit /etc/mediawiki/parsoid/config.yaml and restart the Parsoid service. | |||
* Configure Visual Editor | * Configure Visual Editor | ||
** https://www.mediawiki.org/wiki/Extension:VisualEditor#Basic_configuration_for_MediaWiki-VisualEditor | ** https://www.mediawiki.org/wiki/Extension:VisualEditor#Basic_configuration_for_MediaWiki-VisualEditor | ||
==Configuration | ==Minimal Wiki Farm Configuration== | ||
PHP: | |||
<pre> | <pre> | ||
$wgVirtualRestConfig['modules']['parsoid']['domain'] = ' | $wgVirtualRestConfig['modules']['parsoid']['url'] = 'http://localhost:8142'; | ||
$wgVirtualRestConfig['modules']['parsoid']['domain'] = $wgSitename; # wiki name | |||
$wgVirtualRestConfig['modules']['parsoid']['forwardCookies'] = true; # for private wikis | |||
wfLoadExtension( 'VisualEditor' ); | wfLoadExtension( 'VisualEditor' ); | ||
$wgDefaultUserOptions['visualeditor-enable'] = 1; | $wgDefaultUserOptions['visualeditor-enable'] = 1; | ||
$wgHiddenPrefs[] = 'visualeditor-enable'; | $wgHiddenPrefs[] = 'visualeditor-enable'; | ||
</pre> | </pre> | ||
/etc/mediawiki/parsoid/config.yaml: | |||
<pre> | |||
mwApis: | |||
uri: 'http://path/to/my/wiki/api.php' | |||
domain: 'replace with wiki name' | |||
</pre> | |||
==Caveats== | |||
* It is important that the domain used in /etc/mediawiki/parsoid/config.yaml match the one used in $wgVirtualRestConfig. | |||
==Issues== | ==Issues== | ||
* Possible errors at https://www.mediawiki.org/wiki/Manual:$wgVirtualRestConfig: | * Possible errors at https://www.mediawiki.org/wiki/Manual:$wgVirtualRestConfig: | ||
** I believe that the trailing slashes in the URLs is an error, but I need confirmation. | ** I believe that the trailing slashes in the URLs is an error, but I need confirmation. | ||
** When it says, "These are the default values when Parsoid is registered as a REST service, used when some keys are not defined.", it implies that this value is set somewhere when Parsoid is installed, but I don't believe that is the case. | ** When it says, "These are the default values when Parsoid is registered as a REST service, used when some keys are not defined.", it implies that this value is set somewhere when Parsoid is installed, but I don't believe that is the case. | ||
* Adding a wiki to a wiki farm requires editing /etc/mediawiki/parsoid/config.yaml. | * Adding a wiki to a wiki farm requires editing /etc/mediawiki/parsoid/config.yaml and restarting the Parsoid service. | ||
Latest revision as of 08:44, 23 August 2018
| Author | |
|---|---|
| Created | 2 September 2017 22:03:10 |
| Last Modified | 23 August 2018 13:44:50 |
| Tags | Parsoid, Visual Editor |
Instructions
- Download Visual Editor
- Install Parsoid
- https://www.mediawiki.org/wiki/Parsoid/Setup
- It appears to be OK to use the jessie repo for stretch.
- Edit /etc/mediawiki/parsoid/config.yaml and restart the Parsoid service.
- Configure Visual Editor
Minimal Wiki Farm Configuration
PHP:
$wgVirtualRestConfig['modules']['parsoid']['url'] = 'http://localhost:8142'; $wgVirtualRestConfig['modules']['parsoid']['domain'] = $wgSitename; # wiki name $wgVirtualRestConfig['modules']['parsoid']['forwardCookies'] = true; # for private wikis wfLoadExtension( 'VisualEditor' ); $wgDefaultUserOptions['visualeditor-enable'] = 1; $wgHiddenPrefs[] = 'visualeditor-enable';
/etc/mediawiki/parsoid/config.yaml:
mwApis:
uri: 'http://path/to/my/wiki/api.php'
domain: 'replace with wiki name'
Caveats
- It is important that the domain used in /etc/mediawiki/parsoid/config.yaml match the one used in $wgVirtualRestConfig.
Issues
- Possible errors at https://www.mediawiki.org/wiki/Manual:$wgVirtualRestConfig:
- I believe that the trailing slashes in the URLs is an error, but I need confirmation.
- When it says, "These are the default values when Parsoid is registered as a REST service, used when some keys are not defined.", it implies that this value is set somewhere when Parsoid is installed, but I don't believe that is the case.
- Adding a wiki to a wiki farm requires editing /etc/mediawiki/parsoid/config.yaml and restarting the Parsoid service.