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 mail notifications body. Message: ${notificationMessage} User: ${userId} <#list documentList as doc>Document: ${doc.path} |
|
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.enabled |
Boolean |
Whether the suscription is evaluated and the message is sent or not. By default is enabled, but in case of massive document import we recommend to disable it to avoid performance issues. |
|
subscription.message.body |
HTML |
This parameter is used in 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 mail subscription notification subject. Help users identify that these emails are coming from OpenKM. OpenKM - ${eventType} - ${documentPath} |
|
text.extraction.concurrent |
Boolean |
Enable or disable concurrent text extraction concurrent threads. |
|
text.extraction.batch |
Integer |
It indicates the number of documents being processed on each indexing cycle. When parameter "text.extraction.concurrent" is enabled, is a good practice to set multiple of "text.extraction.threads" value. |
|
text.extraction.threads |
Integer |
Number of concurrent threads that will be used for text extraction. It's a good practice to set this number to be less or equal than 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 mail extraction concurrent threads. |
|
mail.extraction.batch |
Integer |
It indicates the number of mails being processed on each indexing cycle. When parameter "mail.extraction.concurrent" is enabled, is a good practice to set multiple of "mail.extraction.threads" value. |
|
mail.extraction.threads |
Integer |
Number of concurrent threads that will be used for mail extraction. It's a good practice to set this number to be less or equal than CPU cores you want to use for mail extraction. |
|
system.imagemagick.convert |
String |
Path to ImageMagick convert tool. |
|
system.ocr |
String |
Path to OCR text extractor engine. |
|
system.openoffice.program |
String |
Path to the LibreOffice executable. |
|
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 ). |
