Skip to content
Other versions

Loading…

Experimental configuration parameters

Property Type Description
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.
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 are cached by the OpenKM server and are refreshed once per day. That 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 Enable or disable node deletion integrity check. For example, if the node is used in a workflow, or any of its children (in the case of folders or records) can be deleted. By default it is enabled, and you should only disable it when deleting large numbers of nodes.
okm.content.security.policy String By default, embedding the application in an iframe is only allowed from the same origin; that’s required because it is used in the web UI. This is the default value:
frame-ancestors ‘self’
The next sample shows how to enable other 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 for it 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 next sample shows how to enable access to the REST API only for several domains and disable 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 is applied; therefore, the path “/**” should always be last.
More information about CORS at https://developer.mozilla.org/en-US/docs/Web/HTTP/CORS
ldap.ignore.partial.result.exception Boolean With AD integration, warnings for PartialResultException are shown in the log by default. When true, these warnings are not shown in the log.
true
okm.authentication.external.authentication String Enable OpenKM external authentication. This feature allows the application to be authenticated by third-party authentication providers such as OAuth, Azure, 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 a REST request to a third-party application. For example, a jbpm-console request.
15