Using the installer

Caution

The OpenKM installer demands credentials to use it, so in case you want to access you should need to contact the OpenKM staff.

Another way of installing OpenKM is using the installer tool. This is a Java application which eases the installation process and works on Ubuntu, Debian, RedHat, CentOS and Windows platforms. Keep in mind that you need a working Java installation prior to use this tool. We recommend OpenJDK 8. Please check these pages for more information about installing Java on your server; look for Checking Java version section:

• Installing on RedHat and CentOS (Manual)
• Installing on Ubuntu and Debian (Manual)
• Installing on Windows

Note

The installer downloads several packages from our servers like Tomcat and OpenKM, so it needs to connect to http://download.openkm.com. 

Once Java 8 is installed you can download the installer from http://download.openkm.com/.

Note

The installer will make the installation in the folder which it runs in, so before running move the OKMInstaller.jar to the location where OpenKM should be installed. In case of running on Linux it also changes the files permissions to a user called “openkm” so, if you haven’t created such user, please create it now:

$ sudo adduser openkm

This command should work in most common Linux distributions.

It’s a text-based installer, so you need to execute it from console as root if you are on Linux or as Administrator if you are on Windows. This is because it needs to install package dependencies and configure OpenKM as a service:

$ java -jar OKMInstaller.jar -tv 8.5.47 -ov 6.4

 And this is the output:

Values in brackets are the default one. If you hit Enter, this is the chosen value. If you want a different one, just write the string. At the end, the installed will show the entered information and you would be able to verify it and proceed or enter again these values.

Caution

The installer will ask for an authorized user and password. If you don’t have already this information, please open a support ticket or contact your sales agent.

If you press “y”, the installer will ask for an authorized user and password. Once the user and password are validated, the installation process will start. This process may take several minutes depending on your Internet connection and server performance. In case of Linux based systems, it will install all required dependencies like ImageMagick and LibreOffice. 

Note

If you access the Internet using a proxy, just configure it when executing the application:

$ java -Dhttp.proxyHost=192.168.0.1 -Dhttp.proxyPort=3128 -jar OKMInstaller.jar -tv 8.5.47 -ov 6.4

You may also need https.proxyHost and https.proxyPort or even http.proxyUser, http.proxyPassword, https.proxyUser and https.proxyPassword parameters.

Supported databases

The installer supports these databases:

• MariaDB (mariadb)
• MySQL (mysql)
• PostgreSQL (posgresql)
• SQL Server (sqlserver)
• Oracle (oracle)
• HSQLDB (hsqldb)
• H2 (h2)

Other options

The installer will also check if the port 8080 is already being used, which is the default port used by Tomcat and should be free. If you want to disable this check, use the -p or --port parameters.

$ java -jar OKMInstaller.jar -tv 8.5.47 -ov 6.4 -p