2020-06-05 18:00:30 +00:00
# Docker images
2018-01-02 18:26:37 +00:00
2020-06-05 18:00:30 +00:00
These are Docker images for Dendrite!
2018-01-02 18:26:37 +00:00
2020-11-16 11:27:59 +00:00
They can be found on Docker Hub:
2021-01-07 13:02:15 +00:00
- [matrixdotorg/dendrite-monolith ](https://hub.docker.com/r/matrixdotorg/dendrite-monolith ) for monolith deployments
2020-11-16 11:27:59 +00:00
2020-06-05 18:00:30 +00:00
## Dockerfiles
2018-01-02 18:26:37 +00:00
2022-11-02 14:04:08 +00:00
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
```
2018-01-02 18:26:37 +00:00
2020-06-05 18:00:30 +00:00
## Compose files
2018-01-02 18:26:37 +00:00
2022-11-03 12:18:25 +00:00
There are two sample `docker-compose` files:
2018-01-02 18:26:37 +00:00
2020-06-05 18:00:30 +00:00
- `docker-compose.monolith.yml` which runs a monolith Dendrite deployment
2018-01-02 18:26:37 +00:00
2020-06-05 18:00:30 +00:00
## Configuration
2018-01-02 18:26:37 +00:00
2020-06-05 18:00:30 +00:00
The `docker-compose` files refer to the `/etc/dendrite` volume as where the
runtime config should come from. The mounted folder must contain:
2018-01-02 18:26:37 +00:00
2022-05-12 11:05:55 +00:00
- `dendrite.yaml` configuration file (based on one of the sample config files)
2020-06-05 18:00:30 +00:00
- `matrix_key.pem` server key, as generated using `cmd/generate-keys`
- `server.crt` certificate file
- `server.key` private key file for the above certificate
2018-01-02 18:26:37 +00:00
2020-06-05 18:00:30 +00:00
To generate keys:
2018-01-02 18:26:37 +00:00
```
2021-06-14 13:08:59 +00:00
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
2018-01-02 18:26:37 +00:00
```
2021-06-14 13:08:59 +00:00
The key files will now exist in your current working directory, and can be mounted into place.
2023-02-14 11:47:47 +00:00
## Starting Dendrite
2018-01-02 18:26:37 +00:00
2022-05-12 11:05:55 +00:00
Create your config based on the [`dendrite-sample.monolith.yaml` ](https://github.com/matrix-org/dendrite/blob/main/dendrite-sample.monolith.yaml ) sample configuration file.
2020-10-13 08:50:11 +00:00
2022-01-05 17:44:49 +00:00
Then start the deployment:
2018-01-02 18:26:37 +00:00
```
2020-06-05 18:00:30 +00:00
docker-compose -f docker-compose.monolith.yml up
2018-01-02 18:26:37 +00:00
```
2020-06-05 18:00:30 +00:00
## Building the images
2018-01-02 18:26:37 +00:00
2021-07-12 09:13:17 +00:00
The `build/docker/images-build.sh` script will build the base image, followed by
2020-06-05 18:00:30 +00:00
all of the component images.
2018-01-02 18:26:37 +00:00
2021-07-12 09:13:17 +00:00
The `build/docker/images-push.sh` script will push them to Docker Hub (subject
2020-06-05 18:00:30 +00:00
to permissions).
2018-01-02 18:26:37 +00:00
2020-06-05 18:00:30 +00:00
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` .
