Skip to content

Experimental configuration parameters

Property Type Description
unit.testing.folder String Folder path used for unit testing.
/okm:root/okmTesting
unit.testing.user String Username for unit testing.
okmAdmin
unit.testing.password String Password for unit testing user.
admin
unit.testing.url.base String Base URL for unit testing.
http://localhost:8080/openkm/
extension.digicert.base.path String OpenKM base folder path.
/okm:root/invoices
extension.digicert.keystore.file String Keystore file path.
/home/openkm/certificate.p12
extension.digicert.keystore.password String Keystore password.
extension.digicert.keystore.type String Keystore type (JKS or PKCS12).
JKS
extension.digicert.private.key.alias String Certificate alias.
b138bef79c0104378101b77b71922c61_9463f621-75bc-4ff7-b832-08ea82e57a16
extension.digicert.signature.algorithm String Certificate signature algorithm.
rsa
extension.digicert.type String Values can be “month” or “quarterly”.
month
extension.digicert.upload.base.path String OpenKM path where the documents are uploaded.
/okm:root/invoices/upload
extension.digicert.validate.properties String Metadata group fields to validate.
okp:digicert.num.recepcion
okp:digicert.num.factura
okp:digicert.fecha.factura
okp:digicert.nif.emisor
okp:digicert.iva.general
okp:digicert.iva.reducido
okp:digicert.iva.superreducido
okp:digicert.base.general
okp:digicert.base.reducido
okp:digicert.base.superreducido
okp:digicert.base.siniva
okp:digicert.total
okp:digicert.year
okp:digicert.period
rss.news.max.size Integer Maximum number of news items retrieved from the news server.
10
News items are cached by the OpenKM server and refreshed once per day. That means any change to this parameter will take effect tomorrow or after restarting the OpenKM service.
check.node.deletion.integrity Boolean Enable or disable node deletion integrity check. When enabled, it prevents deletion of nodes that are in use by workflows or have children in use (for folders or records). This is enabled by default and should only be disabled when performing mass node deletion operations.
okm.content.security.policy String By default, embedding the application in an iframe is only allowed from the same origin, as required by the web UI. Default value:
frame-ancestors ‘self’
To enable additional domains, use the following example:
frame-ancestors ‘self’ http://example.com
The configuration parameter must be set in the openkm.properties file and the OpenKM service must be restarted to take effect.
More information about content security policy: https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Content-Security-Policy
okm.cors.configuration.policy String By default, CORS is enabled for all origins, methods, and headers. This is the default value:
[{“path”:“/rest/**”, “origins”:[“*”], “methods”:[“*”], “headers”:[“*”]}, {“path”:“/**”, “origins”:[“*”], “methods”:[“*”], “headers”:[“*”]}]
To enable REST API access for specific domains only, use the following example:
[{“path”:“/rest/**”, “origins”:[“http://domain.com","https://domain.com","http://domain2.com","https://domain2.com"\], “methods”:[“*”], “headers”:[“*”]}, {“path”:“/**”, “origins”:[“http://localhost"\], “methods”:[“*”], “headers”:[“*”]}]
The configuration parameter must be set in the openkm.properties file and the OpenKM service must be restarted to take effect.
The String value is a list of objects in JSON format. The order of these rules is relevant because internally the first match will be applied; that means the path “/**” should always be applied at the end.
More information about CORS at: https://developer.mozilla.org/en-US/docs/Web/HTTP/CORS
ldap.ignore.partial.result.exception Boolean When using Active Directory integration, PartialResultException warnings are displayed in the log by default. Setting this to true suppresses these warnings in the log.
true
okm.authentication.external.authentication String Enable OpenKM external authentication. This feature allows the application to be authenticated by third-party providers like OAuth, Azure Cloud, and others.
okm.authentication.external.authentication=http://localhost:8081/ext-auth
rest.client.call.timeout String Maximum timeout in seconds for REST requests made by OpenKM to third-party applications (e.g., jbpm-console).
15
optimized.thumbnail.generation Boolean Enables optimized thumbnail generation method. Recommended when using PDF Tools or Stamp features.
true
pdf.viewer.concurrency Integer Maximum number of concurrent PDF page renders for the interactive per-page viewer (the /rest/pdf/{uuid}/{page}/image endpoint). Bounds the concurrent in-memory image buffers so a burst of requests can’t exhaust the heap.
Number of available processors
pdf.thumbnail.concurrency Integer Same idea but for document preview/thumbnail-cache generation (e.g. folder listing, search results). Kept as a separate limit from pdf.viewer.concurrency so a burst of one kind of request can’t starve the other.
Number of available processors
security.database-query.enabled Boolean Enables DatabaseQuery functionality in the administration interface. When enabled, administrators can execute custom database queries.
false
security.scripting.enabled Boolean Enables Scripting functionality in the administration interface. When enabled, administrators can execute custom scripts.
false
security.script-validation.enabled Boolean Enables validation of scripting statements executed in Scripting. When enabled, scripts are validated before execution to prevent potentially harmful operations.
true
security.sql-validation.enabled Boolean Enables validation of SQL statements executed in DatabaseQuery. When enabled, SQL queries are validated before execution to prevent potentially harmful operations.
true