MySQL/MariaDB
=============

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

Requirements
------------

-  MySQL >= 5.6 or MariaDB >= 10
-  The PHP extension ``pdo_mysql`` installed

MySQL configuration
-------------------

Create a database
~~~~~~~~~~~~~~~~~

The first step is to create a database on your MySQL server.
For example, you can do that from MySQL client:

.. code:: sql

    CREATE DATABASE kanboard CHARACTER SET utf8mb4 COLLATE utf8mb4_unicode_ci;

.. note:: Since the version 1.2.3, Kanboard uses the utf8mb4 encoding instead of utf8.

You can then assign the required permissions on the database:

.. code:: sql

    GRANT ALTER, CREATE, DELETE, DROP, INDEX, INSERT, REFERENCES, SELECT, UPDATE, LOCK TABLES ON kanboard.* TO 'USERNAME'@'HOST' IDENTIFIED BY 'PASSWORD';

Create a config file
~~~~~~~~~~~~~~~~~~~~

The file ``config.php`` should contains these values:

.. code:: php

    <?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:

.. code:: bash

    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.

If you would like to use Unix socket connection, try this:

.. code:: php

    define('DB_HOSTNAME', '127.0.0.1;unix_socket=/var/run/mysqld/mysqld.sock');

SSL configuration
-----------------

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

.. code:: php

    // 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');