Skip to content

Commit

Permalink
link to element-docker-demo from contrib/docker* (#17953)
Browse files Browse the repository at this point in the history
  • Loading branch information
ara4n authored Nov 22, 2024
1 parent 80e39fd commit 4c67d20
Show file tree
Hide file tree
Showing 3 changed files with 7 additions and 0 deletions.
1 change: 1 addition & 0 deletions changelog.d/17953.doc
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Link to element-docker-demo from contrib/docker*.
3 changes: 3 additions & 0 deletions contrib/docker/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,3 +30,6 @@ docker-compose up -d
### More information

For more information on required environment variables and mounts, see the main docker documentation at [/docker/README.md](../../docker/README.md)

**For a more comprehensive Docker Compose example showcasing a full Matrix 2.0 stack, please see
https://github.com/element-hq/element-docker-demo**
3 changes: 3 additions & 0 deletions contrib/docker_compose_workers/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,9 @@ All examples and snippets assume that your Synapse service is called `synapse` i

An example Docker Compose file can be found [here](docker-compose.yaml).

**For a more comprehensive Docker Compose example, showcasing a full Matrix 2.0 stack (originally based on this
docker-compose.yaml), please see https://github.com/element-hq/element-docker-demo**

## Worker Service Examples in Docker Compose

In order to start the Synapse container as a worker, you must specify an `entrypoint` that loads both the `homeserver.yaml` and the configuration for the worker (`synapse-generic-worker-1.yaml` in the example below). You must also include the worker type in the environment variable `SYNAPSE_WORKER` or alternatively pass `-m synapse.app.generic_worker` as part of the `entrypoint` after `"/start.py", "run"`).
Expand Down

0 comments on commit 4c67d20

Please sign in to comment.