Upgrades

PmWiki is designed to make it easy to upgrade the PmWiki software without affecting your existing data files or installation. For most upgrades, you simply copy the files in the new release over your existing installation.

Note: this page may have a more recent version, see PmWiki:Upgrades.

Generic instructions

1. Read the release notes

Please read carefully the ReleaseNotes before performing an upgrade, about the changes between your previous version and the new one. See if there are any significant changes or preparation tasks that must be handled before performing the upgrade.

2. Backup

It's always a good idea to have a backup copy of your existing PmWiki installation before starting. You can copy the entire directory containing your existing installation, or you can just make copies of the wiki.d/ directory and any other local customization files you may have created (e.g., config.php, localmap.txt, etc.).

3. Download and extract

Download the version of PmWiki that you want from the download page.

Extract the tar image using tar -xvzf tgzfile, where tgzfile is the tar file you downloaded above. This will create a pmwiki-x.y.z directory with the new version of the software.

4. Copy

Copy the files in pmwiki-x.y.z over the files of your existing PmWiki installation. For example, if your existing PmWiki installation is in a directory called pmwiki, then one way to copy the new files over the existing ones is to enter the command:

Note that BSD systems will not have the -a option as a command-line argument for cp, but that's okay, since it's just shorthand for cp -dpR, so use that instead of -a.

Some environments have an alias established for cp that enable interactive prompts before overwriting a file. To work around this specify the absolute path to cp, such as /bin/cp.

On (some) FreeBSD servers and Mac OS X systems you need to use

Alternatively, you can use rsync:

This will perform a trial run with no changes made but will show which files would be updated. To perform the actual update, remove the --dry-run option.

5. Update customisations and recipes

That's it! Your base PmWiki installation is complete.

Now use the PmWiki:Site Analyzer to determine which recipes could be updated to the most recent version.

Unless you have made customizations to the pmwiki.php script or to the files in scripts/, your PmWiki installation should continue to run correctly! (Changes to these files are not recommended).

(Local customizations should go in local/config.php, pub/css, and pub/skins/yourskinname)

Note: Additional tips can be found on the PmWiki:Troubleshooting page.

Upgrading from version 2.1.27 to 2.2.0

Between the stable versions 2.1.27 and 2.2.0 there are a number of additions. Some of them may need changes to local config files or to wiki pages, and they are outlined here. For the full list of changes see the release notes.

If you are upgrading from a 2.2.beta version, your wiki may already include these features.

• Some pages that were formerly in the Site.* group are now in a separate read-protected SiteAdmin.* group: Site.AuthUser, Site.AuthList, Site.NotifyList, Site.Blocklist, and Site.ApprovedUrls. If upgrading from an earlier version, PmWiki will prompt to automatically copy these pages to their new location if needed. If a site wishes to continue using the old Site.* group for these pages, simply set to config.php $SiteAdminGroup = $SiteGroup;
• To authorize reading or editing in protected areas, the former password "nopass" should now be written as "@nopass".
• WikiWords are now disabled by default. To re-enable them, set either $LinkWikiWords or $EnableWikiWords to 1.
• The $ROSPatterns variable has changed -- replacement strings are no longer passed through FmtPageName() i.e., it must now be done explicitly.
• Page links inside included pages, sidebars, headers or footers are now treated as relative to the page where they are written, instead of the page where they appear. For example, in Site.SideBar, always set the group in a wikilink like [[Main/HomePage]] or with a page variable [[{*$Group}/HomePage]], because a link [[HomePage]] will point to a page Site.HomePage.
• PageLists
  • Spaces no longer separate wildcard patterns -- use commas.
  • {$PageCount}, {$GroupCount}, {$GroupPageCount} variables used in pagelist templates are now {$$PageCount}, {$$GroupCount}, {$$GroupPageCount}.
  • The directive no longer accepts parameters from urls by default. In order to have it accept such parameters (which was the default in 2.1 and earlier), add a request=1 option to the (:pagelist:) directive.
• Skin templates are now required to have <!--HTMLHeader--> and <!--HTMLFooter--> directives.
• Authentication using Active Directory is now simplified, see PmWiki.AuthUser.

Upgrading from version 2.2.0 to 2.2.145

Note: this page may have a more recent version, see PmWiki:Upgrades.

Some additions since version 2.2.0 may need changes to local config files or to wiki pages, and they are outlined here. For the full list of changes see release notes and change log.

• Version 2.2.10: $EnableRelativePageVars was changed to enabled by default, and it affects PageVariables from included pages, sidebars, headers and footers.
  • The form {*$var} refers to "the currently browsed page" while {$var} without an asterisk refers to "the physical page where the PageVar is written".
  • Pages that are designed to work on "the currently browsed page" should switch to using {*$FullName} instead of {$FullName}. Administrators should especially check any customized versions of Site.PageActions, Site.EditForm, Site.PageNotFound, SideBar pages, $GroupHeaderFmt, $GroupFooterFmt, Page lists in sidebars, headers, and footers. See Special references.
  • If your wiki heavily relies on the previous behavior, you can revert to it, see $EnableRelativePageVars.
• Version 2.2.35: Important change for international wikis: the XLPage() function no longer loads encoding scripts such as xlpage-utf-8.php. When you upgrade, you need to include those scripts from config.php, before the call to XLPage():

    include_once("scripts/xlpage-utf-8.php"); # if your wiki uses UTF-8
    XLPage('bg','PmWikiBg.XLPage');
  

Upgrading from version 2.2.145 to 2.3.0

Note: this page may have a more recent version, see PmWiki:Upgrades.

Version 2.3.0 requires PHP 5.3 or more recent. The new version includes a number of new features, some of which were previously provided by recipes.

Here are the things to review when upgrading:

• If you previously used Cookbook:PageListMultiTargets, please disable it when you upgrade. The same functionality is now available in the core.
• For PHP 8.1, the function strftime() has been deprecated. PmWiki 2.3.0 provides a replacement function PSFT(), see PmWiki:Functions#PSFT.
• The RecentChanges pages now store in the page source the time stamp in a slightly different, and portable international format (easily parsable). When the page is displayed, the new format is automatically converted to the current one ($TimeFmt), so the RecentChanges pages will look exactly like before, but the source code will be slightly different.
  If you have custom $RecentChangesFmt settings, they will be preserved. If you have no custom settings but still prefer the old format, to revert to the old format, add this to config.php:

  # revert to pre-2.3.0 RecentChanges
  $RecentChangesFmt = array(
    '$SiteGroup.AllRecentChanges' => 
      '* [[{$Group}.{$Name}]]  . . . $CurrentTime $[by] $AuthorLink: [=$ChangeSummary=]',
    '$Group.RecentChanges' =>
      '* [[{$Group}/{$Name}]]  . . . $CurrentTime $[by] $AuthorLink: [=$ChangeSummary=]');
  

• The variable $EnableNotSavedWarning is now enabled by default. Add to config.php $EnableNotSavedWarning = 0; to disable it.
• The core table of contents function ($PmTOC) has had its styles updated, in order to properly indent long sub-headings. Notably, the TOC links now have a display:block setting and there are no line breaks between them. If you have previously added custom styles for PmTOC, please review these in case they need updating.

See also Release Notes for any changes between your previous version and the new one.

If you have any questions or difficulties, please let us know.

Upgrading from version 2.3.0 to more recent versions

2.3.15 GUI Edit Buttons change

Part of these functions were rewritten to avoid 'unsafe inline' JavaScript. While default and most custom buttons should work without change, you should no longer need to url-encode some characters like % or add backslashes. If you have such buttons, you may need to update their declarations to strip the extra backslashes. Please contact us if you need assistance.

2.3.23 PmToken

This version adds a session token to core edit, upload, attributes and other forms. This is a way to mitigate CSRF vulnerabilities.

All core forms and elements have been updated and should work without change.

Some installations might encounter the warning "Token invalid or missing" and the changes are not saved. This can be caused by custom edit or upload forms, automated scripts posting to the wiki, AJAX posting text or uploads used by some recipes, or partial upgrades where some core scripts haven't been updated. Most of these should be easy to update -- please check if you're using the latest recipe versions, or report such cases to us.

To update custom forms:

• In a form written in wiki markup, include the element (:input pmtoken:) after the (:input form...:) directive.
• If your script defines the variable $PageUploadFmt, it should now include the element: <input type='hidden' name='\$TokenName' value='\$TokenValue' /> inside the <form...> element.

If you have customized $UnapprovedLinkFmt, you should update it to include the token argument $TokenName=$TokenValue in the link URL, something like href='{\$PageUrl}?action=approvesites&\$TokenName=\$TokenValue'.

If you are unable to update your scripts, you can disable the PmToken functionality with this in config.php:

  $EnablePmToken = 0; # edit, upload, attributes, approveurls
  $PmFormEnablePmToken = 0; # PmForm

If you have recipes or custom functions that make changes to the wiki, and you want to benefit from the built-in PmToken functions, see Functions#pmtoken.

2.3.31 PrintFmt()

The function PrintFmt() was refactored to process markup and wiki pages before outputting HTML headers, which would allow for markup in headers, footers, sidebars included from the skin, and action pages like the Auth form, to configure $HTMLHeaderFmt and $HTMLStylesFmt, and the directives (:noheader:), (:notitle:), (:noleft:), (:noaction:) to work from these pages. In case your wiki relied on the previous behavior, you can revert to it by adding to config.php:

  $EnablePrePrintFmt = 0;

If the new default mode is problematic on your wiki, please do let me know.

FAQ

    $WikiLibDirs = array(&$WikiDir,
      new PageStore('/path/to/existing/wiki.d/{$FullName}'),
      new PageStore('wikilib.d/{$FullName}'));