···

       
112
       
112
       
 
       
2. Check out the target _release branch_, e.g. `release-22.11`. Do not use a _channel branch_ like `nixos-22.11` or `nixpkgs-22.11-darwin`.

     

       
113
       
113
       
 
       
3. Create a branch for your change, e.g. `git checkout -b backport`.

     

       
114
       
114
       
 
       
4. When the reason to backport is not obvious from the original commit message, use `git cherry-pick -xe <original commit>` and add a reason. Otherwise use `git cherry-pick -x <original commit>`. That's fine for minor version updates that only include security and bug fixes, commits that fixes an otherwise broken package or similar. Please also ensure the commits exists on the master branch; in the case of squashed or rebased merges, the commit hash will change and the new commits can be found in the merge message at the bottom of the master pull request.

     

       
115
       
115
       
-
       
5. Push to GitHub and open a backport pull request. Make sure to select the release branch (e.g. `release-22.11`) as the target branch of the pull request, and link to the pull request in which the original change was comitted to `master`. The pull request title should be the commit title with the release version as prefix, e.g. `[22.11]`.

     

       
115
       
115
       
+
       
5. Push to GitHub and open a backport pull request. Make sure to select the release branch (e.g. `release-22.11`) as the target branch of the pull request, and link to the pull request in which the original change was committed to `master`. The pull request title should be the commit title with the release version as prefix, e.g. `[22.11]`.

     

       
116
       
116
       
 
       
6. When the backport pull request is merged and you have the necessary privileges you can also replace the label `9.needs: port to stable` with `8.has: port to stable` on the original pull request. This way maintainers can keep track of missing backports easier.

     

       
117
       
117
       
 
       


     

       
118
       
118
       
 
       
## Criteria for Backporting changes

     

···

       
185
       
185
       
 
       
##### Comments

     

       
186
       
186
       
 
       
```

     

       
187
       
187
       
 
       


     

       
188
       
188
       
-
       
## Individual maintainer list {#reviewing-contributions-indvidual-maintainer-list}

     

       
188
       
188
       
+
       
## Individual maintainer list {#reviewing-contributions-individual-maintainer-list}

     

       
189
       
189
       
 
       


     

       
190
       
190
       
 
       
When adding users to `maintainers/maintainer-list.nix`, the following

     

       
191
       
191
       
 
       
checks should be performed:

     

···

       
1
       
1
       
-
       
# Generates the documentation for library functons via nixdoc. To add

     

       
1
       
1
       
+
       
# Generates the documentation for library functions via nixdoc. To add

     

       
2
       
2
       
 
       
# another library function file to this list, the include list in the

     

       
3
       
3
       
 
       
# file `doc/functions/library.xml` must also be updated.

     

       
4
       
4
       
 
       


     

···

       
93
       
93
       
 
       
- run `mix2nix > mix_deps.nix` in the upstream repo.

     

       
94
       
94
       
 
       
- pass `mixNixDeps = with pkgs; import ./mix_deps.nix { inherit lib beamPackages; };` as an argument to mixRelease.

     

       
95
       
95
       
 
       


     

       
96
       
96
       
-
       
If there are git depencencies.

     

       
96
       
96
       
+
       
If there are git dependencies.

     

       
97
       
97
       
 
       


     

       
98
       
98
       
 
       
- You'll need to fix the version artificially in mix.exs and regenerate the mix.lock with fixed version (on upstream). This will enable you to run `mix2nix > mix_deps.nix`.

     

       
99
       
99
       
 
       
- From the mix_deps.nix file, remove the dependencies that had git versions and pass them as an override to the import function.

     

···

       
8
       
8
       
 
       
* `customOCamlPackages` (optional, defaults to `null`, which lets Coq choose a version automatically), which can be set to any of the ocaml packages attribute of `ocaml-ng` (such as `ocaml-ng.ocamlPackages_4_10` which is the default for Coq 8.11 for example).

     

       
9
       
9
       
 
       
* `coq-version` (optional, defaults to the short version e.g. "8.10"), is a version number of the form "x.y" that indicates which Coq's version build behavior to mimic when using a source which is not a release. E.g. `coq.override { version = "d370a9d1328a4e1cdb9d02ee032f605a9d94ec7a"; coq-version = "8.10"; }`.

     

       
10
       
10
       
 
       


     

       
11
       
11
       
-
       
The associated package set can be optained using `mkCoqPackages coq`, where `coq` is the derivation to use.

     

       
11
       
11
       
+
       
The associated package set can be obtained using `mkCoqPackages coq`, where `coq` is the derivation to use.

     

       
12
       
12
       
 
       


     

       
13
       
13
       
 
       
## Coq packages attribute sets: `coqPackages` {#coq-packages-attribute-sets-coqpackages}

     

       
14
       
14
       
 
       


     

···

       
38
       
38
       
 
       


     

       
39
       
39
       
 
       
Nixpkgs tries to target support real architecture defaults based on the

     

       
40
       
40
       
 
       
CUDA toolkit version with PTX support for future hardware.  Experienced

     

       
41
       
41
       
-
       
users may optmize this configuration for a variety of reasons such as

     

       
41
       
41
       
+
       
users may optimize this configuration for a variety of reasons such as

     

       
42
       
42
       
 
       
reducing binary size and compile time, supporting legacy hardware, or

     

       
43
       
43
       
 
       
optimizing for specific hardware.

     

       
44
       
44
       
 
       


     

···

       
37
       
37
       
 
       
```

     

       
38
       
38
       
 
       


     

       
39
       
39
       
 
       
- The first parameter is the Cue schema file.

     

       
40
       
40
       
-
       
- The second paramter is an options parameter, currently, only: `document` can be passed.

     

       
40
       
40
       
+
       
- The second parameter is an options parameter, currently, only: `document` can be passed.

     

       
41
       
41
       
 
       


     

       
42
       
42
       
-
       
`document` : match your input data against this fragment of structure or definition, e.g. you may use the same schema file but differents documents based on the data you are validating.

     

       
42
       
42
       
+
       
`document` : match your input data against this fragment of structure or definition, e.g. you may use the same schema file but different documents based on the data you are validating.

     

       
43
       
43
       
 
       


     

       
44
       
44
       
 
       
Another example, given the following `validator.nix` :

     

       
45
       
45
       
 
       
```

     

···

       
4
       
4
       
 
       


     

       
5
       
5
       
 
       
### Installation without packages {#installation-without-packages}

     

       
6
       
6
       
 
       


     

       
7
       
7
       
-
       
You can install `hy` via nix-env or by adding it to `configuration.nix` by reffering to it as a `hy` attribute. This kind of installation adds `hy` to your environment and it succesfully works with `python3`.

     

       
7
       
7
       
+
       
You can install `hy` via nix-env or by adding it to `configuration.nix` by referring to it as a `hy` attribute. This kind of installation adds `hy` to your environment and it successfully works with `python3`.

     

       
8
       
8
       
 
       


     

       
9
       
9
       
 
       
::: {.caution}

     

       
10
       
10
       
-
       
Packages that are installed with your python derivation, are not accesible by `hy` this way.

     

       
10
       
10
       
+
       
Packages that are installed with your python derivation, are not accessible by `hy` this way.

     

       
11
       
11
       
 
       
:::

     

       
12
       
12
       
 
       


     

       
13
       
13
       
 
       
### Installation with packages {#installation-with-packages}

     

···

       
3
       
3
       
 
       
         xml:id="chap-language-support">

     

       
4
       
4
       
 
       
 <title>Languages and frameworks</title>

     

       
5
       
5
       
 
       
 <para>

     

       
6
       
6
       
-
       
  The <link linkend="chap-stdenv">standard build environment</link> makes it easy to build typical Autotools-based packages with very little code. Any other kind of package can be accomodated by overriding the appropriate phases of <literal>stdenv</literal>. However, there are specialised functions in Nixpkgs to easily build packages for other programming languages, such as Perl or Haskell. These are described in this chapter.

     

       
6
       
6
       
+
       
  The <link linkend="chap-stdenv">standard build environment</link> makes it easy to build typical Autotools-based packages with very little code. Any other kind of package can be accommodated by overriding the appropriate phases of <literal>stdenv</literal>. However, there are specialised functions in Nixpkgs to easily build packages for other programming languages, such as Perl or Haskell. These are described in this chapter.

     

       
7
       
7
       
 
       
 </para>

     

       
8
       
8
       
 
       
 <xi:include href="agda.section.xml" />

     

       
9
       
9
       
 
       
 <xi:include href="android.section.xml" />

     

···

       
605
       
605
       
 
       
`test` command for a `checkPhase` which runs `pytest`. This is also beneficial

     

       
606
       
606
       
 
       
when a package may need many items disabled to run the test suite.

     

       
607
       
607
       
 
       


     

       
608
       
608
       
-
       
Using the example above, the analagous `pytestCheckHook` usage would be:

     

       
608
       
608
       
+
       
Using the example above, the analogous `pytestCheckHook` usage would be:

     

       
609
       
609
       
 
       


     

       
610
       
610
       
 
       
```

     

       
611
       
611
       
 
       
  checkInputs = [ pytestCheckHook ];

     
···

       
624
       
624
       
 
       
  ];

     

       
625
       
625
       
 
       
```

     

       
626
       
626
       
 
       


     

       
627
       
627
       
-
       
This is expecially useful when tests need to be conditionally disabled,

     

       
627
       
627
       
+
       
This is especially useful when tests need to be conditionally disabled,

     

       
628
       
628
       
 
       
for example:

     

       
629
       
629
       
 
       


     

       
630
       
630
       
 
       
```

     

···

       
319
       
319
       
 
       
However, please check if it's possible to disable a problematic subset of the

     

       
320
       
320
       
 
       
test suite and leave a comment explaining your reasoning.

     

       
321
       
321
       
 
       


     

       
322
       
322
       
-
       
This can be achived with `--skip` in `checkFlags`:

     

       
322
       
322
       
+
       
This can be achieved with `--skip` in `checkFlags`:

     

       
323
       
323
       
 
       


     

       
324
       
324
       
 
       
```nix

     

       
325
       
325
       
 
       
rustPlatform.buildRustPackage {

     

···

       
303
       
303
       
 
       
This is used by the Nix build process to set the dynamic linker, glibc

     

       
304
       
304
       
 
       
in the case of i686-linux using the default Nix packages collection.

     

       
305
       
305
       
 
       


     

       
306
       
306
       
-
       
Obiously, since we need to compile libstc++ for arm-linux with uClibc linking

     

       
306
       
306
       
+
       
Obviously, since we need to compile libstc++ for arm-linux with uClibc linking

     

       
307
       
307
       
 
       
will not be done correctly: you can't link object files built for arm-linux

     

       
308
       
308
       
 
       
with a glibc built for i686-linux.

     

       
309
       
309
       
 
       


     

···

       
29
       
29
       
 
       
`nix-env` lacks an easy way to select the outputs to install. When installing a package, `nix-env` always installs the outputs listed in `meta.outputsToInstall`, even when the user explicitly selects an output.

     

       
30
       
30
       
 
       


     

       
31
       
31
       
 
       
::: {.warning}

     

       
32
       
32
       
-
       
`nix-env` silenty disregards the outputs selected by the user, and instead installs the outputs from `meta.outputsToInstall`. For example,

     

       
32
       
32
       
+
       
`nix-env` silently disregards the outputs selected by the user, and instead installs the outputs from `meta.outputsToInstall`. For example,

     

       
33
       
33
       
 
       


     

       
34
       
34
       
 
       
```ShellSession

     

       
35
       
35
       
 
       
$ nix-env -iA nixpkgs.coreutils.info

     

···

       
719
       
719
       
 
       


     

       
720
       
720
       
 
       
##### `dontStripHost` {#var-stdenv-dontStripHost}

     

       
721
       
721
       
 
       


     

       
722
       
722
       
-
       
Like `dontStrip`, but only affects the `strip` command targetting the package’s host platform. Useful when supporting cross compilation, but otherwise feel free to ignore.

     

       
722
       
722
       
+
       
Like `dontStrip`, but only affects the `strip` command targeting the package’s host platform. Useful when supporting cross compilation, but otherwise feel free to ignore.

     

       
723
       
723
       
 
       


     

       
724
       
724
       
 
       
##### `dontStripTarget` {#var-stdenv-dontStripTarget}

     

       
725
       
725
       
 
       


     

       
726
       
726
       
-
       
Like `dontStrip`, but only affects the `strip` command targetting the packages’ target platform. Useful when supporting cross compilation, but otherwise feel free to ignore.

     

       
726
       
726
       
+
       
Like `dontStrip`, but only affects the `strip` command targeting the packages’ target platform. Useful when supporting cross compilation, but otherwise feel free to ignore.

     

       
727
       
727
       
 
       


     

       
728
       
728
       
 
       
##### `dontMoveSbin` {#var-stdenv-dontMoveSbin}

     

       
729
       
729
       
 
       


     

···

       
757
       
757
       
 
       
       matchAttrs :: AttrSet -> AttrSet -> Bool

     

       
758
       
758
       
 
       
  */

     

       
759
       
759
       
 
       
  matchAttrs =

     

       
760
       
760
       
-
       
    # Attribute set strucutre to match

     

       
760
       
760
       
+
       
    # Attribute set structure to match

     

       
761
       
761
       
 
       
    pattern:

     

       
762
       
762
       
 
       
    # Attribute set to find patterns in

     

       
763
       
763
       
 
       
    attrs:

     

···

       
17
       
17
       
 
       
    situations below.

     

       
18
       
18
       
 
       


     

       
19
       
19
       
 
       
    For illustration and/or testing, we define derivation such that its

     

       
20
       
20
       
-
       
    evaluation is very noticable.

     

       
20
       
20
       
+
       
    evaluation is very noticeable.

     

       
21
       
21
       
 
       


     

       
22
       
22
       
 
       
        let derivation = throw "This won't be evaluated.";

     

       
23
       
23
       
 
       


     

···

       
479
       
479
       
 
       
      ) (lib.functionArgs f);

     

       
480
       
480
       
 
       


     

       
481
       
481
       
 
       
      # Note: we append in the opposite order such that we can add an error

     

       
482
       
482
       
-
       
      # context on the explicited arguments of "args" too. This update

     

       
482
       
482
       
+
       
      # context on the explicit arguments of "args" too. This update

     

       
483
       
483
       
 
       
      # operator is used to make the "args@{ ... }: with args.lib;" notation

     

       
484
       
484
       
 
       
      # works.

     

       
485
       
485
       
 
       
    in f (args // extraArgs)

     

···

       
185
       
185
       
 
       
  */

     

       
186
       
186
       
 
       
  makeBinPath = makeSearchPathOutput "bin" "bin";

     

       
187
       
187
       
 
       


     

       
188
       
188
       
-
       
  /* Normalize path, removing extranous /s

     

       
188
       
188
       
+
       
  /* Normalize path, removing extraneous /s

     

       
189
       
189
       
 
       


     

       
190
       
190
       
 
       
     Type: normalizePath :: string -> string

     

       
191
       
191
       
 
       


     
···

       
330
       
330
       
 
       
  */

     

       
331
       
331
       
 
       
  escape = list: replaceStrings list (map (c: "\\${c}") list);

     

       
332
       
332
       
 
       


     

       
333
       
333
       
-
       
  /* Escape occurence of the element of `list` in `string` by

     

       
333
       
333
       
+
       
  /* Escape occurrence of the element of `list` in `string` by

     

       
334
       
334
       
 
       
     converting to its ASCII value and prefixing it with \\x.

     

       
335
       
335
       
 
       
     Only works for printable ascii characters.

     

       
336
       
336
       
 
       


     

···

       
67
       
67
       
 
       
    #

     

       
68
       
68
       
 
       
    # Note:

     

       
69
       
69
       
 
       
    #

     

       
70
       
70
       
-
       
    # - The succesors of `skylake` (`cannonlake`, `icelake`, etc) use `avx512`

     

       
70
       
70
       
+
       
    # - The successors of `skylake` (`cannonlake`, `icelake`, etc) use `avx512`

     

       
71
       
71
       
 
       
    #   which no current AMD Zen michroarch support.

     

       
72
       
72
       
 
       
    # - `znver1` uses `ABM`, `CLZERO`, `CX16`, `MWAITX`, and `SSE4A` which no

     

       
73
       
73
       
 
       
    #   current Intel microarch support.

     

···

       
20
       
20
       
 
       
  # necessary.

     

       
21
       
21
       
 
       
  #

     

       
22
       
22
       
 
       
  # `parsed` is inferred from args, both because there are two options with one

     

       
23
       
23
       
-
       
  # clearly prefered, and to prevent cycles. A simpler fixed point where the RHS

     

       
23
       
23
       
+
       
  # clearly preferred, and to prevent cycles. A simpler fixed point where the RHS

     

       
24
       
24
       
 
       
  # always just used `final.*` would fail on both counts.

     

       
25
       
25
       
 
       
  elaborate = args': let

     

       
26
       
26
       
 
       
    args = if lib.isString args' then { system = args'; }

     
···

       
62
       
62
       
 
       
      linker =

     

       
63
       
63
       
 
       
        /**/ if final.useLLVM or false      then "lld"

     

       
64
       
64
       
 
       
        else if final.isDarwin              then "cctools"

     

       
65
       
65
       
-
       
        # "bfd" and "gold" both come from GNU binutils. The existance of Gold

     

       
65
       
65
       
+
       
        # "bfd" and "gold" both come from GNU binutils. The existence of Gold

     

       
66
       
66
       
 
       
        # is why we use the more obscure "bfd" and not "binutils" for this

     

       
67
       
67
       
 
       
        # choice.

     

       
68
       
68
       
 
       
        else                                     "bfd";

     

···

       
1
       
1
       
 
       
# See [RFC 46] for mandated platform support and ../../pkgs/stdenv for

     

       
2
       
2
       
 
       
# implemented platform support. This list is mainly descriptive, i.e. all

     

       
3
       
3
       
-
       
# system doubles for platforms where nixpkgs can do native compiliation

     

       
3
       
3
       
+
       
# system doubles for platforms where nixpkgs can do native compilation

     

       
4
       
4
       
 
       
# reasonably well are included.

     

       
5
       
5
       
 
       
#

     

       
6
       
6
       
 
       
# [RFC 46]: https://github.com/NixOS/rfcs/blob/master/rfcs/0046-platform-support-tiers.md

     

···

       
246
       
246
       
 
       
## Freeform modules

     

       
247
       
247
       
 
       
# Assigning without a declared option should work

     

       
248
       
248
       
 
       
checkConfigOutput '^"24"$' config.value ./freeform-attrsOf.nix ./define-value-string.nix

     

       
249
       
249
       
-
       
# No freeform assigments shouldn't make it error

     

       
249
       
249
       
+
       
# No freeform assignments shouldn't make it error

     

       
250
       
250
       
 
       
checkConfigOutput '^{ }$' config ./freeform-attrsOf.nix

     

       
251
       
251
       
 
       
# but only if the type matches

     

       
252
       
252
       
 
       
checkConfigError 'A definition for option .* is not of type .*' config.value ./freeform-attrsOf.nix ./define-value-list.nix

     

···

       
7
       
7
       
 
       
available to processes through the `/sys` and

     

       
8
       
8
       
 
       
`/proc` filesystems. It also disables the User Namespaces

     

       
9
       
9
       
 
       
feature of the kernel, which stops Nix from being able to build anything

     

       
10
       
10
       
-
       
(this particular setting can be overriden via

     

       
10
       
10
       
+
       
(this particular setting can be overridden via

     

       
11
       
11
       
 
       
[](#opt-security.allowUserNamespaces)). See the

     

       
12
       
12
       
 
       
[profile source](https://github.com/nixos/nixpkgs/tree/master/nixos/modules/profiles/hardened.nix)

     

       
13
       
13
       
 
       
for further detail on which settings are altered.

     

···

       
34
       
34
       
 
       


     

       
35
       
35
       
 
       
An activation script can write to special files instructing

     

       
36
       
36
       
 
       
`switch-to-configuration` to restart/reload units. The script will take these

     

       
37
       
37
       
-
       
requests into account and will incorperate the unit configuration as described

     

       
37
       
37
       
+
       
requests into account and will incorporate the unit configuration as described

     

       
38
       
38
       
 
       
above. This means that the activation script will "fake" a modified unit file

     

       
39
       
39
       
 
       
and `switch-to-configuration` will act accordingly. By doing so, configuration

     

       
40
       
40
       
 
       
like [systemd.services.\<name\>.restartIfChanged](#opt-systemd.services) is

     
···

       
49
       
49
       
 
       
`/run/nixos/dry-activation-reload-list`. Those files can contain

     

       
50
       
50
       
 
       
newline-separated lists of unit names where duplicates are being ignored. These

     

       
51
       
51
       
 
       
files are not create automatically and activation scripts must take the

     

       
52
       
52
       
-
       
possiblility into account that they have to create them first.

     

       
52
       
52
       
+
       
possibility into account that they have to create them first.

     

       
53
       
53
       
 
       


     

       
54
       
54
       
 
       
## NixOS snippets {#sec-activation-script-nixos-snippets}

     

       
55
       
55
       
 
       


     

···

       
345
       
345
       
 
       
It takes a parameter *`o`*, that should be a set, or a function returning

     

       
346
       
346
       
 
       
a set with an `options` key defining the sub-options. Submodule option

     

       
347
       
347
       
 
       
definitions are type-checked accordingly to the `options` declarations.

     

       
348
       
348
       
-
       
Of course, you can nest submodule option definitons for even higher

     

       
348
       
348
       
+
       
Of course, you can nest submodule option definitions for even higher

     

       
349
       
349
       
 
       
modularity.

     

       
350
       
350
       
 
       


     

       
351
       
351
       
 
       
The option set can be defined directly

     

···

       
298
       
298
       
 
       


     

       
299
       
299
       
 
       
:   Wait until the supplied regular expressions match a line of the

     

       
300
       
300
       
 
       
    serial console output. This method is useful when OCR is not

     

       
301
       
301
       
-
       
    possibile or accurate enough.

     

       
301
       
301
       
+
       
    possible or accurate enough.

     

       
302
       
302
       
 
       


     

       
303
       
303
       
 
       
`wait_for_window`

     

       
304
       
304
       
 
       


     
···

       
351
       
351
       
 
       
`start_job` and `stop_job`.

     

       
352
       
352
       
 
       


     

       
353
       
353
       
 
       
For faster dev cycles it\'s also possible to disable the code-linters

     

       
354
       
354
       
-
       
(this shouldn\'t be commited though):

     

       
354
       
354
       
+
       
(this shouldn\'t be committed though):

     

       
355
       
355
       
 
       


     

       
356
       
356
       
 
       
```nix

     

       
357
       
357
       
 
       
{

     

···

       
9
       
9
       
 
       
    available to processes through the <literal>/sys</literal> and

     

       
10
       
10
       
 
       
    <literal>/proc</literal> filesystems. It also disables the User

     

       
11
       
11
       
 
       
    Namespaces feature of the kernel, which stops Nix from being able to

     

       
12
       
12
       
-
       
    build anything (this particular setting can be overriden via

     

       
12
       
12
       
+
       
    build anything (this particular setting can be overridden via

     

       
13
       
13
       
 
       
    <xref linkend="opt-security.allowUserNamespaces" />). See the

     

       
14
       
14
       
 
       
    <link xlink:href="https://github.com/nixos/nixpkgs/tree/master/nixos/modules/profiles/hardened.nix">profile

     

       
15
       
15
       
 
       
    source</link> for further detail on which settings are altered.

     

···

       
45
       
45
       
 
       
    An activation script can write to special files instructing

     

       
46
       
46
       
 
       
    <literal>switch-to-configuration</literal> to restart/reload units.

     

       
47
       
47
       
 
       
    The script will take these requests into account and will

     

       
48
       
48
       
-
       
    incorperate the unit configuration as described above. This means

     

       
48
       
48
       
+
       
    incorporate the unit configuration as described above. This means

     

       
49
       
49
       
 
       
    that the activation script will <quote>fake</quote> a modified unit

     

       
50
       
50
       
 
       
    file and <literal>switch-to-configuration</literal> will act

     

       
51
       
51
       
 
       
    accordingly. By doing so, configuration like

     
···

       
66
       
66
       
 
       
    <literal>/run/nixos/dry-activation-reload-list</literal>. Those

     

       
67
       
67
       
 
       
    files can contain newline-separated lists of unit names where

     

       
68
       
68
       
 
       
    duplicates are being ignored. These files are not create

     

       
69
       
69
       
-
       
    automatically and activation scripts must take the possiblility into

     

       
69
       
69
       
+
       
    automatically and activation scripts must take the possibility into

     

       
70
       
70
       
 
       
    account that they have to create them first.

     

       
71
       
71
       
 
       
  </para>

     

       
72
       
72
       
 
       
  <section xml:id="sec-activation-script-nixos-snippets">

     

···

       
712
       
712
       
 
       
      <literal>options</literal> key defining the sub-options. Submodule

     

       
713
       
713
       
 
       
      option definitions are type-checked accordingly to the

     

       
714
       
714
       
 
       
      <literal>options</literal> declarations. Of course, you can nest

     

       
715
       
715
       
-
       
      submodule option definitons for even higher modularity.

     

       
715
       
715
       
+
       
      submodule option definitions for even higher modularity.

     

       
716
       
716
       
 
       
    </para>

     

       
717
       
717
       
 
       
    <para>

     

       
718
       
718
       
 
       
      The option set can be defined directly

     

···

       
536
       
536
       
 
       
          <para>

     

       
537
       
537
       
 
       
            Wait until the supplied regular expressions match a line of

     

       
538
       
538
       
 
       
            the serial console output. This method is useful when OCR is

     

       
539
       
539
       
-
       
            not possibile or accurate enough.

     

       
539
       
539
       
+
       
            not possible or accurate enough.

     

       
540
       
540
       
 
       
          </para>

     

       
541
       
541
       
 
       
        </listitem>

     

       
542
       
542
       
 
       
      </varlistentry>

     
···

       
631
       
631
       
 
       
    </para>

     

       
632
       
632
       
 
       
    <para>

     

       
633
       
633
       
 
       
      For faster dev cycles it's also possible to disable the

     

       
634
       
634
       
-
       
      code-linters (this shouldn't be commited though):

     

       
634
       
634
       
+
       
      code-linters (this shouldn't be committed though):

     

       
635
       
635
       
 
       
    </para>

     

       
636
       
636
       
 
       
    <programlisting language="bash">

     

       
637
       
637
       
 
       
{

     

···

       
24
       
24
       
 
       
  </itemizedlist>

     

       
25
       
25
       
 
       
  <para>

     

       
26
       
26
       
 
       
    System images, such as the live installer ones, know how to enforce

     

       
27
       
27
       
-
       
    configuration settings on wich they immediately depend in order to

     

       
27
       
27
       
+
       
    configuration settings on which they immediately depend in order to

     

       
28
       
28
       
 
       
    work correctly.

     

       
29
       
29
       
 
       
  </para>

     

       
30
       
30
       
 
       
  <para>

     
···

       
102
       
102
       
 
       
      it needs at a minimum for correct functioning, while the installer

     

       
103
       
103
       
 
       
      base image overrides the entire file system layout because there

     

       
104
       
104
       
 
       
      can’t be any other guarantees on a live medium than those given by

     

       
105
       
105
       
-
       
      the live medium itself. The latter is especially true befor

     

       
105
       
105
       
+
       
      the live medium itself. The latter is especially true before

     

       
106
       
106
       
 
       
      formatting the target block device(s). On the other hand, the

     

       
107
       
107
       
 
       
      netboot iso only overrides its minimum dependencies since netboot

     

       
108
       
108
       
 
       
      images are always made-to-target.

     

···

       
223
       
223
       
 
       
      <para>

     

       
224
       
224
       
 
       
        You'll likely want to set a root password for your first boot

     

       
225
       
225
       
 
       
        using the configuration files because you won't have a chance to

     

       
226
       
226
       
-
       
        enter a password until after you reboot. You can initalize the

     

       
226
       
226
       
+
       
        enter a password until after you reboot. You can initialize the

     

       
227
       
227
       
 
       
        root password to an empty one with this line: (and of course

     

       
228
       
228
       
 
       
        don't forget to set one once you've rebooted or to lock the

     

       
229
       
229
       
 
       
        account with <literal>sudo passwd -l root</literal> if you use

     

···

       
1
       
1
       
-
       
<section xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="sec-instaling-virtualbox-guest">

     

       
1
       
1
       
+
       
<section xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="sec-installing-virtualbox-guest">

     

       
2
       
2
       
 
       
  <title>Installing in a VirtualBox guest</title>

     

       
3
       
3
       
 
       
  <para>

     

       
4
       
4
       
 
       
    Installing NixOS into a VirtualBox guest is convenient for users who

     

···

       
256
       
256
       
 
       
      </para>

     

       
257
       
257
       
 
       
      <para>

     

       
258
       
258
       
 
       
        On the minimal installer, NetworkManager is not available, so

     

       
259
       
259
       
-
       
        configuration must be perfomed manually. To configure the wifi,

     

       
259
       
259
       
+
       
        configuration must be performed manually. To configure the wifi,

     

       
260
       
260
       
 
       
        first start wpa_supplicant with

     

       
261
       
261
       
 
       
        <literal>sudo systemctl start wpa_supplicant</literal>, then run

     

       
262
       
262
       
 
       
        <literal>wpa_cli</literal>. For most home networks, you need to

     

···

       
545
       
545
       
 
       
        <literal>services.udev.extraRules</literal> option now writes

     

       
546
       
546
       
 
       
        rules to <literal>99-local.rules</literal> instead of

     

       
547
       
547
       
 
       
        <literal>10-local.rules</literal>. This makes all the user rules

     

       
548
       
548
       
-
       
        apply after others, so their results wouldn't be overriden by

     

       
548
       
548
       
+
       
        apply after others, so their results wouldn't be overridden by

     

       
549
       
549
       
 
       
        anything else.

     

       
550
       
550
       
 
       
      </para>

     

       
551
       
551
       
 
       
    </listitem>

     

···

       
666
       
666
       
 
       
      <listitem>

     

       
667
       
667
       
 
       
        <para>

     

       
668
       
668
       
 
       
          <literal>services.firefox.syncserver</literal> now runs by

     

       
669
       
669
       
-
       
          default as a non-root user. To accomodate this change, the

     

       
669
       
669
       
+
       
          default as a non-root user. To accommodate this change, the

     

       
670
       
670
       
 
       
          default sqlite database location has also been changed.

     

       
671
       
671
       
 
       
          Migration should work automatically. Refer to the description

     

       
672
       
672
       
 
       
          of the options for more details.

     

···

       
271
       
271
       
 
       
      <listitem>

     

       
272
       
272
       
 
       
        <para>

     

       
273
       
273
       
 
       
          The versioned <literal>postgresql</literal> have been renamed

     

       
274
       
274
       
-
       
          to use underscore number seperators. For example,

     

       
274
       
274
       
+
       
          to use underscore number separators. For example,

     

       
275
       
275
       
 
       
          <literal>postgresql96</literal> has been renamed to

     

       
276
       
276
       
 
       
          <literal>postgresql_9_6</literal>.

     

       
277
       
277
       
 
       
        </para>

     

···

       
498
       
498
       
 
       
      <listitem>

     

       
499
       
499
       
 
       
        <para>

     

       
500
       
500
       
 
       
          The <literal>prometheus-nginx-exporter</literal> package now

     

       
501
       
501
       
-
       
          uses the offical exporter provided by NGINX Inc. Its metrics

     

       
501
       
501
       
+
       
          uses the official exporter provided by NGINX Inc. Its metrics

     

       
502
       
502
       
 
       
          are differently structured and are incompatible to the old

     

       
503
       
503
       
 
       
          ones. For information about the metrics, have a look at the

     

       
504
       
504
       
 
       
          <link xlink:href="https://github.com/nginxinc/nginx-prometheus-exporter">official

     
···

       
524
       
524
       
 
       
        <para>

     

       
525
       
525
       
 
       
          By default, prometheus exporters are now run with

     

       
526
       
526
       
 
       
          <literal>DynamicUser</literal> enabled. Exporters that need a

     

       
527
       
527
       
-
       
          real user, now run under a seperate user and group which

     

       
527
       
527
       
+
       
          real user, now run under a separate user and group which

     

       
528
       
528
       
 
       
          follow the pattern

     

       
529
       
529
       
 
       
          <literal>&lt;exporter-name&gt;-exporter</literal>, instead of

     

       
530
       
530
       
 
       
          the previous default <literal>nobody</literal> and

     

···

       
1304
       
1304
       
 
       
      <listitem>

     

       
1305
       
1305
       
 
       
        <para>

     

       
1306
       
1306
       
 
       
          In the ACME module, the data used to build the hash for the

     

       
1307
       
1307
       
-
       
          account directory has changed to accomodate new features to

     

       
1307
       
1307
       
+
       
          account directory has changed to accommodate new features to

     

       
1308
       
1308
       
 
       
          reduce account rate limit issues. This will trigger new

     

       
1309
       
1309
       
 
       
          account creation on the first rebuild following this update.

     

       
1310
       
1310
       
 
       
          No issues are expected to arise from this, thanks to the new

     

···

       
328
       
328
       
 
       
      <listitem>

     

       
329
       
329
       
 
       
        <para>

     

       
330
       
330
       
 
       
          <link xlink:href="https://maddy.email/">Maddy</link>, a free

     

       
331
       
331
       
-
       
          an open source mail server. Availabe as

     

       
331
       
331
       
+
       
          an open source mail server. Available as

     

       
332
       
332
       
 
       
          <link linkend="opt-services.maddy.enable">services.maddy</link>.

     

       
333
       
333
       
 
       
        </para>

     

       
334
       
334
       
 
       
      </listitem>

     
···

       
1422
       
1422
       
 
       
              derivation if <literal>name</literal> is

     

       
1423
       
1423
       
 
       
              <literal>&quot;vim&quot;</literal> (the default). This

     

       
1424
       
1424
       
 
       
              makes the <literal>wrapManual</literal> argument obsolete,

     

       
1425
       
1425
       
-
       
              but this behavior can be overriden by setting the

     

       
1425
       
1425
       
+
       
              but this behavior can be overridden by setting the

     

       
1426
       
1426
       
 
       
              <literal>standalone</literal> argument.

     

       
1427
       
1427
       
 
       
            </para>

     

       
1428
       
1428
       
 
       
          </listitem>

     

···

       
1280
       
1280
       
 
       
      </listitem>

     

       
1281
       
1281
       
 
       
      <listitem>

     

       
1282
       
1282
       
 
       
        <para>

     

       
1283
       
1283
       
-
       
          Option descriptions, examples, and defaults writting in

     

       
1284
       
1284
       
-
       
          DocBook are now deprecated. Using CommonMark is preferred and

     

       
1285
       
1285
       
-
       
          will become the default in a future release.

     

       
1283
       
1283
       
+
       
          Option descriptions, examples, and defaults writing in DocBook

     

       
1284
       
1284
       
+
       
          are now deprecated. Using CommonMark is preferred and will

     

       
1285
       
1285
       
+
       
          become the default in a future release.

     

       
1286
       
1286
       
 
       
        </para>

     

       
1287
       
1287
       
 
       
      </listitem>

     

       
1288
       
1288
       
 
       
      <listitem>

     

···

       
114
       
114
       
 
       
          <link linkend="opt-services.snapserver.openFirewall">services.snapserver.openFirewall</link>

     

       
115
       
115
       
 
       
          module option default value has been changed from

     

       
116
       
116
       
 
       
          <literal>true</literal> to <literal>false</literal>. You will

     

       
117
       
117
       
-
       
          need to explicitely set this option to

     

       
118
       
118
       
-
       
          <literal>true</literal>, or configure your firewall.

     

       
117
       
117
       
+
       
          need to explicitly set this option to <literal>true</literal>,

     

       
118
       
118
       
+
       
          or configure your firewall.

     

       
119
       
119
       
 
       
        </para>

     

       
120
       
120
       
 
       
      </listitem>

     

       
121
       
121
       
 
       
      <listitem>

     
···

       
124
       
124
       
 
       
          <link linkend="opt-services.tmate-ssh-server.openFirewall">services.tmate-ssh-server.openFirewall</link>

     

       
125
       
125
       
 
       
          module option default value has been changed from

     

       
126
       
126
       
 
       
          <literal>true</literal> to <literal>false</literal>. You will

     

       
127
       
127
       
-
       
          need to explicitely set this option to

     

       
128
       
128
       
-
       
          <literal>true</literal>, or configure your firewall.

     

       
127
       
127
       
+
       
          need to explicitly set this option to <literal>true</literal>,

     

       
128
       
128
       
+
       
          or configure your firewall.

     

       
129
       
129
       
 
       
        </para>

     

       
130
       
130
       
 
       
      </listitem>

     

       
131
       
131
       
 
       
      <listitem>

     
···

       
134
       
134
       
 
       
          <link linkend="opt-services.unifi-video.openFirewall">services.unifi-video.openFirewall</link>

     

       
135
       
135
       
 
       
          module option default value has been changed from

     

       
136
       
136
       
 
       
          <literal>true</literal> to <literal>false</literal>. You will

     

       
137
       
137
       
-
       
          need to explicitely set this option to

     

       
138
       
138
       
-
       
          <literal>true</literal>, or configure your firewall.

     

       
137
       
137
       
+
       
          need to explicitly set this option to <literal>true</literal>,

     

       
138
       
138
       
+
       
          or configure your firewall.

     

       
139
       
139
       
 
       
        </para>

     

       
140
       
140
       
 
       
      </listitem>

     

       
141
       
141
       
 
       
      <listitem>

     
···

       
266
       
266
       
 
       
          The new option <literal>users.motdFile</literal> allows

     

       
267
       
267
       
 
       
          configuring a Message Of The Day that can be updated

     

       
268
       
268
       
 
       
          dynamically.

     

       
269
       
269
       
+
       
        </para>

     

       
270
       
270
       
+
       
      </listitem>

     

       
271
       
271
       
+
       
      <listitem>

     

       
272
       
272
       
+
       
        <para>

     

       
273
       
273
       
+
       
          Enabling global redirect in

     

       
274
       
274
       
+
       
          <literal>services.nginx.virtualHosts</literal> now allows one

     

       
275
       
275
       
+
       
          to add exceptions with the <literal>locations</literal>

     

       
276
       
276
       
+
       
          option.

     

       
269
       
277
       
 
       
        </para>

     

       
270
       
278
       
 
       
      </listitem>

     

       
271
       
279
       
 
       
      <listitem>

     

···

       
9
       
9
       
 
       
- Combine them with (any of) your host config(s)

     

       
10
       
10
       
 
       


     

       
11
       
11
       
 
       
System images, such as the live installer ones, know how to enforce configuration settings

     

       
12
       
12
       
-
       
on wich they immediately depend in order to work correctly.

     

       
12
       
12
       
+
       
on which they immediately depend in order to work correctly.

     

       
13
       
13
       
 
       


     

       
14
       
14
       
 
       
However, if you are confident, you can opt to override those

     

       
15
       
15
       
 
       
enforced values with `mkForce`.

     
···

       
75
       
75
       
 
       
For example, the iso base image overrides those file systems which it needs at a minimum

     

       
76
       
76
       
 
       
for correct functioning, while the installer base image overrides the entire file system

     

       
77
       
77
       
 
       
layout because there can't be any other guarantees on a live medium than those given

     

       
78
       
78
       
-
       
by the live medium itself. The latter is especially true befor formatting the target

     

       
78
       
78
       
+
       
by the live medium itself. The latter is especially true before formatting the target

     

       
79
       
79
       
 
       
block device(s). On the other hand, the netboot iso only overrides its minimum dependencies

     

       
80
       
80
       
 
       
since netboot images are always made-to-target.

     

···

       
158
       
158
       
 
       


     

       
159
       
159
       
 
       
    You\'ll likely want to set a root password for your first boot using

     

       
160
       
160
       
 
       
    the configuration files because you won\'t have a chance to enter a

     

       
161
       
161
       
-
       
    password until after you reboot. You can initalize the root password

     

       
161
       
161
       
+
       
    password until after you reboot. You can initialize the root password

     

       
162
       
162
       
 
       
    to an empty one with this line: (and of course don\'t forget to set

     

       
163
       
163
       
 
       
    one once you\'ve rebooted or to lock the account with

     

       
164
       
164
       
 
       
    `sudo passwd -l root` if you use `sudo`)

     

···

       
1
       
1
       
-
       
# Installing in a VirtualBox guest {#sec-instaling-virtualbox-guest}

     

       
1
       
1
       
+
       
# Installing in a VirtualBox guest {#sec-installing-virtualbox-guest}

     

       
2
       
2
       
 
       


     

       
3
       
3
       
 
       
Installing NixOS into a VirtualBox guest is convenient for users who

     

       
4
       
4
       
 
       
want to try NixOS without installing it on bare metal. If you want to

     

···

       
162
       
162
       
 
       
`systemctl stop NetworkManager`.

     

       
163
       
163
       
 
       


     

       
164
       
164
       
 
       
On the minimal installer, NetworkManager is not available, so

     

       
165
       
165
       
-
       
configuration must be perfomed manually. To configure the wifi, first

     

       
165
       
165
       
+
       
configuration must be performed manually. To configure the wifi, first

     

       
166
       
166
       
 
       
start wpa_supplicant with `sudo systemctl start wpa_supplicant`, then

     

       
167
       
167
       
 
       
run `wpa_cli`. For most home networks, you need to type in the following

     

       
168
       
168
       
 
       
commands:

     

···

       
202
       
202
       
 
       
  }

     

       
203
       
203
       
 
       
  ```

     

       
204
       
204
       
 
       


     

       
205
       
205
       
-
       
- `services.udev.extraRules` option now writes rules to `99-local.rules` instead of `10-local.rules`. This makes all the user rules apply after others, so their results wouldn\'t be overriden by anything else.

     

       
205
       
205
       
+
       
- `services.udev.extraRules` option now writes rules to `99-local.rules` instead of `10-local.rules`. This makes all the user rules apply after others, so their results wouldn\'t be overridden by anything else.

     

       
206
       
206
       
 
       


     

       
207
       
207
       
 
       
- Large parts of the `services.gitlab` module has been been rewritten. There are new configuration options available. The `stateDir` option was renamned to `statePath` and the `satellitesDir` option was removed. Please review the currently available options.

     

       
208
       
208
       
 
       


     

···

       
238
       
238
       
 
       


     

       
239
       
239
       
 
       
- `cc-wrapper`\'s setup-hook now exports a number of environment variables corresponding to binutils binaries, (e.g. `LD`, `STRIP`, `RANLIB`, etc). This is done to prevent packages\' build systems guessing, which is harder to predict, especially when cross-compiling. However, some packages have broken due to this---their build systems either not supporting, or claiming to support without adequate testing, taking such environment variables as parameters.

     

       
240
       
240
       
 
       


     

       
241
       
241
       
-
       
- `services.firefox.syncserver` now runs by default as a non-root user. To accomodate this change, the default sqlite database location has also been changed. Migration should work automatically. Refer to the description of the options for more details.

     

       
241
       
241
       
+
       
- `services.firefox.syncserver` now runs by default as a non-root user. To accommodate this change, the default sqlite database location has also been changed. Migration should work automatically. Refer to the description of the options for more details.

     

       
242
       
242
       
 
       


     

       
243
       
243
       
 
       
- The `compiz` window manager and package was removed. The system support had been broken for several years.

     

       
244
       
244
       
 
       


     

···

       
73
       
73
       
 
       


     

       
74
       
74
       
 
       
- OpenSMTPD has been upgraded to version 6.4.0p1. This release makes backwards-incompatible changes to the configuration file format. See `man smtpd.conf` for more information on the new file format.

     

       
75
       
75
       
 
       


     

       
76
       
76
       
-
       
- The versioned `postgresql` have been renamed to use underscore number seperators. For example, `postgresql96` has been renamed to `postgresql_9_6`.

     

       
76
       
76
       
+
       
- The versioned `postgresql` have been renamed to use underscore number separators. For example, `postgresql96` has been renamed to `postgresql_9_6`.

     

       
77
       
77
       
 
       


     

       
78
       
78
       
 
       
- Package `consul-ui` and passthrough `consul.ui` have been removed. The package `consul` now uses upstream releases that vendor the UI into the binary. See [\#48714](https://github.com/NixOS/nixpkgs/pull/48714#issuecomment-433454834) for details.

     

       
79
       
79
       
 
       


     

···

       
154
       
154
       
 
       


     

       
155
       
155
       
 
       
- The setopt declarations will be evaluated at the end of `/etc/zshrc`, so any code in [programs.zsh.interactiveShellInit](options.html#opt-programs.zsh.interactiveShellInit), [programs.zsh.loginShellInit](options.html#opt-programs.zsh.loginShellInit) and [programs.zsh.promptInit](options.html#opt-programs.zsh.promptInit) may break if it relies on those options being set.

     

       
156
       
156
       
 
       


     

       
157
       
157
       
-
       
- The `prometheus-nginx-exporter` package now uses the offical exporter provided by NGINX Inc. Its metrics are differently structured and are incompatible to the old ones. For information about the metrics, have a look at the [official repo](https://github.com/nginxinc/nginx-prometheus-exporter).

     

       
157
       
157
       
+
       
- The `prometheus-nginx-exporter` package now uses the official exporter provided by NGINX Inc. Its metrics are differently structured and are incompatible to the old ones. For information about the metrics, have a look at the [official repo](https://github.com/nginxinc/nginx-prometheus-exporter).

     

       
158
       
158
       
 
       


     

       
159
       
159
       
 
       
- The `shibboleth-sp` package has been updated to version 3. It is largely backward compatible, for further information refer to the [release notes](https://wiki.shibboleth.net/confluence/display/SP3/ReleaseNotes) and [upgrade guide](https://wiki.shibboleth.net/confluence/display/SP3/UpgradingFromV2).

     

       
160
       
160
       
 
       


     

       
161
       
161
       
 
       
  Nodejs 8 is scheduled EOL under the lifetime of 19.09 and has been dropped.

     

       
162
       
162
       
 
       


     

       
163
       
163
       
-
       
- By default, prometheus exporters are now run with `DynamicUser` enabled. Exporters that need a real user, now run under a seperate user and group which follow the pattern `<exporter-name>-exporter`, instead of the previous default `nobody` and `nogroup`. Only some exporters are affected by the latter, namely the exporters `dovecot`, `node`, `postfix` and `varnish`.

     

       
163
       
163
       
+
       
- By default, prometheus exporters are now run with `DynamicUser` enabled. Exporters that need a real user, now run under a separate user and group which follow the pattern `<exporter-name>-exporter`, instead of the previous default `nobody` and `nogroup`. Only some exporters are affected by the latter, namely the exporters `dovecot`, `node`, `postfix` and `varnish`.

     

       
164
       
164
       
 
       


     

       
165
       
165
       
 
       
- The `ibus-qt` package is not installed by default anymore when [i18n.inputMethod.enabled](options.html#opt-i18n.inputMethod.enabled) is set to `ibus`. If IBus support in Qt 4.x applications is required, add the `ibus-qt` package to your [environment.systemPackages](options.html#opt-environment.systemPackages) manually.

     

       
166
       
166
       
 
       


     

···

       
369
       
369
       
 
       


     

       
370
       
370
       
 
       
- The zookeeper package does not provide `zooInspector.sh` anymore, as that \"contrib\" has been dropped from upstream releases.

     

       
371
       
371
       
 
       


     

       
372
       
372
       
-
       
- In the ACME module, the data used to build the hash for the account directory has changed to accomodate new features to reduce account rate limit issues. This will trigger new account creation on the first rebuild following this update. No issues are expected to arise from this, thanks to the new account creation handling.

     

       
372
       
372
       
+
       
- In the ACME module, the data used to build the hash for the account directory has changed to accommodate new features to reduce account rate limit issues. This will trigger new account creation on the first rebuild following this update. No issues are expected to arise from this, thanks to the new account creation handling.

     

       
373
       
373
       
 
       


     

       
374
       
374
       
 
       
- [users.users._name_.createHome](options.html#opt-users.users._name_.createHome) now always ensures home directory permissions to be `0700`. Permissions had previously been ignored for already existing home directories, possibly leaving them readable by others. The option\'s description was incorrect regarding ownership management and has been simplified greatly.

     

       
375
       
375
       
 
       


     

···

       
107
       
107
       
 
       


     

       
108
       
108
       
 
       
- [kanidm](https://kanidm.github.io/kanidm/stable/), an identity management server written in Rust. Available as [services.kanidm](#opt-services.kanidm.enableServer)

     

       
109
       
109
       
 
       


     

       
110
       
110
       
-
       
- [Maddy](https://maddy.email/), a free an open source mail server. Availabe as [services.maddy](#opt-services.maddy.enable).

     

       
110
       
110
       
+
       
- [Maddy](https://maddy.email/), a free an open source mail server. Available as [services.maddy](#opt-services.maddy.enable).

     

       
111
       
111
       
 
       


     

       
112
       
112
       
 
       
- [matrix-conduit](https://conduit.rs/), a simple, fast and reliable chat server powered by matrix. Available as [services.matrix-conduit](option.html#opt-services.matrix-conduit.enable).

     

       
113
       
113
       
 
       


     
···

       
562
       
562
       
 
       
- `pkgs._7zz` is now correctly licensed as LGPL3+ and BSD3 with optional unfree unRAR licensed code

     

       
563
       
563
       
 
       


     

       
564
       
564
       
 
       
- The `vim.customize` function produced by `vimUtils.makeCustomizable` now has a slightly different interface:

     

       
565
       
565
       
-
       
  * The wrapper now includes everything in the given Vim derivation if `name` is `"vim"` (the default). This makes the `wrapManual` argument obsolete, but this behavior can be overriden by setting the `standalone` argument.

     

       
565
       
565
       
+
       
  * The wrapper now includes everything in the given Vim derivation if `name` is `"vim"` (the default). This makes the `wrapManual` argument obsolete, but this behavior can be overridden by setting the `standalone` argument.

     

       
566
       
566
       
 
       
  * All the executables present in the given derivation (or, in `standalone` mode, only the `*vim` ones) are wrapped. This makes the `wrapGui` argument obsolete.

     

       
567
       
567
       
 
       
  * The `vimExecutableName` and `gvimExecutableName` arguments were replaced by a single `executableName` argument in which the shell variable `$exe` can be used to refer to the wrapped executable's name.

     

       
568
       
568
       
 
       


     

···

       
385
       
385
       
 
       


     

       
386
       
386
       
 
       
- memtest86+ was updated from 5.00-coreboot-002 to 6.00-beta2. It is now the upstream version from https://www.memtest.org/, as coreboot's fork is no longer available.

     

       
387
       
387
       
 
       


     

       
388
       
388
       
-
       
- Option descriptions, examples, and defaults writting in DocBook are now deprecated. Using CommonMark is preferred and will become the default in a future release.

     

       
388
       
388
       
+
       
- Option descriptions, examples, and defaults writing in DocBook are now deprecated. Using CommonMark is preferred and will become the default in a future release.

     

       
389
       
389
       
 
       


     

       
390
       
390
       
 
       
- The `documentation.nixos.options.allowDocBook` option was added to ease the transition to CommonMark option documentation. Setting this option to `false` causes an error for every option included in the manual that uses DocBook documentation; it defaults to `true` to preserve the previous behavior and will be removed once the transition to CommonMark is complete.

     

       
391
       
391
       
 
       


     

···

       
37
       
37
       
 
       


     

       
38
       
38
       
 
       
- `services.sourcehut.dispatch` and the corresponding package (`sourcehut.dispatchsrht`) have been removed due to [upstream deprecation](https://sourcehut.org/blog/2022-08-01-dispatch-deprecation-plans/).

     

       
39
       
39
       
 
       


     

       
40
       
40
       
-
       
- The [services.snapserver.openFirewall](#opt-services.snapserver.openFirewall) module option default value has been changed from `true` to `false`. You will need to explicitely set this option to `true`, or configure your firewall.

     

       
40
       
40
       
+
       
- The [services.snapserver.openFirewall](#opt-services.snapserver.openFirewall) module option default value has been changed from `true` to `false`. You will need to explicitly set this option to `true`, or configure your firewall.

     

       
41
       
41
       
 
       


     

       
42
       
42
       
-
       
- The [services.tmate-ssh-server.openFirewall](#opt-services.tmate-ssh-server.openFirewall) module option default value has been changed from `true` to `false`. You will need to explicitely set this option to `true`, or configure your firewall.

     

       
42
       
42
       
+
       
- The [services.tmate-ssh-server.openFirewall](#opt-services.tmate-ssh-server.openFirewall) module option default value has been changed from `true` to `false`. You will need to explicitly set this option to `true`, or configure your firewall.

     

       
43
       
43
       
 
       


     

       
44
       
44
       
-
       
- The [services.unifi-video.openFirewall](#opt-services.unifi-video.openFirewall) module option default value has been changed from `true` to `false`. You will need to explicitely set this option to `true`, or configure your firewall.

     

       
44
       
44
       
+
       
- The [services.unifi-video.openFirewall](#opt-services.unifi-video.openFirewall) module option default value has been changed from `true` to `false`. You will need to explicitly set this option to `true`, or configure your firewall.

     

       
45
       
45
       
 
       


     

       
46
       
46
       
 
       
- The EC2 image module previously detected and automatically mounted ext3-formatted instance store devices and partitions in stage-1 (initramfs), storing `/tmp` on the first discovered device. This behaviour, which only catered to very specific use cases and could not be disabled, has been removed. Users relying on this should provide their own implementation, and probably use ext4 and perform the mount in stage-2.

     

       
47
       
47
       
 
       


     
···

       
77
       
77
       
 
       
- A new `virtualisation.rosetta` module was added to allow running `x86_64` binaries through [Rosetta](https://developer.apple.com/documentation/apple-silicon/about-the-rosetta-translation-environment) inside virtualised NixOS guests on Apple silicon. This feature works by default with the [UTM](https://docs.getutm.app/) virtualisation [package](https://search.nixos.org/packages?channel=unstable&show=utm&from=0&size=1&sort=relevance&type=packages&query=utm).

     

       
78
       
78
       
 
       


     

       
79
       
79
       
 
       
- The new option `users.motdFile` allows configuring a Message Of The Day that can be updated dynamically.

     

       
80
       
80
       
+
       


     

       
81
       
81
       
+
       
- Enabling global redirect in `services.nginx.virtualHosts` now allows one to add exceptions with the `locations` option.

     

       
80
       
82
       
 
       


     

       
81
       
83
       
 
       
- Resilio sync secret keys can now be provided using a secrets file at runtime, preventing these secrets from ending up in the Nix store.

     

       
82
       
84
       
 
       


     

···

       
19
       
19
       
 
       
{ pkgs

     

       
20
       
20
       
 
       
, lib

     

       
21
       
21
       
 
       
, options

     

       
22
       
22
       
-
       
, transformOptions ? lib.id  # function for additional tranformations of the options

     

       
22
       
22
       
+
       
, transformOptions ? lib.id  # function for additional transformations of the options

     

       
23
       
23
       
 
       
, documentType ? "appendix" # TODO deprecate "appendix" in favor of "none"

     

       
24
       
24
       
 
       
                            #      and/or rename function to moduleOptionDoc for clean slate

     

       
25
       
25
       
 
       


     

···

       
8
       
8
       
 
       
  # https://salsa.debian.org/debian/gnupg2/-/blob/debian/main/debian/scdaemon.udev

     

       
9
       
9
       
 
       


     

       
10
       
10
       
 
       
  # the latest rev of the entire debian gnupg2 repo as of 2021-04-28

     

       
11
       
11
       
-
       
  # the scdaemon.udev file was last commited on 2021-01-05 (7817a03):

     

       
11
       
11
       
+
       
  # the scdaemon.udev file was last committed on 2021-01-05 (7817a03):

     

       
12
       
12
       
 
       
  scdaemonUdevRev = "01898735a015541e3ffb43c7245ac1e612f40836";

     

       
13
       
13
       
 
       


     

       
14
       
14
       
 
       
  scdaemonRules = pkgs.fetchurl {

     

···

       
110
       
110
       
 
       
    boot.extraModulePackages = [ kernelPackages.openrazer ];

     

       
111
       
111
       
 
       
    boot.kernelModules = drivers;

     

       
112
       
112
       
 
       


     

       
113
       
113
       
-
       
    # Makes the man pages available so you can succesfully run

     

       
113
       
113
       
+
       
    # Makes the man pages available so you can successfully run

     

       
114
       
114
       
 
       
    # > systemctl --user help openrazer-daemon

     

       
115
       
115
       
 
       
    environment.systemPackages = [ pkgs.python3Packages.openrazer-daemon.man ];

     

       
116
       
116
       
 
       


     

···

       
100
       
100
       
 
       
              default = {};

     

       
101
       
101
       
 
       
              description = lib.mdDoc ''

     

       
102
       
102
       
 
       
                Sets PPD options for the printer.

     

       
103
       
103
       
-
       
                {command}`lpoptions [-p printername] -l` shows suported PPD options for the given printer.

     

       
103
       
103
       
+
       
                {command}`lpoptions [-p printername] -l` shows supported PPD options for the given printer.

     

       
104
       
104
       
 
       
              '';

     

       
105
       
105
       
 
       
            };

     

       
106
       
106
       
 
       
          };

     

···

       
81
       
81
       
 
       


     

       
82
       
82
       
 
       
  # The configuration file for syslinux.

     

       
83
       
83
       
 
       


     

       
84
       
84
       
-
       
  # Notes on syslinux configuration and UNetbootin compatiblity:

     

       
84
       
84
       
+
       
  # Notes on syslinux configuration and UNetbootin compatibility:

     

       
85
       
85
       
 
       
  #   * Do not use '/syslinux/syslinux.cfg' as the path for this

     

       
86
       
86
       
 
       
  #     configuration. UNetbootin will not parse the file and use it as-is.

     

       
87
       
87
       
 
       
  #     This results in a broken configuration if the partition label does

     

···

       
27
       
27
       
 
       
        variable (defaults to the value of

     

       
28
       
28
       
 
       
        {option}`system.nixos.version`).

     

       
29
       
29
       
 
       


     

       
30
       
30
       
-
       
        Can be overriden by setting {env}`NIXOS_LABEL`.

     

       
30
       
30
       
+
       
        Can be overridden by setting {env}`NIXOS_LABEL`.

     

       
31
       
31
       
 
       


     

       
32
       
32
       
 
       
        Useful for not loosing track of configurations built from different

     

       
33
       
33
       
 
       
        nixos branches/revisions, e.g.:

     

···

       
714
       
714
       
 
       
        default = false;

     

       
715
       
715
       
 
       
        description = lib.mdDoc ''

     

       
716
       
716
       
 
       
          Whether to use the root user when generating certs. This is not recommended

     

       
717
       
717
       
-
       
          for security + compatiblity reasons. If a service requires root owned certificates

     

       
717
       
717
       
+
       
          for security + compatibility reasons. If a service requires root owned certificates

     

       
718
       
718
       
 
       
          consider following the guide on "Using ACME with services demanding root

     

       
719
       
719
       
 
       
          owned certificates" in the NixOS manual, and only using this as a fallback

     

       
720
       
720
       
 
       
          or for testing.

     
···

       
765
       
765
       
 
       
      To use the let's encrypt staging server, use security.acme.server =

     

       
766
       
766
       
 
       
      "https://acme-staging-v02.api.letsencrypt.org/directory".

     

       
767
       
767
       
 
       
    '')

     

       
768
       
768
       
-
       
    (mkRemovedOptionModule [ "security" "acme" "directory" ] "ACME Directory is now hardcoded to /var/lib/acme and its permisisons are managed by systemd. See https://github.com/NixOS/nixpkgs/issues/53852 for more info.")

     

       
768
       
768
       
+
       
    (mkRemovedOptionModule [ "security" "acme" "directory" ] "ACME Directory is now hardcoded to /var/lib/acme and its permissions are managed by systemd. See https://github.com/NixOS/nixpkgs/issues/53852 for more info.")

     

       
769
       
769
       
 
       
    (mkRemovedOptionModule [ "security" "acme" "preDelay" ] "This option has been removed. If you want to make sure that something executes before certificates are provisioned, add a RequiredBy=acme-\${cert}.service to the service you want to execute before the cert renewal")

     

       
770
       
770
       
 
       
    (mkRemovedOptionModule [ "security" "acme" "activationDelay" ] "This option has been removed. If you want to make sure that something executes before certificates are provisioned, add a RequiredBy=acme-\${cert}.service to the service you want to execute before the cert renewal")

     

       
771
       
771
       
 
       
    (mkChangedOptionModule [ "security" "acme" "validMin" ] [ "security" "acme" "defaults" "validMinDays" ] (config: config.security.acme.validMin / (24 * 3600)))

     

···

       
202
       
202
       
 
       
          # (indirectly read from /etc/apparmor.d/*, without recursing into sub-directory).

     

       
203
       
203
       
 
       
          # Note that this does not remove profiles dynamically generated by libvirt.

     

       
204
       
204
       
 
       
          [ "${pkgs.apparmor-utils}/bin/aa-remove-unknown" ] ++

     

       
205
       
205
       
-
       
          # Optionaly kill the processes which are unconfined but now have a profile loaded

     

       
205
       
205
       
+
       
          # Optionally kill the processes which are unconfined but now have a profile loaded

     

       
206
       
206
       
 
       
          # (because AppArmor can only start to confine new processes).

     

       
207
       
207
       
 
       
          optional cfg.killUnconfinedConfinables killUnconfinedConfinables;

     

       
208
       
208
       
 
       
        ExecStop = "${pkgs.apparmor-utils}/bin/aa-teardown";

     

···

       
282
       
282
       
 
       
        defaultText = literalExpression "config.security.pam.mount.enable";

     

       
283
       
283
       
 
       
        type = types.bool;

     

       
284
       
284
       
 
       
        description = lib.mdDoc ''

     

       
285
       
285
       
-
       
          Enable PAM mount (pam_mount) system to mount fileystems on user login.

     

       
285
       
285
       
+
       
          Enable PAM mount (pam_mount) system to mount filesystems on user login.

     

       
286
       
286
       
 
       
        '';

     

       
287
       
287
       
 
       
      };

     

       
288
       
288
       
 
       


     
···

       
305
       
305
       
 
       
        default = false;

     

       
306
       
306
       
 
       
        type = types.bool;

     

       
307
       
307
       
 
       
        description = lib.mdDoc ''

     

       
308
       
308
       
-
       
          Wheather the delay after typing a wrong password should be disabled.

     

       
308
       
308
       
+
       
          Whether the delay after typing a wrong password should be disabled.

     

       
309
       
309
       
 
       
        '';

     

       
310
       
310
       
 
       
      };

     

       
311
       
311
       
 
       


     

···

       
24
       
24
       
 
       
        type = types.bool;

     

       
25
       
25
       
 
       
        default = false;

     

       
26
       
26
       
 
       
        description = lib.mdDoc ''

     

       
27
       
27
       
-
       
          Enable PAM mount system to mount fileystems on user login.

     

       
27
       
27
       
+
       
          Enable PAM mount system to mount filesystems on user login.

     

       
28
       
28
       
 
       
        '';

     

       
29
       
29
       
 
       
      };

     

       
30
       
30
       
 
       


     

···

       
202
       
202
       
 
       
      internal    = true;

     

       
203
       
203
       
 
       
      description = lib.mdDoc ''

     

       
204
       
204
       
 
       
        This option defines the path to the wrapper programs. It

     

       
205
       
205
       
-
       
        should not be overriden.

     

       
205
       
205
       
+
       
        should not be overridden.

     

       
206
       
206
       
 
       
      '';

     

       
207
       
207
       
 
       
    };

     

       
208
       
208
       
 
       
  };

     

···

       
48
       
48
       
 
       


     

       
49
       
49
       
 
       
      hostname = mkOption {

     

       
50
       
50
       
 
       
        type = types.nullOr types.str;

     

       
51
       
51
       
-
       
        description = lib.mdDoc "DNS name or IP address that will be used for the stream directory lookups or possibily the playlist generation if a Host header is not provided.";

     

       
51
       
51
       
+
       
        description = lib.mdDoc "DNS name or IP address that will be used for the stream directory lookups or possibly the playlist generation if a Host header is not provided.";

     

       
52
       
52
       
 
       
        default = config.networking.domain;

     

       
53
       
53
       
 
       
        defaultText = literalExpression "config.networking.domain";

     

       
54
       
54
       
 
       
      };

     

···

       
12
       
12
       
 
       
      enable = mkEnableOption (lib.mdDoc "ZFS snapshot replication.");

     

       
13
       
13
       
 
       


     

       
14
       
14
       
 
       
      followDelete = mkOption {

     

       
15
       
15
       
-
       
        description = lib.mdDoc "Remove remote snapshots that don't have a local correspondant.";

     

       
15
       
15
       
+
       
        description = lib.mdDoc "Remove remote snapshots that don't have a local correspondent.";

     

       
16
       
16
       
 
       
        default = true;

     

       
17
       
17
       
 
       
        type = types.bool;

     

       
18
       
18
       
 
       
      };

     
···

       
30
       
30
       
 
       
      };

     

       
31
       
31
       
 
       


     

       
32
       
32
       
 
       
      localFilesystem = mkOption {

     

       
33
       
33
       
-
       
        description = lib.mdDoc "Local ZFS fileystem from which snapshots should be sent.  Defaults to the attribute name.";

     

       
33
       
33
       
+
       
        description = lib.mdDoc "Local ZFS filesystem from which snapshots should be sent.  Defaults to the attribute name.";

     

       
34
       
34
       
 
       
        example = "pool/file/path";

     

       
35
       
35
       
 
       
        type = types.str;

     

       
36
       
36
       
 
       
      };

     

···

       
9
       
9
       
 
       
      The znapzend backup plan to use for the source.

     

       
10
       
10
       
 
       


     

       
11
       
11
       
 
       
      The plan specifies how often to backup and for how long to keep the

     

       
12
       
12
       
-
       
      backups. It consists of a series of retention periodes to interval

     

       
12
       
12
       
+
       
      backups. It consists of a series of retention periods to interval

     

       
13
       
13
       
 
       
      associations:

     

       
14
       
14
       
 
       


     

       
15
       
15
       
 
       
      ```

     
···

       
268
       
268
       
 
       


     

       
269
       
269
       
 
       
  mkSrcAttrs = srcCfg: with srcCfg; {

     

       
270
       
270
       
 
       
    enabled = onOff enable;

     

       
271
       
271
       
-
       
    # mbuffer is not referenced by its full path to accomodate non-NixOS systems or differing mbuffer versions between source and target

     

       
271
       
271
       
+
       
    # mbuffer is not referenced by its full path to accommodate non-NixOS systems or differing mbuffer versions between source and target

     

       
272
       
272
       
 
       
    mbuffer = with mbuffer; if enable then "mbuffer"

     

       
273
       
273
       
 
       
        + optionalString (port != null) ":${toString port}" else "off";

     

       
274
       
274
       
 
       
    mbuffer_size = mbuffer.size;

     
···

       
372
       
372
       
 
       
        compressed feature which adds the options `-Lce` to

     

       
373
       
373
       
 
       
        the {command}`zfs send` command. When this is enabled, make

     

       
374
       
374
       
 
       
        sure that both the sending and receiving pool have the same relevant

     

       
375
       
375
       
-
       
        features enabled. Using `-c` will skip unneccessary

     

       
375
       
375
       
+
       
        features enabled. Using `-c` will skip unnecessary

     

       
376
       
376
       
 
       
        decompress-compress stages, `-L` is for large block

     

       
377
       
377
       
 
       
        support and -e is for embedded data support. see

     

       
378
       
378
       
 
       
        {manpage}`znapzend(1)`

     

···

       
51
       
51
       
 
       
              type = types.bool;

     

       
52
       
52
       
 
       
              default = false;

     

       
53
       
53
       
 
       
              description = lib.mdDoc ''

     

       
54
       
54
       
-
       
                Explictly disables syncing of deposit logs from the execution node.

     

       
54
       
54
       
+
       
                Explicitly disables syncing of deposit logs from the execution node.

     

       
55
       
55
       
 
       
                This overrides any previous option that depends on it.

     

       
56
       
56
       
 
       
                Useful if you intend to run a non-validating beacon node.

     

       
57
       
57
       
 
       
              '';

     

···

       
22
       
22
       
 
       


     

       
23
       
23
       
 
       
    bootstrapAddons = mkOption {

     

       
24
       
24
       
 
       
      description = lib.mdDoc ''

     

       
25
       
25
       
-
       
        Bootstrap addons are like regular addons, but they are applied with cluster-admin rigths.

     

       
25
       
25
       
+
       
        Bootstrap addons are like regular addons, but they are applied with cluster-admin rights.

     

       
26
       
26
       
 
       
        They are applied at addon-manager startup only.

     

       
27
       
27
       
 
       
      '';

     

       
28
       
28
       
 
       
      default = { };

     

···

       
323
       
323
       
 
       
          systemctl restart flannel

     

       
324
       
324
       
 
       
        ''}

     

       
325
       
325
       
 
       


     

       
326
       
326
       
-
       
        echo "Node joined succesfully"

     

       
326
       
326
       
+
       
        echo "Node joined successfully"

     

       
327
       
327
       
 
       
      '')];

     

       
328
       
328
       
 
       


     

       
329
       
329
       
 
       
      # isolate etcd on loopback at the master node

     

···

       
1
       
1
       
-
       
# NixOS module for Buildbot continous integration server.

     

       
1
       
1
       
+
       
# NixOS module for Buildbot continuous integration server.

     

       
2
       
2
       
 
       


     

       
3
       
3
       
 
       
{ config, lib, options, pkgs, ... }:

     

       
4
       
4
       
 
       


     

···

       
49
       
49
       
 
       
      registration token on startup as needed. Make sure the PAT has a scope of

     

       
50
       
50
       
 
       
      `admin:org` for organization-wide registrations or a scope of

     

       
51
       
51
       
 
       
      `repo` for a single repository. Fine-grained PATs need read and write permission

     

       
52
       
52
       
-
       
      to the "Adminstration" resources.

     

       
52
       
52
       
+
       
      to the "Administration" resources.

     

       
53
       
53
       
 
       


     

       
54
       
54
       
 
       
      Changing this option or the file's content triggers a new runner registration.

     

       
55
       
55
       
 
       
    '';

     

···

       
141
       
141
       
 
       
      default = false;

     

       
142
       
142
       
 
       
      description = lib.mdDoc ''

     

       
143
       
143
       
 
       
        Finish all remaining jobs before stopping.

     

       
144
       
144
       
-
       
        If not set gitlab-runner will stop immediatly without waiting

     

       
144
       
144
       
+
       
        If not set gitlab-runner will stop immediately without waiting

     

       
145
       
145
       
 
       
        for jobs to finish, which will lead to failed builds.

     

       
146
       
146
       
 
       
      '';

     

       
147
       
147
       
 
       
    };

     

···

       
15
       
15
       
 
       
      default = false;

     

       
16
       
16
       
 
       
      description = lib.mdDoc ''

     

       
17
       
17
       
 
       
        Enables the Hail Auto Update Service. Hail can automatically deploy artifacts

     

       
18
       
18
       
-
       
        built by a Hydra Continous Integration server. A common use case is to provide

     

       
19
       
19
       
-
       
        continous deployment for single services or a full NixOS configuration.'';

     

       
18
       
18
       
+
       
        built by a Hydra Continuous Integration server. A common use case is to provide

     

       
19
       
19
       
+
       
        continuous deployment for single services or a full NixOS configuration.'';

     

       
20
       
20
       
 
       
    };

     

       
21
       
21
       
 
       
    profile = mkOption {

     

       
22
       
22
       
 
       
      type = types.str;

     

···

       
14
       
14
       
 
       
#

     

       
15
       
15
       
 
       
# Be careful, virtuoso-opensource also provides a different isql command !

     

       
16
       
16
       
 
       


     

       
17
       
17
       
-
       
# There are at least two ways to run firebird. superserver has been choosen

     

       
17
       
17
       
+
       
# There are at least two ways to run firebird. superserver has been chosen

     

       
18
       
18
       
 
       
# however there are no strong reasons to prefer this or the other one AFAIK

     

       
19
       
19
       
 
       
# Eg superserver is said to be most efficiently using resources according to

     

       
20
       
20
       
 
       
# http://www.firebirdsql.org/manual/qsg25-classic-or-super.html

     

···

       
45
       
45
       
 
       
      default = !(cfg.settings ? initial_session);

     

       
46
       
46
       
 
       
      defaultText = literalExpression "!(config.services.greetd.settings ? initial_session)";

     

       
47
       
47
       
 
       
      description = lib.mdDoc ''

     

       
48
       
48
       
-
       
        Wether to restart greetd when it terminates (e.g. on failure).

     

       
48
       
48
       
+
       
        Whether to restart greetd when it terminates (e.g. on failure).

     

       
49
       
49
       
 
       
        This is usually desirable so a user can always log in, but should be disabled when using 'settings.initial_session' (autologin),

     

       
50
       
50
       
 
       
        because every greetd restart will trigger the autologin again.

     

       
51
       
51
       
 
       
      '';

     

···

       
35
       
35
       
 
       
      description = lib.mdDoc ''

     

       
36
       
36
       
 
       
        If enabled, starts the ArchisSteamFarm service.

     

       
37
       
37
       
 
       
        For configuring the SteamGuard token you will need to use the web-ui, which is enabled by default over on 127.0.0.1:1242.

     

       
38
       
38
       
-
       
        You cannot configure ASF in any way outside of nix, since all the config files get wiped on restart and replaced with the programatically set ones by nix.

     

       
38
       
38
       
+
       
        You cannot configure ASF in any way outside of nix, since all the config files get wiped on restart and replaced with the programnatically set ones by nix.

     

       
39
       
39
       
 
       
      '';

     

       
40
       
40
       
 
       
      default = false;

     

       
41
       
41
       
 
       
    };

     
···

       
98
       
98
       
 
       
    ipcPasswordFile = mkOption {

     

       
99
       
99
       
 
       
      type = types.nullOr types.path;

     

       
100
       
100
       
 
       
      default = null;

     

       
101
       
101
       
-
       
      description = lib.mdDoc "Path to a file containig the password. The file must be readable by the `asf` user/group.";

     

       
101
       
101
       
+
       
      description = lib.mdDoc "Path to a file containing the password. The file must be readable by the `asf` user/group.";

     

       
102
       
102
       
 
       
    };

     

       
103
       
103
       
 
       


     

       
104
       
104
       
 
       
    ipcSettings = mkOption {

     
···

       
129
       
129
       
 
       
          };

     

       
130
       
130
       
 
       
          passwordFile = mkOption {

     

       
131
       
131
       
 
       
            type = types.path;

     

       
132
       
132
       
-
       
            description = lib.mdDoc "Path to a file containig the password. The file must be readable by the `asf` user/group.";

     

       
132
       
132
       
+
       
            description = lib.mdDoc "Path to a file containing the password. The file must be readable by the `asf` user/group.";

     

       
133
       
133
       
 
       
          };

     

       
134
       
134
       
 
       
          enabled = mkOption {

     

       
135
       
135
       
 
       
            type = types.bool;

     

···

       
62
       
62
       
 
       
          Path to logfile for logging.

     

       
63
       
63
       
 
       


     

       
64
       
64
       
 
       
          If set to null, logging will be output to stdout which means

     

       
65
       
65
       
-
       
          all output will be catched by systemd.

     

       
65
       
65
       
+
       
          all output will be caught by systemd.

     

       
66
       
66
       
 
       
        '';

     

       
67
       
67
       
 
       
      };

     

       
68
       
68
       
 
       


     

···

       
19
       
19
       
 
       
          [lircd]

     

       
20
       
20
       
 
       
          nodaemon = False

     

       
21
       
21
       
 
       
        '';

     

       
22
       
22
       
-
       
        description = lib.mdDoc "LIRC default options descriped in man:lircd(8) ({file}`lirc_options.conf`)";

     

       
22
       
22
       
+
       
        description = lib.mdDoc "LIRC default options described in man:lircd(8) ({file}`lirc_options.conf`)";

     

       
23
       
23
       
 
       
      };

     

       
24
       
24
       
 
       


     

       
25
       
25
       
 
       
      configs = mkOption {

     

···

       
141
       
141
       
 
       
      description = lib.mdDoc ''

     

       
142
       
142
       
 
       
        Enable saned network daemon for remote connection to scanners.

     

       
143
       
143
       
 
       


     

       
144
       
144
       
-
       
        saned would be runned from `scanner` user; to allow

     

       
144
       
144
       
+
       
        saned would be run from `scanner` user; to allow

     

       
145
       
145
       
 
       
        access to hardware that doesn't have `scanner` group

     

       
146
       
146
       
 
       
        you should add needed groups to this user.

     

       
147
       
147
       
 
       
      '';

     

···

       
163
       
163
       
 
       
              default = null;

     

       
164
       
164
       
 
       
              description = lib.mdDoc ''

     

       
165
       
165
       
 
       
                How often to rotate the logs. Defaults to previously set global setting,

     

       
166
       
166
       
-
       
                which itself defauts to weekly.

     

       
166
       
166
       
+
       
                which itself defaults to weekly.

     

       
167
       
167
       
 
       
              '';

     

       
168
       
168
       
 
       
            };

     

       
169
       
169
       
 
       


     

···

       
113
       
113
       
 
       
          type = types.str;

     

       
114
       
114
       
 
       
          example = "/run/secrets/ldap-bind";

     

       
115
       
115
       
 
       
          description = lib.mdDoc ''

     

       
116
       
116
       
-
       
            Path to the file containing the bind password of the servie account

     

       
116
       
116
       
+
       
            Path to the file containing the bind password of the service account

     

       
117
       
117
       
 
       
            defined by [](#opt-services.mailman.ldap.bindDn).

     

       
118
       
118
       
 
       
          '';

     

       
119
       
119
       
 
       
        };

     

···

       
234
       
234
       
 
       


     

       
235
       
235
       
 
       
  headerChecks = concatStringsSep "\n" (map (x: "${x.pattern} ${x.action}") cfg.headerChecks) + cfg.extraHeaderChecks;

     

       
236
       
236
       
 
       


     

       
237
       
237
       
-
       
  aliases = let seperator = if cfg.aliasMapType == "hash" then ":" else ""; in

     

       
237
       
237
       
+
       
  aliases = let separator = if cfg.aliasMapType == "hash" then ":" else ""; in

     

       
238
       
238
       
 
       
    optionalString (cfg.postmasterAlias != "") ''

     

       
239
       
239
       
-
       
      postmaster${seperator} ${cfg.postmasterAlias}

     

       
239
       
239
       
+
       
      postmaster${separator} ${cfg.postmasterAlias}

     

       
240
       
240
       
 
       
    ''

     

       
241
       
241
       
 
       
    + optionalString (cfg.rootAlias != "") ''

     

       
242
       
242
       
-
       
      root${seperator} ${cfg.rootAlias}

     

       
242
       
242
       
+
       
      root${separator} ${cfg.rootAlias}

     

       
243
       
243
       
 
       
    ''

     

       
244
       
244
       
 
       
    + cfg.extraAliases

     

       
245
       
245
       
 
       
  ;

     

···

       
39
       
39
       
 
       
      '';

     

       
40
       
40
       
 
       


     

       
41
       
41
       
 
       
      description = lib.mdDoc ''

     

       
42
       
42
       
-
       
        The package which contains roundcube's sources. Can be overriden to create

     

       
42
       
42
       
+
       
        The package which contains roundcube's sources. Can be overridden to create

     

       
43
       
43
       
 
       
        an environment which contains roundcube and third-party plugins.

     

       
44
       
44
       
 
       
      '';

     

       
45
       
45
       
 
       
    };

     
···

       
92
       
92
       
 
       
      default = [];

     

       
93
       
93
       
 
       
      example = literalExpression "with pkgs.aspellDicts; [ en fr de ]";

     

       
94
       
94
       
 
       
      description = lib.mdDoc ''

     

       
95
       
95
       
-
       
        List of aspell dictionnaries for spell checking. If empty, spell checking is disabled.

     

       
95
       
95
       
+
       
        List of aspell dictionaries for spell checking. If empty, spell checking is disabled.

     

       
96
       
96
       
 
       
      '';

     

       
97
       
97
       
 
       
    };

     

       
98
       
98