summaryrefslogtreecommitdiff
path: root/docs/mysql-configuration.markdown
blob: b1934947f0d47cf673152fe32fd663e95f22fa96 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
How to use Mysql or MariaDB instead of Sqlite
=============================================

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

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:

```sql
CREATE DATABASE kanboard;
```

### Create a config file

All application constants can be overrided by using a config file at the root of the project.
The second step is to create a config file named `config.php`:

```
.
├── LICENSE
├── common.php
├── ....
├── config.php <== Our config file
├── ....
├── index.php
├── ....
└── vendor
```

### Define Mysql parameters

Copy and paste this config file and replace the values:

```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`.