Mjolnir

`services.mjolnir.accessTokenFile`

File containing the matrix access token for the mjolnir user.

Type: null or path

Default

null

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

`services.mjolnir.dataPath`

The directory the bot should store various bits of information in.

Type: path

Default

"/var/lib/mjolnir"

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

`services.mjolnir.enable`

Whether to enable Mjolnir, a moderation tool for Matrix. Type: boolean

Default

false

Example

true

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

`services.mjolnir.homeserverUrl`

Where the homeserver is located (client-server URL).

If pantalaimon.enable is true, this option will become the homeserver to which pantalaimon connects. The listen address of pantalaimon will then become the homeserverUrl of mjolnir.

Type: string

Default

"https://matrix.org"

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

`services.mjolnir.managementRoom`

The room ID where people can use the bot. The bot has no access controls, so anyone in this room can use the bot - secure your room! This should be a room alias or room ID - not a matrix.to URL. Note: mjolnir is fairly verbose - expect a lot of messages from it.

Type: string

Default

"#moderators:example.org"

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

`services.mjolnir.pantalaimon`

pantalaimon options (enables E2E Encryption support).

This will create a pantalaimon instance with the name "mjolnir".

Type: submodule

Default

{ }

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

`services.mjolnir.pantalaimon.enable`

Whether to enable ignoring the accessToken. If true, accessToken is ignored and the username/password below will be used instead. The access token of the bot will be stored in the dataPath . Type: boolean

Default

false

Example

true

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

`services.mjolnir.pantalaimon.options`

passthrough additional options to the pantalaimon service.

Type: submodule

Default

{ }

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

`services.mjolnir.pantalaimon.options.dataPath`

The directory where pantalaimon should store its state such as the database file.

Type: path

Default

"/var/lib/pantalaimon-‹name›"

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

`services.mjolnir.pantalaimon.options.extraSettings`

Extra configuration options. See pantalaimon(5) for available options.

Type: attribute set

Default

{ }

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

`services.mjolnir.pantalaimon.options.homeserver`

The URI of the homeserver that the pantalaimon proxy should forward requests to, without the matrix API path but including the http(s) schema.

Type: string

Example

"https://matrix.org"

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

`services.mjolnir.pantalaimon.options.listenAddress`

The address where the daemon will listen to client connections for this homeserver.

Type: string

Default

"localhost"

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

`services.mjolnir.pantalaimon.options.listenPort`

The port where the daemon will listen to client connections for this homeserver. Note that the listen address/port combination needs to be unique between different homeservers.

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