Peter M. Groen / knowledgetree

Commit 36cdb3c707e8a0284dced343f23fc8289c0387b5

Authored by nbm
1 parent dee17b19

Describe the new upgrade processes: 

. Note the bin/upgrade/upgrade-to-*.php files for manual upgrade.
. Detail the new automated upgrade procedure, both command line and
  web-based.


git-svn-id: https://kt-dms.svn.sourceforge.net/svnroot/kt-dms/trunk@3364 c91229c3-7414-0410-bfa2-8a42b809f60b
Inline Side-by-side
Showing 1 changed file with 60 additions and 2 deletions
docs/UPGRADE.txt
  View file @36cdb3c
1 1 KnowledgeTree Upgrade instructions
2 2 ==================================
3 3  
4   -Basic upgrade
5   --------------
  4 +Before you upgrade
  5 +------------------
  6 +
  7 +Before you upgrade, ensure that your data (KnowledgeTree, Documents, and
  8 +database) is backed up safely. An upgrade may fail to accurately change
  9 +the data to the format required by the next version of KnowledgeTree,
  10 +and a backup will allow you to return to the original version of
  11 +KnowledgeTree. Please report failed upgrades to the KnowledgeTree
  12 +developers.
  13 +
  14 +Automated upgrade
  15 +-----------------
  16 +
  17 +The automated upgrade may be used from the command line or through a web
  18 +page. The web page is preferable, as it provides better error
  19 +reporting. The automated upgrade works between any version of
  20 +KnowledgeTree to the current version. The automated upgrade remembers
  21 +which upgrades it has performed, and will not perform them again, unless
  22 +forced to do so. Using the automated upgrade will create an upgrade
  23 +history that can be reviewed via the KnowledgeTree administrators
  24 +interface.
  25 +
  26 +Command line:
  27 +
  28 +- Run bin/automated-upgrade.php
  29 +- Any errors will be reported.
  30 +
  31 +Web page:
  32 +
  33 +- If your KnowledgeTree installation is at http://example.org/kt/,
  34 + visit:
  35 +
  36 + http://example.org/kt/setup/upgrade.php
  37 +
  38 +- Review the upgrades available to you, and select the button to perform
  39 + the upgrade.
  40 +
  41 +- Review the results of the upgrade.
  42 +
  43 +Manual upgrade
  44 +--------------
6 45  
7 46 In order to upgrade your KnowledgeTree installation, perform the following tasks:
8 47 - Run the appropriate database upgrade scripts against your database. If you are upgrading more than one version, multiple
... ... @@ -15,8 +54,27 @@ In order to upgrade your KnowledgeTree installation, perform the following tasks
15 54 It may be that there are no changes to the database format between
16 55 versions, and no upgrade script will be available.
17 56  
  57 + From version 2.0.6, there may be multiple upgrade scripts for a
  58 + version, contained in a subdirectory with the version name.
  59 +
  60 + For example, these are the scripts necessary to upgrade to 2.0.6:
  61 +
  62 + - sql/mysql/upgrade/2.0.6/add_email_attachment_transaction_type.sql
  63 + - sql/mysql/upgrade/2.0.6/create_upgrade_table.sql
  64 + - sql/mysql/upgrade/2.0.6/1-update_database_version.sql
  65 +
18 66 - Upgrade your application code, by unpacking the latest download into your webroot directory.
19 67  
  68 +- Run any applicable upgrade scripts in the bin/upgrade directory.
  69 + eg. If you are upgrading from version 2.0.5 to version 2.0.6, you
  70 + should run:
  71 +
  72 + - bin/upgrade/upgrade-to-2.0.6.php
  73 +
  74 + Note: You will need to run each intermediate version's upgrade scripts
  75 + manually. In other words, from 2.0.5 to 2.0.7, you will need to
  76 + run both upgrade-to-2.0.6.php and upgrade-to-2.0.7.php.
  77 +
20 78 - Copy over the changes you made to the configuration to the configuration
21 79 file.
22 80  
... ...