History

Till e6c992ba8b Update Dockerfile (#2342 ) Updates/adds a new multistage (build-kit) Dockerfile. (if accepted, could make `Dockerfile.monolith` and `Dockerfile.polylith` in `build/docker` obsolete) There's no huge difference between the dockerfiles, except this uses a non-root user when running the container, also doesn't copy the working directory to the image when building. Also adds vulnerabilities scans using [Trivy](https://github.com/aquasecurity/trivy) for the created docker images. (untested) Building images is done using ``` docker build . --target image-monolith -t dendrite-monolith docker build . --target image-polylith -t dendrite-polylith ``` As noted in the comments, only adds `dendrite-polylith-multi` to the polylith image and all required binaries to the monolith image. Probably needs some docs updating, if this is accepted. Co-authored-by: Neil Alexander <neilalexander@users.noreply.github.com>		2022-10-04 10:41:06 +01:00
..
postgres	Remove references to `userapi_devices` (fixes #2259 )	2022-03-09 16:38:50 +00:00
crossbuild.sh	Update Dockerfile (#2342 )	2022-10-04 10:41:06 +01:00
DendriteJS.Dockerfile	Fix DendriteJS dockerfile	2022-02-08 16:18:16 +00:00
docker-compose.monolith.yml
docker-compose.polylith.yml	Remove eduserver (#2306 )	2022-03-29 14:14:35 +02:00
images-build.sh	Update Dockerfile (#2342 )	2022-10-04 10:41:06 +01:00
images-pull.sh	Use /usr/bin/env bash in shebangs to make them universal (#2735 )	2022-09-27 09:42:08 +01:00
images-push.sh	Use /usr/bin/env bash in shebangs to make them universal (#2735 )	2022-09-27 09:42:08 +01:00
README.md	Update Dockerfile (#2342 )	2022-10-04 10:41:06 +01:00

README.md

Docker images

These are Docker images for Dendrite!

They can be found on Docker Hub:

matrixdotorg/dendrite-monolith for monolith deployments
matrixdotorg/dendrite-polylith for polylith deployments

Dockerfiles

The Dockerfile is a multistage file which can build all three Dendrite images depending on the supplied --target. From the root of the Dendrite repository, run:

docker build . --target monolith -t matrixdotorg/dendrite-monolith
docker build . --target polylith -t matrixdotorg/dendrite-monolith
docker build . --target demo-pinecone -t matrixdotorg/dendrite-monolith

Compose files

There are three sample docker-compose files:

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 one of the sample config files)
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-sample.monolith.yaml sample configuration file.

Then start the deployment:

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

Starting Dendrite as a polylith deployment

Create your config based on the dendrite-sample.polylith.yaml sample configuration file.

Then start the deployment:

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.