diff options
Diffstat (limited to 'doc/en_US/requirements.markdown')
-rw-r--r-- | doc/en_US/requirements.markdown | 108 |
1 files changed, 108 insertions, 0 deletions
diff --git a/doc/en_US/requirements.markdown b/doc/en_US/requirements.markdown new file mode 100644 index 00000000..957d8750 --- /dev/null +++ b/doc/en_US/requirements.markdown @@ -0,0 +1,108 @@ +Requirements +============ + +Server side +----------- + +### Compatible Operating Systems + +| Operating System | +|--------------------------------------| +| Linux Ubuntu Xenial Xerus 16.04 LTS | +| Linux Ubuntu Trusty 14.04 LTS | +| Linux Centos 6.x | +| Linux Centos 7.x | +| Linux Redhat 6.x | +| Linux Redhat 7.x | +| Linux Debian 8 | +| FreeBSD 10.x | +| Microsoft Windows 2012 R2 | +| Microsoft Windows 2008 | + +### Compatible Databases + +| Database | +|--------------------| +| Sqlite 3.x | +| Mysql >= 5.5 | +| MariaDB >= 10 | +| Postgresql >= 9.3 | + +Which database to choose? + +| Type | Usage | +|-----------------|-----------------------------------------------------| +| Sqlite | Single user or small team (almost no concurrency) | +| Mysql/Postgres | Larger team, high-availability configuration | + +Do not use Sqlite on NFS mounts, only when you have a disk with fast I/O. + +### Compatible Web Servers + +| Web Server | +|--------------------| +| Apache HTTP Server | +| Nginx | +| Microsoft IIS | + +Kanboard is pre-configured to work with Apache (URL rewriting). + +### PHP Versions + +| PHP Version | +|----------------| +| PHP >= 5.3.9 | +| PHP 5.4 | +| PHP 5.5 | +| PHP 5.6 | +| PHP 7.x | + +### PHP Extensions Required + +| PHP Extension | Note | +|----------------------------|-------------------------------| +| pdo_sqlite | Only if you use Sqlite | +| pdo_mysql | Only if you use Mysql/MariaDB | +| pdo_pgsql | Only if you use Postgres | +| gd | | +| mbstring | | +| openssl | | +| json | | +| hash | | +| ctype | | +| session | | +| ldap | Only for LDAP authentication | +| Zend OPcache | Recommended | + +### Optional PHP extensions + +| PHP Extension | Note | +|----------------------------|--------------------------------------------| +| zip | Used to install plugins from Kanboard | + +### Recommendations + +- Modern Linux or Unix operating system. +- Best performances are obtained with the latest version of PHP with OPcode caching activated. + +Client side +----------- + +### Browsers + +Always use a modern browser with the latest version if possible: + +| Browser | +|---------------------------------------| +| Safari | +| Google Chrome | +| Mozilla Firefox | +| Microsoft Internet Explorer >= 11 | +| Microsoft Edge | + +### Devices + +| Device | Screen resolution | +|-------------------|--------------------| +| Laptop or desktop | >= 1366 x 768 | +| Tablet | >= 1024 x 768 | |