dendrite/build/docker
Melroy van den Berg e48a08fef0
Propose config better (#1758)
Better explain where the config file are located and how to deal with the yml file.

Co-authored-by: kegsay <kegan@matrix.org>
2021-07-12 10:13:17 +01:00
..
config fix database names to reflect renaming (#1636) 2021-02-17 15:20:06 +00:00
postgres fix database names to reflect renaming (#1636) 2021-02-17 15:20:06 +00:00
DendriteJS.Dockerfile Unbreak DendriteJS.Dockerfile; Riot is now Element 2021-02-17 15:45:50 +00:00
docker-compose.deps.yml Update docker-compose.deps.yml to use postgres:11 (#1677) 2021-01-04 10:36:36 +00:00
docker-compose.monolith.yml Docker fix and tweak (#1781) 2021-03-03 11:20:40 +00:00
docker-compose.polylith.yml Docker fix and tweak (#1781) 2021-03-03 11:20:40 +00:00
Dockerfile.monolith Docker fix and tweak (#1781) 2021-03-03 11:20:40 +00:00
Dockerfile.polylith Docker fix and tweak (#1781) 2021-03-03 11:20:40 +00:00
images-build.sh Update GHA Docker Hub builds 2021-01-18 12:24:23 +00:00
images-pull.sh
images-push.sh
README.md Propose config better (#1758) 2021-07-12 10:13:17 +01:00

Docker images

These are Docker images for Dendrite!

They can be found on Docker Hub:

Dockerfiles

The Dockerfile builds the base image which contains all of the Dendrite components. The Dockerfile.component file takes the given component, as specified with --buildarg component= from the base image and produce smaller component-specific images, which are substantially smaller and do not contain the Go toolchain etc.

Compose files

There are three sample docker-compose files:

  • docker-compose.deps.yml which runs the Postgres and Kafka prerequisites
  • docker-compose.monolith.yml which runs a monolith Dendrite deployment
  • docker-compose.polylith.yml which runs a polylith Dendrite deployment

Configuration

The docker-compose files refer to the /etc/dendrite volume as where the runtime config should come from. The mounted folder must contain:

  • dendrite.yaml configuration file (based on the dendrite-config.yaml sample in the build/docker/config folder of this repository.)
  • matrix_key.pem server key, as generated using cmd/generate-keys
  • server.crt certificate file
  • server.key private key file for the above certificate

To generate keys:

docker run --rm --entrypoint="" \
  -v $(pwd):/mnt \
  matrixdotorg/dendrite-monolith:latest \
  /usr/bin/generate-keys \
  -private-key /mnt/matrix_key.pem \
  -tls-cert /mnt/server.crt \
  -tls-key /mnt/server.key

The key files will now exist in your current working directory, and can be mounted into place.

Starting Dendrite as a monolith deployment

Create your config based on the dendrite-config.yaml configuration file in the build/docker/config folder of this repository. And rename the config file to dendrite.yml (and put it in your config directory).

Once in place, start the PostgreSQL dependency:

docker-compose -f docker-compose.deps.yml up postgres

Wait a few seconds for PostgreSQL to finish starting up, and then start a monolith:

docker-compose -f docker-compose.monolith.yml up

Starting Dendrite as a polylith deployment

Create your config based on the dendrite-config.yaml configuration file in the build/docker/config folder of this repository. And rename the config file to dendrite.yml (and put it in your config directory).

Once in place, start all the dependencies:

docker-compose -f docker-compose.deps.yml up

Wait a few seconds for PostgreSQL and Kafka to finish starting up, and then start a polylith:

docker-compose -f docker-compose.polylith.yml up

Building the images

The build/docker/images-build.sh script will build the base image, followed by all of the component images.

The build/docker/images-push.sh script will push them to Docker Hub (subject to permissions).

If you wish to build and push your own images, rename matrixdotorg/dendrite to the name of another Docker Hub repository in images-build.sh and images-push.sh.