Upgrade Setup Wizard Guide

From KnowledgeTree Document Management Made Simple

Important Note

The KnowledgeTree Upgrade Setup Wizard migrates your 3.6.1 KnowledgeTree installation to the new KnowledgeTree Stack and upgrades your system to version 3.7. Note that in order to avoid any issues the migration process does not move the KnowledgeTree Documents directory. This directory remains in its original location (Windows default: c:\Program Files\ktmds\Documents Linux default: /opt/ktdms/Documents). Please ensure that you do not delete this directory after the upgrade.

Linux users

The KnowledgeTree Documents directory in KnowledgeTree 3.6.1 is owned by the nobody user by default. In the new KnowledgeTree 3.7 Stack Apache is run by the www-data user. To ensure that Apache is able to read the Documents directory you must change ownership of the directory to the www-data user. Click here for more information.

Run Setup Wizard

To launch the KnowledgeTree Setup Wizard, open your browser and navigate to http://127.0.0.1/knowledgetree.

Note: This address is case sensitive on Linux installs (the apache configuration file defines this alias:  Alias /knowledgetree /usr/share/knowledgetree-ce)

1) On Welcome to the KnowledgeTree Setup Wizard, click Next to view the license agreement. Click I Agree to accept KnowledgeTree's license terms to continue.

2) The Setup Wizard Installation Type page displays. Select Upgrade KnowledgeTree Stack Install.

3) On Current Installation, enter the path to the KnowledgeTree 3.6.1 installation you wish to upgrade; then, click Next.

4) Review your current installation settings. To select a different installation, click Back. To continue, click Confirm.

5) On the Database Export step, the Setup Wizard prompts you to stop the new KnowledgeTree MySQL server and start the old KnowledgeTree 3.6.1 MySQL server. This is in preparation for the migration of your database to the new KnowledgeTree 3.7 Stack.

Click here for instructions on how to stop and start your MySQL services.

When you're ready to continue, click Next to start the Database Migration step.

NOTE: If you need to back up your database, you should do so now. Backing up is optional, but strongly recommended.

6) On Deactivate Services step, the Setup Wizard now prompts you to stop the old KnowledgeTree 3.6. This is in preparation for the upgrade to KnowledgeTree 3.7.

Click here for instructions on how to stop and start your MySQL services.

When you're ready to continue, click Next.

7) When the migration is complete, the Setup Wizard displays the location of your exported 3.6.1 database. Before continuing on to the upgrade process, you must now restart the new KnowledgeTree MySQL service.

Click here for instructions on how to stop and start your MySQL services.

When you're ready to continue, click 'Next' to proceed to the database upgrade.

8) On PHP Dependencies, view the result of the system scan. For information about your PHP version, PHP extensions, and PHP configuration, click the Show Details link beneath each of these components. When you're ready to continue, click Next to review your configuration settings.

9) On System Configuration, review your current configuration settings - for your server, paths, and permissions. If you need to modify any settings, click Edit. Make the changes you require; then, when you're done, click Confirm.

Note: You may receive an error message indicating that your 'Documents' directory is not writable. Please read the following wiki article for assistance in resolving this issue - Known Issue: KnowledgeTree Documents directory not writable on Linux

10) The Checking Service Dependencies step will attempt to resolve any service dependencies on your environment. Click Next, when you are ready to continue.

11) On Confirming Database Configuration, define a database name, and enter a database username and password. Click Advanced Options for more configuration settings.

Linux users: You will have been prompted to set this password during the initial installation process.

Windows users: The default password is blank. A secure password may be set at a later stage.

When you're done, click Next to register for product updates.

12) Confirm that your database settings are correct. Click Edit to modify them or Click Confirm to continue.

13) On Finalizing System Installation, click Install to start the Database Upgrade Wizard.

14) Enter your administrator username and password. This is the password set in your original KnowledgeTree 3.6.1 (or previous) installation.

15) On Current Installation, choose whether to backup now, or go straight to the upgrade:

Backing up now? Click Backup Now. Confirm the backup. Your database is backed up. Click Upgrade.

Note: Restoring your Database - If you run into problems with the backup, you can use the Restore button on the Setup 
Wizard interface to restore your original database.

Skipping the backup? Click Upgrade.

16) Preview your upgrade - you will be presented with a list of available upgrades, and an indication whether any have already been applied. Click Next to continue.

17) Confirm this upgrade. If you have not backed up, you will be reminded to do so now. Click Next to apply the upgrades.

18) View upgrade result:

If upgrade fails - Setup provides information about which upgrade script failed. You can restore your database, backup, then try again. If problems persist, please contact KnowledgeTree support.