Configuration parameters

OpenKM is preconfigured with a number of parameters. However, if you plan to use it in production you should take a look at our Recommended configuration parameters. To access Configuration parameters go to Administration > Configuration parameters.

Configuration parameters are shown in a table with three columns:

Property Key



Property key is the unique identifier for each configuration property.

There are several configuration types:

  • String.
  • Integer (only numeric values are allowed).
  • Boolean (only true or false values are allowed).
  • List (each break line is considered a new list element).
  • Text.
  • HTML (HTML tags allowed).
  • File.

To create your own parameters read Creating your own parameters.

Edit a parameter

  • Click the edit icon .
  • View and modify the value.
  • Click the Edit button to confirm the change.

Delete a parameter

You should not delete parameters if you are not completely sure about the implications of this action.

  • Click remove icon .
  • In Delete confirmation view click Delete button.

Backup configuration parameters

  • Click at top right the Configuration parameters export icon .
  • Your browser will download a SQL file with the configuration.

Restore configuration parameters

Restoring configuration parameters will replace the current parameters with the ones imported.

  • Go to the bottom of the page.
  • Select configuration parameter SQL file.
  • Click  Import button.

Check configuration

This action will check if potentially conflictive parameters are configured properly (pdf2swf, convert tool, OCR engine, OpenOffice or LibreOffice path).

Although a parameter may pass this check, this does not mean it is 100% correct. Take this function as a light check which cannot cover all cases but is good approximation to rule out most problems.

  • Click the Check icon at top right.
  • It will show the Configuration check view. If some parameters are misconfigured or wrong, they will be shown in red.

Tenant configuration

This option is only available in case of the application has been configured with the multi-tenant module.

  • Click the Tenant configuration button at top right.
  • In tenant configuration you can create your own configuration parameters. These will have preference over the default values. For example, have another application.url value for each tenant.