synapse_config/README.md

19 lines
1.1 KiB
Markdown

# Matrix/Synapse configuration
Everything (except for docker-compose.yaml) goes into the data-volume of the synapse installation.
This uses the semi-official synapse image: https://hub.docker.com/r/matrixdotorg/synapse
Config is cobbled together using the worker documentation: https://matrix-org.github.io/synapse/latest/workers.html#setting-up-workers and this blog post: https://netfg.net/post/128
## First time launch:
* Create containers and volumes: `docker-compose up --no-start`
* Generate Keys and config: `docker-compose run --rm -e SYNAPSE_SERVER_NAME=??? -e SYNAPSE_REPORT_STATS=no synapse generate`
* Read through the generated homeserver.yaml. Take note of generated keys, etc.
* Replace homeserver.yaml in your data volume with the one from this repository, adapting to your needs. Use the keys from the step before. Copy the other config-yamls to your /data directory.
* Start the databases: `docker-compose up -d redis postgres`
* Start the synapse services: `docker-compose up -d`
* Don't forget to backup your config directory and database
* Good luck :)