Include documentation in the application

This commit is contained in:
Frederic Guillot
2015-08-29 20:00:53 -04:00
parent ef087f5e22
commit 6c711f696f
135 changed files with 285 additions and 38 deletions

View File

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