Update documentation about Docker
This commit is contained in:
parent
55547db6ce
commit
0573c92d09
|
|
@ -30,3 +30,4 @@ Installation and Upgrade
|
|||
- [Requirements](https://github.com/kanboard/kanboard/blob/master/doc/en_US/requirements.markdown)
|
||||
- [Installation instructions](https://github.com/kanboard/kanboard/blob/master/doc/en_US/installation.markdown)
|
||||
- [Upgrade to a new version](https://github.com/kanboard/kanboard/blob/master/doc/en_US/update.markdown)
|
||||
- [Use Kanboard with Docker](https://github.com/kanboard/kanboard/blob/master/doc/en_US/docker.markdown)
|
||||
|
|
|
|||
|
|
@ -3,7 +3,7 @@ How to run Kanboard with Docker?
|
|||
|
||||
Kanboard can run easily with [Docker](https://www.docker.com).
|
||||
|
||||
The image size is approximately **70MB** and contains:
|
||||
The image size is approximately **50MB** and contains:
|
||||
|
||||
- [Alpine Linux](http://alpinelinux.org/)
|
||||
- The [process manager S6](http://skarnet.org/software/s6/)
|
||||
|
|
@ -15,50 +15,39 @@ URL rewriting is enabled in the included config file.
|
|||
|
||||
When the container is running, the memory utilization is around **30MB**.
|
||||
|
||||
Use the stable version
|
||||
----------------------
|
||||
Use the latest release version
|
||||
------------------------------
|
||||
|
||||
To fetch the latest stable release of Kanboard use the tag **stable**:
|
||||
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
|
||||
docker run -d --name kanboard -p 80:80 -t kanboard/kanboard:stable
|
||||
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://registry.hub.docker.com/u/kanboard/kanboard/).
|
||||
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
|
||||
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, use at your own risk.
|
||||
The tag **latest** is the **development version** of Kanboard and represents the master branch, use at your own risk.
|
||||
|
||||
Build your own Docker image
|
||||
---------------------------
|
||||
|
||||
There is a `Dockerfile` in the Kanboard repository to build your own image.
|
||||
Clone the Kanboard repository and run the following command:
|
||||
|
||||
```bash
|
||||
docker build -t youruser/kanboard:master .
|
||||
```
|
||||
|
||||
or
|
||||
|
||||
```bash
|
||||
make docker-image
|
||||
```
|
||||
|
||||
To run your container in background on the port 80:
|
||||
|
||||
```bash
|
||||
docker run -d --name kanboard -p 80:80 -t youruser/kanboard:master
|
||||
```
|
||||
|
||||
Volumes
|
||||
-------
|
||||
|
||||
|
|
@ -69,6 +58,8 @@ You can attach 2 volumes to your container:
|
|||
|
||||
Use the flag `-v` to mount a volume on the host machine like described in [official Docker documentation](https://docs.docker.com/engine/userguide/containers/dockervolumes/).
|
||||
|
||||
There is also a `docker-compose.yml` file in the repository.
|
||||
|
||||
Upgrade your container
|
||||
----------------------
|
||||
|
||||
|
|
@ -86,12 +77,12 @@ 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`.
|
||||
- If you change your config file values, you must restart the container to take into account the new parameters.
|
||||
- You must restart the container to take into account the new parameters of your custom config file.
|
||||
|
||||
References
|
||||
----------
|
||||
Notes
|
||||
-----
|
||||
|
||||
- [Official Kanboard images](https://registry.hub.docker.com/u/kanboard/kanboard/)
|
||||
- [Official Kanboard images](https://hub.docker.com/r/kanboard/kanboard/)
|
||||
- [Docker documentation](https://docs.docker.com/)
|
||||
- [Dockerfile stable version](https://github.com/kanboard/docker)
|
||||
- [Dockerfile dev version](https://github.com/kanboard/kanboard/blob/master/Dockerfile)
|
||||
- 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
|
||||
|
|
|
|||
Loading…
Reference in New Issue