Using the installer
Another way of installing OpenKM is by using the installer tool. This Java application simplifies installation and works on Ubuntu, Debian, Red Hat, CentOS, and Windows platforms. Remember that you need a working Java installation before using this tool. We recommend OpenJDK 8. Please check these pages for more information about installing Java on your server; look for the Checking Java version section:
The installer installs into the folder in which it runs, so before running, move the OKMInstaller.jar to the location where OpenKM should be installed. When running on Linux, it also changes the file's ownership to a user called "openkm", so if you haven't created such a 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 the console as root if you are on Linux or as an administrator on Windows. This is because it needs to install package dependencies and configure OpenKM as a service:
$ java -jar OKMInstaller.jar
And this is the output:
Values in brackets are the default ones. If you hit Enter, this is the chosen value. If you want a different one, enter the value. In the end, the installed program will show the entered information, and you can verify it and proceed, or enter these values again.
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. Depending on your Internet connection and server performance, this process may take several minutes. In the case of Linux-based systems, it will install all required dependencies like ImageMagick and LibreOffice.
If you access the Internet using a proxy, configure it when running the application:
$ java -Dhttp.proxyHost=192.168.0.1 -Dhttp.proxyPort=3128 -jar OKMInstaller.jar
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 (postgresql)
- SQL Server (sqlserver)
- Oracle (oracle)
Other options
The installer will also check if 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 -p
