3rd Party Services

From KnowledgeTree Document Management Made Simple

KnowledgeTree requires a number of 3rd-party services for document indexing, search and conversion. The following steps detail how to configure these services for a KnowledgeTree 3.7 Community Edition Source Only installation.

1. 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.

• 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)
• OpenOffice.org – from http://www.openoffice.org (for pdf generation and document comparison)
• Java – from http://www.sun.com (to run the Document Indexer)
• ImageMagick – from http://www.imagemagick.org/script/index.php (for Thumbnail creation)
• GhostScript – from http://pages.cs.wisc.edu/~ghost/ (required by ImageMagick for reading of PDF files used to create thumbnails)

2. In your Web browser, log in to your KnowledgeTree. Go to Administration -> System Configuration -> General Settings to configure the following things:

• externalBinary - allow external applications to be found

3. Start OpenOffice.org as a server:

a) Are you installing on Unix/Linux?

• Yes. If you are using OpenOffice.org 2.0 - 2.3 and do not have X Windows, the Xvfb virtual display daemon is required to start OpenOffice.org.

$ Xvfb -screen 0 800x600x16 -nolisten tcp -auth /path/to/auth-file &

Note: Please consult the documentation on Xvfb for more details on usage for your operating system. You may want to make sure that only OpenOffice.org can connect to the Xserver (hence the -auth option)

• No. Go to step 9.

b) Start OpenOffice.org as a background task:

Unix/Linux:
OpenOffice 2.0 - 2.2:
$ nohup soffice -invisible -accept='socket,host=localhost,port=8100;urp' -display :0 &
OpenOffice 2.3+:
$ nohup soffice.bin -headless -accept='socket,host=localhost,port=8100;urp' &

Windows:
X:\> 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.org as a background task, go to [1].

4. 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:

Unix/Linux:  Edit the cron. To do this, add the following: 
*/5 * * * * /path_to_php/php /opt/ktdms/knowledgeTree/bin/scheduler.php > /dev/null
to the crontab of the user running knowledgetree (the web server) or use /etc/cron.d or /etc/crontab if more appropriate on your system.

Windows:  Configure the Windows Scheduler to run the script in the background once a minute.

5. Start the Document Indexer:

Unix/Linux:  
$ cd /opt/ktdms/knowledgeTree/bin/luceneserver
You may need to tweak the settings in KnowledgeTreeIndexer.properties
$ 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/