Browse Source

Merge branch 'master' into 'master'

Update READMEs for using the docker images.

See merge request famedly/conduit!139
merge-requests/139/merge
Yatekii 4 years ago
parent
commit
6f94b6de0e
  1. 12
      README.md
  2. 10
      docker/README.md

12
README.md

@ -80,11 +80,19 @@ Pull and run the docker image with @@ -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)

10
docker/README.md

@ -40,9 +40,17 @@ which also will tag the resulting image as `matrixconduit/matrix-conduit:latest` @@ -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.

Loading…
Cancel
Save