Include documentation in the application

1 files changed, 40 insertions, 0 deletions

diff --git a/doc/postgresql-configuration.markdown b/doc/postgresql-configuration.markdown
new file mode 100644
index 00000000..3c07ff16
--- /dev/null
+++ b/doc/postgresql-configuration.markdown
@@ -0,0 +1,40 @@
+Postgresql configuration
+========================
+
+By default, Kanboard use Sqlite to store its data but it's also possible to use Postgresql.
+
+Requirements
+------------
+
+- A Postgresql server already installed and configured
+- The PHP extension `pdo_pgsql` installed (Debian/Ubuntu: `apt-get install php5-pgsql`)
+
+Note: Kanboard is tested with **Postgresql 9.3 and 9.4**
+
+Configuration
+-------------
+
+### Create an empty database with the command `pgsql`:
+
+```sql
+CREATE DATABASE kanboard;
+```
+
+### Create a config file
+
+The file `config.php` should contains those values:
+
+```php
+<?php
+
+// We choose to use Postgresql instead of Sqlite
+define('DB_DRIVER', 'postgres');
+
+// 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`.