Recommended configuration parameters
There are some recommended changes to 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 mail notification body. Message: ${notificationMessage} User: ${userId} <#list documentList as doc>Document: ${doc.path} |
|
notification.message.subject |
Text |
This parameter is used in mail notifications. It helps users identify that these emails are coming from OpenKM. OpenKM - NOTIFICATION |
|
subscription.message.enabled |
Boolean |
Determines whether the subscription is evaluated and the message is sent. It is enabled by default, 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 mail user subscription notification body. 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 mail subscription notification subject. It helps users identify that these emails are coming from OpenKM. OpenKM - ${eventType} - ${documentPath} |
|
text.extraction.concurrent |
Boolean |
Enables or disables concurrent text extraction threads.
|
|
text.extraction.batch |
Integer |
It indicates the number of documents processed in each indexing cycle. When parameter "text.extraction.concurrent" is enabled, it is good practice to set a multiple of the "text.extraction.threads" value. |
|
text.extraction.threads |
Integer |
The 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. |
|
mail.extraction.concurrent |
Boolean
|
Enables or disables concurrent mail extraction threads.
|
|
mail.extraction.batch |
Integer |
It indicates the number of emails processed in each indexing cycle. When parameter "mail.extraction.concurrent" is enabled, it is good practice to set a multiple of the "mail.extraction.threads" value. |
|
mail.extraction.threads |
Integer |
The 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 the ImageMagick convert tool. |
|
system.ocr |
String |
Path to the OCR text extractor engine. |
|
system.openoffice.program |
String |
Path to the LibreOffice installation. |
|
logo.login |
File |
Logo for the login page. It automatically tries to resize the image to 316px × 74px (suggested background #F1F3F5). |
|
logo.mobile |
File |
Logo for the mobile login page. It automatically tries to resize the image to 161px × 38px (suggested background #F1F3F5). |
|
logo.report |
File |
The default logo used in JasperReports. It automatically tries to resize the image to 150px × 35px (suggested background #FFF000). |
|
logo.favicon |
File |
Small icon on the left side of the browser's address bar. The uploaded file must be a valid icon (16px x 16px). |
