(:Summary:How to upgrade an existing PmWiki installation:) [[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. %block bgcolor=#f7f7f7 color=black border='1px solid black' padding=5px% '''Note for PmWiki 1.0 sites:''' Upgrading from 1.0.x to 2.0 requires more than simply copying the 2.0 software over the 1.0 installation. See [[PmWiki:Upgrading From PmWiki 1]] for more details. !! To upgrade PmWiki: !!! 1. Read the release notes If you're upgrading to a new major release (a release where the second number changes, as in going from 0.5.27 to 0.6.0), then carefully read the [[(PmWiki:)ReleaseNotes]] before performing an upgrade to see if there are any significant changes or preparation tasks that must be handled before performing the upgrade. Upgrading from a beta version of 2.0 is quite easy, but taking a look at the 2.0 [[(PmWiki:)ReleaseNotes]] doesn't hurt. !!! 2. Backup It's ''always'' a good idea to have a [[(PmWiki:)backup (And Restore)]] 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 [[(PmWiki:)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: ->@@cp -a pmwiki-x.y.z/. pmwiki@@ 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''. On (some) [=FreeBSD=] servers and Mac OS X systems you need to use ->@@cp -Rpv pmwiki-x.y.z/. pmwiki@@ !!! 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. >>faq<< [[#faq]] Q: How can I determine what version of PmWiki I'm running now? A: See [[version]] - {Version$:Summary}. Q: How can I test a new version of PmWiki on my wiki without changing the prior version used by visitors? A: The easy way to do this is to install the new version in a separate directory, and for the new version set (in local/config.php): [@ $WikiLibDirs = array(&$WikiDir, new PageStore('/path/to/existing/wiki.d/{$FullName}'), new PageStore('wikilib.d/{$FullName}')); @] This lets you test the new version using existing page content without impacting the existing site or risking modification of the pages. (Of course, any recipes or local customizations have to be installed in the new version as well.) Then, once you're comfortable that the new version seems to work as well as the old, it's safe to upgrade the old version (and one knows of any configuration or page changes that need to be made).