summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorFrederic Guillot <fred@kanboard.net>2016-05-06 19:19:05 -0400
committerFrederic Guillot <fred@kanboard.net>2016-05-06 19:19:05 -0400
commit400e230881bc71e052ee41da660ec5ff8dd3130d (patch)
treedfe32f874dca7f93c37ac5184941a8932293119a /doc
parent72dcb6fc9b48a2b0c730b499685052bf256cf3c2 (diff)
Added support for Mysql SSL connection
Diffstat (limited to 'doc')
-rw-r--r--doc/config.markdown9
-rw-r--r--doc/mysql-configuration.markdown25
2 files changed, 29 insertions, 5 deletions
diff --git a/doc/config.markdown b/doc/config.markdown
index c1f08b99..2f88d306 100644
--- a/doc/config.markdown
+++ b/doc/config.markdown
@@ -87,6 +87,15 @@ define('DB_NAME', 'kanboard');
// Mysql/Postgres custom port (null = default port)
define('DB_PORT', null);
+
+// Mysql SSL key
+define('DB_SSL_KEY', null);
+
+// Mysql SSL certificate
+define('DB_SSL_CERT', null);
+
+// Mysql SSL CA
+define('DB_SSL_CA', null);
```
LDAP settings
diff --git a/doc/mysql-configuration.markdown b/doc/mysql-configuration.markdown
index 6bfb209d..9d60271c 100644
--- a/doc/mysql-configuration.markdown
+++ b/doc/mysql-configuration.markdown
@@ -1,5 +1,5 @@
-How to use Mysql or MariaDB instead of Sqlite
-=============================================
+Mysql/MariaDB Configuration
+===========================
By default Kanboard use Sqlite to stores its data.
However it's possible to use Mysql or MariaDB instead of Sqlite.
@@ -8,7 +8,7 @@ Requirements
------------
- Mysql server
-- The PHP extension `pdo_mysql` installed (Debian/Ubuntu: `apt-get install php5-mysql`)
+- The PHP extension `pdo_mysql` installed
Note: Kanboard is tested with **Mysql >= 5.5 and MariaDB >= 10.0**
@@ -47,11 +47,26 @@ Note: You can also rename the template file `config.default.php` to `config.php`
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 issues or potential timeouts you can initialize the database directly by importing the SQL schema:
+To avoid any potential timeout you can initialize the database directly by importing the SQL schema:
```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.
+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:
+
+```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');
+```