Skip to content

Matrix sliding sync

services.matrix-sliding-sync.createDatabase

Whether to enable and configure services.postgres to ensure that the database user matrix-sliding-sync and the database matrix-sliding-sync exist.

Type: boolean

Default

true

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/matrix/matrix-sliding-sync.nix

services.matrix-sliding-sync.enable

Whether to enable sliding sync. Type: boolean

Default

false

Example

true

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/matrix/matrix-sliding-sync.nix

services.matrix-sliding-sync.environmentFile

Environment file as defined in {manpage}systemd.exec(5).

This must contain the {env}SYNCV3_SECRET variable which should be generated with {command}openssl rand -hex 32.

Type: string

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/matrix/matrix-sliding-sync.nix

services.matrix-sliding-sync.package

The matrix-sliding-sync package to use. Type: package

Default

pkgs.matrix-sliding-sync

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/matrix/matrix-sliding-sync.nix

services.matrix-sliding-sync.settings

Freeform environment variables passed to the sliding sync proxy. Refer to https://github.com/matrix-org/sliding-sync#setup for all supported values.

Type: attribute set of string

Default

{ }

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/matrix/matrix-sliding-sync.nix

services.matrix-sliding-sync.settings.SYNCV3_BINDADDR

The interface and port or path (for unix socket) to listen on. Type: string

Default

"127.0.0.1:8009"

Example

"[::]:8008"

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/matrix/matrix-sliding-sync.nix

services.matrix-sliding-sync.settings.SYNCV3_DB

The postgres connection string. Refer to https://www.postgresql.org/docs/current/libpq-connect.html#LIBPQ-CONNSTRING.

Type: string

Default

"postgresql:///matrix-sliding-sync?host=/run/postgresql"

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/matrix/matrix-sliding-sync.nix

services.matrix-sliding-sync.settings.SYNCV3_LOG_LEVEL

The level of verbosity for messages logged. Type: one of "trace", "debug", "info", "warn", "error", "fatal"

Default

"info"

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/matrix/matrix-sliding-sync.nix

services.matrix-sliding-sync.settings.SYNCV3_SERVER

The destination homeserver to talk to not including /_matrix/ e.g https://matrix.example.org.

Type: string

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/matrix/matrix-sliding-sync.nix