1
0
Fork 0
mirror of https://github.com/YunoHost-Apps/kanboard_ynh.git synced 2024-09-03 19:36:17 +02:00
kanboard_ynh/sources/doc/mysql-configuration.markdown
2016-07-23 14:11:39 +02:00

1.7 KiB

Mysql/MariaDB Configuration

By default Kanboard use Sqlite to stores its data. However it's possible to use Mysql or MariaDB instead of Sqlite.

Requirements

  • Mysql server
  • The PHP extension pdo_mysql installed

Note: Kanboard is tested with Mysql >= 5.5 and MariaDB >= 10.0

Mysql configuration

Create a database

The first step is to create a database on your Mysql server. By example, you can do that with the command line mysql client:

CREATE DATABASE kanboard;

Create a config file

The file config.php should contains those values:

<?php

// We choose to use Mysql instead of Sqlite
define('DB_DRIVER', 'mysql');

// Mysql parameters
define('DB_USERNAME', 'REPLACE_ME');
define('DB_PASSWORD', 'REPLACE_ME');
define('DB_HOSTNAME', 'REPLACE_ME');
define('DB_NAME', 'kanboard');

Note: You can also rename the template file config.default.php to config.php.

Importing SQL dump (alternative method)

For the first time, Kanboard will run one by one each database migration and this process can take some time according to your configuration.

To avoid any potential timeout you can initialize the database directly by importing the SQL schema:

mysql -u root -p my_database < app/Schema/Sql/mysql.sql

The file app/Schema/Sql/mysql.sql is a SQL dump that represents the last version of the database.

SSL configuration

These parameters have to be defined to enable the Mysql SSL connection:

// Mysql SSL key
define('DB_SSL_KEY', '/path/to/client-key.pem');

// Mysql SSL certificate
define('DB_SSL_CERT', '/path/to/client-cert.pem');

// Mysql SSL CA
define('DB_SSL_CA', '/path/to/ca-cert.pem');