Include documentation in the application

1 files changed, 0 insertions, 242 deletions

diff --git a/docs/config.markdown b/docs/config.markdown
deleted file mode 100644
index b5c3ce0d..00000000
--- a/docs/config.markdown
+++ /dev/null
@@ -1,242 +0,0 @@
-Config file
-===========
-
-You can customize the default settings of Kanboard by adding a file `config.php` at the project root.
-You can also rename the `config.default.php` and change the desired values.
-
-Enable/Disable debug mode
--------------------------
-
-```php
-define('DEBUG', false);
-```
-
-The debug mode logs all SQL queries and the time taken to generate pages.
-
-Debug file path
----------------
-
-```php
-define('DEBUG_FILE', __DIR__.'/data/debug.log');
-```
-
-All debug information are saved in this file.
-If you prefer to send logs to `stdout` or `stderr` replace the value by `php://stdout` or `php://stderr`.
-
-Folder for uploaded files
--------------------------
-
-```php
-define('FILES_DIR', 'data/files/');
-```
-
-Don't forget the trailing slash.
-
-Enable/disable url rewrite
---------------------------
-
-```php
-define('ENABLE_URL_REWRITE', false);
-```
-
-Email configuration
--------------------
-
-```php
-// E-mail address for the "From" header (notifications)
-define('MAIL_FROM', 'notifications@kanboard.local');
-
-// Mail transport to use: "smtp", "sendmail" or "mail" (PHP mail function)
-define('MAIL_TRANSPORT', 'mail');
-
-// SMTP configuration to use when the "smtp" transport is chosen
-define('MAIL_SMTP_HOSTNAME', '');
-define('MAIL_SMTP_PORT', 25);
-define('MAIL_SMTP_USERNAME', '');
-define('MAIL_SMTP_PASSWORD', '');
-define('MAIL_SMTP_ENCRYPTION', null); // Valid values are "null", "ssl" or "tls"
-
-// Sendmail command to use when the transport is "sendmail"
-define('MAIL_SENDMAIL_COMMAND', '/usr/sbin/sendmail -bs');
-```
-
-Database settings
------------------
-
-```php
-// Database driver: sqlite, mysql or postgres (sqlite by default)
-define('DB_DRIVER', 'sqlite');
-
-// Mysql/Postgres username
-define('DB_USERNAME', 'root');
-
-// Mysql/Postgres password
-define('DB_PASSWORD', '');
-
-// Mysql/Postgres hostname
-define('DB_HOSTNAME', 'localhost');
-
-// Mysql/Postgres database name
-define('DB_NAME', 'kanboard');
-
-// Mysql/Postgres custom port (null = default port)
-define('DB_PORT', null);
-```
-
-LDAP settings
--------------
-
-```php
-// Enable LDAP authentication (false by default)
-define('LDAP_AUTH', false);
-
-// LDAP server hostname
-define('LDAP_SERVER', '');
-
-// LDAP server port (389 by default)
-define('LDAP_PORT', 389);
-
-// By default, require certificate to be verified for ldaps:// style URL. Set to false to skip the verification.
-define('LDAP_SSL_VERIFY', true);
-
-// Enable LDAP START_TLS
-define('LDAP_START_TLS', false);
-
-// LDAP bind type: "anonymous", "user" (use the given user/password from the form) and "proxy" (a specific user to browse the LDAP directory)
-define('LDAP_BIND_TYPE', 'anonymous');
-
-// LDAP username to connect with. null for anonymous bind (by default).
-// Or for user bind type, you can use a pattern: %s@kanboard.local
-define('LDAP_USERNAME', null);
-
-// LDAP password to connect with. null for anonymous bind (by default).
-define('LDAP_PASSWORD', null);
-
-// LDAP account base, i.e. root of all user account
-// Example: ou=People,dc=example,dc=com
-define('LDAP_ACCOUNT_BASE', '');
-
-// LDAP query pattern to use when searching for a user account
-// Example for ActiveDirectory: '(&(objectClass=user)(sAMAccountName=%s))'
-// Example for OpenLDAP: 'uid=%s'
-define('LDAP_USER_PATTERN', '');
-
-// Name of an attribute of the user account object which should be used as the full name of the user.
-define('LDAP_ACCOUNT_FULLNAME', 'displayname');
-
-// Name of an attribute of the user account object which should be used as the email of the user.
-define('LDAP_ACCOUNT_EMAIL', 'mail');
-
-// Name of an attribute of the user account object which should be used as the id of the user.
-// Example for ActiveDirectory: 'samaccountname'
-// Example for OpenLDAP: 'uid'
-define('LDAP_ACCOUNT_ID', 'samaccountname');
-
-// By default Kanboard lowercase the ldap username to avoid duplicate users (the database is case sensitive)
-// Set to true if you want to preserve the case
-define('LDAP_USERNAME_CASE_SENSITIVE', false);
-
-// Automatically create user account
-define('LDAP_ACCOUNT_CREATION', true);
-```
-
-Google Authentication settings
-------------------------------
-
-```php
-// Enable/disable Google authentication
-define('GOOGLE_AUTH', false);
-
-// Google client id (Get this value from the Google developer console)
-define('GOOGLE_CLIENT_ID', '');
-
-// Google client secret key (Get this value from the Google developer console)
-define('GOOGLE_CLIENT_SECRET', '');
-```
-
-Github Authentication settings
-------------------------------
-
-```php
-// Enable/disable GitHub authentication
-define('GITHUB_AUTH', false);
-
-// GitHub client id (Copy it from your settings -> Applications -> Developer applications)
-define('GITHUB_CLIENT_ID', '');
-
-// GitHub client secret key (Copy it from your settings -> Applications -> Developer applications)
-define('GITHUB_CLIENT_SECRET', '');
-```
-
-Reverse-Proxy Authentication settings
--------------------------------------
-
-```php
-// Enable/disable the reverse proxy authentication
-define('REVERSE_PROXY_AUTH', false);
-
-// Header name to use for the username
-define('REVERSE_PROXY_USER_HEADER', 'REMOTE_USER');
-
-// Username of the admin, by default blank
-define('REVERSE_PROXY_DEFAULT_ADMIN', '');
-
-// Default domain to use for setting the email address
-define('REVERSE_PROXY_DEFAULT_DOMAIN', '');
-```
-
-RememberMe Authentication settings
-----------------------------------
-
-```php
-// Enable/disable remember me authentication
-define('REMEMBER_ME_AUTH', true);
-```
-
-Secure HTTP headers settings
-----------------------------
-
-```php
-// Enable or disable "Strict-Transport-Security" HTTP header
-define('ENABLE_HSTS', true);
-
-// Enable or disable "X-Frame-Options: DENY" HTTP header
-define('ENABLE_XFRAME', true);
-```
-
-Bruteforce protection
----------------------
-
-```php
-// Enable captcha after 3 authentication failure
-define('BRUTEFORCE_CAPTCHA', 3);
-
-// Lock the account after 6 authentication failure
-define('BRUTEFORCE_LOCKDOWN', 6);
-
-// Lock account duration in minute
-define('BRUTEFORCE_LOCKDOWN_DURATION', 15);
-```
-
-Session
--------
-
-```php
-// Session duration in second (0 = until the browser is closed)
-// See http://php.net/manual/en/session.configuration.php#ini.session.cookie-lifetime
-define('SESSION_DURATION', 0);
-```
-
-Various settings
-----------------
-
-```php
-// Escape html inside markdown text
-define('MARKDOWN_ESCAPE_HTML', true);
-
-// API alternative authentication header, the default is HTTP Basic Authentication defined in RFC2617
-define('API_AUTHENTICATION_HEADER', '');
-
-// Hide login form, useful if all your users use Google/Github/ReverseProxy authentication
-define('HIDE_LOGIN_FORM', false);
-```