service.livebackup

The Synapse service.livebackup tool can be used to generate a new backup of a running Synapse service.

Syntax

service.livebackup is executed using python -m synapse.tools.service.livebackup. The command usage is as follows:

python -m synapse.tools.service.livebackup -h

usage: synapse.tools.service.livebackup [-h] [--url URL] [--name NAME]

Generate a new backup of a running Synapse service.

Examples:

    # Generate a backup from inside a Synapse service container
    python -m synapse.tools.service.livebackup

options:
  -h, --help   show this help message and exit
  --url URL    The telepath URL of the Synapse service.
  --name NAME  Specify a name for the backup. Defaults to an automatically
               generated timestamp.

Note

This tool was previously run using synapse.tools.livebackup. It can still be run with that name.