summaryrefslogtreecommitdiffstats
path: root/nixos/modules/services/web-servers
diff options
context:
space:
mode:
authorstuebinm <stuebinm@disroot.org>2024-04-13 14:54:15 +0200
committerJonathan Ringer <jonringer@users.noreply.github.com>2024-04-13 10:07:35 -0700
commit6afb255d976f85f3359e4929abd6f5149c323a02 (patch)
treeced23a118ee0852174d31005acd16f04cad3a781 /nixos/modules/services/web-servers
parent1dd996e59a5e67694b7a252aacba71a88d51b41e (diff)
nixos: remove all uses of lib.mdDoc
these changes were generated with nixq 0.0.2, by running nixq ">> lib.mdDoc[remove] Argument[keep]" --batchmode nixos/**.nix nixq ">> mdDoc[remove] Argument[keep]" --batchmode nixos/**.nix nixq ">> Inherit >> mdDoc[remove]" --batchmode nixos/**.nix two mentions of the mdDoc function remain in nixos/, both of which are inside of comments. Since lib.mdDoc is already defined as just id, this commit is a no-op as far as Nix (and the built manual) is concerned.
Diffstat (limited to 'nixos/modules/services/web-servers')
-rw-r--r--nixos/modules/services/web-servers/agate.nix16
-rw-r--r--nixos/modules/services/web-servers/apache-httpd/default.nix41
-rw-r--r--nixos/modules/services/web-servers/apache-httpd/location-options.nix10
-rw-r--r--nixos/modules/services/web-servers/apache-httpd/vhost-options.nix54
-rw-r--r--nixos/modules/services/web-servers/caddy/default.nix32
-rw-r--r--nixos/modules/services/web-servers/caddy/vhost-options.nix12
-rw-r--r--nixos/modules/services/web-servers/darkhttpd.nix12
-rw-r--r--nixos/modules/services/web-servers/fcgiwrap.nix12
-rw-r--r--nixos/modules/services/web-servers/garage.nix18
-rw-r--r--nixos/modules/services/web-servers/hitch/default.nix18
-rw-r--r--nixos/modules/services/web-servers/hydron.nix20
-rw-r--r--nixos/modules/services/web-servers/jboss/default.nix16
-rw-r--r--nixos/modules/services/web-servers/keter/default.nix30
-rw-r--r--nixos/modules/services/web-servers/lighttpd/cgit.nix6
-rw-r--r--nixos/modules/services/web-servers/lighttpd/collectd.nix4
-rw-r--r--nixos/modules/services/web-servers/lighttpd/default.nix18
-rw-r--r--nixos/modules/services/web-servers/lighttpd/gitweb.nix2
-rw-r--r--nixos/modules/services/web-servers/merecat.nix4
-rw-r--r--nixos/modules/services/web-servers/mighttpd2.nix8
-rw-r--r--nixos/modules/services/web-servers/minio.nix20
-rw-r--r--nixos/modules/services/web-servers/molly-brown.nix14
-rw-r--r--nixos/modules/services/web-servers/nginx/default.nix122
-rw-r--r--nixos/modules/services/web-servers/nginx/gitweb.nix10
-rw-r--r--nixos/modules/services/web-servers/nginx/location-options.nix26
-rw-r--r--nixos/modules/services/web-servers/nginx/tailscale-auth.nix12
-rw-r--r--nixos/modules/services/web-servers/nginx/vhost-options.nix68
-rw-r--r--nixos/modules/services/web-servers/phpfpm/default.nix26
-rw-r--r--nixos/modules/services/web-servers/pomerium.nix10
-rw-r--r--nixos/modules/services/web-servers/rustus.nix46
-rw-r--r--nixos/modules/services/web-servers/stargazer.nix34
-rw-r--r--nixos/modules/services/web-servers/static-web-server.nix8
-rw-r--r--nixos/modules/services/web-servers/tomcat.nix42
-rw-r--r--nixos/modules/services/web-servers/traefik.nix16
-rw-r--r--nixos/modules/services/web-servers/trafficserver/default.nix34
-rw-r--r--nixos/modules/services/web-servers/unit/default.nix12
-rw-r--r--nixos/modules/services/web-servers/uwsgi.nix14
-rw-r--r--nixos/modules/services/web-servers/varnish/default.nix14
37 files changed, 430 insertions, 431 deletions
diff --git a/nixos/modules/services/web-servers/agate.nix b/nixos/modules/services/web-servers/agate.nix
index e03174c87945..76c1a94f3bf2 100644
--- a/nixos/modules/services/web-servers/agate.nix
+++ b/nixos/modules/services/web-servers/agate.nix
@@ -8,14 +8,14 @@ in
{
options = {
services.agate = {
- enable = mkEnableOption (lib.mdDoc "Agate Server");
+ enable = mkEnableOption "Agate Server";
package = mkPackageOption pkgs "agate" { };
addresses = mkOption {
type = types.listOf types.str;
default = [ "0.0.0.0:1965" ];
- description = lib.mdDoc ''
+ description = ''
Addresses to listen on, IP:PORT, if you haven't disabled forwarding
only set IPv4.
'';
@@ -24,19 +24,19 @@ in
contentDir = mkOption {
default = "/var/lib/agate/content";
type = types.path;
- description = lib.mdDoc "Root of the content directory.";
+ description = "Root of the content directory.";
};
certificatesDir = mkOption {
default = "/var/lib/agate/certificates";
type = types.path;
- description = lib.mdDoc "Root of the certificate directory.";
+ description = "Root of the certificate directory.";
};
hostnames = mkOption {
default = [ ];
type = types.listOf types.str;
- description = lib.mdDoc ''
+ description = ''
Domain name of this Gemini server, enables checking hostname and port
in requests. (multiple occurrences means basic vhosts)
'';
@@ -45,20 +45,20 @@ in
language = mkOption {
default = null;
type = types.nullOr types.str;
- description = lib.mdDoc "RFC 4646 Language code for text/gemini documents.";
+ description = "RFC 4646 Language code for text/gemini documents.";
};
onlyTls_1_3 = mkOption {
default = false;
type = types.bool;
- description = lib.mdDoc "Only use TLSv1.3 (default also allows TLSv1.2).";
+ description = "Only use TLSv1.3 (default also allows TLSv1.2).";
};
extraArgs = mkOption {
type = types.listOf types.str;
default = [ "" ];
example = [ "--log-ip" ];
- description = lib.mdDoc "Extra arguments to use running agate.";
+ description = "Extra arguments to use running agate.";
};
};
};
diff --git a/nixos/modules/services/web-servers/apache-httpd/default.nix b/nixos/modules/services/web-servers/apache-httpd/default.nix
index 016e4885a095..4d49b29efff6 100644
--- a/nixos/modules/services/web-servers/apache-httpd/default.nix
+++ b/nixos/modules/services/web-servers/apache-httpd/default.nix
@@ -404,7 +404,7 @@ in
services.httpd = {
- enable = mkEnableOption (lib.mdDoc "the Apache HTTP Server");
+ enable = mkEnableOption "the Apache HTTP Server";
package = mkPackageOption pkgs "apacheHttpd" { };
@@ -413,7 +413,7 @@ in
default = confFile;
defaultText = literalExpression "confFile";
example = literalExpression ''pkgs.writeText "httpd.conf" "# my custom config file ..."'';
- description = lib.mdDoc ''
+ description = ''
Override the configuration file used by Apache. By default,
NixOS generates one automatically.
'';
@@ -422,7 +422,7 @@ in
extraConfig = mkOption {
type = types.lines;
default = "";
- description = lib.mdDoc ''
+ description = ''
Configuration lines appended to the generated Apache
configuration file. Note that this mechanism will not work
when {option}`configFile` is overridden.
@@ -438,7 +438,7 @@ in
{ name = "jk"; path = "''${pkgs.tomcat_connectors}/modules/mod_jk.so"; }
]
'';
- description = lib.mdDoc ''
+ description = ''
Additional Apache modules to be used. These can be
specified as a string in the case of modules distributed
with Apache, or as an attribute set specifying the
@@ -451,14 +451,14 @@ in
type = types.nullOr types.str;
example = "admin@example.org";
default = null;
- description = lib.mdDoc "E-mail address of the server administrator.";
+ description = "E-mail address of the server administrator.";
};
logFormat = mkOption {
type = types.str;
default = "common";
example = "combined";
- description = lib.mdDoc ''
+ description = ''
Log format for log files. Possible values are: combined, common, referer, agent, none.
See <https://httpd.apache.org/docs/2.4/logs.html> for more details.
'';
@@ -467,7 +467,7 @@ in
logPerVirtualHost = mkOption {
type = types.bool;
default = true;
- description = lib.mdDoc ''
+ description = ''
If enabled, each virtual host gets its own
{file}`access.log` and
{file}`error.log`, namely suffixed by the
@@ -478,7 +478,7 @@ in
user = mkOption {
type = types.str;
default = "wwwrun";
- description = lib.mdDoc ''
+ description = ''
User account under which httpd children processes run.
If you require the main httpd process to run as
@@ -492,7 +492,7 @@ in
group = mkOption {
type = types.str;
default = "wwwrun";
- description = lib.mdDoc ''
+ description = ''
Group under which httpd children processes run.
'';
};
@@ -500,7 +500,7 @@ in
logDir = mkOption {
type = types.path;
default = "/var/log/httpd";
- description = lib.mdDoc ''
+ description = ''
Directory for Apache's log files. It is created automatically.
'';
};
@@ -531,7 +531,7 @@ in
};
}
'';
- description = lib.mdDoc ''
+ description = ''
Specification of the virtual hosts served by Apache. Each
element should be an attribute set specifying the
configuration of the virtual host.
@@ -541,13 +541,13 @@ in
enableMellon = mkOption {
type = types.bool;
default = false;
- description = lib.mdDoc "Whether to enable the mod_auth_mellon module.";
+ description = "Whether to enable the mod_auth_mellon module.";
};
enablePHP = mkOption {
type = types.bool;
default = false;
- description = lib.mdDoc "Whether to enable the PHP module.";
+ description = "Whether to enable the PHP module.";
};
phpPackage = mkPackageOption pkgs "php" { };
@@ -555,7 +555,7 @@ in
enablePerl = mkOption {
type = types.bool;
default = false;
- description = lib.mdDoc "Whether to enable the Perl module (mod_perl).";
+ description = "Whether to enable the Perl module (mod_perl).";
};
phpOptions = mkOption {
@@ -565,7 +565,7 @@ in
''
date.timezone = "CET"
'';
- description = lib.mdDoc ''
+ description = ''
Options appended to the PHP configuration file {file}`php.ini`.
'';
};
@@ -574,8 +574,7 @@ in
type = types.enum [ "event" "prefork" "worker" ];
default = "event";
example = "worker";
- description =
- lib.mdDoc ''
+ description = ''
Multi-processing module to be used by Apache. Available
modules are `prefork` (handles each
request in a separate child process), `worker`
@@ -590,14 +589,14 @@ in
type = types.int;
default = 150;
example = 8;
- description = lib.mdDoc "Maximum number of httpd processes (prefork)";
+ description = "Maximum number of httpd processes (prefork)";
};
maxRequestsPerChild = mkOption {
type = types.int;
default = 0;
example = 500;
- description = lib.mdDoc ''
+ description = ''
Maximum number of httpd requests answered per httpd child (prefork), 0 means unlimited.
'';
};
@@ -605,14 +604,14 @@ in
sslCiphers = mkOption {
type = types.str;
default = "HIGH:!aNULL:!MD5:!EXP";
- description = lib.mdDoc "Cipher Suite available for negotiation in SSL proxy handshake.";
+ description = "Cipher Suite available for negotiation in SSL proxy handshake.";
};
sslProtocols = mkOption {
type = types.str;
default = "All -SSLv2 -SSLv3 -TLSv1 -TLSv1.1";
example = "All -SSLv2 -SSLv3";
- description = lib.mdDoc "Allowed SSL/TLS protocol versions.";
+ description = "Allowed SSL/TLS protocol versions.";
};
};
diff --git a/nixos/modules/services/web-servers/apache-httpd/location-options.nix b/nixos/modules/services/web-servers/apache-httpd/location-options.nix
index f2d4f8357047..80dc1674c5a2 100644
--- a/nixos/modules/services/web-servers/apache-httpd/location-options.nix
+++ b/nixos/modules/services/web-servers/apache-httpd/location-options.nix
@@ -9,7 +9,7 @@ in
type = with types; nullOr str;
default = null;
example = "http://www.example.org/";
- description = lib.mdDoc ''
+ description = ''
Sets up a simple reverse proxy as described by <https://httpd.apache.org/docs/2.4/howto/reverse_proxy.html#simple>.
'';
};
@@ -18,7 +18,7 @@ in
type = with types; nullOr str;
default = null;
example = "index.php index.html";
- description = lib.mdDoc ''
+ description = ''
Adds DirectoryIndex directive. See <https://httpd.apache.org/docs/2.4/mod/mod_dir.html#directoryindex>.
'';
};
@@ -27,7 +27,7 @@ in
type = with types; nullOr path;
default = null;
example = "/your/alias/directory";
- description = lib.mdDoc ''
+ description = ''
Alias directory for requests. See <https://httpd.apache.org/docs/2.4/mod/mod_alias.html#alias>.
'';
};
@@ -35,7 +35,7 @@ in
extraConfig = mkOption {
type = types.lines;
default = "";
- description = lib.mdDoc ''
+ description = ''
These lines go to the end of the location verbatim.
'';
};
@@ -43,7 +43,7 @@ in
priority = mkOption {
type = types.int;
default = 1000;
- description = lib.mdDoc ''
+ description = ''
Order of this location block in relation to the others in the vhost.
The semantics are the same as with `lib.mkOrder`. Smaller values have
a greater priority.
diff --git a/nixos/modules/services/web-servers/apache-httpd/vhost-options.nix b/nixos/modules/services/web-servers/apache-httpd/vhost-options.nix
index 7b87f9ef4bde..f3d57ac16ea2 100644
--- a/nixos/modules/services/web-servers/apache-httpd/vhost-options.nix
+++ b/nixos/modules/services/web-servers/apache-httpd/vhost-options.nix
@@ -8,14 +8,14 @@ in
hostName = mkOption {
type = types.str;
default = name;
- description = lib.mdDoc "Canonical hostname for the server.";
+ description = "Canonical hostname for the server.";
};
serverAliases = mkOption {
type = types.listOf types.str;
default = [];
example = ["www.example.org" "www.example.org:8080" "example.org"];
- description = lib.mdDoc ''
+ description = ''
Additional names of virtual hosts served by this virtual host configuration.
'';
};
@@ -25,17 +25,17 @@ in
options = {
port = mkOption {
type = types.port;
- description = lib.mdDoc "Port to listen on";
+ description = "Port to listen on";
};
ip = mkOption {
type = types.str;
default = "*";
- description = lib.mdDoc "IP to listen on. 0.0.0.0 for IPv4 only, * for all.";
+ description = "IP to listen on. 0.0.0.0 for IPv4 only, * for all.";
};
ssl = mkOption {
type = types.bool;
default = false;
- description = lib.mdDoc "Whether to enable SSL (https) support.";
+ description = "Whether to enable SSL (https) support.";
};
};
}));
@@ -45,7 +45,7 @@ in
{ ip = "192.154.1.1"; port = 80; }
{ ip = "*"; port = 8080; }
];
- description = lib.mdDoc ''
+ description = ''
Listen addresses and ports for this virtual host.
::: {.note}
@@ -59,7 +59,7 @@ in
listenAddresses = mkOption {
type = with types; nonEmptyListOf str;
- description = lib.mdDoc ''
+ description = ''
Listen addresses for this virtual host.
Compared to `listen` this only sets the addresses
and the ports are chosen automatically.
@@ -77,7 +77,7 @@ in
addSSL = mkOption {
type = types.bool;
default = false;
- description = lib.mdDoc ''
+ description = ''
Whether to enable HTTPS in addition to plain HTTP. This will set defaults for
`listen` to listen on all interfaces on the respective default
ports (80, 443).
@@ -87,7 +87,7 @@ in
onlySSL = mkOption {
type = types.bool;
default = false;
- description = lib.mdDoc ''
+ description = ''
Whether to enable HTTPS and reject plain HTTP connections. This will set
defaults for `listen` to listen on all interfaces on port 443.
'';
@@ -96,7 +96,7 @@ in
forceSSL = mkOption {
type = types.bool;
default = false;
- description = lib.mdDoc ''
+ description = ''
Whether to add a separate nginx server block that permanently redirects (301)
all plain HTTP traffic to HTTPS. This will set defaults for
`listen` to listen on all interfaces on the respective default
@@ -107,7 +107,7 @@ in
enableACME = mkOption {
type = types.bool;
default = false;
- description = lib.mdDoc ''
+ description = ''
Whether to ask Let's Encrypt to sign a certificate for this vhost.
Alternately, you can use an existing certificate through {option}`useACMEHost`.
'';
@@ -116,7 +116,7 @@ in
useACMEHost = mkOption {
type = types.nullOr types.str;
default = null;
- description = lib.mdDoc ''
+ description = ''
A host of an existing Let's Encrypt certificate to use.
This is useful if you have many subdomains and want to avoid hitting the
[rate limit](https://letsencrypt.org/docs/rate-limits).
@@ -128,7 +128,7 @@ in
acmeRoot = mkOption {
type = types.nullOr types.str;
default = "/var/lib/acme/acme-challenge";
- description = lib.mdDoc ''
+ description = ''
Directory for the acme challenge which is PUBLIC, don't put certs or keys in here.
Set to null to inherit from config.security.acme.
'';
@@ -137,26 +137,26 @@ in
sslServerCert = mkOption {
type = types.path;
example = "/var/host.cert";
- description = lib.mdDoc "Path to server SSL certificate.";
+ description = "Path to server SSL certificate.";
};
sslServerKey = mkOption {
type = types.path;
example = "/var/host.key";
- description = lib.mdDoc "Path to server SSL certificate key.";
+ description = "Path to server SSL certificate key.";
};
sslServerChain = mkOption {
type = types.nullOr types.path;
default = null;
example = "/var/ca.pem";
- description = lib.mdDoc "Path to server SSL chain file.";
+ description = "Path to server SSL chain file.";
};
http2 = mkOption {
type = types.bool;
default = true;
- description = lib.mdDoc ''
+ description = ''
Whether to enable HTTP 2. HTTP/2 is supported in all multi-processing modules that come with httpd. *However, if you use the prefork mpm, there will
be severe restrictions.* Refer to <https://httpd.apache.org/docs/2.4/howto/http2.html#mpm-config> for details.
'';
@@ -166,14 +166,14 @@ in
type = types.nullOr types.str;
default = null;
example = "admin@example.org";
- description = lib.mdDoc "E-mail address of the server administrator.";
+ description = "E-mail address of the server administrator.";
};
documentRoot = mkOption {
type = types.nullOr types.path;
default = null;
example = "/data/webserver/docs";
- description = lib.mdDoc ''
+ description = ''
The path of Apache's document root directory. If left undefined,
an empty directory in the Nix store will be used as root.
'';
@@ -187,7 +187,7 @@ in
dir = "/home/eelco/Dev/nix-homepage";
}
];
- description = lib.mdDoc ''
+ description = ''
This option provides a simple way to serve static directories.
'';
};
@@ -200,7 +200,7 @@ in
file = "/home/eelco/some-file.png";
}
];
- description = lib.mdDoc ''
+ description = ''
This option provides a simple way to serve individual, static files.
::: {.note}
@@ -220,7 +220,7 @@ in
AllowOverride All
</Directory>
'';
- description = lib.mdDoc ''
+ description = ''
These lines go to httpd.conf verbatim. They will go after
directories and directory aliases defined by default.
'';
@@ -229,7 +229,7 @@ in
enableUserDir = mkOption {
type = types.bool;
default = false;
- description = lib.mdDoc ''
+ description = ''
Whether to enable serving {file}`~/public_html` as
`/~«username»`.
'';
@@ -239,7 +239,7 @@ in
type = types.nullOr types.str;
default = null;
example = "http://newserver.example.org/";
- description = lib.mdDoc ''
+ description = ''
If set, all requests for this host are redirected permanently to
the given URL.
'';
@@ -249,7 +249,7 @@ in
type = types.str;
default = "common";
example = "combined";
- description = lib.mdDoc ''
+ description = ''
Log format for Apache's log files. Possible values are: combined, common, referer, agent.
'';
};
@@ -258,7 +258,7 @@ in
type = types.lines;
default = "";
example = "Disallow: /foo/";
- description = lib.mdDoc ''
+ description = ''
Specification of pages to be ignored by web crawlers. See <http://www.robotstxt.org/> for details.
'';
};
@@ -276,7 +276,7 @@ in
};
};
'';
- description = lib.mdDoc ''
+ description = ''
Declarative location config. See <https://httpd.apache.org/docs/2.4/mod/core.html#location> for details.
'';
};
diff --git a/nixos/modules/services/web-servers/caddy/default.nix b/nixos/modules/services/web-servers/caddy/default.nix
index 95dc219d108c..08ce50bff62c 100644
--- a/nixos/modules/services/web-servers/caddy/default.nix
+++ b/nixos/modules/services/web-servers/caddy/default.nix
@@ -64,12 +64,12 @@ in
# interface
options.services.caddy = {
- enable = mkEnableOption (lib.mdDoc "Caddy web server");
+ enable = mkEnableOption "Caddy web server";
user = mkOption {
default = "caddy";
type = types.str;
- description = lib.mdDoc ''
+ description = ''
User account under which caddy runs.
::: {.note}
@@ -83,7 +83,7 @@ in
group = mkOption {
default = "caddy";
type = types.str;
- description = lib.mdDoc ''
+ description = ''
Group account under which caddy runs.
::: {.note}
@@ -99,7 +99,7 @@ in
dataDir = mkOption {
type = types.path;
default = "/var/lib/caddy";
- description = lib.mdDoc ''
+ description = ''
The data directory for caddy.
::: {.note}
@@ -116,7 +116,7 @@ in
logDir = mkOption {
type = types.path;
default = "/var/log/caddy";
- description = lib.mdDoc ''
+ description = ''
Directory for storing Caddy access logs.
::: {.note}
@@ -135,7 +135,7 @@ in
example = literalExpression ''
mkForce "level INFO";
'';
- description = lib.mdDoc ''
+ description = ''
Configuration for the default logger. See
<https://caddyserver.com/docs/caddyfile/options#log>
for details.
@@ -155,7 +155,7 @@ in
file_server
''';
'';
- description = lib.mdDoc ''
+ description = ''
Override the configuration file used by Caddy. By default,
NixOS generates one automatically.
@@ -170,7 +170,7 @@ in
'';
example = literalExpression "nginx";
type = with types; nullOr str;
- description = lib.mdDoc ''
+ description = ''
Name of the config adapter to use.
See <https://caddyserver.com/docs/config-adapters>
for the full list.
@@ -192,7 +192,7 @@ in
resume = mkOption {
default = false;
type = types.bool;
- description = lib.mdDoc ''
+ description = ''
Use saved config, if any (and prefer over any specified configuration passed with `--config`).
'';
};
@@ -208,7 +208,7 @@ in
}
}
'';
- description = lib.mdDoc ''
+ description = ''
Additional lines of configuration appended to the global config section
of the `Caddyfile`.
@@ -227,7 +227,7 @@ in
root /srv/http
}
'';
- description = lib.mdDoc ''
+ description = ''
Additional lines of configuration appended to the automatically
generated `Caddyfile`.
'';
@@ -247,7 +247,7 @@ in
};
};
'';
- description = lib.mdDoc ''
+ description = ''
Declarative specification of virtual hosts served by Caddy.
'';
};
@@ -256,7 +256,7 @@ in
default = null;
example = "https://acme-v02.api.letsencrypt.org/directory";
type = with types; nullOr str;
- description = lib.mdDoc ''
+ description = ''
::: {.note}
Sets the [`acme_ca` option](https://caddyserver.com/docs/caddyfile/options#acme-ca)
in the global options block of the resulting Caddyfile.
@@ -276,7 +276,7 @@ in
email = mkOption {
default = null;
type = with types; nullOr str;
- description = lib.mdDoc ''
+ description = ''
Your email address. Mainly used when creating an ACME account with your
CA, and is highly recommended in case there are problems with your
certificates.
@@ -286,7 +286,7 @@ in
enableReload = mkOption {
default = true;