dendrite/build/docker
Till f8fba0c0de
Fix building Pinecone and Yggrasil docker images (#3592)
Fixes #3503 

### Pull Request Checklist

<!-- Please read
https://matrix-org.github.io/dendrite/development/contributing before
submitting your pull request -->

* [x] I have added Go unit tests or [Complement integration
tests](https://github.com/matrix-org/complement) for this PR _or_ I have
justified why this PR doesn't need tests
* [x] Pull request includes a [sign off
below](https://element-hq.github.io/dendrite/development/contributing#sign-off)
_or_ I have already signed off privately

Signed-off-by: Till Faelligen <2353100+S7evinK@users.noreply.github.com>
2025-06-05 20:45:15 +02:00
..
DendriteJS.Dockerfile Fix DendriteJS dockerfile 2022-02-08 16:18:16 +00:00
docker-compose.yml Speedup building docker images in CI (#3467) 2024-12-18 11:23:41 +01:00
Dockerfile.demo-pinecone Fix building Pinecone and Yggrasil docker images (#3592) 2025-06-05 20:45:15 +02:00
Dockerfile.demo-yggdrasil Fix building Pinecone and Yggrasil docker images (#3592) 2025-06-05 20:45:15 +02:00
images-build.sh Avoid image confusion 2024-12-18 12:40:32 +01:00
images-pull.sh Speedup building docker images in CI (#3467) 2024-12-18 11:23:41 +01:00
images-push.sh Speedup building docker images in CI (#3467) 2024-12-18 11:23:41 +01:00
README.md Speedup building docker images in CI (#3467) 2024-12-18 11:23:41 +01:00

Docker images

These are Docker images for Dendrite!

They can be found on Docker Hub:

Dockerfile

The Dockerfile is a multistage file which can build Dendrite. From the root of the Dendrite repository, run:

docker build -t ghcr.io/element-hq/dendrite-monolith:latest .

Compose file

There is one sample docker-compose files:

  • docker-compose.yml which runs a Dendrite deployment with Postgres

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 \
  ghcr.io/element-hq/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

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

Then start the deployment:

docker-compose -f docker-compose.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.