···

       
871
       
 
       
# adds `FOOBAR=baz` to `$out/bin/foo`’s environment

     

       
872
       
 
       
makeWrapper $out/bin/foo $wrapperfile --set FOOBAR baz

     

       
873
       
 
       


     

       
874
       
-
       
# prefixes the binary paths of `hello` and `git`

     

       
0
       
 
       

     

       
875
       
 
       
# Be advised that paths often should be patched in directly

     

       
876
       
 
       
# (via string replacements or in `configurePhase`).

     

       
877
       
-
       
makeWrapper $out/bin/foo $wrapperfile --prefix PATH : ${lib.makeBinPath [ hello git ]}

     

       
0
       
 
       

     

       
0
       
 
       

     

       
878
       
 
       
```

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
879
       
 
       


     

       
880
       
 
       
There’s many more kinds of arguments, they are documented in `nixpkgs/pkgs/build-support/setup-hooks/make-wrapper.sh` for the `makeWrapper` implementation and in `nixpkgs/pkgs/build-support/setup-hooks/make-binary-wrapper/make-binary-wrapper.sh` for the `makeBinaryWrapper` implementation.

     

       
881
       
 
       


     

···

       
871
       
 
       
# adds `FOOBAR=baz` to `$out/bin/foo`’s environment

     

       
872
       
 
       
makeWrapper $out/bin/foo $wrapperfile --set FOOBAR baz

     

       
873
       
 
       


     

       
874
       
+
       
# Prefixes the binary paths of `hello` and `git`

     

       
875
       
+
       
# and suffixes the binary path of `xdg-utils`.

     

       
876
       
 
       
# Be advised that paths often should be patched in directly

     

       
877
       
 
       
# (via string replacements or in `configurePhase`).

     

       
878
       
+
       
makeWrapper $out/bin/foo $wrapperfile \

     

       
879
       
+
       
  --prefix PATH : ${lib.makeBinPath [ hello git ]} \

     

       
880
       
+
       
  --suffix PATH : ${lib.makeBinPath [ xdg-utils ]}

     

       
881
       
 
       
```

     

       
882
       
+
       


     

       
883
       
+
       
Packages may expect or require other utilities to be available at runtime.

     

       
884
       
+
       
`makeWrapper` can be used to add packages to a `PATH` environment variable local to a wrapper.

     

       
885
       
+
       


     

       
886
       
+
       
Use `--prefix` to explicitly set dependencies in `PATH`.

     

       
887
       
+
       


     

       
888
       
+
       
:::{note}

     

       
889
       
+
       
`--prefix` essentially hard-codes dependencies into the wrapper.

     

       
890
       
+
       
They cannot be overridden without rebuilding the package.

     

       
891
       
+
       
:::

     

       
892
       
+
       


     

       
893
       
+
       
If dependencies should be resolved at runtime, use `--suffix` to append fallback values to `PATH`.

     

       
894
       
 
       


     

       
895
       
 
       
There’s many more kinds of arguments, they are documented in `nixpkgs/pkgs/build-support/setup-hooks/make-wrapper.sh` for the `makeWrapper` implementation and in `nixpkgs/pkgs/build-support/setup-hooks/make-binary-wrapper/make-binary-wrapper.sh` for the `makeBinaryWrapper` implementation.

     

       
896
       
 
       


     

···

       
204
       
 
       
            admin_server = SYSLOG:NOTICE

     

       
205
       
 
       
            default      = SYSLOG:NOTICE

     

       
206
       
 
       
        '';

     

       
207
       
-
       
        description = ''

     

       
208
       
-
       
          These lines go to the end of <literal>krb5.conf</literal> verbatim.

     

       
209
       
-
       
          <literal>krb5.conf</literal> may include any of the relations that are

     

       
210
       
-
       
          valid for <literal>kdc.conf</literal> (see <literal>man

     

       
211
       
-
       
          kdc.conf</literal>), but it is not a recommended practice.

     

       
212
       
 
       
        '';

     

       
213
       
 
       
      };

     

       
214
       
 
       


     

···

       
204
       
 
       
            admin_server = SYSLOG:NOTICE

     

       
205
       
 
       
            default      = SYSLOG:NOTICE

     

       
206
       
 
       
        '';

     

       
207
       
+
       
        description = lib.mdDoc ''

     

       
208
       
+
       
          These lines go to the end of `krb5.conf` verbatim.

     

       
209
       
+
       
          `krb5.conf` may include any of the relations that are

     

       
210
       
+
       
          valid for `kdc.conf` (see `man kdc.conf`),

     

       
211
       
+
       
          but it is not a recommended practice.

     

       
212
       
 
       
        '';

     

       
213
       
 
       
      };

     

       
214
       
 
       


     

···

       
186
       
 
       
        policy = mkOption {

     

       
187
       
 
       
          default = "hard_open";

     

       
188
       
 
       
          type = types.enum [ "hard_open" "hard_init" "soft" ];

     

       
189
       
-
       
          description = ''

     

       
190
       
 
       
            Specifies the policy to use for reconnecting to an unavailable

     

       
191
       
-
       
            LDAP server. The default is <literal>hard_open</literal>, which

     

       
192
       
 
       
            reconnects if opening the connection to the directory server

     

       
193
       
-
       
            failed. By contrast, <literal>hard_init</literal> reconnects if

     

       
194
       
 
       
            initializing the connection failed. Initializing may not

     

       
195
       
 
       
            actually contact the directory server, and it is possible that

     

       
196
       
 
       
            a malformed configuration file will trigger reconnection. If

     

       
197
       
-
       
            <literal>soft</literal> is specified, then

     

       
198
       
-
       
            <package>nss_ldap</package> will return immediately on server

     

       
199
       
 
       
            failure. All hard reconnect policies block with exponential

     

       
200
       
 
       
            backoff before retrying.

     

       
201
       
 
       
          '';

     

···

       
186
       
 
       
        policy = mkOption {

     

       
187
       
 
       
          default = "hard_open";

     

       
188
       
 
       
          type = types.enum [ "hard_open" "hard_init" "soft" ];

     

       
189
       
+
       
          description = lib.mdDoc ''

     

       
190
       
 
       
            Specifies the policy to use for reconnecting to an unavailable

     

       
191
       
+
       
            LDAP server. The default is `hard_open`, which

     

       
192
       
 
       
            reconnects if opening the connection to the directory server

     

       
193
       
+
       
            failed. By contrast, `hard_init` reconnects if

     

       
194
       
 
       
            initializing the connection failed. Initializing may not

     

       
195
       
 
       
            actually contact the directory server, and it is possible that

     

       
196
       
 
       
            a malformed configuration file will trigger reconnection. If

     

       
197
       
+
       
            `soft` is specified, then

     

       
198
       
+
       
            `nss_ldap` will return immediately on server

     

       
199
       
 
       
            failure. All hard reconnect policies block with exponential

     

       
200
       
 
       
            backoff before retrying.

     

       
201
       
 
       
          '';

     

···

       
84
       
 
       
          <programlisting>${defaultPackagesText}</programlisting>

     

       
85
       
 
       
        '';

     

       
86
       
 
       
        example = [];

     

       
87
       
-
       
        description = ''

     

       
88
       
 
       
          Set of default packages that aren't strictly necessary

     

       
89
       
 
       
          for a running system, entries can be removed for a more

     

       
90
       
 
       
          minimal NixOS installation.

     

       
91
       
 
       


     

       
92
       
-
       
          Note: If <package>pkgs.nano</package> is removed from this list,

     

       
93
       
 
       
          make sure another editor is installed and the

     

       
94
       
-
       
          <literal>EDITOR</literal> environment variable is set to it.

     

       
95
       
 
       
          Environment variables can be set using

     

       
96
       
-
       
          <option>environment.variables</option>.

     

       
97
       
 
       


     

       
98
       
 
       
          Like with systemPackages, packages are installed to

     

       
99
       
-
       
          <filename>/run/current-system/sw</filename>. They are

     

       
100
       
 
       
          automatically available to all users, and are

     

       
101
       
 
       
          automatically updated every time you rebuild the system

     

       
102
       
 
       
          configuration.

     

···

       
84
       
 
       
          <programlisting>${defaultPackagesText}</programlisting>

     

       
85
       
 
       
        '';

     

       
86
       
 
       
        example = [];

     

       
87
       
+
       
        description = lib.mdDoc ''

     

       
88
       
 
       
          Set of default packages that aren't strictly necessary

     

       
89
       
 
       
          for a running system, entries can be removed for a more

     

       
90
       
 
       
          minimal NixOS installation.

     

       
91
       
 
       


     

       
92
       
+
       
          Note: If `pkgs.nano` is removed from this list,

     

       
93
       
 
       
          make sure another editor is installed and the

     

       
94
       
+
       
          `EDITOR` environment variable is set to it.

     

       
95
       
 
       
          Environment variables can be set using

     

       
96
       
+
       
          {option}`environment.variables`.

     

       
97
       
 
       


     

       
98
       
 
       
          Like with systemPackages, packages are installed to

     

       
99
       
+
       
          {file}`/run/current-system/sw`. They are

     

       
100
       
 
       
          automatically available to all users, and are

     

       
101
       
 
       
          automatically updated every time you rebuild the system

     

       
102
       
 
       
          configuration.

     

···

       
40
       
 
       
    extraPortals = mkOption {

     

       
41
       
 
       
      type = types.listOf types.package;

     

       
42
       
 
       
      default = [ ];

     

       
43
       
-
       
      description = ''

     

       
44
       
 
       
        List of additional portals to add to path. Portals allow interaction

     

       
45
       
 
       
        with system, like choosing files or taking screenshots. At minimum,

     

       
46
       
 
       
        a desktop portal implementation should be listed. GNOME and KDE already

     

       
47
       
-
       
        adds <package>xdg-desktop-portal-gtk</package>; and

     

       
48
       
-
       
        <package>xdg-desktop-portal-kde</package> respectively. On other desktop

     

       
49
       
 
       
        environments you probably want to add them yourself.

     

       
50
       
 
       
      '';

     

       
51
       
 
       
    };

     

···

       
40
       
 
       
    extraPortals = mkOption {

     

       
41
       
 
       
      type = types.listOf types.package;

     

       
42
       
 
       
      default = [ ];

     

       
43
       
+
       
      description = lib.mdDoc ''

     

       
44
       
 
       
        List of additional portals to add to path. Portals allow interaction

     

       
45
       
 
       
        with system, like choosing files or taking screenshots. At minimum,

     

       
46
       
 
       
        a desktop portal implementation should be listed. GNOME and KDE already

     

       
47
       
+
       
        adds `xdg-desktop-portal-gtk`; and

     

       
48
       
+
       
        `xdg-desktop-portal-kde` respectively. On other desktop

     

       
49
       
 
       
        environments you probably want to add them yourself.

     

       
50
       
 
       
      '';

     

       
51
       
 
       
    };

     

···

       
15
       
 
       
    enable = mkEnableOption ''

     

       
16
       
 
       
      the desktop portal for the LXQt desktop environment.

     

       
17
       
 
       


     

       
18
       
-
       
      This will add the <package>lxqt.xdg-desktop-portal-lxqt</package>

     

       
19
       
 
       
      package (with the extra Qt styles) into the

     

       
20
       
 
       
      <option>xdg.portal.extraPortals</option> option

     

       
21
       
 
       
    '';

     
···

       
29
       
 
       
        pkgs.qtcurve

     

       
30
       
 
       
      ];

     

       
31
       
 
       
      '';

     

       
32
       
-
       
      description = ''

     

       
33
       
 
       
        Extra Qt styles that will be available to the

     

       
34
       
-
       
        <package>lxqt.xdg-desktop-portal-lxqt</package>.

     

       
35
       
 
       
      '';

     

       
36
       
 
       
    };

     

       
37
       
 
       
  };

     

···

       
15
       
 
       
    enable = mkEnableOption ''

     

       
16
       
 
       
      the desktop portal for the LXQt desktop environment.

     

       
17
       
 
       


     

       
18
       
+
       
      This will add the <literal>lxqt.xdg-desktop-portal-lxqt</literal>

     

       
19
       
 
       
      package (with the extra Qt styles) into the

     

       
20
       
 
       
      <option>xdg.portal.extraPortals</option> option

     

       
21
       
 
       
    '';

     
···

       
29
       
 
       
        pkgs.qtcurve

     

       
30
       
 
       
      ];

     

       
31
       
 
       
      '';

     

       
32
       
+
       
      description = lib.mdDoc ''

     

       
33
       
 
       
        Extra Qt styles that will be available to the

     

       
34
       
+
       
        `lxqt.xdg-desktop-portal-lxqt`.

     

       
35
       
 
       
      '';

     

       
36
       
 
       
    };

     

       
37
       
 
       
  };

     

···

       
17
       
 
       
    enable = mkEnableOption ''

     

       
18
       
 
       
      desktop portal for wlroots-based desktops

     

       
19
       
 
       


     

       
20
       
-
       
      This will add the <package>xdg-desktop-portal-wlr</package> package into

     

       
21
       
 
       
      the <option>xdg.portal.extraPortals</option> option, and provide the

     

       
22
       
 
       
      configuration file

     

       
23
       
 
       
    '';

     

       
24
       
 
       


     

       
25
       
 
       
    settings = mkOption {

     

       
26
       
-
       
      description = ''

     

       
27
       
-
       
        Configuration for <package>xdg-desktop-portal-wlr</package>.

     

       
28
       
 
       


     

       
29
       
-
       
        See <literal>xdg-desktop-portal-wlr(5)</literal> for supported

     

       
30
       
 
       
        values.

     

       
31
       
 
       
      '';

     

       
32
       
 
       


     

···

       
17
       
 
       
    enable = mkEnableOption ''

     

       
18
       
 
       
      desktop portal for wlroots-based desktops

     

       
19
       
 
       


     

       
20
       
+
       
      This will add the <literal>xdg-desktop-portal-wlr</literal> package into

     

       
21
       
 
       
      the <option>xdg.portal.extraPortals</option> option, and provide the

     

       
22
       
 
       
      configuration file

     

       
23
       
 
       
    '';

     

       
24
       
 
       


     

       
25
       
 
       
    settings = mkOption {

     

       
26
       
+
       
      description = lib.mdDoc ''

     

       
27
       
+
       
        Configuration for `xdg-desktop-portal-wlr`.

     

       
28
       
 
       


     

       
29
       
+
       
        See `xdg-desktop-portal-wlr(5)` for supported

     

       
30
       
 
       
        values.

     

       
31
       
 
       
      '';

     

       
32
       
 
       


     

···

       
103
       
 
       
        default = "zstd";

     

       
104
       
 
       
        example = "lz4";

     

       
105
       
 
       
        type = with types; either (enum [ "lzo" "lz4" "zstd" ]) str;

     

       
106
       
-
       
        description = ''

     

       
107
       
-
       
          Compression algorithm. <literal>lzo</literal> has good compression,

     

       
108
       
-
       
          but is slow. <literal>lz4</literal> has bad compression, but is fast.

     

       
109
       
-
       
          <literal>zstd</literal> is both good compression and fast, but requires newer kernel.

     

       
110
       
 
       
          You can check what other algorithms are supported by your zram device with

     

       
111
       
-
       
          <programlisting>cat /sys/class/block/zram*/comp_algorithm</programlisting>

     

       
112
       
 
       
        '';

     

       
113
       
 
       
      };

     

       
114
       
 
       
    };

     

···

       
103
       
 
       
        default = "zstd";

     

       
104
       
 
       
        example = "lz4";

     

       
105
       
 
       
        type = with types; either (enum [ "lzo" "lz4" "zstd" ]) str;

     

       
106
       
+
       
        description = lib.mdDoc ''

     

       
107
       
+
       
          Compression algorithm. `lzo` has good compression,

     

       
108
       
+
       
          but is slow. `lz4` has bad compression, but is fast.

     

       
109
       
+
       
          `zstd` is both good compression and fast, but requires newer kernel.

     

       
110
       
 
       
          You can check what other algorithms are supported by your zram device with

     

       
111
       
+
       
          {command}`cat /sys/class/block/zram*/comp_algorithm`

     

       
112
       
 
       
        '';

     

       
113
       
 
       
      };

     

       
114
       
 
       
    };

     

···

       
20
       
 
       
        type = types.str;

     

       
21
       
 
       
        default = "0xfffd7fff";

     

       
22
       
 
       
        example = "0xffffffff";

     

       
23
       
-
       
        description = ''

     

       
24
       
 
       
          Sets the `amdgpu.ppfeaturemask` kernel option.

     

       
25
       
 
       
          In particular, it is used here to set the overdrive bit.

     

       
26
       
 
       
          Default is `0xfffd7fff` as it is less likely to cause flicker issues.

     

···

       
20
       
 
       
        type = types.str;

     

       
21
       
 
       
        default = "0xfffd7fff";

     

       
22
       
 
       
        example = "0xffffffff";

     

       
23
       
+
       
        description = lib.mdDoc ''

     

       
24
       
 
       
          Sets the `amdgpu.ppfeaturemask` kernel option.

     

       
25
       
 
       
          In particular, it is used here to set the overdrive bit.

     

       
26
       
 
       
          Default is `0xfffd7fff` as it is less likely to cause flicker issues.

     

···

       
8
       
 
       
    options.hardware.cpu.amd.sev = {

     

       
9
       
 
       
      enable = mkEnableOption "access to the AMD SEV device";

     

       
10
       
 
       
      user = mkOption {

     

       
11
       
-
       
        description = "Owner to assign to the SEV device.";

     

       
12
       
 
       
        type = types.str;

     

       
13
       
 
       
        default = "root";

     

       
14
       
 
       
      };

     

       
15
       
 
       
      group = mkOption {

     

       
16
       
-
       
        description = "Group to assign to the SEV device.";

     

       
17
       
 
       
        type = types.str;

     

       
18
       
 
       
        default = defaultGroup;

     

       
19
       
 
       
      };

     

       
20
       
 
       
      mode = mkOption {

     

       
21
       
-
       
        description = "Mode to set for the SEV device.";

     

       
22
       
 
       
        type = types.str;

     

       
23
       
 
       
        default = "0660";

     

       
24
       
 
       
      };

     

···

       
8
       
 
       
    options.hardware.cpu.amd.sev = {

     

       
9
       
 
       
      enable = mkEnableOption "access to the AMD SEV device";

     

       
10
       
 
       
      user = mkOption {

     

       
11
       
+
       
        description = lib.mdDoc "Owner to assign to the SEV device.";

     

       
12
       
 
       
        type = types.str;

     

       
13
       
 
       
        default = "root";

     

       
14
       
 
       
      };

     

       
15
       
 
       
      group = mkOption {

     

       
16
       
+
       
        description = lib.mdDoc "Group to assign to the SEV device.";

     

       
17
       
 
       
        type = types.str;

     

       
18
       
 
       
        default = defaultGroup;

     

       
19
       
 
       
      };

     

       
20
       
 
       
      mode = mkOption {

     

       
21
       
+
       
        description = lib.mdDoc "Mode to set for the SEV device.";

     

       
22
       
 
       
        type = types.str;

     

       
23
       
 
       
        default = "0660";

     

       
24
       
 
       
      };

     

···

       
35
       
 
       
  options.sdImage = {

     

       
36
       
 
       
    imageName = mkOption {

     

       
37
       
 
       
      default = "${config.sdImage.imageBaseName}-${config.system.nixos.label}-${pkgs.stdenv.hostPlatform.system}.img";

     

       
38
       
-
       
      description = ''

     

       
39
       
 
       
        Name of the generated image file.

     

       
40
       
 
       
      '';

     

       
41
       
 
       
    };

     

       
42
       
 
       


     

       
43
       
 
       
    imageBaseName = mkOption {

     

       
44
       
 
       
      default = "nixos-sd-image";

     

       
45
       
-
       
      description = ''

     

       
46
       
 
       
        Prefix of the name of the generated image file.

     

       
47
       
 
       
      '';

     

       
48
       
 
       
    };

     
···

       
50
       
 
       
    storePaths = mkOption {

     

       
51
       
 
       
      type = with types; listOf package;

     

       
52
       
 
       
      example = literalExpression "[ pkgs.stdenv ]";

     

       
53
       
-
       
      description = ''

     

       
54
       
 
       
        Derivations to be included in the Nix store in the generated SD image.

     

       
55
       
 
       
      '';

     

       
56
       
 
       
    };

     
···

       
74
       
 
       
    firmwarePartitionID = mkOption {

     

       
75
       
 
       
      type = types.str;

     

       
76
       
 
       
      default = "0x2178694e";

     

       
77
       
-
       
      description = ''

     

       
78
       
 
       
        Volume ID for the /boot/firmware partition on the SD card. This value

     

       
79
       
 
       
        must be a 32-bit hexadecimal number.

     

       
80
       
 
       
      '';

     
···

       
83
       
 
       
    firmwarePartitionName = mkOption {

     

       
84
       
 
       
      type = types.str;

     

       
85
       
 
       
      default = "FIRMWARE";

     

       
86
       
-
       
      description = ''

     

       
87
       
 
       
        Name of the filesystem which holds the boot firmware.

     

       
88
       
 
       
      '';

     

       
89
       
 
       
    };

     
···

       
92
       
 
       
      type = types.nullOr types.str;

     

       
93
       
 
       
      default = null;

     

       
94
       
 
       
      example = "14e19a7b-0ae0-484d-9d54-43bd6fdc20c7";

     

       
95
       
-
       
      description = ''

     

       
96
       
 
       
        UUID for the filesystem on the main NixOS partition on the SD card.

     

       
97
       
 
       
      '';

     

       
98
       
 
       
    };

     
···

       
101
       
 
       
      type = types.int;

     

       
102
       
 
       
      # As of 2019-08-18 the Raspberry pi firmware + u-boot takes ~18MiB

     

       
103
       
 
       
      default = 30;

     

       
104
       
-
       
      description = ''

     

       
105
       
 
       
        Size of the /boot/firmware partition, in megabytes.

     

       
106
       
 
       
      '';

     

       
107
       
 
       
    };

     

       
108
       
 
       


     

       
109
       
 
       
    populateFirmwareCommands = mkOption {

     

       
110
       
 
       
      example = literalExpression "'' cp \${pkgs.myBootLoader}/u-boot.bin firmware/ ''";

     

       
111
       
-
       
      description = ''

     

       
112
       
 
       
        Shell commands to populate the ./firmware directory.

     

       
113
       
 
       
        All files in that directory are copied to the

     

       
114
       
 
       
        /boot/firmware partition on the SD image.

     
···

       
117
       
 
       


     

       
118
       
 
       
    populateRootCommands = mkOption {

     

       
119
       
 
       
      example = literalExpression "''\${config.boot.loader.generic-extlinux-compatible.populateCmd} -c \${config.system.build.toplevel} -d ./files/boot''";

     

       
120
       
-
       
      description = ''

     

       
121
       
 
       
        Shell commands to populate the ./files directory.

     

       
122
       
 
       
        All files in that directory are copied to the

     

       
123
       
 
       
        root (/) partition on the SD image. Use this to

     
···

       
128
       
 
       
    postBuildCommands = mkOption {

     

       
129
       
 
       
      example = literalExpression "'' dd if=\${pkgs.myBootLoader}/SPL of=$img bs=1024 seek=1 conv=notrunc ''";

     

       
130
       
 
       
      default = "";

     

       
131
       
-
       
      description = ''

     

       
132
       
 
       
        Shell commands to run after the image is built.

     

       
133
       
 
       
        Can be used for boards requiring to dd u-boot SPL before actual partitions.

     

       
134
       
 
       
      '';

     
···

       
137
       
 
       
    compressImage = mkOption {

     

       
138
       
 
       
      type = types.bool;

     

       
139
       
 
       
      default = true;

     

       
140
       
-
       
      description = ''

     

       
141
       
 
       
        Whether the SD image should be compressed using

     

       
142
       
-
       
        <command>zstd</command>.

     

       
143
       
 
       
      '';

     

       
144
       
 
       
    };

     

       
145
       
 
       


     

       
146
       
 
       
    expandOnBoot = mkOption {

     

       
147
       
 
       
      type = types.bool;

     

       
148
       
 
       
      default = true;

     

       
149
       
-
       
      description = ''

     

       
150
       
 
       
        Whether to configure the sd image to expand it's partition on boot.

     

       
151
       
 
       
      '';

     

       
152
       
 
       
    };

     

···

       
35
       
 
       
  options.sdImage = {

     

       
36
       
 
       
    imageName = mkOption {

     

       
37
       
 
       
      default = "${config.sdImage.imageBaseName}-${config.system.nixos.label}-${pkgs.stdenv.hostPlatform.system}.img";

     

       
38
       
+
       
      description = lib.mdDoc ''

     

       
39
       
 
       
        Name of the generated image file.

     

       
40
       
 
       
      '';

     

       
41
       
 
       
    };

     

       
42
       
 
       


     

       
43
       
 
       
    imageBaseName = mkOption {

     

       
44
       
 
       
      default = "nixos-sd-image";

     

       
45
       
+
       
      description = lib.mdDoc ''

     

       
46
       
 
       
        Prefix of the name of the generated image file.

     

       
47
       
 
       
      '';

     

       
48
       
 
       
    };

     
···

       
50
       
 
       
    storePaths = mkOption {

     

       
51
       
 
       
      type = with types; listOf package;

     

       
52
       
 
       
      example = literalExpression "[ pkgs.stdenv ]";

     

       
53
       
+
       
      description = lib.mdDoc ''

     

       
54
       
 
       
        Derivations to be included in the Nix store in the generated SD image.

     

       
55
       
 
       
      '';

     

       
56
       
 
       
    };

     
···

       
74
       
 
       
    firmwarePartitionID = mkOption {

     

       
75
       
 
       
      type = types.str;

     

       
76
       
 
       
      default = "0x2178694e";

     

       
77
       
+
       
      description = lib.mdDoc ''

     

       
78
       
 
       
        Volume ID for the /boot/firmware partition on the SD card. This value

     

       
79
       
 
       
        must be a 32-bit hexadecimal number.

     

       
80
       
 
       
      '';

     
···

       
83
       
 
       
    firmwarePartitionName = mkOption {

     

       
84
       
 
       
      type = types.str;

     

       
85
       
 
       
      default = "FIRMWARE";

     

       
86
       
+
       
      description = lib.mdDoc ''

     

       
87
       
 
       
        Name of the filesystem which holds the boot firmware.

     

       
88
       
 
       
      '';

     

       
89
       
 
       
    };

     
···

       
92
       
 
       
      type = types.nullOr types.str;

     

       
93
       
 
       
      default = null;

     

       
94
       
 
       
      example = "14e19a7b-0ae0-484d-9d54-43bd6fdc20c7";

     

       
95
       
+
       
      description = lib.mdDoc ''

     

       
96
       
 
       
        UUID for the filesystem on the main NixOS partition on the SD card.

     

       
97
       
 
       
      '';

     

       
98
       
 
       
    };

     
···

       
101
       
 
       
      type = types.int;

     

       
102
       
 
       
      # As of 2019-08-18 the Raspberry pi firmware + u-boot takes ~18MiB

     

       
103
       
 
       
      default = 30;

     

       
104
       
+
       
      description = lib.mdDoc ''

     

       
105
       
 
       
        Size of the /boot/firmware partition, in megabytes.

     

       
106
       
 
       
      '';

     

       
107
       
 
       
    };

     

       
108
       
 
       


     

       
109
       
 
       
    populateFirmwareCommands = mkOption {

     

       
110
       
 
       
      example = literalExpression "'' cp \${pkgs.myBootLoader}/u-boot.bin firmware/ ''";

     

       
111
       
+
       
      description = lib.mdDoc ''

     

       
112
       
 
       
        Shell commands to populate the ./firmware directory.

     

       
113
       
 
       
        All files in that directory are copied to the

     

       
114
       
 
       
        /boot/firmware partition on the SD image.

     
···

       
117
       
 
       


     

       
118
       
 
       
    populateRootCommands = mkOption {

     

       
119
       
 
       
      example = literalExpression "''\${config.boot.loader.generic-extlinux-compatible.populateCmd} -c \${config.system.build.toplevel} -d ./files/boot''";

     

       
120
       
+
       
      description = lib.mdDoc ''

     

       
121
       
 
       
        Shell commands to populate the ./files directory.

     

       
122
       
 
       
        All files in that directory are copied to the

     

       
123
       
 
       
        root (/) partition on the SD image. Use this to

     
···

       
128
       
 
       
    postBuildCommands = mkOption {

     

       
129
       
 
       
      example = literalExpression "'' dd if=\${pkgs.myBootLoader}/SPL of=$img bs=1024 seek=1 conv=notrunc ''";

     

       
130
       
 
       
      default = "";

     

       
131
       
+
       
      description = lib.mdDoc ''

     

       
132
       
 
       
        Shell commands to run after the image is built.

     

       
133
       
 
       
        Can be used for boards requiring to dd u-boot SPL before actual partitions.

     

       
134
       
 
       
      '';

     
···

       
137
       
 
       
    compressImage = mkOption {

     

       
138
       
 
       
      type = types.bool;

     

       
139
       
 
       
      default = true;

     

       
140
       
+
       
      description = lib.mdDoc ''

     

       
141
       
 
       
        Whether the SD image should be compressed using

     

       
142
       
+
       
        {command}`zstd`.

     

       
143
       
 
       
      '';

     

       
144
       
 
       
    };

     

       
145
       
 
       


     

       
146
       
 
       
    expandOnBoot = mkOption {

     

       
147
       
 
       
      type = types.bool;

     

       
148
       
 
       
      default = true;

     

       
149
       
+
       
      description = lib.mdDoc ''

     

       
150
       
 
       
        Whether to configure the sd image to expand it's partition on boot.

     

       
151
       
 
       
      '';

     

       
152
       
 
       
    };

     

···

       
241
       
 
       
      nixos.extraModules = mkOption {

     

       
242
       
 
       
        type = types.listOf types.raw;

     

       
243
       
 
       
        default = [];

     

       
244
       
-
       
        description = ''

     

       
245
       
 
       
          Modules for which to show options even when not imported.

     

       
246
       
 
       
        '';

     

       
247
       
 
       
      };

     

···

       
241
       
 
       
      nixos.extraModules = mkOption {

     

       
242
       
 
       
        type = types.listOf types.raw;

     

       
243
       
 
       
        default = [];

     

       
244
       
+
       
        description = lib.mdDoc ''

     

       
245
       
 
       
          Modules for which to show options even when not imported.

     

       
246
       
 
       
        '';

     

       
247
       
 
       
      };

     

···

       
117
       
 
       
      '';

     

       
118
       
 
       
      type = pkgsType;

     

       
119
       
 
       
      example = literalExpression "import <nixpkgs> {}";

     

       
120
       
-
       
      description = ''

     

       
121
       
 
       
        If set, the pkgs argument to all NixOS modules is the value of

     

       
122
       
-
       
        this option, extended with <literal>nixpkgs.overlays</literal>, if

     

       
123
       
-
       
        that is also set. Either <literal>nixpkgs.crossSystem</literal> or

     

       
124
       
-
       
        <literal>nixpkgs.localSystem</literal> will be used in an assertion

     

       
125
       
 
       
        to check that the NixOS and Nixpkgs architectures match. Any

     

       
126
       
-
       
        other options in <literal>nixpkgs.*</literal>, notably <literal>config</literal>,

     

       
127
       
 
       
        will be ignored.

     

       
128
       
 
       


     

       
129
       
 
       
        If unset, the pkgs argument to all NixOS modules is determined

     
···

       
132
       
 
       
        The default value imports the Nixpkgs source files

     

       
133
       
 
       
        relative to the location of this NixOS module, because

     

       
134
       
 
       
        NixOS and Nixpkgs are distributed together for consistency,

     

       
135
       
-
       
        so the <literal>nixos</literal> in the default value is in fact a

     

       
136
       
-
       
        relative path. The <literal>config</literal>, <literal>overlays</literal>,

     

       
137
       
-
       
        <literal>localSystem</literal>, and <literal>crossSystem</literal> come

     

       
138
       
 
       
        from this option's siblings.

     

       
139
       
 
       


     

       
140
       
 
       
        This option can be used by applications like NixOps to increase

     

       
141
       
 
       
        the performance of evaluation, or to create packages that depend

     

       
142
       
 
       
        on a container that should be built with the exact same evaluation

     

       
143
       
 
       
        of Nixpkgs, for example. Applications like this should set

     

       
144
       
-
       
        their default value using <literal>lib.mkDefault</literal>, so

     

       
145
       
 
       
        user-provided configuration can override it without using

     

       
146
       
-
       
        <literal>lib</literal>.

     

       
147
       
 
       


     

       
148
       
 
       
        Note that using a distinct version of Nixpkgs with NixOS may

     

       
149
       
 
       
        be an unexpected source of problems. Use this option with care.

     

···

       
117
       
 
       
      '';

     

       
118
       
 
       
      type = pkgsType;

     

       
119
       
 
       
      example = literalExpression "import <nixpkgs> {}";

     

       
120
       
+
       
      description = lib.mdDoc ''

     

       
121
       
 
       
        If set, the pkgs argument to all NixOS modules is the value of

     

       
122
       
+
       
        this option, extended with `nixpkgs.overlays`, if

     

       
123
       
+
       
        that is also set. Either `nixpkgs.crossSystem` or

     

       
124
       
+
       
        `nixpkgs.localSystem` will be used in an assertion

     

       
125
       
 
       
        to check that the NixOS and Nixpkgs architectures match. Any

     

       
126
       
+
       
        other options in `nixpkgs.*`, notably `config`,

     

       
127
       
 
       
        will be ignored.

     

       
128
       
 
       


     

       
129
       
 
       
        If unset, the pkgs argument to all NixOS modules is determined

     
···

       
132
       
 
       
        The default value imports the Nixpkgs source files

     

       
133
       
 
       
        relative to the location of this NixOS module, because

     

       
134
       
 
       
        NixOS and Nixpkgs are distributed together for consistency,

     

       
135
       
+
       
        so the `nixos` in the default value is in fact a

     

       
136
       
+
       
        relative path. The `config`, `overlays`,

     

       
137
       
+
       
        `localSystem`, and `crossSystem` come

     

       
138
       
 
       
        from this option's siblings.

     

       
139
       
 
       


     

       
140
       
 
       
        This option can be used by applications like NixOps to increase

     

       
141
       
 
       
        the performance of evaluation, or to create packages that depend

     

       
142
       
 
       
        on a container that should be built with the exact same evaluation

     

       
143
       
 
       
        of Nixpkgs, for example. Applications like this should set

     

       
144
       
+
       
        their default value using `lib.mkDefault`, so

     

       
145
       
 
       
        user-provided configuration can override it without using

     

       
146
       
+
       
        `lib`.

     

       
147
       
 
       


     

       
148
       
 
       
        Note that using a distinct version of Nixpkgs with NixOS may

     

       
149
       
 
       
        be an unexpected source of problems. Use this option with care.

     

···

       
23
       
 
       
          }

     

       
24
       
 
       
        '';

     

       
25
       
 
       


     

       
26
       
-
       
        description = ''

     

       
27
       
 
       
          A set with the key names being the environment variable you'd like to

     

       
28
       
 
       
          set and the values being a list of paths to text documents containing

     

       
29
       
 
       
          lists of words. The various files will be merged, sorted, duplicates

     

···

       
23
       
 
       
          }

     

       
24
       
 
       
        '';

     

       
25
       
 
       


     

       
26
       
+
       
        description = lib.mdDoc ''

     

       
27
       
 
       
          A set with the key names being the environment variable you'd like to

     

       
28
       
 
       
          set and the values being a list of paths to text documents containing

     

       
29
       
 
       
          lists of words. The various files will be merged, sorted, duplicates

     

···

       
85
       
 
       
      bindInterface = mkOption {

     

       
86
       
 
       
        default = true;

     

       
87
       
 
       
        type = types.bool;

     

       
88
       
-
       
        description = ''

     

       
89
       
-
       
          Binds <package>captive-browser</package> to the network interface declared in

     

       
90
       
-
       
          <literal>cfg.interface</literal>. This can be used to avoid collisions

     

       
91
       
 
       
          with private subnets.

     

       
92
       
 
       
        '';

     

       
93
       
 
       
      };

     

···

       
85
       
 
       
      bindInterface = mkOption {

     

       
86
       
 
       
        default = true;

     

       
87
       
 
       
        type = types.bool;

     

       
88
       
+
       
        description = lib.mdDoc ''

     

       
89
       
+
       
          Binds `captive-browser` to the network interface declared in

     

       
90
       
+
       
          `cfg.interface`. This can be used to avoid collisions

     

       
91
       
 
       
          with private subnets.

     

       
92
       
 
       
        '';

     

       
93
       
 
       
      };

     

···

       
76
       
 
       


     

       
77
       
 
       
      extraOpts = mkOption {

     

       
78
       
 
       
        type = types.attrs;

     

       
79
       
-
       
        description = ''

     

       
80
       
 
       
          Extra chromium policy options. A list of available policies

     

       
81
       
 
       
          can be found in the Chrome Enterprise documentation:

     

       
82
       
-
       
          <link xlink:href="https://cloud.google.com/docs/chrome-enterprise/policies/">https://cloud.google.com/docs/chrome-enterprise/policies/</link>

     

       
83
       
 
       
          Make sure the selected policy is supported on Linux and your browser version.

     

       
84
       
 
       
        '';

     

       
85
       
 
       
        default = {};

     

···

       
76
       
 
       


     

       
77
       
 
       
      extraOpts = mkOption {

     

       
78
       
 
       
        type = types.attrs;

     

       
79
       
+
       
        description = lib.mdDoc ''

     

       
80
       
 
       
          Extra chromium policy options. A list of available policies

     

       
81
       
 
       
          can be found in the Chrome Enterprise documentation:

     

       
82
       
+
       
          <https://cloud.google.com/docs/chrome-enterprise/policies/>

     

       
83
       
 
       
          Make sure the selected policy is supported on Linux and your browser version.

     

       
84
       
 
       
        '';

     

       
85
       
 
       
        default = {};

     

···

       
8
       
 
       
    enable = mkOption {

     

       
9
       
 
       
      type = types.bool;

     

       
10
       
 
       
      default = false;

     

       
11
       
-
       
      description = ''

     

       
12
       
 
       
        Whether to enable k3b, the KDE disk burning application.

     

       
13
       
 
       


     

       
14
       
-
       
        Additionally to installing <package>k3b</package> enabling this will

     

       
15
       
-
       
        add <literal>setuid</literal> wrappers in <literal>/run/wrappers/bin</literal>

     

       
16
       
-
       
        for both <package>cdrdao</package> and <package>cdrecord</package>. On first

     

       
17
       
-
       
        run you must manually configure the path of <package>cdrdae</package> and

     

       
18
       
-
       
        <package>cdrecord</package> to correspond to the appropriate paths under

     

       
19
       
-
       
        <literal>/run/wrappers/bin</literal> in the "Setup External Programs" menu.

     

       
20
       
 
       
      '';

     

       
21
       
 
       
    };

     

       
22
       
 
       
  };

     

···

       
8
       
 
       
    enable = mkOption {

     

       
9
       
 
       
      type = types.bool;

     

       
10
       
 
       
      default = false;

     

       
11
       
+
       
      description = lib.mdDoc ''

     

       
12
       
 
       
        Whether to enable k3b, the KDE disk burning application.

     

       
13
       
 
       


     

       
14
       
+
       
        Additionally to installing `k3b` enabling this will

     

       
15
       
+
       
        add `setuid` wrappers in `/run/wrappers/bin`

     

       
16
       
+
       
        for both `cdrdao` and `cdrecord`. On first

     

       
17
       
+
       
        run you must manually configure the path of `cdrdae` and

     

       
18
       
+
       
        `cdrecord` to correspond to the appropriate paths under

     

       
19
       
+
       
        `/run/wrappers/bin` in the "Setup External Programs" menu.

     

       
20
       
 
       
      '';

     

       
21
       
 
       
    };

     

       
22
       
 
       
  };

     

···

       
17
       
 
       
      type = lib.types.bool;

     

       
18
       
 
       
    };

     

       
19
       
 
       
    withUtempter = mkOption {

     

       
20
       
-
       
      description = ''

     

       
21
       
 
       
        Whether to enable libutempter for mosh.

     

       
22
       
 
       
        This is required so that mosh can write to /var/run/utmp (which can be queried with `who` to display currently connected user sessions).

     

       
23
       
 
       
        Note, this will add a guid wrapper for the group utmp!

     

···

       
17
       
 
       
      type = lib.types.bool;

     

       
18
       
 
       
    };

     

       
19
       
 
       
    withUtempter = mkOption {

     

       
20
       
+
       
      description = lib.mdDoc ''

     

       
21
       
 
       
        Whether to enable libutempter for mosh.

     

       
22
       
 
       
        This is required so that mosh can write to /var/run/utmp (which can be queried with `who` to display currently connected user sessions).

     

       
23
       
 
       
        Note, this will add a guid wrapper for the group utmp!

     

···

       
45
       
 
       
            passwordeval = "cat /secrets/password.txt";

     

       
46
       
 
       
          };

     

       
47
       
 
       
        };

     

       
48
       
-
       
        description = ''

     

       
49
       
 
       
          Named accounts and their respective configurations.

     

       
50
       
 
       
          The special name "default" allows a default account to be defined.

     

       
51
       
 
       
          See msmtp(1) for the available options.

     

···

       
45
       
 
       
            passwordeval = "cat /secrets/password.txt";

     

       
46
       
 
       
          };

     

       
47
       
 
       
        };

     

       
48
       
+
       
        description = lib.mdDoc ''

     

       
49
       
 
       
          Named accounts and their respective configurations.

     

       
50
       
 
       
          The special name "default" allows a default account to be defined.

     

       
51
       
 
       
          See msmtp(1) for the available options.

     

···

       
93
       
 
       
      extraConfig = mkOption {

     

       
94
       
 
       
        type = types.lines;

     

       
95
       
 
       
        default = "";

     

       
96
       
-
       
        description = ''

     

       
97
       
-
       
          Extra configuration text prepended to <filename>ssh_config</filename>. Other generated

     

       
98
       
-
       
          options will be added after a <literal>Host *</literal> pattern.

     

       
99
       
-
       
          See <citerefentry><refentrytitle>ssh_config</refentrytitle><manvolnum>5</manvolnum></citerefentry>

     

       
100
       
 
       
          for help.

     

       
101
       
 
       
        '';

     

       
102
       
 
       
      };

     

···

       
93
       
 
       
      extraConfig = mkOption {

     

       
94
       
 
       
        type = types.lines;

     

       
95
       
 
       
        default = "";

     

       
96
       
+
       
        description = lib.mdDoc ''

     

       
97
       
+
       
          Extra configuration text prepended to {file}`ssh_config`. Other generated

     

       
98
       
+
       
          options will be added after a `Host *` pattern.

     

       
99
       
+
       
          See {manpage}`ssh_config(5)`

     

       
100
       
 
       
          for help.

     

       
101
       
 
       
        '';

     

       
102
       
 
       
      };

     

···

       
22
       
 
       
          default = "fuck";

     

       
23
       
 
       
          type = types.str;

     

       
24
       
 
       


     

       
25
       
-
       
          description = ''

     

       
26
       
 
       
            `thefuck` needs an alias to be configured.

     

       
27
       
 
       
            The default value is `fuck`, but you can use anything else as well.

     

       
28
       
 
       
          '';

     

···

       
22
       
 
       
          default = "fuck";

     

       
23
       
 
       
          type = types.str;

     

       
24
       
 
       


     

       
25
       
+
       
          description = lib.mdDoc ''

     

       
26
       
 
       
            `thefuck` needs an alias to be configured.

     

       
27
       
 
       
            The default value is `fuck`, but you can use anything else as well.

     

       
28
       
 
       
          '';

     

···

       
95
       
 
       
        exclude.dir     /nix/store

     

       
96
       
 
       
        include.encrypt /home/.../*

     

       
97
       
 
       
      '';

     

       
98
       
-
       
      description = ''

     

       
99
       
-
       
        <literal>include.*</literal> and

     

       
100
       
-
       
        <literal>exclude.*</literal> directives to be

     

       
101
       
 
       
        used when sending files to the IBM TSM server.

     

       
102
       
 
       
        The lines will be written into a file that the

     

       
103
       
-
       
        <literal>inclexcl</literal>

     

       
104
       
-
       
        directive in <filename>dsm.sys</filename> points to.

     

       
105
       
 
       
      '';

     

       
106
       
 
       
    };

     

       
107
       
 
       
    options.extraConfig = mkOption {

     

···

       
95
       
 
       
        exclude.dir     /nix/store

     

       
96
       
 
       
        include.encrypt /home/.../*

     

       
97
       
 
       
      '';

     

       
98
       
+
       
      description = lib.mdDoc ''

     

       
99
       
+
       
        `include.*` and

     

       
100
       
+
       
        `exclude.*` directives to be

     

       
101
       
 
       
        used when sending files to the IBM TSM server.

     

       
102
       
 
       
        The lines will be written into a file that the

     

       
103
       
+
       
        `inclexcl`

     

       
104
       
+
       
        directive in {file}`dsm.sys` points to.

     

       
105
       
 
       
      '';

     

       
106
       
 
       
    };

     

       
107
       
 
       
    options.extraConfig = mkOption {

     

···

       
62
       
 
       
          to use `yabar-unstable'.

     

       
63
       
 
       
        '';

     

       
64
       
 
       


     

       
65
       
-
       
        description = ''

     

       
66
       
 
       
          The package which contains the `yabar` binary.

     

       
67
       
 
       


     

       
68
       
 
       
          Nixpkgs provides the `yabar` and `yabar-unstable`

     

···

       
62
       
 
       
          to use `yabar-unstable'.

     

       
63
       
 
       
        '';

     

       
64
       
 
       


     

       
65
       
+
       
        description = lib.mdDoc ''

     

       
66
       
 
       
          The package which contains the `yabar` binary.

     

       
67
       
 
       


     

       
68
       
 
       
          Nixpkgs provides the `yabar` and `yabar-unstable`

     

···

       
49
       
 
       
        package = mkOption {

     

       
50
       
 
       
          default = pkgs.oh-my-zsh;

     

       
51
       
 
       
          defaultText = literalExpression "pkgs.oh-my-zsh";

     

       
52
       
-
       
          description = ''

     

       
53
       
 
       
            Package to install for `oh-my-zsh` usage.

     

       
54
       
 
       
          '';

     

       
55
       
 
       


     
···

       
67
       
 
       
        custom = mkOption {

     

       
68
       
 
       
          default = null;

     

       
69
       
 
       
          type = with types; nullOr str;

     

       
70
       
-
       
          description = ''

     

       
71
       
 
       
            Path to a custom oh-my-zsh package to override config of oh-my-zsh.

     

       
72
       
 
       
            (Can't be used along with `customPkgs`).

     

       
73
       
 
       
          '';

     
···

       
76
       
 
       
        customPkgs = mkOption {

     

       
77
       
 
       
          default = [];

     

       
78
       
 
       
          type = types.listOf types.package;

     

       
79
       
-
       
          description = ''

     

       
80
       
 
       
            List of custom packages that should be loaded into `oh-my-zsh`.

     

       
81
       
 
       
          '';

     

       
82
       
 
       
        };

     
···

       
92
       
 
       
        cacheDir = mkOption {

     

       
93
       
 
       
          default = "$HOME/.cache/oh-my-zsh";

     

       
94
       
 
       
          type = types.str;

     

       
95
       
-
       
          description = ''

     

       
96
       
 
       
            Cache directory to be used by `oh-my-zsh`.

     

       
97
       
 
       
            Without this option it would default to the read-only nix store.

     

       
98
       
 
       
          '';

     

···

       
49
       
 
       
        package = mkOption {

     

       
50
       
 
       
          default = pkgs.oh-my-zsh;

     

       
51
       
 
       
          defaultText = literalExpression "pkgs.oh-my-zsh";

     

       
52
       
+
       
          description = lib.mdDoc ''

     

       
53
       
 
       
            Package to install for `oh-my-zsh` usage.

     

       
54
       
 
       
          '';

     

       
55
       
 
       


     
···

       
67
       
 
       
        custom = mkOption {

     

       
68
       
 
       
          default = null;

     

       
69
       
 
       
          type = with types; nullOr str;

     

       
70
       
+
       
          description = lib.mdDoc ''

     

       
71
       
 
       
            Path to a custom oh-my-zsh package to override config of oh-my-zsh.

     

       
72
       
 
       
            (Can't be used along with `customPkgs`).

     

       
73
       
 
       
          '';

     
···

       
76
       
 
       
        customPkgs = mkOption {

     

       
77
       
 
       
          default = [];

     

       
78
       
 
       
          type = types.listOf types.package;

     

       
79
       
+
       
          description = lib.mdDoc ''

     

       
80
       
 
       
            List of custom packages that should be loaded into `oh-my-zsh`.

     

       
81
       
 
       
          '';

     

       
82
       
 
       
        };

     
···

       
92
       
 
       
        cacheDir = mkOption {

     

       
93
       
 
       
          default = "$HOME/.cache/oh-my-zsh";

     

       
94
       
 
       
          type = types.str;

     

       
95
       
+
       
          description = lib.mdDoc ''

     

       
96
       
 
       
            Cache directory to be used by `oh-my-zsh`.

     

       
97
       
 
       
            Without this option it would default to the read-only nix store.

     

       
98
       
 
       
          '';

     

···

       
11
       
 
       
      package = mkOption {

     

       
12
       
 
       
        default = pkgs.zsh-autoenv;

     

       
13
       
 
       
        defaultText = literalExpression "pkgs.zsh-autoenv";

     

       
14
       
-
       
        description = ''

     

       
15
       
 
       
          Package to install for `zsh-autoenv` usage.

     

       
16
       
 
       
        '';

     

       
17
       
 
       


     

···

       
11
       
 
       
      package = mkOption {

     

       
12
       
 
       
        default = pkgs.zsh-autoenv;

     

       
13
       
 
       
        defaultText = literalExpression "pkgs.zsh-autoenv";

     

       
14
       
+
       
        description = lib.mdDoc ''

     

       
15
       
 
       
          Package to install for `zsh-autoenv` usage.

     

       
16
       
 
       
        '';

     

       
17
       
 
       


     

···

       
24
       
 
       
    strategy = mkOption {

     

       
25
       
 
       
      type = types.listOf (types.enum [ "history" "completion" "match_prev_cmd" ]);

     

       
26
       
 
       
      default = [ "history" ];

     

       
27
       
-
       
      description = ''

     

       
28
       
 
       
        `ZSH_AUTOSUGGEST_STRATEGY` is an array that specifies how suggestions should be generated.

     

       
29
       
 
       
        The strategies in the array are tried successively until a suggestion is found.

     

       
30
       
 
       
        There are currently three built-in strategies to choose from:

     

···

       
24
       
 
       
    strategy = mkOption {

     

       
25
       
 
       
      type = types.listOf (types.enum [ "history" "completion" "match_prev_cmd" ]);

     

       
26
       
 
       
      default = [ "history" ];

     

       
27
       
+
       
      description = lib.mdDoc ''

     

       
28
       
 
       
        `ZSH_AUTOSUGGEST_STRATEGY` is an array that specifies how suggestions should be generated.

     

       
29
       
 
       
        The strategies in the array are tried successively until a suggestion is found.

     

       
30
       
 
       
        There are currently three built-in strategies to choose from:

     

···

       
676
       
 
       
      inheritDefaults = mkOption {

     

       
677
       
 
       
        default = true;

     

       
678
       
 
       
        example = true;

     

       
679
       
-
       
        description = "Whether to inherit values set in `security.acme.defaults` or not.";

     

       
680
       
 
       
        type = lib.types.bool;

     

       
681
       
 
       
      };

     

       
682
       
 
       
    };

     

···

       
676
       
 
       
      inheritDefaults = mkOption {

     

       
677
       
 
       
        default = true;

     

       
678
       
 
       
        example = true;

     

       
679
       
+
       
        description = lib.mdDoc "Whether to inherit values set in `security.acme.defaults` or not.";

     

       
680
       
 
       
        type = lib.types.bool;

     

       
681
       
 
       
      };

     

       
682
       
 
       
    };

     

···

       
94
       
 
       


     

       
95
       
 
       
          <note><para>If this is <literal>false</literal> the resulting store

     

       
96
       
 
       
          path will be non-deterministic and will be rebuilt every time the

     

       
97
       
-
       
          <package>openssl</package> package changes.</para></note>

     

       
98
       
 
       
        '';

     

       
99
       
 
       
      };

     

       
100
       
 
       


     

···

       
94
       
 
       


     

       
95
       
 
       
          <note><para>If this is <literal>false</literal> the resulting store

     

       
96
       
 
       
          path will be non-deterministic and will be rebuilt every time the

     

       
97
       
+
       
          <literal>openssl</literal> package changes.</para></note>

     

       
98
       
 
       
        '';

     

       
99
       
 
       
      };

     

       
100
       
 
       


     

···

       
320
       
 
       
      limits = mkOption {

     

       
321
       
 
       
        default = [];

     

       
322
       
 
       
        type = limitsType;

     

       
323
       
-
       
        description = ''

     

       
324
       
 
       
          Attribute set describing resource limits.  Defaults to the

     

       
325
       
-
       
          value of <option>security.pam.loginLimits</option>.

     

       
326
       
-
       
          The meaning of the values is explained in <citerefentry>

     

       
327
       
-
       
          <refentrytitle>limits.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry>.

     

       
328
       
 
       
        '';

     

       
329
       
 
       
      };

     

       
330
       
 
       


     
···

       
774
       
 
       
          }

     

       
775
       
 
       
       ];

     

       
776
       
 
       


     

       
777
       
-
       
     description =

     

       
778
       
-
       
       '' Define resource limits that should apply to users or groups.

     

       
779
       
-
       
          Each item in the list should be an attribute set with a

     

       
780
       
-
       
          <varname>domain</varname>, <varname>type</varname>,

     

       
781
       
-
       
          <varname>item</varname>, and <varname>value</varname>

     

       
782
       
-
       
          attribute.  The syntax and semantics of these attributes

     

       
783
       
-
       
          must be that described in <citerefentry><refentrytitle>limits.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry>.

     

       
784
       
 
       


     

       
785
       
-
       
          Note that these limits do not apply to systemd services,

     

       
786
       
-
       
          whose limits can be changed via <option>systemd.extraConfig</option>

     

       
787
       
-
       
          instead.

     

       
788
       
-
       
       '';

     

       
789
       
 
       
    };

     

       
790
       
 
       


     

       
791
       
 
       
    security.pam.services = mkOption {

     

···

       
320
       
 
       
      limits = mkOption {

     

       
321
       
 
       
        default = [];

     

       
322
       
 
       
        type = limitsType;

     

       
323
       
+
       
        description = lib.mdDoc ''

     

       
324
       
 
       
          Attribute set describing resource limits.  Defaults to the

     

       
325
       
+
       
          value of {option}`security.pam.loginLimits`.

     

       
326
       
+
       
          The meaning of the values is explained in {manpage}`limits.conf(5)`.

     

       
0
       
 
       

     

       
327
       
 
       
        '';

     

       
328
       
 
       
      };

     

       
329
       
 
       


     
···

       
773
       
 
       
          }

     

       
774
       
 
       
       ];

     

       
775
       
 
       


     

       
776
       
+
       
     description = ''

     

       
777
       
+
       
       Define resource limits that should apply to users or groups.

     

       
778
       
+
       
       Each item in the list should be an attribute set with a

     

       
779
       
+
       
       <varname>domain</varname>, <varname>type</varname>,

     

       
780
       
+
       
       <varname>item</varname>, and <varname>value</varname>

     

       
781
       
+
       
       attribute.  The syntax and semantics of these attributes

     

       
782
       
+
       
       must be that described in <citerefentry><refentrytitle>limits.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry>.

     

       
783
       
 
       


     

       
784
       
+
       
       Note that these limits do not apply to systemd services,

     

       
785
       
+
       
       whose limits can be changed via <option>systemd.extraConfig</option>

     

       
786
       
+
       
       instead.

     

       
787
       
+
       
     '';

     

       
788
       
 
       
    };

     

       
789
       
 
       


     

       
790
       
 
       
    security.pam.services = mkOption {

     

···

       
46
       
 
       
      type = types.package;

     

       
47
       
 
       
      default = pkgs.sudo;

     

       
48
       
 
       
      defaultText = literalExpression "pkgs.sudo";

     

       
49
       
-
       
      description = ''

     

       
50
       
 
       
        Which package to use for `sudo`.

     

       
51
       
 
       
      '';

     

       
52
       
 
       
    };

     

···

       
46
       
 
       
      type = types.package;

     

       
47
       
 
       
      default = pkgs.sudo;

     

       
48
       
 
       
      defaultText = literalExpression "pkgs.sudo";

     

       
49
       
+
       
      description = lib.mdDoc ''

     

       
50
       
 
       
        Which package to use for `sudo`.

     

       
51
       
 
       
      '';

     

       
52
       
 
       
    };

     

···

       
21
       
 
       
        "hbase.cluster.distributed" = "true";

     

       
22
       
 
       
      };

     

       
23
       
 
       
      type = types.attrsOf types.anything;

     

       
24
       
-
       
      description = ''

     

       
25
       
 
       
        Default options for hbase-site.xml

     

       
26
       
 
       
      '';

     

       
27
       
 
       
    };

     
···

       
30
       
 
       
      type = with types; attrsOf anything;

     

       
31
       
 
       
      example = literalExpression ''

     

       
32
       
 
       
      '';

     

       
33
       
-
       
      description = ''

     

       
34
       
 
       
        Additional options and overrides for hbase-site.xml

     

       
35
       
-
       
        <link xlink:href="https://github.com/apache/hbase/blob/rel/2.4.11/hbase-common/src/main/resources/hbase-default.xml"/>

     

       
36
       
 
       
      '';

     

       
37
       
 
       
    };

     

       
38
       
 
       
    hbaseSiteInternal = mkOption {

     
···

       
50
       
 
       
        type = types.package;

     

       
51
       
 
       
        default = pkgs.hbase;

     

       
52
       
 
       
        defaultText = literalExpression "pkgs.hbase";

     

       
53
       
-
       
        description = "HBase package";

     

       
54
       
 
       
      };

     

       
55
       
 
       


     

       
56
       
 
       
      rootdir = mkOption {

     

       
57
       
-
       
        description = ''

     

       
58
       
 
       
          This option will set "hbase.rootdir" in hbase-site.xml and determine

     

       
59
       
 
       
          the directory shared by region servers and into which HBase persists.

     

       
60
       
 
       
          The URL should be 'fully-qualified' to include the filesystem scheme.

     
···

       
68
       
 
       
        default = "/hbase";

     

       
69
       
 
       
      };

     

       
70
       
 
       
      zookeeperQuorum = mkOption {

     

       
71
       
-
       
        description = ''

     

       
72
       
 
       
          This option will set "hbase.zookeeper.quorum" in hbase-site.xml.

     

       
73
       
 
       
          Comma separated list of servers in the ZooKeeper ensemble.

     

       
74
       
 
       
        '';

     
···

       
83
       
 
       
        openFirewall = mkOption {

     

       
84
       
 
       
          type = types.bool;

     

       
85
       
 
       
          default = false;

     

       
86
       
-
       
          description = ''

     

       
87
       
 
       
            Open firewall ports for HBase master.

     

       
88
       
 
       
          '';

     

       
89
       
 
       
        };

     
···

       
94
       
 
       
        overrideHosts = mkOption {

     

       
95
       
 
       
          type = types.bool;

     

       
96
       
 
       
          default = true;

     

       
97
       
-
       
          description = ''

     

       
98
       
 
       
            Remove /etc/hosts entries for "127.0.0.2" and "::1" defined in nixos/modules/config/networking.nix

     

       
99
       
 
       
            Regionservers must be able to resolve their hostnames to their IP addresses, through PTR records

     

       
100
       
 
       
            or /etc/hosts entries.

     
···

       
105
       
 
       
        openFirewall = mkOption {

     

       
106
       
 
       
          type = types.bool;

     

       
107
       
 
       
          default = false;

     

       
108
       
-
       
          description = ''

     

       
109
       
 
       
            Open firewall ports for HBase master.

     

       
110
       
 
       
          '';

     

       
111
       
 
       
        };

     

···

       
21
       
 
       
        "hbase.cluster.distributed" = "true";

     

       
22
       
 
       
      };

     

       
23
       
 
       
      type = types.attrsOf types.anything;

     

       
24
       
+
       
      description = lib.mdDoc ''

     

       
25
       
 
       
        Default options for hbase-site.xml

     

       
26
       
 
       
      '';

     

       
27
       
 
       
    };

     
···

       
30
       
 
       
      type = with types; attrsOf anything;

     

       
31
       
 
       
      example = literalExpression ''

     

       
32
       
 
       
      '';

     

       
33
       
+
       
      description = lib.mdDoc ''

     

       
34
       
 
       
        Additional options and overrides for hbase-site.xml

     

       
35
       
+
       
        <https://github.com/apache/hbase/blob/rel/2.4.11/hbase-common/src/main/resources/hbase-default.xml>

     

       
36
       
 
       
      '';

     

       
37
       
 
       
    };

     

       
38
       
 
       
    hbaseSiteInternal = mkOption {

     
···

       
50
       
 
       
        type = types.package;

     

       
51
       
 
       
        default = pkgs.hbase;

     

       
52
       
 
       
        defaultText = literalExpression "pkgs.hbase";

     

       
53
       
+
       
        description = lib.mdDoc "HBase package";

     

       
54
       
 
       
      };

     

       
55
       
 
       


     

       
56
       
 
       
      rootdir = mkOption {

     

       
57
       
+
       
        description = lib.mdDoc ''

     

       
58
       
 
       
          This option will set "hbase.rootdir" in hbase-site.xml and determine

     

       
59
       
 
       
          the directory shared by region servers and into which HBase persists.

     

       
60
       
 
       
          The URL should be 'fully-qualified' to include the filesystem scheme.

     
···

       
68
       
 
       
        default = "/hbase";

     

       
69
       
 
       
      };

     

       
70
       
 
       
      zookeeperQuorum = mkOption {

     

       
71
       
+
       
        description = lib.mdDoc ''

     

       
72
       
 
       
          This option will set "hbase.zookeeper.quorum" in hbase-site.xml.

     

       
73
       
 
       
          Comma separated list of servers in the ZooKeeper ensemble.

     

       
74
       
 
       
        '';

     
···

       
83
       
 
       
        openFirewall = mkOption {

     

       
84
       
 
       
          type = types.bool;

     

       
85
       
 
       
          default = false;

     

       
86
       
+
       
          description = lib.mdDoc ''

     

       
87
       
 
       
            Open firewall ports for HBase master.

     

       
88
       
 
       
          '';

     

       
89
       
 
       
        };

     
···

       
94
       
 
       
        overrideHosts = mkOption {

     

       
95
       
 
       
          type = types.bool;

     

       
96
       
 
       
          default = true;

     

       
97
       
+
       
          description = lib.mdDoc ''

     

       
98
       
 
       
            Remove /etc/hosts entries for "127.0.0.2" and "::1" defined in nixos/modules/config/networking.nix

     

       
99
       
 
       
            Regionservers must be able to resolve their hostnames to their IP addresses, through PTR records

     

       
100
       
 
       
            or /etc/hosts entries.

     
···

       
105
       
 
       
        openFirewall = mkOption {

     

       
106
       
 
       
          type = types.bool;

     

       
107
       
 
       
          default = false;

     

       
108
       
+
       
          description = lib.mdDoc ''

     

       
109
       
 
       
            Open firewall ports for HBase master.

     

       
110
       
 
       
          '';

     

       
111
       
 
       
        };

     

···

       
121
       
 
       
      keepalive = mkOption {

     

       
122
       
 
       
        default = 600;

     

       
123
       
 
       
        type = types.int;

     

       
124
       
-
       
        description = "

     

       
125
       
 
       
          This is a number that indicates how frequently keepalive messages should be sent

     

       
126
       
 
       
          from the worker to the buildmaster, expressed in seconds.

     

       
127
       
-
       
        ";

     

       
128
       
 
       
      };

     

       
129
       
 
       


     

       
130
       
 
       
      package = mkOption {

     

···

       
121
       
 
       
      keepalive = mkOption {

     

       
122
       
 
       
        default = 600;

     

       
123
       
 
       
        type = types.int;

     

       
124
       
+
       
        description = lib.mdDoc ''

     

       
125
       
 
       
          This is a number that indicates how frequently keepalive messages should be sent

     

       
126
       
 
       
          from the worker to the buildmaster, expressed in seconds.

     

       
127
       
+
       
        '';

     

       
128
       
 
       
      };

     

       
129
       
 
       


     

       
130
       
 
       
      package = mkOption {

     

···

       
193
       
 
       
  options.services.buildkite-agents = mkOption {

     

       
194
       
 
       
    type = types.attrsOf (types.submodule buildkiteOptions);

     

       
195
       
 
       
    default = {};

     

       
196
       
-
       
    description = ''

     

       
197
       
 
       
      Attribute set of buildkite agents.

     

       
198
       
 
       
      The attribute key is combined with the hostname and a unique integer to

     

       
199
       
 
       
      create the final agent name. This can be overridden by setting the `name`

     

···

       
193
       
 
       
  options.services.buildkite-agents = mkOption {

     

       
194
       
 
       
    type = types.attrsOf (types.submodule buildkiteOptions);

     

       
195
       
 
       
    default = {};

     

       
196
       
+
       
    description = lib.mdDoc ''

     

       
197
       
 
       
      Attribute set of buildkite agents.

     

       
198
       
 
       
      The attribute key is combined with the hostname and a unique integer to

     

       
199
       
 
       
      create the final agent name. This can be overridden by setting the `name`

     

···

       
103
       
 
       
        defaultText = literalExpression ''baseDirectory + "/secrets"'';

     

       
104
       
 
       
      };

     

       
105
       
 
       
      clusterJoinTokenPath = mkOption {

     

       
106
       
-
       
        description = ''

     

       
107
       
 
       
          Location of the cluster-join-token.key file.

     

       
108
       
 
       


     

       
109
       
 
       
          You can retrieve the contents of the file when creating a new agent via

     

       
110
       
-
       
          <link xlink:href="https://hercules-ci.com/dashboard">https://hercules-ci.com/dashboard</link>.

     

       
111
       
 
       


     

       
112
       
 
       
          As this value is confidential, it should not be in the store, but

     

       
113
       
 
       
          installed using other means, such as agenix, NixOps

     

       
114
       
-
       
          <literal>deployment.keys</literal>, or manual installation.

     

       
115
       
 
       


     

       
116
       
 
       
          The contents of the file are used for authentication between the agent and the API.

     

       
117
       
 
       
        '';

     
···

       
120
       
 
       
        defaultText = literalExpression ''staticSecretsDirectory + "/cluster-join-token.key"'';

     

       
121
       
 
       
      };

     

       
122
       
 
       
      binaryCachesPath = mkOption {

     

       
123
       
-
       
        description = ''

     

       
124
       
 
       
          Path to a JSON file containing binary cache secret keys.

     

       
125
       
 
       


     

       
126
       
 
       
          As these values are confidential, they should not be in the store, but

     

       
127
       
 
       
          copied over using other means, such as agenix, NixOps

     

       
128
       
-
       
          <literal>deployment.keys</literal>, or manual installation.

     

       
129
       
 
       


     

       
130
       
-
       
          The format is described on <link xlink:href="https://docs.hercules-ci.com/hercules-ci-agent/binary-caches-json/">https://docs.hercules-ci.com/hercules-ci-agent/binary-caches-json/</link>.

     

       
131
       
 
       
        '';

     

       
132
       
 
       
        type = types.path;

     

       
133
       
 
       
        default = config.staticSecretsDirectory + "/binary-caches.json";

     

       
134
       
 
       
        defaultText = literalExpression ''staticSecretsDirectory + "/binary-caches.json"'';

     

       
135
       
 
       
      };

     

       
136
       
 
       
      secretsJsonPath = mkOption {

     

       
137
       
-
       
        description = ''

     

       
138
       
 
       
          Path to a JSON file containing secrets for effects.

     

       
139
       
 
       


     

       
140
       
 
       
          As these values are confidential, they should not be in the store, but

     

       
141
       
 
       
          copied over using other means, such as agenix, NixOps

     

       
142
       
-
       
          <literal>deployment.keys</literal>, or manual installation.

     

       
143
       
 
       


     

       
144
       
-
       
          The format is described on <link xlink:href="https://docs.hercules-ci.com/hercules-ci-agent/secrets-json/">https://docs.hercules-ci.com/hercules-ci-agent/secrets-json/</link>.

     

       
145
       
-
       


     

       
146
       
 
       
        '';

     

       
147
       
 
       
        type = types.path;

     

       
148
       
 
       
        default = config.staticSecretsDirectory + "/secrets.json";

     

···

       
103
       
 
       
        defaultText = literalExpression ''baseDirectory + "/secrets"'';

     

       
104
       
 
       
      };

     

       
105
       
 
       
      clusterJoinTokenPath = mkOption {

     

       
106
       
+
       
        description = lib.mdDoc ''

     

       
107
       
 
       
          Location of the cluster-join-token.key file.

     

       
108
       
 
       


     

       
109
       
 
       
          You can retrieve the contents of the file when creating a new agent via

     

       
110
       
+
       
          <https://hercules-ci.com/dashboard>.

     

       
111
       
 
       


     

       
112
       
 
       
          As this value is confidential, it should not be in the store, but

     

       
113
       
 
       
          installed using other means, such as agenix, NixOps

     

       
114
       
+
       
          `deployment.keys`, or manual installation.

     

       
115
       
 
       


     

       
116
       
 
       
          The contents of the file are used for authentication between the agent and the API.

     

       
117
       
 
       
        '';

     
···

       
120
       
 
       
        defaultText = literalExpression ''staticSecretsDirectory + "/cluster-join-token.key"'';

     

       
121
       
 
       
      };

     

       
122
       
 
       
      binaryCachesPath = mkOption {

     

       
123
       
+
       
        description = lib.mdDoc ''

     

       
124
       
 
       
          Path to a JSON file containing binary cache secret keys.

     

       
125
       
 
       


     

       
126
       
 
       
          As these values are confidential, they should not be in the store, but

     

       
127
       
 
       
          copied over using other means, such as agenix, NixOps

     

       
128
       
+
       
          `deployment.keys`, or manual installation.

     

       
129
       
 
       


     

       
130
       
+
       
          The format is described on <https://docs.hercules-ci.com/hercules-ci-agent/binary-caches-json/>.

     

       
131
       
 
       
        '';

     

       
132
       
 
       
        type = types.path;

     

       
133
       
 
       
        default = config.staticSecretsDirectory + "/binary-caches.json";

     

       
134
       
 
       
        defaultText = literalExpression ''staticSecretsDirectory + "/binary-caches.json"'';

     

       
135
       
 
       
      };

     

       
136
       
 
       
      secretsJsonPath = mkOption {

     

       
137
       
+
       
        description = lib.mdDoc ''

     

       
138
       
 
       
          Path to a JSON file containing secrets for effects.

     

       
139
       
 
       


     

       
140
       
 
       
          As these values are confidential, they should not be in the store, but

     

       
141
       
 
       
          copied over using other means, such as agenix, NixOps

     

       
142
       
+
       
          `deployment.keys`, or manual installation.

     

       
143
       
 
       


     

       
144
       
+
       
          The format is described on <https://docs.hercules-ci.com/hercules-ci-agent/secrets-json/>.

     

       
0
       
 
       

     

       
145
       
 
       
        '';

     

       
146
       
 
       
        type = types.path;

     

       
147
       
 
       
        default = config.staticSecretsDirectory + "/secrets.json";

     

···

       
87
       
 
       
        type = types.str;

     

       
88
       
 
       
        default = localDB;

     

       
89
       
 
       
        example = "dbi:Pg:dbname=hydra;host=postgres.example.org;user=foo;";

     

       
90
       
-
       
        description = ''

     

       
91
       
 
       
          The DBI string for Hydra database connection.

     

       
92
       
 
       


     

       
93
       
 
       
          NOTE: Attempts to set `application_name` will be overridden by

     
···

       
115
       
 
       
        type = types.str;

     

       
116
       
 
       
        default = "*";

     

       
117
       
 
       
        example = "localhost";

     

       
118
       
-
       
        description = ''

     

       
119
       
-
       
          The hostname or address to listen on or <literal>*</literal> to listen

     

       
120
       
 
       
          on all interfaces.

     

       
121
       
 
       
        '';

     

       
122
       
 
       
      };

     

···

       
87
       
 
       
        type = types.str;

     

       
88
       
 
       
        default = localDB;

     

       
89
       
 
       
        example = "dbi:Pg:dbname=hydra;host=postgres.example.org;user=foo;";

     

       
90
       
+
       
        description = lib.mdDoc ''

     

       
91
       
 
       
          The DBI string for Hydra database connection.

     

       
92
       
 
       


     

       
93
       
 
       
          NOTE: Attempts to set `application_name` will be overridden by

     
···

       
115
       
 
       
        type = types.str;

     

       
116
       
 
       
        default = "*";

     

       
117
       
 
       
        example = "localhost";

     

       
118
       
+
       
        description = lib.mdDoc ''

     

       
119
       
+
       
          The hostname or address to listen on or `*` to listen

     

       
120
       
 
       
          on all interfaces.

     

       
121
       
 
       
        '';

     

       
122
       
 
       
      };

     

···

       
97
       
 
       
    openFirewall = mkOption {

     

       
98
       
 
       
      type        = types.bool;

     

       
99
       
 
       
      default     = false;

     

       
100
       
-
       
      description = ''

     

       
101
       
 
       
        Open the firewall ports corresponding to FoundationDB processes and coordinators

     

       
102
       
-
       
        using <option>config.networking.firewall.*</option>.

     

       
103
       
 
       
      '';

     

       
104
       
 
       
    };

     

       
105
       
 
       


     

···

       
97
       
 
       
    openFirewall = mkOption {

     

       
98
       
 
       
      type        = types.bool;

     

       
99
       
 
       
      default     = false;

     

       
100
       
+
       
      description = lib.mdDoc ''

     

       
101
       
 
       
        Open the firewall ports corresponding to FoundationDB processes and coordinators

     

       
102
       
+
       
        using {option}`config.networking.firewall.*`.

     

       
103
       
 
       
      '';

     

       
104
       
 
       
    };

     

       
105
       
 
       


     

···

       
35
       
 
       
        default = pkgs.mongodb;

     

       
36
       
 
       
        defaultText = literalExpression "pkgs.mongodb";

     

       
37
       
 
       
        type = types.package;

     

       
38
       
-
       
        description = "

     

       
39
       
 
       
          Which MongoDB derivation to use.

     

       
40
       
-
       
        ";

     

       
41
       
 
       
      };

     

       
42
       
 
       


     

       
43
       
 
       
      user = mkOption {

     

···

       
35
       
 
       
        default = pkgs.mongodb;

     

       
36
       
 
       
        defaultText = literalExpression "pkgs.mongodb";

     

       
37
       
 
       
        type = types.package;

     

       
38
       
+
       
        description = lib.mdDoc ''

     

       
39
       
 
       
          Which MongoDB derivation to use.

     

       
40
       
+
       
        '';

     

       
41
       
 
       
      };

     

       
42
       
 
       


     

       
43
       
 
       
      user = mkOption {

     

···

       
36
       
 
       
      package = mkOption {

     

       
37
       
 
       
        type = types.package;

     

       
38
       
 
       
        example = literalExpression "pkgs.mariadb";

     

       
39
       
-
       
        description = "

     

       
40
       
 
       
          Which MySQL derivation to use. MariaDB packages are supported too.

     

       
41
       
-
       
        ";

     

       
42
       
 
       
      };

     

       
43
       
 
       


     

       
44
       
 
       
      user = mkOption {

     

···

       
36
       
 
       
      package = mkOption {

     

       
37
       
 
       
        type = types.package;

     

       
38
       
 
       
        example = literalExpression "pkgs.mariadb";

     

       
39
       
+
       
        description = lib.mdDoc ''

     

       
40
       
 
       
          Which MySQL derivation to use. MariaDB packages are supported too.

     

       
41
       
+
       
        '';

     

       
42
       
 
       
      };

     

       
43
       
 
       


     

       
44
       
 
       
      user = mkOption {

     

···

       
79
       
 
       
      authentication = mkOption {

     

       
80
       
 
       
        type = types.lines;

     

       
81
       
 
       
        default = "";

     

       
82
       
-
       
        description = ''

     

       
83
       
 
       
          Defines how users authenticate themselves to the server. See the

     

       
84
       
-
       
          <link xlink:href="https://www.postgresql.org/docs/current/auth-pg-hba-conf.html">PostgreSQL documentation for pg_hba.conf</link>

     

       
85
       
 
       
          for details on the expected format of this option. By default,

     

       
86
       
 
       
          peer based authentication will be used for users connecting

     

       
87
       
 
       
          via the Unix socket, and md5 password authentication will be

     

       
88
       
 
       
          used for users connecting via TCP. Any added rules will be

     

       
89
       
 
       
          inserted above the default rules. If you'd like to replace the

     

       
90
       
-
       
          default rules entirely, you can use <function>lib.mkForce</function> in your

     

       
91
       
 
       
          module.

     

       
92
       
 
       
        '';

     

       
93
       
 
       
      };

     

···

       
79
       
 
       
      authentication = mkOption {

     

       
80
       
 
       
        type = types.lines;

     

       
81
       
 
       
        default = "";

     

       
82
       
+
       
        description = lib.mdDoc ''

     

       
83
       
 
       
          Defines how users authenticate themselves to the server. See the

     

       
84
       
+
       
          [PostgreSQL documentation for pg_hba.conf](https://www.postgresql.org/docs/current/auth-pg-hba-conf.html)

     

       
85
       
 
       
          for details on the expected format of this option. By default,

     

       
86
       
 
       
          peer based authentication will be used for users connecting

     

       
87
       
 
       
          via the Unix socket, and md5 password authentication will be

     

       
88
       
 
       
          used for users connecting via TCP. Any added rules will be

     

       
89
       
 
       
          inserted above the default rules. If you'd like to replace the

     

       
90
       
+
       
          default rules entirely, you can use `lib.mkForce` in your

     

       
91
       
 
       
          module.

     

       
92
       
 
       
        '';

     

       
93
       
 
       
      };

     

···

       
149
       
 
       
          };

     

       
150
       
 
       
        }

     

       
151
       
 
       
      '';

     

       
152
       
-
       
      description = "Declarative kernel config

     

       
0
       
 
       

     

       
153
       
 
       


     

       
154
       
-
       
      Kernels can be declared in any language that supports and has the required

     

       
155
       
-
       
      dependencies to communicate with a jupyter server.

     

       
156
       
-
       
      In python's case, it means that ipykernel package must always be included in

     

       
157
       
-
       
      the list of packages of the targeted environment.

     

       
158
       
-
       
      ";

     

       
159
       
 
       
    };

     

       
160
       
 
       
  };

     

       
161
       
 
       


     

···

       
149
       
 
       
          };

     

       
150
       
 
       
        }

     

       
151
       
 
       
      '';

     

       
152
       
+
       
      description = lib.mdDoc ''

     

       
153
       
+
       
        Declarative kernel config.

     

       
154
       
 
       


     

       
155
       
+
       
        Kernels can be declared in any language that supports and has the required

     

       
156
       
+
       
        dependencies to communicate with a jupyter server.

     

       
157
       
+
       
        In python's case, it means that ipykernel package must always be included in

     

       
158
       
+
       
        the list of packages of the targeted environment.

     

       
159
       
+
       
      '';

     

       
160
       
 
       
    };

     

       
161
       
 
       
  };

     

       
162
       
 
       


     

···

       
9
       
 
       
      enable = lib.mkOption {

     

       
10
       
 
       
        default = false;

     

       
11
       
 
       
        type = lib.types.bool;

     

       
12
       
-
       
        description = ''

     

       
13
       
 
       
          Enables the daemon for `lorri`, a nix-shell replacement for project

     

       
14
       
 
       
          development. The socket-activated daemon starts on the first request

     

       
15
       
 
       
          issued by the `lorri` command.

     

···

       
9
       
 
       
      enable = lib.mkOption {

     

       
10
       
 
       
        default = false;

     

       
11
       
 
       
        type = lib.types.bool;

     

       
12
       
+
       
        description = lib.mdDoc ''

     

       
13
       
 
       
          Enables the daemon for `lorri`, a nix-shell replacement for project

     

       
14
       
 
       
          development. The socket-activated daemon starts on the first request

     

       
15
       
 
       
          issued by the `lorri` command.

     

···

       
36
       
 
       
    certificateChain = mkOption {

     

       
37
       
 
       
      type = types.nullOr types.path;

     

       
38
       
 
       
      default = null;

     

       
39
       
-
       
      description = ''

     

       
40
       
 
       
        Chain of CA-certificates to which our `certificateFile` is relative.

     

       
41
       
 
       
        Optional for TLS.

     

       
42
       
 
       
      '';

     

···

       
36
       
 
       
    certificateChain = mkOption {

     

       
37
       
 
       
      type = types.nullOr types.path;

     

       
38
       
 
       
      default = null;

     

       
39
       
+
       
      description = lib.mdDoc ''

     

       
40
       
 
       
        Chain of CA-certificates to which our `certificateFile` is relative.

     

       
41
       
 
       
        Optional for TLS.

     

       
42
       
 
       
      '';

     

···

       
81
       
 
       


     

       
82
       
 
       
    settings = mkOption {

     

       
83
       
 
       
      type = format.type;

     

       
84
       
-
       
      description = ''

     

       
85
       
-
       
        The ASF.json file, all the options are documented <link xlink:href="https://github.com/JustArchiNET/ArchiSteamFarm/wiki/Configuration#global-config">here</link>.

     

       
86
       
 
       
        Do note that `AutoRestart`  and `UpdateChannel` is always to `false` respectively `0` because NixOS takes care of updating everything.

     

       
87
       
 
       
        `Headless` is also always set to `true` because there is no way to provide inputs via a systemd service.

     

       
88
       
-
       
        You should try to keep ASF up to date since upstream does not provide support for anything but the latest version and you're exposing yourself to all kinds of issues - as is outlined <link xlink:href="https://github.com/JustArchiNET/ArchiSteamFarm/wiki/Configuration#updateperiod">here</link>.

     

       
89
       
 
       
      '';

     

       
90
       
 
       
      example = {

     

       
91
       
 
       
        Statistics = false;

     

···

       
81
       
 
       


     

       
82
       
 
       
    settings = mkOption {

     

       
83
       
 
       
      type = format.type;

     

       
84
       
+
       
      description = lib.mdDoc ''

     

       
85
       
+
       
        The ASF.json file, all the options are documented [here](https://github.com/JustArchiNET/ArchiSteamFarm/wiki/Configuration#global-config).

     

       
86
       
 
       
        Do note that `AutoRestart`  and `UpdateChannel` is always to `false` respectively `0` because NixOS takes care of updating everything.

     

       
87
       
 
       
        `Headless` is also always set to `true` because there is no way to provide inputs via a systemd service.

     

       
88
       
+
       
        You should try to keep ASF up to date since upstream does not provide support for anything but the latest version and you're exposing yourself to all kinds of issues - as is outlined [here](https://github.com/JustArchiNET/ArchiSteamFarm/wiki/Configuration#updateperiod).

     

       
89
       
 
       
      '';

     

       
90
       
 
       
      example = {

     

       
91
       
 
       
        Statistics = false;

     

···

       
41
       
 
       
    stateDir = mkOption {

     

       
42
       
 
       
      type = types.str;

     

       
43
       
 
       
      default = "/var/lib/crossfire";

     

       
44
       
-
       
      description = ''

     

       
45
       
 
       
        Where to store runtime data (save files, persistent items, etc).

     

       
46
       
 
       


     

       
47
       
 
       
        If left at the default, this will be automatically created on server

     
···

       
61
       
 
       


     

       
62
       
 
       
    configFiles = mkOption {

     

       
63
       
 
       
      type = types.attrsOf types.str;

     

       
64
       
-
       
      description = ''

     

       
65
       
 
       
        Text to append to the corresponding configuration files. Note that the

     

       
66
       
 
       
        files given in the example are *not* the complete set of files available

     

       
67
       
 
       
        to customize; look in /etc/crossfire after enabling the server to see

     

···

       
41
       
 
       
    stateDir = mkOption {

     

       
42
       
 
       
      type = types.str;

     

       
43
       
 
       
      default = "/var/lib/crossfire";

     

       
44
       
+
       
      description = lib.mdDoc ''

     

       
45
       
 
       
        Where to store runtime data (save files, persistent items, etc).

     

       
46
       
 
       


     

       
47
       
 
       
        If left at the default, this will be automatically created on server

     
···

       
61
       
 
       


     

       
62
       
 
       
    configFiles = mkOption {

     

       
63
       
 
       
      type = types.attrsOf types.str;

     

       
64
       
+
       
      description = lib.mdDoc ''

     

       
65
       
 
       
        Text to append to the corresponding configuration files. Note that the

     

       
66
       
 
       
        files given in the example are *not* the complete set of files available

     

       
67
       
 
       
        to customize; look in /etc/crossfire after enabling the server to see

     

···

       
41
       
 
       
    stateDir = mkOption {

     

       
42
       
 
       
      type = types.str;

     

       
43
       
 
       
      default = "/var/lib/deliantra";

     

       
44
       
-
       
      description = ''

     

       
45
       
 
       
        Where to store runtime data (save files, persistent items, etc).

     

       
46
       
 
       


     

       
47
       
 
       
        If left at the default, this will be automatically created on server