Server configuration

The packet for the query is too large (MySQL)

If you get an error like this:

You need to modify your MySQL server configuration file and increase the value of the max_allowed_packet property. Don't forget to restart MySQL after any change in this file. In Debian-based distros like Ubuntu, this configuration file is located at /etc/mysql/my.cnf.

Not able to connect from another computer in the network

If you expose the tomcat port 8080, ensure it is binding your IP, the "address" parameter value should be "0.0.0.0" at  $TOMCAT_HOME/conf/server.xml:

<Connector port="8080" address="0.0.0.0" protocol="HTTP/1.1"
           connectionTimeout="20000"
           redirectPort="8443" />

Error downloading document as PDF

This error is usually caused by LibreOffice service configuration.

IMAP SSL certificate error

First, obtain the certificate with the openssl command, and after this, import the certificate with the following:

The OpenKM server has no direct Internet connection.

If you need a proxy to access the Internet, edit your "/etc/bash.bashrc" file as root and put these lines at the end of your "/etc/bash.bashrc" file:

export http_proxy=http://username:password@proxyserver.net:port/
export ftp_proxy=http://username:password@proxyserver.net:port/

You can omit the username: and password if your proxy server has no password.  

Access denied installing OpenKM as a service on Windows 7

The command shell works slightly differently in Vista. By default, when you run cmd.exe, it does not give administrator rights. To get around it, create a shortcut to cmd.exe on the desktop, open the Properties > Compatibility tab, and check the box for Administrator rights. Then you can do admin stuff on the command line.

Problems with character encodings

If your language has non-ASCII characters and is displayed as garbage, you have a problem with encodings.

Check the $TOMCAT/bin/setenv.sh or  $TOMCAT/bin/setenv.bat file. You should have set the JVM parameter "-Dfile.encoding=utf-8".

PermGen errors

If you see this error:

java.lang.OutOfMemoryError: PermGen space

Edit your "$TOMCAT_HOME/bin/setenv.sh" (or "$TOMCAT_HOME/bin/setenv.bat" if using Windows) and increase the value of the JVM parameter "-XX:MaxPermSize":

JAVA_OPTS="-Xms256m -Xmx2048m -XX:PermSize=128m -XX:MaxPermSize=512m"

See also Presenting the Permanent Generation.

LDAP Size limit exceeded

It is caused because bindDN has a size limit for each ldap query.

In OpenLDAP, the solution is to increase the limit of bindDN, for example, to change the size limit to the user used by the OpenKM LDAP connection.

limits dn.exact="cn=reader,ou=accounts,ou=admins,dc=example,dc=com" size=100000

See also OpenLDAP Limits.

Behind the IIS proxy, you get error 404 or 404.15

Using IIS as a web server by default, it has a limit for the query string sent to the server. If the limit is passed, then you get some error screen on the client side:

On the server side, we get a more detailed error:

To solve this issue, we need to increase the maximum size of the query string on the web server:

• Open Internet Information Services (IIS) Manager.
• In the Connections pane, go to the connection > site > application or directory for which you want to modify your request filtering settings.
• In the Home pane, double-click Request Filtering.

Click Edit Feature Settings... in the Actions pane.

Change the maximum query string length:

More information is at the OpenKM forum.

IIS gets IOException: Internal Server Error while uploading a file or HTTP 413 Request Entity Too Large Error

This error may appear when uploading a big document to OpenKM.

Solution one

Change the "Maximum allowed content length (Bytes)" from your IIS configuration parameters:

Solution two

• Go to webapps folder
• Edit the web.config file and add the following under <configuration> where "2097151" is the maximum allowed in IIS:

<system.web>
   <httpRuntime maxRequestLength="2097151" />
</system.web>

If there is no web.config, then create one from a text file and add the following :

<configuration>
   <system.web>
      <httpRuntime maxRequestLength="2097151" />
   </system.web>
</configuration>

CMIS wrong URL behind Nginx proxy 

Use this configuration:

location /OpenKM/ {
   proxy_pass http://127.0.0.1:8080/OpenKM/;
   proxy_redirect off;
   
   proxy_set_header Host $host;
   proxy_set_header X-Real-IP $remote_addr;
   proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
}

Sigar java.lang.UnsatisfiedLinkError Known issue in Windows

If you have OpenOffice or LibreOffice configured, and you get the error "sigar java.lang.UnsatisfiedLinkError" you probably have missed the "sigar path" in the "PATH" environment variable.

Caused by: java.lang.UnsatisfiedLinkError: org.hyperic.sigar.Sigar.getSigNum(Ljava/lang/String;)I
	at org.hyperic.sigar.Sigar.getSigNum(Native Method)
	at org.hyperic.sigar.Sigar.kill(Sigar.java:275)

Edit your general environment variable "PATH" and add your "$TOMCAT_HOME\lib\sigar\" folder, for example, like PATH=...;C:\tomcat-7.0.27\lib\sigar

WARN net.sf.ehcache.hibernate.strategy.AbstractReadWriteEhcacheAccessStrategy

If you see this message:

A soft-locked cache entry was expired by the underlying Ehcache.
If this happens regularly you should consider increasing the cache timeouts and/or capacity limit

Are you experiencing any performance or usability problems due to this warning? If not, then it seems like you should treat this warning as a warning.

Otherwise, it looks like the solution is to increase the size of maxElementsInMemory to account for the difference in what is cached versus what is being used.

LibreOffice is not starting on Windows.

Sometimes is not easy to get OpenKM with soffice service started for several strange reasons, which depends on your OS Windows version and other specific configuration done on the server.

First, ensure your OpenOffice path is correctly configured at Administration > Configuration parameters > "system.openoffice.program" parameter. Server configuration

Ensure there's no other soffice.bin instance running. If there's another soffice.bin instance on execution, openkm will not be able to start its soffice service. Look at the process running on Windows or use a tool like Process Explorer.

Stop the firewall and other possible tools that do not allow to start soffice service—for example, the antivirus.  

Try starting the application from the command line at "%TOMCAT_HOME/bin":