Maubot

`services.maubot.configMutable`

Whether maubot should write updated config into extraConfigFile. This will make your Nix module settings have no effect besides the initial config, as extraConfigFile takes precedence over NixOS settings!

Type: boolean

Default

false

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

`services.maubot.dataDir`

The directory where maubot stores its stateful data.

Type: string

Default

"/var/lib/maubot"

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

`services.maubot.enable`

Whether to enable maubot. Type: boolean

Default

false

Example

true

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

`services.maubot.extraConfigFile`

A file for storing secrets. You can pass homeserver registration keys here. If it already exists, it must contain server.unshared_secret which is used for signing API keys. If configMutable is not set to true, maubot user must have write access to this file.

Type: string

Default

"${config.services.maubot.dataDir}/config.yaml"

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

`services.maubot.package`

The maubot package to use. Type: package

Default

pkgs.maubot

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

`services.maubot.plugins`

List of additional maubot plugins to make available.

Type: list of package

Default

[ ]

Example

with config.services.maubot.package.plugins; [xyz.maubot.reactbotxyz.maubot.rss];

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

`services.maubot.pythonPackages`

List of additional Python packages to make available for maubot.

Type: list of package

Default

[ ]

Example

with pkgs.python3Packages; [aiohttp];

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

`services.maubot.settings`

YAML settings for maubot. See the example configuration for more info.

Secrets should be passed in by using extraConfigFile.

Type: submodule

Default

{ }

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

`services.maubot.settings.admins`

List of administrator users. Plaintext passwords will be bcrypted on startup. Set empty password to prevent normal login. Root is a special user that can't have a password and will always exist.

Type: attribute set of string

Default

{root = "";}

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

`services.maubot.settings.api_features`

API feature switches.

Type: attribute set of boolean

Default

{client = true;client_auth = true;client_proxy = true;dev_open = true;instance = true;instance_database = true;log = true;login = true;plugin = true;plugin_upload = true;}

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

`services.maubot.settings.crypto_database`

Separate database URL for the crypto database. By default, the regular database is also used for crypto.

Type: string

Default

"default"

Example

"postgresql://username:password@hostname/dbname"

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

`services.maubot.settings.database`

The full URI to the database. SQLite and Postgres are fully supported. Other DBMSes supported by SQLAlchemy may or may not work.

Type: string

Default

"sqlite:maubot.db"

Example

"postgresql://username:password@hostname/dbname"

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

`services.maubot.settings.database_opts`

Additional arguments for asyncpg.create_pool() or sqlite3.connect()

Type: attribute set

Default

{ }

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

`services.maubot.settings.homeservers`

Known homeservers. This is required for the mbc auth command and also allows more convenient access from the management UI. If you want to specify registration secrets, pass this via extraConfigFile instead.

Type: attribute set of (submodule)

Default

{"matrix.org" = {url = "https://matrix-client.matrix.org";};}

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

`services.maubot.settings.homeservers.<name>.url`

Client-server API URL

Type: string

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

`services.maubot.settings.logging`

Python logging configuration. See section 16.7.2 of the Python documentation for more info.

Type: attribute set

Default

{formatters = {colored = {"()" = "maubot.lib.color_log.ColorFormatter";format = "[%(asctime)s] [%(levelname)s@%(name)s] %(message)s";};normal = {format = "[%(asctime)s] [%(levelname)s@%(name)s] %(message)s";};};handlers = {console = {class = "logging.StreamHandler";formatter = "colored";};file = {backupCount = 10;class = "logging.handlers.RotatingFileHandler";filename = "./maubot.log";formatter = "normal";maxBytes = 10485760;};};loggers = {aiohttp = {level = "INFO";};mau = {level = "DEBUG";};maubot = {level = "DEBUG";};};root = {handlers = ["file""console"];level = "DEBUG";};version = 1;}