service.backup

The Synapse service.backup tool can be used to create an optimized backup of a Synapse directory.

Syntax

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

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

usage: synapse.tools.service.backup [-h] [--skipdirs SKIPDIRS [SKIPDIRS ...]]
                                    srcdir dstdir

Create an optimized backup of a Synapse directory.

positional arguments:
  srcdir                Path to the Synapse directory to backup.
  dstdir                Path to the backup target directory.

options:
  -h, --help            show this help message and exit
  --skipdirs SKIPDIRS [SKIPDIRS ...]
                        Glob patterns of relative directory names to exclude
                        from the backup.

Note

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