summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorFrédéric Guillot <fred@kanboard.net>2014-10-13 19:24:09 -0400
committerFrédéric Guillot <fred@kanboard.net>2014-10-13 19:24:09 -0400
commitd0e6d2e1f177cfe533ea7819bf79b0469b8d0cc2 (patch)
tree054492608593f16af0c8b8c481ef8a67bee4ed74 /docs
parent6fdf3264aabd64f1887899975adb2d630f357318 (diff)
Add Docker config file and documentation
Diffstat (limited to 'docs')
-rw-r--r--docs/docker.markdown48
1 files changed, 48 insertions, 0 deletions
diff --git a/docs/docker.markdown b/docs/docker.markdown
new file mode 100644
index 00000000..92fcf2c3
--- /dev/null
+++ b/docs/docker.markdown
@@ -0,0 +1,48 @@
+How to test Kanboard with Docker?
+=================================
+
+Kanboard can run with [Docker](https://www.docker.com).
+You can use the public image or build your own image from the `Dockerfile`.
+
+Actually, the Docker image is based on the master branch (development version).
+
+Build your own Docker image
+---------------------------
+
+From your kanboard directory run the following command:
+
+```bash
+docker build -t youruser\kanboard:master .
+```
+
+To run your image in background on the port 80:
+
+```bash
+docker run -d --name kanboard -p 80:80 -t youruser/kanboard:master
+```
+
+Run the public Kanboard image
+-----------------------------
+
+This image is stored on the [Docker Hub](https://hub.docker.com).
+
+Fetch the image on your machine:
+
+```bash
+docker pull kanboard/kanboard:master
+```
+
+Run the image:
+
+```bash
+docker run -d --name kanboard -p 80:80 -t kanboard/kanboard:master
+```
+
+Store your data on a volume
+---------------------------
+
+You can also save your data outside of the container, on the local machine:
+
+```bash
+docker run -d --name kanboard -v /your/local/data/folder:/var/www/html/data -p 80:80 -t kanboard/kanboard:master
+```