diff options
Diffstat (limited to 'nixos/modules/services/matrix/mjolnir.nix')
-rw-r--r-- | nixos/modules/services/matrix/mjolnir.nix | 38 |
1 files changed, 19 insertions, 19 deletions
diff --git a/nixos/modules/services/matrix/mjolnir.nix b/nixos/modules/services/matrix/mjolnir.nix index 278924b05cf28..abbbb4030e526 100644 --- a/nixos/modules/services/matrix/mjolnir.nix +++ b/nixos/modules/services/matrix/mjolnir.nix @@ -70,27 +70,27 @@ in homeserverUrl = mkOption { type = types.str; default = "https://matrix.org"; - description = '' + description = lib.mdDoc '' Where the homeserver is located (client-server URL). - If <literal>pantalaimon.enable</literal> is <literal>true</literal>, this option will become the homeserver to which <literal>pantalaimon</literal> connects. - The listen address of <literal>pantalaimon</literal> will then become the <literal>homeserverUrl</literal> of <literal>mjolnir</literal>. + 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`. ''; }; accessTokenFile = mkOption { type = with types; nullOr path; default = null; - description = '' - File containing the matrix access token for the <literal>mjolnir</literal> user. + description = lib.mdDoc '' + File containing the matrix access token for the `mjolnir` user. ''; }; pantalaimon = mkOption { - description = '' - <literal>pantalaimon</literal> options (enables E2E Encryption support). + description = lib.mdDoc '' + `pantalaimon` options (enables E2E Encryption support). - This will create a <literal>pantalaimon</literal> instance with the name "mjolnir". + This will create a `pantalaimon` instance with the name "mjolnir". ''; default = { }; type = types.submodule { @@ -102,22 +102,22 @@ in username = mkOption { type = types.str; - description = "The username to login with."; + description = lib.mdDoc "The username to login with."; }; passwordFile = mkOption { type = with types; nullOr path; default = null; - description = '' - File containing the matrix password for the <literal>mjolnir</literal> user. + description = lib.mdDoc '' + File containing the matrix password for the `mjolnir` user. ''; }; options = mkOption { type = types.submodule (import ./pantalaimon-options.nix); default = { }; - description = '' - passthrough additional options to the <literal>pantalaimon</literal> service. + description = lib.mdDoc '' + passthrough additional options to the `pantalaimon` service. ''; }; }; @@ -127,7 +127,7 @@ in dataPath = mkOption { type = types.path; default = "/var/lib/mjolnir"; - description = '' + description = lib.mdDoc '' The directory the bot should store various bits of information in. ''; }; @@ -135,11 +135,11 @@ in managementRoom = mkOption { type = types.str; default = "#moderators:example.org"; - description = '' + description = lib.mdDoc '' 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: <literal>mjolnir</literal> is fairly verbose - expect a lot of messages from it. + Note: `mjolnir` is fairly verbose - expect a lot of messages from it. ''; }; @@ -152,7 +152,7 @@ in "https://matrix.to/#/#anotherroom:example.org" ] ''; - description = '' + description = lib.mdDoc '' A list of rooms to protect (matrix.to URLs). ''; }; @@ -166,8 +166,8 @@ in automaticallyRedactForReasons = [ "spam" "advertising" ]; } ''; - description = '' - Additional settings (see <link xlink:href="https://github.com/matrix-org/mjolnir/blob/main/config/default.yaml">mjolnir default config</link> for available settings). These settings will override settings made by the module config. + description = lib.mdDoc '' + Additional settings (see [mjolnir default config](https://github.com/matrix-org/mjolnir/blob/main/config/default.yaml) for available settings). These settings will override settings made by the module config. ''; }; }; |