diff options
Diffstat (limited to 'nixos/modules/services/networking/znc')
| -rw-r--r-- | nixos/modules/services/networking/znc/default.nix | 20 | ||||
| -rw-r--r-- | nixos/modules/services/networking/znc/options.nix | 38 |
2 files changed, 29 insertions, 29 deletions
diff --git a/nixos/modules/services/networking/znc/default.nix b/nixos/modules/services/networking/znc/default.nix index e15233293cf25..1a5793ee0ff58 100644 --- a/nixos/modules/services/networking/znc/default.nix +++ b/nixos/modules/services/networking/znc/default.nix @@ -81,13 +81,13 @@ in options = { services.znc = { - enable = mkEnableOption (lib.mdDoc "ZNC"); + enable = mkEnableOption "ZNC"; user = mkOption { default = "znc"; example = "john"; type = types.str; - description = lib.mdDoc '' + description = '' The name of an existing user account to use to own the ZNC server process. If not specified, a default user will be created. ''; @@ -97,7 +97,7 @@ in default = defaultUser; example = "users"; type = types.str; - description = lib.mdDoc '' + description = '' Group to own the ZNC process. ''; }; @@ -106,7 +106,7 @@ in default = "/var/lib/znc"; example = "/home/john/.znc"; type = types.path; - description = lib.mdDoc '' + description = '' The state directory for ZNC. The config and the modules will be linked to from this directory as well. ''; @@ -115,7 +115,7 @@ in openFirewall = mkOption { type = types.bool; default = false; - description = lib.mdDoc '' + description = '' Whether to open ports in the firewall for ZNC. Does work with ports for listeners specified in {option}`services.znc.config.Listener`. @@ -149,7 +149,7 @@ in }; } ''; - description = lib.mdDoc '' + description = '' Configuration for ZNC, see <https://wiki.znc.in/Configuration> for details. The Nix value declared here will be translated directly to the xml-like @@ -177,7 +177,7 @@ in configFile = mkOption { type = types.path; example = literalExpression "~/.znc/configs/znc.conf"; - description = lib.mdDoc '' + description = '' Configuration file for ZNC. It is recommended to use the {option}`config` option instead. @@ -191,7 +191,7 @@ in type = types.listOf types.package; default = [ ]; example = literalExpression "[ pkgs.zncModules.fish pkgs.zncModules.push ]"; - description = lib.mdDoc '' + description = '' A list of global znc module packages to add to znc. ''; }; @@ -199,7 +199,7 @@ in mutable = mkOption { default = true; # TODO: Default to true when config is set, make sure to not delete the old config if present type = types.bool; - description = lib.mdDoc '' + description = '' Indicates whether to allow the contents of the `dataDir` directory to be changed by the user at run-time. @@ -217,7 +217,7 @@ in default = [ ]; example = [ "--debug" ]; type = types.listOf types.str; - description = lib.mdDoc '' + description = '' Extra arguments to use for executing znc. ''; }; diff --git a/nixos/modules/services/networking/znc/options.nix b/nixos/modules/services/networking/znc/options.nix index bd67ec86d5130..32e5fd9d50253 100644 --- a/nixos/modules/services/networking/znc/options.nix +++ b/nixos/modules/services/networking/znc/options.nix @@ -12,7 +12,7 @@ let server = mkOption { type = types.str; example = "irc.libera.chat"; - description = lib.mdDoc '' + description = '' IRC server address. ''; }; @@ -20,7 +20,7 @@ let port = mkOption { type = types.port; default = 6697; - description = lib.mdDoc '' + description = '' IRC server port. ''; }; @@ -28,7 +28,7 @@ let password = mkOption { type = types.str; default = ""; - description = lib.mdDoc '' + description = '' IRC server password, such as for a Slack gateway. ''; }; @@ -36,7 +36,7 @@ let useSSL = mkOption { type = types.bool; default = true; - description = lib.mdDoc '' + description = '' Whether to use SSL to connect to the IRC server. ''; }; @@ -45,7 +45,7 @@ let type = types.listOf types.str; default = [ "simple_away" ]; example = literalExpression ''[ "simple_away" "sasl" ]''; - description = lib.mdDoc '' + description = '' ZNC network modules to load. ''; }; @@ -54,7 +54,7 @@ let type = types.listOf types.str; default = []; example = [ "nixos" ]; - description = lib.mdDoc '' + description = '' IRC channels to join. ''; }; @@ -62,7 +62,7 @@ let hasBitlbeeControlChannel = mkOption { type = types.bool; default = false; - description = lib.mdDoc '' + description = '' Whether to add the special Bitlbee operations channel. ''; }; @@ -79,7 +79,7 @@ let JoinDelay = 0 Nick = johntron ''; - description = lib.mdDoc '' + description = '' Extra config for the network. Consider using {option}`services.znc.config` instead. ''; @@ -97,7 +97,7 @@ in useLegacyConfig = mkOption { default = true; type = types.bool; - description = lib.mdDoc '' + description = '' Whether to propagate the legacy options under {option}`services.znc.confOptions.*` to the znc config. If this is turned on, the znc config will contain a user with the default name @@ -118,7 +118,7 @@ in type = types.listOf types.str; default = [ "webadmin" "adminlog" ]; example = [ "partyline" "webadmin" "adminlog" "log" ]; - description = lib.mdDoc '' + description = '' A list of modules to include in the `znc.conf` file. ''; }; @@ -127,7 +127,7 @@ in type = types.listOf types.str; default = [ "chansaver" "controlpanel" ]; example = [ "chansaver" "controlpanel" "fish" "push" ]; - description = lib.mdDoc '' + description = '' A list of user modules to include in the `znc.conf` file. ''; }; @@ -136,7 +136,7 @@ in default = "znc"; example = "johntron"; type = types.str; - description = lib.mdDoc '' + description = '' The user name used to log in to the ZNC web admin interface. ''; }; @@ -144,7 +144,7 @@ in networks = mkOption { default = { }; type = with types; attrsOf (submodule networkOpts); - description = lib.mdDoc '' + description = '' IRC networks to connect the user to. ''; example = literalExpression '' @@ -163,7 +163,7 @@ in default = "znc-user"; example = "john"; type = types.str; - description = lib.mdDoc '' + description = '' The IRC nick. ''; }; @@ -177,7 +177,7 @@ in </Pass> ''; type = types.str; - description = lib.mdDoc '' + description = '' Generate with {command}`nix-shell -p znc --command "znc --makepass"`. This is the password used to log in to the ZNC web admin interface. You can also set this through @@ -189,7 +189,7 @@ in port = mkOption { default = 5000; type = types.port; - description = lib.mdDoc '' + description = '' Specifies the port on which to listen. ''; }; @@ -197,7 +197,7 @@ in useSSL = mkOption { default = true; type = types.bool; - description = lib.mdDoc '' + description = '' Indicates whether the ZNC server should use SSL when listening on the specified port. A self-signed certificate will be generated. ''; @@ -207,7 +207,7 @@ in type = types.nullOr types.str; default = null; example = "/znc/"; - description = lib.mdDoc '' + description = '' An optional URI prefix for the ZNC web interface. Can be used to make ZNC available behind a reverse proxy. ''; @@ -216,7 +216,7 @@ in extraZncConf = mkOption { default = ""; type = types.lines; - description = lib.mdDoc '' + description = '' Extra config to `znc.conf` file. ''; }; |