====== upgrade Plugin ======

---- plugin ----
description: Update your DokuWiki with a few clicks from the admin interface
author     : Andreas Gohr 
email      : andi@splitbrain.org
type       : admin, cli, helper
lastupdate : 2024-02-06
compatible : adora belle, weatherwax, binky, Ponder Stibbons, Hrun, detritus, Elenor of Tsort, Greebo, Hogfather,Igor, Jack Jackrum, Kaos
depends    : 
conflicts  : 
similar    : 
tags       : update, upgrade

downloadurl: https://github.com/splitbrain/dokuwiki-plugin-upgrade/zipball/master
bugtracker : https://github.com/splitbrain/dokuwiki-plugin-upgrade/issues
sourcerepo : https://github.com/splitbrain/dokuwiki-plugin-upgrade/
donationurl: https://donate.dokuwiki.org/upgrade

screenshot_img : :plugin:upgrade.png
----

===== Download and Installation =====

Search and install the plugin using the [[plugin:extension|Extension Manager]]. Refer to [[:Plugins]] on how to install plugins manually.

==== Changes ====

{{rss>https://github.com/splitbrain/dokuwiki-plugin-upgrade/commits/master.atom date}}

===== Usage =====

This plugin adds a new option to your admin interface called "Wiki Upgrade". Follow the wizard and upgrade your wiki to the most current stable release of DokuWiki in just a few steps.

Note: this plugin needs write access to all your DokuWiki files, not only files inside data. If you installed DokuWiki through the [[install:downloader|DokuWiki Downloader]], permissions should be fine already. Don't worry though, the plugin will check for needed permissions before doing the real upgrade process.

:!: Creating a backup (see [[faq:backup|FAQ - Backup]]) of your wiki before upgrading is highly recommended. It's NOT done by the plugin. :!:

===== Command Line =====

The plugin can also be used from the command line. There are two ways to do so:

  - Modern wikis (post-Greebo) support command line plugins which can be called through the ''bin/plugin.php'' script. This is the preferred method of using the upgrade plugin. This ensures a properly initialized DokuWiki environment when upgrading.
  - Older wikis (tested back to a release from 2006) can be upgraded by calling ''lib/plugins/upgrade/legacy.php''. This is particularly useful when the old wiki is no longer running with a modern PHP version. The legacy script does not load any existing (outdated) DokuWiki code, but will make more assumptions on your setup. Read the comments at the top of the script for more info.

Below both methods are shown. Prefer the first when possible.

==== Usage ====

To check permissions and versions, without actually updating run:

  - ''php bin/plugin.php upgrade check''
  - ''php lib/plugins/upgrade/legacy.php check''

To run the upgrade:

  - ''php bin/plugin.php upgrade run''
  - ''php lib/plugins/upgrade/legacy.php run''


Check the help screen for any addtional options:

  - ''php bin/plugin.php upgrade -h''
  - ''php lib/plugins/upgrade/legacy.php -h''


===== Q & A =====

=== Usable on systems without internet access? ===

The plugin downloads new releases directly from the github.com repository. Therefore it needs direct access to the internet.

=== Any PHP requirements? ===

Make sure that PHP was compiled with [[http://www.php.net/manual/en/openssl.installation.php|php_openssl]] enabled. Your PHP version will also need to be new enough for the new DokuWiki version to be installed (the plugin will check that for you).

=== I moved some folders out of the Webroot, is that a problem? ===

The upgrade plugin does currently not support installations where the ''conf'' directory was moved from the default location.

If you moved the ''data'' directory, the plugin will recreate a ''data'' directory at the default location. That directory can be safely deleted afterwards. You may need to create any new subfolder inside //your// ''data'' directory manually after the upgrade.

=== Upgrade to Weatherwax ===

Upgrade to Weatherwax using this plugin is only recommended when you're using the plain auth mechanism. Other authbackends probably need some manual config tuning.

=== Languages ===

The plugin will install the new version with **all** languages included. Even if you originally downloaded DokuWiki with a limited set of languages. You can use the [[plugin:langdelete]] plugin to clean up afterwards.