summaryrefslogtreecommitdiff
path: root/doc/installation.markdown
blob: d51c0e52bef72e523ceac61414de50c0f23cd341 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
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!

The data folder is used to store:

- Sqlite database: `db.sqlite`
- Debug file: `debug.log` (if debug mode enabled)
- Uploaded files: `files/*`
- Image thumbnails: `files/thumbnails/*`

People who are using a remote database (Mysql/Postgresql) and a remote file storage (Aws S3 or similar) don't necessarily need to have a persistent local data folder or to change the permission.

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.