summaryrefslogtreecommitdiff
path: root/doc/installation.markdown
diff options
context:
space:
mode:
authorFrederic Guillot <fred@kanboard.net>2015-08-29 20:00:53 -0400
committerFrederic Guillot <fred@kanboard.net>2015-08-29 20:00:53 -0400
commit6c711f696f73bc59813f6834ec241aef3b626cbd (patch)
treeded4f0e8c7f8c672414ff3f2f84eac0f6d9073e5 /doc/installation.markdown
parentef087f5e22df1a0d97babef26aaf9b8960ee6d5d (diff)
Include documentation in the application
Diffstat (limited to 'doc/installation.markdown')
-rw-r--r--doc/installation.markdown40
1 files changed, 40 insertions, 0 deletions
diff --git a/doc/installation.markdown b/doc/installation.markdown
new file mode 100644
index 00000000..53e7095b
--- /dev/null
+++ b/doc/installation.markdown
@@ -0,0 +1,40 @@
+Installation
+============
+
+Requirements
+------------
+
+- Apache or Nginx
+- PHP >= 5.3.3 (Kanboard is compatible with PHP 5.3, 5.4, 5.5, 5.6 and 7.0)
+- PHP extensions required: mbstring, gd and pdo_sqlite
+- A modern web browser
+
+From the archive (stable version)
+---------------------------------
+
+1. You must have a web server with PHP installed
+2. Download the source code and copy the directory `kanboard` where you want
+3. Check if the directory `data` is writeable
+4. With your browser go to <http://yourpersonalserver/kanboard>
+5. The default login and password is **admin/admin**
+6. Start to use the software
+7. Don't forget to change your password!
+
+Note: The folder data is the location where Kanboard stores uploaded files as well as the Sqlite database.
+
+From the repository (development version)
+-----------------------------------------
+
+You must install [composer](https://getcomposer.org/) to use this method.
+
+1. `git clone https://github.com/fguillot/kanboard.git`
+2. `composer install`
+3. Go to the third step just above
+
+Note: This method will install the **current development version**, use at your own risk.
+
+Security
+--------
+
+- Don't forget to change the default user/password
+- Don't allow everybody to access to the directory `data` from the URL. There is already a `.htaccess` for Apache but nothing for Nginx.