Experimental configuration parameters

PropertyTypeDescription

unit.testing.folder

String

Folder used by the testing process.

/okm:root/okmTesting

unit.testing.user

String

User used for unit testing.

okmAdmin

unit.testing.password

String

Password of the user used for unit testing.

admin

unit.testing.url.base

String

The unit test URL.

http://localhost:8080/openkm/

extension.digicert.base.path

String

OpenKM base folder:

/okm:root/invoices

extension.digicert.keystore.file

String

Path of the keystore file.

/home/openkm/certificate.p12

extension.digicert.keystore.password

String

The password of the keystore.

extension.digicert.keystore.type

String

The keystore type (JKS or PKCS12).

JKS

extension.digicert.private.key.alias

String

The alias of the certificate.

b138bef79c0104378101b77b71922c61_9463f621-75bc-4ff7-b832-08ea82e57a16

extension.digicert.signature.algorithm

String

The algorithm of the certificate.

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 for validation.

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

Boolean

Enable or disable news on the login page.

rss.news.box.width

Integer

Width of the news box on the login page.

300

rss.news.max.size

Integer

Maximum number of news items retrieved from the news server.

10

News is cached by the OpenKM server and refreshed once per day. This means any change to this parameter will take effect tomorrow or after restarting the OpenKM service.

rss.news.visible

Integer

Number of visible news items at the same time.

1

check.node.deletion.integrity

Boolean

Enables or disables the node deletion integrity check. When enabled, nodes that are in use by a workflow or contain children in use (in the case of folders or records) cannot be deleted. This feature is enabled by default and should only be disabled when performing mass deletion operations.

okm.content.security.policy

String

By default, embedding the application in an iframe is only allowed from the same origin, as it is required for the web UI. This is the default value:

frame-ancestors 'self'

The following example shows how to enable additional domains:

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":["*"]}]

The following example shows how to restrict REST API access to specific domains while disabling access from others.

[{"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 is 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 logged by default. When set to true, these warnings are suppressed in the log.

true

okm.authentication.external.authentication

String

Enables OpenKM external authentication. This feature allows the application to authenticate users through third-party providers such as OAuth, Azure Cloud, and others.

okm.authentication.external.authentication=http://localhost:8081/ext-auth

rest.client.call.timeout

String

Sets the maximum request timeout in seconds when the OpenKM application makes REST requests to third-party applications (for example, jbpm-console requests).

15

optimized.thumbnail.generation

Boolean

Uses a new, improved method to generate thumbnails. Useful when using PDF Tools or Stamp.

true

security.database-query.enabled

Boolean

Enables the DatabaseQuery functionality in the administration section. When enabled, administrators can execute database queries directly from the interface.

false

security.scripting.enabled

Boolean

Enables the Scripting functionality in the administration section. When enabled, administrators can execute scripts directly from the interface.

false

security.script-validation.enabled

Boolean

Enables validation of script statements executed in the Scripting administration feature. When enabled, the system performs security checks on scripts before execution to prevent potentially harmful operations.

true

security.sql-validation.enabled

Boolean

Enables validation of SQL statements executed in the DatabaseQuery administration feature. When enabled, the system performs security checks on SQL queries before execution to prevent potentially harmful operations.

true

Table of contents [ Hide Show ]