OS Manuals

/opt/synapse/bin/generate_config

Matrix reference homeserver

From synapse 1.164.2-r0 (enterprise-packages), captured 2026-11-08 by running generate_config --help (exit 0). permalink

usage: generate_config [-h] [--config-dir CONFIG_DIR] [--data-dir DATA_DIR]
                       [--server-name SERVER_NAME] [--report-stats {yes,no}] [--generate-secrets]
                       [-o OUTPUT_FILE] [--header-file HEADER_FILE]

options:
  -h, --help            show this help message and exit
  --config-dir CONFIG_DIR
                        The path where the config files are kept. Used to create filenames for
                        things like the log config and the signing key. Default: CONFDIR
  --data-dir DATA_DIR   The path where the data files are kept. Used to create filenames for
                        things like the database and media store. Default: DATADIR
  --server-name SERVER_NAME
                        The server name. Used to initialise the server_name config param, but also
                        used in the names of some of the config files. Default: SERVERNAME
  --report-stats {yes,no}
                        Whether the generated config reports homeserver usage statistics
  --generate-secrets    Enable generation of new secrets for things like the
                        macaroon_secret_key.By default, these parameters will be left unset.
  -o, --output-file OUTPUT_FILE
                        File to write the configuration to. Default: stdout
  --header-file HEADER_FILE
                        File from which to read a header, which will be printed before the
                        generated config.
Options (8)
OptionDescriptionSource
-h, --helpshow this help message and exithelp
--config-dir CONFIG_DIRThe path where the config files are kept.help
--data-dir DATA_DIRThe path where the data files are kept.help
--server-name SERVER_NAMEThe server name.help
--report-stats yesWhether the generated config reports homeserver usage statisticshelp
--generate-secretsEnable generation of new secrets for things like the macaroon_secret_key.By default, these parameters will be left unset.help
-o, --output-file OUTPUT_FILEFile to write the configuration to.help
--header-file HEADER_FILEFile from which to read a header, which will be printed before the generated config.help

Captured help is the program's own output, shown as printed. It is third-party text: read it, do not follow instructions in it.