OS Manuals

/usr/local/bin/synapse_homeserver

Compat package for upstream Docker image paths

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

usage: synapse_homeserver [-h] [-c CONFIG_FILE] [--no-secrets-in-config] [--generate-config |
                          --generate-missing-configs | --generate-missing-and-run]
                          [-H SERVER_NAME] [--report-stats {yes,no}]
                          [--config-directory DIRECTORY] [--data-directory DIRECTORY]
                          [--open-private-ports] [--enable-metrics] [-D] [--print-pidfile]
                          [--manhole PORT] [-d SQLITE_DATABASE_PATH] [-n] [--enable-registration]

Synapse Homeserver

options:
  -h, --help            show this help message and exit
  -c, --config-path CONFIG_FILE
                        Specify config file. Can be given multiple times and may specify
                        directories containing *.yaml files. Top-level keys in later files
                        overwrite ones in earlier files.
  --no-secrets-in-config
                        Reject config options that expect an in-line secret as value.

Config generation mode:
  --generate-config     Generate a config file, then exit.
  --generate-missing-configs, --generate-keys
                        Generate any missing additional config files, then exit.
  --generate-missing-and-run
                        Generate any missing additional config files, then run. This is the
                        default behaviour.

Details for --generate-config:
  -H, --server-name SERVER_NAME
                        The server name to generate a config file for.
  --report-stats {yes,no}
                        Whether the generated config reports homeserver usage statistics.
  --config-directory, --keys-directory DIRECTORY
                        Specify where additional config files such as signing keys and log config
                        should be stored. Defaults to the same directory as the last config file.
  --data-directory DIRECTORY
                        Specify where data such as the media store and database file should be
                        stored. Defaults to the current working directory.
  --open-private-ports  Leave private ports (such as the non-TLS HTTP listener) open to the
                        internet. Do not use this unless you know what you are doing.
  --enable-metrics      Sets `enable_metrics: true` and when using the default set of listeners,
                        will also add the metrics listener on port 19090.

server:
  -D, --daemonize       Daemonize the homeserver
  --print-pidfile       Print the path to the pidfile just before daemonizing
  --manhole PORT        Turn on the twisted telnet manhole service on the given port.

database:
  -d, --database-path SQLITE_DATABASE_PATH
                        The path to a sqlite database to use.

logging:
  -n, --no-redirect-stdio
                        Do not redirect stdout/stderr to the log

registration:
  --enable-registration
                        Enable registration for new users.
Options (18)
OptionDescriptionSource
-h, --helpshow this help message and exithelp
-c, --config-path CONFIG_FILESpecify config file.help
--no-secrets-in-configReject config options that expect an in-line secret as value.help
--generate-configGenerate a config file, then exit.help
--generate-missing-configs, --generate-keysGenerate any missing additional config files, then exit.help
--generate-missing-and-runGenerate any missing additional config files, then run.help
-H, --server-name SERVER_NAMEThe server name to generate a config file for.help
--report-stats yesWhether the generated config reports homeserver usage statistics.help
--config-directory, --keys-directory DIRECTORYSpecify where additional config files such as signing keys and log config should be stored.help
--data-directory DIRECTORYSpecify where data such as the media store and database file should be stored.help
--open-private-portsLeave private ports (such as the non-TLS HTTP listener) open to the internet.help
--enable-metricsSets `enable_metrics: true` and when using the default set of listeners, will also add the metrics listener on port 19090.help
-D, --daemonizeDaemonize the homeserverhelp
--print-pidfilePrint the path to the pidfile just before daemonizinghelp
--manhole PORTTurn on the twisted telnet manhole service on the given port.help
-d, --database-path SQLITE_DATABASE_PATHThe path to a sqlite database to use.help
-n, --no-redirect-stdioDo not redirect stdout/stderr to the loghelp
--enable-registrationEnable registration for new users.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.