Skip to content

matrix-synapse

A federated messaging server with end-to-end encryption.

Will be deprecated

The matrix-synapse module might eventually be migrated to 'clanServices'*

See: clanServices

Categories

Uncategorized

Usage via Inventory

This module cannot be used via the inventory interface.

Usage via Nix

This module can be also imported directly in your nixos configuration. Although it is recommended to use the inventory interface if available.

Some modules are considered 'low-level' or 'expert modules' and are not available via the inventory interface.

{config, lib, inputs, ...}: {
    imports = [ inputs.clan-core.clanModules.matrix-synapse ];
    # ...
}

Module Options

The following options are available for this module.

clan.matrix-synapse.app_domain

The matrix server hostname also serves the element client

Type: string

Example
"matrix.example.com"

Declared in: clanModules/matrix-synapse

clan.matrix-synapse.server_tld

The address that is suffixed after your username i.e @alice:example.com

Type: string

Example
"example.com"

Declared in: clanModules/matrix-synapse

clan.matrix-synapse.users

A list of users. Not that only new users will be created and existing ones are not modified.

Type: attribute set of (submodule)

Default:

{ }
Example
{
  alice = {
    admin = true;
  };
}

Declared in: clanModules/matrix-synapse

clan.matrix-synapse.users.<name>.admin

Whether the user should be an admin

Type: boolean

Default:

false

Declared in: clanModules/matrix-synapse

clan.matrix-synapse.users.<name>.name

The name of the user

Type: string

Default:

"‹name›"

Declared in: clanModules/matrix-synapse