stiag
/
matrix-org.dendrite
mirror of https://github.com/matrix-org/dendrite.git
1
0
Fork 0
Code Releases Wiki Activity
matrix-org.dendrite/build/docker
History
Yoann N d34277a6c0
Update README sample config link (#2987) 
### 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 using a legally
identifiable
name](https://matrix-org.github.io/dendrite/development/contributing#sign-off)
_or_ I have already signed off privately
 		2023-02-23 09:07:20 +01:00
..
postgres Remove references to `userapi_devices` (fixes #2259) 2022-03-09 16:38:50 +00:00
DendriteJS.Dockerfile Fix DendriteJS dockerfile 2022-02-08 16:18:16 +00:00
Dockerfile.demo-pinecone Add curl to dendrite-demo-pinecone docker container 2023-01-06 12:02:43 -07:00
Dockerfile.demo-yggdrasil Put P2P Demos back into their own Dockerfiles 2022-11-03 13:57:44 +00:00
README.md Update README sample config link (#2987) 2023-02-23 09:07:20 +01:00
docker-compose.monolith.yml Add NATS JetStream support (#1866) 2022-01-05 17:44:49 +00:00
images-build.sh Remove polylith/API mode (#2967) 2023-02-14 12:47:47 +01:00
images-pull.sh Remove polylith/API mode (#2967) 2023-02-14 12:47:47 +01:00
images-push.sh Remove polylith/API mode (#2967) 2023-02-14 12:47:47 +01:00

README.md

Docker images

These are Docker images for Dendrite!

They can be found on Docker Hub:

Dockerfiles

The Dockerfile is a multistage file which can build all four 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 demo-pinecone -t matrixdotorg/dendrite-demo-pinecone
docker build . --target demo-yggdrasil -t matrixdotorg/dendrite-demo-yggdrasil

Compose files

There are two sample docker-compose files:

  • docker-compose.monolith.yml which runs a monolith 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

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

Then start the deployment:

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