diff options
| author | purplemeteorite <purplemeteorite@protonmail.com> | 2023-06-28 18:51:44 +0200 |
|---|---|---|
| committer | purplemeteorite <purplemeteorite@protonmail.com> | 2023-06-28 18:51:44 +0200 |
| commit | 06a1321e5692b240e0ce1e117cce0bd7008908eb (patch) | |
| tree | 9232446cc45665febac605526828a49399b2e140 /docker | |
| parent | 3a1a72df987b64d32d170e6d0996df7eca1419cd (diff) | |
| download | conduit-06a1321e5692b240e0ce1e117cce0bd7008908eb.zip | |
easier-to-read docker setup instructions
Diffstat (limited to 'docker')
| -rw-r--r-- | docker/README.md | 41 |
1 files changed, 29 insertions, 12 deletions
diff --git a/docker/README.md b/docker/README.md index c702832..ef93af2 100644 --- a/docker/README.md +++ b/docker/README.md @@ -4,7 +4,31 @@ ## Docker -### Build & Dockerfile +To run conduit with docker you can either build the image yourself or pull it from a registry. + + +### Use a registry + +The image is available in the following registries: + +| Registry | Image | Size | +| --------------- | --------------------------------------------------------------- | --------------------- | +| Docker Hub | [matrixconduit/matrix-conduit:latest][dh] | ![Image Size][shield] | +| GitLab Registry | [registry.gitlab.com/famedly/conduit/matrix-conduit:latest][gl] | ![Image Size][shield] | + +[dh]: https://hub.docker.com/r/matrixconduit/matrix-conduit +[gl]: https://gitlab.com/famedly/conduit/container_registry/2497937 +[shield]: https://img.shields.io/docker/image-size/matrixconduit/matrix-conduit/latest + +Use +```bash +docker image pull <link> +``` +to pull it to your machine. + + + +### Build using a dockerfile The Dockerfile provided by Conduit has two stages, each of which creates an image. @@ -19,9 +43,11 @@ docker build --tag matrixconduit/matrix-conduit:latest . which also will tag the resulting image as `matrixconduit/matrix-conduit:latest`. + + ### Run -After building the image you can simply run it with +When you have the image you can simply run it with ```bash docker run -d -p 8448:6167 \ @@ -37,16 +63,7 @@ docker run -d -p 8448:6167 \ --name conduit matrixconduit/matrix-conduit:latest ``` -or you can skip the build step and pull the image from one of the following registries: - -| Registry | Image | Size | -| --------------- | --------------------------------------------------------------- | --------------------- | -| Docker Hub | [matrixconduit/matrix-conduit:latest][dh] | ![Image Size][shield] | -| GitLab Registry | [registry.gitlab.com/famedly/conduit/matrix-conduit:latest][gl] | ![Image Size][shield] | - -[dh]: https://hub.docker.com/r/matrixconduit/matrix-conduit -[gl]: https://gitlab.com/famedly/conduit/container_registry/2497937 -[shield]: https://img.shields.io/docker/image-size/matrixconduit/matrix-conduit/latest +or you can use [docker-compose](#docker-compose). The `-d` flag lets the container run in detached mode. You now need to supply a `conduit.toml` config file, an example can be found [here](../conduit-example.toml). You can pass in different env vars to change config values on the fly. You can even configure Conduit completely by using env vars, but for that you need |