summaryrefslogtreecommitdiff
path: root/doc/requirements.markdown
diff options
context:
space:
mode:
authorFrederic Guillot <fred@kanboard.net>2016-01-08 21:44:51 -0500
committerFrederic Guillot <fred@kanboard.net>2016-01-08 21:44:51 -0500
commit97270f9b1897e2228516e2edfa927d2c0ca17c75 (patch)
tree6d95eebbe1437f11c36ed8451a89b217a6b1a0a0 /doc/requirements.markdown
parentf32d23d01528f86ff25728e9a99058e273d5b154 (diff)
Improve requirements page in documentation
Diffstat (limited to 'doc/requirements.markdown')
-rw-r--r--doc/requirements.markdown101
1 files changed, 101 insertions, 0 deletions
diff --git a/doc/requirements.markdown b/doc/requirements.markdown
new file mode 100644
index 00000000..2c99d4f2
--- /dev/null
+++ b/doc/requirements.markdown
@@ -0,0 +1,101 @@
+Requirements
+============
+
+Server side
+-----------
+
+### Compatible Operating Systems
+
+| Operating System |
+|--------------------------------|
+| 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, use Sqlite 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.3 |
+| PHP 5.4 |
+| PHP 5.5 |
+| PHP 5.6 |
+| PHP 7.x |
+
+### PHP Extensions Required
+
+| PHP Extensions required | 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 | |
+| ldap | Only for LDAP authentication |
+| Zend OPcache | Recommended |
+
+### 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 |
+
+Kanboard is not yet optimized for smartphones. It's working but the user interface is not really convenient to use.