← 返回命令列表

Linux command

synctl 命令

文件

复制后可按需替换文件名、目录或参数。

常用示例

Start Synapse server

synctl start

Stop Synapse server

synctl stop

Restart Synapse server

synctl restart

Start with specific config file

synctl start [/path/to/homeserver.yaml]

Start a specific worker

synctl start -w [/path/to/worker.yaml]

Restart all workers and main process

synctl restart -a [/path/to/workers/]

说明

synctl is the control interface for Matrix Synapse, the reference homeserver implementation for the Matrix communication protocol. It manages starting, stopping, and restarting the Synapse server and its worker processes. For single-instance deployments, synctl operates on the main homeserver process. For scaled deployments using workers, the -a option manages all worker processes defined in a configuration directory. Configuration files use YAML format and define server settings, database connections, federation parameters, and resource limits.

参数

start
Start Synapse server or worker.
stop
Stop Synapse server or worker.
restart
Restart Synapse server or worker.
-w, --worker _file_
Operate on a single worker using specified config file.
-a, --all-processes _dir_
Operate on all workers in directory and main process.

FAQ

What is the synctl command used for?

synctl is the control interface for Matrix Synapse, the reference homeserver implementation for the Matrix communication protocol. It manages starting, stopping, and restarting the Synapse server and its worker processes. For single-instance deployments, synctl operates on the main homeserver process. For scaled deployments using workers, the -a option manages all worker processes defined in a configuration directory. Configuration files use YAML format and define server settings, database connections, federation parameters, and resource limits.

How do I run a basic synctl example?

Run `synctl start` in a terminal, then adjust file names, paths, flags, or remote targets for your system.

What does start do in synctl?

Start Synapse server or worker.