services.conduit.enable

Whether to enable conduit.

Type: boolean

Default: false

Example: true

Declared by:

services.conduit.package

The package to use.

Type: package

Default: pkgs.matrix-conduit

Declared by:

services.conduit.extraEnvironment

Extra Environment variables to pass to the conduit server.

Type: attribute set of string

Default: { }

Example:

{
  RUST_BACKTRACE = "yes";
}

Declared by:

services.conduit.settings

Generates the conduit.toml configuration file. Refer to https://docs.conduit.rs/configuration.html for details on supported values. Note that database_path can not be edited because the service’s reliance on systemd StateDir.

Type: submodule

Default: { }

Declared by:

services.conduit.settings.global.address

Address to listen on for connections by the reverse proxy/tls terminator.

Type: string

Default: "::1"

Declared by:

services.conduit.settings.global.allow_check_for_updates

Whether to allow Conduit to automatically contact https://conduit.rs hourly to check for important Conduit news.

Disabled by default because nixpkgs handles updates.

Type: boolean

Default: false

Declared by:

services.conduit.settings.global.allow_encryption

Whether new encrypted rooms can be created. Note: existing rooms will continue to work.

Type: boolean

Default: true

Declared by:

services.conduit.settings.global.allow_federation

Whether this server federates with other servers.

Type: boolean

Default: true

Declared by:

services.conduit.settings.global.allow_registration

Whether new users can register on this server.

Type: boolean

Default: false

Declared by:

services.conduit.settings.global.database_backend

The database backend for the service. Switching it on an existing instance will require manual migration of data.

Type: one of “sqlite”, “rocksdb”

Default: "sqlite"

Example: "rocksdb"

Declared by:

services.conduit.settings.global.database_path

Path to the conduit database, the directory where conduit will save its data. Note that due to using the DynamicUser feature of systemd, this value should not be changed and is set to be read only.

Type: string (read only)

Default: "/var/lib/conduit/"

Declared by:

services.conduit.settings.global.max_request_size

Max request size in bytes. Don’t forget to also change it in the proxy.

Type: positive integer, meaning >0

Default: 20000000

Declared by:

services.conduit.settings.global.port

The port Conduit will be running on. You need to set up a reverse proxy in your web server (e.g. apache or nginx), so all requests to /_matrix on port 443 and 8448 will be forwarded to the Conduit instance running on this port

Type: 16 bit unsigned integer; between 0 and 65535 (both inclusive)

Default: 6167

Declared by:

services.conduit.settings.global.server_name

The server_name is the name of this server. It is used as a suffix for user # and room ids.

Type: string

Example: "example.com"

Declared by:

services.conduit.settings.global.trusted_servers

Servers trusted with signing server keys.

Type: list of string

Default:

[
  "matrix.org"
]

Declared by:

services.conduit.settings.global.turn_secret

The TURN secret.

Type: null or string

Default: null

Declared by:

services.conduit.settings.global.turn_ttl

The TURN TTL in seconds.

Type: signed integer

Default: 86400

Declared by:

services.conduit.settings.global.turn_uris

The TURN URIs.

Type: list of string

Default: [ ]

Declared by:

services.conduit.settings.global.well_known.client

The URL that clients should use to connect to Conduit.

Type: null or string

Default: null

Declared by:

services.conduit.settings.global.well_known.server

The hostname and port servers should use to connect to Conduit.

Type: null or string

Default: null

Declared by:

services.conduit.turn_secret_file

The path to the file with TURN secret.

Type: null or path

Default: null

Declared by: