Differences

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

--- plugin:upgrade [2018-04-25 23:12] – version upped andi
+++ plugin:upgrade [2024-02-07 11:00] (current) – ULTRACOMFY
@@ Line 5: / Line 5: @@
 author     : Andreas Gohr
 email      : andi@splitbrain.org
-type       : admin
+type       : admin, cli, helper
-lastupdate : 2018-04-25
+lastupdate : 2024-02-06
-compatible : adora belle, weatherwax, binky, Ponder Stibbons, Hrun, detritus, Elenor of Tsort
+compatible : adora belle, weatherwax, binky, Ponder Stibbons, Hrun, detritus, Elenor of Tsort, Greebo, Hogfather,Igor, Jack Jackrum, Kaos
 depends    :
 conflicts  :
 similar    :
-tags       : update
+tags       : update, upgrade
 downloadurl: https://github.com/splitbrain/dokuwiki-plugin-upgrade/zipball/master
@@ Line 23: / Line 23: @@
 ===== 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 ====
@@ Line 34: / Line 34: @@
 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. :!:
+===== 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 =====
@@ Line 47: / Line 73: @@
 === 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 be new enough for the new DokuWiki version to be installed (the plugin will check that for you).
+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? ===