diff options
Diffstat (limited to 'nixos/modules/services/networking/biboumi.nix')
| -rw-r--r-- | nixos/modules/services/networking/biboumi.nix | 28 |
1 files changed, 14 insertions, 14 deletions
diff --git a/nixos/modules/services/networking/biboumi.nix b/nixos/modules/services/networking/biboumi.nix index 3f46b95eaf0..7e603300883 100644 --- a/nixos/modules/services/networking/biboumi.nix +++ b/nixos/modules/services/networking/biboumi.nix @@ -19,8 +19,8 @@ in enable = mkEnableOption "the Biboumi XMPP gateway to IRC"; settings = mkOption { - description = '' - See <link xlink:href="https://lab.louiz.org/louiz/biboumi/blob/8.5/doc/biboumi.1.rst">biboumi 8.5</link> + description = lib.mdDoc '' + See [biboumi 8.5](https://lab.louiz.org/louiz/biboumi/blob/8.5/doc/biboumi.1.rst) for documentation. ''; default = {}; @@ -34,7 +34,7 @@ in default = []; example = ["admin@example.org"]; apply = concatStringsSep ":"; - description = '' + description = lib.mdDoc '' The bare JID of the gateway administrator. This JID will have more privileges than other standard users, for example some administration ad-hoc commands will only be available to that JID. @@ -43,7 +43,7 @@ in options.ca_file = mkOption { type = types.path; default = "/etc/ssl/certs/ca-certificates.crt"; - description = '' + description = lib.mdDoc '' Specifies which file should be used as the list of trusted CA when negociating a TLS session. ''; @@ -51,7 +51,7 @@ in options.db_name = mkOption { type = with types; either path str; default = "${stateDir}/biboumi.sqlite"; - description = '' + description = lib.mdDoc '' The name of the database to use. ''; example = "postgresql://user:secret@localhost"; @@ -59,7 +59,7 @@ in options.hostname = mkOption { type = types.str; example = "biboumi.example.org"; - description = '' + description = lib.mdDoc '' The hostname served by the XMPP gateway. This domain must be configured in the XMPP server as an external component. @@ -69,14 +69,14 @@ in type = types.port; default = 113; example = 0; - description = '' + description = lib.mdDoc '' The TCP port on which to listen for identd queries. ''; }; options.log_level = mkOption { type = types.ints.between 0 3; default = 1; - description = '' + description = lib.mdDoc '' Indicate what type of log messages to write in the logs. 0 is debug, 1 is info, 2 is warning, 3 is error. ''; @@ -96,7 +96,7 @@ in options.persistent_by_default = mkOption { type = types.bool; default = false; - description = '' + description = lib.mdDoc '' Whether all rooms will be persistent by default: the value of the “persistent” option in the global configuration of each user will be “true”, but the value of each individual room will still @@ -108,7 +108,7 @@ in type = types.path; default = "${pkgs.biboumi}/etc/biboumi"; defaultText = literalExpression ''"''${pkgs.biboumi}/etc/biboumi"''; - description = '' + description = lib.mdDoc '' A directory that should contain the policy files, used to customize Botan’s behaviour when negociating the TLS connections with the IRC servers. @@ -117,14 +117,14 @@ in options.port = mkOption { type = types.port; default = 5347; - description = '' + description = lib.mdDoc '' The TCP port to use to connect to the local XMPP component. ''; }; options.realname_customization = mkOption { type = types.bool; default = true; - description = '' + description = lib.mdDoc '' Whether the users will be able to use the ad-hoc commands that lets them configure their realname and username. @@ -133,7 +133,7 @@ in options.realname_from_jid = mkOption { type = types.bool; default = false; - description = '' + description = lib.mdDoc '' Whether the realname and username of each biboumi user will be extracted from their JID. Otherwise they will be set to the nick @@ -143,7 +143,7 @@ in options.xmpp_server_ip = mkOption { type = types.str; default = "127.0.0.1"; - description = '' + description = lib.mdDoc '' The IP address to connect to the XMPP server on. The connection to the XMPP server is unencrypted, so the biboumi instance and the server should |