nixos/*: mark pre-existing markdown descriptions as mdDoc

··· 20 20 type = types.str; 21 21 default = "0xfffd7fff"; 22 22 example = "0xffffffff"; 23 23 - description = '' 23 23 + description = lib.mdDoc '' 24 24 Sets the `amdgpu.ppfeaturemask` kernel option. 25 25 In particular, it is used here to set the overdrive bit. 26 26 Default is `0xfffd7fff` as it is less likely to cause flicker issues.

+1 -1

nixos/modules/misc/wordlist.nix

reviewed

··· 23 23 } 24 24 ''; 25 25 26 26 - description = '' 26 26 + description = lib.mdDoc '' 27 27 A set with the key names being the environment variable you'd like to 28 28 set and the values being a list of paths to text documents containing 29 29 lists of words. The various files will be merged, sorted, duplicates

+1 -1

nixos/modules/programs/mosh.nix

reviewed

··· 17 17 type = lib.types.bool; 18 18 }; 19 19 withUtempter = mkOption { 20 20 - description = '' 20 20 + description = lib.mdDoc '' 21 21 Whether to enable libutempter for mosh. 22 22 This is required so that mosh can write to /var/run/utmp (which can be queried with `who` to display currently connected user sessions). 23 23 Note, this will add a guid wrapper for the group utmp!

+1 -1

nixos/modules/programs/msmtp.nix

reviewed

··· 45 45 passwordeval = "cat /secrets/password.txt"; 46 46 }; 47 47 }; 48 48 - description = '' 48 48 + description = lib.mdDoc '' 49 49 Named accounts and their respective configurations. 50 50 The special name "default" allows a default account to be defined. 51 51 See msmtp(1) for the available options.

+1 -1

nixos/modules/programs/thefuck.nix

reviewed

··· 22 22 default = "fuck"; 23 23 type = types.str; 24 24 25 25 - description = '' 25 25 + description = lib.mdDoc '' 26 26 `thefuck` needs an alias to be configured. 27 27 The default value is `fuck`, but you can use anything else as well. 28 28 '';

+1 -1

nixos/modules/programs/yabar.nix

reviewed

··· 62 62 to use `yabar-unstable'. 63 63 ''; 64 64 65 65 - description = '' 65 65 + description = lib.mdDoc '' 66 66 The package which contains the `yabar` binary. 67 67 68 68 Nixpkgs provides the `yabar` and `yabar-unstable`

+4 -4

nixos/modules/programs/zsh/oh-my-zsh.nix

reviewed

··· 49 49 package = mkOption { 50 50 default = pkgs.oh-my-zsh; 51 51 defaultText = literalExpression "pkgs.oh-my-zsh"; 52 52 - description = '' 52 52 + description = lib.mdDoc '' 53 53 Package to install for `oh-my-zsh` usage. 54 54 ''; 55 55 ··· 67 67 custom = mkOption { 68 68 default = null; 69 69 type = with types; nullOr str; 70 70 - description = '' 70 70 + description = lib.mdDoc '' 71 71 Path to a custom oh-my-zsh package to override config of oh-my-zsh. 72 72 (Can't be used along with `customPkgs`). 73 73 ''; ··· 76 76 customPkgs = mkOption { 77 77 default = []; 78 78 type = types.listOf types.package; 79 79 - description = '' 79 79 + description = lib.mdDoc '' 80 80 List of custom packages that should be loaded into `oh-my-zsh`. 81 81 ''; 82 82 }; ··· 92 92 cacheDir = mkOption { 93 93 default = "$HOME/.cache/oh-my-zsh"; 94 94 type = types.str; 95 95 - description = '' 95 95 + description = lib.mdDoc '' 96 96 Cache directory to be used by `oh-my-zsh`. 97 97 Without this option it would default to the read-only nix store. 98 98 '';

+1 -1

nixos/modules/programs/zsh/zsh-autoenv.nix

reviewed

··· 11 11 package = mkOption { 12 12 default = pkgs.zsh-autoenv; 13 13 defaultText = literalExpression "pkgs.zsh-autoenv"; 14 14 - description = '' 14 14 + description = lib.mdDoc '' 15 15 Package to install for `zsh-autoenv` usage. 16 16 ''; 17 17

+1 -1

nixos/modules/programs/zsh/zsh-autosuggestions.nix

reviewed

··· 24 24 strategy = mkOption { 25 25 type = types.listOf (types.enum [ "history" "completion" "match_prev_cmd" ]); 26 26 default = [ "history" ]; 27 27 - description = '' 27 27 + description = lib.mdDoc '' 28 28 `ZSH_AUTOSUGGEST_STRATEGY` is an array that specifies how suggestions should be generated. 29 29 The strategies in the array are tried successively until a suggestion is found. 30 30 There are currently three built-in strategies to choose from:

+1 -1

nixos/modules/security/acme/default.nix

reviewed

··· 676 676 inheritDefaults = mkOption { 677 677 default = true; 678 678 example = true; 679 679 - description = "Whether to inherit values set in `security.acme.defaults` or not."; 679 679 + description = lib.mdDoc "Whether to inherit values set in `security.acme.defaults` or not."; 680 680 type = lib.types.bool; 681 681 }; 682 682 };

+1 -1

nixos/modules/security/sudo.nix

reviewed

··· 46 46 type = types.package; 47 47 default = pkgs.sudo; 48 48 defaultText = literalExpression "pkgs.sudo"; 49 49 - description = '' 49 49 + description = lib.mdDoc '' 50 50 Which package to use for `sudo`. 51 51 ''; 52 52 };

+1 -1

nixos/modules/services/continuous-integration/buildkite-agents.nix

reviewed

··· 193 193 options.services.buildkite-agents = mkOption { 194 194 type = types.attrsOf (types.submodule buildkiteOptions); 195 195 default = {}; 196 196 - description = '' 196 196 + description = lib.mdDoc '' 197 197 Attribute set of buildkite agents. 198 198 The attribute key is combined with the hostname and a unique integer to 199 199 create the final agent name. This can be overridden by setting the `name`

+1 -1

nixos/modules/services/continuous-integration/hydra/default.nix

reviewed

··· 87 87 type = types.str; 88 88 default = localDB; 89 89 example = "dbi:Pg:dbname=hydra;host=postgres.example.org;user=foo;"; 90 90 - description = '' 90 90 + description = lib.mdDoc '' 91 91 The DBI string for Hydra database connection. 92 92 93 93 NOTE: Attempts to set `application_name` will be overridden by

+1 -1

nixos/modules/services/development/lorri.nix

reviewed

··· 9 9 enable = lib.mkOption { 10 10 default = false; 11 11 type = lib.types.bool; 12 12 - description = '' 12 12 + description = lib.mdDoc '' 13 13 Enables the daemon for `lorri`, a nix-shell replacement for project 14 14 development. The socket-activated daemon starts on the first request 15 15 issued by the `lorri` command.

+1 -1

nixos/modules/services/editors/infinoted.nix

reviewed

··· 36 36 certificateChain = mkOption { 37 37 type = types.nullOr types.path; 38 38 default = null; 39 39 - description = '' 39 39 + description = lib.mdDoc '' 40 40 Chain of CA-certificates to which our `certificateFile` is relative. 41 41 Optional for TLS. 42 42 '';

+2 -2

nixos/modules/services/games/crossfire-server.nix

reviewed

··· 41 41 stateDir = mkOption { 42 42 type = types.str; 43 43 default = "/var/lib/crossfire"; 44 44 - description = '' 44 44 + description = lib.mdDoc '' 45 45 Where to store runtime data (save files, persistent items, etc). 46 46 47 47 If left at the default, this will be automatically created on server ··· 61 61 62 62 configFiles = mkOption { 63 63 type = types.attrsOf types.str; 64 64 - description = '' 64 64 + description = lib.mdDoc '' 65 65 Text to append to the corresponding configuration files. Note that the 66 66 files given in the example are *not* the complete set of files available 67 67 to customize; look in /etc/crossfire after enabling the server to see

+1 -1

nixos/modules/services/games/deliantra-server.nix

reviewed

··· 41 41 stateDir = mkOption { 42 42 type = types.str; 43 43 default = "/var/lib/deliantra"; 44 44 - description = '' 44 44 + description = lib.mdDoc '' 45 45 Where to store runtime data (save files, persistent items, etc). 46 46 47 47 If left at the default, this will be automatically created on server

+3 -3

nixos/modules/services/games/minetest-server.nix

reviewed

··· 25 25 gameId = mkOption { 26 26 type = types.nullOr types.str; 27 27 default = null; 28 28 - description = '' 28 28 + description = lib.mdDoc '' 29 29 Id of the game to use. To list available games run 30 30 `minetestserver --gameid list`. 31 31 ··· 36 36 world = mkOption { 37 37 type = types.nullOr types.path; 38 38 default = null; 39 39 - description = '' 39 39 + description = lib.mdDoc '' 40 40 Name of the world to use. To list available worlds run 41 41 `minetestserver --world list`. 42 42 ··· 47 47 configPath = mkOption { 48 48 type = types.nullOr types.path; 49 49 default = null; 50 50 - description = '' 50 50 + description = lib.mdDoc '' 51 51 Path to the config to use. 52 52 53 53 If set to null, the config of the running user will be used:

+2 -2

nixos/modules/services/logging/logrotate.nix

reviewed

··· 79 79 priority = mkOption { 80 80 type = types.int; 81 81 default = 1000; 82 82 - description = '' 82 82 + description = lib.mdDoc '' 83 83 Order of this logrotate block in relation to the others. The semantics are 84 84 the same as with `lib.mkOrder`. Smaller values have a greater priority. 85 85 ''; ··· 260 260 priority = mkOption { 261 261 type = types.int; 262 262 default = 1000; 263 263 - description = '' 263 263 + description = lib.mdDoc '' 264 264 Order of this logrotate block in relation to the others. The semantics are 265 265 the same as with `lib.mkOrder`. Smaller values are inserted first. 266 266 '';

+1 -1

nixos/modules/services/matrix/synapse.nix

reviewed

··· 516 516 type = types.bool; 517 517 default = true; 518 518 example = false; 519 519 - description = '' 519 519 + description = lib.mdDoc '' 520 520 Is the preview URL API enabled? If enabled, you *must* specify an 521 521 explicit url_preview_ip_range_blacklist of IPs that the spider is 522 522 denied from accessing.

+1 -1

nixos/modules/services/misc/gitea.nix

reviewed

··· 183 183 file = mkOption { 184 184 type = types.nullOr types.str; 185 185 default = null; 186 186 - description = "Filename to be used for the dump. If `null` a default name is choosen by gitea."; 186 186 + description = lib.mdDoc "Filename to be used for the dump. If `null` a default name is choosen by gitea."; 187 187 example = "gitea-dump"; 188 188 }; 189 189 };

+1 -1

nixos/modules/services/misc/klipper.nix

reviewed

··· 82 82 ''; 83 83 configFile = mkOption { 84 84 type = path; 85 85 - description = "Path to firmware config which is generated using `klipper-genconf`"; 85 85 + description = lib.mdDoc "Path to firmware config which is generated using `klipper-genconf`"; 86 86 }; 87 87 }; 88 88 });

+1 -1

nixos/modules/services/misc/nix-daemon.nix

reviewed

··· 264 264 type = types.nullOr types.str; 265 265 default = null; 266 266 example = "/root/.ssh/id_buildhost_builduser"; 267 267 - description = '' 267 267 + description = lib.mdDoc '' 268 268 The path to the SSH private key with which to authenticate on 269 269 the build machine. The private key must not have a passphrase. 270 270 If null, the building user (root on NixOS machines) must have an

+1 -1

nixos/modules/services/misc/rmfakecloud.nix

reviewed

··· 50 50 type = with types; attrsOf str; 51 51 default = { }; 52 52 example = { DATADIR = "/custom/path/for/rmfakecloud/data"; }; 53 53 - description = '' 53 53 + description = lib.mdDoc '' 54 54 Extra settings in the form of a set of key-value pairs. 55 55 For tokens and secrets, use `environmentFile` instead. 56 56

+1 -1

nixos/modules/services/misc/zoneminder.nix

reviewed

··· 80 80 webserver = mkOption { 81 81 type = types.enum [ "nginx" "none" ]; 82 82 default = "nginx"; 83 83 - description = '' 83 83 + description = lib.mdDoc '' 84 84 The webserver to configure for the PHP frontend. 85 85 86 86 Set it to `none` if you want to configure it yourself. PRs are welcome

+1 -1

nixos/modules/services/monitoring/collectd.nix

reviewed

··· 52 52 53 53 buildMinimalPackage = mkOption { 54 54 default = false; 55 55 - description = '' 55 55 + description = lib.mdDoc '' 56 56 Build a minimal collectd package with only the configured `services.collectd.plugins` 57 57 ''; 58 58 type = bool;

+2 -2

nixos/modules/services/monitoring/datadog-agent.nix

reviewed

··· 60 60 package = mkOption { 61 61 default = pkgs.datadog-agent; 62 62 defaultText = literalExpression "pkgs.datadog-agent"; 63 63 - description = '' 63 63 + description = lib.mdDoc '' 64 64 Which DataDog v7 agent package to use. Note that the provided 65 65 package is expected to have an overridable `pythonPackages`-attribute 66 66 which configures the Python environment with the Datadog ··· 168 168 }; 169 169 170 170 checks = mkOption { 171 171 - description = '' 171 171 + description = lib.mdDoc '' 172 172 Configuration for all Datadog checks. Keys of this attribute 173 173 set will be used as the name of the check to create the 174 174 appropriate configuration in `conf.d/$check.d/conf.yaml`.

+3 -3

nixos/modules/services/monitoring/prometheus/default.nix

reviewed

··· 251 251 authorization = mkOption { 252 252 type = types.nullOr types.attrs; 253 253 default = null; 254 254 - description = '' 254 254 + description = lib.mdDoc '' 255 255 Sets the `Authorization` header on every scrape request with the configured credentials. 256 256 ''; 257 257 }; ··· 664 664 promTypes.dockerswarm_sd_config = mkDockerSdConfigModule { 665 665 role = mkOption { 666 666 type = types.enum [ "services" "tasks" "nodes" ]; 667 667 - description = '' 667 667 + description = lib.mdDoc '' 668 668 Role of the targets to retrieve. Must be `services`, `tasks`, or `nodes`. 669 669 ''; 670 670 }; ··· 1222 1222 1223 1223 role = mkOption { 1224 1224 type = types.enum [ "instance" "baremetal" ]; 1225 1225 - description = '' 1225 1225 + description = lib.mdDoc '' 1226 1226 Role of the targets to retrieve. Must be `instance` or `baremetal`. 1227 1227 ''; 1228 1228 };

+1 -1

nixos/modules/services/monitoring/prometheus/exporters/nginxlog.nix

reviewed

··· 10 10 settings = mkOption { 11 11 type = types.attrs; 12 12 default = {}; 13 13 - description = '' 13 13 + description = lib.mdDoc '' 14 14 All settings of nginxlog expressed as an Nix attrset. 15 15 16 16 Check the official documentation for the corresponding YAML

+1 -1

nixos/modules/services/monitoring/riemann-tools.nix

reviewed

··· 37 37 extraArgs = mkOption { 38 38 type = types.listOf types.str; 39 39 default = []; 40 40 - description = '' 40 40 + description = lib.mdDoc '' 41 41 A list of commandline-switches forwarded to a riemann-tool. 42 42 See for example `riemann-health --help` for available options. 43 43 '';

+3 -3

nixos/modules/services/network-filesystems/xtreemfs.nix

reviewed

··· 111 111 uuid = mkOption { 112 112 example = "eacb6bab-f444-4ebf-a06a-3f72d7465e40"; 113 113 type = types.str; 114 114 - description = '' 114 114 + description = lib.mdDoc '' 115 115 Must be set to a unique identifier, preferably a UUID according to 116 116 RFC 4122. UUIDs can be generated with `uuidgen` command, found in 117 117 the `util-linux` package. ··· 236 236 uuid = mkOption { 237 237 example = "eacb6bab-f444-4ebf-a06a-3f72d7465e41"; 238 238 type = types.str; 239 239 - description = '' 239 239 + description = lib.mdDoc '' 240 240 Must be set to a unique identifier, preferably a UUID according to 241 241 RFC 4122. UUIDs can be generated with `uuidgen` command, found in 242 242 the `util-linux` package. ··· 379 379 uuid = mkOption { 380 380 example = "eacb6bab-f444-4ebf-a06a-3f72d7465e42"; 381 381 type = types.str; 382 382 - description = '' 382 382 + description = lib.mdDoc '' 383 383 Must be set to a unique identifier, preferably a UUID according to 384 384 RFC 4122. UUIDs can be generated with `uuidgen` command, found in 385 385 the `util-linux` package.

+1 -1

nixos/modules/services/networking/bind.nix

reviewed

··· 117 117 cacheNetworks = mkOption { 118 118 default = [ "127.0.0.0/24" ]; 119 119 type = types.listOf types.str; 120 120 - description = '' 120 120 + description = lib.mdDoc '' 121 121 What networks are allowed to use us as a resolver. Note 122 122 that this is for recursive queries -- all networks are 123 123 allowed to query zones configured with the `zones` option.

+1 -1

nixos/modules/services/networking/cloudflare-dyndns.nix

reviewed

··· 13 13 apiTokenFile = mkOption { 14 14 type = types.nullOr types.str; 15 15 default = null; 16 16 - description = '' 16 16 + description = lib.mdDoc '' 17 17 The path to a file containing the CloudFlare API token. 18 18 19 19 The file must have the form `CLOUDFLARE_API_TOKEN=...`

+1 -1

nixos/modules/services/networking/dhcpcd.nix

reviewed

··· 155 155 type = types.lines; 156 156 default = ""; 157 157 example = "if [[ $reason =~ BOUND ]]; then echo $interface: Routers are $new_routers - were $old_routers; fi"; 158 158 - description = '' 158 158 + description = lib.mdDoc '' 159 159 Shell code that will be run after all other hooks. See 160 160 `man dhcpcd-run-hooks` for details on what is possible. 161 161 '';

+1 -1

nixos/modules/services/networking/ferm.nix

reviewed

··· 20 20 enable = mkOption { 21 21 default = false; 22 22 type = types.bool; 23 23 - description = '' 23 23 + description = lib.mdDoc '' 24 24 Whether to enable Ferm Firewall. 25 25 *Warning*: Enabling this service WILL disable the existing NixOS 26 26 firewall! Default firewall rules provided by packages are not

+1 -1

nixos/modules/services/networking/fireqos.nix

reviewed

··· 10 10 enable = mkOption { 11 11 type = types.bool; 12 12 default = false; 13 13 - description = '' 13 13 + description = lib.mdDoc '' 14 14 If enabled, FireQOS will be launched with the specified 15 15 configuration given in `config`. 16 16 '';

+1 -1

nixos/modules/services/networking/gnunet.nix

reviewed

··· 123 123 extraOptions = mkOption { 124 124 type = types.lines; 125 125 default = ""; 126 126 - description = '' 126 126 + description = lib.mdDoc '' 127 127 Additional options that will be copied verbatim in `gnunet.conf'. 128 128 See `gnunet.conf(5)' for details. 129 129 '';

+1 -1

nixos/modules/services/networking/headscale.nix

reviewed

··· 216 216 magicDns = mkOption { 217 217 type = types.bool; 218 218 default = true; 219 219 - description = '' 219 219 + description = lib.mdDoc '' 220 220 Whether to use [MagicDNS](https://tailscale.com/kb/1081/magicdns/). 221 221 Only works if there is at least a nameserver defined. 222 222 '';

+1 -1

nixos/modules/services/networking/iscsi/root-initiator.nix

reviewed

··· 77 77 }; 78 78 79 79 extraConfigFile = mkOption { 80 80 - description = '' 80 80 + description = lib.mdDoc '' 81 81 Append an additional file's contents to `/etc/iscsid.conf`. Use a non-store path 82 82 and store passwords in this file. Note: the file specified here must be available 83 83 in the initrd, see: `boot.initrd.secrets`.

+1 -1

nixos/modules/services/networking/lokinet.nix

reviewed

··· 95 95 network.exit-node = [ "example.loki" "example2.loki" ]; 96 96 } 97 97 ''; 98 98 - description = '' 98 98 + description = lib.mdDoc '' 99 99 Configuration for Lokinet. 100 100 Currently, the best way to view the available settings is by 101 101 generating a config file using `lokinet -g`.

+1 -1

nixos/modules/services/networking/monero.nix

reviewed

··· 181 181 exclusiveNodes = mkOption { 182 182 type = types.listOf types.str; 183 183 default = [ ]; 184 184 - description = '' 184 184 + description = lib.mdDoc '' 185 185 List of peer IP addresses to connect to *only*. 186 186 If given the other peer options will be ignored. 187 187 '';

+1 -1

nixos/modules/services/networking/murmur.nix

reviewed

··· 219 219 registerHostname = mkOption { 220 220 type = types.str; 221 221 default = ""; 222 222 - description = '' 222 222 + description = lib.mdDoc '' 223 223 DNS hostname where your server can be reached. This is only 224 224 needed if you want your server to be accessed by its 225 225 hostname and not IP - but the name *must* resolve on the

+1 -1

nixos/modules/services/networking/nar-serve.nix

reviewed

··· 23 23 cacheURL = mkOption { 24 24 type = types.str; 25 25 default = "https://cache.nixos.org/"; 26 26 - description = '' 26 26 + description = lib.mdDoc '' 27 27 Binary cache URL to connect to. 28 28 29 29 The URL format is compatible with the nix remote url style, such as:

+1 -1

nixos/modules/services/networking/nixops-dns.nix

reviewed

··· 40 40 dnsmasq = mkOption { 41 41 type = types.bool; 42 42 default = true; 43 43 - description = '' 43 43 + description = lib.mdDoc '' 44 44 Enable dnsmasq forwarding to nixops-dns. This allows to use 45 45 nixops-dns for `services.nixops-dns.domain` resolution 46 46 while forwarding the rest of the queries to original resolvers.

+1 -1

nixos/modules/services/networking/ocserv.nix

reviewed

··· 15 15 config = mkOption { 16 16 type = types.lines; 17 17 18 18 - description = '' 18 18 + description = lib.mdDoc '' 19 19 Configuration content to start an OCServ server. 20 20 21 21 For a full configuration reference,please refer to the online documentation

+2 -2

nixos/modules/services/networking/redsocks.nix

reviewed

··· 30 30 type = types.str; 31 31 default = "stderr"; 32 32 description = 33 33 - '' 33 33 + lib.mdDoc '' 34 34 Where to send logs. 35 35 36 36 Possible values are: ··· 122 122 "Forwarded_ipport" ]; 123 123 default = "false"; 124 124 description = 125 125 - '' 125 125 + lib.mdDoc '' 126 126 Way to disclose client IP to the proxy. 127 127 - "false": do not disclose 128 128 http-connect supports the following ways:

+1 -1

nixos/modules/services/networking/rpcbind.nix

reviewed

··· 13 13 enable = mkOption { 14 14 type = types.bool; 15 15 default = false; 16 16 - description = '' 16 16 + description = lib.mdDoc '' 17 17 Whether to enable `rpcbind', an ONC RPC directory service 18 18 notably used by NFS and NIS, and which can be queried 19 19 using the rpcinfo(1) command. `rpcbind` is a replacement for

+1 -1

nixos/modules/services/networking/x2goserver.nix

reviewed

··· 50 50 settings = mkOption { 51 51 type = types.attrsOf types.attrs; 52 52 default = {}; 53 53 - description = '' 53 53 + description = lib.mdDoc '' 54 54 x2goserver.conf ini configuration as nix attributes. See 55 55 `x2goserver.conf(5)` for details 56 56 '';

+3 -3

nixos/modules/services/networking/znc/options.nix

reviewed

··· 118 118 type = types.listOf types.str; 119 119 default = [ "webadmin" "adminlog" ]; 120 120 example = [ "partyline" "webadmin" "adminlog" "log" ]; 121 121 - description = '' 121 121 + description = lib.mdDoc '' 122 122 A list of modules to include in the `znc.conf` file. 123 123 ''; 124 124 }; ··· 127 127 type = types.listOf types.str; 128 128 default = [ "chansaver" "controlpanel" ]; 129 129 example = [ "chansaver" "controlpanel" "fish" "push" ]; 130 130 - description = '' 130 130 + description = lib.mdDoc '' 131 131 A list of user modules to include in the `znc.conf` file. 132 132 ''; 133 133 }; ··· 216 216 extraZncConf = mkOption { 217 217 default = ""; 218 218 type = types.lines; 219 219 - description = '' 219 219 + description = lib.mdDoc '' 220 220 Extra config to `znc.conf` file. 221 221 ''; 222 222 };

+1 -1

nixos/modules/services/search/meilisearch.nix

reviewed

··· 68 68 }; 69 69 70 70 logLevel = mkOption { 71 71 - description = '' 71 71 + description = lib.mdDoc '' 72 72 Defines how much detail should be present in MeiliSearch's logs. 73 73 MeiliSearch currently supports four log levels, listed in order of increasing verbosity: 74 74 - 'ERROR': only log unexpected events indicating MeiliSearch is not functioning as expected

+1 -1

nixos/modules/services/security/fail2ban.nix

reviewed

··· 73 73 default = []; 74 74 type = types.listOf types.package; 75 75 example = lib.literalExpression "[ pkgs.ipset ]"; 76 76 - description = '' 76 76 + description = lib.mdDoc '' 77 77 Extra packages to be made available to the fail2ban service. The example contains 78 78 the packages needed by the `iptables-ipset-proto6` action. 79 79 '';

+1 -1

nixos/modules/services/security/infnoise.nix

reviewed

··· 10 10 enable = mkEnableOption "the Infinite Noise TRNG driver"; 11 11 12 12 fillDevRandom = mkOption { 13 13 - description = '' 13 13 + description = lib.mdDoc '' 14 14 Whether to run the infnoise driver as a daemon to refill /dev/random. 15 15 16 16 If disabled, you can use the `infnoise` command-line tool to

+1 -1

nixos/modules/services/security/oauth2_proxy.nix

reviewed

··· 347 347 domain = mkOption { 348 348 type = types.nullOr types.str; 349 349 default = null; 350 350 - description = '' 350 350 + description = lib.mdDoc '' 351 351 Optional cookie domains to force cookies to (ie: `.yourcompany.com`). 352 352 The longest domain matching the request's host will be used (or the shortest 353 353 cookie domain if there is no match).

+2 -2

nixos/modules/services/system/cloud-init.nix

reviewed

··· 39 39 btrfs.enable = mkOption { 40 40 type = types.bool; 41 41 default = false; 42 42 - description = '' 42 42 + description = lib.mdDoc '' 43 43 Allow the cloud-init service to operate `btrfs` filesystem. 44 44 ''; 45 45 }; ··· 47 47 ext4.enable = mkOption { 48 48 type = types.bool; 49 49 default = true; 50 50 - description = '' 50 50 + description = lib.mdDoc '' 51 51 Allow the cloud-init service to operate `ext4` filesystem. 52 52 ''; 53 53 };

+6 -6

nixos/modules/services/system/self-deploy.nix

reviewed

··· 41 41 42 42 default = null; 43 43 44 44 - description = '' 44 44 + description = lib.mdDoc '' 45 45 Attribute of `nixFile` that builds the current system. 46 46 ''; 47 47 }; ··· 51 51 52 52 default = { }; 53 53 54 54 - description = '' 54 54 + description = lib.mdDoc '' 55 55 Arguments to `nix-build` passed as `--argstr` or `--arg` depending on 56 56 the type. 57 57 ''; ··· 62 62 63 63 default = "switch"; 64 64 65 65 - description = '' 65 65 + description = lib.mdDoc '' 66 66 The `switch-to-configuration` subcommand used. 67 67 ''; 68 68 }; ··· 70 70 repository = lib.mkOption { 71 71 type = with lib.types; oneOf [ path str ]; 72 72 73 73 - description = '' 73 73 + description = lib.mdDoc '' 74 74 The repository to fetch from. Must be properly formatted for git. 75 75 76 76 If this value is set to a path (must begin with `/`) then it's ··· 99 99 100 100 default = "master"; 101 101 102 102 - description = '' 102 102 + description = lib.mdDoc '' 103 103 Branch to track 104 104 105 105 Technically speaking any ref can be specified here, as this is ··· 113 113 114 114 default = "hourly"; 115 115 116 116 - description = '' 116 116 + description = lib.mdDoc '' 117 117 The schedule on which to run the `self-deploy` service. Format 118 118 specified by `systemd.time 7`. 119 119

+2 -2

nixos/modules/services/web-apps/hedgedoc.nix

reviewed

··· 937 937 id = mkOption { 938 938 type = types.str; 939 939 default = ""; 940 940 - description = '' 940 940 + description = lib.mdDoc '' 941 941 Attribute map for `id'. 942 942 Defaults to `NameID' of SAML response. 943 943 ''; ··· 945 945 username = mkOption { 946 946 type = types.str; 947 947 default = ""; 948 948 - description = '' 948 948 + description = lib.mdDoc '' 949 949 Attribute map for `username'. 950 950 Defaults to `NameID' of SAML response. 951 951 '';

+1 -1

nixos/modules/services/web-apps/nexus.nix

reviewed

··· 93 93 ''' 94 94 ''; 95 95 96 96 - description = '' 96 96 + description = lib.mdDoc '' 97 97 Options for the JVM written to `nexus.jvmopts`. 98 98 Please refer to the docs (https://help.sonatype.com/repomanager3/installation/configuring-the-runtime-environment) 99 99 for further information.

+1 -1

nixos/modules/services/web-servers/apache-httpd/location-options.nix

reviewed

··· 43 43 priority = mkOption { 44 44 type = types.int; 45 45 default = 1000; 46 46 - description = '' 46 46 + description = lib.mdDoc '' 47 47 Order of this location block in relation to the others in the vhost. 48 48 The semantics are the same as with `lib.mkOrder`. Smaller values have 49 49 a greater priority.

+1 -1

nixos/modules/services/web-servers/darkhttpd.nix

reviewed

··· 29 29 address = mkOption { 30 30 default = "127.0.0.1"; 31 31 type = str; 32 32 - description = '' 32 32 + description = lib.mdDoc '' 33 33 Address to listen on. 34 34 Pass `all` to listen on all interfaces. 35 35 '';

+1 -1

nixos/modules/services/web-servers/nginx/location-options.nix

reviewed

··· 122 122 priority = mkOption { 123 123 type = types.int; 124 124 default = 1000; 125 125 - description = '' 125 125 + description = lib.mdDoc '' 126 126 Order of this location block in relation to the others in the vhost. 127 127 The semantics are the same as with `lib.mkOrder`. Smaller values have 128 128 a greater priority.

+2 -2

nixos/modules/services/web-servers/tomcat.nix

reviewed

··· 34 34 purifyOnStart = mkOption { 35 35 type = types.bool; 36 36 default = false; 37 37 - description = '' 37 37 + description = lib.mdDoc '' 38 38 On startup, the `baseDir` directory is populated with various files, 39 39 subdirectories and symlinks. If this option is enabled, these items 40 40 (except for the `logs` and `work` subdirectories) are first removed. ··· 46 46 baseDir = mkOption { 47 47 type = lib.types.path; 48 48 default = "/var/tomcat"; 49 49 - description = '' 49 49 + description = lib.mdDoc '' 50 50 Location where Tomcat stores configuration files, web applications 51 51 and logfiles. Note that it is partially cleared on each service startup 52 52 if `purifyOnStart` is enabled.

+1 -1

nixos/modules/services/x11/desktop-managers/phosh.nix

reviewed

··· 24 24 phocConfigType = types.submodule { 25 25 options = { 26 26 xwayland = mkOption { 27 27 - description = '' 27 27 + description = lib.mdDoc '' 28 28 Whether to enable XWayland support. 29 29 30 30 To start XWayland immediately, use `immediate`.

+1 -1

nixos/modules/system/boot/kernel_config.nix

reviewed

··· 91 91 USB? y 92 92 DEBUG n 93 93 ''; 94 94 - description = '' 94 94 + description = lib.mdDoc '' 95 95 The result of converting the structured kernel configuration in settings 96 96 to an intermediate string that can be parsed by generate-config.pl to 97 97 answer the kernel `make defconfig`.

+1 -1

nixos/modules/tasks/filesystems/zfs.nix

reviewed

··· 426 426 type = types.either (types.enum [ "disabled" "all" ]) (types.listOf types.str); 427 427 default = "disabled"; 428 428 example = [ "tank" "dozer" ]; 429 429 - description = '' 429 429 + description = lib.mdDoc '' 430 430 After importing, expand each device in the specified pools. 431 431 432 432 Set the value to the plain string "all" to expand all pools on boot:

+4 -4

nixos/modules/tasks/network-interfaces.nix

reviewed

··· 785 785 default = null; 786 786 example = "fast"; 787 787 type = types.nullOr types.str; 788 788 - description = '' 788 788 + description = lib.mdDoc '' 789 789 DEPRECATED, use `driverOptions`. 790 790 Option specifying the rate in which we'll ask our link partner 791 791 to transmit LACPDU packets in 802.3ad mode. ··· 796 796 default = null; 797 797 example = 100; 798 798 type = types.nullOr types.int; 799 799 - description = '' 799 799 + description = lib.mdDoc '' 800 800 DEPRECATED, use `driverOptions`. 801 801 Miimon is the number of millisecond in between each round of polling 802 802 by the device driver for failed links. By default polling is not ··· 809 809 default = null; 810 810 example = "active-backup"; 811 811 type = types.nullOr types.str; 812 812 - description = '' 812 812 + description = lib.mdDoc '' 813 813 DEPRECATED, use `driverOptions`. 814 814 The mode which the bond will be running. The default mode for 815 815 the bonding driver is balance-rr, optimizing for throughput. ··· 822 822 default = null; 823 823 example = "layer2+3"; 824 824 type = types.nullOr types.str; 825 825 - description = '' 825 825 + description = lib.mdDoc '' 826 826 DEPRECATED, use `driverOptions`. 827 827 Selects the transmit hash policy to use for slave selection in 828 828 balance-xor, 802.3ad, and tlb modes.

+1 -1

nixos/modules/virtualisation/amazon-options.nix

reviewed

··· 14 14 }; 15 15 16 16 datasets = lib.mkOption { 17 17 - description = '' 17 17 + description = lib.mdDoc '' 18 18 Datasets to create under the `tank` and `boot` zpools. 19 19 20 20 **NOTE:** This option is used only at image creation time, and

+1 -1

nixos/modules/virtualisation/google-compute-image.nix

reviewed

··· 29 29 virtualisation.googleComputeImage.configFile = mkOption { 30 30 type = with types; nullOr str; 31 31 default = null; 32 32 - description = '' 32 32 + description = lib.mdDoc '' 33 33 A path to a configuration file which will be placed at `/etc/nixos/configuration.nix` 34 34 and be used when switching to a new configuration. 35 35 If set to `null`, a default configuration is used, where the only import is

+1 -1

nixos/modules/virtualisation/libvirtd.nix

reviewed

··· 81 81 type = types.package; 82 82 default = pkgs.qemu; 83 83 defaultText = literalExpression "pkgs.qemu"; 84 84 - description = '' 84 84 + description = lib.mdDoc '' 85 85 Qemu package to use with libvirt. 86 86 `pkgs.qemu` can emulate alien architectures (e.g. aarch64 on x86) 87 87 `pkgs.qemu_kvm` saves disk space allowing to emulate only host architectures.

+1 -1

nixos/modules/virtualisation/openstack-options.nix

reviewed

··· 15 15 }; 16 16 17 17 datasets = lib.mkOption { 18 18 - description = '' 18 18 + description = lib.mdDoc '' 19 19 Datasets to create under the `tank` and `boot` zpools. 20 20 21 21 **NOTE:** This option is used only at image creation time, and

+1 -1

nixos/modules/virtualisation/parallels-guest.nix

reviewed

··· 23 23 autoMountShares = mkOption { 24 24 type = types.bool; 25 25 default = true; 26 26 - description = '' 26 26 + description = lib.mdDoc '' 27 27 Control prlfsmountd service. When this service is running, shares can not be manually 28 28 mounted through `mount -t prl_fs ...` as this service will remount and trample any set options. 29 29 Recommended to enable for simple file sharing, but extended share use such as for code should