(Admin) |
|||
| (8 intermediate revisions by 3 users not shown) | |||
| Line 1: | Line 1: | ||
| + | == Version 2.0 has a major change in its file management. == | ||
| + | |||
| + | ====== When installing version 2.0 you will have to remove all the PageSync files: '''export.index''' and all the files in the '''export folder'''. Alternatively you could set a new path for the PageSync files ( '''$wgPageSync['filePath']''' = ). ====== | ||
| + | |||
| + | ====== You will then have to add them again to PageSync. ====== | ||
| + | Or try to run the '''maintenance''' script with '''--convert-2-version-2'''. This should convert all your files and keep them in PageSync. '''Make a Backup first!''' | ||
| + | |||
| + | |||
| + | |||
== Installation == | == Installation == | ||
Grab in instance from https://github.com/Open-CSP/PageSync. | Grab in instance from https://github.com/Open-CSP/PageSync. | ||
| Line 12: | Line 21: | ||
</syntaxhighlight> | </syntaxhighlight> | ||
| − | '''PageSync''' also needs a temporary file path to a directory to handle received Share file. | + | '''PageSync''' also needs a temporary file path to a directory to handle received Share file. If not set, it will default to the FlexForm extension Temp folder! |
<syntaxhighlight lang="php"> | <syntaxhighlight lang="php"> | ||
$wgPageSync['tempFilePath'] = $IP . '/wspsTemp'; | $wgPageSync['tempFilePath'] = $IP . '/wspsTemp'; | ||
| ws-class-props | |||
|---|---|---|---|
| Line 1: | Line 1: | ||
| − | + | {{Doc properties | |
| + | |Doc subject=DevOps:Doc/PageSync | ||
| + | |Subject version=2.0,2.1,2.5,2.6 | ||
| + | |Doc parent=DevOps:Doc/PageSync | ||
| + | |Doc sort order=5 | ||
| + | |Doc target group=Administrator | ||
| + | |Doc synopsis=Installing and upgrading PageSync instructions | ||
| + | }} | ||
| ws-page-props | |||
| Line 1: | Line 1: | ||
| − | + | ||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
Latest revision as of 21:22, 3 October 2023
Version 2.0 has a major change in its file management.
When installing version 2.0 you will have to remove all the PageSync files: export.index and all the files in the export folder. Alternatively you could set a new path for the PageSync files ( $wgPageSync['filePath'] = ).
You will then have to add them again to PageSync.
Or try to run the maintenance script with --convert-2-version-2. This should convert all your files and keep them in PageSync. Make a Backup first!
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. If not set, it will default to the FlexForm extension Temp folder!
$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.
