python3 -m synapse.app.homeserver --generate-config --server-name example.com --report-stats=yes -c homeserver.yaml

Category: Matrix & Synapse

python3 -m synapse.app.homeserver --generate-config --server-name example.com --report-stats=yes -c homeserver.yaml

Generate an initial Synapse config file

Creates homeserver.yaml, a signing key, and a logging config for a new homeserver (your Matrix server). --server-name sets the domain that appears in user IDs, so it must be the DNS name you will serve Matrix from. --report-stats=yes sends anonymous usage statistics to the project; choose yes or no explicitly or the server refuses to start. Edit the generated file, then run the same module without --generate-config to start.
Looking for more? Search all 7,657 commands — works offline, in English or Spanish, and fixes typos.