Upgrading to latest Source Only, Community Edition

Contents  Previous  Next

Upgrading KnowledgeTree > Upgrading to latest Source Only, Community Edition


This procedure manually upgrades your Source Only, manually installed, KnowledgeTree Community edition installation to the latest version of KnowledgeTree Community edition, using the Source Only package, on generic Windows systems, and on Unix-like operating systems.

 

Note: KnowledgeTree Source Only packages contain the KnowledgeTree application and installation instructions. You will need to be familiar with installing and configuring all required components.

 

Warning!

This is an unsupported upgrade. We recommend that you use the KnowledgeTree Community edition stack installer. The Community edition stack installer installs PHP, MySQL, and Apache, and includes the external applications required for running KnowledgeTree Community edition.

 

Pre-requisites:

Ensure that your environment meets the Open Source Platform Requirements for the source only installation.

 

 

Perform the following steps:

1.Ensure that you have the correct version of PHP, MySQL and Apache installed and configured for the latest version of KnowledgeTree.

 

2.Back up your existing KnowledgeTree Source Only database to a file, e.g. dump.sql.

 

3.Download the latest Source Only Package for Windows / Linux at the KnowledgeTree website.

Note: The source package is independent of the operating system.

 

4.Create the environment for installing KnowledgeTree Open Source:
4.1.Move the KnowledgeTree folder to the directory where it is going to be served from:

$ mv knowledgeTree /path/to/your/html/directory/

 

4.2.Configure your Web server to access KnowledgeTree Document Management System.

 

4.3.Run the pre-checkup script: If your KnowledgeTree installation is at http://localhost/, go to http://localhost/setup/

Note: Review your configuration if the pre-checkup script fails.

 

4.4.Set up the database - see the steps below and follow the instructions for your environment:

Unix

Step 1: Create a database

$ mysqladmin -p create dms

 

Step 2: Create and populate the tables

$ mysql -p dms < sql/mysql/install/structure.sql

$ mysql -p dms < sql/mysql/install/data.sql

 

Step 3: Create the database users

Note: The database users and passwords must match the ones in the config.ini

$ mysql -p dms < sql/mysql/install/user.sql

 

 

Windows

Note: Locate the MySQL applications on your system; then, use the path to these

applications in the commands below.

Step 1: Create a database

x:\> mysqladmin -u root -p create dms

 

Step 2: Create and populate the tables

X:\> mysql -u root -p dms < sql/mysql/install/structure.sql

X:\> mysql -u root -p dms < sql/mysql/install/data.sql

 

Step 3: Create the database users

Note: The database users and passwords must match the ones in the config.ini

$ mysql -u root -p dms < sql/mysql/install/user.sql

 

4.5.Configure your installation in the KnowledgeTree config.ini file:
The default configuration automatically determines many settings on your installation; since this is the preferred method of running KnowledgeTree, please don't adjust these settings unnecessarily.

 

After completing your initial evaluation, we recommend that you modify your configuration, including default database connection settings, to comply with security best practises for your platform.

 

The default configuration uses default settings for the database location, username and password. These are defined in the user.sql file mentioned above. Provided that you have followed the examples above for setting up the database, KnowledgeTree should be fully configured to work.

 

The following settings in config/environment.php control the database connectivity.

Default settings are:

[db]

dbHost           = localhost

dbName           = dms

dbUser           = dms

dbPass           = dmspassword

dbPort                  = default

dbAdminUser          = dmsadmin

dbAdminPass          = admin

 

5.Verify file access permissions on the KnowledgeTree folders.
Your Web server MUST be able to write to the ‘var’ folder in the root of the KnowledgeTree installation.
The installation setup script (see above) will display the user (Unix user account) that must be able to write to these folders.

 

Note: The installation setup script will not show the account name for

Windows users because there is no commonly available way to do this.

The user needs to know what the account name is.

 

Your Web server should preferably not be able to write to the remaining folders – e.g. if your Web server is running as user ‘nobody’ and group ‘nogroup’, then change to the KnowledgeTree directory and type:

 

Unix: ’chown -R nobody.nogroup var'

Windows:  Check the folder’s Permissions and Security tabs (Right click on the

folder; then, select Properties.)

 

6.Review the post-installation check list. If your KnowledgeTree installation is at http://localhost/; then, go to http://localhost/setup/ and click Post-installation checkup.

Note: Checkup alerts you to errors. Review the steps above to fix any errors.

 

7.Log in to KnowledgeTree's Web interface. To do this, use your Web browser to navigate to your KnowledgeTree installation; then, on the Login page, enter your KnowledgeTree username and your KnowledgeTree password. Click OK to log in.

Note: A default Admin user – username admin and password admin – is set up during

installation. The default admin user login allows initial access to KnowledgeTree.

This initial login has no relation to the two MySQL accounts created at installation.

 

8.Install the following external applications to enable file indexing.

Note: KnowledgeTree’s file indexing and other features require the use of external

programs. We recommend that you use the package and configuration management

facilities of your operating environment to install these applications – for example,

using the rpm or apt-get tools on Linux systems. Indexing is automatically installed

when you install KnowledgeTree Community Edition using the Community Edition

Stack Installer. You can download the Community Edition Stack Installer from the

KnowledgeTree website.

 

Unzip – from http://www.info-zip.org/ (for bulk upload)
zip – from http://www.info-zip.org/ (for bulk download)
Open Office – from http://www.openoffice.org (for pdf generation)
Java – from http://www.sun.com (to run the Document Indexer)

 

9.Having installed the required applications, edit the following settings through KnowledgeTree's web interface, in DMS Administration - System Configuration:
In General Settings, edit 'External Binaries' - allow external applications to be found
In Search and Indexing Settings, edit 'OpenOffice' - allow KnowledgeTree to communicate with the OpenOffice server

 

10.Start OpenOffice as a server:

 

10.1.Start OpenOffice as a background task:

Note: For more information on starting OpenOffice as a background task, go to

http://www.openoffice.org.

Unix: E.g.

nohup soffice -headless -invisible -accept='socket,host=localhost,port=8100;urp' &

 

Windows: E.g.

soffice -headless -invisible -accept='socket,host=localhost,port=8100;urp'

(Change the port as required and ensure that it corresponds with the

config.ini setting.)

 

10.2.Are you installing on Unix?
Yes. X Windows might not be installed on some Unix systems. In this case, the xvbf virtual display daemon is required: Xvfb -screen 0 800×600x16 &

Note: Please consult the documentation on Xvbf for more details on usage for your

operating system.

 

No. Go to the next step.

 

11.Schedule the background tasks, such as Indexing:

 

Run /opt/ktdms/knowledgeTree/bin/scheduler.php as a background process:

Unix:  Edit the cron. To do this, add the following:

1 * * * * * /path to php/php -Cq /opt/ktdms/knowledgeTree/bin/scheduler.php

Windows:  Configure the Windows Scheduler to run the script in the

background once a minute.

 

12.Start the Document Indexer:

Unix:

cd /opt/ktdms/knowledgeTree/bin/luceneserver

nohup java -jar ktlucene.jar&

 

Windows:

Start a command prompt: java -jar ktlucene.jar

 

Note: This process will fail if the command prompt does not remain active.

 

Alternative Step: To run the Document Indexer as a background service, use

the JavaService wrapper from http://forge.objectweb.org/projects/javaservice/

 

 


© 2008, 2009 KnowledgeTree Inc. - Document Management Software
This work is licensed under a Creative Commons Attribution 3.0 License.
addThis