DevOps:Doc/PageSync/1.5/Installing PageSync

Installation

Grab in instance from https://github.com/Open-CSP/PageSync.

Create a "PageSync" folder in your Wiki extensions folder and extract the files there.

Setup

PageSync needs a full path to a directory to store the files that can be synced. e.g. $IP/wspsFiles

This can be set in the localsettings as :

$wgPageSync['filePath'] =  $IP . '/wspsFiles';

PageSync also needs a temporary file path to a directory to handle received Share file.

$wgPageSync['tempFilePath'] =  $IP . '/wspsTemp';

Make sure the folders have the correct rights for PageSync to store files.

It is also a good practice to store these files outside of your html folder. The content of pages are stored as raw wikitext and although you can store synced files in sub folders hidden within the root, they are potentially visible.

Files from the File namespace will also be synced.

You can define what slots you want to sync. Default value is all. If you change this value, make sure to add "main" for the main content-slot.

$wgPageSync['contentSlotsToBeSynced'] = "all";

or

$wgPageSync['contentSlotsToBeSynced'] = ['main', 'my-content-slot'];

Finally

Add the following line at the end of your LocalSettings.php, or at least after the above configuration setting, to enable the extension :

wfLoadExtension( 'PageSync' );

Navigate to Special:Version on your wiki to verify that the extension is successfully installed.

If you have the extension AdminLinks installed, you can find a link to PageSync there.