diff options
author | Frederic Guillot <fred@kanboard.net> | 2015-08-29 20:00:53 -0400 |
---|---|---|
committer | Frederic Guillot <fred@kanboard.net> | 2015-08-29 20:00:53 -0400 |
commit | 6c711f696f73bc59813f6834ec241aef3b626cbd (patch) | |
tree | ded4f0e8c7f8c672414ff3f2f84eac0f6d9073e5 /doc/docker.markdown | |
parent | ef087f5e22df1a0d97babef26aaf9b8960ee6d5d (diff) |
Include documentation in the application
Diffstat (limited to 'doc/docker.markdown')
-rw-r--r-- | doc/docker.markdown | 47 |
1 files changed, 47 insertions, 0 deletions
diff --git a/doc/docker.markdown b/doc/docker.markdown new file mode 100644 index 00000000..44f3b976 --- /dev/null +++ b/doc/docker.markdown @@ -0,0 +1,47 @@ +How to run Kanboard with Docker? +================================ + +Kanboard can run easily with [Docker](https://www.docker.com). +There is a `Dockerfile` in the repository to build your own container. + +Use the automated build +----------------------- + +Every new commit on the repository trigger a new build on [Docker Hub](https://registry.hub.docker.com/u/kanboard/kanboard/). + +```bash +docker pull kanboard/kanboard +docker run -d --name kanboard -p 80:80 -t kanboard/kanboard:latest +``` + +The tag **latest** is the **development version** of Kanboard, use at your own risk. + +Build your own Docker image +--------------------------- + +Clone the Kanboard repository and 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 +``` + +Store your data on a volume +--------------------------- + +By default Kanboard will store attachments and the Sqlite database in the directory data. Run this command to use a custom volume path: + +```bash +docker run -d --name kanboard -v /your/local/data/folder:/var/www/html/data -p 80:80 -t kanboard/kanboard:master +``` + +References +---------- + +- [Official Kanboard images](https://registry.hub.docker.com/u/kanboard/kanboard/) +- [Docker documentation](https://docs.docker.com/) |