nixpkgs/nixos/modules/services/networking/xinetd.nix
pennae 2e751c0772 treewide: automatically md-convert option descriptions
the conversion procedure is simple:

 - find all things that look like options, ie calls to either `mkOption`
   or `lib.mkOption` that take an attrset. remember the attrset as the
   option
 - for all options, find a `description` attribute who's value is not a
   call to `mdDoc` or `lib.mdDoc`
 - textually convert the entire value of the attribute to MD with a few
   simple regexes (the set from mdize-module.sh)
 - if the change produced a change in the manual output, discard
 - if the change kept the manual unchanged, add some text to the
   description to make sure we've actually found an option. if the
   manual changes this time, keep the converted description

this procedure converts 80% of nixos options to markdown. around 2000
options remain to be inspected, but most of those fail the "does not
change the manual output check": currently the MD conversion process
does not faithfully convert docbook tags like <code> and <package>, so
any option using such tags will not be converted at all.
2022-07-30 15:16:34 +02:00

148 lines
3.7 KiB
Nix

{ config, lib, pkgs, ... }:
with lib;
let
cfg = config.services.xinetd;
configFile = pkgs.writeText "xinetd.conf"
''
defaults
{
log_type = SYSLOG daemon info
log_on_failure = HOST
log_on_success = PID HOST DURATION EXIT
${cfg.extraDefaults}
}
${concatMapStrings makeService cfg.services}
'';
makeService = srv:
''
service ${srv.name}
{
protocol = ${srv.protocol}
${optionalString srv.unlisted "type = UNLISTED"}
${optionalString (srv.flags != "") "flags = ${srv.flags}"}
socket_type = ${if srv.protocol == "udp" then "dgram" else "stream"}
${if srv.port != 0 then "port = ${toString srv.port}" else ""}
wait = ${if srv.protocol == "udp" then "yes" else "no"}
user = ${srv.user}
server = ${srv.server}
${optionalString (srv.serverArgs != "") "server_args = ${srv.serverArgs}"}
${srv.extraConfig}
}
'';
in
{
###### interface
options = {
services.xinetd.enable = mkEnableOption "the xinetd super-server daemon";
services.xinetd.extraDefaults = mkOption {
default = "";
type = types.lines;
description = lib.mdDoc ''
Additional configuration lines added to the default section of xinetd's configuration.
'';
};
services.xinetd.services = mkOption {
default = [];
description = lib.mdDoc ''
A list of services provided by xinetd.
'';
type = with types; listOf (submodule ({
options = {
name = mkOption {
type = types.str;
example = "login";
description = lib.mdDoc "Name of the service.";
};
protocol = mkOption {
type = types.str;
default = "tcp";
description =
lib.mdDoc "Protocol of the service. Usually `tcp` or `udp`.";
};
port = mkOption {
type = types.int;
default = 0;
example = 123;
description = lib.mdDoc "Port number of the service.";
};
user = mkOption {
type = types.str;
default = "nobody";
description = lib.mdDoc "User account for the service";
};
server = mkOption {
type = types.str;
example = "/foo/bin/ftpd";
description = lib.mdDoc "Path of the program that implements the service.";
};
serverArgs = mkOption {
type = types.separatedString " ";
default = "";
description = lib.mdDoc "Command-line arguments for the server program.";
};
flags = mkOption {
type = types.str;
default = "";
description = "";
};
unlisted = mkOption {
type = types.bool;
default = false;
description = lib.mdDoc ''
Whether this server is listed in
{file}`/etc/services`. If so, the port
number can be omitted.
'';
};
extraConfig = mkOption {
type = types.lines;
default = "";
description = lib.mdDoc "Extra configuration-lines added to the section of the service.";
};
};
}));
};
};
###### implementation
config = mkIf cfg.enable {
systemd.services.xinetd = {
description = "xinetd server";
after = [ "network.target" ];
wantedBy = [ "multi-user.target" ];
path = [ pkgs.xinetd ];
script = "exec xinetd -syslog daemon -dontfork -stayalive -f ${configFile}";
};
};
}