b12f/nixpkgs
1
0
Fork 0
Code Issues Pull requests Packages Projects Releases Wiki Activity

Merge master into staging-next

Browse source
This commit is contained in:
github-actions[bot] 2022-08-20 00:02:22 +00:00 committed by GitHub
parent 949c5dc1a1 287e8bfb2d
commit 318717f2e3
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
222 changed files with 1191 additions and 1043 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

19
doc/stdenv/stdenv.chapter.md
View file

@ -871,12 +871,27 @@ Constructs a wrapper for a program with various possible arguments. It is define
# adds `FOOBAR=baz` to `$out/bin/foo`’s environment
makeWrapper $out/bin/foo $wrapperfile --set FOOBAR baz
# prefixes the binary paths of `hello` and `git`
# Prefixes the binary paths of `hello` and `git`
# and suffixes the binary path of `xdg-utils`.
# Be advised that paths often should be patched in directly
# (via string replacements or in `configurePhase`).
makeWrapper $out/bin/foo $wrapperfile --prefix PATH : ${lib.makeBinPath [ hello git ]}
makeWrapper $out/bin/foo $wrapperfile \
--prefix PATH : ${lib.makeBinPath [ hello git ]} \
--suffix PATH : ${lib.makeBinPath [ xdg-utils ]}
```
Packages may expect or require other utilities to be available at runtime.
`makeWrapper` can be used to add packages to a `PATH` environment variable local to a wrapper.
Use `--prefix` to explicitly set dependencies in `PATH`.
:::{note}
`--prefix` essentially hard-codes dependencies into the wrapper.
They cannot be overridden without rebuilding the package.
:::
If dependencies should be resolved at runtime, use `--suffix` to append fallback values to `PATH`.
There’s many more kinds of arguments, they are documented in `nixpkgs/pkgs/build-support/setup-hooks/make-wrapper.sh` for the `makeWrapper` implementation and in `nixpkgs/pkgs/build-support/setup-hooks/make-binary-wrapper/make-binary-wrapper.sh` for the `makeBinaryWrapper` implementation.
`wrapProgram` is a convenience function you probably want to use most of the time, implemented by both `makeWrapper` and `makeBinaryWrapper`.

10
nixos/modules/config/krb5/default.nix
View file

@ -204,11 +204,11 @@ in {
admin_server = SYSLOG:NOTICE
default = SYSLOG:NOTICE
'';
description = ''
These lines go to the end of <literal>krb5.conf</literal> verbatim.
<literal>krb5.conf</literal> may include any of the relations that are
valid for <literal>kdc.conf</literal> (see <literal>man
kdc.conf</literal>), but it is not a recommended practice.
description = lib.mdDoc ''
These lines go to the end of `krb5.conf` verbatim.
`krb5.conf` may include any of the relations that are
valid for `kdc.conf` (see `man kdc.conf`),
but it is not a recommended practice.
'';
};

10
nixos/modules/config/ldap.nix
View file

@ -186,16 +186,16 @@ in
policy = mkOption {
default = "hard_open";
type = types.enum [ "hard_open" "hard_init" "soft" ];
description = ''
description = lib.mdDoc ''
Specifies the policy to use for reconnecting to an unavailable
LDAP server. The default is <literal>hard_open</literal>, which
LDAP server. The default is `hard_open`, which
reconnects if opening the connection to the directory server
failed. By contrast, <literal>hard_init</literal> reconnects if
failed. By contrast, `hard_init` reconnects if
initializing the connection failed. Initializing may not
actually contact the directory server, and it is possible that
a malformed configuration file will trigger reconnection. If
<literal>soft</literal> is specified, then
<package>nss_ldap</package> will return immediately on server
`soft` is specified, then
`nss_ldap` will return immediately on server
failure. All hard reconnect policies block with exponential
backoff before retrying.
'';

10
nixos/modules/config/system-path.nix
View file

@ -84,19 +84,19 @@ in
<programlisting>${defaultPackagesText}</programlisting>
'';
example = [];
description = ''
description = lib.mdDoc ''
Set of default packages that aren't strictly necessary
for a running system, entries can be removed for a more
minimal NixOS installation.
Note: If <package>pkgs.nano</package> is removed from this list,
Note: If `pkgs.nano` is removed from this list,
make sure another editor is installed and the
<literal>EDITOR</literal> environment variable is set to it.
`EDITOR` environment variable is set to it.
Environment variables can be set using
<option>environment.variables</option>.
{option}`environment.variables`.
Like with systemPackages, packages are installed to
<filename>/run/current-system/sw</filename>. They are
{file}`/run/current-system/sw`. They are
automatically available to all users, and are
automatically updated every time you rebuild the system
configuration.

6
nixos/modules/config/xdg/portal.nix
View file

@ -40,12 +40,12 @@ in
extraPortals = mkOption {
type = types.listOf types.package;
default = [ ];
description = ''
description = lib.mdDoc ''
List of additional portals to add to path. Portals allow interaction
with system, like choosing files or taking screenshots. At minimum,
a desktop portal implementation should be listed. GNOME and KDE already
adds <package>xdg-desktop-portal-gtk</package>; and
<package>xdg-desktop-portal-kde</package> respectively. On other desktop
adds `xdg-desktop-portal-gtk`; and
`xdg-desktop-portal-kde` respectively. On other desktop
environments you probably want to add them yourself.
'';
};

6
nixos/modules/config/xdg/portals/lxqt.nix
View file

@ -15,7 +15,7 @@ in
enable = mkEnableOption ''
the desktop portal for the LXQt desktop environment.
This will add the <package>lxqt.xdg-desktop-portal-lxqt</package>
This will add the <literal>lxqt.xdg-desktop-portal-lxqt</literal>
package (with the extra Qt styles) into the
<option>xdg.portal.extraPortals</option> option
'';
@ -29,9 +29,9 @@ in
pkgs.qtcurve
];
'';
description = ''
description = lib.mdDoc ''
Extra Qt styles that will be available to the
<package>lxqt.xdg-desktop-portal-lxqt</package>.
`lxqt.xdg-desktop-portal-lxqt`.
'';
};
};

8
nixos/modules/config/xdg/portals/wlr.nix
View file

@ -17,16 +17,16 @@ in
enable = mkEnableOption ''
desktop portal for wlroots-based desktops
This will add the <package>xdg-desktop-portal-wlr</package> package into
This will add the <literal>xdg-desktop-portal-wlr</literal> package into
the <option>xdg.portal.extraPortals</option> option, and provide the
configuration file
'';
settings = mkOption {
description = ''
Configuration for <package>xdg-desktop-portal-wlr</package>.
description = lib.mdDoc ''
Configuration for `xdg-desktop-portal-wlr`.
See <literal>xdg-desktop-portal-wlr(5)</literal> for supported
See `xdg-desktop-portal-wlr(5)` for supported
values.
'';

10
nixos/modules/config/zram.nix
View file

@ -103,12 +103,12 @@ in
default = "zstd";
example = "lz4";
type = with types; either (enum [ "lzo" "lz4" "zstd" ]) str;
description = ''
Compression algorithm. <literal>lzo</literal> has good compression,
but is slow. <literal>lz4</literal> has bad compression, but is fast.
<literal>zstd</literal> is both good compression and fast, but requires newer kernel.
description = lib.mdDoc ''
Compression algorithm. `lzo` has good compression,
but is slow. `lz4` has bad compression, but is fast.
`zstd` is both good compression and fast, but requires newer kernel.
You can check what other algorithms are supported by your zram device with
<programlisting>cat /sys/class/block/zram*/comp_algorithm</programlisting>
{command}`cat /sys/class/block/zram*/comp_algorithm`
'';
};
};

2
nixos/modules/hardware/corectrl.nix
View file

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

6
nixos/modules/hardware/cpu/amd-sev.nix
View file

@ -8,17 +8,17 @@ in
options.hardware.cpu.amd.sev = {
enable = mkEnableOption "access to the AMD SEV device";
user = mkOption {
description = "Owner to assign to the SEV device.";
description = lib.mdDoc "Owner to assign to the SEV device.";
type = types.str;
default = "root";
};
group = mkOption {
description = "Group to assign to the SEV device.";
description = lib.mdDoc "Group to assign to the SEV device.";
type = types.str;
default = defaultGroup;
};
mode = mkOption {
description = "Mode to set for the SEV device.";
description = lib.mdDoc "Mode to set for the SEV device.";
type = types.str;
default = "0660";
};

26
nixos/modules/installer/sd-card/sd-image.nix
View file

@ -35,14 +35,14 @@ in
options.sdImage = {
imageName = mkOption {
default = "${config.sdImage.imageBaseName}-${config.system.nixos.label}-${pkgs.stdenv.hostPlatform.system}.img";
description = ''
description = lib.mdDoc ''
Name of the generated image file.
'';
};
imageBaseName = mkOption {
default = "nixos-sd-image";
description = ''
description = lib.mdDoc ''
Prefix of the name of the generated image file.
'';
};
@ -50,7 +50,7 @@ in
storePaths = mkOption {
type = with types; listOf package;
example = literalExpression "[ pkgs.stdenv ]";
description = ''
description = lib.mdDoc ''
Derivations to be included in the Nix store in the generated SD image.
'';
};
@ -74,7 +74,7 @@ in
firmwarePartitionID = mkOption {
type = types.str;
default = "0x2178694e";
description = ''
description = lib.mdDoc ''
Volume ID for the /boot/firmware partition on the SD card. This value
must be a 32-bit hexadecimal number.
'';
@ -83,7 +83,7 @@ in
firmwarePartitionName = mkOption {
type = types.str;
default = "FIRMWARE";
description = ''
description = lib.mdDoc ''
Name of the filesystem which holds the boot firmware.
'';
};
@ -92,7 +92,7 @@ in
type = types.nullOr types.str;
default = null;
example = "14e19a7b-0ae0-484d-9d54-43bd6fdc20c7";
description = ''
description = lib.mdDoc ''
UUID for the filesystem on the main NixOS partition on the SD card.
'';
};
@ -101,14 +101,14 @@ in
type = types.int;
# As of 2019-08-18 the Raspberry pi firmware + u-boot takes ~18MiB
default = 30;
description = ''
description = lib.mdDoc ''
Size of the /boot/firmware partition, in megabytes.
'';
};
populateFirmwareCommands = mkOption {
example = literalExpression "'' cp \${pkgs.myBootLoader}/u-boot.bin firmware/ ''";
description = ''
description = lib.mdDoc ''
Shell commands to populate the ./firmware directory.
All files in that directory are copied to the
/boot/firmware partition on the SD image.
@ -117,7 +117,7 @@ in
populateRootCommands = mkOption {
example = literalExpression "''\${config.boot.loader.generic-extlinux-compatible.populateCmd} -c \${config.system.build.toplevel} -d ./files/boot''";
description = ''
description = lib.mdDoc ''
Shell commands to populate the ./files directory.
All files in that directory are copied to the
root (/) partition on the SD image. Use this to
@ -128,7 +128,7 @@ in
postBuildCommands = mkOption {
example = literalExpression "'' dd if=\${pkgs.myBootLoader}/SPL of=$img bs=1024 seek=1 conv=notrunc ''";
default = "";
description = ''
description = lib.mdDoc ''
Shell commands to run after the image is built.
Can be used for boards requiring to dd u-boot SPL before actual partitions.
'';
@ -137,16 +137,16 @@ in
compressImage = mkOption {
type = types.bool;
default = true;
description = ''
description = lib.mdDoc ''
Whether the SD image should be compressed using
<command>zstd</command>.
{command}`zstd`.
'';
};
expandOnBoot = mkOption {
type = types.bool;
default = true;
description = ''
description = lib.mdDoc ''
Whether to configure the sd image to expand it's partition on boot.
'';
};

2
nixos/modules/misc/documentation.nix
View file

@ -241,7 +241,7 @@ in
nixos.extraModules = mkOption {
type = types.listOf types.raw;
default = [];
description = ''
description = lib.mdDoc ''
Modules for which to show options even when not imported.
'';
};

20
nixos/modules/misc/nixpkgs.nix
View file

@ -117,13 +117,13 @@ in
'';
type = pkgsType;
example = literalExpression "import <nixpkgs> {}";
description = ''
description = lib.mdDoc ''
If set, the pkgs argument to all NixOS modules is the value of
this option, extended with <literal>nixpkgs.overlays</literal>, if
that is also set. Either <literal>nixpkgs.crossSystem</literal> or
<literal>nixpkgs.localSystem</literal> will be used in an assertion
this option, extended with `nixpkgs.overlays`, if
that is also set. Either `nixpkgs.crossSystem` or
`nixpkgs.localSystem` will be used in an assertion
to check that the NixOS and Nixpkgs architectures match. Any
other options in <literal>nixpkgs.*</literal>, notably <literal>config</literal>,
other options in `nixpkgs.*`, notably `config`,
will be ignored.
If unset, the pkgs argument to all NixOS modules is determined
@ -132,18 +132,18 @@ in
The default value imports the Nixpkgs source files
relative to the location of this NixOS module, because
NixOS and Nixpkgs are distributed together for consistency,
so the <literal>nixos</literal> in the default value is in fact a
relative path. The <literal>config</literal>, <literal>overlays</literal>,
<literal>localSystem</literal>, and <literal>crossSystem</literal> come
so the `nixos` in the default value is in fact a
relative path. The `config`, `overlays`,
`localSystem`, and `crossSystem` come
from this option's siblings.
This option can be used by applications like NixOps to increase
the performance of evaluation, or to create packages that depend
on a container that should be built with the exact same evaluation
of Nixpkgs, for example. Applications like this should set
their default value using <literal>lib.mkDefault</literal>, so
their default value using `lib.mkDefault`, so
user-provided configuration can override it without using
<literal>lib</literal>.
`lib`.
Note that using a distinct version of Nixpkgs with NixOS may
be an unexpected source of problems. Use this option with care.

2
nixos/modules/misc/wordlist.nix
View file

@ -23,7 +23,7 @@ in
}
'';
description = ''
description = lib.mdDoc ''
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
lists of words. The various files will be merged, sorted, duplicates

6
nixos/modules/programs/captive-browser.nix
View file

@ -85,9 +85,9 @@ in
bindInterface = mkOption {
default = true;
type = types.bool;
description = ''
Binds <package>captive-browser</package> to the network interface declared in
<literal>cfg.interface</literal>. This can be used to avoid collisions
description = lib.mdDoc ''
Binds `captive-browser` to the network interface declared in
`cfg.interface`. This can be used to avoid collisions
with private subnets.
'';
};

4
nixos/modules/programs/chromium.nix
View file

@ -76,10 +76,10 @@ in
extraOpts = mkOption {
type = types.attrs;
description = ''
description = lib.mdDoc ''
Extra chromium policy options. A list of available policies
can be found in the Chrome Enterprise documentation:
<link xlink:href="https://cloud.google.com/docs/chrome-enterprise/policies/">https://cloud.google.com/docs/chrome-enterprise/policies/</link>
<https://cloud.google.com/docs/chrome-enterprise/policies/>
Make sure the selected policy is supported on Linux and your browser version.
'';
default = {};

14
nixos/modules/programs/k3b.nix
View file

@ -8,15 +8,15 @@ with lib;
enable = mkOption {
type = types.bool;
default = false;
description = ''
description = lib.mdDoc ''
Whether to enable k3b, the KDE disk burning application.
Additionally to installing <package>k3b</package> enabling this will
add <literal>setuid</literal> wrappers in <literal>/run/wrappers/bin</literal>
for both <package>cdrdao</package> and <package>cdrecord</package>. On first
run you must manually configure the path of <package>cdrdae</package> and
<package>cdrecord</package> to correspond to the appropriate paths under
<literal>/run/wrappers/bin</literal> in the "Setup External Programs" menu.
Additionally to installing `k3b` enabling this will
add `setuid` wrappers in `/run/wrappers/bin`
for both `cdrdao` and `cdrecord`. On first
run you must manually configure the path of `cdrdae` and
`cdrecord` to correspond to the appropriate paths under
`/run/wrappers/bin` in the "Setup External Programs" menu.
'';
};
};

2
nixos/modules/programs/mosh.nix
View file

@ -17,7 +17,7 @@ in
type = lib.types.bool;
};
withUtempter = mkOption {
description = ''
description = lib.mdDoc ''
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).
Note, this will add a guid wrapper for the group utmp!

2
nixos/modules/programs/msmtp.nix
View file

@ -45,7 +45,7 @@ in {
passwordeval = "cat /secrets/password.txt";
};
};
description = ''
description = lib.mdDoc ''
Named accounts and their respective configurations.
The special name "default" allows a default account to be defined.
See msmtp(1) for the available options.

8
nixos/modules/programs/ssh.nix
View file

@ -93,10 +93,10 @@ in
extraConfig = mkOption {
type = types.lines;
default = "";
description = ''
Extra configuration text prepended to <filename>ssh_config</filename>. Other generated
options will be added after a <literal>Host *</literal> pattern.
See <citerefentry><refentrytitle>ssh_config</refentrytitle><manvolnum>5</manvolnum></citerefentry>
description = lib.mdDoc ''
Extra configuration text prepended to {file}`ssh_config`. Other generated
options will be added after a `Host *` pattern.
See {manpage}`ssh_config(5)`
for help.
'';
};

2
nixos/modules/programs/thefuck.nix
View file

@ -22,7 +22,7 @@ in
default = "fuck";
type = types.str;
description = ''
description = lib.mdDoc ''
`thefuck` needs an alias to be configured.
The default value is `fuck`, but you can use anything else as well.
'';

10
nixos/modules/programs/tsm-client.nix
View file

@ -95,13 +95,13 @@ let
exclude.dir /nix/store
include.encrypt /home/.../*
'';
description = ''
<literal>include.*</literal> and
<literal>exclude.*</literal> directives to be
description = lib.mdDoc ''
`include.*` and
`exclude.*` directives to be
used when sending files to the IBM TSM server.
The lines will be written into a file that the
<literal>inclexcl</literal>
directive in <filename>dsm.sys</filename> points to.
`inclexcl`
directive in {file}`dsm.sys` points to.
'';
};
options.extraConfig = mkOption {

2
nixos/modules/programs/yabar.nix
View file

@ -62,7 +62,7 @@ in
to use `yabar-unstable'.
'';
description = ''
description = lib.mdDoc ''
The package which contains the `yabar` binary.
Nixpkgs provides the `yabar` and `yabar-unstable`

8
nixos/modules/programs/zsh/oh-my-zsh.nix
View file

@ -49,7 +49,7 @@ in
package = mkOption {
default = pkgs.oh-my-zsh;
defaultText = literalExpression "pkgs.oh-my-zsh";
description = ''
description = lib.mdDoc ''
Package to install for `oh-my-zsh` usage.
'';
@ -67,7 +67,7 @@ in
custom = mkOption {
default = null;
type = with types; nullOr str;
description = ''
description = lib.mdDoc ''
Path to a custom oh-my-zsh package to override config of oh-my-zsh.
(Can't be used along with `customPkgs`).
'';
@ -76,7 +76,7 @@ in
customPkgs = mkOption {
default = [];
type = types.listOf types.package;
description = ''
description = lib.mdDoc ''
List of custom packages that should be loaded into `oh-my-zsh`.
'';
};
@ -92,7 +92,7 @@ in
cacheDir = mkOption {
default = "$HOME/.cache/oh-my-zsh";
type = types.str;
description = ''
description = lib.mdDoc ''
Cache directory to be used by `oh-my-zsh`.
Without this option it would default to the read-only nix store.
'';

2
nixos/modules/programs/zsh/zsh-autoenv.nix
View file

@ -11,7 +11,7 @@ in {
package = mkOption {
default = pkgs.zsh-autoenv;
defaultText = literalExpression "pkgs.zsh-autoenv";
description = ''
description = lib.mdDoc ''
Package to install for `zsh-autoenv` usage.
'';

2
nixos/modules/programs/zsh/zsh-autosuggestions.nix
View file

@ -24,7 +24,7 @@ in
strategy = mkOption {
type = types.listOf (types.enum [ "history" "completion" "match_prev_cmd" ]);
default = [ "history" ];
description = ''
description = lib.mdDoc ''
`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.
There are currently three built-in strategies to choose from:

2
nixos/modules/security/acme/default.nix
View file

@ -676,7 +676,7 @@ let
inheritDefaults = mkOption {
default = 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;
};
};

2
nixos/modules/security/dhparams.nix
View file

@ -94,7 +94,7 @@ in {
<note><para>If this is <literal>false</literal> the resulting store
path will be non-deterministic and will be rebuilt every time the
<package>openssl</package> package changes.</para></note>
<literal>openssl</literal> package changes.</para></note>
'';
};

29
nixos/modules/security/pam.nix
View file

@ -320,11 +320,10 @@ let
limits = mkOption {
default = [];
type = limitsType;
description = ''
description = lib.mdDoc ''
Attribute set describing resource limits. Defaults to the
value of <option>security.pam.loginLimits</option>.
The meaning of the values is explained in <citerefentry>
<refentrytitle>limits.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry>.
value of {option}`security.pam.loginLimits`.
The meaning of the values is explained in {manpage}`limits.conf(5)`.
'';
};
@ -774,18 +773,18 @@ in
}
];
description =
'' Define resource limits that should apply to users or groups.
Each item in the list should be an attribute set with a
<varname>domain</varname>, <varname>type</varname>,
<varname>item</varname>, and <varname>value</varname>
attribute. The syntax and semantics of these attributes
must be that described in <citerefentry><refentrytitle>limits.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry>.
description = ''
Define resource limits that should apply to users or groups.
Each item in the list should be an attribute set with a
<varname>domain</varname>, <varname>type</varname>,
<varname>item</varname>, and <varname>value</varname>
attribute. The syntax and semantics of these attributes
must be that described in <citerefentry><refentrytitle>limits.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry>.
Note that these limits do not apply to systemd services,
whose limits can be changed via <option>systemd.extraConfig</option>
instead.
'';
Note that these limits do not apply to systemd services,
whose limits can be changed via <option>systemd.extraConfig</option>
instead.
'';
};
security.pam.services = mkOption {

2
nixos/modules/security/sudo.nix
View file

@ -46,7 +46,7 @@ in
type = types.package;
default = pkgs.sudo;
defaultText = literalExpression "pkgs.sudo";
description = ''
description = lib.mdDoc ''
Which package to use for `sudo`.
'';
};

18
nixos/modules/services/cluster/hadoop/hbase.nix
View file

@ -21,7 +21,7 @@ in
"hbase.cluster.distributed" = "true";
};
type = types.attrsOf types.anything;
description = ''
description = lib.mdDoc ''
Default options for hbase-site.xml
'';
};
@ -30,9 +30,9 @@ in
type = with types; attrsOf anything;
example = literalExpression ''
'';
description = ''
description = lib.mdDoc ''
Additional options and overrides for hbase-site.xml
<link xlink:href="https://github.com/apache/hbase/blob/rel/2.4.11/hbase-common/src/main/resources/hbase-default.xml"/>
<https://github.com/apache/hbase/blob/rel/2.4.11/hbase-common/src/main/resources/hbase-default.xml>
'';
};
hbaseSiteInternal = mkOption {
@ -50,11 +50,11 @@ in
type = types.package;
default = pkgs.hbase;
defaultText = literalExpression "pkgs.hbase";
description = "HBase package";
description = lib.mdDoc "HBase package";
};
rootdir = mkOption {
description = ''
description = lib.mdDoc ''
This option will set "hbase.rootdir" in hbase-site.xml and determine
the directory shared by region servers and into which HBase persists.
The URL should be 'fully-qualified' to include the filesystem scheme.
@ -68,7 +68,7 @@ in
default = "/hbase";
};
zookeeperQuorum = mkOption {
description = ''
description = lib.mdDoc ''
This option will set "hbase.zookeeper.quorum" in hbase-site.xml.
Comma separated list of servers in the ZooKeeper ensemble.
'';
@ -83,7 +83,7 @@ in
openFirewall = mkOption {
type = types.bool;
default = false;
description = ''
description = lib.mdDoc ''
Open firewall ports for HBase master.
'';
};
@ -94,7 +94,7 @@ in
overrideHosts = mkOption {
type = types.bool;
default = true;
description = ''
description = lib.mdDoc ''
Remove /etc/hosts entries for "127.0.0.2" and "::1" defined in nixos/modules/config/networking.nix
Regionservers must be able to resolve their hostnames to their IP addresses, through PTR records
or /etc/hosts entries.
@ -105,7 +105,7 @@ in
openFirewall = mkOption {
type = types.bool;
default = false;
description = ''
description = lib.mdDoc ''
Open firewall ports for HBase master.
'';
};

4
nixos/modules/services/continuous-integration/buildbot/worker.nix
View file

@ -121,10 +121,10 @@ in {
keepalive = mkOption {
default = 600;
type = types.int;
description = "
description = lib.mdDoc ''
This is a number that indicates how frequently keepalive messages should be sent
from the worker to the buildmaster, expressed in seconds.
";
'';
};
package = mkOption {

2
nixos/modules/services/continuous-integration/buildkite-agents.nix
View file

@ -193,7 +193,7 @@ in
options.services.buildkite-agents = mkOption {
type = types.attrsOf (types.submodule buildkiteOptions);
default = {};
description = ''
description = lib.mdDoc ''
Attribute set of buildkite agents.
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`

19
nixos/modules/services/continuous-integration/hercules-ci-agent/common.nix
View file

@ -103,15 +103,15 @@ let
defaultText = literalExpression ''baseDirectory + "/secrets"'';
};
clusterJoinTokenPath = mkOption {
description = ''
description = lib.mdDoc ''
Location of the cluster-join-token.key file.
You can retrieve the contents of the file when creating a new agent via
<link xlink:href="https://hercules-ci.com/dashboard">https://hercules-ci.com/dashboard</link>.
<https://hercules-ci.com/dashboard>.
As this value is confidential, it should not be in the store, but
installed using other means, such as agenix, NixOps
<literal>deployment.keys</literal>, or manual installation.
`deployment.keys`, or manual installation.
The contents of the file are used for authentication between the agent and the API.
'';
@ -120,29 +120,28 @@ let
defaultText = literalExpression ''staticSecretsDirectory + "/cluster-join-token.key"'';
};
binaryCachesPath = mkOption {
description = ''
description = lib.mdDoc ''
Path to a JSON file containing binary cache secret keys.
As these values are confidential, they should not be in the store, but
copied over using other means, such as agenix, NixOps
<literal>deployment.keys</literal>, or manual installation.
`deployment.keys`, or manual installation.
The format is described on <link xlink:href="https://docs.hercules-ci.com/hercules-ci-agent/binary-caches-json/">https://docs.hercules-ci.com/hercules-ci-agent/binary-caches-json/</link>.
The format is described on <https://docs.hercules-ci.com/hercules-ci-agent/binary-caches-json/>.
'';
type = types.path;
default = config.staticSecretsDirectory + "/binary-caches.json";
defaultText = literalExpression ''staticSecretsDirectory + "/binary-caches.json"'';
};
secretsJsonPath = mkOption {
description = ''
description = lib.mdDoc ''
Path to a JSON file containing secrets for effects.
As these values are confidential, they should not be in the store, but
copied over using other means, such as agenix, NixOps
<literal>deployment.keys</literal>, or manual installation.
The format is described on <link xlink:href="https://docs.hercules-ci.com/hercules-ci-agent/secrets-json/">https://docs.hercules-ci.com/hercules-ci-agent/secrets-json/</link>.
`deployment.keys`, or manual installation.
The format is described on <https://docs.hercules-ci.com/hercules-ci-agent/secrets-json/>.
'';
type = types.path;
default = config.staticSecretsDirectory + "/secrets.json";

6
nixos/modules/services/continuous-integration/hydra/default.nix
View file

@ -87,7 +87,7 @@ in
type = types.str;
default = localDB;
example = "dbi:Pg:dbname=hydra;host=postgres.example.org;user=foo;";
description = ''
description = lib.mdDoc ''
The DBI string for Hydra database connection.
NOTE: Attempts to set `application_name` will be overridden by
@ -115,8 +115,8 @@ in
type = types.str;
default = "*";
example = "localhost";
description = ''
The hostname or address to listen on or <literal>*</literal> to listen
description = lib.mdDoc ''
The hostname or address to listen on or `*` to listen
on all interfaces.
'';
};

4
nixos/modules/services/databases/foundationdb.nix
View file

@ -97,9 +97,9 @@ in
openFirewall = mkOption {
type = types.bool;
default = false;
description = ''
description = lib.mdDoc ''
Open the firewall ports corresponding to FoundationDB processes and coordinators
using <option>config.networking.firewall.*</option>.
using {option}`config.networking.firewall.*`.
'';
};

4
nixos/modules/services/databases/mongodb.nix
View file

@ -35,9 +35,9 @@ in
default = pkgs.mongodb;
defaultText = literalExpression "pkgs.mongodb";
type = types.package;
description = "
description = lib.mdDoc ''
Which MongoDB derivation to use.
";
'';
};
user = mkOption {

4
nixos/modules/services/databases/mysql.nix
View file

@ -36,9 +36,9 @@ in
package = mkOption {
type = types.package;
example = literalExpression "pkgs.mariadb";
description = "
description = lib.mdDoc ''
Which MySQL derivation to use. MariaDB packages are supported too.
";
'';
};
user = mkOption {

6
nixos/modules/services/databases/postgresql.nix
View file

@ -79,15 +79,15 @@ in
authentication = mkOption {
type = types.lines;
default = "";
description = ''
description = lib.mdDoc ''
Defines how users authenticate themselves to the server. See the
<link xlink:href="https://www.postgresql.org/docs/current/auth-pg-hba-conf.html">PostgreSQL documentation for pg_hba.conf</link>
[PostgreSQL documentation for pg_hba.conf](https://www.postgresql.org/docs/current/auth-pg-hba-conf.html)
for details on the expected format of this option. By default,
peer based authentication will be used for users connecting
via the Unix socket, and md5 password authentication will be
used for users connecting via TCP. Any added rules will be
inserted above the default rules. If you'd like to replace the
default rules entirely, you can use <function>lib.mkForce</function> in your
default rules entirely, you can use `lib.mkForce` in your
module.
'';
};

13
nixos/modules/services/development/jupyter/default.nix
View file

@ -149,13 +149,14 @@ in {
};
}
'';
description = "Declarative kernel config
description = lib.mdDoc ''
Declarative kernel config.
Kernels can be declared in any language that supports and has the required
dependencies to communicate with a jupyter server.
In python's case, it means that ipykernel package must always be included in
the list of packages of the targeted environment.
";
Kernels can be declared in any language that supports and has the required
dependencies to communicate with a jupyter server.
In python's case, it means that ipykernel package must always be included in
the list of packages of the targeted environment.
'';
};
};

2
nixos/modules/services/development/lorri.nix
View file

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

2
nixos/modules/services/editors/infinoted.nix
View file

@ -36,7 +36,7 @@ in {
certificateChain = mkOption {
type = types.nullOr types.path;
default = null;
description = ''
description = lib.mdDoc ''
Chain of CA-certificates to which our `certificateFile` is relative.
Optional for TLS.
'';

6
nixos/modules/services/games/asf.nix
View file

@ -81,11 +81,11 @@ in
settings = mkOption {
type = format.type;
description = ''
The ASF.json file, all the options are documented <link xlink:href="https://github.com/JustArchiNET/ArchiSteamFarm/wiki/Configuration#global-config">here</link>.
description = lib.mdDoc ''
The ASF.json file, all the options are documented [here](https://github.com/JustArchiNET/ArchiSteamFarm/wiki/Configuration#global-config).
Do note that `AutoRestart` and `UpdateChannel` is always to `false` respectively `0` because NixOS takes care of updating everything.
`Headless` is also always set to `true` because there is no way to provide inputs via a systemd service.
You should try to keep ASF up to date since upstream does not provide support for anything but the latest version and you're exposing yourself to all kinds of issues - as is outlined <link xlink:href="https://github.com/JustArchiNET/ArchiSteamFarm/wiki/Configuration#updateperiod">here</link>.
You should try to keep ASF up to date since upstream does not provide support for anything but the latest version and you're exposing yourself to all kinds of issues - as is outlined [here](https://github.com/JustArchiNET/ArchiSteamFarm/wiki/Configuration#updateperiod).
'';
example = {
Statistics = false;

4
nixos/modules/services/games/crossfire-server.nix
View file

@ -41,7 +41,7 @@ in {
stateDir = mkOption {
type = types.str;
default = "/var/lib/crossfire";
description = ''
description = lib.mdDoc ''
Where to store runtime data (save files, persistent items, etc).
If left at the default, this will be automatically created on server
@ -61,7 +61,7 @@ in {
configFiles = mkOption {
type = types.attrsOf types.str;
description = ''
description = lib.mdDoc ''
Text to append to the corresponding configuration files. Note that the
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

2
nixos/modules/services/games/deliantra-server.nix
View file

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

6
nixos/modules/services/games/minetest-server.nix
View file

@ -25,7 +25,7 @@ in
gameId = mkOption {
type = types.nullOr types.str;
default = null;
description = ''
description = lib.mdDoc ''
Id of the game to use. To list available games run
`minetestserver --gameid list`.
@ -36,7 +36,7 @@ in
world = mkOption {
type = types.nullOr types.path;
default = null;
description = ''
description = lib.mdDoc ''
Name of the world to use. To list available worlds run
`minetestserver --world list`.
@ -47,7 +47,7 @@ in
configPath = mkOption {
type = types.nullOr types.path;
default = null;
description = ''
description = lib.mdDoc ''
Path to the config to use.
If set to null, the config of the running user will be used:

8
nixos/modules/services/hardware/fwupd.nix
View file

@ -15,9 +15,9 @@ let
DisabledPlugins=${lib.concatStringsSep ";" cfg.disabledPlugins}
'';
};
"fwupd/uefi.conf" = {
source = pkgs.writeText "uefi.conf" ''
[uefi]
"fwupd/uefi_capsule.conf" = {
source = pkgs.writeText "uefi_capsule.conf" ''
[uefi_capsule]
OverrideESPMountPoint=${config.boot.loader.efi.efiSysMountPoint}
'';
};
@ -125,8 +125,6 @@ in {
services.udev.packages = [ cfg.package ];
services.udisks2.enable = true;
systemd.packages = [ cfg.package ];
};

4
nixos/modules/services/home-automation/home-assistant.nix
View file

@ -126,10 +126,10 @@ in {
psycopg2
];
'';
description = ''
description = lib.mdDoc ''
List of packages to add to propagatedBuildInputs.
A popular example is <package>python3Packages.psycopg2</package>
A popular example is `python3Packages.psycopg2`
for PostgreSQL support in the recorder component.
'';
};

4
nixos/modules/services/logging/logrotate.nix
View file

@ -79,7 +79,7 @@ let
priority = mkOption {
type = types.int;
default = 1000;
description = ''
description = lib.mdDoc ''
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.
'';
@ -260,7 +260,7 @@ in
priority = mkOption {
type = types.int;
default = 1000;
description = ''
description = lib.mdDoc ''
Order of this logrotate block in relation to the others. The semantics are
the same as with `lib.mkOrder`. Smaller values are inserted first.
'';

72
nixos/modules/services/mail/postfix.nix
View file

@ -355,125 +355,125 @@ in
setgidGroup = mkOption {
type = types.str;
default = "postdrop";
description = "
description = lib.mdDoc ''
How to call postfix setgid group (for postdrop). Should
be uniquely used group.
";
'';
};
networks = mkOption {
type = types.nullOr (types.listOf types.str);
default = null;
example = ["192.168.0.1/24"];
description = "
description = lib.mdDoc ''
Net masks for trusted - allowed to relay mail to third parties -
hosts. Leave empty to use mynetworks_style configuration or use
default (localhost-only).
";
'';
};
networksStyle = mkOption {
type = types.str;
default = "";
description = "
description = lib.mdDoc ''
Name of standard way of trusted network specification to use,
leave blank if you specify it explicitly or if you want to use
default (localhost-only).
";
'';
};
hostname = mkOption {
type = types.str;
default = "";
description ="
description = lib.mdDoc ''
Hostname to use. Leave blank to use just the hostname of machine.
It should be FQDN.
";
'';
};
domain = mkOption {
type = types.str;
default = "";
description ="
description = lib.mdDoc ''
Domain to use. Leave blank to use hostname minus first component.
";
'';
};
origin = mkOption {
type = types.str;
default = "";
description ="
description = lib.mdDoc ''
Origin to use in outgoing e-mail. Leave blank to use hostname.
";
'';
};
destination = mkOption {
type = types.nullOr (types.listOf types.str);
default = null;
example = ["localhost"];
description = "
description = lib.mdDoc ''
Full (!) list of domains we deliver locally. Leave blank for
acceptable Postfix default.
";
'';
};
relayDomains = mkOption {
type = types.nullOr (types.listOf types.str);
default = null;
example = ["localdomain"];
description = "
description = lib.mdDoc ''
List of domains we agree to relay to. Default is empty.
";
'';
};
relayHost = mkOption {
type = types.str;
default = "";
description = "
description = lib.mdDoc ''
Mail relay for outbound mail.
";
'';
};
relayPort = mkOption {
type = types.int;
default = 25;
description = "
description = lib.mdDoc ''
SMTP port for relay mail relay.
";
'';
};
lookupMX = mkOption {
type = types.bool;
default = false;
description = "
description = lib.mdDoc ''
Whether relay specified is just domain whose MX must be used.
";
'';
};
postmasterAlias = mkOption {
type = types.str;
default = "root";
description = "
description = lib.mdDoc ''
Who should receive postmaster e-mail. Multiple values can be added by
separating values with comma.
";
'';
};
rootAlias = mkOption {
type = types.str;
default = "";
description = "
description = lib.mdDoc ''
Who should receive root e-mail. Blank for no redirection.
Multiple values can be added by separating values with comma.
";
'';
};
extraAliases = mkOption {
type = types.lines;
default = "";
description = "
description = lib.mdDoc ''
Additional entries to put verbatim into aliases file, cf. man-page aliases(8).
";
'';
};
aliasMapType = mkOption {
@ -497,9 +497,9 @@ in
extraConfig = mkOption {
type = types.lines;
default = "";
description = "
description = lib.mdDoc ''
Extra lines to be added verbatim to the main.cf configuration file.
";
'';
};
tlsTrustedAuthorities = mkOption {
@ -527,9 +527,9 @@ in
type = types.str;
default = "";
example = "+";
description = "
description = lib.mdDoc ''
Delimiter for address extension: so mail to user+test can be handled by ~user/.forward+test
";
'';
};
canonical = mkOption {
@ -543,9 +543,9 @@ in
virtual = mkOption {
type = types.lines;
default = "";
description = "
description = lib.mdDoc ''
Entries for the virtual alias map, cf. man-page virtual(5).
";
'';
};
virtualMapType = mkOption {
@ -572,9 +572,9 @@ in
transport = mkOption {
default = "";
type = types.lines;
description = "
description = lib.mdDoc ''
Entries for the transport map, cf. man-page transport(8).
";
'';
};
dnsBlacklists = mkOption {

21
nixos/modules/services/matrix/dendrite.nix
View file

@ -26,24 +26,24 @@ in
type = lib.types.nullOr lib.types.path;
example = "/var/lib/dendrite/server.cert";
default = null;
description = ''
description = lib.mdDoc ''
The path to the TLS certificate.
<programlisting>
```
nix-shell -p dendrite --command "generate-keys --tls-cert server.crt --tls-key server.key"
</programlisting>
```
'';
};
tlsKey = lib.mkOption {
type = lib.types.nullOr lib.types.path;
example = "/var/lib/dendrite/server.key";
default = null;
description = ''
description = lib.mdDoc ''
The path to the TLS key.
<programlisting>
```
nix-shell -p dendrite --command "generate-keys --tls-cert server.crt --tls-key server.key"
</programlisting>
```
'';
};
environmentFile = lib.mkOption {
@ -51,8 +51,7 @@ in
example = "/var/lib/dendrite/registration_secret";
default = null;
description = ''
Environment file as defined in <citerefentry>
<refentrytitle>systemd.exec</refentrytitle><manvolnum>5</manvolnum></citerefentry>.
Environment file as defined in <citerefentry><refentrytitle>systemd.exec</refentrytitle><manvolnum>5</manvolnum></citerefentry>.
Secrets may be passed to the service without adding them to the world-readable
Nix store, by specifying placeholder variables as the option value in Nix and
setting these variables accordingly in the environment file. Currently only used
@ -103,13 +102,13 @@ in
lib.types.path
(lib.types.strMatching "^\\$CREDENTIALS_DIRECTORY/.+");
example = "$CREDENTIALS_DIRECTORY/private_key";
description = ''
description = lib.mdDoc ''
The path to the signing private key file, used to sign
requests and events.
<programlisting>
```
nix-shell -p dendrite --command "generate-keys --private-key matrix_key.pem"
</programlisting>
```
'';
};
trusted_third_party_id_servers = lib.mkOption {

2
nixos/modules/services/matrix/synapse.nix
View file

@ -516,7 +516,7 @@ in {
type = types.bool;
default = true;
example = false;
description = ''
description = lib.mdDoc ''
Is the preview URL API enabled? If enabled, you *must* specify an
explicit url_preview_ip_range_blacklist of IPs that the spider is
denied from accessing.

8
nixos/modules/services/misc/etebase-server.nix
View file

@ -133,10 +133,10 @@ in
};
};
default = {};
description = ''
Configuration for <package>etebase-server</package>. Refer to
<link xlink:href="https://github.com/etesync/server/blob/master/etebase-server.ini.example"/>
and <link xlink:href="https://github.com/etesync/server/wiki"/>
description = lib.mdDoc ''
Configuration for `etebase-server`. Refer to
<https://github.com/etesync/server/blob/master/etebase-server.ini.example>
and <https://github.com/etesync/server/wiki>
for details on supported values.
'';
example = {

4
nixos/modules/services/misc/exhibitor.nix
View file

@ -71,9 +71,9 @@ in
enable = mkOption {
type = types.bool;
default = false;
description = "
description = lib.mdDoc ''
Whether to enable the exhibitor server.
";
'';
};
# See https://github.com/soabase/exhibitor/wiki/Running-Exhibitor for what these mean
# General options for any type of config

10
nixos/modules/services/misc/freeswitch.nix
View file

@ -22,11 +22,11 @@ in {
enableReload = mkOption {
default = false;
type = types.bool;
description = ''
Issue the <literal>reloadxml</literal> command to FreeSWITCH when configuration directory changes (instead of restart).
See <link xlink:href="https://freeswitch.org/confluence/display/FREESWITCH/Reloading">FreeSWITCH documentation</link> for more info.
The configuration directory is exposed at <filename>/etc/freeswitch</filename>.
See also <literal>systemd.services.*.restartIfChanged</literal>.
description = lib.mdDoc ''
Issue the `reloadxml` command to FreeSWITCH when configuration directory changes (instead of restart).
See [FreeSWITCH documentation](https://freeswitch.org/confluence/display/FREESWITCH/Reloading) for more info.
The configuration directory is exposed at {file}`/etc/freeswitch`.
See also `systemd.services.*.restartIfChanged`.
'';
};
configTemplate = mkOption {

27
nixos/modules/services/misc/geoipupdate.nix
View file

@ -12,8 +12,7 @@ in
options = {
services.geoipupdate = {
enable = lib.mkEnableOption ''
periodic downloading of GeoIP databases using
<productname>geoipupdate</productname>.
periodic downloading of GeoIP databases using geoipupdate.
'';
interval = lib.mkOption {
@ -36,21 +35,20 @@ in
ProxyUserPassword = { _secret = "/run/keys/proxy_pass"; };
}
'';
description = ''
<productname>geoipupdate</productname> configuration
options. See
<link xlink:href="https://github.com/maxmind/geoipupdate/blob/main/doc/GeoIP.conf.md"/>
description = lib.mdDoc ''
geoipupdate configuration options. See
<https://github.com/maxmind/geoipupdate/blob/main/doc/GeoIP.conf.md>
for a full list of available options.
Settings containing secret data should be set to an
attribute set containing the attribute
<literal>_secret</literal> - a string pointing to a file
`_secret` - a string pointing to a file
containing the value the option should be set to. See the
example to get a better picture of this: in the resulting
<filename>GeoIP.conf</filename> file, the
<literal>ProxyUserPassword</literal> key will be set to the
{file}`GeoIP.conf` file, the
`ProxyUserPassword` key will be set to the
contents of the
<filename>/run/keys/proxy_pass</filename> file.
{file}`/run/keys/proxy_pass` file.
'';
type = lib.types.submodule {
freeformType =
@ -85,13 +83,12 @@ in
LicenseKey = lib.mkOption {
type = with lib.types; either path (attrsOf path);
description = ''
A file containing the
<productname>MaxMind</productname> license key.
description = lib.mdDoc ''
A file containing the MaxMind license key.
Always handled as a secret whether the value is
wrapped in a <literal>{ _secret = ...; }</literal>
attrset or not (refer to <xref linkend="opt-services.geoipupdate.settings"/> for
wrapped in a `{ _secret = ...; }`
attrset or not (refer to [](#opt-services.geoipupdate.settings) for
details).
'';
apply = x: if isAttrs x then x else { _secret = x; };

12
nixos/modules/services/misc/gitea.nix
View file

@ -183,7 +183,7 @@ in
file = mkOption {
type = types.nullOr types.str;
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";
};
};
@ -293,12 +293,12 @@ in
default = "${cfg.stateDir}/log";
defaultText = literalExpression ''"''${config.${opt.stateDir}}/log"'';
type = types.str;
description = "Root path for log files.";
description = lib.mdDoc "Root path for log files.";
};
LEVEL = mkOption {
default = "Info";
type = types.enum [ "Trace" "Debug" "Info" "Warn" "Error" "Critical" ];
description = "General log level.";
description = lib.mdDoc "General log level.";
};
};
@ -306,14 +306,14 @@ in
DISABLE_SSH = mkOption {
type = types.bool;
default = false;
description = "Disable external SSH feature.";
description = lib.mdDoc "Disable external SSH feature.";
};
SSH_PORT = mkOption {
type = types.int;
default = 22;
example = 2222;
description = ''
description = lib.mdDoc ''
SSH port displayed in clone URL.
The option is required to configure a service when the external visible port
differs from the local listening port i.e. if port forwarding is used.
@ -339,7 +339,7 @@ in
COOKIE_SECURE = mkOption {
type = types.bool;
default = false;
description = ''
description = lib.mdDoc ''
Marks session cookies as "secure" as a hint for browsers to only send
them via HTTPS. This option is recommend, if gitea is being served over HTTPS.
'';

14
nixos/modules/services/misc/gitlab.nix
View file

@ -338,10 +338,9 @@ in {
default = 0;
example = 48;
apply = x: x * 60 * 60;
description = ''
description = lib.mdDoc ''
How long to keep the backups around, in
hours. <literal>0</literal> means <quote>keep
forever</quote>.
hours. `0` means “keep forever”.
'';
};
@ -415,9 +414,9 @@ in {
databaseHost = mkOption {
type = types.str;
default = "";
description = ''
GitLab database hostname. An empty string means <quote>use
local unix socket connection</quote>.
description = lib.mdDoc ''
GitLab database hostname. An empty string means
“use local unix socket connection”.
'';
};
@ -752,8 +751,7 @@ in {
description = ''
The number of worker processes Puma should spawn. This
controls the amount of parallel Ruby code can be
executed. GitLab recommends <quote>Number of CPU cores -
1</quote>, but at least two.
executed. GitLab recommends <literal>Number of CPU cores - 1</literal>, but at least two.
<note>
<para>

25
nixos/modules/services/misc/gitolite.nix
View file

@ -14,12 +14,11 @@ in
enable = mkOption {
type = types.bool;
default = false;
description = ''
description = lib.mdDoc ''
Enable gitolite management under the
<literal>gitolite</literal> user. After
`gitolite` user. After
switching to a configuration with Gitolite enabled, you can
then run <literal>git clone
gitolite@host:gitolite-admin.git</literal> to manage it further.
then run `git clone gitolite@host:gitolite-admin.git` to manage it further.
'';
};
@ -72,25 +71,25 @@ in
@{$RC{ENABLE}} = grep { $_ ne 'desc' } @{$RC{ENABLE}}; # disable the command/feature
'''
'';
description = ''
Extra configuration to append to the default <literal>~/.gitolite.rc</literal>.
description = lib.mdDoc ''
Extra configuration to append to the default `~/.gitolite.rc`.
This should be Perl code that modifies the <literal>%RC</literal>
configuration variable. The default <literal>~/.gitolite.rc</literal>
content is generated by invoking <literal>gitolite print-default-rc</literal>,
This should be Perl code that modifies the `%RC`
configuration variable. The default `~/.gitolite.rc`
content is generated by invoking `gitolite print-default-rc`,
and extra configuration from this option is appended to it. The result
is placed to Nix store, and the <literal>~/.gitolite.rc</literal> file
is placed to Nix store, and the `~/.gitolite.rc` file
becomes a symlink to it.
If you already have a customized (or otherwise changed)
<literal>~/.gitolite.rc</literal> file, NixOS will refuse to replace
`~/.gitolite.rc` file, NixOS will refuse to replace
it with a symlink, and the `gitolite-init` initialization service
will fail. In this situation, in order to use this option, you
will need to take any customizations you may have in
<literal>~/.gitolite.rc</literal>, convert them to appropriate Perl
`~/.gitolite.rc`, convert them to appropriate Perl
statements, add them to this option, and remove the file.
See also the <literal>enableGitAnnex</literal> option.
See also the `enableGitAnnex` option.
'';
};

2
nixos/modules/services/misc/klipper.nix
View file

@ -82,7 +82,7 @@ in
'';
configFile = mkOption {
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`";
};
};
});

20
nixos/modules/services/misc/nix-daemon.nix
View file

@ -264,7 +264,7 @@ in
type = types.nullOr types.str;
default = null;
example = "/root/.ssh/id_buildhost_builduser";
description = ''
description = lib.mdDoc ''
The path to the SSH private key with which to authenticate on
the build machine. The private key must not have a passphrase.
If null, the building user (root on NixOS machines) must have an
@ -562,13 +562,13 @@ in
trusted-public-keys = mkOption {
type = types.listOf types.str;
example = [ "hydra.nixos.org-1:CNHJZBh9K4tP3EKF6FkkgeVYsS3ohTl+oS0Qa8bezVs=" ];
description = ''
description = lib.mdDoc ''
List of public keys used to sign binary caches. If
<option>nix.settings.trusted-public-keys</option> is enabled,
{option}`nix.settings.trusted-public-keys` is enabled,
then Nix will use a binary from a binary cache if and only
if it is signed by <emphasis>any</emphasis> of the keys
if it is signed by *any* of the keys
listed here. By default, only the key for
<uri>cache.nixos.org</uri> is included.
`cache.nixos.org` is included.
'';
};
@ -605,13 +605,13 @@ in
type = types.listOf types.str;
default = [ "*" ];
example = [ "@wheel" "@builders" "alice" "bob" ];
description = ''
description = lib.mdDoc ''
A list of names of users (separated by whitespace) that are
allowed to connect to the Nix daemon. As with
<option>nix.settings.trusted-users</option>, you can specify groups by
prefixing them with <literal>@</literal>. Also, you can
allow all users by specifying <literal>*</literal>. The
default is <literal>*</literal>. Note that trusted users are
{option}`nix.settings.trusted-users`, you can specify groups by
prefixing them with `@`. Also, you can
allow all users by specifying `*`. The
default is `*`. Note that trusted users are
always allowed to connect.
'';
};

2
nixos/modules/services/misc/rmfakecloud.nix
View file

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

2
nixos/modules/services/misc/zoneminder.nix
View file

@ -80,7 +80,7 @@ in {
webserver = mkOption {
type = types.enum [ "nginx" "none" ];
default = "nginx";
description = ''
description = lib.mdDoc ''
The webserver to configure for the PHP frontend.
Set it to `none` if you want to configure it yourself. PRs are welcome

2
nixos/modules/services/monitoring/collectd.nix
View file

@ -52,7 +52,7 @@ in {
buildMinimalPackage = mkOption {
default = false;
description = ''
description = lib.mdDoc ''
Build a minimal collectd package with only the configured `services.collectd.plugins`
'';
type = bool;

4
nixos/modules/services/monitoring/datadog-agent.nix
View file

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

4
nixos/modules/services/monitoring/grafana-agent.nix
View file

@ -38,8 +38,8 @@ in
};
settings = mkOption {
description = ''
Configuration for <package>grafana-agent</package>.
description = lib.mdDoc ''
Configuration for `grafana-agent`.
See https://grafana.com/docs/agent/latest/configuration/
'';

12
nixos/modules/services/monitoring/grafana-image-renderer.nix
View file

@ -63,7 +63,7 @@ in {
default = "default";
type = types.enum [ "default" "reusable" "clustered" ];
description = ''
Rendering mode of <package>grafana-image-renderer</package>:
Rendering mode of <literal>grafana-image-renderer</literal>:
<itemizedlist>
<listitem><para><literal>default:</literal> Creates on browser-instance
per rendering request.</para></listitem>
@ -79,8 +79,8 @@ in {
args = mkOption {
type = types.listOf types.str;
default = [ "--no-sandbox" ];
description = ''
List of CLI flags passed to <package>chromium</package>.
description = lib.mdDoc ''
List of CLI flags passed to `chromium`.
'';
};
};
@ -89,10 +89,10 @@ in {
default = {};
description = ''
Configuration attributes for <package>grafana-image-renderer</package>.
description = lib.mdDoc ''
Configuration attributes for `grafana-image-renderer`.
See <link xlink:href="https://github.com/grafana/grafana-image-renderer/blob/ce1f81438e5f69c7fd7c73ce08bab624c4c92e25/default.json"/>
See <https://github.com/grafana/grafana-image-renderer/blob/ce1f81438e5f69c7fd7c73ce08bab624c4c92e25/default.json>
for supported values.
'';
};

4
nixos/modules/services/monitoring/mackerel-agent.nix
View file

@ -20,11 +20,11 @@ in {
apiKeyFile = mkOption {
type = types.path;
example = "/run/keys/mackerel-api-key";
description = ''
description = lib.mdDoc ''
Path to file containing the Mackerel API key. The file should contain a
single line of the following form:
<literallayout>apikey = "EXAMPLE_API_KEY"</literallayout>
`apikey = "EXAMPLE_API_KEY"`
'';
};

22
nixos/modules/services/monitoring/nagios.nix
View file

@ -91,11 +91,11 @@ in
enable = mkEnableOption ''<link xlink:href="http://www.nagios.org/">Nagios</link> to monitor your system or network.'';
objectDefs = mkOption {
description = "
description = lib.mdDoc ''
A list of Nagios object configuration files that must define
the hosts, host groups, services and contacts for the
network that you want Nagios to monitor.
";
'';
type = types.listOf types.path;
example = literalExpression "[ ./objects.cfg ]";
};
@ -104,18 +104,18 @@ in
type = types.listOf types.package;
default = with pkgs; [ monitoring-plugins msmtp mailutils ];
defaultText = literalExpression "[pkgs.monitoring-plugins pkgs.msmtp pkgs.mailutils]";
description = "
description = ''
Packages to be added to the Nagios <envar>PATH</envar>.
Typically used to add plugins, but can be anything.
";
'';
};
mainConfigFile = mkOption {
type = types.nullOr types.package;
default = null;
description = "
description = lib.mdDoc ''
If non-null, overrides the main configuration file of Nagios.
";
'';
};
extraConfig = mkOption {
@ -139,19 +139,19 @@ in
type = types.package;
default = nagiosCGICfgFile;
defaultText = literalExpression "nagiosCGICfgFile";
description = "
description = lib.mdDoc ''
Derivation for the configuration file of Nagios CGI scripts
that can be used in web servers for running the Nagios web interface.
";
'';
};
enableWebInterface = mkOption {
type = types.bool;
default = false;
description = "
description = lib.mdDoc ''
Whether to enable the Nagios web interface. You should also
enable Apache (<option>services.httpd.enable</option>).
";
enable Apache ({option}`services.httpd.enable`).
'';
};
virtualHost = mkOption {

17
nixos/modules/services/monitoring/prometheus/default.nix
View file

@ -251,7 +251,7 @@ let
authorization = mkOption {
type = types.nullOr types.attrs;
default = null;
description = ''
description = lib.mdDoc ''
Sets the `Authorization` header on every scrape request with the configured credentials.
'';
};
@ -664,7 +664,7 @@ let
promTypes.dockerswarm_sd_config = mkDockerSdConfigModule {
role = mkOption {
type = types.enum [ "services" "tasks" "nodes" ];
description = ''
description = lib.mdDoc ''
Role of the targets to retrieve. Must be `services`, `tasks`, or `nodes`.
'';
};
@ -1222,7 +1222,7 @@ let
role = mkOption {
type = types.enum [ "instance" "baremetal" ];
description = ''
description = lib.mdDoc ''
Role of the targets to retrieve. Must be `instance` or `baremetal`.
'';
};
@ -1729,16 +1729,15 @@ in
type = with types; either bool (enum [ "syntax-only" ]);
default = true;
example = "syntax-only";
description = ''
Check configuration with <literal>promtool
check</literal>. The call to <literal>promtool</literal> is
description = lib.mdDoc ''
Check configuration with `promtool check`. The call to `promtool` is
subject to sandboxing by Nix.
If you use credentials stored in external files
(<literal>password_file</literal>, <literal>bearer_token_file</literal>, etc),
they will not be visible to <literal>promtool</literal>
(`password_file`, `bearer_token_file`, etc),
they will not be visible to `promtool`
and it will report errors, despite a correct configuration.
To resolve this, you may set this option to <literal>"syntax-only"</literal>
To resolve this, you may set this option to `"syntax-only"`
in order to only syntax check the Prometheus configuration.
'';
};

8
nixos/modules/services/monitoring/prometheus/exporters/dovecot.nix
View file

@ -33,10 +33,10 @@ in
work with this exporter:
<programlisting>
{
<xref linkend="opt-services.prometheus.exporters.dovecot.enable"/> = true;
<xref linkend="opt-services.prometheus.exporters.dovecot.socketPath"/> = "/var/run/dovecot2/old-stats";
<xref linkend="opt-services.dovecot2.mailPlugins.globally.enable"/> = [ "old_stats" ];
<xref linkend="opt-services.dovecot2.extraConfig"/> = '''
services.prometheus.exporters.dovecot.enable = true;
services.prometheus.exporters.dovecot.socketPath = "/var/run/dovecot2/old-stats";
services.dovecot2.mailPlugins.globally.enable = [ "old_stats" ];
services.dovecot2.extraConfig = '''
service old-stats {
unix_listener old-stats {
user = dovecot-exporter

4
nixos/modules/services/monitoring/prometheus/exporters/knot.nix
View file

@ -11,8 +11,8 @@ in {
type = types.str;
default = "${pkgs.knot-dns.out}/lib/libknot.so";
defaultText = literalExpression ''"''${pkgs.knot-dns.out}/lib/libknot.so"'';
description = ''
Path to the library of <package>knot-dns</package>.
description = lib.mdDoc ''
Path to the library of `knot-dns`.
'';
};

2
nixos/modules/services/monitoring/prometheus/exporters/mail.nix
View file

@ -121,7 +121,7 @@ let
It's possible to work around the issue with a config like this:
<programlisting>
{
<link linkend="opt-services.rspamd.locals._name_.text">services.rspamd.locals."multimap.conf".text</link> = '''
services.rspamd.locals."multimap.conf".text = '''
ALLOWLIST_PROMETHEUS {
filter = "email:domain:tld";
type = "from";

2
nixos/modules/services/monitoring/prometheus/exporters/nginxlog.nix
View file

@ -10,7 +10,7 @@ in {
settings = mkOption {
type = types.attrs;
default = {};
description = ''
description = lib.mdDoc ''
All settings of nginxlog expressed as an Nix attrset.
Check the official documentation for the corresponding YAML

10
nixos/modules/services/monitoring/prometheus/exporters/openldap.nix
View file

@ -12,7 +12,7 @@ in {
example = "/run/keys/ldap_pass";
description = ''
Environment file to contain the credentials to authenticate against
<package>openldap</package>.
<literal>openldap</literal>.
The file should look like this:
<programlisting>
@ -26,15 +26,15 @@ in {
default = "tcp";
example = "udp";
type = types.str;
description = ''
Which protocol to use to connect against <package>openldap</package>.
description = lib.mdDoc ''
Which protocol to use to connect against `openldap`.
'';
};
ldapAddr = mkOption {
default = "localhost:389";
type = types.str;
description = ''
Address of the <package>openldap</package>-instance.
description = lib.mdDoc ''
Address of the `openldap`-instance.
'';
};
metricsPath = mkOption {

2
nixos/modules/services/monitoring/riemann-tools.nix
View file

@ -37,7 +37,7 @@ in {
extraArgs = mkOption {
type = types.listOf types.str;
default = [];
description = ''
description = lib.mdDoc ''
A list of commandline-switches forwarded to a riemann-tool.
See for example `riemann-health --help` for available options.
'';

6
nixos/modules/services/network-filesystems/xtreemfs.nix
View file

@ -111,7 +111,7 @@ in
uuid = mkOption {
example = "eacb6bab-f444-4ebf-a06a-3f72d7465e40";
type = types.str;
description = ''
description = lib.mdDoc ''
Must be set to a unique identifier, preferably a UUID according to
RFC 4122. UUIDs can be generated with `uuidgen` command, found in
the `util-linux` package.
@ -236,7 +236,7 @@ in
uuid = mkOption {
example = "eacb6bab-f444-4ebf-a06a-3f72d7465e41";
type = types.str;
description = ''
description = lib.mdDoc ''
Must be set to a unique identifier, preferably a UUID according to
RFC 4122. UUIDs can be generated with `uuidgen` command, found in
the `util-linux` package.
@ -379,7 +379,7 @@ in
uuid = mkOption {
example = "eacb6bab-f444-4ebf-a06a-3f72d7465e42";
type = types.str;
description = ''
description = lib.mdDoc ''
Must be set to a unique identifier, preferably a UUID according to
RFC 4122. UUIDs can be generated with `uuidgen` command, found in
the `util-linux` package.

4
nixos/modules/services/network-filesystems/yandex-disk.nix
View file

@ -23,9 +23,9 @@ in
enable = mkOption {
type = types.bool;
default = false;
description = "
description = lib.mdDoc ''
Whether to enable Yandex-disk client. See https://disk.yandex.ru/
";
'';
};
username = mkOption {

40
nixos/modules/services/networking/bind.nix
View file

@ -117,62 +117,62 @@ in
cacheNetworks = mkOption {
default = [ "127.0.0.0/24" ];
type = types.listOf types.str;
description = "
description = lib.mdDoc ''
What networks are allowed to use us as a resolver. Note
that this is for recursive queries -- all networks are
allowed to query zones configured with the `zones` option.
It is recommended that you limit cacheNetworks to avoid your
server being used for DNS amplification attacks.
";
'';
};
blockedNetworks = mkOption {
default = [ ];
type = types.listOf types.str;
description = "
description = lib.mdDoc ''
What networks are just blocked.
";
'';
};
ipv4Only = mkOption {
default = false;
type = types.bool;
description = "
description = lib.mdDoc ''
Only use ipv4, even if the host supports ipv6.
";
'';
};
forwarders = mkOption {
default = config.networking.nameservers;
defaultText = literalExpression "config.networking.nameservers";
type = types.listOf types.str;
description = "
description = lib.mdDoc ''
List of servers we should forward requests to.
";
'';
};
forward = mkOption {
default = "first";
type = types.enum ["first" "only"];
description = "
description = lib.mdDoc ''
Whether to forward 'first' (try forwarding but lookup directly if forwarding fails) or 'only'.
";
'';
};
listenOn = mkOption {
default = [ "any" ];
type = types.listOf types.str;
description = "
description = lib.mdDoc ''
Interfaces to listen on.
";
'';
};
listenOnIpv6 = mkOption {
default = [ "any" ];
type = types.listOf types.str;
description = "
description = lib.mdDoc ''
Ipv6 interfaces to listen on.
";
'';
};
directory = mkOption {
@ -184,9 +184,9 @@ in
zones = mkOption {
default = [ ];
type = with types; coercedTo (listOf attrs) bindZoneCoerce (attrsOf (types.submodule bindZoneOptions));
description = "
description = lib.mdDoc ''
List of zones we claim authority over.
";
'';
example = {
"example.com" = {
master = false;
@ -201,9 +201,9 @@ in
extraConfig = mkOption {
type = types.lines;
default = "";
description = "
description = lib.mdDoc ''
Extra lines to be added verbatim to the generated named configuration file.
";
'';
};
extraOptions = mkOption {
@ -219,10 +219,10 @@ in
type = types.path;
default = confFile;
defaultText = literalExpression "confFile";
description = "
description = lib.mdDoc ''
Overridable config file to use for named. By default, that
generated by nixos.
";
'';
};
};

2
nixos/modules/services/networking/cloudflare-dyndns.nix
View file

@ -13,7 +13,7 @@ in
apiTokenFile = mkOption {
type = types.nullOr types.str;
default = null;
description = ''
description = lib.mdDoc ''
The path to a file containing the CloudFlare API token.
The file must have the form `CLOUDFLARE_API_TOKEN=...`

6
nixos/modules/services/networking/create_ap.nix
View file

@ -12,9 +12,9 @@ in {
settings = mkOption {
type = with types; attrsOf (oneOf [ int bool str ]);
default = {};
description = ''
Configuration for <package>create_ap</package>.
See <link xlink:href="https://raw.githubusercontent.com/lakinduakash/linux-wifi-hotspot/master/src/scripts/create_ap.conf">upstream example configuration</link>
description = lib.mdDoc ''
Configuration for `create_ap`.
See [upstream example configuration](https://raw.githubusercontent.com/lakinduakash/linux-wifi-hotspot/master/src/scripts/create_ap.conf)
for supported values.
'';
example = {

2
nixos/modules/services/networking/dhcpcd.nix
View file

@ -155,7 +155,7 @@ in
type = types.lines;
default = "";
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
`man dhcpcd-run-hooks` for details on what is possible.
'';

2
nixos/modules/services/networking/ferm.nix
View file

@ -20,7 +20,7 @@ in {
enable = mkOption {
default = false;
type = types.bool;
description = ''
description = lib.mdDoc ''
Whether to enable Ferm Firewall.
*Warning*: Enabling this service WILL disable the existing NixOS
firewall! Default firewall rules provided by packages are not

46
nixos/modules/services/networking/firefox-syncserver.nix
View file

@ -55,7 +55,7 @@ in
type = lib.types.package;
default = pkgs.syncstorage-rs;
defaultText = lib.literalExpression "pkgs.syncstorage-rs";
description = ''
description = lib.mdDoc ''
Package to use.
'';
};
@ -66,16 +66,16 @@ in
# behavior ever change.
type = lib.types.strMatching "[a-z_][a-z0-9_]*";
default = defaultDatabase;
description = ''
description = lib.mdDoc ''
Database to use for storage. Will be created automatically if it does not exist
and <literal>config.${opt.database.createLocally}</literal> is set.
and `config.${opt.database.createLocally}` is set.
'';
};
database.user = lib.mkOption {
type = lib.types.str;
default = defaultUser;
description = ''
description = lib.mdDoc ''
Username for database connections.
'';
};
@ -83,8 +83,8 @@ in
database.host = lib.mkOption {
type = lib.types.str;
default = "localhost";
description = ''
Database host name. <literal>localhost</literal> is treated specially and inserts
description = lib.mdDoc ''
Database host name. `localhost` is treated specially and inserts
systemd dependencies, other hostnames or IP addresses of the local machine do not.
'';
};
@ -92,7 +92,7 @@ in
database.createLocally = lib.mkOption {
type = lib.types.bool;
default = true;
description = ''
description = lib.mdDoc ''
Whether to create database and user on the local machine if they do not exist.
This includes enabling unix domain socket authentication for the configured user.
'';
@ -101,19 +101,19 @@ in
logLevel = lib.mkOption {
type = lib.types.str;
default = "error";
description = ''
Log level to run with. This can be a simple log level like <literal>error</literal>
or <literal>trace</literal>, or a more complicated logging expression.
description = lib.mdDoc ''
Log level to run with. This can be a simple log level like `error`
or `trace`, or a more complicated logging expression.
'';
};
secrets = lib.mkOption {
type = lib.types.path;
description = ''
description = lib.mdDoc ''
A file containing the various secrets. Should be in the format expected by systemd's
<literal>EnvironmentFile</literal> directory. Two secrets are currently available:
<literal>SYNC_MASTER_SECRET</literal> and
<literal>SYNC_TOKENSERVER__FXA_METRICS_HASH_SECRET</literal>.
`EnvironmentFile` directory. Two secrets are currently available:
`SYNC_MASTER_SECRET` and
`SYNC_TOKENSERVER__FXA_METRICS_HASH_SECRET`.
'';
};
@ -126,7 +126,7 @@ in
hostname = lib.mkOption {
type = lib.types.str;
description = ''
description = lib.mdDoc ''
Host name to use for this service.
'';
};
@ -134,7 +134,7 @@ in
capacity = lib.mkOption {
type = lib.types.ints.unsigned;
default = 10;
description = ''
description = lib.mdDoc ''
How many sync accounts are allowed on this server. Setting this value
equal to or less than the number of currently active accounts will
effectively deny service to accounts not yet registered here.
@ -147,7 +147,7 @@ in
defaultText = lib.literalExpression ''
''${if cfg.singleNode.enableTLS then "https" else "http"}://''${config.${opt.singleNode.hostname}}
'';
description = ''
description = lib.mdDoc ''
URL of the host. If you are not using the automatic webserver proxy setup you will have
to change this setting or your sync server may not be functional.
'';
@ -162,7 +162,7 @@ in
port = lib.mkOption {
type = lib.types.port;
default = 5000;
description = ''
description = lib.mdDoc ''
Port to bind to.
'';
};
@ -170,21 +170,21 @@ in
tokenserver.enabled = lib.mkOption {
type = lib.types.bool;
default = true;
description = ''
description = lib.mdDoc ''
Whether to enable the token service as well.
'';
};
};
};
default = { };
description = ''
description = lib.mdDoc ''
Settings for the sync server. These take priority over values computed
from NixOS options.
See the doc comments on the <literal>Settings</literal> structs in
<link xlink:href="https://github.com/mozilla-services/syncstorage-rs/blob/master/syncstorage/src/settings.rs" />
See the doc comments on the `Settings` structs in
<https://github.com/mozilla-services/syncstorage-rs/blob/master/syncstorage/src/settings.rs>
and
<link xlink:href="https://github.com/mozilla-services/syncstorage-rs/blob/master/syncstorage/src/tokenserver/settings.rs" />
<https://github.com/mozilla-services/syncstorage-rs/blob/master/syncstorage/src/tokenserver/settings.rs>
for available options.
'';
};

2
nixos/modules/services/networking/fireqos.nix
View file

@ -10,7 +10,7 @@ in {
enable = mkOption {
type = types.bool;
default = false;
description = ''
description = lib.mdDoc ''
If enabled, FireQOS will be launched with the specified
configuration given in `config`.
'';

6
nixos/modules/services/networking/ghostunnel.nix
View file

@ -37,12 +37,12 @@ let
};
keystore = mkOption {
description = ''
description = lib.mdDoc ''
Path to keystore (combined PEM with cert/key, or PKCS12 keystore).
NB: storepass is not supported because it would expose credentials via <literal>/proc/*/cmdline</literal>.
NB: storepass is not supported because it would expose credentials via `/proc/*/cmdline`.
Specify this or <literal>cert</literal> and <literal>key</literal>.
Specify this or `cert` and `key`.
'';
type = types.nullOr types.str;
default = null;

2
nixos/modules/services/networking/gnunet.nix
View file

@ -123,7 +123,7 @@ in
extraOptions = mkOption {
type = types.lines;
default = "";
description = ''
description = lib.mdDoc ''
Additional options that will be copied verbatim in `gnunet.conf'.
See `gnunet.conf(5)' for details.
'';

2
nixos/modules/services/networking/headscale.nix
View file

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

4
nixos/modules/services/networking/hylafax/options.nix
View file

@ -235,9 +235,9 @@ in
InternationalPrefix = "00";
LongDistancePrefix = "0";
};
description = ''
description = lib.mdDoc ''
Attribute set of default values for
modem config files <filename>etc/config.*</filename>.
modem config files {file}`etc/config.*`.
${commonDescr}
Think twice before changing
paths of fax-processing scripts.

32
nixos/modules/services/networking/ircd-hybrid/default.nix
View file

@ -41,69 +41,69 @@ in
serverName = mkOption {
default = "hades.arpa";
type = types.str;
description = "
description = lib.mdDoc ''
IRCD server name.
";
'';
};
sid = mkOption {
default = "0NL";
type = types.str;
description = "
description = lib.mdDoc ''
IRCD server unique ID in a net of servers.
";
'';
};
description = mkOption {
default = "Hybrid-7 IRC server.";
type = types.str;
description = "
description = lib.mdDoc ''
IRCD server description.
";
'';
};
rsaKey = mkOption {
default = null;
example = literalExpression "/root/certificates/irc.key";
type = types.nullOr types.path;
description = "
description = lib.mdDoc ''
IRCD server RSA key.
";
'';
};
certificate = mkOption {
default = null;
example = literalExpression "/root/certificates/irc.pem";
type = types.nullOr types.path;
description = "
description = lib.mdDoc ''
IRCD server SSL certificate. There are some limitations - read manual.
";
'';
};
adminEmail = mkOption {
default = "<bit-bucket@example.com>";
type = types.str;
example = "<name@domain.tld>";
description = "
description = lib.mdDoc ''
IRCD server administrator e-mail.
";
'';
};
extraIPs = mkOption {
default = [];
example = ["127.0.0.1"];
type = types.listOf types.str;
description = "
description = lib.mdDoc ''
Extra IP's to bind.
";
'';
};
extraPort = mkOption {
default = "7117";
type = types.str;
description = "
description = lib.mdDoc ''
Extra port to avoid filtering.
";
'';
};
};

2
nixos/modules/services/networking/iscsi/root-initiator.nix
View file

@ -77,7 +77,7 @@ in
};
extraConfigFile = mkOption {
description = ''
description = lib.mdDoc ''
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
in the initrd, see: `boot.initrd.secrets`.

4
nixos/modules/services/networking/kresd.nix
View file

@ -59,9 +59,9 @@ in {
};
package = mkOption {
type = types.package;
description = "
description = lib.mdDoc ''
knot-resolver package to use.
";
'';
default = pkgs.knot-resolver;
defaultText = literalExpression "pkgs.knot-resolver";
example = literalExpression "pkgs.knot-resolver.override { extraFeatures = true; }";

2
nixos/modules/services/networking/lokinet.nix
View file

@ -95,7 +95,7 @@ in with lib; {
network.exit-node = [ "example.loki" "example2.loki" ];
}
'';
description = ''
description = lib.mdDoc ''
Configuration for Lokinet.
Currently, the best way to view the available settings is by
generating a config file using `lokinet -g`.

2
nixos/modules/services/networking/monero.nix
View file

@ -181,7 +181,7 @@ in
exclusiveNodes = mkOption {
type = types.listOf types.str;
default = [ ];
description = ''
description = lib.mdDoc ''
List of peer IP addresses to connect to *only*.
If given the other peer options will be ignored.
'';

2
nixos/modules/services/networking/murmur.nix
View file

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

4
nixos/modules/services/networking/mxisd.nix
View file

@ -49,9 +49,9 @@ in {
environmentFile = mkOption {
type = types.nullOr types.str;
default = null;
description = ''
description = lib.mdDoc ''
Path to an environment-file which may contain secrets to be
substituted via <package>envsubst</package>.
substituted via `envsubst`.
'';
};

2
nixos/modules/services/networking/nar-serve.nix
View file

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

4
nixos/modules/services/networking/ncdns.nix
View file

@ -126,7 +126,7 @@ in
description = ''
Path to the file containing the KSK public key.
The key can be generated using the <literal>dnssec-keygen</literal>
command, provided by the package <package>bind</package> as follows:
command, provided by the package <literal>bind</literal> as follows:
<programlisting>
$ dnssec-keygen -a RSASHA256 -3 -b 2048 -f KSK bit
</programlisting>
@ -147,7 +147,7 @@ in
description = ''
Path to the file containing the ZSK public key.
The key can be generated using the <literal>dnssec-keygen</literal>
command, provided by the package <package>bind</package> as follows:
command, provided by the package <literal>bind</literal> as follows:
<programlisting>
$ dnssec-keygen -a RSASHA256 -3 -b 2048 bit
</programlisting>

4
nixos/modules/services/networking/nix-serve.nix
View file

@ -39,9 +39,9 @@ in
The path to the file used for signing derivation data.
Generate with:
```
<programlisting>
nix-store --generate-binary-cache-key key-name secret-key-file public-key-file
```
</programlisting>
For more details see <citerefentry><refentrytitle>nix-store</refentrytitle><manvolnum>1</manvolnum></citerefentry>.
'';

2
nixos/modules/services/networking/nixops-dns.nix
View file

@ -40,7 +40,7 @@ in
dnsmasq = mkOption {
type = types.bool;
default = true;
description = ''
description = lib.mdDoc ''
Enable dnsmasq forwarding to nixops-dns. This allows to use
nixops-dns for `services.nixops-dns.domain` resolution
while forwarding the rest of the queries to original resolvers.

Some files were not shown because too many files have changed in this diff Show more