Log Configuration

Logback-based Log Configuration

OpenKM uses logback, which is a Java-based logging utility. This is useful, for example when you need to get more information about something that is not working properly in OpenKM, such as third-party application configuration or Spring authentication. By default, only log messages at the INFO level are shown, but you can increase the amount of logging information by raising the log level to WARN or DEBUG. The log configuration file is $TOMCAT_HOME/logback.xml Here you can change the log level for messages generated by a given class or package.

When OpenKM detects a modification in the logback.xml file, it will reload it so you don't need to stop and start OpenKM to make these changes take effect.

Third-party application execution

This is useful when something like a document preview fails, because this way OpenKM will log every external program execution:

<logger name="com.openkm.util" level="DEBUG" />

Enable log authentication

If you need to debug the security configuration, edit the logback.xml file and add this line:

<logger name="org.springframework.security" level="DEBUG" />