OS Manuals

/opt/synapse/bin/synapse_worker

Matrix reference homeserver

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

usage: synapse_worker [-h] [-c CONFIG_FILE] [--keys-directory DIRECTORY] [--no-secrets-in-config]
                      [-D] [--print-pidfile] [--manhole PORT] [-d SQLITE_DATABASE_PATH] [-n]
                      [--enable-registration]

Synapse worker

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.
  --keys-directory DIRECTORY
                        Where files such as certs and signing keys are stored when their location
                        is not given explicitly in the config. Defaults to the directory
                        containing the last config file
  --no-secrets-in-config
                        Reject config options that expect an in-line secret as value.

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 (10)
OptionDescriptionSource
-h, --helpshow this help message and exithelp
-c, --config-path CONFIG_FILESpecify config file.help
--keys-directory DIRECTORYWhere files such as certs and signing keys are stored when their location is not given explicitly in the config.help
--no-secrets-in-configReject config options that expect an in-line secret as value.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.