You are on page 1of 52

Installation Guide

KnowledgeTree 3.5.x Installation Guide

Copyright 2008 KnowledgeTree Inc. http://www.knowledgetree.com/ This document is subject to change without notice.

License
This work is licensed under a Creative Commons Attribution 3.0 License. http://creativecommons.org

Disclaimer
Documentation is provided "AS IS" and all express or implied conditions, representations, and warranties, including any implied warranty of merchantabilitiy, fitness for a particular purpose or non-infringement, are disclaimed, except to the extent that such disclaimers are held to be legally invalid.

Contents

Table of Contents
0

Welcome to KnowledgeTree
About this Guide Getting Help

................................................................................................................................... 1

................................................................................................................................... 2

KnowledgeTree Editions Licenses

................................................................................................................................... 3

................................................................................................................................... 3

System Requirements
Source Only Requirements

................................................................................................................................... 5

Software Appliance Requirements

................................................................................................................................... 6

Installing KnowledgeTree
Installing KnowledgeTree Commercial Edition
Server - Stack Install
Linux Install Notes

................................................................................................................................... 7

.........................................................................................................................................................

..................................................................................................................................................

11 12

Installing KnowledgeTree Client Tools for Windows


Unattended Installation Silent Install

.........................................................................................................................................................

.................................................................................................................................................. ...........................................................................................................................................

14 15

Installing KnowledgeTree Commercial License Installing KnowledgeTree Community Edition

................................................................................................................................... 15

................................................................................................................................... 16

KnowledgeTree Installation Guide - 14 July 2008

II

KnowledgeTree Installation Guide

Server - Stack Install Source Only Install

.........................................................................................................................................................

16

.........................................................................................................................................................

18

Adding the Scheduler to the *Nix Cron

.................................................................................................................................................. .................................................................................................................................................. ..................................................................................................................................................

22 23 24

Adding the Scheduler to the Windows Task Scheduler Troubleshooting a Source Only Install

Starting KnowledgeTree
Windows Linux

25

................................................................................................................................... 25

................................................................................................................................... 25

Backing up and Restoring


On Linux On Windows

27

................................................................................................................................... 27

................................................................................................................................... 28

Automating Database Backup

................................................................................................................................... 29

Upgrading KnowledgeTree
Migration: Windows to Linux / Linux to Windows Indexing Migrated Content

30

................................................................................................................................... 31

................................................................................................................................... 31

KnowledgeTree Commercial Upgrade Installer

................................................................................................................................... 31

Upgrading Community Edition (Source Only) to Commercial Edition

.........................................................................................................................................................

34

KnowledgeTree Community Edition Upgrade Installer

................................................................................................................................... 35

Upgrading Community Edition (Source Only) to Community Edition (Source Only)

.........................................................................................................................................................

36

KnowledgeTree Installation Guide - 14 July 2008

Contents

III

Uninstalling KnowledgeTree
Linux/Unix Uninstall Windows Uninstall Silent Uninstall

41

................................................................................................................................... 41

................................................................................................................................... 41

................................................................................................................................... 42

Configuring KnowledgeTree Troubleshooting

43 44

KnowledgeTree Installation Guide - 14 July 2008

Welcome to KnowledgeTree
KnowledgeTree is document management made simple - easily share, track, secure, and manage the documents and records your organization depends on. Leveraging an active, open source community, KnowledgeTree provides an easy-to-use, production-ready, enterprise document management solution for use by corporations, government institutions, small to medium businesses, and other types of organizations. KnowledgeTrees open source architecture allows organizations to easily customize and integrate the document management system with their existing infrastructure, providing a more flexible, cost-effective alternative to proprietary applications. To learn more about KnowledgeTree, call +1 415 670-9759, email sales@knowledgetree.com, or visit http://www.knowledgetree.com.

Features in Brief KnowledgeTree provides: A central document repository with audited document content version control Powerful document metadata management and versioning Sophisticated document authoring management and workflows Full-text indexing technology allowing search within document contents Powerful security group and role-based security model and integration with enterprise directory servers For more on KnowledgeTree's features, see the Product Overview on the KnowledgeTree website.

1.1

About this Guide


The KnowledgeTree Installation Guide provides instruction for installing and upgrading KnowledgeTree Document Management System. Please Note: This document is a working draft that is continually updated. It aims to provide a comprehensive guide to installing KnowledgeTree - using the stack installers and manual installs, on generic Windows and Unix-like operating systems. These instructions are intended for use by experienced system administrators. If you have questions that aren't covered in this guide and you think the information should be included here, please post your comments and suggestions by creating a Documentation ticket for the KnowledgeTree project on http://issues.knowledgetree.com.

KnowledgeTree Installation Guide 14 July 2008

Welcome to KnowledgeTree

Important
KnowledgeTree is capable of running on a large number of operating systems, and in many different configuration scenarios. We do not provide instructions for all of the potential implementation environments. If you dont find the installation instruction for your environment in this guide, or if you require further information for a particular upgrade / install, please check the KnowledgeTree Wiki at http://wiki.knowledgetree.com, where you can find a collection of additional installation instructions provided with the help of the KnowledgeTree community.

If you have successfully implemented KnowledgeTree on a platform that is not detailed on the KnowledgeTree Community Wiki, we would welcome your contribution of installation instructions. Please feel free to create a Wiki account for yourself and to post your wisdom!

1.2

Getting Help
KnowledgeTree provides professional support services to subscription customers. Our support service includes priority assistance from the KnowledgeTree support staff and engineers, with guaranteed response times. Click here to find out more about more about KnowledgeTree's Support Services, or contact us for help with choosing the best support package for your needs. Subscription Customers You will receive an email with instructions for logging support requests with your KnowledgeTree license. You can also find out how to log a support request on the KnowledgeTree Wiki. See also Getting Support on the KnowledgeTree Wiki.

Community Edition Community support is available at the KnowledgeTree Community Forums. Post your questions at http://forums.knowledgetree.com/, where our support staff, developers, and a wide number of KnowledgeTree community members, endeavor to answer questions around installing, managing, and using the KnowledgeTree Document Management System.

Documentation
The following documentation is available at http://www.knowledgetree.com/documentation: KnowledgeTree Administrator Manual KnowledgeTree User Guide

KnowledgeTree Installation Guide 14 July 2008

Getting Started with KnowledgeTreeLive KnowledgeTree Client Tools User Guide A Guide to the Integration Interfaces into KnowledgeTree A Guide to the Document Import Interfaces into KnowledgeTree

Don't see what you're looking for?


Try the following: Review the Release Notes for the relevant version Post your questions (and answers) at the KnowledgeTree Community Forum Request new features, or tell us about an error. How do I use KnowledgeTree's Issue Management System? Find more resources on the KnowledgeTree Community Wiki.

1.3

KnowledgeTree Editions
KnowledgeTree is available in three editions: KnowledgeTreeLive - Hosted, Document Management on Demand; a pay per month and per user subscription service requiring no installation or maintenance. KnowledgeTree Community Edition - open source, community supported, free to download, use, modify, and redistribute subject to the terms of the GNU GPL v3. Lacks some commercial features. Available as a click-through, stack installed package, or as a source only install. KnowledgeTree On Premise Editions - On-premise, commercially supported and production-ready document management software application. Stack installed on your own operating system, and includes KnowledgeTree Client Tools for Windows. For more information, see the editions feature matrix and the various deployment options at the KnowledgeTree website. To find out more about KnowledgeTree, call +1 415 692 1418, or email sales@knowledgetree.com.

1.4

Licenses
You will need to purchase and install a KnowledgeTree Commercial License to use KnowledgeTree's Commercial edition. The license key activates the additional document management feature set that is available with KnowledgeTree Commercial, including access to the KnowledgeTree server for KnowledgeTree Client Tools for Windows users. See the Editions Feature Matrix on the KnowledgeTree website to compare

KnowledgeTree Installation Guide 14 July 2008

Welcome to KnowledgeTree KnowledgeTree features across editions.

KnowledgeTree Commercial Edition Trial License To try out KnowledgeTree Commercial with a Trial license for a limited period, we provide a free, trial, download of KnowledgeTree Premium edition. Click here to go to the download page for the KnowledgeTree Premium Trial. The license key is downloaded from the Commercial download area, where it is listed along with the other components that you will need to download and install. Subscriptions KnowledgeTree Sales generates and sends License keys to Commercial customers. You will need to install your license to activate the commercial document management feature sets. Installing Licenses License keys are installed in KnowledgeTree's Web interface (in the DMS Administration module). Renewing Your License License renewal reminders display on the KnowledgeTree system administrator's view of the KnowledgeTree Dashboard 30 days prior to the expiry of the organization's KnowledgeTree Commercial Edition license. What happens if my KnowledgeTree Commercial Editions License Expires? This is what you can expect if your KnowledgeTree On Premise Commercial license expires: commercial plugins are disabled users will not be able to access the repository through KnowledgeTree Client Tools for Windows system functionality reverts to the community edition commercial support and upgrades are discontinued Commercial functionality is restored once you install a new license.

KnowledgeTree Installation Guide 14 July 2008

System Requirements
The latest information around minimum hardware and software requirements for running the KnowledgeTree server and client applications is updated and maintained on the KnowledgeTree website. Click here to go to the page on the KnowledgeTree website.

2.1

Source Only Requirements


The requirements for the Source Only package differ from the stack installed systems. If you are installing KnowledgeTree using the Source Only package, you will need the following: Required Server Software PHP 5.1.6 or above PHP LDAP extension (if LDAP or ActiveDirectory integration is required) PHP Exif extension (if header extraction from JPEG and TIFF files is required) PHP mbstring extension (functions for multi-byte character sets) PHP mysql extension (interface to mysql database from php) PHP json extension (functions for working with json structures) PHP fileinfo extension (functions for resolving mime types of documents) MySQL Server, Client, and PHP libraries, version 5.0.41 or above Apache 2.0 or above pdftotext (required for indexing of pdf files on Microsoft Windows and Linux/UNIX,) pstotext (required for indexing of postscript files on Microsoft Windows) Open Office 2.0 or above (required for indexing of office document types) Info-Zip (required for extracting contents of zip files)

Supported Server Operating Systems Microsoft Windows 2000/2003 Server Linux, FreeBSD Sun Solaris KnowledgeTree should run on any platform capable of hosting the Apache/MySQL/PHP stack described above

Required Client Software A modern web-browser, such as: Firefox 1.0+ Internet Explorer 6.0+
Note: A 'source only' requirements page is hosted and updated on the KnowledgeTree website.

KnowledgeTree Installation Guide 14 July 2008

System Requirements

2.2

Software Appliance Requirements


x86 32 or 64-bit Server or Workstation Hardware Platform XenSource Hypervisor VMWare Server or Workstation Microsoft Virtual Server Parallels Workstation

See the KnowledgeTree Appliance Installation Instructions on the KnowledgeTree Wiki.

KnowledgeTree Installation Guide 14 July 2008

Installing KnowledgeTree
This chapter provides instructions around installing KnowledgeTree for the first time (Commercial Edition or Community Edition). If you are upgrading and existing installation of KnowledgeTree, see Upgrading KnowledgeTree in this Guide.
Note for Windows Users: The cache is disabled by default when installing KnowledgeTree in a Windows environment. If you are installing a fresh installation of KnowledgeTree after uninstalling a previous version, you should restart your computer before running the Stack Installer. For more information, see this topic: Windows Uninstall.

Apache and MySQL in the KnowledgeTree Stack The KnowledgeTree Stack Installers (Commercial and Community Editions) include Apache and MySQL. When installing KnowledgeTree on servers that have existing Apache and MySQL installations you will need to select alternate ports for the installation of Apache and MySQL for the KnowledgeTree server during the stack install. Dual installation of Apache and MySQL should not cause conflicts on your system, provided that you choose different ports when prompted to do so during Setup.

In this section: Installing KnowledgeTree Commercial Edition Installing KnowledgeTree Community Edition - Stack Install / Source Only Package

3.1

Installing KnowledgeTree Commercial Edition


This topic provides a high level walk through of the tasks that must be performed to install KnowledgeTree Commercial.

*IMPORTANT* KnowledgeTree customers are provided with a direct link to the download area via the customer portal. If you are downloading a Trial of Commercial Enterprise, you will need to register to receive this download. An email is sent to you straight after registration. This email contains links to the download area, which provides access to all the KnowledgeTree Commercial components. This is a 3-4 step download process. Download and install all of the following components: KnowledgeTree Client Tools for Windows Trial license / subscription License key KnowledgeTree Commercial Server - stack installer for Windows/Linux The KnowledgeTree Commercial server package is a large file, and may take some

KnowledgeTree Installation Guide 14 July 2008

Installing KnowledgeTree time to download.


Note: Please contact KnowledgeTree Sales if you require any additional information or assistance to complete this installation.

Task Overview 1. Download KnowledgeTree Client Tools for Windows package from the KnowledgeTree website download area; then, install the system on each client machine requiring access to the KnowledgeTree repository through KnowledgeTree Client Tools for Windows. 2. Download the KnowledgeTree Commercial License key from the KnowledgeTree website download area. 3. Download and install the KnowledgeTree Commercial stack installer from the KnowledgeTree website download area. 4. Log in to KnowledgeTree's Web interface.
Note: First time users log in with username 'admin' and password 'admin'. The Install Wizard provides an option to start KnowledgeTree when the installation is complete and in this case KnowledgeTree's Login page opens in your web browser. Alternatively, you can start KnowledgeTree later.

5. Install your License in the DMS Administration module. 6. Configure a connection with the KnowledgeTree server through KnowledgeTree Explorer.
Note: See the KnowledgeTree Administrator Manual for instructions to configure the server connections through KnowledgeTree Client Tools for Windows.

7. Set up KnowledgeTree through the Web interface after completing the installation.

3.1.1

Server - Stack Install


This procedure installs KnowledgeTree Commercial, using the KnowledgeTree Commercial Stack Installer for Windows/Linux.
Note: KnowledgeTree Enterprise is available as a Trial download. The complete download for KnowledgeTree Commercial Edition is a 3-4 step process, which requires that you download and install all KnowledgeTree Commercial components (unless otherwise specified): KnowledgeTree Client Tools for Windows; KnowledgeTree Commercial License Key (Trial or Subscription, as applicable); KnowledgeTree (document management system server, provided through the stack installer for Windows / Linux). This procedure provides instructions for downloading and installing the KnowledgeTree Commercial document management system server on Windows. The procedure differs in a few, minor ways on Linux. If you have any questions or require assistance with the download process, please contact

KnowledgeTree Installation Guide 14 July 2008

KnowledgeTree.

Prerequisites Install only to a supported platform


Note: See the KnowledgeTree website for updated requirements.

Perform the following steps: 1. Are you upgrading on Linux? Yes. Make the install package executable before you start the installation. To do this, open a terminal; then, enter the following commands: $ chmod +x ktdms-[current version]-pro-linux-installer.bin $ ./ktdms-[current version]-pro-linux-installer.bin
Note: Alternative steps: Right click on the Installer / Upgrade Installer package; then, select Properties. Set permissions to Read / Write, select Executable, close Properties dialog. The exact steps vary between Linux distributions; or, Remove the .bin extension from the file name. (Some Linux distributions will not run bin files)

No. Go to step 2 2. Are you installing a Trial edition? Yes. Download KnowledgeTree Commercial Trial from the KnowledgeTree website. Register for the download download at the download area; then, click Submit. An email is sent to the email address you provide on the registration form - this email contains a link to the KnowledgeTree website Commercial download page, where you will find install packages for all KnowledgeTree Commercial components, including the KnowledgeTree Server installer instructions for the KnowledgeTree server installation is explained in this procedure. No. KnowledgeTree customers receive links to the Commercial download from KnowledgeTree Sales via the customer portal or via email. Follow the links you receive to the customer download area. 3. On the download page, select the Installer package you require - Windows or Linux. By default, the file is downloaded to your desktop. 4. Click on the KnowledgeTree installer file to launch Setup; then, click through the KnowledgeTree Commercial Setup Wizard: 4.1.On Welcome ... , click Next to open the License Agreement. Accept the agreement; then, click Next to open the Installation Directory page. 4.2.Choose an installation directory, or accept the default. Click Next to open the Web Server Port page. 4.3.Accept the default port for the Apache Web Server (port 80), or specify a different port; then, click Next to open the SSL support page.
Note: The KnowledgeTree Stack Installers install Apache and MySQL. From KnowledgeTree 3.5, the default port for the Apache installation depends on the security level of the user performing the installation: When users with administrator or root privileges perform the installation, the

KnowledgeTree Installation Guide 14 July 2008

Installing KnowledgeTree
installer selects port 80 as the default port. When users without administrator or root privileges perform the installation, the installer selects port 8080 as the default port. When upgrading to KnowledgeTree 3.5, ensure that the correct port is selected. This is because the installer is unable to determine the port selected in a previous installation, and if port 8080 is selected when port 80 should be used, then the upgrade installer will default to port 80, and not to 8080.

4.4.Do you want to install SSL support?


Note: This is an optional task, which may be configured manually after installing. For more information on manually configuring SSL for your environment, see the KnowledgeTree Administrator Manual.

Yes. Select Yes; then, click Next to define the name of your Web server and the number of days of validity. The installer generates a certificate. Click Next. No. Select No; then, click Next. 4.5.Accept the default port for the MySQL Server (port 3306), or specify a different port; then, click Next to open the MySQL Credentials page.
Note: You will need to define an alternative port if you get a message that the system can't bind to the default ports - 3306 (MySQL); 80 or 8080 (Apache).

4.6. Enter a root password for MySQL Server root password. Repeat the password; then, click Next to open the MySQL User Password page.
Note: Passwords defined during installation are used only to access the MySQL database - these accounts have no relation to the default initial login credentials, which is username 'admin', and password, 'admin'.

4.7.Enter a MySQL User Password - the initial password for the DMS user account created during the MySQL database installation. Re-enter the password; then, click Next to open Ready to install.
Note: Passwords defined during installation are used only to access the MySQL database - these accounts have no relation to the default initial login credentials, which is username 'admin', and password, 'admin'.

4.8.On Ready to install, click Next to start the installation. 4.9.When the install is complete, select one or more of the following options; then, click Finish: View Readme file Open Online Documentation Launch KnowledgeTree DMS now (The web interface login page opens in your browser.)
TIP: I don't want to start KnowledgeTree now - how do I start it later? Windows: Start KnowledgeTree via the Windows Start menu; ensure all services and servers are running Linux: Open a terminal, enter the following commands: cd ktdms/. ; press Enter; then ./ dmsctl.sh start

5.

Depending on the options chosen in the previous step, you can ... view README - click Ok to close view website Welcome page - provides links to resources for getting started log in to KnowledgeTree (first time users use the default administrator

10

KnowledgeTree Installation Guide 14 July 2008

credentials: username 'admin', password 'admin')


Note: The default administrator credentials are provided for initial login to KnowledgeTree - for security purposes, change the defaults at your earliest convenience. Passwords are changed in the Preferences tab.

6.

Download the KnowledgeTree Commercial license from the download page; then install your KnowledgeTree Commercial license.
Note: By default, the license is downloaded to your desktop - add the license in KTIS Administration, located in the DMS Administration tab in KnowledgeTree's web interface. See full instruction in the KnowledgeTree Administrator Manual.

7.

To complete the KnowledgeTree Commercial installation, you should ... read and enable plugins in Manage Plugins in DMS Administration.
Note: See Manage Plugins in the KnowledgeTree Administrator Manual.

download and install other KnowledgeTree Commercial components, if you have not yet done so: KnowledgeTree Client Tools for Windows.
Note: KnowledgeTree Client Tools for Windows must be installed on each client machine requiring access to the to the repository. You will need to configure a connection to the repository. See the KnowledgeTree Administrator Manual.

set up your Document Management System.


Note: For more information about setting up KnowledgeTree, including adding users, see Getting Started in the KnowledgeTree Administrator Manual.

3.1.1.1

Linux Install Notes To add this installation to your system startup scripts, you need to ensure that the dmsCtrl.sh script is linked in to your init.d directory, and that it is placed into the startup and shutdown procedures for runlevel 3.
Note: You must have installed KnowledgeTree using a KnowledgeTree Stack Installer for Linux before performing this procedure. Note: This procedure is applicable for Community Edition and Commercial installations of KnowledgeTree in a Linux environment.

Perform the following steps: 1. Create a symlink in /etc/rc3.d called S45ktdms to dmsctl.sh in your installation directory. 2. Create a symlink in all the other /etc/rcX.d directories called K1ktdms to dmsctl.sh in your installation directory.

11

KnowledgeTree Installation Guide 14 July 2008

Installing KnowledgeTree

3.1.2

Installing KnowledgeTree Client Tools for Windows


This procedure installs KnowledgeTree Client Tools for Windows.
Note: An update of KnowledgeTree Client Tools for Windows is typically released with new versions of the KnowledgeTree Commercial Server package, unless otherwise specified. All KnowledgeTree Commercial components are available on the KnowledgeTree Commercial Download page. KnowledgeTree customers are provided with a direct link to the download area via the customer portal. Other users need to register for this download.

To get KnowledgeTree Client Tools working on the client, you need to ... install KnowledgeTree Client Tools for Windows on each client machine requiring access to KnowledgeTree through Microsoft Office and KnowledgeTree Explorer. download and install the KnowledgeTree Commercial Server package download the KnowledgeTree Commercial license (Trial or Subscription), and install the license in KnowledgeTree's web interface (accessible after you install KnowledgeTree Server) configure a connection between the KnowledgeTree server (the repository) and KnowledgeTree Client Tools for Windows, on the client machine, before attempting to use KnowledgeTree Client Tools for Windows.
Note: See the KnowledgeTree Administrator Manual for instructions on adding licenses and configuring the server connection.

Pre-requisites: Users requiring access to the repository through KnowledgeTree Client Tools must have been added to the system (in the DMS Administration module) and enabled Microsoft .NET 1.0 Framework - required for KnowledgeTree Client Tools Version 3.4.6 and below. Microsoft .NET 2.0 Framework - required from KnowledgeTree Client Tools Version 3.5.2 Commercial (at the time of writing, January 2008, this version of KnowledgeTree Tools will be available February 2008, for use with KnowledgeTree Commercial Server 3.5.2 Commercial Beta)
Note: If you do not have .Net 2.0 installed, the KnowledgeTree Client Tools for Windows installer automatically downloads it from the Internet, and installs it as part of the Client Tools for Windows install process. If you are directed to http://msdn2.microsoft.com/en-us/netframework/aa731542.aspx, download and install the appropriate edition - typically, this will be x86 version, which you will see as an option on the msdn2 download page.

Windows users who want to use Windows Explorer WebDAV must install the Web folders update, available at http://support.microsoft.com/?kbid=907306. Disable Microsoft Word as your email editor in Microsoft Outlook, in order to allow

12

KnowledgeTree Installation Guide 14 July 2008

KnowledgeTree's Outlook Integration feature to install correctly - this allows the KnowledgeTree Client Tools installer to install a Save to KnowledgeTree button on the toolbar in Microsoft Outlook.
Note: KnowledgeTree Outlook Integration is a component of KnowledgeTree Client Tools for Windows.

Close other programs, such as Microsoft Outlook and Microsoft Word, before starting this installation.

Perform the following steps: 1. Download KnowledgeTree Client Tools for Windows.
Note: If this is a trial download of KnowledgeTree Commercial, click here to register for the KnowledgeTree Commercial Enterprise Trial Download. You will receive the link to the download page in an email. All KnowledgeTree Commercial components that need to be downloaded are available on this page.

2. Install KnowledgeTree KnowledgeTree Client Tools for Windows. Click on the setup file, located in the KnowledgeTree Tools install folder, to launch the KnowledgeTree Tools Setup Wizard.
Note: The install package for KnowledgeTree Client Tools for Windows is a zipped folder that includes all components for KnowledgeTree Client Tools for Window. Extract the files from the zip folder; then, click Setup to launch the Setup Wizard.

3. KnowledgeTree Tools Setup checks whether you have the required components installed - e.g. Microsoft .NET 2 Framework (required with KnowledgeTree Tools version 3.5.2 and above). Setup requires these components to continue. Click Install. 4. Setup launches the KnowledgeTree Tools Setup Wizard. Click Next. On the License Agreement.page, select I Agree; then, click Next to open the first of two Options pages. 5. On the first Options page, select components to install - any or all of the following: KnowledgeTree for Outlook, KnowledgeTree for Word, KnowledgeTree for Excel, KnowledgeTree for PowerPoint. Click Next to open the second Options page. On the second Options page, select components to install - any or all of the following: KnowledgeTree Desktop Imaging, KnowledgeTree for Visio. 6. Click Next to open the Select Installation Folder page. Accept the default install location, or click Browse to select an alternative folder. Select either the Everyone or the Just me radio button to define who will be allowed to access KnowledgeTree Client Tools on the computer you're installing to; then, click Next to open the Confirm Installation page. 7. Click Next to start the installation; then, view install progress. 8. Click Close on Installation Complete. Setup places the KnowledgeTree Explorer icon on your desktop, and adds a KnowledgeTree Tools menu item to your Windows Start menu. 9. Download and install the KnowledgeTree Commercial License.
Note:

13

KnowledgeTree Installation Guide 14 July 2008

Installing KnowledgeTree
Locate the Trial license on the download page. A link to this page is sent to you in the email you received after you registered for the download. Download and install KnowledgeTree Commercial Server. The Login page opens by default in your browser after installing. Log in to KnowledgeTree's web interface - first time users use username 'admin' and password 'admin'. Open DMS Administration, then, open KTIS Administration. Install your license in KTIS Administration.

10.Is this the first time that you are installing KnowledgeTree Client Tools for Windows? Yes. Configure a new connection with KnowledgeTree Explorer. View instructions in the KnowledgeTree Administrator Manual. Click here to access the documentation home page on the KnowledgeTree website. No. The Upgrade Installer saves the connection you defined previously to KnowledgeTree Explorer.

3.1.2.1

Unattended Installation This section defines a silent, unattended installation of KnowledgeTree Client Tools for Windows.
Note: A 'silent' install requires no monitoring or user input.

Running a silent install - two methods: use the MSIEXEC command from the command line interface, or; incorporate the MSIEXEC command into a batch file The batch file may be used to combine a silent installation with a pre-populated configuration file.

When is a silent installation used?


Silent installs are useful in a multi-user environment, where all users have the same hardware, and you want to ensure consistent configuration of KnowledgeTree Client Tools for Windows across all client machines. The install package is then placed on a file server, for distribution over a network. Since KnowledgeTree Client Tools for Windows uses Microsoft Windows Installer technology, you can use Active Directory and Group Policy in a deployment.
Note: Find out more about using Active Directory and Group Policy by referring to Microsoft's Online Help for your version of Windows.

Topics in this section: Silent Install - KnowledgeTree Client Tools for Windows Silent Uninstall - KnowledgeTree Client Tools for Windows

14

KnowledgeTree Installation Guide 14 July 2008

3.1.2.1.1 Silent Install This procedures uses the MSIEXEC command to perform a silent installation of KnowledgeTree Client Tools for Windows from the command line.
Note: Refer to Microsoft documentation for more information about the MSIEXEC command.

Important The following command is an example of the MSIEXEC command used to install KnowledgeTree Client Tools for Windows silently. Explanations of the parameters follow the example.
Note: In this instruction, 1.0.msi indicates the file version - replace with your file version number if later than 1.0

Perform a silent install: msiexec /i "c:\KTtoolsVersions\KTtoolsSetup-1.0.msi" /qn /l*v "c:\KTtoolsInstall_log.txt" /i Specifies an installation. /l*v " C:\KTtoolsInstall_log.txt" Specifies verbose logging, and the name and location of the installation log file. /qn Specifies that this is a silent install. "C:\KTtoolsVersions\KTtoolsSetup-1.0.msi" Specifies the complete path to the KnowledgeTree Client Tools for Windows package. It will have an .msi extension.

3.2

Installing KnowledgeTree Commercial License


This procedure displays existing license keys (if any), and adds new license keys. Perform the following steps: 1. Use your administrator credentials to log in to KnowledgeTree's web interface.
Note: First time users log in to KnowledgeTree's web interface using the default credentials created during installation: username 'admin' and password 'admin'.

2. Open DMS Administration; then, click KTIS Administration. 3. Click Manage Keys. 4. Do you want to ... view details of existing keys? License keys are listed on the page. Only 1 key is active at one time. The key that expires first appears at the top of list. The following details are displayed: number of licenses, expiry date, number of days to expiry, organization name.

15

KnowledgeTree Installation Guide 14 July 2008

Installing KnowledgeTree remove a key? Click the Delete link for the relevant key. add a new license key? Click Browse in the Add new key section to locate and upload your license key; then, click Add License. The key is added to the page, displaying the following details: number of licenses, expiry date, number of days to expiry, organization name.
Note: If you are upgrading from one license type to another (e.g. Plus to Premium), you will need to add the new license, and remove the old license type. Users requiring access to KnowledgeTree must be added to the system.

See Also: KnowledgeTree Administrator Manual

3.3

Installing KnowledgeTree Community Edition


In this chapter: How to download and install KnowledgeTree Community Edition using the Community Edition Stack Installer - Server Stack Install How to install KnowledgeTree Community Edition using a Source Only install package Adding the Scheduler to the *Nix Cron (Source Only Install) Adding the Scheduler to the Windows Task Scheduler (Source Only Install) Troubleshooting a Source Only Install

3.3.1

Server - Stack Install


This procedure installs KnowledgeTree Community Edition on your Windows / Linux computer, using the KnowledgeTree Community Edition Stack Installer for Windows / Linux.
Note: This procedure is documented for Windows users. The OSS Stack Installer for Linux differs in a few, minor way - related mainly to setting up services.

Apache and MySQL in the KnowledgeTree Stack The KnowledgeTree Stack Installers (Commercial and Community Editions) include Apache and MySQL. When installing KnowledgeTree on servers that have existing Apache and MySQL installations you will need to select alternate ports for the installation of Apache and MySQL for the KnowledgeTree server during the stack install. Dual installation of Apache and MySQL should not cause conflicts on your system, provided that you choose different ports when prompted to do so during Setup.

Important - Linux Users: 1. Before running the installers for Linux, use the following command to make the package executable:

16

KnowledgeTree Installation Guide 14 July 2008

$ chmod +x ktdms-[current version]-linux-installer.bin $ ./ktdms-[current version]-linux-installer.bin 2. Linux users may need to run the startup script to launch KnowledeTree.

Prerequisites: Install to a supported platform - installations to unsupported platforms must be performed manually, using the Source Only package.

Perform the following steps: 1. Download and run the KnowledgeTree Community Edition Stack Installer for Windows/Linux, from the download page at the KnowledgeTree website. 2. Click through the KnowledgeTree Document Management System OSS Setup Wizard: 2.1.On the Welcome page, click Next to open the License Agreement. Accept the agreement; then, click Next to open the Installation directory page. 2.2.Accept the default install location, or browse to a different install location. When you're done, click Next to open the Web Server Port page. 2.3.Accept the default port for the Apache Web Server (port 8080), or specify a different port; then, click Next to open the SSL support page.
Note: A system messages informs you if the system cannot bind to the standard ports - port 3306 for MySQL, and port 8080 for Apache. In this case, you need to define an alternative port.

2.4.Do you want to install SSL support?


Note: This is an optional task, which may be configured manually after installing. For more information on manually configuring SSL for your environment, see the KnowledgeTree Administrator Manual.

Yes. Select the Yes radio button; then, click Next to define the name of your Web server and the number of days of validity. Click Next. No. Select the No radio button; then, click Next. 2.5.Accept the default port for the MySQL Server (port 3306), or specify a different port; then, click Next to open the MySQL Credentials page.
Note: A system messages informs you if the system cannot bind to the standard ports port 3306 for MySQL, and port 8080 for Apache. In this case, you need to define an alternative port.

2.6.Enter a root password for MySQL Server; then, re-enter the password. Click Next to open the MySQL User Password page.
Note: Passwords defined during install are used only to access the MySQL database these accounts have no relation to the default initial login credentials, created by the system during installation. The initial login to the document management system is: username 'admin', and password, 'admin'.

2.7.Enter a MySQL User Password - the initial password for the DMS user account

17

KnowledgeTree Installation Guide 14 July 2008

Installing KnowledgeTree created during the MySQL database installation. Re-enter the password; then, click Next to open a KnowledgeTree OSS Registration form.
Note: Passwords defined during installation are used only to access the MySQL database. To log in to KnowledgeTree after completing the installation, use the default login credentials: username 'admin', and password 'admin'.

2.8.Register with KnowledgeTree (optional); then, click Next to open Ready to install. 2.9.Click Next to install KnowledgeTree Document Management System. 2.10.When the installation is complete, define whether you want to launch one or more of the following; then, click Finish. README Online Release Notes KnowledgeTree Document Management System (opens KnowledgeTree's web interface Login page; you can log in using the default admin credentials: username 'password', and password, 'password')
TIP: I don't want to start KnowledgeTree now - how will I start it later? Windows: Start KnowledgeTree via the Windows Start menu; ensure all services and servers are running Linux: Open a terminal, enter the following commands: cd ktdms/. ; press Enter; then ./ dmsctl.sh start

4. Set up your Document Management System: change the default administrator username and password in the Preferences tab configure KnowledgeTree for your organization - see the KnowledgeTree Administrator Manual.

3.3.2

Source Only Install


This procedure manually installs KnowledgeTree Community Edition on generic Windows systems, and on Unix-like operating systems. Warning! Manual, source only installations of KnowledgeTree are not supported. 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. Prerequisites: Ensure that you have the correct version of PHP, MySQL and Apache installed and configured for the latest version of KnowledgeTree. See Source Only Package Platform Requirements.

Perform the following steps:

18

KnowledgeTree Installation Guide 14 July 2008

1. Download the KnowledgeTree Source Only package from the KnowledgeTree website
Note: The source package is independent of the operating system.

2. Create the environment for installing KnowledgeTree Community Edition: 2.1.Move the KnowledgeTree folder to the directory where it is going to be served from: $ mv knowledgeTree /path/to/your/html/directory/ 2.2.Configure your Web server to access KnowledgeTree Document Management System. 2.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.

2.4.Set up the database - see the steps in the table below and follow the instructions for your environment: Operating System Tasks Step 1: Create a database $ mysqladmin -p create dms Step 2: Create and populate the tables Unix-based $ mysql -p dms < sql/mysql/install/structure.sql $ mysql -p dms < sql/mysql/install/data.sql Step 3: Create the database users $ mysql -p dms < sql/mysql/install/user.sql
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 Windows 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 $ mysql -u root -p dms < sql/mysql/install/user.sql

2.5.Configure your installation in the KnowledgeTree config.ini file:


Note:

19

KnowledgeTree Installation Guide 14 July 2008

Installing KnowledgeTree
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 3. 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-base chown -R nobody.nogroup var' d systems Windows Check the folders Permissions and Security tabs: Right click on the folder; then, select Properties.

4. 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: The checkup will alert you if there are errors and provide information about the error e.g. that it cannot read/write to a certain location, or that it cannot connect to the database. Review the steps above to fix the error.

5. Log in to KnowledgeTree's Web interface:

20

KnowledgeTree Installation Guide 14 July 2008

5.1.Use your Web browser to navigate to your KnowledgeTree installation. 5.2.Enter your username and password on the Login screen; then, click OK.
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.

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


Note: KnowledgeTrees 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 at the KnowledgeTree website.

pdftotext from http://www.foolabs.com/xpdf/ (for indexing PDF documents) 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 and importing of various office document types) Java from http://www.sun.com (to run the Document Indexer) 7. Edit the following sections in the config.ini file: externalBinary - allow external applications to be found openoffice - allow KnowledgeTree to communicate with the OpenOffice server 8. Start OpenOffice as a server: 8.1.Start OpenOffice as a background task: On ... Unix do the following ... e.g.nohup soffice-headless-invisible-accept='socket,host=localhost,port=8100;ur p' & 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.
Note: For more information on starting OpenOffice as a background task, go to http://www.openoffice.org.

Windo ws

8.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 800600x16 &
Note: Please consult the documentation on Xvbf for more details on usage for your

21

KnowledgeTree Installation Guide 14 July 2008

Installing KnowledgeTree
operating system.

No. Go to step 9. 9. Schedule the background tasks:


Note: KnowledgeTree requires a few background tasks to be performed, such as indexing.

Run /opt/ktdms/knowledgeTree/bin/scheduler.php as a background process: On ... Unix do the following ... Edit the cron. To do this, add the following: 1 * * * * * /path to php/php -Cq /opt/ktdms/knowledgeTree/bin/scheduler.php Windo ws Configure the Windows Scheduler to run the script in the background once a minute.

10.Start the Document Indexer: On ... Unix do the following ... cd /opt/ktdms/knowledgeTree/bin/luceneserver nohup java -jar ktlucene.jar& Windo ws Start a command prompt: java -jar ktlucene.jar
Note: This process will fail if the command prompt does not remain active.

Alternatively, to run the Document Indexer as a background service, use the JavaService wrapper from http://forge.objectweb.org/projects/javaservice/

3.3.2.1

Adding the Scheduler to the *Nix Cron This procedure adds the Scheduler to the Linux cron in a source only installation of KnowledgeTree. Perform the following steps: 1. Open up a root terminal. 2. Check if the scheduler is already in the list of cron jobs. To do this, type: crontab -l. 3. Is the scheduler on the list? Yes. Exit this procedure. No. Add the scheduler to the list. To do this, insert the following line at the end of the crontab, to tell the cron to run the scheduler script every 5 minutes: */5 * * * * /path/to/knowledgeTree/bin/scheduler.php > /dev/null

22

KnowledgeTree Installation Guide 14 July 2008

Cron Commands: The table displays the commands used to view and edit the cron: To .... ... use this command View jobs in the crontab crontab -l Edit the crontab crontab -e Start a new line Press 'o' Edit a line Press 'i' Exit the edit mode Press the 'esc' key Save changes and exit Type ZZ To exit without saving Type :q!

3.3.2.2

Adding the Scheduler to the Windows Task Scheduler Adding the Scheduler to the Windows Task Scheduler when performing a Source Only installation of KnowledgeTree on Windows.

Perform the following steps: 1. Open the Windows Task Scheduler to display existing scheduled tasks: 1.1.Click Start - Control Panel to open the Control Panel. 1.2.Double click on the Scheduled Tasks folder to open it. 1.3.View existing scheduled tasks. 2. Is the scheduler on the list of jobs? Yes. Double click on the scheduler to edit it. No. Go to step 3. Add the scheduler to the list. To do this, click 3. Add the scheduler to the list. To do this, click Add Scheduled Task. Alternatively, right click; then, select New - Scheduled Task. Click Next 3.1.Browse to your KnowledgeTree installation; then, browse to knowledgetree bin. 3.2.Select scheduler.php. 3.3.Select the frequency of the task as Daily. 3.4.Select the time to run as midnight: 12:00AM; then, set it to run every day. 3.5.Enter your windows password. 3.6.Select Open advanced properties for this task when I click Finish. 4. Set Advanced Properties. To do this, right click; then, go to Properties. 4.1.Select the Schedule tab; then, click Advanced. 4.2.Set it to repeat every 5 minutes.

23

KnowledgeTree Installation Guide 14 July 2008

Installing KnowledgeTree 3.3.2.3 Troubleshooting a Source Only Install If you experience errors when attempting a manual (source only) install, check the following: ensure that your KnowledgeTree installation passes all the pre-installation and post-installation checkups refer to the FAQ on the KnowledgeTree Wiki: http://wiki.knowledgetree.com/KnowledgeTree_Support_FAQ request information at the KnowledgeTree community forums: http://forum.knowledgetree.com/ If you suspect that you have found a bug, please report it at http://issues.knowledgetree.com/.

Important: Commercial support is only available to KnowledgeTree Commercial Edition subscribers. See Getting Help for information on community support for KnowledgeTree Community Edition.

24

KnowledgeTree Installation Guide 14 July 2008

Starting KnowledgeTree
KnowledgeTree may be installed as a service or as a console. If you have installed KnowledgeTree as a service (only available on Windows), then KnowledgeTree and all its components (servers and services) starts and stops automatically with the server. When starting KnowledgeTree as a console, you need to manually start and stop KnowledgeTree through the Start menu (on Windows), or through a terminal (on Linux).

4.1

Windows
This procedure starts KnowledgeTree as a console on Windows.
Note: KnowledgeTree and it's components (Apache, MySQL, Scheduler, OpenOffice, Indexer) can be started, stopped, installed, and uninstalled via the Start menu on Windows.

Perform the following steps: 1.Click Start - All Programs - KnowledgeTree Document Management System Commercial Start Here. 2.The login page for KnowledgeTree's web interface displays in your browser. 3.Log in.

4.2

Linux
This procedure starts KnowledgeTree as a console on Linux.
Note: By default, the KnowledgeTree stack installer for Linux installs KnowledgeTree as a console on Linux, and includes the following compulsory components and services, which are required for the proper functioning of KnowledgeTree Document Management System: Apache MySQL OpenOffice Indexer Scheduler Note: Installing KnowledgeTree as a service that starts automatically with the server is only available on Windows.

Perform the following steps: 1. Open a terminal to start KnowledgeTree via the command line interface. 2. Type cd ktdms/.

25

KnowledgeTree Installation Guide 14 July 2008

Starting KnowledgeTree

3. What do you want to do? Start KnowledgeTree as a console. Enter the following command: ./dmsctl. sh start. This option starts the servers - Apache and MySQL, and all services: OpenOffice, Indexer, Scheduler. Stop KnowledgeTree. Enter the following command: ./dmsctl.sh start. This option stops the servers and services. Stop the Apache server only. Enter the following command:./dmsctl stop apache Start the Apache server only. Enter the following command:./dmsctl start apache Restart the Apache server only. Enter the following command:./dmsctl restart apache Stop MySQL server only. Enter the following command:./dmsctl stop mysql Start MySQL server only. Enter the following command:./dmsctl start mysql Restart MySQL server only. Enter the following command:./dmsctl restart mysql

26

KnowledgeTree Installation Guide 14 July 2008

Backing up and Restoring


Backup
The following components should be backed up before you upgrade your KnowledgeTree installation: Database - The mysqldump (included with all the stack installers) or phpMyAdmin programs may be used to export the database into a SQL file. Ensure that you disable foreign key checks in the export. The default database name is dms. Back up this exported file. Documents - Documents are stored in the KnowledgeTree Root directory. Use any file system backup tool to back up your documents. Configuration - The KnowledgeTree configuration settings are in the config.ini file, which you can find in the root directory.
Note: Configuration settings for other applications in the stack are in the following files: php.ini; My.cnf, and http.conf Note: Incorrectly changing settings in the configuration files can introduce errors into your system.

Application - The application may be reinstalled from the original installation material. Keep the application backed up to improve restore-time, and to make it possible to restore if you have lost the original installation material. Use any file system backup tool to back up.

Restore
Restore the following components from the file system where they were backed up: Documents Configuration Application Restore the Database using the mysql or phpMyAdmin programs to read in the exported SQL file.

See Also: Backup and restore on Windows Backup and restore on Linux Automating Database Backup

5.1

On Linux
This procedure saves your database to a file (e.g. dump.sql) and restores your database from the file where it was backed up (Linux users). Perform the following steps: 1. Open a terminal.

27

KnowledgeTree Installation Guide 14 July 2008

Backing up and Restoring

2. Enter KnowledgeTree_Directory\mysql\bin 3. Do you want to ... Backup your database? Go to step 4.


Note: This command saves the database to dump.sql

Go to step 4. Restore your database? Type ./mysqldump --socket= KnowledgeTree_Directory /mysql/tmp/mysql.sock -u dmsadmin -p dms < dump.sql 4. To BACKUP, do the following: 4.1.Enter the following command: ./mysqldump --socket= KnowledgeTree_Directory /mysql/tmp/mysql.sock -u dmsadmin -p dms > dump.sql 4.2.When prompted for a password, enter the MySQL password you set during your KnowledgeTree installation. 4.3.The database is saved to dump.sql. Ensure that you keep this file in a safe place. 5. To RESTORE, do the following: 5.1.Enter the following command: ./mysqldump --socket= KnowledgeTree_Directory /mysql/tmp/mysql.sock -u dmsadmin -p dms < dump.sql 5.2.When prompted for a password, enter the MySQL password you provided when installing KnowledgeTree.

5.2

On Windows
This procedure backs up your database to a file (e.g. dump.sql) and restores your database from backup file (Windows users). Perform the following steps: 1. Click Start - Run. 2. Type cmd in the Run dialog box. 3. What do you want to do? Backup? Go to step 4. Restore. Go to step 5. 4. To BACKUP, do the following: 4.1.Enter the path to the KnowledgeTree install directory, e.g: KnowledgeTree_Directory\mysql\bin

28

KnowledgeTree Installation Guide 14 July 2008

4.2.Enter the following command: mysqldump -u dmsadmin -p dms > dump.sql 4.3.When prompted for a password, enter the MySQL password you set up during your KnowledgeTree installation. 4.4.The database is saved to dump.sql. - by default this is in the ...\mysql\bin directory. Keep this file in a safe place. 5. To RESTORE, do the following: 5.1.Navigate to KnowledgeTree_Directory\mysql\bin 5.2.Enter the following command: mysql.exe -u dmsadmin -p dms < dump.sql 5.3.When prompted for a password, enter the MySQL password you provided during your KnowledgeTree installation.

5.3

Automating Database Backup


This procedure automates the sql dump to run the database backup automatically, on all platforms.
Notes: This procedure eliminates the need for user input of a password after you enter the -u and -p switches (in the command mysqldump -u dmsadmin -p dms > dump.sql)when performing a database backup.

Perform the following step: 1. Add the following to the Pre-Backup Script: use --password=[xxx] in a batch file, which runs without user intervention. Example: mysqldump.exe -u dmsadmin -p dms --password=xxxx > sqldump.sql
Note: Provide a password to the -p/--password option

29

KnowledgeTree Installation Guide 14 July 2008

Upgrading KnowledgeTree

Upgrading KnowledgeTree
This chapter provides instruction and information around the various upgrade scenarios for KnowledgeTree. KnowledgeTree provides click through Upgrade Installers for KnowledgeTree Commercial Editions and KnowledgeTree Community Edition on Windows and on Linux.

Upgrade Notes The KnowledgeTree Upgrade Installers automatically upgrade your database during installation. If the Database Upgrade Wizard fails to launch the database upgrade page, you must load the page manually to run the upgrade script. If you do not run upgrade.php script to apply the necessary database upgrades, you will not be able to log in to KnowledgeTree. The KnowledgeTree Stack Installers install Apache and MySQL - select alternative ports if you are installing on Servers that have Apache and MySQL. Incorrect Permissions settings may cause upgrades to fail - e.g. unwritable log directories. Ensure that permissions are set correctly before starting an upgrade to prevent a non-repairable upgrade state. This condition applies primarily to the <KT directory>\var directory. The user running Apache must have read/write access to this directory.

In this chapter: Upgrading KnowledgeTree Commercial Edition to a new version of KnowledgeTree Commercial Edition Upgrading KnowledgeTree Community Edition (Stack Installed) to KnowledgeTree Commercial Edition Upgrading KnowledgeTree Community Edition (Stack Installed) to new version KnowledgeTree Community Edition (Stack Install) Upgrading KnowledgeTree Community Edition (Source Only Package) to KnowledgeTree Commercial Edition Upgrading KnowledgeTree Community Edition (Source Only Package) to KnowledgeTree Community Edition (Stack Install) Upgrading KnowledgeTree Community Edition (Source Only Package) to KnowledgeTree Community Edition (Source Only Package)

See Also: Backing up and Restoring

30

KnowledgeTree Installation Guide 14 July 2008

6.1

Migration: Windows to Linux / Linux to Windows


When migrating your KnowledgeTree installation from Windows to Linux, or from Linux to Windows, you will need to move your documents and your database from the source environment to the new environment. 1. Perform a backup on the Source environment (Windows/Linux) 2. Restore the backup on the new environment (Windows/Linux) For more information, see Backing up and Restoring in this Guide, or view more information about Backing up and restoring KnowledgeTree on the KnowledgeTree Wiki.
Note: We recommend that you store a backup of the documents and the database in separate locations.

6.2

Indexing Migrated Content


When upgrading from 3.4.x to 3.5.x, an Index Migration script is run (using the search2/indexing/bin/migrate.php script) to move the content from the databasebased full text tables to the new Document Indexer. The migration process is configured as a scheduled task in the KnowledgeTree stack, and starts automatically after upgrading to KnowledgeTree version 3.5.x. When all content is removed from the database-based full text tables, the migration task removes itself from the scheduled tasks list. Migration Script KnowledgeTree (from version 3.5.0) includes a migration script that runs in the background after the upgrade process is complete. During the migration process, a dashlet on KnowledgeTree's web interface dashboard provides status updates on the migration, and when all documents are migrated the dashlet disappears.

6.3

KnowledgeTree Commercial Upgrade Installer


This procedure upgrades your existing KnowledgeTree installation (Community Edition or Commercial Edition) to the latest version of KnowledgeTree Commercial, using the KnowledgeTree Commercial Upgrade Installer for Windows/Linux.
Note: This procedure describes the steps involved when using the Commercial Upgrade Wizard for Windows. The Commercial Upgrade Wizard for Linux differs in a few, minor ways. The KnowledgeTree 3.5.X Upgrade Installers should automatically stop services (MySQL and Apache) running for KnowledgeTree. However, some users have reported that the Upgrade Installers have not stopped MySQL service as expected, causing upgrades to fail. We do therefore recommend that you ensure that services are stopped before upgrading. See the

31

KnowledgeTree Installation Guide 14 July 2008

Upgrading KnowledgeTree
Upgrade Notes on the KnowledgeTree Wiki, where you can find the instruction for stopping MySQL, if required.

Perform the following steps: 1.Are you upgrading from ... an earlier version of KnowledgeTree Commercial Edition? Go to step 2. KnowledgeTree Community Edition (Source Only Package)? See Upgrading Community Edition (Source Only) to Commercial Edition. KnowledgeTree Community Edition (Stack Installed)? Backup your current installation; then, ensure that you have upgraded your stack installed Community Edition installation to a version that is compatible for running the Commercial Upgraded Installer for the latest version of KnowledgeTree Commercial.
Notes: To verify this information, you can check the KnowledgeTree website, and/or the release notes on the KnowledgeTree Wiki, and/or contact KnowledgeTree Sales for assistance: sales@knowledgetree.com.

2.Are you upgrading on Linux? Yes. Use the following command to make the upgrade installer package executable before you launch the file: $ chmod +x ktdms-[current version]-pro-linux-installer.bin $ ./ktdms-[current version]-pro-linux-installer.bin
Note: You can also use either of the following alternative steps for making the package executable on Linux: Right click on the Installer / Upgrade Installer package; then, select Properties. Set permissions to Read / Write, select Executable, close Properties dialog. The exact steps varies between Linux distributions; or, Remove the .bin extension from the file name. (Some Linux distributions will not run bin files)

No. Go to step 3. 3.Download and run the KnowledgeTree Document Management System Commercial Upgrade Wizard (Windows or Linux) from the KnowledgeTree website. 4.Click through the Commercial Upgrade Wizard: 4.1.On the Welcome page, click Next to open the License Agreement page. 4.2.Review the license agreement; then, click I accept the agreement. Click Next to open the Installation directory page. 4.3.Accept the default install location, or click the Browse icon to select another location; then, click Next to open the SSL Support page. 4.4.Do you want to install SSL support? Yes. Click Yes; then, complete the installation steps for SSL support. When you're done, click Next to open Ready to Install.
Note: Installing support for SSL sets up KnowledgeTree to run on SSL by default

32

KnowledgeTree Installation Guide 14 July 2008

when using https. For more information, see Configuring SSL for the Apache Server in the KnowledgeTree Administrator Manual.

No. Click No; then, click Next to open Ready to Install. 4.5.On Ready to Install, click Next to start the upgrade installation. 4.6.View install progress on the Installing page. 4.7.On Completing the ... Setup Wizard, select one or more of the following options: View Readme File Open Online Documentation Visit http://127.0.0.1:80/setup/upgrade.php now?
Note: The Database Upgrade Wizard installs the required database updates. If you do not upgrade the database, a system message on the Login page informs you that the database is incompatible. You will need to upgrade the database before the system will allow you to log in.

5.Upgrade the database through the Database Upgrade Wizard. 5.1.On the login page of the Database Upgrade Wizard, enter your KnowledgeTree administrator credentials in the Username and Password fields; then, click login to open the second page of the Database Upgrade Wizard. 5.2.Do you want to ... exit this procedure? Click cancel. backup your database? Click backup now. continue with this database upgrade? Click next. restore to a previous version of the database? Click restore database. 5.3.The Database Upgrade Wizard displays the available database upgrades that must be applied. Click next to perform the upgrades. 5.4.The Database Upgrade Wizard confirms the success of the upgrade. Click next to open KnowledgeTree's login page in your browser.
Note: On first login to your upgraded installation, hard refresh your browser on the Dashboard (press Ctrl+F5); then, enable new plugins (if required).

6.KnowledgeTree's Login page opens in your browser. Use your administrator credentials to log in to KnowledgeTree's Web interface; then, perform the following tasks to complete the upgrade of your KnowledgeTree installation: Restart KnowledgeTree services. Having logged in to your new upgraded installation for the first time, hard refresh your browser on the Dashboard (press Ctrl+F5) Read and enable Plugins
Note: See Manage Plugins in the KnowledgeTree Administrator Manual for more information about this task.

Install new or additional licenses (if applicable), and ensure that all users requiring access to KnowledgeTree Commercial have been added to the system and are enabled in Users and Groups.

33

KnowledgeTree Installation Guide 14 July 2008

Upgrading KnowledgeTree
Note: Users are enabled by default when they're added to the system. For more information see the KnowledgeTree Administrator Manual.

7.If this is an upgrade from KnowledgeTree Community Edition, you can now download and install KnowledgeTree Commercial Edition Tools, and configure the connection between the client machines where KnowledgeTree Client Tools for Windows is installed, and the KnowledgeTree repository.

6.3.1

Upgrading Community Edition (Source Only) to Commercial Edition


This procedure upgrades a KnowledgeTree Community Edition, source only install, to the latest version of KnowledgeTree Commercial.
**Note: This procedure describes an upgrade on Linux.

Perform the following steps: 1. Back up your existing KnowledgeTree Source Only database to a file e.g. dump. sql. 2. Download; then, run the KnowledgeTree Commercial Edition Stack Installer (Note: Not the Commercial Upgrade Installer). Before running the installer for Linux, use the following command to make the package executable: $ chmod +x ktdms-[current version]-linux-installer.bin $ ./ktdms-[current version]-linux-installer.bin 3. Restore your Source Only database over the Stack Installed database: 3.1.Browse to the following directory: <KnowledgeTree Stack Installation>\mysql\bin 3.2.Drop the empty stack database with the following command: ./mysqladmin -u dmsadmin -p --socket=../tmp/mysql.sock drop dms 3.3.Create a new empty database with the following command: ./mysqladmin -u dmsadmin -p --socket=../tmp/mysql.sock create dms 3.4.Restore your Source Only database with the following command: ./mysql -u dmsadmin -p --socket=../tmp/mysql.sock dms < dump.sql 4. Run any required database upgrades; to do this, open the following page in your Internet browser: http://your_stack_installation_ip:port/setup/upgrade.php 5. Log in to KnowledgeTree's Web interface to perform the administrative tasks necessary for completing the upgrade: 5.1.Reread and enable the plugins. 5.2.Install the KnowledgeTree Commercial Editions license key.

34

KnowledgeTree Installation Guide 14 July 2008

Note: For more information on these administrative tasks, see the KnowledgeTree Administrator Manual.

6.4

KnowledgeTree Community Edition Upgrade Installer


This procedure upgrades an existing KnowledgeTree Community Edition installation (Source Only Package or Stack Installed) to the latest version of KnowledgeTree Community Edition, using the KnowledgeTree Community Edition Upgrade Installer for Windows/Linux. This section discusses tasks to performed before running the KnowledgeTree Community Edition Upgrade Installer to upgrade from a Source Only KnowledgeTree Community Edition installation to the latest, stack installed version of KnowledgeTree Community Edition.

Perform the following steps: 1. Back up your current installation. 2. Are you upgrading from ... KnowledgeTree Community Edition Source Only Package? Manually upgrade to the latest version of KnowledgeTree Community Edition (Source Only). Download the latest Source Only package for Windows / Linux at the KnowledgeTree website. Follow the upgrade instructions on the KnowledgeTree Wiki: http://wiki.knowledgetree.com/Upgrading_KnowledgeTree
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.

KnowledgeTree Community Edition Stack Installed? Go to step 3. 3. Download the latest version of the KnowledgeTree Community Edition Upgrade Installer for Windows/Linux at the KnowledgeTree website. 4.Are you upgrading on Linux? Yes. Use the following command to make the upgrade installer package executable before you launch the file: $ chmod +x ktdms-[current version]-linux-installer.bin $ ./ktdms-[current version]-linux-installer.bin
Note: You can also use either of the following alternative steps for making the package executable on Linux: Right click on the Installer / Upgrade Installer package; then, select Properties. Set permissions to Read / Write, select Executable, close Properties dialog. The exact steps varies between Linux distributions; or, Remove the .bin extension from the file name. (Some Linux distributions will not run bin files)

No. Go to step 5. 5.Click on the file to launch the KnowledgeTree Document Management System Upgrade Setup Wizard; then, click Next.

35

KnowledgeTree Installation Guide 14 July 2008

Upgrading KnowledgeTree 5.1.On the Installation directory page, accept the default install location, or click Browse to specify a different location; then, click Next. 5.2.On the WebServer Port page, accept the default Apache Web Server Port; then, click Next.
Note: From KnowledgeTree version 3.5, the default port for the Apache installation depends on the security level of the user performing the upgrade: When users with administrator or root privileges perform the upgrade, the upgrade installer selects port 80 as the default port. When users without administrator or root privileges perform the upgrade, the upgrade installer selects port 8080 as the default port. When upgrading to KnowledgeTree 3.5, ensure that the correct port is selected, because the installer is unable to determine the port selected in a previous installation, and if port 8080 is selected when port 80 should be used, the upgrade installer will default to port 80, and not to port 8080.

5.3.On Ready to Install, click Next; then, view install progress. 5.4.On Completing the KnowledgeTree Document Management Upgrade Setup Wizard, leave Visit ... to continue selected; then, click Finish. 5.5.The KnowledgeTree Upgrades page opens in your browser. Review the upgrades required; then, click Upgrade.
Note: You must upgrade the database before you will be allowed to log in to KnowledgeTree.

5.6.View upgrade results; then, close the page in your browser. 6.KnowledgeTree's Web interface login page opens in your browser. Use your administrator login credentials to log in; then, open DMS Administration. 7.In Miscellaneous - Manage Plugins reread and enable plugins to complete this upgrade.
Note: See the KnowledgeTree Administrator Manual for more information on reading and enabling Plugins.

6.4.1

Upgrading Community Edition (Source Only) to Community Edition (Source Only)


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

36

KnowledgeTree Installation Guide 14 July 2008

Open Source Stack Installer. The Open Source stack installer installs PHP, MySQL, and Apache, and includes the external applications required for running KnowledgeTree Open Source.

Platform Requirements - Source Only Installation


Required Server Software PHP 5.1.6 or above PHP LDAP extension (if LDAP or ActiveDirectory integration is required) PHP Exif extension (if header extraction from JPEG and TIFF files is required) PHP mbstring extension (functions for multi-byte character sets) PHP mysql extension (interface to mysql database from php) PHP json extension (functions for working with json structures) PHP fileinfo extension (functions for resolving mime types of documents) MySQL Server, Client, and PHP libraries, version 5.0.41 or above Apache 2.0 or above pdftotext (required for indexing of pdf files on Microsoft Windows and Linux/UNIX,) pstotext (required for indexing of postscript files on Microsoft Windows) Open Office 2.0 or above (required for indexing of office document types) Info-Zip (required for extracting contents of zip files)

Supported Server Operating Systems Microsoft Windows 2000/2003 Server Linux FreeBSD Sun Solaris
Note: KnowledgeTree should run on any platform capable of hosting the Apache/MySQL/PHP stack described above.

Required Client Software A modern web-browser, such as: Firefox 1.0+ Internet Explorer 6.0+

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:

37

KnowledgeTree Installation Guide 14 July 2008

Upgrading KnowledgeTree $ 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 $ 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 $ 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:

38

KnowledgeTree Installation Guide 14 July 2008

[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 folders 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: 7.1.Use your Web browser to navigate to your KnowledgeTree installation. 7.2.Enter your username and password on the Login screen; then, click OK.
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: KnowledgeTrees 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.

pdftotext from http://www.foolabs.com/xpdf/ (for indexing PDF documents) 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 and importing of various office document types)

39

KnowledgeTree Installation Guide 14 July 2008

Upgrading KnowledgeTree Java from http://www.sun.com (to run the Document Indexer) 9. Edit the following sections in the config.ini file: externalBinary - allow external applications to be found 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 800600x16 &
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/

40

KnowledgeTree Installation Guide 14 July 2008

7
7.1

Uninstalling KnowledgeTree
Linux/Unix Uninstall
This procedure uninstalls KnowledgeTree in a Linux/Unix environment. Warning! Uninstalling removes all KnowledgeTree program files. Your documents and your database remain on the file system until you delete the ktdms directory. Deleting the ktdms directory removes your documents and your directory (database); you will lose the information in these folders and files, including metadata. To retain this information, see Backup and Restore.

Perform the following steps: 1. Open a terminal. 2. Navigate to the ktdms directory. 3. Run ./uninstall. 4. When you're prompted for your MySQL admin password, enter the password you defined when installing KnowledgeTree. 5. All your KnowledgeTree program files are removed.
Note: Your documents and database remain on the file system until you delete the ktdms directory.

6. The uninstall procedure shuts down the Apache server and the MySQL server.

7.2

Windows Uninstall
This procedure uninstalls KnowledgeTree in a Windows environment. *Important - Windows Users* You must restart your computer after uninstalling KnowledgeTree. If you have installed KnowledgeTree as a service, disable Apache and MySQL services, using the links in the Start Menu, BEFORE uninstalling KnowledgeTree. Warning! Uninstalling removes all KnowledgeTree program files. Your documents and your database remain on the file system until you delete the ktdms directory. Deleting the ktdms directory removes your documents and your directory (database); you will lose the information in these folders and files, including metadata. To retain this information, you will need to backup and restore.

Perform the following steps: 1.Is KnowledgeTree currently installed as a service?

41

KnowledgeTree Installation Guide 14 July 2008

Uninstalling KnowledgeTree Yes. Disable Apache and MySQL services, using the links in the Start Menu. No. Go to step 2. 2. Click Start - Programs - KnowledgeTree Document Management System Uninstall KnowledgeTree Document Management System. 3. All your KnowledgeTree program files are removed. Your documents and database remain on the file system until you delete the ktdms directory (located by default at c:\Program Files\ktdms)
Note: Uninstalling shuts down the Apache server and the MySQL server.

7.3

Silent Uninstall
To silently uninstall KnowledgeTree Client Tools for Windows, replace the /i parameter for each command with the /x parameter. All other parameters remain the same.

Important The following command is an example of using the MSIEXEC command to silently uninstall KnowledgeTree Client Tools for Windows.
Note: In this instruction, 1.0.msi indicates the file version - replace with your file version number if later than 1.0

Perform a silent uninstall: msiexec /x "c:\KTtoolsVersions\KTtoolsSetup-1.0.msi" /qn /l*v "c:\KTtoolsInstall_log.txt"

42

KnowledgeTree Installation Guide 14 July 2008

Configuring KnowledgeTree
For more information about setting up the KnowledgeTree Document Management System for your organization, or to find out more about editing the KnowledgeTree config.ini file, please see the KnowledgeTree Administrator Manual. Go to the KnowledgeTree Documentation home page to access the KnowledgeTree Administrator Manual (View online / PDF)
Note: The KnowledgeTree Administrator Manual includes a high level walk-through of the system tasks that are performed after installing or upgrading your KnowledgeTree Document Management System and server.

43

KnowledgeTree Installation Guide 14 July 2008

Troubleshooting

Troubleshooting
Browser Does not Display KnowledgeTree If you get a browser error, do the following: 1. ensure that Apache and MySQL are running 2. uninstall KnowledgeTree; then, reinstall. Ensure that you are providing the correct path, database, and password information 3. check the community websites for known issues, FAQ's, etc. at http://www. knowledgetree.com

System message Advises Fatal Error in dispatcher.inc.php; or, Fatal Error in Permission.inc To resolve this issue: ensure that MySQL is running; ensure that the 'dbPort' parameter in config.ini is correct.

Calling a Command Line Script Produces Memory Allocation Error To resolve this issue, edit the php.ini and ensure that the memory_limit is set to -1.

File Types of Documents are not Being Resolved Correctly After adding a document you may notice that the file type is not resolved correctly. This is either because the file is not of a known type, or the path to the file type resolution database is incorrect. To resolve this issue, ensure that the fileinfo extension is installed, and that the magicDatabase setting in the config.ini is correct.

Database Incompatible Error Message on Login Page After Upgrading The database must be upgraded when upgrading the KnowledgeTree installation; failure to upgrade the database prevents login, and a system message advises that the database is incompatible. The Upgrade Installers include a Database Upgrade Wizard to automate database upgrades as part of the system upgrade. For Source Only upgrades, follow the instructions in Upgrade.txt in the Docs directory of the Source Only Package, or check the upgrade instructions on the KnowledgeTree website.

Upgrade Failure may be Caused by Incorrect Permissions Settings When upgrade fails, check that permissions are set correctly - for example, the presence of unwritable log files can cause Upgrades to fail to a non-repairable state. To resolve this issue, please ensure that permissions do not prevent upgrade installs before you start the upgrade.

Some Functionality is Not Available After Upgrade To resolve this issue, is it necessary to always reread the plugin list from the file system after upgrading your KnowledgeTree installation.

44

KnowledgeTree Installation Guide 14 July 2008

Upgrading the KnowledgeTree 2.0.7 Database Fails This issue is due to the documents.full_path referring to a path in the documentRoot that does not exist - the storage location has moved, and 2.0.7 deals with directories differently to the way the upgrade scripts expect it to work. As a result, downloads do not work once the upgrade has been applied. A patch is available at the following location: http://forge.knowledgetree.com/snippet/detail.php?type=snippet&id=2 This code can run on a database that has been upgraded from 2.0.7 to 3.3.x. However, because it does require the system to already be in a 3.3.x state, it is not possible to include it in the Upgrade Scripts - it must be executed as a separate step.

Issues When Upgrading KnowledgeTree Versions older than KnowledgeTree 3.4.* When upgrading KnowledgeTree versions older than Version 3.4 Commercial Edition, a system issue prevents the plugin paths, stored in the database, from seamlessly updating as part of the back up and restore procedure for this type of upgrade. The plugin paths have to be updated in one of the following ways: manually - open the database dump (dump.sql) and edit the paths manually. You could search for all references to the KnowledgeTree path - e.g. for Windows: C:/Program Files/ktdms - and change these to your new path. automatically - if you are sufficiently familiar with MySQL, post a support request to obtain SQL queries for update these paths automatically.

Don't see what you're looking for?


See Getting Help or ... Review the Release Notes for your version for the latest upgrade/install notes. Request new features, or tell us about an error. How do I use KnowledgeTree's Issue Management System? Request assistance from KnowledgeTree Support (Commercial Editions only)
Note: For more information on Getting Support, see the KnowledgeTree Wiki.

Post your questions (and answers) at the KnowledgeTree Community Forum.

45

KnowledgeTree Installation Guide 14 July 2008

Index

46

Index
-BBacking up and Restoring On Linux 27 On Windows 27

Unattended Installation KnowledgeTree Editions Commercial 3 Community 3 On Demand 3 On Premise 3

14

-LLicense Expiry 3 Installing 3 Renewing 3 Linux Backing up 27 Install Notes 11 Restoring 27 Starting KnowledgeTree On Uninstalling 41

-CCommercial Editions Installing 7

-DDatabase Backup Automating 29

25

-GGetting Help Commercial Editions 2 Community Edition 2 Documentation 2 Support 2

-MMigrating Linux to Windows Windows to Linux 31 31

-RRequirements Software Appliance Source Only 5 14 6 Running the KnowledgeTree Commmercial Upgrade Installer On Commercial Edition Installation 31 On Community Edition Installation 31 On Source Only Installation 31 Running the KnowledgeTree Community Edition Upgrade Installer On Source Only Installation 35 On Stack Installed Installation 35

-IInstallation KnowledgeTree Client Tools for Windows Unattended 14 Installing KnowledgeTree 7 7

Installing KnowledgeTree

-KKnowledgeTree About 1 Configuring 43 KnowledgeTree Client Tools for Windows Installing 12 Silent Install 15 Silent Uninstall 42

-SSource Only Install 18 Stack Install Community Edition 16 Server 8 Starting KnowledgeTree

46

47

KnowledgeTree Installation Guide

Starting KnowledgeTree On Linux 25 On Windows 25

-TTroubleshooting 44 Source Only Install 24

-UUninstalling Linux 41 On Windows Unix 41 41

Upgrading KnowledgeTree Commercial Edition 30 Community Edition 30 From Community Edition, Stack Installed From Source Only 30 Upgrading KnowledgeTree Community Edition Source Only 34 Upgrading Source Only 36

30

-WWindows Backing up 28 Restoring 28 Starting KnowledgeTree On 25

KnowledgeTree Installation Guide 14 July 2008

You might also like