summaryrefslogtreecommitdiff
path: root/doc/en_US/heroku.markdown
diff options
context:
space:
mode:
Diffstat (limited to 'doc/en_US/heroku.markdown')
-rw-r--r--doc/en_US/heroku.markdown39
1 files changed, 39 insertions, 0 deletions
diff --git a/doc/en_US/heroku.markdown b/doc/en_US/heroku.markdown
new file mode 100644
index 00000000..1891efb0
--- /dev/null
+++ b/doc/en_US/heroku.markdown
@@ -0,0 +1,39 @@
+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
+-----------
+
+- The storage of Heroku is ephemeral, that means uploaded files through Kanboard 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).
+- Some features of Kanboard require that you run [a daily background job](cronjob.markdown).