DokuWiki

It's better when it's simple

User Tools

Site Tools


plugin:upgrade

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revisionPrevious revision
Next revision
Previous revision
plugin:upgrade [2015-08-24 13:37] – [upgrade plugin] andiplugin:upgrade [2024-02-07 11:00] (current) ULTRACOMFY
Line 1: Line 1:
-====== upgrade plugin ======+====== upgrade Plugin ======
  
 ---- plugin ---- ---- plugin ----
 description: Update your DokuWiki with a few clicks from the admin interface description: Update your DokuWiki with a few clicks from the admin interface
 author     : Andreas Gohr  author     : Andreas Gohr 
-email      : andi@splitbrain.org  +email      : andi@splitbrain.org 
-type       : admin +type       : admin, cli, helper 
-lastupdate : 2015-08-24 +lastupdate : 2024-02-06 
-compatible : adora belle, weatherwax, binky, Ponder Stibbons, Hrun, detritus+compatible : adora belle, weatherwax, binky, Ponder Stibbons, Hrun, detritus, Elenor of Tsort, Greebo, Hogfather,Igor, Jack Jackrum, Kaos
 depends    :  depends    : 
 conflicts  conflicts 
 similar    :  similar    : 
-tags       : update+tags       : update, upgrade
  
-downloadurl: http://github.com/splitbrain/dokuwiki-plugin-upgrade/zipball/master +downloadurl: https://github.com/splitbrain/dokuwiki-plugin-upgrade/zipball/master 
-bugtracker : http://github.com/splitbrain/dokuwiki-plugin-upgrade/issues +bugtracker : https://github.com/splitbrain/dokuwiki-plugin-upgrade/issues 
-sourcerepo : http://github.com/splitbrain/dokuwiki-plugin-upgrade/ +sourcerepo : https://github.com/splitbrain/dokuwiki-plugin-upgrade/ 
-donationurl: http://donate.dokuwiki.org/upgrade+donationurl: https://donate.dokuwiki.org/upgrade
  
 screenshot_img : :plugin:upgrade.png screenshot_img : :plugin:upgrade.png
Line 23: Line 23:
 ===== Download and Installation ===== ===== Download and Installation =====
  
-Download and install the plugin using the [[plugin:plugin|Plugin Manager]] using the URL given above. Refer to [[:Plugins]] on how to install plugins manually.+Search and install the plugin using the [[plugin:extension|Extension Manager]]. Refer to [[:Plugins]] on how to install plugins manually.
  
 ==== Changes ==== ==== Changes ====
  
 {{rss>https://github.com/splitbrain/dokuwiki-plugin-upgrade/commits/master.atom date}} {{rss>https://github.com/splitbrain/dokuwiki-plugin-upgrade/commits/master.atom date}}
- 
  
 ===== Usage ===== ===== Usage =====
Line 34: Line 33:
 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. 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+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.
- +
-This plugin was only tested in upgrading from "Lemming" upwards. It might work for upgrading older versions as well.+
  
 :!: Creating a backup (see [[faq:backup|FAQ - Backup]]) of your wiki before upgrading is highly recommended. It's NOT done by the plugin. :!: :!: Creating a backup (see [[faq:backup|FAQ - Backup]]) of your wiki before upgrading is highly recommended. It's NOT done by the plugin. :!:
  
-:!: Before running this plugin, always check if a newer version of the plugin is available and upgrade the plugin first. :!:+===== 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 ===== ===== Q & A =====
  
Line 49: Line 73:
 === Any PHP requirements? === === Any PHP requirements? ===
  
-Make sure that PHP was compiled with [[http://www.php.net/manual/en/openssl.installation.php|php_openssl]] enabled.+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? === === I moved some folders out of the Webroot, is that a problem? ===
Line 61: Line 85:
 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. 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.
plugin/upgrade.1440416278.txt.gz · Last modified: 2015-08-24 13:37 by andi

Except where otherwise noted, content on this wiki is licensed under the following license: CC Attribution-Share Alike 4.0 International
CC Attribution-Share Alike 4.0 International Donate Powered by PHP Valid HTML5 Valid CSS Driven by DokuWiki