summaryrefslogtreecommitdiff
path: root/docker/README.md
diff options
context:
space:
mode:
authorJonas Zohren <git-pbkyr@jzohren.de>2022-02-20 11:43:50 +0100
committerJonas Zohren <git-pbkyr@jzohren.de>2022-02-20 11:43:50 +0100
commit86162c2c20c04305c01a0d17430bb360e8ab9782 (patch)
tree749a2cd14f7bf73a80664f05b942cfe7ada3a415 /docker/README.md
parent57ac4160b75981b6354d69168fd506e96138d265 (diff)
parent199c84195a5721aed9aa1585f61a242d0cab5244 (diff)
downloadconduit-86162c2c20c04305c01a0d17430bb360e8ab9782.zip
Merge branch 'next' into docs
Diffstat (limited to 'docker/README.md')
-rw-r--r--docker/README.md29
1 files changed, 22 insertions, 7 deletions
diff --git a/docker/README.md b/docker/README.md
index f9d94ab..c980adc 100644
--- a/docker/README.md
+++ b/docker/README.md
@@ -56,8 +56,18 @@ If you just want to test Conduit for a short time, you can use the `--rm` flag,
## Docker-compose
-If the docker command is not for you or your setup, you can also use one of the provided `docker-compose` files. Depending on your proxy setup, use the [`docker-compose.traefik.yml`](docker-compose.traefik.yml) and [`docker-compose.override.traefik.yml`](docker-compose.override.traefik.yml) for Traefik (don't forget to remove `.traefik` from the filenames) or the normal [`docker-compose.yml`](../docker-compose.yml) for every other reverse proxy. Additional info about deploying
-Conduit can be found [here](../DEPLOY.md).
+If the `docker run` command is not for you or your setup, you can also use one of the provided `docker-compose` files.
+
+Depending on your proxy setup, you can use one of the following files;
+- If you already have a `traefik` instance set up, use [`docker-compose.for-traefik.yml`](docker-compose.for-traefik.yml)
+- If you don't have a `traefik` instance set up (or any other reverse proxy), use [`docker-compose.with-traefik.yml`](docker-compose.with-traefik.yml)
+- For any other reverse proxy, use [`docker-compose.yml`](docker-compose.yml)
+
+When picking the traefik-related compose file, rename it so it matches `docker-compose.yml`, and
+rename the override file to `docker-compose.override.yml`. Edit the latter with the values you want
+for your server.
+
+Additional info about deploying Conduit can be found [here](../DEPLOY.md).
### Build
@@ -81,11 +91,16 @@ docker-compose up -d
### Use Traefik as Proxy
-As a container user, you probably know about Traefik. It is a easy to use reverse proxy for making containerized app and services available through the web. With the
-two provided files, [`docker-compose.traefik.yml`](docker-compose.traefik.yml) and [`docker-compose.override.traefik.yml`](docker-compose.override.traefik.yml), it is
-equally easy to deploy and use Conduit, with a little caveat. If you already took a look at the files, then you should have seen the `well-known` service, and that is
-the little caveat. Traefik is simply a proxy and loadbalancer and is not able to serve any kind of content, but for Conduit to federate, we need to either expose ports
-`443` and `8448` or serve two endpoints `.well-known/matrix/client` and `.well-known/matrix/server`.
+As a container user, you probably know about Traefik. It is a easy to use reverse proxy for making
+containerized app and services available through the web. With the two provided files,
+[`docker-compose.for-traefik.yml`](docker-compose.for-traefik.yml) (or
+[`docker-compose.with-traefik.yml`](docker-compose.with-traefik.yml)) and
+[`docker-compose.override.yml`](docker-compose.override.traefik.yml), it is equally easy to deploy
+and use Conduit, with a little caveat. If you already took a look at the files, then you should have
+seen the `well-known` service, and that is the little caveat. Traefik is simply a proxy and
+loadbalancer and is not able to serve any kind of content, but for Conduit to federate, we need to
+either expose ports `443` and `8448` or serve two endpoints `.well-known/matrix/client` and
+`.well-known/matrix/server`.
With the service `well-known` we use a single `nginx` container that will serve those two files.