Installing on Ubuntu and Debian

Preliminaries

Check disk size

Create user named openkm

Check if partners channels are enabled

In case they are not enabled, enable them.

Check server configuration

Increase ulimit

uncomment the following line

to

and add the following lines to the end of the file (before the line # End of file)

Checking Java version

 If Java is correctly installed on your computer, the name and version of the Java virtual machine is displayed:

Install Java

In case of Ubuntu

In case of Debian

Set OpenJDK 1.8 as your default Java version

Installing database

Install MySQL if you do not have it already installed:

When you install MySQL, the installer will ask you for a password for the root user. Keep this password handy.

Also you can install MariaDB, which replaces MySQL in latest versions:

Change MySQL root password

Do it only if it's necessary to change MySQL root password.

Method 1

Method 2

Method 3

Method 4

More information at MySQL : Reseting permissions.

Check InnoDB is default MySQL engine

If it not default, modify /etc/mysql/my.cnf

and under [mysqld] add

Create database

Installing OpenKM and Tomcat bundle

Configuring Tomcat as a service

Create a file with the script:

#!/bin/sh
 
### BEGIN INIT INFO
# Provides:          tomcat
# Required-Start:    $remote_fs $syslog
# Required-Stop:     $remote_fs $syslog
# Default-Start:     2 3 4 5
# Default-Stop:      0 1 6
# Short-Description: Start and stop Apache Tomcat
# Description:       Enable Apache Tomcat service provided by daemon.
### END INIT INFO
 
ECHO=/bin/echo
TEST=/usr/bin/test
TOMCAT_USER=openkm
TOMCAT_HOME=/home/openkm/tomcat
TOMCAT_START_SCRIPT=$TOMCAT_HOME/bin/startup.sh
TOMCAT_STOP_SCRIPT=$TOMCAT_HOME/bin/shutdown.sh
 
$TEST -x $TOMCAT_START_SCRIPT || exit 0
$TEST -x $TOMCAT_STOP_SCRIPT || exit 0
 
start() {
    $ECHO -n "Starting Tomcat"
    su - $TOMCAT_USER -c "$TOMCAT_START_SCRIPT &"
    $ECHO "."
}
 
stop() {
    $ECHO -n "Stopping Tomcat"
    su - $TOMCAT_USER -c "$TOMCAT_STOP_SCRIPT 60 -force &"
    while [ "$(ps -fu $TOMCAT_USER | grep java | grep tomcat | wc -l)" -gt "0" ]; do
        sleep 5; $ECHO -n "."
    done
    $ECHO "."
}
 
case "$1" in
    start)
        start
        ;;
    stop)
        stop
        ;;
    restart)
        stop
        sleep 30
        start
        ;;
    *)
        $ECHO "Usage: tomcat {start|stop|restart}"
        exit 1
esac
exit 0

Make it executable:

Update the run-levels:

Check the service

Start the service:

Stop the service:

Installing third-party software

Start application

Check OpenKM.cfg parameters

Your configuration should be something like this:

First time application start:

To see the startup process can execute the command:

When application is started you'll see in log file the lines:

2015-07-04 18:28:10,680 [main] INFO  org.apache.coyote.http11.Http11Protocol - Starting ProtocolHandler ["http-bio-0.0.0.0-8080"]
2015-07-04 18:28:10,688 [main] INFO  org.apache.coyote.ajp.AjpProtocol - Starting ProtocolHandler ["ajp-bio-127.0.0.1-8009"]
2015-07-04 18:28:10,692 [main] INFO  org.apache.catalina.startup.Catalina - Server startup in 41456 ms

The application will be accessible at http://YOUR_IP:8080/OpenKM by user:okmAdmin with password:admin. ( Do not forget to change it !). For more information about Manage users and roles.

Configure default extensions:

Go to Administration > Database query  and execute:

INSERT INTO OKM_EXTENSION (EXT_UUID, EXT_NAME) VALUES ('808e7a42-2e73-470c-ba23-e4c9d5c3a0f4', 'Live Edit');
INSERT INTO OKM_EXTENSION (EXT_UUID, EXT_NAME) VALUES ('58392af6-2131-413b-b188-1851aa7b651c', 'HTML Editor 4');
INSERT INTO OKM_PROFILE_MSC_EXTENSION (PEX_ID, PEX_EXTENSION) VALUES (1, '808e7a42-2e73-470c-ba23-e4c9d5c3a0f4');
INSERT INTO OKM_PROFILE_MSC_EXTENSION (PEX_ID, PEX_EXTENSION) VALUES (1, '58392af6-2131-413b-b188-1851aa7b651c');

Other common additional configurations setup 

OpenKM comes with a lot of configuration parameters. Please make sure to review: Recommended configuration parameters.

• Configuring Apache HTTP Reverse-Proxy
• Configuring mail
• Configuring Tomcat memory utilization 
• Configuring Tomcat port
• Configuring Tomcat SSL/TLS
• Configuring Tomcat timezone

Restart installation from scratch

The OpenKM first startup does some background configurations like filesystem folder creation, changes in the OpenKM.cfg what only happens during the first startup.

Sometimes maybe some mistake in OpenKM configuration, for example, wrong database connection or similar issues during the first startup what raise and application failure. To restart the installation from scratch we suggest following the next steps.

1. Ensure OpenKM is stopped.
2. Edit the OpenKM.cfg and set the parameter hibernate.hbm2ddl=create
3. In case issue with database connection, we suggest checking the connection from the OpenKM server. Remember some databases require enabling the user to gain connection from a server ( specific IP, range of IP, any server ).
4. Delete the folder named "repository"
5. Start OpenKM.