m (Charlot moved page DevOps:Doc/PageSync/1.5/Install to Installing PageSync without leaving a redirect) |
(Admin) |
||
| (7 intermediate revisions by 2 users not shown) | |||
| Line 1: | Line 1: | ||
| + | == 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 : | ||
| + | <syntaxhighlight lang="php"> | ||
| + | $wgPageSync['filePath'] = $IP . '/wspsFiles'; | ||
| + | </syntaxhighlight> | ||
| + | |||
| + | '''PageSync''' also needs a temporary file path to a directory to handle received Share file. | ||
| + | <syntaxhighlight lang="php"> | ||
| + | $wgPageSync['tempFilePath'] = $IP . '/wspsTemp'; | ||
| + | </syntaxhighlight> | ||
| + | |||
| + | Make sure the folders have the correct rights for '''PageSync''' to store files. | ||
| + | |||
| + | <small><u>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.</u></small> | ||
| + | |||
| + | 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. | ||
| + | <syntaxhighlight lang="php"> | ||
| + | $wgPageSync['contentSlotsToBeSynced'] = "all"; | ||
| + | </syntaxhighlight> | ||
| + | or | ||
| + | <syntaxhighlight lang="php"> | ||
| + | $wgPageSync['contentSlotsToBeSynced'] = ['main', 'my-content-slot']; | ||
| + | </syntaxhighlight> | ||
| + | |||
| + | ==== Finally ==== | ||
| + | Add the following line at the end of your LocalSettings.php, or at least after the above configuration setting, to enable the extension :<syntaxhighlight lang="php"> | ||
| + | wfLoadExtension( 'PageSync' ); | ||
| + | </syntaxhighlight> | ||
| + | |||
| + | 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. | ||
| ws-base-props | |||
|---|---|---|---|
| Line 1: | Line 1: | ||
{{Base properties | {{Base properties | ||
| − | |Title=PageSync | + | |Title=Installing PageSync |
|Class=Doc | |Class=Doc | ||
}} | }} | ||
| ws-class-props | |||
| Line 1: | Line 1: | ||
| − | + | {{Doc properties | |
| + | |Doc subject=DevOps:Doc/PageSync | ||
| + | |Subject version=1.5 | ||
| + | |Doc parent=DevOps:Doc/PageSync | ||
| + | |Doc sort order=5 | ||
| + | |Doc target group=Administrator | ||
| + | |Doc synopsis=Installing and upgrading PageSync instructions v1.5 | ||
| + | }} | ||
| ws-page-props | |||
| Line 1: | Line 1: | ||
| − | + | ||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
Latest revision as of 09:48, 26 September 2022
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.
