blob: 2c4449305215e1e2c3a3bfb70d43029afa835db3 (
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
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
|
How to run Kanboard with Docker?
================================
Kanboard can run easily with [Docker](https://www.docker.com).
The image size is approximately **50MB** and contains:
- [Alpine Linux](http://alpinelinux.org/)
- The [process manager S6](http://skarnet.org/software/s6/)
- Nginx
- PHP 7
The Kanboard cronjob is also running everyday at midnight.
URL rewriting is enabled in the included config file.
When the container is running, the memory utilization is around **30MB**.
Use the latest release version
------------------------------
From the list of tags on the [Docker Hub](https://hub.docker.com/r/kanboard/kanboard/), choose the version that you would like to install.
For example, to install the version 1.1.1:
```bash
docker pull kanboard/kanboard:v1.1.1
docker run -d --name kanboard -p 80:80 -t kanboard/kanboard:v1.1.1
```
Use the development version (automated build)
---------------------------------------------
Every new commit on the repository trigger a new build on the [Docker Hub](https://hub.docker.com/r/kanboard/kanboard/).
```bash
docker pull kanboard/kanboard:latest
docker run -d --name kanboard -p 80:80 -t kanboard/kanboard:latest
```
The tag **latest** is the **development version** of Kanboard and represents the master branch, use at your own risk.
Build your own Docker image
---------------------------
Clone the Kanboard repository and run the following command:
```bash
make docker-image
```
Volumes
-------
You can attach 2 volumes to your container:
- Data folder: `/var/www/app/data`
- Plugins folder: `/var/www/app/plugins`
Use the flag `-v` to mount a volume on the host machine like described in [official Docker documentation](https://docs.docker.com/storage/volumes/).
There is also a `docker-compose.yml` file in the repository.
Upgrade your container
----------------------
- Pull the new image
- Remove the old container
- Restart a new container with the same volumes
Environment variables
---------------------
The list of environment variables is available on [this page](env.markdown).
Config files
------------
- The container already include a custom config file located at `/var/www/app/config.php`.
- You can store your own config file on the data volume: `/var/www/app/data/config.php`.
- You must restart the container to take into account the new parameters of your custom config file.
Notes
-----
- [Official Kanboard images](https://hub.docker.com/r/kanboard/kanboard/)
- [Docker documentation](https://docs.docker.com/)
- Since Kanboard > v1.1.0, the tag "stable" is not used anymore
- To send emails, you must use the SMTP method or a plugin like Mailgun/Sendgrid/Postmark
|
