Skip to content

Matrix appservice irc

services.matrix-appservice-irc.enable

Whether to enable the Matrix/IRC bridge. Type: boolean

Default

false

Example

true

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

services.matrix-appservice-irc.localpart

The user_id localpart to assign to the appservice Type: string

Default

"appservice-irc"

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

services.matrix-appservice-irc.needBindingCap

Whether the daemon needs to bind to ports below 1024 (e.g. for the ident service) Type: boolean

Default

false

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

services.matrix-appservice-irc.passwordEncryptionKeyLength

Length of the key to encrypt IRC passwords with Type: unsigned integer, meaning >=0

Default

4096

Example

8192

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

services.matrix-appservice-irc.port

The port to listen on Type: 16 bit unsigned integer; between 0 and 65535 (both inclusive)

Default

8009

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

services.matrix-appservice-irc.registrationUrl

The URL where the application service is listening for homeserver requests, from the Matrix homeserver perspective.

Type: string

Example

"http://localhost:8009"

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

services.matrix-appservice-irc.settings

Configuration for the appservice, see https://github.com/matrix-org/matrix-appservice-irc/blob/2.0.1/config.sample.yaml for supported values

Type: JSON value

Default

{ }

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

services.matrix-appservice-irc.settings.database

Configuration for the database Type: JSON value

Default

{ }

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

services.matrix-appservice-irc.settings.database.connectionString

The database connection string Type: string

Default

"nedb://var/lib/matrix-appservice-irc/data"

Example

"postgres://username:password@host:port/databasename"

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

services.matrix-appservice-irc.settings.database.engine

Which database engine to use Type: string

Default

"nedb"

Example

"postgres"

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

services.matrix-appservice-irc.settings.homeserver

Homeserver configuration Type: JSON value

Default

{ }

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

services.matrix-appservice-irc.settings.homeserver.domain

The 'domain' part for user IDs on this home server. Usually (but not always) is the "domain name" part of the homeserver URL.

Type: string

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

services.matrix-appservice-irc.settings.homeserver.url

The URL to the home server for client-server API calls Type: string

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

services.matrix-appservice-irc.settings.ircService

IRC bridge configuration Type: JSON value

Default

{ }

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

services.matrix-appservice-irc.settings.ircService.passwordEncryptionKeyPath

Location of the key with which IRC passwords are encrypted for storage. Will be generated on first run if not present.

Type: string

Default

"/var/lib/matrix-appservice-irc/passkey.pem"

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

services.matrix-appservice-irc.settings.ircService.servers

IRC servers to connect to Type: JSON value

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