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, but obviously you don't want to access your OpenKM installation only from localhost. |
|
notification.message.body |
HTML |
This parameter is used in the body of mail notifications. Message: ${notificationMessage} User: ${userId} <#list documentList as doc>Document: ${doc.path} |
|
notification.message.subject |
Text |
This parameter is used in the subject of mail notifications. It helps users identify that these emails are coming from OpenKM. OpenKM - NOTIFICATION |
|
subscription.message.enabled |
Boolean |
Whether the subscription is evaluated and the message is sent. By default it is enabled, but in case of massive document import we recommend disabling it to avoid performance issues. |
|
subscription.message.body |
HTML |
This parameter is used in the body of mail user subscription notifications. Date: ${eventDate?string("yyyy-MM-dd HH:mm:ss")} Document: ${documentPath} User: ${userId} Event: ${eventType} Comment: ${subscriptionComment} |
|
subscription.message.subject |
Text |
This parameter is used in the subject of mail subscription notifications. It helps users identify that these emails are coming from OpenKM. OpenKM - ${eventType} - ${documentPath} |
|
text.extraction.concurrent |
Boolean |
Enable or disable concurrent threads for text extraction. |
|
text.extraction.batch |
Integer |
It indicates the number of documents being processed on each indexing cycle. When parameter "text.extraction.concurrent" is enabled, it is good practice to set it to a multiple of the "text.extraction.threads" value. |
|
text.extraction.threads |
Integer |
Number of concurrent threads that will be used for text extraction. It's good practice to set this number to be less than or equal to the number of CPU cores you want to use for text extraction. |
|
text.extraction.min.size |
Integer |
Specify the minimum number of characters required to consider a text extraction successful. |
|
mail.extraction.concurrent |
Boolean |
Enable or disable concurrent threads for mail extraction. |
|
mail.extraction.batch |
Integer |
It indicates the number of emails being processed on each indexing cycle. When parameter "mail.extraction.concurrent" is enabled, it is good practice to set it to a multiple of the "mail.extraction.threads" value. |
|
mail.extraction.threads |
Integer |
Number of concurrent threads that will be used for mail extraction. It's good practice to set this number to be less than or equal to the number of CPU cores you want to use for mail extraction. |
|
system.imagemagick.convert |
String |
Path to ImageMagick convert tool. |
|
system.ocr |
String |
Path to the OCR text extractor engine. |
|
system.openoffice.program |
String |
Path to the LibreOffice executable. |
|
logo.login |
File |
Login page logo. It automatically tries to resize the image to 316px × 74px (suggested background #F1F3F5). |
|
logo.mobile |
File |
Mobile login page logo. It automatically tries to resize the image to 161px × 38px (suggested background #F1F3F5). |
|
logo.report |
File |
Default logo used in Jasper Reports. It automatically tries to resize the image to 150px × 35px (suggested background #FFF000). |
|
logo.tiny |
File |
Small logo at the top right corner in the frontend UI. It automatically tries to resize the image to 51px × 13px (suggested background: transparent). |
|
logo.favicon |
File |
Small icon on the left side of the browser URL. The uploaded file must be a valid icon (16px × 16px). |
