forked from mirrors/nixpkgs
143 lines
4.2 KiB
Nix
143 lines
4.2 KiB
Nix
{ lib, ... }:
|
|
{ options.services.nghttpx = {
|
|
enable = lib.mkEnableOption "nghttpx";
|
|
|
|
frontends = lib.mkOption {
|
|
type = lib.types.listOf (lib.types.submodule (import ./frontend-submodule.nix));
|
|
description = lib.mdDoc ''
|
|
A list of frontend listener specifications.
|
|
'';
|
|
example = [
|
|
{ server = {
|
|
host = "*";
|
|
port = 80;
|
|
};
|
|
|
|
params = {
|
|
tls = "no-tls";
|
|
};
|
|
}
|
|
];
|
|
};
|
|
|
|
backends = lib.mkOption {
|
|
type = lib.types.listOf (lib.types.submodule (import ./backend-submodule.nix));
|
|
description = lib.mdDoc ''
|
|
A list of backend specifications.
|
|
'';
|
|
example = [
|
|
{ server = {
|
|
host = "172.16.0.22";
|
|
port = 8443;
|
|
};
|
|
patterns = [ "/" ];
|
|
params = {
|
|
proto = "http/1.1";
|
|
redirect-if-not-tls = true;
|
|
};
|
|
}
|
|
];
|
|
};
|
|
|
|
tls = lib.mkOption {
|
|
type = lib.types.nullOr (lib.types.submodule (import ./tls-submodule.nix));
|
|
default = null;
|
|
description = lib.mdDoc ''
|
|
TLS certificate and key paths. Note that this does not enable
|
|
TLS for a frontend listener, to do so, a frontend
|
|
specification must set `params.tls` to true.
|
|
'';
|
|
example = {
|
|
key = "/etc/ssl/keys/server.key";
|
|
crt = "/etc/ssl/certs/server.crt";
|
|
};
|
|
};
|
|
|
|
extraConfig = lib.mkOption {
|
|
type = lib.types.lines;
|
|
default = "";
|
|
description = lib.mdDoc ''
|
|
Extra configuration options to be appended to the generated
|
|
configuration file.
|
|
'';
|
|
};
|
|
|
|
single-process = lib.mkOption {
|
|
type = lib.types.bool;
|
|
default = false;
|
|
description = lib.mdDoc ''
|
|
Run this program in a single process mode for debugging
|
|
purpose. Without this option, nghttpx creates at least 2
|
|
processes: master and worker processes. If this option is
|
|
used, master and worker are unified into a single
|
|
process. nghttpx still spawns additional process if neverbleed
|
|
is used. In the single process mode, the signal handling
|
|
feature is disabled.
|
|
|
|
Please see https://nghttp2.org/documentation/nghttpx.1.html#cmdoption-nghttpx--single-process
|
|
'';
|
|
};
|
|
|
|
backlog = lib.mkOption {
|
|
type = lib.types.int;
|
|
default = 65536;
|
|
description = lib.mdDoc ''
|
|
Listen backlog size.
|
|
|
|
Please see https://nghttp2.org/documentation/nghttpx.1.html#cmdoption-nghttpx--backlog
|
|
'';
|
|
};
|
|
|
|
backend-address-family = lib.mkOption {
|
|
type = lib.types.enum [
|
|
"auto"
|
|
"IPv4"
|
|
"IPv6"
|
|
];
|
|
default = "auto";
|
|
description = lib.mdDoc ''
|
|
Specify address family of backend connections. If "auto" is
|
|
given, both IPv4 and IPv6 are considered. If "IPv4" is given,
|
|
only IPv4 address is considered. If "IPv6" is given, only IPv6
|
|
address is considered.
|
|
|
|
Please see https://nghttp2.org/documentation/nghttpx.1.html#cmdoption-nghttpx--backend-address-family
|
|
'';
|
|
};
|
|
|
|
workers = lib.mkOption {
|
|
type = lib.types.int;
|
|
default = 1;
|
|
description = lib.mdDoc ''
|
|
Set the number of worker threads.
|
|
|
|
Please see https://nghttp2.org/documentation/nghttpx.1.html#cmdoption-nghttpx-n
|
|
'';
|
|
};
|
|
|
|
single-thread = lib.mkOption {
|
|
type = lib.types.bool;
|
|
default = false;
|
|
description = lib.mdDoc ''
|
|
Run everything in one thread inside the worker process. This
|
|
feature is provided for better debugging experience, or for
|
|
the platforms which lack thread support. If threading is
|
|
disabled, this option is always enabled.
|
|
|
|
Please see https://nghttp2.org/documentation/nghttpx.1.html#cmdoption-nghttpx--single-thread
|
|
'';
|
|
};
|
|
|
|
rlimit-nofile = lib.mkOption {
|
|
type = lib.types.int;
|
|
default = 0;
|
|
description = ''
|
|
Set maximum number of open files (RLIMIT_NOFILE) to <N>. If 0
|
|
is given, nghttpx does not set the limit.
|
|
|
|
Please see https://nghttp2.org/documentation/nghttpx.1.html#cmdoption-nghttpx--rlimit-nofile
|
|
'';
|
|
};
|
|
};
|
|
}
|