0
0
Fork 1
mirror of https://mau.dev/maunium/synapse.git synced 2024-12-13 23:53:47 +01:00
synapse/contrib/docker
2024-11-22 12:35:03 +00:00
..
docker-compose.yml Update book location 2023-12-13 16:15:22 +00:00
README.md link to element-docker-demo from contrib/docker* (#17953) 2024-11-22 12:35:03 +00:00

Synapse Docker

Configuration

A sample docker-compose.yml is provided, including example labels for reverse proxying and other artifacts. The docker-compose file is an example, please comment/uncomment sections that are not suitable for your usecase.

Specify a SYNAPSE_CONFIG_PATH, preferably to a persistent path, to use manual configuration.

To generate a fresh homeserver.yaml, you can use the generate command. (See the documentation for more information.) You will need to specify appropriate values for at least the SYNAPSE_SERVER_NAME and SYNAPSE_REPORT_STATS environment variables. For example:

docker-compose run --rm -e SYNAPSE_SERVER_NAME=my.matrix.host -e SYNAPSE_REPORT_STATS=yes synapse generate

(This will also generate necessary signing keys.)

Then, customize your configuration and run the server:

docker-compose up -d

More information

For more information on required environment variables and mounts, see the main docker documentation at /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