Skip to content

Mautrix facebook

services.mautrix-facebook.configurePostgresql

Enable PostgreSQL and create a user and database for mautrix-facebook. The default settings reference this database, if you disable this option you must provide a database URL.

Type: boolean

Default

true

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

services.mautrix-facebook.enable

Whether to enable Mautrix-Facebook, a Matrix-Facebook hybrid puppeting/relaybot bridge. Type: boolean

Default

false

Example

true

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

services.mautrix-facebook.environmentFile

File containing environment variables to be passed to the mautrix-facebook service.

Any config variable can be overridden by setting MAUTRIX_FACEBOOK_SOME_KEY to override the some.key variable.

Type: null or path

Default

null

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

services.mautrix-facebook.registrationData

Output data for appservice registration. Simply make any desired changes and serialize to JSON. Note that this data contains secrets so think twice before putting it into the nix store.

Currently as_token and hs_token need to be added as they are not known to this module.

Type: attribute set

Default

{ }

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

services.mautrix-facebook.settings

{file}config.yaml configuration as a Nix attribute set. Configuration options should match those described in example-config.yaml.

Secret tokens should be specified using {option}environmentFile instead of this world-readable attribute set.

Type: JSON value

Default

{appservice = {address = "http://localhost:29319";bot_username = "facebookbot";database = "postgresql://";hostname = "localhost";id = "facebook";port = 29319;};bridge = {encryption = {allow = true;default = true;verification_levels = {receive = "cross-signed-tofu";send = "cross-signed-tofu";share = "cross-signed-tofu";};};username_template = "facebook_{userid}";};homeserver = {address = "http://localhost:8008";software = "standard";};logging = {formatters = {journal_fmt = {format = "%(name)s: %(message)s";};};handlers = {journal = {SYSLOG_IDENTIFIER = "mautrix-facebook";class = "systemd.journal.JournalHandler";formatter = "journal_fmt";};};root = {handlers = ["journal"];level = "INFO";};version = 1;};manhole = {enabled = false;};metrics = {enabled = false;};}

Example

`#!nix { homeserver = { address = "http://localhost:8008"; domain = "mydomain.example"; };

bridge.permissions = { "@admin:mydomain.example" = "admin"; "mydomain.example" = "user"; }; } `

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