diff options
| author | purplemeteorite <purplemeteorite@protonmail.com> | 2023-07-21 20:33:32 +0200 |
|---|---|---|
| committer | purplemeteorite <purplemeteorite@protonmail.com> | 2023-07-21 20:33:32 +0200 |
| commit | bd8fec3836158053714ebc4e9ed61a4451cf831b (patch) | |
| tree | b1069c449c2aedf1d5abd7cb54f9a3a097695e54 | |
| parent | 17180a3e0892f164b0f255c563e8d4fb13e2b2aa (diff) | |
| download | conduit-bd8fec3836158053714ebc4e9ed61a4451cf831b.zip | |
changed registry options
1. Recommended GitLab's own registry over Docker Hub. (Reason: https://gitlab.com/famedly/conduit/-/merge_requests/492#note_1457220261)
2. Added the development image :next to the list of options.
3. Displayed text for Docker Hub now contains "docker.io" as part of the link for easier copy-paste for podman users. Clicking on the link still takes to the website.
| -rw-r--r-- | docker/README.md | 19 |
1 files changed, 12 insertions, 7 deletions
diff --git a/docker/README.md b/docker/README.md index 1b9e046..cd41291 100644 --- a/docker/README.md +++ b/docker/README.md @@ -9,16 +9,21 @@ To run Conduit with Docker you can either build the image yourself or pull it fr ### Use a registry -The image is available in the following registries: +OCI images for Conduit are available in the registries listed below. We recommend using the image tagged as `latest` from GitLab's own registry. + +| Registry | Image | Size | Notes | +| --------------- | --------------------------------------------------------------- | ----------------------------- | ---------------------- | +| GitLab Registry | [registry.gitlab.com/famedly/conduit/matrix-conduit:latest][gl] | ![Image Size][shield-latest] | Stable image. | +| Docker Hub | [docker.io/matrixconduit/matrix-conduit:latest][dh] | ![Image Size][shield-latest] | Stable image. | +| GitLab Registry | [registry.gitlab.com/famedly/conduit/matrix-conduit:next][gl] | ![Image Size][shield-next] | Development version. | +| Docker Hub | [docker.io/matrixconduit/matrix-conduit:next][dh] | ![Image Size][shield-next] | Development version. | -| 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 +[shield-latest]: https://img.shields.io/docker/image-size/matrixconduit/matrix-conduit/latest +[shield-next]: https://img.shields.io/docker/image-size/matrixconduit/matrix-conduit/next + Use ```bash @@ -60,7 +65,7 @@ docker run -d -p 8448:6167 \ -e CONDUIT_TRUSTED_SERVERS="[\"matrix.org\"]" \ -e CONDUIT_MAX_CONCURRENT_REQUESTS="100" \ -e CONDUIT_LOG="warn,rocket=off,_=off,sled=off" \ - --name conduit matrixconduit/matrix-conduit:latest + --name conduit <link> ``` or you can use [docker-compose](#docker-compose). |