Knowledgetree Installation and Upgrade Guide

Installation and Upgrade Guide
KnowledgeTree 3.6.1 Installation and Upgrade Guide
Copyright 2009 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/licenses/by/3.0/us/
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
Part I Welcome to KnowledgeTree 2
................................................................................................................................... 4 What's New in KnowledgeTree 3.6.x ................................................................................................................................... 5 About this Help ................................................................................................................................... 6 Getting Help for KnowledgeTree ................................................................................................................................... 8 KnowledgeTree Editions ................................................................................................................................... 9 KnowledgeTree Client Tools ................................................................................................................................... 10 KnowledgeTree Commercial Features ................................................................................................................................... 11 KnowledgeTree Commercial License
Viewing / ......................................................................................................................................................... 12 Adding License Keys Part II Installing KnowledgeTree 15
................................................................................................................................... 15 View Demo - Installing KnowledgeTree ................................................................................................................................... 16 System Requirements ................................................................................................................................... 16 Linux Install Notes ................................................................................................................................... 16 Installing KnowledgeTree Commercial Edition
Running ......................................................................................................................................................... 18 the KnowledgeTree Commercial Stack Installer

................................................................................................................................... 20 Installing KnowledgeTree Community Edition - Stack Install ................................................................................................................................... 22 Installing KnowledgeTree Community Edition - Source Only Install
......................................................................................................................................................... 26 Adding the Scheduler to the Windows Task Scheduler ......................................................................................................................................................... 26 Adding the Scheduler to the *Nix Cron ......................................................................................................................................................... 27 Troubleshooting a Source Only Install
................................................................................................................................... 27 Starting KnowledgeTree ................................................................................................................................... 29 Logging In
Part III Upgrading KnowledgeTree
31
................................................................................................................................... 32 Backing up and Restoring
KnowledgeTree 3.6.1 Installation and Upgrade Guide - 09 September 2009
II
KnowledgeTree 3.6.1 Installation and Upgrade Guide

......................................................................................................................................................... 32 Backup and Restore on Windows ......................................................................................................................................................... 33 Backup and Restore on Linux ......................................................................................................................................................... 34 Automating Database Backup
................................................................................................................................... 34 Migrating your KnowledgeTree Installation
Indexing ......................................................................................................................................................... 35 Migrated Content

................................................................................................................................... 35 Upgrading to latest KnowledgeTree Commercial Edition ................................................................................................................................... 37 Upgrading Source Only, Community Edition to KnowledgeTree Commercial ................................................................................................................................... 38 Upgrading Community Edition, Stack Installed ................................................................................................................................... 40 Upgrading to latest Source Only, Community Edition
Part IV Uninstalling KnowledgeTree
45
................................................................................................................................... 45 Uninstalling on Windows ................................................................................................................................... 46 Uninstalling on Linux / Unix
Part V Setting up KnowledgeTree
48
................................................................................................................................... 48 View Demo - Getting Started
Part VI Troubleshooting
51
KnowledgeTree 3.6.1 Installation and Upgrade Guide - 09 September 2009
Welcome to KnowledgeTree
Part
KnowledgeTreeT M is document management made simple - easily share, track, secure, and manage the documents and records your organization depends on. KnowledgeTree provides an easy-to-use, production-ready, enterprise document management solution for use by corporations, government institutions, medium to small businesses, and many 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.
KnowledgeTreeLive KnowledgeTreeLive is the 'Software-as-a-Service' (Cloud), hosted version of KnowledgeTree's web-based, on-premise, Commercial edition document management system that runs on Amazon Elastic Compute Cloud(EC2). Documents are stored on Amazon.com Elastic Block Store (EBS), and regular, secure backups are stored separately to Amazon Simple Storage Service (S3) - a massive, fault-tolerant, storage area network. IMPORTANT KnowledgeTreeLive is not included in this document as it requires no server infrastructure, installation, upgrades, storage, or firewalls. For more information about KnowledgeTreeLive, see the KnowledgeTreeLive Quick Start Guide - view online / download PDF.
Note: Amazon Web Services, the "Powered by Amazon Web Services" logo, Amazon's Elastic Compute Cloud(tm) and Simple Storage Service(tm) are trademarks of Amazon.com, Inc. or its affiliates in the United States and/or other countries.
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 workflow Full-text indexing technology allowing search within document contents Powerful security group and role-based security model and integration with enterprise directory servers
KnowledgeTree 3.6.1 Installation and Upgrade Guide 09 September 2009
KnowledgeTree web interface dashboard
To learn more about KnowledgeTree on-premise, to subscribe to KnowledgeTreeLive, or to license KnowledgeTree for use within your own application, visit the KnowledgeTree website or contact KnowledgeTree Sales: Call: +1 415.200.0225 Fax: +1 415.449.3595 Email: sales@knowledgetree.com Support: support@knowledgetree.com
Note: Support is only available for KnowledgeTree Commercial customers.
See Also: KnowledgeTree KnowledgeTree KnowledgeTree KnowledgeTree
Community edition - open source software community resources plugins index platform requirements
KnowledgeTree features KnowledgeTree feature checklist KnowledgeTree Commercial on-premise feature matrix KnowledgeTreeLive product overview KnowledgeTree Commercial support KnowledgeTree store KnowledgeTree case studies KnowledgeTree customer training KnowledgeTree screenshots, webcasts, and documentation
1.1
What's New in KnowledgeTree 3.6.x
KnowledgeTree version 3.6.x includes the following new functionality:

Note: Some features are only available in the KnowledgeTree Commercial edition (on-premise, and KnowledgeTreeLive).
Electronic signatures - facilitates compliance with a number of standards, including CFR 21 Part 11. Enabling Electronic Signatures requires KnowledgeTree users to enter their KnowledgeTree username and password to complete document and folder write actions. Document Type Alerts the KnowledgeTree administrator creates document type alerts and assigns these alerts to specific document types in the system. When creating the alert, the administrator selects the recipients who will receive email notifications when the alert is triggered. Additionally, alert recipients are notified through their 'Items Requiring Your Attention' dashlet, where they can follow a link to the relevant documents. Users may also view alerts as un-editable 'System Alerts' via the 'Alerts' action on the relevant document's Document Actions menu. KnowledgeTree Office Add-in the server-side components that are required for using this new desktop integration client tool with the KnowledgeTree server are packaged with the KnowledgeTree Commercial server installers and upgrade installers (from version 3.6.1 and above), and are pre-configured with KnowledgeTreeLive. KnowledgeTree Office Add-in is a client tool for Microsoft Office 2007 users, and is installed on each user's local machine to provide access to their KnowledgeTree documents from within Microsoft Office 2007 (Excel, PowerPoint, and Word). See the KnowledgeTree Client Tools User Guide. Warning prompt on the 'Make Immutable' action - the 'Make Immutable' document action prevents anyone from making further changes on a document, but this action cannot be undone. Previously, users could easily make a document immutable without realizing the consequences of this action. A warning prompt has now been added to this action to warn users before they complete this action. Improvements to Search changes to search ranking ensure that results are returned in the correct order, with the document title and metadata ranking higher than content. Improvements to the Advanced Search function ensures that more relevant results are returned. Improvements to Indexing a new, more reliable method of extracting content from documents ensures greater support for document formats and improved cross-platform
Welcome to KnowledgeTree stability. In this document, see Search and Indexing Reports, and Search and Indexing Settings. IE8 compatibility Improved PDF conversion - allows users to generate a PDF of supported file types Improvements to the Upgrade Installers Numerous Bug fixes
The following enhancements were released with KnowledgeTree 3.6-Community Edition, and have been added to the KnowledgeTree 3.6.1-Commercial and Community Edition releases: New core API and RESTful interface including updated documentation to facilitate integrating KnowledgeTree with other applications and services. Click here to view the latest online API Documentation. New Text Extraction Engine provides greater UTF-8 support and improved cross-platform stability, including enhanced support for searching content in languages such as Chinese and Japanese. Upgraded components in the KnowledgeTree Stack Installers and Upgrade Installers: Apache - upgraded from version 2.0.63 to version 2.2.11 PHP - upgraded from version 5.2.5 to version 5.2.8 OpenOffice - upgraded from version 2.3 to version 2.4.2 New location for Search and Indexing reports now accessible through System Configuration, in KnowledgeTrees Web interface administration module (DMS Administration) Improved Search and Indexing yields better results Improved performance and system stability
Note: For more information, see the KnowledgeTree Release Notes on the KnowledgeTree Wiki, and the KnowledgeTree documentation: KnowledgeTree Administrator Manual KnowledgeTree User Manual KnowledgeTree Client Tools User Guide
1.2
About this Help
The KnowledgeTree Installation and Upgrade Guide provides instructions for installing and upgrading KnowledgeTree on-premise (Commercial edition and Community Edition).
IMPORTANT KnowledgeTreeLive is not included in this documentation as it requires no server infrastructure, installation, upgrades, storage, or firewalls, and server-side settings are pre-configured. For more information about KnowledgeTreeLive, see the KnowledgeTreeLiv e Quick Start Guide - view online / download PDF.
This Help is intended for use by an experienced system administrator.

Note: For information on setting up KnowledgeTree after this installation is complete, please see the KnowledgeTree Administrator Manual. Instructions for users are documented in the KnowledgeTree User Manual.
Getting the latest version of the KnowledgeTree Documentation The latest published version of this document may be downloaded (PDF) or viewed online at http://www.knowledgetree.com/resources - please also see the KnowledgeTree Wiki for updates, various articles, and the latest Release Notes.
This version: KnowledgeTree Server Version: 3.6.X Publication Date: July 2009
Improving KnowledgeTree Documentation This document is a working draft that is continually updated. We welcome your contributions to help us document KnowledgeTree. Please post your comments and suggestions by creating a Documentation ticket for the KnowledgeTree project on http://issues.knowledgetree.com.
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.3
Getting Help for KnowledgeTree
Getting help for KnowledgeTree Commercial editions: KnowledgeTree provides professional support services to commercial customers (on-premise, and the SaaS version, KnowledgeTreeLive). Our support service includes priority assistance from KnowledgeTree support staff and engineers, with guaranteed response times. Find out more about KnowledgeTree's Commercial Support services at the KnowledgeTree website, or contact us for help with choosing the best support package for your needs. Logging Support Requests
Welcome to KnowledgeTree KnowledgeTree Commercial support tickets (for KnowledgeTree on-premise, or KnowledgeTreeLive) are logged through KnowledgeTree's online Issue Tracking system, or via email. KnowledgeTree Commercial on-premise: Customers are provided with instructions for logging support requests, with their KnowledgeTree Commercial on-premise license. KnowledgeTreeLive: Customers are provided with an account username and password for logging support requests through the online Issue Tracking system. See also 'Getting Support' on the KnowledgeTree Wiki. Find out more about logging support requests.
Getting Help for KnowledgeTree Community Edition Community support is available at the KnowledgeTree Community Forums, where you can post questions and get answers from our KnowledgeTree developers, and the KnowledgeTree community.
KnowledgeTree Documentation The following documentation is available from http://www.knowledgetree.com/resources: (View Online or Download PDF files) KnowledgeTree Administrator Manual KnowledgeTree User Manual KnowledgeTree Client Tools User Guide KnowledgeTreeLive Quick Start Guide KnowledgeTree API Documentation 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 your 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, and at http://www. knowledgetree.com/community Contact KnowledgeTree Sales - by phone, fax, or email
1.4
KnowledgeTree Editions
KnowledgeTree is available in two on-premise editions (KnowledgeTree Commercial edition, and KnowledgeTree Community edition), and a hosted (SaaS) version of KnowledgeTree Commercial on-premise edition: KnowledgeTree Commercial Editions ON-PREMISE self-hosted licensed on-premise, LAMP/WAMP stack install commercially supported production-ready, Web-based, document management software application includes extra tools and 'commercial-only' features, such as the KnowledgeTree client tools, and additional document management functionality View support options for KnowledgeTree Commercial customers, and compare products. Download KnowledgeTree Commercial, on-premise
HOSTED, Software-as-a-Service (SaaS), KnowledgeTreeLive hosted licensed requires no installation, upgrades, or server infrastructure commercially supported production-ready, web-based, document management system commercially supported includes extra tools and 'commercial-only' features, such as the KnowledgeTree client tools, and additional document management functionality includes Zoho(R) integration - allowing you to create, view, and edit documents online, and on the fly
Notes: View information for setting up and managing your KnowledgeTree document management system (KnowledgeTreeLive and KnowledgeTree on-premise) in the KnowledgeTree KnowledgeTree Administrator Manual View information for using your KnowledgeTree document management system in the KnowledgeTree User Manual
Sign up for your KnowledgeTreeLive account To sign up, please contact KnowledgeTree Sales: Call: +1 415.200.0225 Fax: +1 415.449.3595 Email: sales@knowledgetree.com Support: live-support@knowledgetree.com
KnowledgeTree Community Edition
Welcome to KnowledgeTree Open Source - free to download, use, modify, and redistribute, subject to the terms of the GNU GPL v3 Self-hosted Stack installed, or source installed Community supported Lacks the KnowledgeTree Commercial tools and features that are available with KnowledgeTree Commercial on-premise, and KnowledgeTreeLive Find out more about KnowledgeTree Community Edition Download KnowledgeTree Community Edition - stack installed, or the 'source only' package
Contacting KnowledgeTree Call: +1 415.200.0225 Fax: +1 415.449.3595 Email: sales@knowledgetree.com Support: live-support@knowledgetree.com
Note: Support is only available to Commercial customers.
See Also: KnowledgeTree Community edition - open source software KnowledgeTree community resources KnowledgeTree platform requirements KnowledgeTree features KnowledgeTree feature checklist KnowledgeTree Commercial on-premise feature matrix KnowledgeTreeLive product overview KnowledgeTree Commercial support KnowledgeTree store KnowledgeTree case studies KnowledgeTree customer training KnowledgeTree screenshots, webcasts, and documentation
1.5
KnowledgeTree Client Tools
KnowledgeTree provides several client-side tools that offer alternative document management and integration interfaces to the web-based KnowledgeTree repository.
Note: The KnowledgeTree Client Tools User Guide provides download links, inline video overviews, and information on installing and using all the KnowledgeTree client tools - view online / download the PDF Note: KnowledgeTreeLive is the hosted (SaaS) version of KnowledgeTree Commercial on-premise. A KnowledgeTreeLive account provides access to KnowledgeTree's Commercial features, including the KnowledgeTree client tools. See the KnowledgeTreeLive Quick Start Guide for more information about downloading the client tools for KnowledgeTreeLive.
The KnowledgeTree Client Tools include:
KnowledgeTree Tools - a single package download that ships with KnowledgeTree Commercial editions (on-premise, and KnowledgeTreeLive), for Microsoft Office Windows users (2003, XP), and includes: KnowledgeTree Explorer, KnowledgeTree Office Integration, KnowledgeTree Outlook Integration, and the KnowledgeTree Desktop Imaging tool.
Commercial Editions Only
KnowledgeTree Office Add-in - a client-side, desktop tool for Microsoft Office 2007 that allows you to work KnowledgeTree documents from within the following Microsoft Office 2007 applications: Word, Excel, and PowerPoint.
KnowledgeTree Hot Folders - integrates your scanner or bulk document handling applications with KnowledgeTree.
KnowledgeTree Drop Box - drag and drop one or more documents and folders from your Windows desktop right into KnowledgeTree's web-based document management system.
Community (from version 3.5.3) and Commercial Editions
1.6
KnowledgeTree Commercial Features
KnowledgeTree Commercial editions (on-premise, and KnowledgeTreeLive) include professional support, and provide access to additional document management tools and functionality.
Note: Features that are available only to admin users are referenced in the KnowledgeTree Administrator Manual. Features available to non-admin users are documented in the KnowledgeTree User Manual and in the KnowledgeTree Client Tools User Guide.
KnowledgeTree Commercial Tools and Add-ins KnowledgeTree Tools for Windows

Note: This toolset contains all of the following: KnowledgeTree Explorer, KnowledgeTree Outlook Integration, KnowledgeTree Office Add-in for Microsoft Office, KnowledgeTree Desktop Imaging.
KnowledgeTree Office Add-in - a client-side tool for Microsoft Office 2007 KnowledgeTree Hot Folders
Note: KnowledgeTree Drop Box (Beta) may be used with KnowledgeTree Commercial editions (onpremise, and KnowledgeTreeLive), and KnowledgeTree Community edition (from version 3.5.3).
KnowledgeTree Web Interface Commercial Functionality: Users Document Actions Document Shortcuts Document Alerts Inline View of Documents Document Comparison PDF Conversion Zoho(R) integration - for KnowledgeTreeLive only
10
Web Interface Dashlets Recently Viewed Items Top Downloads (for the last week) Go to Document ID Your Checked-out Documents Quicklinks General Document Jump plugin - allows users to move the Web interface dashlets to preferred positions.
Administrators Reporting User Reports: Last Login Information, Login Activity (all users), Full Login History (per user) Folder Usage Information Extended Transaction Information (view transactions per user, or global transaction reports) Other Professional Support Custom Document Numbering Email Document Types (used with KnowledgeTree Outlook Integration) Conditional metadata Electronic Signatures (New in KnowledgeTree 3.6.1) Document Type Alerts (New in KnowledgeTree 3.6.1) Commercial language packs for the KnowledgeTree Commercial interface: Italian, Japanese, German, French
See Also: The KnowledgeTree Plugins Index on the KnowledgeTree Wiki
1.7
KnowledgeTree Commercial License
KnowledgeTree Commercial on-premise (trial or subscription) requires a license to activate commercial features and provide access to the KnowledgeTree Commercial edition client tools.
Note: KnowledgeTree Commercial is a stable, quality tested, production ready version of the open source KnowledgeTree Community Edition. Note: KnowledgeTreeLive requires no license installation. Signing up for a hosted, KnowledgeTreeLive account subscription provides instant access to the KnowledgeTree Commercial edition document management software, including all commercial features and the client tools.. For more information about the KnowledgeTreeLive service, please consult the KnowledgeTreeLive Quick Start Guide.
Free Trial You can download the full-featured KnowledgeTree Commercial Premium Trial (on-premise)
11
software for evaluation purposes for a limited, free period, from the KnowledgeTree website. On the download page, you can download KnowledgeTree on-premise, a trial license, and the KnowledgeTree client tools.
Note: You will need to install your license to unlock KnowledgeTree's Commercial functionality.
Purchasing a KnowledgeTree Commercial edition, on-premise License Contact KnowledgeTree Sales to purchase your KnowledgeTree Commercial Edition license: Call us: +1 415.200.0225 Email us: sales@knowledgetree.com Before you buy ... Compare editions - see the Editions Feature Matrix on the KnowledgeTree website Find all your purchasing questions answered at our Sales and Purchasing FAQ
1.7.1
Viewing / Adding License Keys
This procedure displays your existing KnowledgeTree Commercial edition on-premise license, and adds a new license.
Note: This procedure is not relevant for KnowledgeTreeLive. KnowledgeTreeLive requires no license installation. Signing up for a hosted, KnowledgeTreeLive account subscription provides instant access to the KnowledgeTree Commercial edition document management software, including all commercial features and the client tools.. For more information about the KnowledgeTreeLive service, please consult the KnowledgeTreeLive Quick Start Guide.
Pre-requisite: KnowledgeTree Commercial edition on-premise server, installed Your license key downloaded to your desktop - either the key you purchased, or the evaluation (trial) key. Perform the following steps: 1. Use your administrator credentials to log in to KnowledgeTree's web interface; then, go to DMS Administration - License Administration.
Note: First time users log in to KnowledgeTree's web interface using the default credentials created during installation: username: admin password: admin
12
Welcome to KnowledgeTree 2. Click Manage Keys. 3. 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.
remove a key? Click the Delete link for the relevant key. add a new license key? In the Add new key section, click Browse to locate and upload your License; 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: When upgrading from one license type to another, you will need to add your new license; then, delete the old license.
13
Installing KnowledgeTree
Part
II
This chapter provides instructions around installing KnowledgeTree on-premise for the first time (Commercial edition, or Community edition). If you are upgrading an existing installation of KnowledgeTree, see Upgrading KnowledgeTree in this Guide.
Note: This chapter is not relevant for KnowledgeTreeLive, the hosted, on-demand (SaaS) version of KnowledgeTree Commercial on-premise. KnowledgeTreeLive requires no installation, upgrades, storage, firewalls, server infrastructure, or server configuration.
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.
Apache and MySQL in the KnowledgeTree Stack The KnowledgeTree stack installers (Commercial and Community on-premise 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.
2.1
View Demo - Installing KnowledgeTree
This topic presents - in the online documentation only - an inline, recorded demo of the KnowledgeTree Commercial on-premise installation process, when using the KnowledgeTree Commercial Installer for Windows.
Note: This is a flash file. Use the movie controls located at the top left of the movie screen to play, pause, or stop the demo. Click anywhere on the movie screen to move past the Text boxes. If you are viewing this topic in the PDF document and want to watch the demo, you can find KnowledgeTree's online documentation, including this document, at http://www.knowledgetree.com/resources.
Contents of this Demo: Downloading KnowledgeTree from the KnowledgeTree website - filling out the registration form, finding the link in your email, and what you will find on the KnowledgeTree Commercial download page Running the KnowledgeTree Commercial Install Wizard Viewing KnowledgeTree resources on the Welcome page after completing the install Logging in to KnowledgeTree's Web interface Introduction to KnowledgeTree's Web interface Dashboard
15
2.2
System Requirements
The latest information around minimum hardware and software requirements for running the KnowledgeTree on-premise server and the KnowledgeTree client tools is hosted and updated on the KnowledgeTree website: View minimum Platform Requirements for the Stack Installation (KnowledgeTree Commercial Edition and Community Edition) View minimum Platform Requirements for Source Only installation (KnowledgeTree Community Edition only)
Im portant! The requirements for the Source Only package differ from the Stack Installed packages, which include all the components required for running KnowledgeTree. Only KnowledgeTree Community Edition can be manually installed using the source only package. Note that Source Only installations are not supported.
2.3
Linux Install Notes
When using a stack installer to install KnowledgeTree on Linux (Commercial and Community editions, on-premise), the installation must be added to your system startup scripts to ensure that the KnowledgeTree services will start automatically when booting your Linux machine. To do this, you need to ensure that the dmsctl.sh script is linked to your init.d directory, and that it is placed into the startup and shutdown procedures for runlevel 3.
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.
2.4
Installing KnowledgeTree Commercial Edition
This topic provides a high level walk through of the tasks that must be performed to install KnowledgeTree Commercial on-premise. *IMPORTANT* Download links - KnowledgeTree customers are provided with a direct link to the download area via the customer portal. When downloading a KnowledgeTree Commercial Trial for evaluation purposes, you will need to fill out a registration form to access this download. An email containing a link to the download area will be sent to you immediately after you submit the registration form. The KnowledgeTree download page provides access to all the download packages required for your installation. This is a 3 step download process. Download and install all of the following components:
16
Installing KnowledgeTree KnowledgeTree Client Tools (one or more) 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 time to download.
Note: Please contact KnowledgeTree Sales if you require any additional information or assistance to complete this installation.
Task Overview 1. Ensure that your install environment fulfills the minimum platform requirements. 2. Download and install the KnowledgeTree Commercial stack installer (for Windows or Linux) from the KnowledgeTree website. 3. Download and install one or more of the KnowledgeTree Client Tools, on each client machine requiring access to KnowledgeTree.
Note: The following KnowledgeTree Client Tools are available for download on the server download page: KnowledgeTree Tools (KnowledgeTree Explorer etc.) KnowledgeTree Office Add-in KnowledgeTree Hot Folders KnowledgeTree Drop Box Note: Installation and setup instructions for all the KnowledgeTree Client Tools may be found in the KnowledgeTree Client Tools User Guide (Download PDF / View Online at http://www.knowledgetree.com/resources
4. Download your KnowledgeTree Commercial on-premise license from the KnowledgeTree website download area. 5. Log in to KnowledgeTree's Web interface to install your License (Trial, or Commercial Subscription).
Note: The Install Wizard opens KnowledgeTree's Web interface Login page immediately after the install. Alternatively, you can start KnowledgeTree later. Use the following default credentials to log in after completing this installation: Username: admin Password: admin
6. If you are using KnowledgeTree Client Tools, configure a connection to the KnowledgeTree server through each of the client tools you are using (i.e. on each client machine where the tools are installed).
Note: See the KnowledgeTree Client Tools User Guide for information on configuring server connections for the relevant client tool. Note: When using the KnowledgeTree Client Tools with KnowledgeTreeLive, you will need to define the connection to your KnowledgeTree domain, which is provided with your KnowledgeTreeLive account.
7. Configure KnowledgeTree for use in your organization.
17
2.4.1
Running the KnowledgeTree Commercial Stack Installer
This procedure installs KnowledgeTree Commercial (on-premise), using the KnowledgeTree Commercial Stack Installer for Windows/Linux.
Notes: KnowledgeTree Commercial Edition is also available as a Premium Trial download for evaluation purposes. The complete download for KnowledgeTree Commercial Edition is a 3 step process - the KnowledgeTree document management server (Windows or Linux), your KnowledgeTree Commercial License (Trial or Subscription), and one or more of the KnowledgeTree Client Tools. 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 Sales.
Prerequisites Install only to a supported platform. 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. Fill out the registration form; 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 the instructions for the KnowledgeTree server installation are provided in this procedure. No. If you have already purchased your Commercial Edition license, KnowledgeTree Sales will send your license in an email, with a link to the Commercial download page, where you can download all required KnowledgeTree Commercial Edition components. To purchase your license now, go to http://www.knowledgetree.com/store. 3. On the KnowledgeTree Commercial download page, select the Installer package you
18
Installing KnowledgeTree 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 Enabling SSL support.
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 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.
4.4.To install SSL support, select Yes; then, click Next to define the name of your Web server and the number of days validity. The installer generates a certificate. Click Next. Alternatively, select No to skip this step; then, click Next.
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.
4.5.On MySQL Information, accept the default port for the MySQL Server (port 3306), or specify a different port; then, click Next to open the Database Server Root Password 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 for MySQL; 80 or 8080 for Apache.
4.6.Enter a root password for MySQL Server. Repeat the password; then, click Next to open the Database Server 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.
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 the Sign up for new release ... page, define whether you want to receive new release information and security and other alerts delivered to your KnowledgeTree dashboard through Bitrock Network Support; then, when you're done, click Next.
Note: For more information on the Bitrock Network Service, go to http://bitrock.com/network/
4.9.On Ready to install, click Next to start the installation. 5. When the installation is complete, define whether to open the KnowledgeTree website's
19
Welcome page, and / or whether to start KnowledgeTree now. When you have made your selection, click Finish.
Note: The Welcome page on the KnowledgeTree website provides information on getting started with KnowledgeTree. If you choose to launch KnowledgeTree now, the Web interface Login page will display, and you can use the following default credentials to logon: username: admin password: admin
6. To complete this KnowledgeTree installation, do the following: Download and install your Commercial or Trial license. Read and enable the plugins you want to use. Download and install the KnowledgeTree Client Tools you require; then, configure server connections for the tools on each client machine requiring access to KnowledgeTree through the tools. Configure KnowledgeTree for your organization.
Note: See the KnowledgeTree Adm inistrator Manual for configuration information, and see the KnowledgeTree Client Tools User Guide for information on installing and using the KnowledgeTree Client Tools.
2.5
Installing KnowledgeTree Community Edition - 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 Community Edition Stack Installer for Linux differs in a few, minor ways - 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: $ 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:
20
Installing KnowledgeTree 1. Download the KnowledgeTree Community Edition Stack Installer for Windows/Linux. (Registration required) 2. Open the file; then, click through the KnowledgeTree Community Edition Setup Wizard: 2.1.On Welcome ... 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 for the Apache Web Server (port 80, if you have sufficient permissions, or port 8080), or specify a different port; then, click Next to open the Enabling SSL support page. Note: If you are unable to bind to the standard ports (port 3306 for MySQL and port 8080 for Apache), you will receive an error message, and you will need to define an alternative port. 2.4.Do you want to install SSL support now? Yes. Select Yes; then, click Next to provide details for your SSL certificate. Provide the name of your Web server and the number of days the certificate must remain valid. Click Next to continue. No. Select No; then, click Next.
Note: You can choose to enable SSL through the Installer, or you
can enable and configure SSL for your environment at a later stage. See the KnowledgeTree Administrator Manual for instructions on how to do this. 2.5.On the MySQL Information page, accept the default port (port 3306), or specify an alternative; then, click Next to open the Database Server Root Password page. 2.6.Define a root password for MySQL ServerNote: These passwords are only used to access the
MySQL database and have no relation to your login credentials - default (admin/admin) or otherwise. . Confirm the password; then, click Next to open the Database Server User
Password page. 2.7.Define a MySQL user passwordNote: These passwords are only used to access the MySQL database and have no relation to your login credentials - default (admin/admin) or otherwise. . Confirm the password; then, click Next to open the KnowledgeTree Update Notification Service form.
Note: Passwords defined during an installation are only used to access the MySQL database and have no relation to the default logon credentials (username 'admin', and password 'admin')
2.8.Define whether you want receive new release information and security notifications for KnowledgeTree; then, click Next. 2.9.Windows users only - Get a free drag-and-drop tool for KnowledgeTree: On Sign up to ... [Drop Box] define whether you want to download KnowledgeTree Drop BoxA desktop
tool for Windows that allows you to drag and drop documents and folders from your desktop right into KnowledgeTree.; then, please fill out the form to help us improve our product by telling
us a bit about how you intend using KnowledgeTree. When you're done, click Next to start the installation.
Note: KnowledgeTree Drop Box is a Windows tool that allows you to drag and drop
21
documents and folders from your desktop right into KnowledgeTree. To see KnowledgeTree Drop Box in action, see the webcast at the KnowledgeTree website, or to find out more, see the KnowledgeTree Client Tools User Guide.
2.10.On Ready to install, click Next. View install progress. 2.11.On Completing the KnowledgeTree ... Setup Wizard, select your preferences (options include: view Welcome page, and Login now). Click Finish. 2.12.If you have chosen to log in now, KnowledgeTree's Login page opens in your browser. First time users use the following credentials to log in: Username 'admin' and Password 'admin'. 3. Set up KnowledgeTree for your organization. See the KnowledgeTree Administrator Manual for more information on getting started with KnowledgeTree.
2.6
Installing KnowledgeTree Community Edition - 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: 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 your KnowledgeTree installation. 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:
22
Installing KnowledgeTree 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
3. Configure your installation in the KnowledgeTree config.ini file:

Note: 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
23
dbPort dbAdminUser dbAdminPass
= default = dmsadmin = admin
4. 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-based systems Windows chown -R nobody.nogroup var' Check the folders Permissions and Security tabs: Right click on the folder; then, select Properties.
5. 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.
6. To log in to KnowledgeTree's Web interface, use your Web browser to navigate to your KnowledgeTree installation; then, enter your username and password on the Login screen. 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.
7. Install the following external applications to enable file indexing. 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)
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
24
KnowledgeTree website.
8. 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 9. Start OpenOffice as a server: 9.1.Start OpenOffice as a background task: On ... Unix Windows do the following ... e.g.nohup soffice-headless-invisible-accept='socket,host=localhost, port=8100;urp' & 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.
9.2.If you are installing on Linux, 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.
10.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 Windows Configure the Windows Scheduler to run the script in the background once a minute.
11.Start the Document Indexer: On ... Unix do the following ... 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.
Alternatively, to run the Document Indexer as a background service, use the JavaService wrapper from http://forge.objectweb.org/projects/javaservice/
25
2.6.1
Adding the Scheduler to the Windows Task Scheduler
Adding the Scheduler to the Windows Task Scheduler when performing a source install on Microsoft 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.
2.6.2
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
26
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!
2.6.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 postinstallation 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.
2.7
Starting KnowledgeTree
This procedure starts KnowledgeTree.

Note: KnowledgeTree may be installed as a service or as a console. When installing KnowledgeTree as a service (Windows users only), 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.
Starting KnowledgeTree on 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.
27
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.
Note: On first logon after a fresh installation, use the default administrator credentials that are created during the installation: username: admin password: admin To protect your system, change the default password at your earliest convenience.
Starting KnowledgeTree on 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
Perform the following steps: 1. Open a terminal to start KnowledgeTree via the command line interface. 2. Type cd ktdms/. 3. To start the servers (Apache and MySQL) and all services (OpenOffice, Indexer, Scheduler), enter the following command: ./dmsctl.sh start.
Note: Use the following commands for these alternative actions: To stop the KnowledgeTree servers and services, use: ./dmsctl.sh start To stop the Apache server only, use: ./dmsctl stop apache To start the Apache server only, use: ./dmsctl start apache To restart the Apache server only, use: ./dmsctl restart apache To stop MySQL only, use: ./dmsctl stop mysql To start MySQL server only, use: ./dmsctl start mysql To restart MySQL server only, use: ./dmsctl restart mysql
28
2.8
Logging In
This procedure allows you to log in to KnowledgeTree's Web interface. Perform the following steps: 1. Start KnowledgeTree manually, or navigate to the server address of your KnowledgeTree domain.
Note: KnowledgeTree's Web interface opens by default in your browser after installation. E.g.
2. The Web interface Login page displays in your browser. 3. Enter your login username and password credentials to log in to KnowledgeTree.
Note: First time login credentials are created by default during the installation: username: admin password: admin You should change these credentials (in the Web interface 'Preferences' tab) at your earliest convenience. See the KnowledgeTree Adm inistrator Manual for information on changing your username and password.
29
Upgrading KnowledgeTree
Part
III
This chapter provides instruction and information around the various upgrade scenarios for KnowledgeTree on-premise.
Note: This chapter is not relevant for KnowledgeTreeLive, the hosted, on-demand (SaaS) version of KnowledgeTree Commercial on-premise. KnowledgeTreeLive requires no installation, upgrades, storage, firewalls, server infrastructure, or server configuration.
KnowledgeTree provides click through Upgrade Installers for KnowledgeTree Commercial editions (on-premise) 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 nonrepairable 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
31
3.1
Backing up and Restoring
This topic provides information and instructions to backup and restore on Windows and on Linux, and explains how to automate database backups. Before you begin: 1. See the Upgrade Best Practice tips on the KnowledgeTree website. 2. See also, How to restore if upgrade fails (version 3.5.4a and above).
Components to backup before an upgrade 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. Components to restore after upgrading 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.
3.1.1
Backup and Restore 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; then, type cmd in the Run dialog box.
32
2. To BACKUP ... 2.1.Enter the path to the KnowledgeTree install directory, e.g: KnowledgeTree_Directory\mysql\bin 2.2.Enter the following command: mysqldump -u dmsadmin -p dms > dump.sql 2.3.When prompted for a password, enter the MySQL password you set up during your KnowledgeTree installation. 2.4.The database is saved to dump.sql. - by default this is in the ...\mysql\bin directory. Keep this file in a safe place. 3. To RESTORE ... 3.1.Navigate to KnowledgeTree_Directory\mysql\bin 3.2.Enter the following command: mysql.exe -u dmsadmin -p dms < dump.sql 3.3.When prompted for a password, enter the MySQL password you provided during your KnowledgeTree installation.
3.1.2
Backup and Restore 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. 2. Enter KnowledgeTree_Directory\mysql\bin 3. Do you want to ... Backup your database? 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
Note: This command saves the database to 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:
33
./mysql --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.
3.1.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
3.2
Migrating your KnowledgeTree Installation
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.
Note: This chapter is not relevant for KnowledgeTreeLive, the hosted, on-demand (SaaS) version of KnowledgeTree Commercial on-premise. KnowledgeTreeLive requires no installation, upgrades, storage, firewalls, server infrastructure, or server configuration. For more information on migrating between KnowledgeTreeLive and KnowledgeTree on-premise, see the online KnowledgeTreeLive Quick Start Guide, or download the PDF.
Perform the following steps: 1. Perform a backup on the Source environment (e.g. Windows, or Linux)
Note: We recommend that you store a backup of the documents and the database in separate locations.
2. Restore the backup on the new environment (e.g. Windows, or Linux)

Note: See Backing up and Restoring in this Guide, or view more information about Backing up and restoring KnowledgeTree on the KnowledgeTree Wiki.
34
3.2.1
Indexing Migrated Content
From version 3.5.0, KnowledgeTree (on-premise) 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. When upgrading from KnowledgeTree version 3.4.x to version 3.5.x, an Index Migration script is run (using the search2/indexing/bin/migrate.php script) to move the content from the database-based 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.
Note: An alternative to running the migration script would be to empty the full text database table (document_text) and then run Reschedule all Docum ents in DMS Adm inistration - Search and Indexing. This forces all the documents to be indexed using the new Indexer.
3.3
Upgrading to latest KnowledgeTree Commercial Edition
This procedure upgrades your existing KnowledgeTree installation - stack installed Community or Commercial on-premise editions - to the latest version of KnowledgeTree Commercial onpremise, using the KnowledgeTree Commercial Upgrade Installer for Windows/Linux.
Note: This procedure describes the steps involved when using the Com m ercial 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 Upgrade Notes on the KnowledgeTree Wiki, where you can find the instruction for stopping MySQL, if required.
35
Pre-requisites: Upgrading on Linux? Make the upgrade installer package executable before launching the file. To do this, use the following command: $ chmod +x ktdms-[current version]-pro-linux-installer.bin $ ./ktdms-[current version]-pro-linux-installer.bin Alternatively, use either of the following 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 varies between Linux distributions; or, Remove the .bin extension from the file name. (Some Linux distributions will not run bin files) Upgrading from a Stack Installed Community Edition? Backup your installation, and ensure that you are upgrading from a stack installed Community Edition version that is compatible for running the current version of the Commercial Upgrade Installer. To verify your scenario, check the KnowledgeTree website, the Release Notes on the Wiki, and/or contact KnowledgeTree Sales for assistance.
Perform the following steps: 1. Download and run the KnowledgeTree Document Management System Commercial Upgrade Wizard (Windows or Linux) from the KnowledgeTree website commercial download page. 2. Click through the Commercial Upgrade Wizard: 2.1.On the Welcome page, click Next to open the License Agreement page. 2.2.Review the license agreement; then, click I accept the agreement. Click Next to open the Installation directory page. 2.3.Accept the default install location, or click the Browse icon to select another location; then, click Next to open the SSL Support page. 2.4.To install SSL Support, click Yes; then, complete the installation steps for SSL support. Alternatively, click No to install KnowledgeTree without SSL support.
Im portant! If you have SSL installed, click No. Clicking Yes when you already have SSL installed will overwrite your existing SSL. Note: Installing support for SSL sets up KnowledgeTree to run on SSL by default when using https. For more information, see 'Configuring SSL for the Apache Server' in the KnowledgeTree Administrator Manual.
2.5. Click Next to open Setup (Sign up for new release and security announcements). Define whether you want to sign up for Bitrock's Network Service, which allows you to receive information about new KnowledgeTree releases. When you're done, click Forward to open Ready to Install. 2.6.On Ready to Install, click Next to start the upgrade installation; then, view install progress. 2.7.On Completing the ... Setup Wizard, select the option to perform the Database Upgrade 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
36
that the database is incompatible. You will need to upgrade the database before the system will allow you to log in.
3. Upgrade your Database through the Database Upgrade Wizard: 3.1.Enter your KnowledgeTree administrator credentials in the Username and Password fields; then, click login to open the second page of the Database Upgrade Wizard. 3.2.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. 3.3.The Database Upgrade Wizard displays the available database upgrades that must be applied. Click next to perform the upgrades. A system notice on the Upgrade Wizard confirms the success of the upgrade. 3.4.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).
4. 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. Once you have logged in after upgrading, hard refresh your browser on the Dashboard (press Ctrl+F5) Install new licenses, if applicable Read and enable Plugins
Note: See the KnowledgeTree Adm inistrator Manual for more information.
5. If this is an upgrade from KnowledgeTree Community Edition, you can now download and install the KnowledgeTree Client Tools, and configure the connection between the client machine where the client tools are installed, and the web-based KnowledgeTree system.
3.4
Upgrading Source Only, Community Edition to KnowledgeTree Commercial
This procedure upgrades a KnowledgeTree Community edition, source only install, to the latest version of KnowledgeTree Commercial Edition.
**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.
37
2. Back up your existing Documents directory. 3. Download; then, run the KnowledgeTree Commercial Edition Stack Installer - Note: NOT the Commercial Upgrade Installer. Before running the installer on Linux, use the following command to make the package executable: $ chmod +x ktdms-[current version]-linux-installer.bin $ ./ktdms-[current version]-linux-installer.bin 4. Restore your Source Only database over the Stack Installed database: 4.1.Browse to the following directory: <KnowledgeTree Stack Installation>\mysql\bin 4.2.Drop the empty stack database with the following command: ./mysqladmin -u dmsadmin -p --socket=../tmp/mysql.sock drop dms 4.3.Create a new, empty database with the following command: ./mysqladmin -u dmsadmin -p --socket=../tmp/mysql.sock create dms 4.4.Restore your Source Only database with the following command: ./mysql -u dmsadmin -p --socket=../tmp/mysql.sock dms < dump.sql 5. 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 6. Log in to KnowledgeTree's Web interface; then, perform the following tasks to complete this upgrade: 6.1.Read and enable plugins. 6.2.Install your KnowledgeTree Commercial Editions license key to activate Commercial functionality.
Note: For more information on these administrative tasks, see the KnowledgeTree Adm inistrator Manual.
3.5
Upgrading Community Edition, Stack Installed
This procedure upgrades an existing, source only or stack installed, KnowledgeTree Community edition to a newer version of KnowledgeTree Community edition, using the KnowledgeTree Community edition Upgrade Installer for Windows/Linux. 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
38
Upgrading KnowledgeTree 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 e, 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.
Note: Download from http://www.knowledgetree.com/node/38
4. If you are upgrading on Linux, make the Upgrade Installer package executable before launching the file. To do this, use the following command: $ 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)
5. Click on the file to launch the KnowledgeTree Document Management System Upgrade Setup Wizard; then, click Next. 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.
Notes: 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. 6. 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.
39
7. View upgrade results; then, close the page in your browser. 8. KnowledgeTree's Web interface login page opens in your browser. 9. Use your administrator login credentials to log in; then, open DMS Administration to reread and enable Plugins.
Note: See the KnowledgeTree Adm inistrator Manual for more information on reading and enabling Plugins.
3.6
Upgrading to latest Source Only, Community Edition
This procedure manually upgrades your Source Only, manually installed, KnowledgeTree Community edition installation to the latest version of KnowledgeTree Community edition, using the Source Only package, on generic Windows systems, and on Unix-like operating systems.
Note: KnowledgeTree Source Only packages contain the KnowledgeTree application and installation instructions. You will need to be familiar with installing and configuring all required components.
Warning!
This is an unsupported upgrade. We recommend that you use the KnowledgeTree Community edition stack installer. The Community edition stack installer installs PHP, MySQL, and Apache, and includes the external applications required for running KnowledgeTree Community edition. Pre-requisites: Ensure that your environment meets the Open Source Platform Requirements for the source only installation.
Perform the following steps: 1. Ensure that you have the correct version of PHP, MySQL and Apache installed and configured for the latest version of KnowledgeTree. 2. Back up your existing KnowledgeTree Source Only database to a file, e.g. dump.sql. 3. Download the latest Source Only Package for Windows / Linux at the KnowledgeTree website.
Note: The source package is independent of the operating system.
4. Create the environment for installing KnowledgeTree Open Source: 4.1.Move the KnowledgeTree folder to the directory where it is going to be served from: $ mv knowledgeTree /path/to/your/html/directory/ 4.2.Configure your Web server to access KnowledgeTree Document Management System. 4.3.Run the pre-checkup script: If your KnowledgeTree installation is at http://localhost/, go to http://localhost/setup/
Note: Review your configuration if the pre-checkup script fails.
4.4.Set up the database - see the steps below and follow the instructions for your
40
Upgrading KnowledgeTree environment: Unix Step 1: Create a database $ mysqladmin -p create dms Step 2: Create and populate the tables $ mysql -p dms < sql/mysql/install/structure.sql $ mysql -p dms < sql/mysql/install/data.sql Step 3: Create the database users
Note: The database users and passwords must match the ones in the config.ini
$ mysql -p dms < sql/mysql/install/user.sql
Windows
Note: Locate the MySQL applications on your system; then, use the path to these applications in the commands below.
Step 1: Create a database x:\> mysqladmin -u root -p create dms Step 2: Create and populate the tables X:\> mysql -u root -p dms < sql/mysql/install/structure.sql X:\> mysql -u root -p dms < sql/mysql/install/data.sql Step 3: Create the database users
Note: The database users and passwords must match the ones in the config.ini
$ mysql -u root -p dms < sql/mysql/install/user.sql 4.5.Configure your installation in the KnowledgeTree config.ini file: The default configuration automatically determines many settings on your installation; since this is the preferred method of running KnowledgeTree, please don't adjust these settings unnecessarily. After completing your initial evaluation, we recommend that you modify your configuration, including default database connection settings, to comply with security best practises for your platform. The default configuration uses default settings for the database location, username and password. These are defined in the user.sql file mentioned above. Provided that you have followed the examples above for setting up the database, KnowledgeTree should be fully configured to work. The following settings in config/environment.php control the database connectivity. Default settings are: [db] dbHost = localhost dbName = dms dbUser = dms dbPass = dmspassword dbPort = default dbAdminUser = dmsadmin dbAdminPass = admin 5. Verify file access permissions on the KnowledgeTree folders.
41
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. To do this, use your Web browser to navigate to your KnowledgeTree installation; then, on the Login page, enter your KnowledgeTree username and your KnowledgeTree password. Click OK to log in.
Note: A default Admin user username admin and password admin is set up during installation. The default admin user login allows initial access to KnowledgeTree. This initial login has no relation to the two MySQL accounts created at installation.
8. Install the following external applications to enable file indexing.

Note: 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.
Unzip from http://www.info-zip.org/ (for bulk upload) zip from http://www.info-zip.org/ (for bulk download) Open Office from http://www.openoffice.org (for pdf generation) Java from http://www.sun.com (to run the Document Indexer)
9. Having installed the required applications, edit the following settings through KnowledgeTree's web interface, in DMS Administration - System Configuration: In General Settings, edit 'External Binaries' - allow external applications to be found In Search and Indexing Settings, edit 'OpenOffice' - allow KnowledgeTree to communicate with the OpenOffice server 10.Start OpenOffice as a server: 10.1.Start OpenOffice as a background task:
Note: For more information on starting OpenOffice as a background task, go to http://www.openoffice.org.
Unix: E.g. nohup soffice -headless -invisible -accept='socket,host=localhost,port=8100;urp' &
42
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/
43
Uninstalling KnowledgeTree
Part
IV
4
4.1
Uninstalling on Windows
This procedure uninstalls KnowledgeTree in a Windows environment.

Note: This chapter is not relevant for KnowledgeTreeLive, the hosted, on-demand (SaaS) version of KnowledgeTree Commercial on-premise. KnowledgeTreeLive requires no installation, upgrades, storage, firewalls, server infrastructure, or server configuration. For more information on migrating between KnowledgeTreeLive and KnowledgeTree on-premise, see the online KnowledgeTreeLive Quick Start Guide (download the PDF), or contact KnowledgeTree Sales.
*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. Click Start - Programs - KnowledgeTree Document Management System - Uninstall KnowledgeTree Document Management System. 2. 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.
To uninstall KnowledgeTree manually, on Windows, do the following: 1. Open Control Panel - Administrative Tools - Services. 2. Stop the following services; then, delete these services: KTOpenOffice KTLucene KTApache KTMySQL 3. Delete the KnowledgeTree directory - by default, this is at c:\program files\ktdms 4. Delete the Start menu entry.
Note: After performing the steps above, KnowledgeTree will still be listed as an entry in Add/Remove Programs, but any new version of KnowledgeTree that you install will be listed as a separate entry.
45
4.2
Uninstalling on Linux / Unix
This procedure uninstalls KnowledgeTree in a Linux/Unix environment.

Note: This chapter is not relevant for KnowledgeTreeLive, the hosted, on-demand (SaaS) version of KnowledgeTree Commercial on-premise. KnowledgeTreeLive requires no installation, upgrades, storage, firewalls, server infrastructure, or server configuration. For more information on migrating between KnowledgeTreeLive and KnowledgeTree on-premise, see the online KnowledgeTreeLive Quick Start Guide (download the PDF), or contact KnowledgeTree Sales.
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.
46
Setting up KnowledgeTree
Part
Setting up KnowledgeTree
Instructions for administrators tasked with setting up KnowledgeTree for use in the organization are provided in the KnowledgeTree Administrator Manual, which provides a high level walk-through of the system tasks that are performed after installing or upgrading KnowledgeTree.
Note: The steps for setting up KnowledgeTreeLive are slightly different to setting up KnowledgeTree onpremise. This is because many of the server-related settings that must be defined for KnowledgeTree on-premise are pre-configured for KnowledgeTreeLive. For information on the steps to perform to set up your system for your KnowledgeTreeLive account, see the online KnowledgeTreeLive Quick Start Guide ( download the PDF). Note: Instructions for users are documented in the KnowledgeTree User Manual.
5.1
View Demo - Getting Started
This topic presents - in the online documentation only - an inline, guided demo of the first steps to setting up KnowledgeTree.
Note: The steps for setting up KnowledgeTreeLive are slightly different to setting up KnowledgeTree onpremise. This is because many of the server-related settings that must be defined for KnowledgeTree on-premise are pre-configured for KnowledgeTreeLive. For information on the steps to perform to set up your system for your KnowledgeTreeLive account, see the online KnowledgeTreeLive Quick Start Guide ( download the PDF).
Note: This is a flash file. Use the movie controls located at the top left of the movie screen to play, pause, or stop the demo. Click anywhere on the movie screen to move past the Text boxes. If you are viewing this topic in the PDF document and want to watch the demo, you can find KnowledgeTree's online documentation, including this document, at http://www.knowledgetree.com/resources.
Contents of this Demo: The KnowledgeTree Dashboard - Admin user About configuring Email About WebDAV access About KnowledgeTree Commercial How to install your KnowledgeTree Commercial License Where to enable and disable Plugins Configuring Email Adding users and groups, and adding users to groups Adding documents and folders, and different methods of bulk importing content, with an example Bulk Upload Assign permissions Logging out as admin, and logging on as a normal, non-admin user to work with folders and files The KnowledgeTree Dashboard - Non-admin user Edit document metadata - add tags and view in the Tag cloud Setting up RSS Feeds to external content (e.g. RSS from the KnowledgeTree website) Subscribing to internal folders
48
Setting up KnowledgeTree Adding Quicklinks Next steps
49
Troubleshooting
Part
VI
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. 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
51
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? Try the following:

Review the Release Notes for your version for the latest upgrade/install notes. Request assistance from KnowledgeTree Support Commercial Editions Only
Note: See the KnowledgeTree Wiki for more information on Getting Support.
Use KnowledgeTree's Issue Management System to request new features, or tell us about an error. How do I use KnowledgeTree's Issue Management System? Post your questions (and answers) at the KnowledgeTree Community Forum.
52
Index
53
Index
-AAdd Scheduler for Source Only Installs 15, 26 to the Nix Cron 15, 26 to Windows Task Scheduler 15, 26 Add-ins 8, 9, 10 Automating Database Backup 32, 34
KnowledgeTree Commercial
5, 6, 10
-IIndexing Reschedule 35 Installing KnowledgeTree 16, 20, 35, 38 Commercial edition 12, 15, 16, 18 Community edition 15, 16, 22, 27, 37, 51 Source only package 15, 27, 37, 40
-KKnowledgeTree 27, 29 Client Tools 8, 9, 10 Client Tools for Windows 8, 9, 10 Commercial edition 6, 8, 10, 11, 12 Commercial features 10 Community Forum 5, 6 Demo 15, 48 Documentation 5 Download 12, 15, 16, 18, 20, 22, 31, 35, 37, 38, 40, 45 Drop Box 8, 9, 10 Editions 8 Explorer 8, 9, 10 Help 5, 6 Installing 12, 15, 16, 18, 20, 22, 27, 35, 38 License 11, 12 Linux 15, 16, 33, 34, 46 Migrating 34, 35 Office Add-in 8, 9, 10 Open source 2, 6, 8 Outlook Integration 8, 9, 10 Release notes 5, 6 Setting up 48 Stack 15 Support 6, 10 System requirements 16 Upgrading 31, 32, 33, 34, 35, 37, 40 Wiki 5, 6 KnowledgeTree Client Tools Documentation 5, 9 for Windows 8, 9, 10 KnowledgeTree Commercial Client Tools 8, 9, 10 Download 15, 31 Editions 8 11, 12
-BBackup 35 Application 32, 33, 34 Automating 32, 34 Best practice 32 Database 31, 32, 33, 34 Documents 32, 34 on Linux 33, 34 on Windows 32
-DDatabase backup 32, 33, 34 Demo Getting started 48 Installing KnowledgeTree 15 Download KnowledgeTree 15, 31
-FFeatures Forums 2, 10 6
-GGetting started 15, 48
-HHelp About 5 Getting help 6
2008, 2009 KnowledgeTree Inc.
54
KnowledgeTree 3.6.1 Installation and Upgrade Guide 11, 12 Logging issues 6 16
KnowledgeTree Commercial Features 8, 10 Support 6 Trial download 2, 15
System Requirements Source Only Install Stack Install 16
KnowledgeTree Drop Box 8, 9, 10 KnowledgeTree Editions 2, 8 KnowledgeTree Explorer 8, 9, 10 KnowledgeTree Hot Folders 8, 9, 10 KnowledgeTree Office Add-in 8, 9, 10
-TTroubleshooting 6, 16, 27 Browser error 51 Database Incompatible Error Message 51 Fatal Error in dispatcher.inc.php 51 Fatal Error in Permission.inc 51 File type not resolved correctly 51 Memory Allocation Error 51 Some Functionality not available after upgrade 51 Upgrade Failure 51
-LLicense 8 Add new 12 Expiry 11, 12 Installing 12 Managing 11, 12 Purchase 11 Viewing 12 Linux 46 Installing on Login 27, 29 15, 16, 33, 34
-UUninstalling KnowledgeTree on Linux 45 on Windows 45 46 Upgrading 5, 6 Backup 32, 33 Commercial edition 31 Community edition 31, 37, 38, 40 Database 31, 32, 33, 34, 37, 40 Failure 31 Manually 27, 31, 37, 40 Notes 31 on Linux 31, 35, 38 Restore 32, 33 Source Only package 27, 31, 37, 40
-MMicrosoft Windows Migrating 34, 35 2, 15, 32, 34, 45
-QQuick start 2, 5, 6, 15, 48
-RRelease notes 5, 6 Restore 31, 32, 33, 34, 51 Source Only database 37
-VVideo Getting started Installing 15 48
-SSource Only Installs 15, 26, 27 SSL 15, 16, 18, 20, 22, 27, 31, 35, 38, 48, 51 Stack Installers 2, 15, 16, 18, 31, 34, 35, 38 Apache 15 MySQL 15 Starting KnowledgeTree Support 5, 8, 10 27
2008, 2009 KnowledgeTree Inc.

Knowledgetree Installation and Upgrade Guide

Hochgeladen von

Dokumentinformationen

Originalbeschreibung:

Copyright

Verfügbare Formate

Dieses Dokument teilen

Dokument teilen oder einbetten

Freigabeoptionen

Stufen Sie dieses Dokument als nützlich ein?

Sind diese Inhalte unangemessen?

Copyright:

Verfügbare Formate

Knowledgetree Installation and Upgrade Guide

Hochgeladen von

Copyright:

Verfügbare Formate

Installation and Upgrade Guide

KnowledgeTree 3.6.1 Installation and Upgrade Guide

Viewing / ......................................................................................................................................................... 12 Adding License Keys Part II Installing KnowledgeTree 15

Running ......................................................................................................................................................... 18 the KnowledgeTree Commercial Stack Installer

Part III Upgrading KnowledgeTree

................................................................................................................................... 32 Backing up and Restoring

KnowledgeTree 3.6.1 Installation and Upgrade Guide - 09 September 2009

KnowledgeTree 3.6.1 Installation and Upgrade Guide

................................................................................................................................... 34 Migrating your KnowledgeTree Installation

Indexing ......................................................................................................................................................... 35 Migrated Content

Part IV Uninstalling KnowledgeTree

Part V Setting up KnowledgeTree

................................................................................................................................... 48 View Demo - Getting Started

KnowledgeTree 3.6.1 Installation and Upgrade Guide - 09 September 2009

KnowledgeTree 3.6.1 Installation and Upgrade Guide 09 September 2009

KnowledgeTree web interface dashboard

See Also: KnowledgeTree KnowledgeTree KnowledgeTree KnowledgeTree

KnowledgeTree 3.6.1 Installation and Upgrade Guide 09 September 2009

What's New in KnowledgeTree 3.6.x

KnowledgeTree version 3.6.x includes the following new functionality:

KnowledgeTree 3.6.1 Installation and Upgrade Guide 09 September 2009

About this Help

KnowledgeTree 3.6.1 Installation and Upgrade Guide 09 September 2009

This Help is intended for use by an experienced system administrator.

Getting Help for KnowledgeTree

KnowledgeTree 3.6.1 Installation and Upgrade Guide 09 September 2009

Don't see what you're looking for?

KnowledgeTree 3.6.1 Installation and Upgrade Guide 09 September 2009

KnowledgeTree Community Edition

KnowledgeTree 3.6.1 Installation and Upgrade Guide 09 September 2009

KnowledgeTree Client Tools

The KnowledgeTree Client Tools include:

KnowledgeTree 3.6.1 Installation and Upgrade Guide 09 September 2009

KnowledgeTree Commercial Features

KnowledgeTree Commercial Tools and Add-ins KnowledgeTree Tools for Windows

KnowledgeTree 3.6.1 Installation and Upgrade Guide 09 September 2009

See Also: The KnowledgeTree Plugins Index on the KnowledgeTree Wiki

KnowledgeTree Commercial License

KnowledgeTree 3.6.1 Installation and Upgrade Guide 09 September 2009

Viewing / Adding License Keys

KnowledgeTree 3.6.1 Installation and Upgrade Guide 09 September 2009

KnowledgeTree 3.6.1 Installation and Upgrade Guide 09 September 2009

View Demo - Installing KnowledgeTree

KnowledgeTree 3.6.1 Installation and Upgrade Guide 09 September 2009

Linux Install Notes

Installing KnowledgeTree Commercial Edition

KnowledgeTree 3.6.1 Installation and Upgrade Guide 09 September 2009

7. Configure KnowledgeTree for use in your organization.

KnowledgeTree 3.6.1 Installation and Upgrade Guide 09 September 2009

Running the KnowledgeTree Commercial Stack Installer

KnowledgeTree 3.6.1 Installation and Upgrade Guide 09 September 2009

KnowledgeTree 3.6.1 Installation and Upgrade Guide 09 September 2009

Installing KnowledgeTree Community Edition - Stack Install

Perform the following steps:

KnowledgeTree 3.6.1 Installation and Upgrade Guide 09 September 2009

KnowledgeTree 3.6.1 Installation and Upgrade Guide 09 September 2009

Installing KnowledgeTree Community Edition - Source Only Install

KnowledgeTree 3.6.1 Installation and Upgrade Guide 09 September 2009

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

KnowledgeTree 3.6.1 Installation and Upgrade Guide 09 September 2009

dbPort dbAdminUser dbAdminPass

= default = dmsadmin = admin

KnowledgeTree 3.6.1 Installation and Upgrade Guide 09 September 2009