Recommended configuration parameters
There are some recommended changes in the configuration:
| Field / Property | Type | Description |
|---|---|---|
|
application.url |
String |
This parameter is used in mail notifications and the copy-to-clipboard feature among others. By default OpenKM sets the access URL to http://localhost:8080/OpenKM/index.jsp, but obviously you don't want to access your OpenKM installation only from localhost. |
|
notification.message.body |
HTML |
This parameter is used in mail notifications body. <b>Message: </b>${notificationMessage}<br/>
<b>User: </b>${userId}<br/> <#list documentList as doc><b>Document: </b><a href="${doc.url}">${doc.path}</a><br/></#list> |
|
notification.message.subject |
Text |
This parameter is used in mail notifications subject. Help users identify that these emails are coming from OpenKM. OpenKM - NOTIFICATION |
|
subscription.message.body |
HTML |
This parameter is used in mail user subscription notification body. <b>Document: </b>
<a href="${documentUrl}">${documentPath}</a><br/> <b>User: </b>${userId}<br/><b>Event: </b>${eventType}<br/> <b>Comment: </b>${subscriptionComment}<br/> |
|
subscription.message.subject |
Text |
This parameter is used in mail subscription notification subject. Help users identify that these emails are coming from OpenKM. OpenKM - ${eventType} - ${documentPath} |
|
max.file.size |
String |
It indicates the maximum allowed file size which can be uploaded to OpenKM. Default value is 0 indicates unlimited. Use size units with KB, MB, GB or TB, otherwise value will be considered as bytes. 200MB |
|
managed.text.extraction |
Boolean |
Enable or disable. |
|
managed.text.extraction.batch |
Integer |
It indicates the number of documents being processed on each indexing cycle. When parameter "managed.text.extraction.concurrent" is enabled, is a good practice to set multiple of "managed.text.extraction.pool.threads" value. |
|
managed.text.extraction.concurrent |
Boolean |
Enable or disable concurrent text extraction concurrent threads. |
|
managed.text.extraction.pool.size |
Integer |
How many threads are launched concurrently every time. This number should be smaller or equal to the number of CPUs in the server. |
|
managed.text.extraction.pool.threads |
Integer |
Number of concurrent threads that will be used for text extraction. If "managed.text.extraction.pool.size" is 8 and "managed.text.extraction.pool.threads" is set to 16 then all these 16 threads will be launched using this pool. If every task take the same time to complete, in theory every pool thread will execute two tasks. Of course this is not true in the real world. It's a good practice to set this number to be less or equal than CPU cores you want to use for text extraction. |
|
managed.text.extraction.pool.timeout |
Integer |
How many minutes should the worker wait for the text extraction pool to complete the tasks. After these minutes, the remaining pool threads are interrupted. |
|
system.imagemagick.convert |
String |
Path to ImageMagick convert tool. |
|
system.ocr |
String |
Path to OCR text extractor engine. |
|
system.swftools.pdf2swf |
String |
Path to pd2swf conversion tool. |
|
system.openoffice.path |
String |
Path to OpenOffice or LibreOffice installation. |
|
logo.login |
File |
Login page logo. It automatically tries to resize image to 316px × 74px (suggested background #F1F3F5). |
|
logo.mobile |
File |
Mobile login page logo. It automatically tries to resize image to 161px × 38px (suggested background #F1F3F5). |
|
logo.report |
File |
Default logo used in Jasper Reports. It automatically tries to resize image to 150px × 35px (suggested background #FFF000). |
|
logo.tiny |
File |
Small logo at top right corner in frontend UI. It automatically tries to resize image to 51px × 13px ( suggested background transparent). |
|
logo.favicon |
File |
Small icon in left side of browser url. The uploaded file must be a valid icon ( 16px x 16px ). |