From 6409dadedeb51fc8d44d18425a18c99ddf3c3333 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Noah=20H=C3=BCsser?= <yatekii@yatekii.ch>
Date: Wed, 21 Jul 2021 18:16:50 +0200
Subject: [PATCH] Update READMEs for using the docker images.

---
 README.md        | 12 ++++++++++--
 docker/README.md | 10 +++++++++-
 2 files changed, 19 insertions(+), 3 deletions(-)

diff --git a/README.md b/README.md
index fde762c..6a946b2 100644
--- a/README.md
+++ b/README.md
@@ -80,11 +80,19 @@ Pull and run the docker image with
 
 ``` bash
 docker pull matrixconduit/matrix-conduit:latest
-docker run -d -p 8448:8000 -v ~/conduit.toml:/srv/conduit/conduit.toml -v db:/srv/conduit/.local/share/conduit matrixconduit/matrix-conduit:latest
+docker run \
+  -d \
+  -p 8448:6167 \
+  -v ~/conduit.toml:/srv/conduit/conduit.toml \
+  -v db:/srv/conduit/.local/share/conduit matrixconduit/matrix-conduit:latest
 ```
 
+this will map the container local port 6167 to the host local port 8448.
+Furthermore it will map the `conduit.toml` file in your home directory into the container as well as the volume called `db`.
+Be advised that the `db` directory needs to be `rwx` for the `wwww-data` user.
+
 > <b>Note:</b> You also need to supply a `conduit.toml` config file, you can find an example [here](./conduit-example.toml).
-> Or you can pass in `-e CONDUIT_CONFIG=""` and configure Conduit purely with env vars.
+> Or you can pass in `-e CONDUIT_CONFIG=""` and configure Conduit purely with environment variables.
 
 Or build and run it with docker or docker-compose. [Read more](docker/README.md)
 
diff --git a/docker/README.md b/docker/README.md
index 499d1ad..6cb546b 100644
--- a/docker/README.md
+++ b/docker/README.md
@@ -40,9 +40,17 @@ which also will tag the resulting image as `matrixconduit/matrix-conduit:latest`
 After building the image you can simply run it with
 
 ``` bash
-docker run -d -p 8448:8000 -v ~/conduit.toml:/srv/conduit/conduit.toml -v db:/srv/conduit/.local/share/conduit matrixconduit/matrix-conduit:latest
+docker run \
+  -d \
+  -p 8448:6167 \
+  -v ~/conduit.toml:/srv/conduit/conduit.toml \
+  -v db:/srv/conduit/.local/share/conduit matrixconduit/matrix-conduit:latest
 ```
 
+this will map the container local port 6167 to the host local port 8448.
+Furthermore it will map the `conduit.toml` file in your home directory into the container as well as the volume called `db`.
+Be advised that the `db` directory needs to be `rwx` for the `wwww-data` user.
+
 For detached mode, you also need to use the `-d` flag. You also need to supply a `conduit.toml` config file, you can find an example [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
 too pass `-e CONDUIT_CONFIG=""` into your container. For an overview of possible values, please take a look at the `docker-compose.yml` file.