How to move to another server
Although the system should not be affected, before doing this kind of action we recommend having a backup. Refer to the Backup and restore section.
Linux
In the next documentation, will refer to the Installing on Ubuntu and Debian in some sections because are the same actions.
Preliminaries
- Ensure you have enough disk space in the new server.
- Check if you have enough CPU power and RAM in the new server.
- Create the user who's the owner of the OpenKM files ( $TOMCAT_HOME folder ). This user is usually named "openkm" ( more info at Installing on Ubuntu and Debian ), but maybe in the installation was choose other one.
- Update the OS.
Stop OpenKM service
It is important while moving the data between the two servers do not perform any kind of changes in the old server. That's why is a good practice to have OpenKM stopped.
If you do not want to stop the OpenKM service, set OpenKM as read-only with a configuration parameter named "system.readonly".
Backup the database
In the "openkm.properties" file ( at $TOMCAT_HOME folder ) is configured the database connection. In the next sample the user is named "openkm" with password "openkm" and the connection URL is "jdbc:mariadb://localhost:3306/okmdb?autoReconnect=true&useUnicode=true&characterEncoding=UTF8&nullNamePatternMatchesAll=true":
# Database connection
spring.datasource.driver-class-name=org.mariadb.jdbc.Driver
spring.datasource.url=jdbc:mariadb://localhost:3306/okmdb?autoReconnect=true&useUnicode=true&characterEncoding=UTF8&nullNamePatternMatchesAll=true
spring.datasource.username=openkm
spring.datasource.password=openkmThe command below explains how to backup the MySQL and MariaDB database. The database is usually named "okmdb":
$ mysqldump -h localhost -u openkm -popenkm okmdb > okmdb.sql
Restore the database
- Install the same database engine in the new server.
- Create the database user with the same credentials ( more info at Installing on Ubuntu and Debian ).
- Copy the okmdb.sql file to the new server.
- Restore the backup.
The sample below explains how to restore the MySQL and MariaDB database. Again, the database is usually named "okmdb":
$ mysql -h localhost -u openkm -popenkm okmdb < okmdb.sql
Copy binary files
Take a look at the file OpenKM.cfg, the whole repository is usually in the TOMCAT_HOME folder, but depending on your configuration it may be has configured in other location. This repository folder should also be copied.
Take a look at the parameters in Change repository home.
- Copy the TOMCAT_HOME folder to the new server. We suggest to keep the same origin folder path in destination ( otherwise you would need to make extra configuration steps ).
- Set grants to the owner of the TOMCAT_HOME folder in the new server ( usually the user named openkm ).
The sample below shows how to copy it ( from the old server to the new server ):
$ rsync -avh --progress --stats /home/openkm/tomcat-8.5.69 root@newServer:/home/openkm/tomcat-9.0.79
The sample below shows how to set the owner ( you need to execute as root ):
$ chown openkm:openkm -Rf /home/openkm/tomcat-8.5.69
Configure service in the new server
- Copy the file /etc/init.d/openkm to the new server at the same location and register as a service. ( more info at Installing on Ubuntu and Debian ).
Install third-party tools
In OpenKM Administration > Configuration parameters you will find information about most applications required. Some of them are under $TOMCAT_HOME/bin folder, so these have been just copied in previous steps as part of the TOMCAT_HOME folder.
The minimum required packages are ( more info at Installing on Ubuntu and Debian ):
- ImageMagick
- Ghostscript
- LibreOffice
- Tesseract OCR engine ( remember the language packs required in your environment )
Start OpenKM service
Until the license is not moved to the new server you will only be able to access the administration user interface.
- In case the new server has less RAM than the old server you need to check the $TOMCAT_HOME/bin/setenv.sh file and adapt properly.
- Check the openkm.log file for the startup process and look for possible errors.
Additional steps
- If the new server has a different number of cores you need to check the value of the configuration parameters named "text.extraction.threads" and "text.extraction.batch".
- Open administration at http://localhost:8080/openkm/management/ and execute a repository checker ( this action may take a lot of time until completed ).
Moving license
Coordinate with the OpenKM team to move the license from the old server to the new one.
Final checks
- Check the preview of different document types ( PDF, Microsoft Office ).
- Check the thumbnails of different document types ( PDF, Microsoft Office ).
- Create a folder.
- Upload a new document.
- Download a previously existing document.
