|
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. |
Perform the following steps:
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:
Operating System
|
Tasks
|
Unix-based
|
Step 1: Create a database
$ mysqladmin -p create dms
|
Step 2: Create and populate the tables
$ mysql -p dms < sql/mysql/install/structure.sql
$ mysql -p dms < sql/mysql/install/data.sql
|
Step 3: Create the database users
$ mysql -p dms < sql/mysql/install/user.sql
|
Windows
|
Note: Locate the MySQL applications on your system; then, use the path to
these applications in the commands below.
|
Step 1: Create a database
x:\> mysqladmin -u root -p create dms
|
Step 2: Create and populate the tables
X:\> mysql -u root -p dms < sql/mysql/install/structure.sql
X:\> mysql -u root -p dms < sql/mysql/install/data.sql
|
Step 3: Create the database users
$ mysql -u root -p dms < sql/mysql/install/user.sql
|
| 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
dbPort = default
dbAdminUser = dmsadmin
dbAdminPass = 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
|
’chown -R nobody.nogroup var'
|
Windows
|
Check the folder’s 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. |
Note: KnowledgeTree’s file indexing and other features require the use of external
programs. We recommend that you use the package and configuration management
facilities of your operating environment to install these applications – for example,
using the rpm or apt-get tools on Linux systems. Indexing is automatically installed
when you install KnowledgeTree Community Edition using the Community Edition
Stack Installer. You can download the Community Edition Stack Installer at the
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 ...
|
do the following ...
|
Unix
|
e.g.nohup soffice-headless-invisible-accept='socket,host=localhost,port=8100;urp' &
|
Windows
|
e.g. soffice -headless-invisible-accept='socket,host=localhost,port=8100;urp'
Change the port as required and ensure that it corresponds with the config.ini setting.
|
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 800×600x16 & |
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 ...
|
do the following ...
|
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.
|
| 11. | Start the Document Indexer: |
On ...
|
do the following ...
|
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.
Alternatively, to run the Document Indexer as a background service, use the JavaService wrapper from http://forge.objectweb.org/projects/javaservice/
|
| 
