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-06-05 18:00:30 +00:00
|
|
|
## Dockerfiles
|
2018-01-02 18:26:37 +00:00
|
|
|
|
2020-06-05 18:00:30 +00:00
|
|
|
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.
|
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
|
|
|
|
2020-06-05 18:00:30 +00:00
|
|
|
There are three sample `docker-compose` files:
|
2018-01-02 18:26:37 +00:00
|
|
|
|
2020-06-05 18:00:30 +00:00
|
|
|
- `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
|
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
|
|
|
|
2020-06-05 18:00:30 +00:00
|
|
|
- `dendrite.yaml` configuration file (based on the sample `dendrite-config.yaml`
|
|
|
|
|
in the `docker/config` folder in the [Dendrite repository](https://github.com/matrix-org/dendrite)
|
|
|
|
|
- `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
|
|
|
|
|
|
|
|
```
|
2020-06-05 18:00:30 +00:00
|
|
|
go run github.com/matrix-org/dendrite/cmd/generate-keys \
|
|
|
|
|
--private-key=matrix_key.pem \
|
|
|
|
|
--tls-cert=server.crt \
|
|
|
|
|
--tls-key=server.key
|
2018-01-02 18:26:37 +00:00
|
|
|
```
|
|
|
|
|
|
2020-06-05 18:00:30 +00:00
|
|
|
## Starting Dendrite
|
2018-01-02 18:26:37 +00:00
|
|
|
|
2020-06-05 18:00:30 +00:00
|
|
|
Once in place, start the dependencies:
|
2018-01-02 18:26:37 +00:00
|
|
|
|
2020-06-05 18:00:30 +00:00
|
|
|
```
|
|
|
|
|
docker-compose -f docker-compose.deps.yml up
|
|
|
|
|
```
|
2018-01-02 18:26:37 +00:00
|
|
|
|
2020-06-05 18:00:30 +00:00
|
|
|
Wait a few seconds for Kafka and Postgres to finish starting up, and then start a monolith:
|
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
|
|
|
... or start the polylith components:
|
2018-01-02 18:26:37 +00:00
|
|
|
|
|
|
|
|
```
|
2020-06-05 18:00:30 +00:00
|
|
|
docker-compose -f docker-compose.polylith.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
|
|
|
|
2020-06-05 18:00:30 +00:00
|
|
|
The `docker/images-build.sh` script will build the base image, followed by
|
|
|
|
|
all of the component images.
|
2018-01-02 18:26:37 +00:00
|
|
|
|
2020-06-05 18:00:30 +00:00
|
|
|
The `docker/images-push.sh` script will push them to Docker Hub (subject
|
|
|
|
|
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`.
|
