Configuring KnowledgeTree | KnowledgeTree Document Management Software

Configuring KnowledgeTree

This topic describes the parameters and values in KnowledgeTree's config.ini file, located in the KnowledgeTree folder.

The config.ini file contains the configuration settings for all KnowledgeTree Document Management System installations (Windows or Linux). Settings in the config.ini file may be changed in any text editor, such as Notepad. All values in the file are editable. Please note that some sections are marked as 'reserved for future development'.

Note: We recommend that only authorized, experienced administrative users should attempt to change settings in config.ini. Incorrect configurations may introduce errors in your system.

Important

Recommended minimum configuration changes

•	[db]- change the default user name and password

•	[email] - used to enable email notifications (requires setting the SMTP server)

Configuration Settings

[db]

The database engine. You will need to change at least some of these settings (such as the default username and password, which are created automatically during installation).

•	Database type

Note: Currently, (January 2008), MySQL is the only supported database

type.

dbType = mysql

•	Database Login Details

Note: These are the MySQL database usernames and passwords. You may need this

information when backing up your database or upgrading. Passwords are user-defined

during installation; passwords displayed below are therefore example values only.

Database host details

dbHost = localhost

dbName = dms

dbPort = default

Unprivileged Database User

dbUser = dms

dbPass = 16H56d

Privileged Database User

dbAdminUser = dmsadmin

dbAdminPass = 052ad

[KnowledgeTree]

KnowledgeTree automatically detects the default settings in this section. Do not change these settings manually unless you understand the consequences of your actions. Changing these settings incorrectly may introduce errors into your system.

•	The path to the install location for KnowledgeTree on your system

Note: Leave the default to have this automatically detected.

fileSystemRoot = default

•	The Web server name (host name)

Note: Leave the default to have this automatically detected.

serverName = default

•	Defines whether or not SSL is enabled

Note: Leave the default to have this automatically detected.

sslEnabled = default

•	The path to the Web application from the root of the web site -

i.e. if KnowledgeTree is at http://example.org/foo/, then rootUrl should be '/foo'

Note: Leave the default to have this automatically detected.

rootUrl = default

•	Defines whether the platform supports PATH_INFO

Provides improved file identification support on *nix systems - not necessary if

you use file extensions.

The current default is true.

pathInfoSupport = default

•	The location of binaries on your system

The default is to the path set for your Web server; this works for Unix-like

systems, but may require changes for Windows systems.

execSearchPath = default

•	Defines whether to use the new Dashboard.

The default is true.

useNewDashboard = true

•	The level of logging to use - DEBUG, INFO, WARN, ERROR

Note: By default, this option is not enabled in the system; logLevel is commented out in

the config.ini file, and is typically only activated for troubleshooting and support purposes.

The default is INFO.

logLevel = DEBUG

•	Defines the location of the mime magic file.

The default is /usr/share/file/magic

magicDatabase = default

[dashboard]

•	Whether to display the 'Your Checked out Documents' dashlet, even when empty.

The default is false.

alwayShowYCOD = false

[storage]

•	The storage manager to use for the storage of documents on the file system

The default is KTOnDiskHashedStorageManager

manager = default

[ui]

•	OEM application name

appName = ACME

•	Enable Morph

morphEnabled = 1

•	Morph Theme

morphTo = blue

•	The location of the company logo - the custom logo you add to the interface

The Logo must be 50px tall, on a white background

companyLogo = ${rootUrl}/resources/companylogo.png

•	The width of the logo, in pixels

companyLogoWidth = 313px

•	Alternative text for the logo, for accessibility purposes

companyLogoTitle = ACME Corporation

•

Main logo

mainLogo = ${rootUrl}/resources/oemlogo.png

•	Main logo width, in pixels

mainLogoWidth = 219px

•	Main logo alternative text, for accessibility purposes

mainLogoTitle = ACME Knowledge Management Systems

•	The location of the 'Powered by KnowledgeTree' logo

powerLogo = ${rootUrl}/resources/powered-by-kt.gif

•	Powered by KnowledgeTree, logo's width in pixels

powerLogoWidth = 130px

•	'Powered by KnowledgeTree', alternative text for accessibility purposes

powerLogoTitle = Powered by KnowledgeTree

•	IE-specific GIF theme overrides

Using the additional IE-specific GIF theme overrides may prevent

arbitrary theme packs from working without having GIF versions available.

The default is true.

ieGIF = default

•	Do not restrict to searches on users and groups pages

e.g. always show_all

The default is false.

alwaysShowAll = default

•	Automatically Refresh the Page

Change this setting to true to automatically refresh the page after the session would

have expired.

The default is false.

automaticRefresh = default

•	Defines whether to use a condensed admin user interface

Note: The condensed administrative interface is a more compact version of the

administrative interface.

The default is false.

condensedAdminUI = default

•	Defines whether to allow browsers from allowing 'open' from download

Note: Changing this setting to true will prevent (most) browsers from giving users the

option to 'open' from downloads.

The default is false.

fakeMimetype = default

•	'dot' command location

On Unix system, to determine whether the 'dot' application is installed.

dot = dot

•	Defines whether to sort metadata fields alphabetically

metadata_sort = true

[i18n]

Internationalization.

•	The default language for the interface.

The default is English (en).

defaultLanguage = en

•	Search Ideographic Language

If your language does not have distinguishable words (typically, there is no space

character), change this setting to true to enable the Search function capable

of dealing with this issue - please note that this Search is effective, but slower.

The default is false.

useLike = default

[tweaks]

•	Enabling PHP Error Logging

Change this setting to true to enable PHP error logging to the

log/php_error_log file.

phpErrorLogFile = false

•	The folder that opens when the user clicks on the Browse Documents tab

Change this setting to true to allow the user to go directly to their Unit folder

when clicking 'Browse Documents'.

The default (false) displays the root folder (the first Unit).

browseToUnitFolder = false

•	Whether bulk operations should generate a transaction notice on each item, or only on the folder.

The default (false) indicates that only the folder transaction should occur.

noisyBulkOperations = false

[email]

Defines email settings and enables the email feature for your installation of KnowledgeTree.

•	SMTP server

Your mail server address.

The default is none.

emailServer = none

•	SMTP server port

The default is 25.

emailPort = default

•	Whether authentication is required for connecting to SMTP

Note: Changing emailAuthentication to true forces the user to log in using their user

name and password.

emailAuthentication = false

emailUsername = username

emailPassword = password

•	The sending email address for mail sent by KnowledgeTree

emailFrom = kt@example.org

•	The name used by KnowledgeTree when sending mail.

emailFromName = KnowledgeTree Document Management System

•	Sending attachments from the DMS

Change this setting to true to allow users to send attachments from the document

management system. The default is false.

allowAttachment = false

•	Allow sending of emails to any email address

Change this setting to true to allow KnowledgeTree system users to send email to any email address - to other KnowledgeTree users and to external users.

allowEmailAddresses = false

•	Always send mail from ...

Change this setting to true to always send email from the emailFrom address listed above, even if the sending user is identifiable. The default is false.

sendAsSystem = false

•	Users sending email only to their group

Set to true to enable onlyOwnGroups. The default is false.

onlyOwnGroups = false

[urls]

•	The directory where KnowledgeTree stores information - e.g. documents

Important: Do not change this setting unless you are an authorized and experienced

administrative user, and you understand the implications of changing this information.

Note: Values for these settings are specific to your installation - e.g. different on Windows

and Linux. Values shown below are thus examples only.

varDirectory = C:/Program Files/ktdms/var

logDirectory = ${varDirectory}/log

documentRoot = C:/Program Files/ktdms/Documents

uiDirectory = ${fileSystemRoot}/presentation/lookAndFeel/

knowledgeTree

tmpDirectory = ${varDirectory}/tmp

•	The location of all images used in KnowledgeTree

For example, the question mark used for the Help page.

graphicsUrl = ${rootUrl}/graphics

uiUrl = ${rootUrl}/presentation/lookAndFeel/knowledgeTree

•	The dedicated feed URL

dedicatedrsstitle = RSS Feed Title

dedicatedrssurl =

•

Files

stopwordsFile = ${fileSystemRoot}/config/stopwords.txt

[webservice]

•	The directory to which all uploads via webservices are persisted before moving into the repository.

uploadDirectory = ${varDirectory}/uploads

•	The prefix URL for webservice requests

This URL is sent to clients via web service calls to allow download files via HTTP

GET.

downloadUrl = ${rootUrl}/ktwebservice/download.php

•	The maximum time, in minutes, that is allowed to elapse between a file being uploaded, using web services, and that file being added using web services

The default is 30

uploadExpiry = 30

•	The maximum time, in minutes, that a web services generated URL (download link) remains valid.

The default is 30

downloadExpiry = 30

•	Random text, used to generate a hash for downloads using web services.

The text used in the following setting is an example. Any random combination of

letters, numbers and special characters can be used.

randomKeyText = bkdfjhg23yskjdhf2iu

•	validate session count

Validating session counts may interfere with access; best practice is to leave this

disabled, unless very strict access is required.

The default is false

validateSessionCount = false

•	Use default document type

Defines whether to default to the 'default document type' when documents are

uploaded and an invalid document type is specified. This is specifically relevant

to bulk uploads where the document type is predefined - e.g. uploads via

KnowledgeTree DWI Service (hot folders)

The default is true

useDefaultDocumentTypeIfInvalid = true

•	Webservice debugging

This setting must be added manually to generate debug log information.

Defines web service debugging if the logLevel is set to DEBUG. Setting the value

to 4 or 5 produces more verbose web service logging - level 4 logs the name of

functions being accessed; level 5 logs the SOAP XML requests and responses.

Used to turn Web Services debug logging on and off.

Note: logLevel=debug needs to be uncommented for the logging to work.

The default is false

debug = false

[session]

•	The period of time (in seconds) after which the system times out following a period of inactivity

sessionTimeout = 1200

•	Whether to automatically allow log in of users as Anonymous

The default is false.

Note: To protect your system, it is highly recommended that you do not change the

default to true to allow anonymous login, even if you understand KnowledgeTree

security, and you have sensibly applied the roles 'Everyone' and 'Authenticated ' Users.

allowAnonymousLogin = false

•	IP address for sessions

Change this setting to true if you want to force sessions to come from the same IP address.

The default is false.

ipTracking = false

[import]

•	Location of the unzip binary

The unzip command uses execSearchPath to find the location of your unzip binary, if the path to the binary is not given.

Values auto-populated for this setting are specific to your installation - i.e. Windows or Linux.

unzip = C:/Program Files/ktdms/bin/unzip/unzip.exe

[export]

•	Location of the zip binary

The zip command uses execSearchPath to find the location of your zip binary, if the path to the binary is not given.

Values auto-populated for this setting are specific to your installation - i.e. Windows or Linux.

zip = C:/Program Files/ktdms/bin/zip/zip.exe

•	Encoding to use in the bulk export plugin

The default is UTF-8

encoding = default

[externalBinary]

•	Various parts of KnowledgeTree may use the following external binaries.

xls2csv = C:/Program Files/ktdms/bin/catdoc/xls2csv.exe

pdftotext = C:/Program Files/ktdms/bin/xpdf/pdftotext.exe

catppt = C:/Program Files/ktdms/bin/catdoc/catppt.exe

pstotext = pstotext

catdoc = C:/Program Files/ktdms/bin/catdoc/catdoc.exe

antiword = antiword

python = python

java = C:/Program Files/ktdms/java/jre/bin/java.exe

php = C:/Program Files/ktdms/php/php.exe

df = C:/Program Files/ktdms/bin/gnuwin32/df.exe

[search]

•	The number of results per page

The default is 25

resultsPerPage = default

•	The date format used when making queries using widgets

The default is y-m-d

dateFormat = default

[indexer]

•	The core indexing class.

The default is JavaXMLRPCLuceneIndexer

coreClass=PHPLuceneIndexer

coreClass=JavaXMLRPCLuceneIndexer

•	The number of documents to be indexed by the KnowledgeTree scheduler in a single batch.

The default is 20.

batchDocuments = default

•	The number of documents to be migrated, using the migration script (run by KnowledgeTree scheduler) in a single batch.

The default is 500.

batchMigrateDocuments = default

•	The location of the KnowledgeTree Indexer.

luceneDirectory=${varDirectory}/indexes

•	The URL for the Java Lucene Server.

Make sure this points to the Lucene Server.

Defaults to http://localhost:8875 (this is the stack location for Lucene - automatic configuration)

javaLuceneURL = default

[openoffice] *Reserved for future development

•	The host on which OpenOffice is installed.

Make sure this points to the OpenOffice Server.

Defaults to OpenOffice address on the stack or wherever else you specify

Defaults to http://localhost:8100

host = default

•	The port on which OpenOffice is listening.

Defaults to 8100.

port = default

[user_prefs]