diff --git a/Installing-on-Docker.md b/Installing-on-Docker.md new file mode 100644 index 0000000..26fffa5 --- /dev/null +++ b/Installing-on-Docker.md @@ -0,0 +1,58 @@ +# Installing on Docker + +There is a `Dockerfile` at the root of this repository which you can use to build your own Docker image. There is not an officially published Docker image from this file though. However, there is a third party automatically built and published Docker image on Docker Hub at https://hub.docker.com/r/grepular/radicale. This image is built automatically once a day if a new version of Radicale has been released, by an automated workflow at this Gitlab repository https://gitlab.com/grepular/docker-radicale. For a given `major.minor.patch` version release, the following Docker tags are published: + +- latest +- major.minor.patch +- major.minor +- major + +## Trust + +The person behind this auto-built image is - https://www.grepular.com / https://github.com/mikecardwell / https://gitlab.com/mikecardwell and it's origin is this discussion - https://github.com/Kozea/Radicale/discussions/1745 + +## Example run using docker command + +``` +docker run \ + -p 127.0.0.1:5232:5232 \ + -v "$PWD/config:/etc/radicale" \ + -v "$PWD/data:/var/lib/radicale" \ + grepular/radicale:3 +``` + +Now you should be able to access it at http://127.0.0.1:5232 + +## Example docker-compose.yml file + +``` +--- +version: "2.1" +services: + radicale: + image: grepular/radicale:3 + user: root + ports: + - "5232:5232" + volumes: + - /opt/radicale/config:/etc/radicale:ro + - /opt/radicale/data:/var/lib/radicale + restart: unless-stopped +``` + +If you wish to build the image locally as part of your docker-compose configuration, you can replace the "image" entry with a "build" entry linking to the official repository: + +``` +--- +version: "2.1" +services: + radicale: + build: github.com/Kozea/Radicale#v3.5.2 + user: root + ports: + - "5232:5232" + volumes: + - /opt/radicale/config:/etc/radicale:ro + - /opt/radicale/data:/var/lib/radicale + restart: unless-stopped +``` \ No newline at end of file