char/dendrite
1
0
Fork 0
Code Issues Pull requests Projects Releases Wiki Activity
dendrite/build/docker
History
Neil Alexander cf82e08096
Update GHA Docker Hub builds 
Squashed commit of the following:

commit 4a61aa711473deece2adf415cfd65501dbca63b2
Author: Neil Alexander <neilalexander@users.noreply.github.com>
Date:   Mon Jan 18 12:19:24 2021 +0000

    Set back to matrixdotorg on published releases

commit 6d1ac53f2c0c9b30e1e70c0bb1559e1b8ec874a2
Author: Neil Alexander <neilalexander@users.noreply.github.com>
Date:   Mon Jan 18 11:55:28 2021 +0000

    Rename

commit 258999f7fb7b655b3a02a06a7ea05e66fb7740fb
Author: Neil Alexander <neilalexander@users.noreply.github.com>
Date:   Mon Jan 18 11:52:26 2021 +0000

    Refactor multi-stage builds

commit c7ab8e476939899571e7b5668860dec372b9b60f
Author: Neil Alexander <neilalexander@users.noreply.github.com>
Date:   Mon Jan 18 11:13:19 2021 +0000

    Let's try this again
2021-01-18 12:24:23 +00:00
..
config Fix max_open_conns in Dendrite sample config 2020-12-11 10:48:24 +00:00
postgres Multi-personality polylith binary (#1552) 2020-10-20 16:11:24 +01:00
DendriteJS.Dockerfile Implement ExtraPublicRoomsProvider for p2p demos (#1180) 2020-07-03 12:59:00 +01:00
docker-compose.deps.yml Update docker-compose.deps.yml to use postgres:11 (#1677) 2021-01-04 10:36:36 +00:00
docker-compose.monolith.yml Update Docker sample configs 2020-10-27 13:58:58 +00:00
docker-compose.polylith.yml Multi-personality polylith binary (#1552) 2020-10-20 16:11:24 +01:00
Dockerfile.monolith Update GHA Docker Hub builds 2021-01-18 12:24:23 +00:00
Dockerfile.polylith Update GHA Docker Hub builds 2021-01-18 12:24:23 +00:00
images-build.sh Update GHA Docker Hub builds 2021-01-18 12:24:23 +00:00
images-pull.sh Multi-personality polylith binary (#1552) 2020-10-20 16:11:24 +01:00
images-push.sh Multi-personality polylith binary (#1552) 2020-10-20 16:11:24 +01:00
README.md Fixed links to Docker Hub (#1686) 2021-01-07 13:02:15 +00:00

README.md

Docker images

These are Docker images for Dendrite!

They can be found on Docker Hub:

Dockerfiles

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.

Compose files

There are three sample docker-compose files:

  • 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

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 the sample dendrite-config.yaml in the docker/config folder in the Dendrite repository
  • 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:

go run github.com/matrix-org/dendrite/cmd/generate-keys \
  --private-key=matrix_key.pem \
  --tls-cert=server.crt \
  --tls-key=server.key

Starting Dendrite as a monolith deployment

Create your config based on the dendrite.yaml configuration file in the docker/config folder in the Dendrite repository. Additionally, make the following changes to the configuration:

  • Enable Naffka: use_naffka: true

Once in place, start the PostgreSQL dependency:

docker-compose -f docker-compose.deps.yml up postgres

Wait a few seconds for PostgreSQL to finish starting up, and then start a monolith:

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

Starting Dendrite as a polylith deployment

Create your config based on the dendrite.yaml configuration file in the docker/config folder in the Dendrite repository.

Once in place, start all the dependencies:

docker-compose -f docker-compose.deps.yml up

Wait a few seconds for PostgreSQL and Kafka to finish starting up, and then start a polylith:

docker-compose -f docker-compose.polylith.yml up

Building the images

The docker/images-build.sh script will build the base image, followed by all of the component images.

The 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.