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.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} |
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 |
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.concurrent |
Boolean |
Enable or disable concurrent text extraction concurrent threads. |
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. |
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 ). |