Configuring MySQL

Tip

For performance reasons, we recommend using MariaDB instead of MySQL. See Configuring MariaDB for the full setup guide (preliminaries, charset configuration, timezone, case-insensitive node names, troubleshooting, etc.) — the steps are the same for MySQL, only the client tool names and driver differ, as shown below.

Database creation

Create a database and user

DROP DATABASE IF EXISTS okmdb;
CREATE DATABASE okmdb DEFAULT CHARACTER SET utf8 DEFAULT COLLATE utf8_bin;
CREATE USER openkm@localhost IDENTIFIED BY '*secret*';
GRANT ALL ON okmdb.* TO openkm@localhost WITH GRANT OPTION;

You can check the database engine with the following:

$ mysqlshow -h localhost -u root -p --status okmdb;

More information at MySQL: Case Sensitivity in String Searches

Configure your openkm.properties

Caution

This configuration property should be set before creating the database. Once the database has been initialized, do not modify it, because doing so can damage your installation.

If your OpenKM installation has already been configured with another database, you can’t switch to another database by simply changing this property.

Edit the file $TOMCAT_HOME/openkm.properties

spring.jpa.hibernate.ddl-auto=create-only
spring.jpa.properties.hibernate.dialect=com.openkm.db.dialect.MySQLDialect

Configure Tomcat data sources

Edit the file $TOMCAT_HOME/openkm.properties and enable the resource named JDBC/OpenKMDS

spring.datasource.driver-class-name=com.mysql.jdbc.Driver
spring.datasource.url=jdbc:mysql://localhost:3306/okmdb?autoReconnect=true&useUnicode=true&characterEncoding=UTF8&nullNamePatternMatchesAll=true&serverTimezone=Europe/Madrid
spring.datasource.username=openkm
spring.datasource.password=*secret*

Note

In recent MySQL versions, you need to add useSSL=false to the connection URL.

Caution

Configure the values of the attributes named:

• Username.
• Password.
• URL (change to your host and port).

It can only use the resource called JDBC/OpenKMDS.

Configure application login

Edit the file $TOMCAT_HOME/openkm.properties

authentication.openkm.database=true

Run application

At OpenKM startup, the application will automatically create an empty database structure.

Note

Once the tables are created, OpenKM will automatically change the hibernate.hbm2ddl property from create-only to none.

Remove and create MySQL service on Windows.

Caution

Ensure your MySQL\bin folder is in your PATH environment variable.

For example, in MySQL 5.7, the bin folder location is at C:\Program Files\MySQL\MySQL Server 5.7\bin

If you have a MySQL Windows service, you can remove it with one of these command lines:

c:\> mysqld --remove MySQL57

or

c:\> sc delete MySQL57

Create the service:

c:\> "C:\Program Files\MySQL\MySQL Server 5.7\bin\mysqld.exe" --install MYSQL57 --defaults-file="C:\ProgramData\MySQL\MySQL Server 5.7\my.ini"

Note

More information at http://dev.mysql.com/doc/refman/5.7/en/windows-start-service.html