Upgrading KnowledgeTree

From KnowledgeTree Document Management Made Simple

Jump to: navigation, search

For the latest information on Upgrading your KnowledgeTree installation, see the KnowledgeTree Installation Guide

1 Preparing for the Upgrade
2 Additional steps
3 Additional links
4 Article source

[edit]

Preparing for the Upgrade

Before you upgrade, please ensure that your data (KnowledgeTree, Documents, and database) is backed up safely. An upgrade may fail to accurately change the data to the format required by the next version of KnowledgeTree, and a backup will allow you to return to the original version of KnowledgeTree. Please report failed upgrades to the [KnowledgeTree developers].

Ensure that the web user may write to all the folders within the 'var' folder, so that logging and other changes are possible.

Make sure you read the Additional steps section towards the end of the document to ensure that any specific steps for your upgrade are performed before you continue.

[edit]

Running Automated Upgrade

The automated upgrade may be used from the command line or through a web page. The web page is preferable, as it provides better error reporting. The automated upgrade works between any version of KnowledgeTree to the current version. The automated upgrade remembers which upgrades it has performed, and will not perform them again, unless forced to do so. Using the automated upgrade will create an upgrade history that can be reviewed via the KnowledgeTree administrators interface.

If you are upgrading KnowledgeTree from versions prior to 3.0.0, see the Additional steps section to set up automated upgrades.

[edit]

... via URL

Download the latest source code and extract.
Upload and overwrite your existing KT code.
If your KnowledgeTree installation is at http://example.org/kt/, visit: http://example.org/kt/setup/upgrade.php. This will let you upgrade the database.
Review the upgrades available to you, and select the button to perform the upgrade.
Review the results of the upgrade.
After the scripts informs you that all upgrades have been applied, the upgrade process is complete.

Note: Depending on your system, the upgrade may take some time.

[edit]

... via command line

Run bin/automated-upgrade.php
Any errors will be reported.

[edit]

Additional steps

[edit]

... for KnowledgeTree 2.0.6

The automated upgrade requires that you set up a database administrator user (name configurable in config/environment.php, defaults to 'dmsadmin') for the upgrade process to function. You need to run this command on your database (say, 'dms') from the MySQL command prompt:

mysql> use dms; mysql> GRANT ALL PRIVILEGES ON * TO dmsadmin@localhost IDENTIFIED BY 'js9281djw';

In config/environment.php, you should add:

$default->dbAdminUser = "dmsadmin";

$default->dbAdminPass = "js9281djw";

Also edit config/config.ini and set the MySQL variables straight (server, user, password, databasename).

You should now be able to use the automated upgrade, but keep your fingers crossed.

[edit]

... for KnowledgeTree 3.0.0

KnowledgeTree 3.0 includes the move of the default document storage location from "Documents" in the root of the KnowledgeTree install to "var/Documents". The "log" directory has also moved to "var/log".

If you are using the default document storage location (ie, you have not specifically set another document location), move the Documents directory to "var/Documents before upgrading.

[edit]

... if you've changed the config.ini paths for the var directory

You'll need to complete the upgrade then move any new subdirectories or files from the $fileSystemRoot/var directory to the appropriate place then edit the changes you made to the config.ini back in to the new one.

[edit]