mirror of
https://github.com/NixOS/nixpkgs.git
synced 2025-06-11 18:41:33 +09:00
nixos/*: mark pre-existing markdown descriptions as mdDoc
This commit is contained in:
parent
b51f8036c2
commit
7e7d68a250
70 changed files with 96 additions and 96 deletions
|
@ -20,7 +20,7 @@ in
|
||||||
type = types.str;
|
type = types.str;
|
||||||
default = "0xfffd7fff";
|
default = "0xfffd7fff";
|
||||||
example = "0xffffffff";
|
example = "0xffffffff";
|
||||||
description = ''
|
description = lib.mdDoc ''
|
||||||
Sets the `amdgpu.ppfeaturemask` kernel option.
|
Sets the `amdgpu.ppfeaturemask` kernel option.
|
||||||
In particular, it is used here to set the overdrive bit.
|
In particular, it is used here to set the overdrive bit.
|
||||||
Default is `0xfffd7fff` as it is less likely to cause flicker issues.
|
Default is `0xfffd7fff` as it is less likely to cause flicker issues.
|
||||||
|
|
|
@ -23,7 +23,7 @@ in
|
||||||
}
|
}
|
||||||
'';
|
'';
|
||||||
|
|
||||||
description = ''
|
description = lib.mdDoc ''
|
||||||
A set with the key names being the environment variable you'd like to
|
A set with the key names being the environment variable you'd like to
|
||||||
set and the values being a list of paths to text documents containing
|
set and the values being a list of paths to text documents containing
|
||||||
lists of words. The various files will be merged, sorted, duplicates
|
lists of words. The various files will be merged, sorted, duplicates
|
||||||
|
|
|
@ -17,7 +17,7 @@ in
|
||||||
type = lib.types.bool;
|
type = lib.types.bool;
|
||||||
};
|
};
|
||||||
withUtempter = mkOption {
|
withUtempter = mkOption {
|
||||||
description = ''
|
description = lib.mdDoc ''
|
||||||
Whether to enable libutempter for mosh.
|
Whether to enable libutempter for mosh.
|
||||||
This is required so that mosh can write to /var/run/utmp (which can be queried with `who` to display currently connected user sessions).
|
This is required so that mosh can write to /var/run/utmp (which can be queried with `who` to display currently connected user sessions).
|
||||||
Note, this will add a guid wrapper for the group utmp!
|
Note, this will add a guid wrapper for the group utmp!
|
||||||
|
|
|
@ -45,7 +45,7 @@ in {
|
||||||
passwordeval = "cat /secrets/password.txt";
|
passwordeval = "cat /secrets/password.txt";
|
||||||
};
|
};
|
||||||
};
|
};
|
||||||
description = ''
|
description = lib.mdDoc ''
|
||||||
Named accounts and their respective configurations.
|
Named accounts and their respective configurations.
|
||||||
The special name "default" allows a default account to be defined.
|
The special name "default" allows a default account to be defined.
|
||||||
See msmtp(1) for the available options.
|
See msmtp(1) for the available options.
|
||||||
|
|
|
@ -22,7 +22,7 @@ in
|
||||||
default = "fuck";
|
default = "fuck";
|
||||||
type = types.str;
|
type = types.str;
|
||||||
|
|
||||||
description = ''
|
description = lib.mdDoc ''
|
||||||
`thefuck` needs an alias to be configured.
|
`thefuck` needs an alias to be configured.
|
||||||
The default value is `fuck`, but you can use anything else as well.
|
The default value is `fuck`, but you can use anything else as well.
|
||||||
'';
|
'';
|
||||||
|
|
|
@ -62,7 +62,7 @@ in
|
||||||
to use `yabar-unstable'.
|
to use `yabar-unstable'.
|
||||||
'';
|
'';
|
||||||
|
|
||||||
description = ''
|
description = lib.mdDoc ''
|
||||||
The package which contains the `yabar` binary.
|
The package which contains the `yabar` binary.
|
||||||
|
|
||||||
Nixpkgs provides the `yabar` and `yabar-unstable`
|
Nixpkgs provides the `yabar` and `yabar-unstable`
|
||||||
|
|
|
@ -49,7 +49,7 @@ in
|
||||||
package = mkOption {
|
package = mkOption {
|
||||||
default = pkgs.oh-my-zsh;
|
default = pkgs.oh-my-zsh;
|
||||||
defaultText = literalExpression "pkgs.oh-my-zsh";
|
defaultText = literalExpression "pkgs.oh-my-zsh";
|
||||||
description = ''
|
description = lib.mdDoc ''
|
||||||
Package to install for `oh-my-zsh` usage.
|
Package to install for `oh-my-zsh` usage.
|
||||||
'';
|
'';
|
||||||
|
|
||||||
|
@ -67,7 +67,7 @@ in
|
||||||
custom = mkOption {
|
custom = mkOption {
|
||||||
default = null;
|
default = null;
|
||||||
type = with types; nullOr str;
|
type = with types; nullOr str;
|
||||||
description = ''
|
description = lib.mdDoc ''
|
||||||
Path to a custom oh-my-zsh package to override config of oh-my-zsh.
|
Path to a custom oh-my-zsh package to override config of oh-my-zsh.
|
||||||
(Can't be used along with `customPkgs`).
|
(Can't be used along with `customPkgs`).
|
||||||
'';
|
'';
|
||||||
|
@ -76,7 +76,7 @@ in
|
||||||
customPkgs = mkOption {
|
customPkgs = mkOption {
|
||||||
default = [];
|
default = [];
|
||||||
type = types.listOf types.package;
|
type = types.listOf types.package;
|
||||||
description = ''
|
description = lib.mdDoc ''
|
||||||
List of custom packages that should be loaded into `oh-my-zsh`.
|
List of custom packages that should be loaded into `oh-my-zsh`.
|
||||||
'';
|
'';
|
||||||
};
|
};
|
||||||
|
@ -92,7 +92,7 @@ in
|
||||||
cacheDir = mkOption {
|
cacheDir = mkOption {
|
||||||
default = "$HOME/.cache/oh-my-zsh";
|
default = "$HOME/.cache/oh-my-zsh";
|
||||||
type = types.str;
|
type = types.str;
|
||||||
description = ''
|
description = lib.mdDoc ''
|
||||||
Cache directory to be used by `oh-my-zsh`.
|
Cache directory to be used by `oh-my-zsh`.
|
||||||
Without this option it would default to the read-only nix store.
|
Without this option it would default to the read-only nix store.
|
||||||
'';
|
'';
|
||||||
|
|
|
@ -11,7 +11,7 @@ in {
|
||||||
package = mkOption {
|
package = mkOption {
|
||||||
default = pkgs.zsh-autoenv;
|
default = pkgs.zsh-autoenv;
|
||||||
defaultText = literalExpression "pkgs.zsh-autoenv";
|
defaultText = literalExpression "pkgs.zsh-autoenv";
|
||||||
description = ''
|
description = lib.mdDoc ''
|
||||||
Package to install for `zsh-autoenv` usage.
|
Package to install for `zsh-autoenv` usage.
|
||||||
'';
|
'';
|
||||||
|
|
||||||
|
|
|
@ -24,7 +24,7 @@ in
|
||||||
strategy = mkOption {
|
strategy = mkOption {
|
||||||
type = types.listOf (types.enum [ "history" "completion" "match_prev_cmd" ]);
|
type = types.listOf (types.enum [ "history" "completion" "match_prev_cmd" ]);
|
||||||
default = [ "history" ];
|
default = [ "history" ];
|
||||||
description = ''
|
description = lib.mdDoc ''
|
||||||
`ZSH_AUTOSUGGEST_STRATEGY` is an array that specifies how suggestions should be generated.
|
`ZSH_AUTOSUGGEST_STRATEGY` is an array that specifies how suggestions should be generated.
|
||||||
The strategies in the array are tried successively until a suggestion is found.
|
The strategies in the array are tried successively until a suggestion is found.
|
||||||
There are currently three built-in strategies to choose from:
|
There are currently three built-in strategies to choose from:
|
||||||
|
|
|
@ -676,7 +676,7 @@ let
|
||||||
inheritDefaults = mkOption {
|
inheritDefaults = mkOption {
|
||||||
default = true;
|
default = true;
|
||||||
example = true;
|
example = true;
|
||||||
description = "Whether to inherit values set in `security.acme.defaults` or not.";
|
description = lib.mdDoc "Whether to inherit values set in `security.acme.defaults` or not.";
|
||||||
type = lib.types.bool;
|
type = lib.types.bool;
|
||||||
};
|
};
|
||||||
};
|
};
|
||||||
|
|
|
@ -46,7 +46,7 @@ in
|
||||||
type = types.package;
|
type = types.package;
|
||||||
default = pkgs.sudo;
|
default = pkgs.sudo;
|
||||||
defaultText = literalExpression "pkgs.sudo";
|
defaultText = literalExpression "pkgs.sudo";
|
||||||
description = ''
|
description = lib.mdDoc ''
|
||||||
Which package to use for `sudo`.
|
Which package to use for `sudo`.
|
||||||
'';
|
'';
|
||||||
};
|
};
|
||||||
|
|
|
@ -193,7 +193,7 @@ in
|
||||||
options.services.buildkite-agents = mkOption {
|
options.services.buildkite-agents = mkOption {
|
||||||
type = types.attrsOf (types.submodule buildkiteOptions);
|
type = types.attrsOf (types.submodule buildkiteOptions);
|
||||||
default = {};
|
default = {};
|
||||||
description = ''
|
description = lib.mdDoc ''
|
||||||
Attribute set of buildkite agents.
|
Attribute set of buildkite agents.
|
||||||
The attribute key is combined with the hostname and a unique integer to
|
The attribute key is combined with the hostname and a unique integer to
|
||||||
create the final agent name. This can be overridden by setting the `name`
|
create the final agent name. This can be overridden by setting the `name`
|
||||||
|
|
|
@ -87,7 +87,7 @@ in
|
||||||
type = types.str;
|
type = types.str;
|
||||||
default = localDB;
|
default = localDB;
|
||||||
example = "dbi:Pg:dbname=hydra;host=postgres.example.org;user=foo;";
|
example = "dbi:Pg:dbname=hydra;host=postgres.example.org;user=foo;";
|
||||||
description = ''
|
description = lib.mdDoc ''
|
||||||
The DBI string for Hydra database connection.
|
The DBI string for Hydra database connection.
|
||||||
|
|
||||||
NOTE: Attempts to set `application_name` will be overridden by
|
NOTE: Attempts to set `application_name` will be overridden by
|
||||||
|
|
|
@ -9,7 +9,7 @@ in {
|
||||||
enable = lib.mkOption {
|
enable = lib.mkOption {
|
||||||
default = false;
|
default = false;
|
||||||
type = lib.types.bool;
|
type = lib.types.bool;
|
||||||
description = ''
|
description = lib.mdDoc ''
|
||||||
Enables the daemon for `lorri`, a nix-shell replacement for project
|
Enables the daemon for `lorri`, a nix-shell replacement for project
|
||||||
development. The socket-activated daemon starts on the first request
|
development. The socket-activated daemon starts on the first request
|
||||||
issued by the `lorri` command.
|
issued by the `lorri` command.
|
||||||
|
|
|
@ -36,7 +36,7 @@ in {
|
||||||
certificateChain = mkOption {
|
certificateChain = mkOption {
|
||||||
type = types.nullOr types.path;
|
type = types.nullOr types.path;
|
||||||
default = null;
|
default = null;
|
||||||
description = ''
|
description = lib.mdDoc ''
|
||||||
Chain of CA-certificates to which our `certificateFile` is relative.
|
Chain of CA-certificates to which our `certificateFile` is relative.
|
||||||
Optional for TLS.
|
Optional for TLS.
|
||||||
'';
|
'';
|
||||||
|
|
|
@ -41,7 +41,7 @@ in {
|
||||||
stateDir = mkOption {
|
stateDir = mkOption {
|
||||||
type = types.str;
|
type = types.str;
|
||||||
default = "/var/lib/crossfire";
|
default = "/var/lib/crossfire";
|
||||||
description = ''
|
description = lib.mdDoc ''
|
||||||
Where to store runtime data (save files, persistent items, etc).
|
Where to store runtime data (save files, persistent items, etc).
|
||||||
|
|
||||||
If left at the default, this will be automatically created on server
|
If left at the default, this will be automatically created on server
|
||||||
|
@ -61,7 +61,7 @@ in {
|
||||||
|
|
||||||
configFiles = mkOption {
|
configFiles = mkOption {
|
||||||
type = types.attrsOf types.str;
|
type = types.attrsOf types.str;
|
||||||
description = ''
|
description = lib.mdDoc ''
|
||||||
Text to append to the corresponding configuration files. Note that the
|
Text to append to the corresponding configuration files. Note that the
|
||||||
files given in the example are *not* the complete set of files available
|
files given in the example are *not* the complete set of files available
|
||||||
to customize; look in /etc/crossfire after enabling the server to see
|
to customize; look in /etc/crossfire after enabling the server to see
|
||||||
|
|
|
@ -41,7 +41,7 @@ in {
|
||||||
stateDir = mkOption {
|
stateDir = mkOption {
|
||||||
type = types.str;
|
type = types.str;
|
||||||
default = "/var/lib/deliantra";
|
default = "/var/lib/deliantra";
|
||||||
description = ''
|
description = lib.mdDoc ''
|
||||||
Where to store runtime data (save files, persistent items, etc).
|
Where to store runtime data (save files, persistent items, etc).
|
||||||
|
|
||||||
If left at the default, this will be automatically created on server
|
If left at the default, this will be automatically created on server
|
||||||
|
|
|
@ -25,7 +25,7 @@ in
|
||||||
gameId = mkOption {
|
gameId = mkOption {
|
||||||
type = types.nullOr types.str;
|
type = types.nullOr types.str;
|
||||||
default = null;
|
default = null;
|
||||||
description = ''
|
description = lib.mdDoc ''
|
||||||
Id of the game to use. To list available games run
|
Id of the game to use. To list available games run
|
||||||
`minetestserver --gameid list`.
|
`minetestserver --gameid list`.
|
||||||
|
|
||||||
|
@ -36,7 +36,7 @@ in
|
||||||
world = mkOption {
|
world = mkOption {
|
||||||
type = types.nullOr types.path;
|
type = types.nullOr types.path;
|
||||||
default = null;
|
default = null;
|
||||||
description = ''
|
description = lib.mdDoc ''
|
||||||
Name of the world to use. To list available worlds run
|
Name of the world to use. To list available worlds run
|
||||||
`minetestserver --world list`.
|
`minetestserver --world list`.
|
||||||
|
|
||||||
|
@ -47,7 +47,7 @@ in
|
||||||
configPath = mkOption {
|
configPath = mkOption {
|
||||||
type = types.nullOr types.path;
|
type = types.nullOr types.path;
|
||||||
default = null;
|
default = null;
|
||||||
description = ''
|
description = lib.mdDoc ''
|
||||||
Path to the config to use.
|
Path to the config to use.
|
||||||
|
|
||||||
If set to null, the config of the running user will be used:
|
If set to null, the config of the running user will be used:
|
||||||
|
|
|
@ -79,7 +79,7 @@ let
|
||||||
priority = mkOption {
|
priority = mkOption {
|
||||||
type = types.int;
|
type = types.int;
|
||||||
default = 1000;
|
default = 1000;
|
||||||
description = ''
|
description = lib.mdDoc ''
|
||||||
Order of this logrotate block in relation to the others. The semantics are
|
Order of this logrotate block in relation to the others. The semantics are
|
||||||
the same as with `lib.mkOrder`. Smaller values have a greater priority.
|
the same as with `lib.mkOrder`. Smaller values have a greater priority.
|
||||||
'';
|
'';
|
||||||
|
@ -260,7 +260,7 @@ in
|
||||||
priority = mkOption {
|
priority = mkOption {
|
||||||
type = types.int;
|
type = types.int;
|
||||||
default = 1000;
|
default = 1000;
|
||||||
description = ''
|
description = lib.mdDoc ''
|
||||||
Order of this logrotate block in relation to the others. The semantics are
|
Order of this logrotate block in relation to the others. The semantics are
|
||||||
the same as with `lib.mkOrder`. Smaller values are inserted first.
|
the same as with `lib.mkOrder`. Smaller values are inserted first.
|
||||||
'';
|
'';
|
||||||
|
|
|
@ -516,7 +516,7 @@ in {
|
||||||
type = types.bool;
|
type = types.bool;
|
||||||
default = true;
|
default = true;
|
||||||
example = false;
|
example = false;
|
||||||
description = ''
|
description = lib.mdDoc ''
|
||||||
Is the preview URL API enabled? If enabled, you *must* specify an
|
Is the preview URL API enabled? If enabled, you *must* specify an
|
||||||
explicit url_preview_ip_range_blacklist of IPs that the spider is
|
explicit url_preview_ip_range_blacklist of IPs that the spider is
|
||||||
denied from accessing.
|
denied from accessing.
|
||||||
|
|
|
@ -183,7 +183,7 @@ in
|
||||||
file = mkOption {
|
file = mkOption {
|
||||||
type = types.nullOr types.str;
|
type = types.nullOr types.str;
|
||||||
default = null;
|
default = null;
|
||||||
description = "Filename to be used for the dump. If `null` a default name is choosen by gitea.";
|
description = lib.mdDoc "Filename to be used for the dump. If `null` a default name is choosen by gitea.";
|
||||||
example = "gitea-dump";
|
example = "gitea-dump";
|
||||||
};
|
};
|
||||||
};
|
};
|
||||||
|
|
|
@ -82,7 +82,7 @@ in
|
||||||
'';
|
'';
|
||||||
configFile = mkOption {
|
configFile = mkOption {
|
||||||
type = path;
|
type = path;
|
||||||
description = "Path to firmware config which is generated using `klipper-genconf`";
|
description = lib.mdDoc "Path to firmware config which is generated using `klipper-genconf`";
|
||||||
};
|
};
|
||||||
};
|
};
|
||||||
});
|
});
|
||||||
|
|
|
@ -264,7 +264,7 @@ in
|
||||||
type = types.nullOr types.str;
|
type = types.nullOr types.str;
|
||||||
default = null;
|
default = null;
|
||||||
example = "/root/.ssh/id_buildhost_builduser";
|
example = "/root/.ssh/id_buildhost_builduser";
|
||||||
description = ''
|
description = lib.mdDoc ''
|
||||||
The path to the SSH private key with which to authenticate on
|
The path to the SSH private key with which to authenticate on
|
||||||
the build machine. The private key must not have a passphrase.
|
the build machine. The private key must not have a passphrase.
|
||||||
If null, the building user (root on NixOS machines) must have an
|
If null, the building user (root on NixOS machines) must have an
|
||||||
|
|
|
@ -50,7 +50,7 @@ in {
|
||||||
type = with types; attrsOf str;
|
type = with types; attrsOf str;
|
||||||
default = { };
|
default = { };
|
||||||
example = { DATADIR = "/custom/path/for/rmfakecloud/data"; };
|
example = { DATADIR = "/custom/path/for/rmfakecloud/data"; };
|
||||||
description = ''
|
description = lib.mdDoc ''
|
||||||
Extra settings in the form of a set of key-value pairs.
|
Extra settings in the form of a set of key-value pairs.
|
||||||
For tokens and secrets, use `environmentFile` instead.
|
For tokens and secrets, use `environmentFile` instead.
|
||||||
|
|
||||||
|
|
|
@ -80,7 +80,7 @@ in {
|
||||||
webserver = mkOption {
|
webserver = mkOption {
|
||||||
type = types.enum [ "nginx" "none" ];
|
type = types.enum [ "nginx" "none" ];
|
||||||
default = "nginx";
|
default = "nginx";
|
||||||
description = ''
|
description = lib.mdDoc ''
|
||||||
The webserver to configure for the PHP frontend.
|
The webserver to configure for the PHP frontend.
|
||||||
|
|
||||||
Set it to `none` if you want to configure it yourself. PRs are welcome
|
Set it to `none` if you want to configure it yourself. PRs are welcome
|
||||||
|
|
|
@ -52,7 +52,7 @@ in {
|
||||||
|
|
||||||
buildMinimalPackage = mkOption {
|
buildMinimalPackage = mkOption {
|
||||||
default = false;
|
default = false;
|
||||||
description = ''
|
description = lib.mdDoc ''
|
||||||
Build a minimal collectd package with only the configured `services.collectd.plugins`
|
Build a minimal collectd package with only the configured `services.collectd.plugins`
|
||||||
'';
|
'';
|
||||||
type = bool;
|
type = bool;
|
||||||
|
|
|
@ -60,7 +60,7 @@ in {
|
||||||
package = mkOption {
|
package = mkOption {
|
||||||
default = pkgs.datadog-agent;
|
default = pkgs.datadog-agent;
|
||||||
defaultText = literalExpression "pkgs.datadog-agent";
|
defaultText = literalExpression "pkgs.datadog-agent";
|
||||||
description = ''
|
description = lib.mdDoc ''
|
||||||
Which DataDog v7 agent package to use. Note that the provided
|
Which DataDog v7 agent package to use. Note that the provided
|
||||||
package is expected to have an overridable `pythonPackages`-attribute
|
package is expected to have an overridable `pythonPackages`-attribute
|
||||||
which configures the Python environment with the Datadog
|
which configures the Python environment with the Datadog
|
||||||
|
@ -168,7 +168,7 @@ in {
|
||||||
};
|
};
|
||||||
|
|
||||||
checks = mkOption {
|
checks = mkOption {
|
||||||
description = ''
|
description = lib.mdDoc ''
|
||||||
Configuration for all Datadog checks. Keys of this attribute
|
Configuration for all Datadog checks. Keys of this attribute
|
||||||
set will be used as the name of the check to create the
|
set will be used as the name of the check to create the
|
||||||
appropriate configuration in `conf.d/$check.d/conf.yaml`.
|
appropriate configuration in `conf.d/$check.d/conf.yaml`.
|
||||||
|
|
|
@ -251,7 +251,7 @@ let
|
||||||
authorization = mkOption {
|
authorization = mkOption {
|
||||||
type = types.nullOr types.attrs;
|
type = types.nullOr types.attrs;
|
||||||
default = null;
|
default = null;
|
||||||
description = ''
|
description = lib.mdDoc ''
|
||||||
Sets the `Authorization` header on every scrape request with the configured credentials.
|
Sets the `Authorization` header on every scrape request with the configured credentials.
|
||||||
'';
|
'';
|
||||||
};
|
};
|
||||||
|
@ -664,7 +664,7 @@ let
|
||||||
promTypes.dockerswarm_sd_config = mkDockerSdConfigModule {
|
promTypes.dockerswarm_sd_config = mkDockerSdConfigModule {
|
||||||
role = mkOption {
|
role = mkOption {
|
||||||
type = types.enum [ "services" "tasks" "nodes" ];
|
type = types.enum [ "services" "tasks" "nodes" ];
|
||||||
description = ''
|
description = lib.mdDoc ''
|
||||||
Role of the targets to retrieve. Must be `services`, `tasks`, or `nodes`.
|
Role of the targets to retrieve. Must be `services`, `tasks`, or `nodes`.
|
||||||
'';
|
'';
|
||||||
};
|
};
|
||||||
|
@ -1222,7 +1222,7 @@ let
|
||||||
|
|
||||||
role = mkOption {
|
role = mkOption {
|
||||||
type = types.enum [ "instance" "baremetal" ];
|
type = types.enum [ "instance" "baremetal" ];
|
||||||
description = ''
|
description = lib.mdDoc ''
|
||||||
Role of the targets to retrieve. Must be `instance` or `baremetal`.
|
Role of the targets to retrieve. Must be `instance` or `baremetal`.
|
||||||
'';
|
'';
|
||||||
};
|
};
|
||||||
|
|
|
@ -10,7 +10,7 @@ in {
|
||||||
settings = mkOption {
|
settings = mkOption {
|
||||||
type = types.attrs;
|
type = types.attrs;
|
||||||
default = {};
|
default = {};
|
||||||
description = ''
|
description = lib.mdDoc ''
|
||||||
All settings of nginxlog expressed as an Nix attrset.
|
All settings of nginxlog expressed as an Nix attrset.
|
||||||
|
|
||||||
Check the official documentation for the corresponding YAML
|
Check the official documentation for the corresponding YAML
|
||||||
|
|
|
@ -37,7 +37,7 @@ in {
|
||||||
extraArgs = mkOption {
|
extraArgs = mkOption {
|
||||||
type = types.listOf types.str;
|
type = types.listOf types.str;
|
||||||
default = [];
|
default = [];
|
||||||
description = ''
|
description = lib.mdDoc ''
|
||||||
A list of commandline-switches forwarded to a riemann-tool.
|
A list of commandline-switches forwarded to a riemann-tool.
|
||||||
See for example `riemann-health --help` for available options.
|
See for example `riemann-health --help` for available options.
|
||||||
'';
|
'';
|
||||||
|
|
|
@ -111,7 +111,7 @@ in
|
||||||
uuid = mkOption {
|
uuid = mkOption {
|
||||||
example = "eacb6bab-f444-4ebf-a06a-3f72d7465e40";
|
example = "eacb6bab-f444-4ebf-a06a-3f72d7465e40";
|
||||||
type = types.str;
|
type = types.str;
|
||||||
description = ''
|
description = lib.mdDoc ''
|
||||||
Must be set to a unique identifier, preferably a UUID according to
|
Must be set to a unique identifier, preferably a UUID according to
|
||||||
RFC 4122. UUIDs can be generated with `uuidgen` command, found in
|
RFC 4122. UUIDs can be generated with `uuidgen` command, found in
|
||||||
the `util-linux` package.
|
the `util-linux` package.
|
||||||
|
@ -236,7 +236,7 @@ in
|
||||||
uuid = mkOption {
|
uuid = mkOption {
|
||||||
example = "eacb6bab-f444-4ebf-a06a-3f72d7465e41";
|
example = "eacb6bab-f444-4ebf-a06a-3f72d7465e41";
|
||||||
type = types.str;
|
type = types.str;
|
||||||
description = ''
|
description = lib.mdDoc ''
|
||||||
Must be set to a unique identifier, preferably a UUID according to
|
Must be set to a unique identifier, preferably a UUID according to
|
||||||
RFC 4122. UUIDs can be generated with `uuidgen` command, found in
|
RFC 4122. UUIDs can be generated with `uuidgen` command, found in
|
||||||
the `util-linux` package.
|
the `util-linux` package.
|
||||||
|
@ -379,7 +379,7 @@ in
|
||||||
uuid = mkOption {
|
uuid = mkOption {
|
||||||
example = "eacb6bab-f444-4ebf-a06a-3f72d7465e42";
|
example = "eacb6bab-f444-4ebf-a06a-3f72d7465e42";
|
||||||
type = types.str;
|
type = types.str;
|
||||||
description = ''
|
description = lib.mdDoc ''
|
||||||
Must be set to a unique identifier, preferably a UUID according to
|
Must be set to a unique identifier, preferably a UUID according to
|
||||||
RFC 4122. UUIDs can be generated with `uuidgen` command, found in
|
RFC 4122. UUIDs can be generated with `uuidgen` command, found in
|
||||||
the `util-linux` package.
|
the `util-linux` package.
|
||||||
|
|
|
@ -117,7 +117,7 @@ in
|
||||||
cacheNetworks = mkOption {
|
cacheNetworks = mkOption {
|
||||||
default = [ "127.0.0.0/24" ];
|
default = [ "127.0.0.0/24" ];
|
||||||
type = types.listOf types.str;
|
type = types.listOf types.str;
|
||||||
description = ''
|
description = lib.mdDoc ''
|
||||||
What networks are allowed to use us as a resolver. Note
|
What networks are allowed to use us as a resolver. Note
|
||||||
that this is for recursive queries -- all networks are
|
that this is for recursive queries -- all networks are
|
||||||
allowed to query zones configured with the `zones` option.
|
allowed to query zones configured with the `zones` option.
|
||||||
|
|
|
@ -13,7 +13,7 @@ in
|
||||||
apiTokenFile = mkOption {
|
apiTokenFile = mkOption {
|
||||||
type = types.nullOr types.str;
|
type = types.nullOr types.str;
|
||||||
default = null;
|
default = null;
|
||||||
description = ''
|
description = lib.mdDoc ''
|
||||||
The path to a file containing the CloudFlare API token.
|
The path to a file containing the CloudFlare API token.
|
||||||
|
|
||||||
The file must have the form `CLOUDFLARE_API_TOKEN=...`
|
The file must have the form `CLOUDFLARE_API_TOKEN=...`
|
||||||
|
|
|
@ -155,7 +155,7 @@ in
|
||||||
type = types.lines;
|
type = types.lines;
|
||||||
default = "";
|
default = "";
|
||||||
example = "if [[ $reason =~ BOUND ]]; then echo $interface: Routers are $new_routers - were $old_routers; fi";
|
example = "if [[ $reason =~ BOUND ]]; then echo $interface: Routers are $new_routers - were $old_routers; fi";
|
||||||
description = ''
|
description = lib.mdDoc ''
|
||||||
Shell code that will be run after all other hooks. See
|
Shell code that will be run after all other hooks. See
|
||||||
`man dhcpcd-run-hooks` for details on what is possible.
|
`man dhcpcd-run-hooks` for details on what is possible.
|
||||||
'';
|
'';
|
||||||
|
|
|
@ -20,7 +20,7 @@ in {
|
||||||
enable = mkOption {
|
enable = mkOption {
|
||||||
default = false;
|
default = false;
|
||||||
type = types.bool;
|
type = types.bool;
|
||||||
description = ''
|
description = lib.mdDoc ''
|
||||||
Whether to enable Ferm Firewall.
|
Whether to enable Ferm Firewall.
|
||||||
*Warning*: Enabling this service WILL disable the existing NixOS
|
*Warning*: Enabling this service WILL disable the existing NixOS
|
||||||
firewall! Default firewall rules provided by packages are not
|
firewall! Default firewall rules provided by packages are not
|
||||||
|
|
|
@ -10,7 +10,7 @@ in {
|
||||||
enable = mkOption {
|
enable = mkOption {
|
||||||
type = types.bool;
|
type = types.bool;
|
||||||
default = false;
|
default = false;
|
||||||
description = ''
|
description = lib.mdDoc ''
|
||||||
If enabled, FireQOS will be launched with the specified
|
If enabled, FireQOS will be launched with the specified
|
||||||
configuration given in `config`.
|
configuration given in `config`.
|
||||||
'';
|
'';
|
||||||
|
|
|
@ -123,7 +123,7 @@ in
|
||||||
extraOptions = mkOption {
|
extraOptions = mkOption {
|
||||||
type = types.lines;
|
type = types.lines;
|
||||||
default = "";
|
default = "";
|
||||||
description = ''
|
description = lib.mdDoc ''
|
||||||
Additional options that will be copied verbatim in `gnunet.conf'.
|
Additional options that will be copied verbatim in `gnunet.conf'.
|
||||||
See `gnunet.conf(5)' for details.
|
See `gnunet.conf(5)' for details.
|
||||||
'';
|
'';
|
||||||
|
|
|
@ -216,7 +216,7 @@ in
|
||||||
magicDns = mkOption {
|
magicDns = mkOption {
|
||||||
type = types.bool;
|
type = types.bool;
|
||||||
default = true;
|
default = true;
|
||||||
description = ''
|
description = lib.mdDoc ''
|
||||||
Whether to use [MagicDNS](https://tailscale.com/kb/1081/magicdns/).
|
Whether to use [MagicDNS](https://tailscale.com/kb/1081/magicdns/).
|
||||||
Only works if there is at least a nameserver defined.
|
Only works if there is at least a nameserver defined.
|
||||||
'';
|
'';
|
||||||
|
|
|
@ -77,7 +77,7 @@ in
|
||||||
};
|
};
|
||||||
|
|
||||||
extraConfigFile = mkOption {
|
extraConfigFile = mkOption {
|
||||||
description = ''
|
description = lib.mdDoc ''
|
||||||
Append an additional file's contents to `/etc/iscsid.conf`. Use a non-store path
|
Append an additional file's contents to `/etc/iscsid.conf`. Use a non-store path
|
||||||
and store passwords in this file. Note: the file specified here must be available
|
and store passwords in this file. Note: the file specified here must be available
|
||||||
in the initrd, see: `boot.initrd.secrets`.
|
in the initrd, see: `boot.initrd.secrets`.
|
||||||
|
|
|
@ -95,7 +95,7 @@ in with lib; {
|
||||||
network.exit-node = [ "example.loki" "example2.loki" ];
|
network.exit-node = [ "example.loki" "example2.loki" ];
|
||||||
}
|
}
|
||||||
'';
|
'';
|
||||||
description = ''
|
description = lib.mdDoc ''
|
||||||
Configuration for Lokinet.
|
Configuration for Lokinet.
|
||||||
Currently, the best way to view the available settings is by
|
Currently, the best way to view the available settings is by
|
||||||
generating a config file using `lokinet -g`.
|
generating a config file using `lokinet -g`.
|
||||||
|
|
|
@ -181,7 +181,7 @@ in
|
||||||
exclusiveNodes = mkOption {
|
exclusiveNodes = mkOption {
|
||||||
type = types.listOf types.str;
|
type = types.listOf types.str;
|
||||||
default = [ ];
|
default = [ ];
|
||||||
description = ''
|
description = lib.mdDoc ''
|
||||||
List of peer IP addresses to connect to *only*.
|
List of peer IP addresses to connect to *only*.
|
||||||
If given the other peer options will be ignored.
|
If given the other peer options will be ignored.
|
||||||
'';
|
'';
|
||||||
|
|
|
@ -219,7 +219,7 @@ in
|
||||||
registerHostname = mkOption {
|
registerHostname = mkOption {
|
||||||
type = types.str;
|
type = types.str;
|
||||||
default = "";
|
default = "";
|
||||||
description = ''
|
description = lib.mdDoc ''
|
||||||
DNS hostname where your server can be reached. This is only
|
DNS hostname where your server can be reached. This is only
|
||||||
needed if you want your server to be accessed by its
|
needed if you want your server to be accessed by its
|
||||||
hostname and not IP - but the name *must* resolve on the
|
hostname and not IP - but the name *must* resolve on the
|
||||||
|
|
|
@ -23,7 +23,7 @@ in
|
||||||
cacheURL = mkOption {
|
cacheURL = mkOption {
|
||||||
type = types.str;
|
type = types.str;
|
||||||
default = "https://cache.nixos.org/";
|
default = "https://cache.nixos.org/";
|
||||||
description = ''
|
description = lib.mdDoc ''
|
||||||
Binary cache URL to connect to.
|
Binary cache URL to connect to.
|
||||||
|
|
||||||
The URL format is compatible with the nix remote url style, such as:
|
The URL format is compatible with the nix remote url style, such as:
|
||||||
|
|
|
@ -40,7 +40,7 @@ in
|
||||||
dnsmasq = mkOption {
|
dnsmasq = mkOption {
|
||||||
type = types.bool;
|
type = types.bool;
|
||||||
default = true;
|
default = true;
|
||||||
description = ''
|
description = lib.mdDoc ''
|
||||||
Enable dnsmasq forwarding to nixops-dns. This allows to use
|
Enable dnsmasq forwarding to nixops-dns. This allows to use
|
||||||
nixops-dns for `services.nixops-dns.domain` resolution
|
nixops-dns for `services.nixops-dns.domain` resolution
|
||||||
while forwarding the rest of the queries to original resolvers.
|
while forwarding the rest of the queries to original resolvers.
|
||||||
|
|
|
@ -15,7 +15,7 @@ in
|
||||||
config = mkOption {
|
config = mkOption {
|
||||||
type = types.lines;
|
type = types.lines;
|
||||||
|
|
||||||
description = ''
|
description = lib.mdDoc ''
|
||||||
Configuration content to start an OCServ server.
|
Configuration content to start an OCServ server.
|
||||||
|
|
||||||
For a full configuration reference,please refer to the online documentation
|
For a full configuration reference,please refer to the online documentation
|
||||||
|
|
|
@ -30,7 +30,7 @@ in
|
||||||
type = types.str;
|
type = types.str;
|
||||||
default = "stderr";
|
default = "stderr";
|
||||||
description =
|
description =
|
||||||
''
|
lib.mdDoc ''
|
||||||
Where to send logs.
|
Where to send logs.
|
||||||
|
|
||||||
Possible values are:
|
Possible values are:
|
||||||
|
@ -122,7 +122,7 @@ in
|
||||||
"Forwarded_ipport" ];
|
"Forwarded_ipport" ];
|
||||||
default = "false";
|
default = "false";
|
||||||
description =
|
description =
|
||||||
''
|
lib.mdDoc ''
|
||||||
Way to disclose client IP to the proxy.
|
Way to disclose client IP to the proxy.
|
||||||
- "false": do not disclose
|
- "false": do not disclose
|
||||||
http-connect supports the following ways:
|
http-connect supports the following ways:
|
||||||
|
|
|
@ -13,7 +13,7 @@ with lib;
|
||||||
enable = mkOption {
|
enable = mkOption {
|
||||||
type = types.bool;
|
type = types.bool;
|
||||||
default = false;
|
default = false;
|
||||||
description = ''
|
description = lib.mdDoc ''
|
||||||
Whether to enable `rpcbind', an ONC RPC directory service
|
Whether to enable `rpcbind', an ONC RPC directory service
|
||||||
notably used by NFS and NIS, and which can be queried
|
notably used by NFS and NIS, and which can be queried
|
||||||
using the rpcinfo(1) command. `rpcbind` is a replacement for
|
using the rpcinfo(1) command. `rpcbind` is a replacement for
|
||||||
|
|
|
@ -50,7 +50,7 @@ in {
|
||||||
settings = mkOption {
|
settings = mkOption {
|
||||||
type = types.attrsOf types.attrs;
|
type = types.attrsOf types.attrs;
|
||||||
default = {};
|
default = {};
|
||||||
description = ''
|
description = lib.mdDoc ''
|
||||||
x2goserver.conf ini configuration as nix attributes. See
|
x2goserver.conf ini configuration as nix attributes. See
|
||||||
`x2goserver.conf(5)` for details
|
`x2goserver.conf(5)` for details
|
||||||
'';
|
'';
|
||||||
|
|
|
@ -118,7 +118,7 @@ in
|
||||||
type = types.listOf types.str;
|
type = types.listOf types.str;
|
||||||
default = [ "webadmin" "adminlog" ];
|
default = [ "webadmin" "adminlog" ];
|
||||||
example = [ "partyline" "webadmin" "adminlog" "log" ];
|
example = [ "partyline" "webadmin" "adminlog" "log" ];
|
||||||
description = ''
|
description = lib.mdDoc ''
|
||||||
A list of modules to include in the `znc.conf` file.
|
A list of modules to include in the `znc.conf` file.
|
||||||
'';
|
'';
|
||||||
};
|
};
|
||||||
|
@ -127,7 +127,7 @@ in
|
||||||
type = types.listOf types.str;
|
type = types.listOf types.str;
|
||||||
default = [ "chansaver" "controlpanel" ];
|
default = [ "chansaver" "controlpanel" ];
|
||||||
example = [ "chansaver" "controlpanel" "fish" "push" ];
|
example = [ "chansaver" "controlpanel" "fish" "push" ];
|
||||||
description = ''
|
description = lib.mdDoc ''
|
||||||
A list of user modules to include in the `znc.conf` file.
|
A list of user modules to include in the `znc.conf` file.
|
||||||
'';
|
'';
|
||||||
};
|
};
|
||||||
|
@ -216,7 +216,7 @@ in
|
||||||
extraZncConf = mkOption {
|
extraZncConf = mkOption {
|
||||||
default = "";
|
default = "";
|
||||||
type = types.lines;
|
type = types.lines;
|
||||||
description = ''
|
description = lib.mdDoc ''
|
||||||
Extra config to `znc.conf` file.
|
Extra config to `znc.conf` file.
|
||||||
'';
|
'';
|
||||||
};
|
};
|
||||||
|
|
|
@ -68,7 +68,7 @@ in
|
||||||
};
|
};
|
||||||
|
|
||||||
logLevel = mkOption {
|
logLevel = mkOption {
|
||||||
description = ''
|
description = lib.mdDoc ''
|
||||||
Defines how much detail should be present in MeiliSearch's logs.
|
Defines how much detail should be present in MeiliSearch's logs.
|
||||||
MeiliSearch currently supports four log levels, listed in order of increasing verbosity:
|
MeiliSearch currently supports four log levels, listed in order of increasing verbosity:
|
||||||
- 'ERROR': only log unexpected events indicating MeiliSearch is not functioning as expected
|
- 'ERROR': only log unexpected events indicating MeiliSearch is not functioning as expected
|
||||||
|
|
|
@ -73,7 +73,7 @@ in
|
||||||
default = [];
|
default = [];
|
||||||
type = types.listOf types.package;
|
type = types.listOf types.package;
|
||||||
example = lib.literalExpression "[ pkgs.ipset ]";
|
example = lib.literalExpression "[ pkgs.ipset ]";
|
||||||
description = ''
|
description = lib.mdDoc ''
|
||||||
Extra packages to be made available to the fail2ban service. The example contains
|
Extra packages to be made available to the fail2ban service. The example contains
|
||||||
the packages needed by the `iptables-ipset-proto6` action.
|
the packages needed by the `iptables-ipset-proto6` action.
|
||||||
'';
|
'';
|
||||||
|
|
|
@ -10,7 +10,7 @@ in {
|
||||||
enable = mkEnableOption "the Infinite Noise TRNG driver";
|
enable = mkEnableOption "the Infinite Noise TRNG driver";
|
||||||
|
|
||||||
fillDevRandom = mkOption {
|
fillDevRandom = mkOption {
|
||||||
description = ''
|
description = lib.mdDoc ''
|
||||||
Whether to run the infnoise driver as a daemon to refill /dev/random.
|
Whether to run the infnoise driver as a daemon to refill /dev/random.
|
||||||
|
|
||||||
If disabled, you can use the `infnoise` command-line tool to
|
If disabled, you can use the `infnoise` command-line tool to
|
||||||
|
|
|
@ -347,7 +347,7 @@ in
|
||||||
domain = mkOption {
|
domain = mkOption {
|
||||||
type = types.nullOr types.str;
|
type = types.nullOr types.str;
|
||||||
default = null;
|
default = null;
|
||||||
description = ''
|
description = lib.mdDoc ''
|
||||||
Optional cookie domains to force cookies to (ie: `.yourcompany.com`).
|
Optional cookie domains to force cookies to (ie: `.yourcompany.com`).
|
||||||
The longest domain matching the request's host will be used (or the shortest
|
The longest domain matching the request's host will be used (or the shortest
|
||||||
cookie domain if there is no match).
|
cookie domain if there is no match).
|
||||||
|
|
|
@ -39,7 +39,7 @@ in
|
||||||
btrfs.enable = mkOption {
|
btrfs.enable = mkOption {
|
||||||
type = types.bool;
|
type = types.bool;
|
||||||
default = false;
|
default = false;
|
||||||
description = ''
|
description = lib.mdDoc ''
|
||||||
Allow the cloud-init service to operate `btrfs` filesystem.
|
Allow the cloud-init service to operate `btrfs` filesystem.
|
||||||
'';
|
'';
|
||||||
};
|
};
|
||||||
|
@ -47,7 +47,7 @@ in
|
||||||
ext4.enable = mkOption {
|
ext4.enable = mkOption {
|
||||||
type = types.bool;
|
type = types.bool;
|
||||||
default = true;
|
default = true;
|
||||||
description = ''
|
description = lib.mdDoc ''
|
||||||
Allow the cloud-init service to operate `ext4` filesystem.
|
Allow the cloud-init service to operate `ext4` filesystem.
|
||||||
'';
|
'';
|
||||||
};
|
};
|
||||||
|
|
|
@ -41,7 +41,7 @@ in
|
||||||
|
|
||||||
default = null;
|
default = null;
|
||||||
|
|
||||||
description = ''
|
description = lib.mdDoc ''
|
||||||
Attribute of `nixFile` that builds the current system.
|
Attribute of `nixFile` that builds the current system.
|
||||||
'';
|
'';
|
||||||
};
|
};
|
||||||
|
@ -51,7 +51,7 @@ in
|
||||||
|
|
||||||
default = { };
|
default = { };
|
||||||
|
|
||||||
description = ''
|
description = lib.mdDoc ''
|
||||||
Arguments to `nix-build` passed as `--argstr` or `--arg` depending on
|
Arguments to `nix-build` passed as `--argstr` or `--arg` depending on
|
||||||
the type.
|
the type.
|
||||||
'';
|
'';
|
||||||
|
@ -62,7 +62,7 @@ in
|
||||||
|
|
||||||
default = "switch";
|
default = "switch";
|
||||||
|
|
||||||
description = ''
|
description = lib.mdDoc ''
|
||||||
The `switch-to-configuration` subcommand used.
|
The `switch-to-configuration` subcommand used.
|
||||||
'';
|
'';
|
||||||
};
|
};
|
||||||
|
@ -70,7 +70,7 @@ in
|
||||||
repository = lib.mkOption {
|
repository = lib.mkOption {
|
||||||
type = with lib.types; oneOf [ path str ];
|
type = with lib.types; oneOf [ path str ];
|
||||||
|
|
||||||
description = ''
|
description = lib.mdDoc ''
|
||||||
The repository to fetch from. Must be properly formatted for git.
|
The repository to fetch from. Must be properly formatted for git.
|
||||||
|
|
||||||
If this value is set to a path (must begin with `/`) then it's
|
If this value is set to a path (must begin with `/`) then it's
|
||||||
|
@ -99,7 +99,7 @@ in
|
||||||
|
|
||||||
default = "master";
|
default = "master";
|
||||||
|
|
||||||
description = ''
|
description = lib.mdDoc ''
|
||||||
Branch to track
|
Branch to track
|
||||||
|
|
||||||
Technically speaking any ref can be specified here, as this is
|
Technically speaking any ref can be specified here, as this is
|
||||||
|
@ -113,7 +113,7 @@ in
|
||||||
|
|
||||||
default = "hourly";
|
default = "hourly";
|
||||||
|
|
||||||
description = ''
|
description = lib.mdDoc ''
|
||||||
The schedule on which to run the `self-deploy` service. Format
|
The schedule on which to run the `self-deploy` service. Format
|
||||||
specified by `systemd.time 7`.
|
specified by `systemd.time 7`.
|
||||||
|
|
||||||
|
|
|
@ -937,7 +937,7 @@ in
|
||||||
id = mkOption {
|
id = mkOption {
|
||||||
type = types.str;
|
type = types.str;
|
||||||
default = "";
|
default = "";
|
||||||
description = ''
|
description = lib.mdDoc ''
|
||||||
Attribute map for `id'.
|
Attribute map for `id'.
|
||||||
Defaults to `NameID' of SAML response.
|
Defaults to `NameID' of SAML response.
|
||||||
'';
|
'';
|
||||||
|
@ -945,7 +945,7 @@ in
|
||||||
username = mkOption {
|
username = mkOption {
|
||||||
type = types.str;
|
type = types.str;
|
||||||
default = "";
|
default = "";
|
||||||
description = ''
|
description = lib.mdDoc ''
|
||||||
Attribute map for `username'.
|
Attribute map for `username'.
|
||||||
Defaults to `NameID' of SAML response.
|
Defaults to `NameID' of SAML response.
|
||||||
'';
|
'';
|
||||||
|
|
|
@ -93,7 +93,7 @@ in
|
||||||
'''
|
'''
|
||||||
'';
|
'';
|
||||||
|
|
||||||
description = ''
|
description = lib.mdDoc ''
|
||||||
Options for the JVM written to `nexus.jvmopts`.
|
Options for the JVM written to `nexus.jvmopts`.
|
||||||
Please refer to the docs (https://help.sonatype.com/repomanager3/installation/configuring-the-runtime-environment)
|
Please refer to the docs (https://help.sonatype.com/repomanager3/installation/configuring-the-runtime-environment)
|
||||||
for further information.
|
for further information.
|
||||||
|
|
|
@ -43,7 +43,7 @@ in
|
||||||
priority = mkOption {
|
priority = mkOption {
|
||||||
type = types.int;
|
type = types.int;
|
||||||
default = 1000;
|
default = 1000;
|
||||||
description = ''
|
description = lib.mdDoc ''
|
||||||
Order of this location block in relation to the others in the vhost.
|
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
|
The semantics are the same as with `lib.mkOrder`. Smaller values have
|
||||||
a greater priority.
|
a greater priority.
|
||||||
|
|
|
@ -29,7 +29,7 @@ in {
|
||||||
address = mkOption {
|
address = mkOption {
|
||||||
default = "127.0.0.1";
|
default = "127.0.0.1";
|
||||||
type = str;
|
type = str;
|
||||||
description = ''
|
description = lib.mdDoc ''
|
||||||
Address to listen on.
|
Address to listen on.
|
||||||
Pass `all` to listen on all interfaces.
|
Pass `all` to listen on all interfaces.
|
||||||
'';
|
'';
|
||||||
|
|
|
@ -122,7 +122,7 @@ with lib;
|
||||||
priority = mkOption {
|
priority = mkOption {
|
||||||
type = types.int;
|
type = types.int;
|
||||||
default = 1000;
|
default = 1000;
|
||||||
description = ''
|
description = lib.mdDoc ''
|
||||||
Order of this location block in relation to the others in the vhost.
|
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
|
The semantics are the same as with `lib.mkOrder`. Smaller values have
|
||||||
a greater priority.
|
a greater priority.
|
||||||
|
|
|
@ -34,7 +34,7 @@ in
|
||||||
purifyOnStart = mkOption {
|
purifyOnStart = mkOption {
|
||||||
type = types.bool;
|
type = types.bool;
|
||||||
default = false;
|
default = false;
|
||||||
description = ''
|
description = lib.mdDoc ''
|
||||||
On startup, the `baseDir` directory is populated with various files,
|
On startup, the `baseDir` directory is populated with various files,
|
||||||
subdirectories and symlinks. If this option is enabled, these items
|
subdirectories and symlinks. If this option is enabled, these items
|
||||||
(except for the `logs` and `work` subdirectories) are first removed.
|
(except for the `logs` and `work` subdirectories) are first removed.
|
||||||
|
@ -46,7 +46,7 @@ in
|
||||||
baseDir = mkOption {
|
baseDir = mkOption {
|
||||||
type = lib.types.path;
|
type = lib.types.path;
|
||||||
default = "/var/tomcat";
|
default = "/var/tomcat";
|
||||||
description = ''
|
description = lib.mdDoc ''
|
||||||
Location where Tomcat stores configuration files, web applications
|
Location where Tomcat stores configuration files, web applications
|
||||||
and logfiles. Note that it is partially cleared on each service startup
|
and logfiles. Note that it is partially cleared on each service startup
|
||||||
if `purifyOnStart` is enabled.
|
if `purifyOnStart` is enabled.
|
||||||
|
|
|
@ -24,7 +24,7 @@ let
|
||||||
phocConfigType = types.submodule {
|
phocConfigType = types.submodule {
|
||||||
options = {
|
options = {
|
||||||
xwayland = mkOption {
|
xwayland = mkOption {
|
||||||
description = ''
|
description = lib.mdDoc ''
|
||||||
Whether to enable XWayland support.
|
Whether to enable XWayland support.
|
||||||
|
|
||||||
To start XWayland immediately, use `immediate`.
|
To start XWayland immediately, use `immediate`.
|
||||||
|
|
|
@ -91,7 +91,7 @@ in
|
||||||
USB? y
|
USB? y
|
||||||
DEBUG n
|
DEBUG n
|
||||||
'';
|
'';
|
||||||
description = ''
|
description = lib.mdDoc ''
|
||||||
The result of converting the structured kernel configuration in settings
|
The result of converting the structured kernel configuration in settings
|
||||||
to an intermediate string that can be parsed by generate-config.pl to
|
to an intermediate string that can be parsed by generate-config.pl to
|
||||||
answer the kernel `make defconfig`.
|
answer the kernel `make defconfig`.
|
||||||
|
|
|
@ -426,7 +426,7 @@ in
|
||||||
type = types.either (types.enum [ "disabled" "all" ]) (types.listOf types.str);
|
type = types.either (types.enum [ "disabled" "all" ]) (types.listOf types.str);
|
||||||
default = "disabled";
|
default = "disabled";
|
||||||
example = [ "tank" "dozer" ];
|
example = [ "tank" "dozer" ];
|
||||||
description = ''
|
description = lib.mdDoc ''
|
||||||
After importing, expand each device in the specified pools.
|
After importing, expand each device in the specified pools.
|
||||||
|
|
||||||
Set the value to the plain string "all" to expand all pools on boot:
|
Set the value to the plain string "all" to expand all pools on boot:
|
||||||
|
|
|
@ -785,7 +785,7 @@ in
|
||||||
default = null;
|
default = null;
|
||||||
example = "fast";
|
example = "fast";
|
||||||
type = types.nullOr types.str;
|
type = types.nullOr types.str;
|
||||||
description = ''
|
description = lib.mdDoc ''
|
||||||
DEPRECATED, use `driverOptions`.
|
DEPRECATED, use `driverOptions`.
|
||||||
Option specifying the rate in which we'll ask our link partner
|
Option specifying the rate in which we'll ask our link partner
|
||||||
to transmit LACPDU packets in 802.3ad mode.
|
to transmit LACPDU packets in 802.3ad mode.
|
||||||
|
@ -796,7 +796,7 @@ in
|
||||||
default = null;
|
default = null;
|
||||||
example = 100;
|
example = 100;
|
||||||
type = types.nullOr types.int;
|
type = types.nullOr types.int;
|
||||||
description = ''
|
description = lib.mdDoc ''
|
||||||
DEPRECATED, use `driverOptions`.
|
DEPRECATED, use `driverOptions`.
|
||||||
Miimon is the number of millisecond in between each round of polling
|
Miimon is the number of millisecond in between each round of polling
|
||||||
by the device driver for failed links. By default polling is not
|
by the device driver for failed links. By default polling is not
|
||||||
|
@ -809,7 +809,7 @@ in
|
||||||
default = null;
|
default = null;
|
||||||
example = "active-backup";
|
example = "active-backup";
|
||||||
type = types.nullOr types.str;
|
type = types.nullOr types.str;
|
||||||
description = ''
|
description = lib.mdDoc ''
|
||||||
DEPRECATED, use `driverOptions`.
|
DEPRECATED, use `driverOptions`.
|
||||||
The mode which the bond will be running. The default mode for
|
The mode which the bond will be running. The default mode for
|
||||||
the bonding driver is balance-rr, optimizing for throughput.
|
the bonding driver is balance-rr, optimizing for throughput.
|
||||||
|
@ -822,7 +822,7 @@ in
|
||||||
default = null;
|
default = null;
|
||||||
example = "layer2+3";
|
example = "layer2+3";
|
||||||
type = types.nullOr types.str;
|
type = types.nullOr types.str;
|
||||||
description = ''
|
description = lib.mdDoc ''
|
||||||
DEPRECATED, use `driverOptions`.
|
DEPRECATED, use `driverOptions`.
|
||||||
Selects the transmit hash policy to use for slave selection in
|
Selects the transmit hash policy to use for slave selection in
|
||||||
balance-xor, 802.3ad, and tlb modes.
|
balance-xor, 802.3ad, and tlb modes.
|
||||||
|
|
|
@ -14,7 +14,7 @@ in {
|
||||||
};
|
};
|
||||||
|
|
||||||
datasets = lib.mkOption {
|
datasets = lib.mkOption {
|
||||||
description = ''
|
description = lib.mdDoc ''
|
||||||
Datasets to create under the `tank` and `boot` zpools.
|
Datasets to create under the `tank` and `boot` zpools.
|
||||||
|
|
||||||
**NOTE:** This option is used only at image creation time, and
|
**NOTE:** This option is used only at image creation time, and
|
||||||
|
|
|
@ -29,7 +29,7 @@ in
|
||||||
virtualisation.googleComputeImage.configFile = mkOption {
|
virtualisation.googleComputeImage.configFile = mkOption {
|
||||||
type = with types; nullOr str;
|
type = with types; nullOr str;
|
||||||
default = null;
|
default = null;
|
||||||
description = ''
|
description = lib.mdDoc ''
|
||||||
A path to a configuration file which will be placed at `/etc/nixos/configuration.nix`
|
A path to a configuration file which will be placed at `/etc/nixos/configuration.nix`
|
||||||
and be used when switching to a new configuration.
|
and be used when switching to a new configuration.
|
||||||
If set to `null`, a default configuration is used, where the only import is
|
If set to `null`, a default configuration is used, where the only import is
|
||||||
|
|
|
@ -81,7 +81,7 @@ let
|
||||||
type = types.package;
|
type = types.package;
|
||||||
default = pkgs.qemu;
|
default = pkgs.qemu;
|
||||||
defaultText = literalExpression "pkgs.qemu";
|
defaultText = literalExpression "pkgs.qemu";
|
||||||
description = ''
|
description = lib.mdDoc ''
|
||||||
Qemu package to use with libvirt.
|
Qemu package to use with libvirt.
|
||||||
`pkgs.qemu` can emulate alien architectures (e.g. aarch64 on x86)
|
`pkgs.qemu` can emulate alien architectures (e.g. aarch64 on x86)
|
||||||
`pkgs.qemu_kvm` saves disk space allowing to emulate only host architectures.
|
`pkgs.qemu_kvm` saves disk space allowing to emulate only host architectures.
|
||||||
|
|
|
@ -15,7 +15,7 @@ in
|
||||||
};
|
};
|
||||||
|
|
||||||
datasets = lib.mkOption {
|
datasets = lib.mkOption {
|
||||||
description = ''
|
description = lib.mdDoc ''
|
||||||
Datasets to create under the `tank` and `boot` zpools.
|
Datasets to create under the `tank` and `boot` zpools.
|
||||||
|
|
||||||
**NOTE:** This option is used only at image creation time, and
|
**NOTE:** This option is used only at image creation time, and
|
||||||
|
|
|
@ -23,7 +23,7 @@ in
|
||||||
autoMountShares = mkOption {
|
autoMountShares = mkOption {
|
||||||
type = types.bool;
|
type = types.bool;
|
||||||
default = true;
|
default = true;
|
||||||
description = ''
|
description = lib.mdDoc ''
|
||||||
Control prlfsmountd service. When this service is running, shares can not be manually
|
Control prlfsmountd service. When this service is running, shares can not be manually
|
||||||
mounted through `mount -t prl_fs ...` as this service will remount and trample any set options.
|
mounted through `mount -t prl_fs ...` as this service will remount and trample any set options.
|
||||||
Recommended to enable for simple file sharing, but extended share use such as for code should
|
Recommended to enable for simple file sharing, but extended share use such as for code should
|
||||||
|
|
Loading…
Add table
Add a link
Reference in a new issue