summaryrefslogtreecommitdiff
path: root/doc/en_US/heroku.markdown
blob: fa8d29b9fab260651cfcbe664055a0fe89f5df42 (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
Deploy Kanboard on Heroku
=========================

You can try Kanboard for free on [Heroku](https://www.heroku.com/).
You can use this one click install button or follow the manual instructions below:

[![Deploy](https://www.herokucdn.com/deploy/button.png)](https://heroku.com/deploy?template=https://github.com/kanboard/kanboard)

Requirements
------------

- Heroku account, you can use a free account
- Heroku command line tools installed

Manual instructions
-------------------

```bash
# Get the last development version
git clone https://github.com/kanboard/kanboard.git
cd kanboard

# Push the code to Heroku (You can also use SSH if git over HTTP doesn't work)
heroku create
git push heroku master

# Start a new dyno with a Postgresql database
heroku ps:scale web=1
heroku addons:add heroku-postgresql:hobby-dev

# Open your browser
heroku open
```

Limitations
-----------

Local disk storage on Heroku is ephemeral:

- Uploaded files are not persistent after a restart. You may want to install a plugin to store your files in a cloud storage provider like [Amazon S3](https://github.com/kanboard/plugin-s3).
- Plugins installed via the web interface are stored on the local filesystem. You should include and deploy plugins with your own copy of Kanboard.

Some features of Kanboard require that you run [a daily background job](cronjob.markdown).