···

       
75
       
 
       
          List of locales that the system should support.  The value

     

       
76
       
 
       
          <literal>"all"</literal> means that all locales supported by

     

       
77
       
 
       
          Glibc will be installed.  A full list of supported locales

     

       
78
       
-
       
          can be found at <link

     

       
79
       
-
       
          xlink:href="https://sourceware.org/git/?p=glibc.git;a=blob;f=localedata/SUPPORTED"/>.

     

       
80
       
 
       
        '';

     

       
81
       
 
       
      };

     

       
82
       
 
       


     

···

       
75
       
 
       
          List of locales that the system should support.  The value

     

       
76
       
 
       
          <literal>"all"</literal> means that all locales supported by

     

       
77
       
 
       
          Glibc will be installed.  A full list of supported locales

     

       
78
       
+
       
          can be found at <link xlink:href="https://sourceware.org/git/?p=glibc.git;a=blob;f=localedata/SUPPORTED"/>.

     

       
0
       
 
       

     

       
79
       
 
       
        '';

     

       
80
       
 
       
      };

     

       
81
       
 
       


     

···

       
156
       
 
       
          <filename>pam_mount.conf.xml</filename>.

     

       
157
       
 
       
          Useful attributes might include <literal>path</literal>,

     

       
158
       
 
       
          <literal>options</literal>, <literal>fstype</literal>, and <literal>server</literal>.

     

       
159
       
-
       
          See <link

     

       
160
       
-
       
          xlink:href="http://pam-mount.sourceforge.net/pam_mount.conf.5.html" />

     

       
161
       
 
       
          for more information.

     

       
162
       
 
       
        '';

     

       
163
       
 
       
      };

     

···

       
156
       
 
       
          <filename>pam_mount.conf.xml</filename>.

     

       
157
       
 
       
          Useful attributes might include <literal>path</literal>,

     

       
158
       
 
       
          <literal>options</literal>, <literal>fstype</literal>, and <literal>server</literal>.

     

       
159
       
+
       
          See <link xlink:href="http://pam-mount.sourceforge.net/pam_mount.conf.5.html"/>

     

       
0
       
 
       

     

       
160
       
 
       
          for more information.

     

       
161
       
 
       
        '';

     

       
162
       
 
       
      };

     

···

       
33
       
 
       


     

       
34
       
 
       
  options.xdg.portal = {

     

       
35
       
 
       
    enable =

     

       
36
       
-
       
      mkEnableOption "<link xlink:href='https://github.com/flatpak/xdg-desktop-portal'>xdg desktop integration</link>" // {

     

       
37
       
 
       
        default = false;

     

       
38
       
 
       
      };

     

       
39
       
 
       


     

···

       
33
       
 
       


     

       
34
       
 
       
  options.xdg.portal = {

     

       
35
       
 
       
    enable =

     

       
36
       
+
       
      mkEnableOption ''<link xlink:href="https://github.com/flatpak/xdg-desktop-portal">xdg desktop integration</link>'' // {

     

       
37
       
 
       
        default = false;

     

       
38
       
 
       
      };

     

       
39
       
 
       


     

···

       
13
       
 
       


     

       
14
       
 
       
          To configure the driver, pass the options to the <option>boot.kernelParams</option> configuration.

     

       
15
       
 
       
          There are several parameters you can change. It's best to check at the source code description which options are supported.

     

       
16
       
-
       
          You can find all the supported parameters at: <link xlink:href="https://github.com/tuxedocomputers/tuxedo-keyboard#kernelparam" />

     

       
17
       
 
       


     

       
18
       
 
       
          In order to use the <literal>custom</literal> lighting with the maximumg brightness and a color of <literal>0xff0a0a</literal> one would put pass <option>boot.kernelParams</option> like this:

     

       
19
       
 
       


     

···

       
13
       
 
       


     

       
14
       
 
       
          To configure the driver, pass the options to the <option>boot.kernelParams</option> configuration.

     

       
15
       
 
       
          There are several parameters you can change. It's best to check at the source code description which options are supported.

     

       
16
       
+
       
          You can find all the supported parameters at: <link xlink:href="https://github.com/tuxedocomputers/tuxedo-keyboard#kernelparam"/>

     

       
17
       
 
       


     

       
18
       
 
       
          In order to use the <literal>custom</literal> lighting with the maximumg brightness and a color of <literal>0xff0a0a</literal> one would put pass <option>boot.kernelParams</option> like this:

     

       
19
       
 
       


     

···

       
39
       
 
       
      Sway, the i3-compatible tiling Wayland compositor. You can manually launch

     

       
40
       
 
       
      Sway by executing "exec sway" on a TTY. Copy /etc/sway/config to

     

       
41
       
 
       
      ~/.config/sway/config to modify the default configuration. See

     

       
42
       
-
       
      <link xlink:href="https://github.com/swaywm/sway/wiki" /> and

     

       
43
       
 
       
      "man 5 sway" for more information'';

     

       
44
       
 
       


     

       
45
       
 
       
    wrapperFeatures = mkOption {

     

···

       
39
       
 
       
      Sway, the i3-compatible tiling Wayland compositor. You can manually launch

     

       
40
       
 
       
      Sway by executing "exec sway" on a TTY. Copy /etc/sway/config to

     

       
41
       
 
       
      ~/.config/sway/config to modify the default configuration. See

     

       
42
       
+
       
      <link xlink:href="https://github.com/swaywm/sway/wiki"/> and

     

       
43
       
 
       
      "man 5 sway" for more information'';

     

       
44
       
 
       


     

       
45
       
 
       
    wrapperFeatures = mkOption {

     

···

       
581
       
 
       
          Turns on the OCSP Must-Staple TLS extension.

     

       
582
       
 
       
          Make sure you know what you're doing! See:

     

       
583
       
 
       
          <itemizedlist>

     

       
584
       
-
       
            <listitem><para><link xlink:href="https://blog.apnic.net/2019/01/15/is-the-web-ready-for-ocsp-must-staple/" /></para></listitem>

     

       
585
       
-
       
            <listitem><para><link xlink:href="https://blog.hboeck.de/archives/886-The-Problem-with-OCSP-Stapling-and-Must-Staple-and-why-Certificate-Revocation-is-still-broken.html" /></para></listitem>

     

       
586
       
 
       
          </itemizedlist>

     

       
587
       
 
       
        '';

     

       
588
       
 
       
      };

     

···

       
581
       
 
       
          Turns on the OCSP Must-Staple TLS extension.

     

       
582
       
 
       
          Make sure you know what you're doing! See:

     

       
583
       
 
       
          <itemizedlist>

     

       
584
       
+
       
            <listitem><para><link xlink:href="https://blog.apnic.net/2019/01/15/is-the-web-ready-for-ocsp-must-staple/"/></para></listitem>

     

       
585
       
+
       
            <listitem><para><link xlink:href="https://blog.hboeck.de/archives/886-The-Problem-with-OCSP-Stapling-and-Must-Staple-and-why-Certificate-Revocation-is-still-broken.html"/></para></listitem>

     

       
586
       
 
       
          </itemizedlist>

     

       
587
       
 
       
        '';

     

       
588
       
 
       
      };

     

···

       
831
       
 
       


     

       
832
       
 
       
          If set, users can log in with SSH keys and PKCS#11 tokens.

     

       
833
       
 
       


     

       
834
       
-
       
          More information can be found <link

     

       
835
       
-
       
          xlink:href="https://github.com/OpenSC/pam_p11">here</link>.

     

       
836
       
 
       
        '';

     

       
837
       
 
       
      };

     

       
838
       
 
       


     
···

       
872
       
 
       
          <literal>username:first_keyHandle,first_public_key: second_keyHandle,second_public_key</literal>

     

       
873
       
 
       
          This file can be generated using <command>pamu2fcfg</command> command.

     

       
874
       
 
       


     

       
875
       
-
       
          More information can be found <link

     

       
876
       
-
       
          xlink:href="https://developers.yubico.com/pam-u2f/">here</link>.

     

       
877
       
 
       
        '';

     

       
878
       
 
       
      };

     

       
879
       
 
       


     
···

       
894
       
 
       
          <literal>username:first_keyHandle,first_public_key: second_keyHandle,second_public_key</literal>

     

       
895
       
 
       
          This file can be generated using <command>pamu2fcfg</command> command.

     

       
896
       
 
       


     

       
897
       
-
       
          More information can be found <link

     

       
898
       
-
       
          xlink:href="https://developers.yubico.com/pam-u2f/">here</link>.

     

       
899
       
 
       
        '';

     

       
900
       
 
       
      };

     

       
901
       
 
       


     
···

       
909
       
 
       
            When using <command>pamu2fcfg</command>, you can specify your

     

       
910
       
 
       
            application ID with the <literal>-i</literal> flag.

     

       
911
       
 
       


     

       
912
       
-
       
            More information can be found <link

     

       
913
       
-
       
            xlink:href="https://developers.yubico.com/pam-u2f/Manuals/pam_u2f.8.html">

     

       
914
       
-
       
            here</link>

     

       
915
       
 
       
        '';

     

       
916
       
 
       
      };

     

       
917
       
 
       


     
···

       
927
       
 
       
            When using <command>pamu2fcfg</command>, you can specify your

     

       
928
       
 
       
            application ID with the <literal>-o</literal> flag.

     

       
929
       
 
       


     

       
930
       
-
       
            More information can be found <link

     

       
931
       
-
       
            xlink:href="https://developers.yubico.com/pam-u2f/Manuals/pam_u2f.8.html">

     

       
932
       
-
       
            here</link>

     

       
933
       
 
       
        '';

     

       
934
       
 
       
      };

     

       
935
       
 
       


     
···

       
995
       
 
       
          Note that this module must both be enabled using this option and on a

     

       
996
       
 
       
          per-PAM-service level as well (using <literal>usshAuth</literal>).

     

       
997
       
 
       


     

       
998
       
-
       
          More information can be found <link

     

       
999
       
-
       
          xlink:href="https://github.com/uber/pam-ussh">here</link>.

     

       
1000
       
 
       
        '';

     

       
1001
       
 
       
      };

     

       
1002
       
 
       


     
···

       
1084
       
 
       


     

       
1085
       
 
       
          The file must have only one line:

     

       
1086
       
 
       
          <literal>username:yubikey_token_id1:yubikey_token_id2</literal>

     

       
1087
       
-
       
          More information can be found <link

     

       
1088
       
-
       
          xlink:href="https://developers.yubico.com/yubico-pam/">here</link>.

     

       
1089
       
 
       
        '';

     

       
1090
       
 
       
      };

     

       
1091
       
 
       
      control = mkOption {

     
···

       
1130
       
 
       
          Challenge-Response configurations. See the man-page ykpamcfg(1) for further

     

       
1131
       
 
       
          details on how to configure offline Challenge-Response validation.

     

       
1132
       
 
       


     

       
1133
       
-
       
          More information can be found <link

     

       
1134
       
-
       
          xlink:href="https://developers.yubico.com/yubico-pam/Authentication_Using_Challenge-Response.html">here</link>.

     

       
1135
       
 
       
        '';

     

       
1136
       
 
       
      };

     

       
1137
       
 
       
      challengeResponsePath = mkOption {

     
···

       
1140
       
 
       
        description = ''

     

       
1141
       
 
       
          If not null, set the path used by yubico pam module where the challenge expected response is stored.

     

       
1142
       
 
       


     

       
1143
       
-
       
          More information can be found <link

     

       
1144
       
-
       
          xlink:href="https://developers.yubico.com/yubico-pam/Authentication_Using_Challenge-Response.html">here</link>.

     

       
1145
       
 
       
        '';

     

       
1146
       
 
       
      };

     

       
1147
       
 
       
    };

     

···

       
831
       
 
       


     

       
832
       
 
       
          If set, users can log in with SSH keys and PKCS#11 tokens.

     

       
833
       
 
       


     

       
834
       
+
       
          More information can be found <link xlink:href="https://github.com/OpenSC/pam_p11">here</link>.

     

       
0
       
 
       

     

       
835
       
 
       
        '';

     

       
836
       
 
       
      };

     

       
837
       
 
       


     
···

       
871
       
 
       
          <literal>username:first_keyHandle,first_public_key: second_keyHandle,second_public_key</literal>

     

       
872
       
 
       
          This file can be generated using <command>pamu2fcfg</command> command.

     

       
873
       
 
       


     

       
874
       
+
       
          More information can be found <link xlink:href="https://developers.yubico.com/pam-u2f/">here</link>.

     

       
0
       
 
       

     

       
875
       
 
       
        '';

     

       
876
       
 
       
      };

     

       
877
       
 
       


     
···

       
892
       
 
       
          <literal>username:first_keyHandle,first_public_key: second_keyHandle,second_public_key</literal>

     

       
893
       
 
       
          This file can be generated using <command>pamu2fcfg</command> command.

     

       
894
       
 
       


     

       
895
       
+
       
          More information can be found <link xlink:href="https://developers.yubico.com/pam-u2f/">here</link>.

     

       
0
       
 
       

     

       
896
       
 
       
        '';

     

       
897
       
 
       
      };

     

       
898
       
 
       


     
···

       
906
       
 
       
            When using <command>pamu2fcfg</command>, you can specify your

     

       
907
       
 
       
            application ID with the <literal>-i</literal> flag.

     

       
908
       
 
       


     

       
909
       
+
       
            More information can be found <link xlink:href="https://developers.yubico.com/pam-u2f/Manuals/pam_u2f.8.html">here</link>

     

       
0
       
 
       

     

       
0
       
 
       

     

       
910
       
 
       
        '';

     

       
911
       
 
       
      };

     

       
912
       
 
       


     
···

       
922
       
 
       
            When using <command>pamu2fcfg</command>, you can specify your

     

       
923
       
 
       
            application ID with the <literal>-o</literal> flag.

     

       
924
       
 
       


     

       
925
       
+
       
            More information can be found <link xlink:href="https://developers.yubico.com/pam-u2f/Manuals/pam_u2f.8.html">here</link>

     

       
0
       
 
       

     

       
0
       
 
       

     

       
926
       
 
       
        '';

     

       
927
       
 
       
      };

     

       
928
       
 
       


     
···

       
988
       
 
       
          Note that this module must both be enabled using this option and on a

     

       
989
       
 
       
          per-PAM-service level as well (using <literal>usshAuth</literal>).

     

       
990
       
 
       


     

       
991
       
+
       
          More information can be found <link xlink:href="https://github.com/uber/pam-ussh">here</link>.

     

       
0
       
 
       

     

       
992
       
 
       
        '';

     

       
993
       
 
       
      };

     

       
994
       
 
       


     
···

       
1076
       
 
       


     

       
1077
       
 
       
          The file must have only one line:

     

       
1078
       
 
       
          <literal>username:yubikey_token_id1:yubikey_token_id2</literal>

     

       
1079
       
+
       
          More information can be found <link xlink:href="https://developers.yubico.com/yubico-pam/">here</link>.

     

       
0
       
 
       

     

       
1080
       
 
       
        '';

     

       
1081
       
 
       
      };

     

       
1082
       
 
       
      control = mkOption {

     
···

       
1121
       
 
       
          Challenge-Response configurations. See the man-page ykpamcfg(1) for further

     

       
1122
       
 
       
          details on how to configure offline Challenge-Response validation.

     

       
1123
       
 
       


     

       
1124
       
+
       
          More information can be found <link xlink:href="https://developers.yubico.com/yubico-pam/Authentication_Using_Challenge-Response.html">here</link>.

     

       
0
       
 
       

     

       
1125
       
 
       
        '';

     

       
1126
       
 
       
      };

     

       
1127
       
 
       
      challengeResponsePath = mkOption {

     
···

       
1130
       
 
       
        description = ''

     

       
1131
       
 
       
          If not null, set the path used by yubico pam module where the challenge expected response is stored.

     

       
1132
       
 
       


     

       
1133
       
+
       
          More information can be found <link xlink:href="https://developers.yubico.com/yubico-pam/Authentication_Using_Challenge-Response.html">here</link>.

     

       
0
       
 
       

     

       
1134
       
 
       
        '';

     

       
1135
       
 
       
      };

     

       
1136
       
 
       
    };

     

···

       
33
       
 
       
        default = [];

     

       
34
       
 
       
        description = ''

     

       
35
       
 
       
          List of volume definitions for pam_mount.

     

       
36
       
-
       
          For more information, visit <link

     

       
37
       
-
       
          xlink:href="http://pam-mount.sourceforge.net/pam_mount.conf.5.html" />.

     

       
38
       
 
       
        '';

     

       
39
       
 
       
      };

     

       
40
       
 
       


     
···

       
67
       
 
       
        description = ''

     

       
68
       
 
       
          Sets the Debug-Level. 0 disables debugging, 1 enables pam_mount tracing,

     

       
69
       
 
       
          and 2 additionally enables tracing in mount.crypt. The default is 0.

     

       
70
       
-
       
          For more information, visit <link

     

       
71
       
-
       
          xlink:href="http://pam-mount.sourceforge.net/pam_mount.conf.5.html" />.

     

       
72
       
 
       
        '';

     

       
73
       
 
       
      };

     

       
74
       
 
       


     
···

       
78
       
 
       
        description = ''

     

       
79
       
 
       
          Amount of microseconds to wait until killing remaining processes after

     

       
80
       
 
       
          final logout.

     

       
81
       
-
       
          For more information, visit <link

     

       
82
       
-
       
          xlink:href="http://pam-mount.sourceforge.net/pam_mount.conf.5.html" />.

     

       
83
       
 
       
        '';

     

       
84
       
 
       
      };

     

       
85
       
 
       


     

···

       
33
       
 
       
        default = [];

     

       
34
       
 
       
        description = ''

     

       
35
       
 
       
          List of volume definitions for pam_mount.

     

       
36
       
+
       
          For more information, visit <link xlink:href="http://pam-mount.sourceforge.net/pam_mount.conf.5.html"/>.

     

       
0
       
 
       

     

       
37
       
 
       
        '';

     

       
38
       
 
       
      };

     

       
39
       
 
       


     
···

       
66
       
 
       
        description = ''

     

       
67
       
 
       
          Sets the Debug-Level. 0 disables debugging, 1 enables pam_mount tracing,

     

       
68
       
 
       
          and 2 additionally enables tracing in mount.crypt. The default is 0.

     

       
69
       
+
       
          For more information, visit <link xlink:href="http://pam-mount.sourceforge.net/pam_mount.conf.5.html"/>.

     

       
0
       
 
       

     

       
70
       
 
       
        '';

     

       
71
       
 
       
      };

     

       
72
       
 
       


     
···

       
76
       
 
       
        description = ''

     

       
77
       
 
       
          Amount of microseconds to wait until killing remaining processes after

     

       
78
       
 
       
          final logout.

     

       
79
       
+
       
          For more information, visit <link xlink:href="http://pam-mount.sourceforge.net/pam_mount.conf.5.html"/>.

     

       
0
       
 
       

     

       
80
       
 
       
        '';

     

       
81
       
 
       
      };

     

       
82
       
 
       


     

···

       
19
       
 
       
        default = false;

     

       
20
       
 
       
        description = ''

     

       
21
       
 
       
          Enable USB login for all login systems that support it.  For

     

       
22
       
-
       
          more information, visit <link

     

       
23
       
-
       
          xlink:href="https://github.com/aluzzardi/pam_usb/wiki/Getting-Started#setting-up-devices-and-users" />.

     

       
24
       
 
       
        '';

     

       
25
       
 
       
      };

     

       
26
       
 
       


     

···

       
19
       
 
       
        default = false;

     

       
20
       
 
       
        description = ''

     

       
21
       
 
       
          Enable USB login for all login systems that support it.  For

     

       
22
       
+
       
          more information, visit <link xlink:href="https://github.com/aluzzardi/pam_usb/wiki/Getting-Started#setting-up-devices-and-users"/>.

     

       
0
       
 
       

     

       
23
       
 
       
        '';

     

       
24
       
 
       
      };

     

       
25
       
 
       


     

···

       
23
       
 
       
      settings = mkOption {

     

       
24
       
 
       
        default = { };

     

       
25
       
 
       
        description = ''

     

       
26
       
-
       
          Configuration for zrepl. See <link

     

       
27
       
-
       
          xlink:href="https://zrepl.github.io/configuration.html"/>

     

       
28
       
 
       
          for more information.

     

       
29
       
 
       
        '';

     

       
30
       
 
       
        type = types.submodule {

     

···

       
23
       
 
       
      settings = mkOption {

     

       
24
       
 
       
        default = { };

     

       
25
       
 
       
        description = ''

     

       
26
       
+
       
          Configuration for zrepl. See <link xlink:href="https://zrepl.github.io/configuration.html"/>

     

       
0
       
 
       

     

       
27
       
 
       
          for more information.

     

       
28
       
 
       
        '';

     

       
29
       
 
       
        type = types.submodule {

     

···

       
22
       
 
       
        Whether to enable GitHub Actions runner.

     

       
23
       
 
       


     

       
24
       
 
       
        Note: GitHub recommends using self-hosted runners with private repositories only. Learn more here:

     

       
25
       
-
       
        <link xlink:href="https://docs.github.com/en/actions/hosting-your-own-runners/about-self-hosted-runners"

     

       
26
       
-
       
        >About self-hosted runners</link>.

     

       
27
       
 
       
      '';

     

       
28
       
 
       
      type = lib.types.bool;

     

       
29
       
 
       
    };

     

···

       
22
       
 
       
        Whether to enable GitHub Actions runner.

     

       
23
       
 
       


     

       
24
       
 
       
        Note: GitHub recommends using self-hosted runners with private repositories only. Learn more here:

     

       
25
       
+
       
        <link xlink:href="https://docs.github.com/en/actions/hosting-your-own-runners/about-self-hosted-runners">About self-hosted runners</link>.

     

       
0
       
 
       

     

       
26
       
 
       
      '';

     

       
27
       
 
       
      type = lib.types.bool;

     

       
28
       
 
       
    };

     

···

       
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">

     

       
85
       
-
       
          PostgreSQL documentation for pg_hba.conf</link>

     

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

     

       
87
       
 
       
          peer based authentication will be used for users connecting

     

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

     

···

       
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>

     

       
0
       
 
       

     

       
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

     

···

       
29
       
 
       
      type = types.listOf types.str;

     

       
30
       
 
       
      default = [];

     

       
31
       
 
       
      description = ''

     

       
32
       
-
       
        Extra options to pass to VictoriaMetrics. See the README: <link

     

       
33
       
-
       
        xlink:href="https://github.com/VictoriaMetrics/VictoriaMetrics/blob/master/README.md" />

     

       
34
       
 
       
        or <command>victoriametrics -help</command> for more

     

       
35
       
 
       
        information.

     

       
36
       
 
       
      '';

     

···

       
29
       
 
       
      type = types.listOf types.str;

     

       
30
       
 
       
      default = [];

     

       
31
       
 
       
      description = ''

     

       
32
       
+
       
        Extra options to pass to VictoriaMetrics. See the README:

     

       
33
       
+
       
        <link xlink:href="https://github.com/VictoriaMetrics/VictoriaMetrics/blob/master/README.md"/>

     

       
34
       
 
       
        or <command>victoriametrics -help</command> for more

     

       
35
       
 
       
        information.

     

       
36
       
 
       
      '';

     

···

       
139
       
 
       
          '';

     

       
140
       
 
       
          description = ''

     

       
141
       
 
       
            The <filename>database.yml</filename> configuration file as key value set.

     

       
142
       
-
       
            See <link xlink:href='TODO' />

     

       
143
       
 
       
            for list of configuration parameters.

     

       
144
       
 
       
          '';

     

       
145
       
 
       
        };

     

···

       
139
       
 
       
          '';

     

       
140
       
 
       
          description = ''

     

       
141
       
 
       
            The <filename>database.yml</filename> configuration file as key value set.

     

       
142
       
+
       
            See <link xlink:href="TODO"/>

     

       
143
       
 
       
            for list of configuration parameters.

     

       
144
       
 
       
          '';

     

       
145
       
 
       
        };

     

···

       
136
       
 
       
          };

     

       
137
       
 
       
          settings = mkOption {

     

       
138
       
 
       
            type = types.attrs;

     

       
139
       
-
       
            description = "Additional settings that are documented <link xlink:href=\"https://github.com/JustArchiNET/ArchiSteamFarm/wiki/Configuration#bot-config\">here</link>.";

     

       
0
       
 
       

     

       
0
       
 
       

     

       
140
       
 
       
            default = { };

     

       
141
       
 
       
          };

     

       
142
       
 
       
        };

     

···

       
136
       
 
       
          };

     

       
137
       
 
       
          settings = mkOption {

     

       
138
       
 
       
            type = types.attrs;

     

       
139
       
+
       
            description = ''

     

       
140
       
+
       
              Additional settings that are documented <link xlink:href="https://github.com/JustArchiNET/ArchiSteamFarm/wiki/Configuration#bot-config">here</link>.

     

       
141
       
+
       
            '';

     

       
142
       
 
       
            default = { };

     

       
143
       
 
       
          };

     

       
144
       
 
       
        };

     

···

       
282
       
 
       
      default = true;

     

       
283
       
 
       
      type = types.bool;

     

       
284
       
 
       
      description = ''

     

       
285
       
-
       
        Whether to assign <link

     

       
286
       
-
       
        xlink:href='http://www.freedesktop.org/wiki/Software/systemd/PredictableNetworkInterfaceNames'>predictable

     

       
287
       
-
       
        names to network interfaces</link>.  If enabled, interfaces

     

       
288
       
 
       
        are assigned names that contain topology information

     

       
289
       
 
       
        (e.g. <literal>wlp3s0</literal>) and thus should be stable

     

       
290
       
 
       
        across reboots.  If disabled, names depend on the order in

     

···

       
282
       
 
       
      default = true;

     

       
283
       
 
       
      type = types.bool;

     

       
284
       
 
       
      description = ''

     

       
285
       
+
       
        Whether to assign <link xlink:href="http://www.freedesktop.org/wiki/Software/systemd/PredictableNetworkInterfaceNames">predictable names to network interfaces</link>.

     

       
286
       
+
       
        If enabled, interfaces

     

       
0
       
 
       

     

       
287
       
 
       
        are assigned names that contain topology information

     

       
288
       
 
       
        (e.g. <literal>wlp3s0</literal>) and thus should be stable

     

       
289
       
 
       
        across reboots.  If disabled, names depend on the order in

     

···

       
161
       
 
       
                internal = true;

     

       
162
       
 
       
                description = ''

     

       
163
       
 
       
                  Inputs specify how Filebeat locates and processes

     

       
164
       
-
       
                  input data. Use <xref

     

       
165
       
-
       
                  linkend="opt-services.filebeat.inputs"/> instead.

     

       
166
       
 
       


     

       
167
       
 
       
                  See <link xlink:href="https://www.elastic.co/guide/en/beats/filebeat/current/configuration-filebeat-options.html"/>.

     

       
168
       
 
       
                '';

     

···

       
161
       
 
       
                internal = true;

     

       
162
       
 
       
                description = ''

     

       
163
       
 
       
                  Inputs specify how Filebeat locates and processes

     

       
164
       
+
       
                  input data. Use <xref linkend="opt-services.filebeat.inputs"/> instead.

     

       
0
       
 
       

     

       
165
       
 
       


     

       
166
       
 
       
                  See <link xlink:href="https://www.elastic.co/guide/en/beats/filebeat/current/configuration-filebeat-options.html"/>.

     

       
167
       
 
       
                '';

     

···

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

     

       
115
       
 
       
          description = ''

     

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

     

       
117
       
-
       
            defined by <xref linkend="opt-services.mailman.ldap.bindDn" />.

     

       
118
       
 
       
          '';

     

       
119
       
 
       
        };

     

       
120
       
 
       
        superUserGroup = mkOption {

     

···

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

     

       
115
       
 
       
          description = ''

     

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

     

       
117
       
+
       
            defined by <xref linkend="opt-services.mailman.ldap.bindDn"/>.

     

       
118
       
 
       
          '';

     

       
119
       
 
       
        };

     

       
120
       
 
       
        superUserGroup = mkOption {

     

···

       
88
       
 
       
      example = "cs";

     

       
89
       
 
       
      description = ''

     

       
90
       
 
       
        Default Sympa language.

     

       
91
       
-
       
        See <link xlink:href='https://github.com/sympa-community/sympa/tree/sympa-6.2/po/sympa' />

     

       
92
       
 
       
        for available options.

     

       
93
       
 
       
      '';

     

       
94
       
 
       
    };

     
···

       
138
       
 
       
            };

     

       
139
       
 
       
            description = ''

     

       
140
       
 
       
              The <filename>robot.conf</filename> configuration file as key value set.

     

       
141
       
-
       
              See <link xlink:href='https://sympa-community.github.io/gpldoc/man/sympa.conf.5.html' />

     

       
142
       
 
       
              for list of configuration parameters.

     

       
143
       
 
       
            '';

     

       
144
       
 
       
          };

     
···

       
287
       
 
       
      '';

     

       
288
       
 
       
      description = ''

     

       
289
       
 
       
        The <filename>sympa.conf</filename> configuration file as key value set.

     

       
290
       
-
       
        See <link xlink:href='https://sympa-community.github.io/gpldoc/man/sympa.conf.5.html' />

     

       
291
       
 
       
        for list of configuration parameters.

     

       
292
       
 
       
      '';

     

       
293
       
 
       
    };

     

···

       
88
       
 
       
      example = "cs";

     

       
89
       
 
       
      description = ''

     

       
90
       
 
       
        Default Sympa language.

     

       
91
       
+
       
        See <link xlink:href="https://github.com/sympa-community/sympa/tree/sympa-6.2/po/sympa"/>

     

       
92
       
 
       
        for available options.

     

       
93
       
 
       
      '';

     

       
94
       
 
       
    };

     
···

       
138
       
 
       
            };

     

       
139
       
 
       
            description = ''

     

       
140
       
 
       
              The <filename>robot.conf</filename> configuration file as key value set.

     

       
141
       
+
       
              See <link xlink:href="https://sympa-community.github.io/gpldoc/man/sympa.conf.5.html"/>

     

       
142
       
 
       
              for list of configuration parameters.

     

       
143
       
 
       
            '';

     

       
144
       
 
       
          };

     
···

       
287
       
 
       
      '';

     

       
288
       
 
       
      description = ''

     

       
289
       
 
       
        The <filename>sympa.conf</filename> configuration file as key value set.

     

       
290
       
+
       
        See <link xlink:href="https://sympa-community.github.io/gpldoc/man/sympa.conf.5.html"/>

     

       
291
       
 
       
        for list of configuration parameters.

     

       
292
       
 
       
      '';

     

       
293
       
 
       
    };

     

···

       
44
       
 
       
          <filename>config.yaml</filename> configuration as a Nix attribute set.

     

       
45
       
 
       


     

       
46
       
 
       
          Configuration options should match those described in

     

       
47
       
-
       
          <link xlink:href="https://github.com/Half-Shot/matrix-appservice-discord/blob/master/config/config.sample.yaml">

     

       
48
       
-
       
          config.sample.yaml</link>.

     

       
49
       
 
       


     

       
50
       
 
       
          <option>config.bridge.domain</option> and <option>config.bridge.homeserverUrl</option>

     

       
51
       
 
       
          should be set to match the public host name of the Matrix homeserver for webhooks and avatars to work.

     

···

       
44
       
 
       
          <filename>config.yaml</filename> configuration as a Nix attribute set.

     

       
45
       
 
       


     

       
46
       
 
       
          Configuration options should match those described in

     

       
47
       
+
       
          <link xlink:href="https://github.com/Half-Shot/matrix-appservice-discord/blob/master/config/config.sample.yaml">config.sample.yaml</link>.

     

       
0
       
 
       

     

       
48
       
 
       


     

       
49
       
 
       
          <option>config.bridge.domain</option> and <option>config.bridge.homeserverUrl</option>

     

       
50
       
 
       
          should be set to match the public host name of the Matrix homeserver for webhooks and avatars to work.

     

···

       
78
       
 
       
        description = ''

     

       
79
       
 
       
          <filename>config.yaml</filename> configuration as a Nix attribute set.

     

       
80
       
 
       
          Configuration options should match those described in

     

       
81
       
-
       
          <link xlink:href="https://github.com/mautrix/facebook/blob/master/mautrix_facebook/example-config.yaml">

     

       
82
       
-
       
          example-config.yaml</link>.

     

       
83
       
 
       


     

       
84
       
 
       
          Secret tokens should be specified using <option>environmentFile</option>

     

       
85
       
 
       
          instead of this world-readable attribute set.

     

···

       
78
       
 
       
        description = ''

     

       
79
       
 
       
          <filename>config.yaml</filename> configuration as a Nix attribute set.

     

       
80
       
 
       
          Configuration options should match those described in

     

       
81
       
+
       
          <link xlink:href="https://github.com/mautrix/facebook/blob/master/mautrix_facebook/example-config.yaml">example-config.yaml</link>.

     

       
0
       
 
       

     

       
82
       
 
       


     

       
83
       
 
       
          Secret tokens should be specified using <option>environmentFile</option>

     

       
84
       
 
       
          instead of this world-readable attribute set.

     

···

       
81
       
 
       
        description = ''

     

       
82
       
 
       
          <filename>config.yaml</filename> configuration as a Nix attribute set.

     

       
83
       
 
       
          Configuration options should match those described in

     

       
84
       
-
       
          <link xlink:href="https://github.com/tulir/mautrix-telegram/blob/master/example-config.yaml">

     

       
85
       
-
       
          example-config.yaml</link>.

     

       
86
       
 
       


     

       
87
       
 
       
          Secret tokens should be specified using <option>environmentFile</option>

     

       
88
       
 
       
          instead of this world-readable attribute set.

     

···

       
81
       
 
       
        description = ''

     

       
82
       
 
       
          <filename>config.yaml</filename> configuration as a Nix attribute set.

     

       
83
       
 
       
          Configuration options should match those described in

     

       
84
       
+
       
          <link xlink:href="https://github.com/tulir/mautrix-telegram/blob/master/example-config.yaml">example-config.yaml</link>.

     

       
0
       
 
       

     

       
85
       
 
       


     

       
86
       
 
       
          Secret tokens should be specified using <option>environmentFile</option>

     

       
87
       
 
       
          instead of this world-readable attribute set.

     

···

       
127
       
 
       
    extraConf = mkOption {

     

       
128
       
 
       
      description = ''

     

       
129
       
 
       
        Etcd extra configuration. See

     

       
130
       
-
       
        <link xlink:href='https://github.com/coreos/etcd/blob/master/Documentation/op-guide/configuration.md#configuration-flags' />

     

       
131
       
 
       
      '';

     

       
132
       
 
       
      type = types.attrsOf types.str;

     

       
133
       
 
       
      default = {};

     

···

       
127
       
 
       
    extraConf = mkOption {

     

       
128
       
 
       
      description = ''

     

       
129
       
 
       
        Etcd extra configuration. See

     

       
130
       
+
       
        <link xlink:href="https://github.com/coreos/etcd/blob/master/Documentation/op-guide/configuration.md#configuration-flags"/>

     

       
131
       
 
       
      '';

     

       
132
       
 
       
      type = types.attrsOf types.str;

     

       
133
       
 
       
      default = {};

     

···

       
135
       
 
       
        default = {};

     

       
136
       
 
       
        description = ''

     

       
137
       
 
       
          Configuration for <package>etebase-server</package>. Refer to

     

       
138
       
-
       
          <link xlink:href="https://github.com/etesync/server/blob/master/etebase-server.ini.example" />

     

       
139
       
-
       
          and <link xlink:href="https://github.com/etesync/server/wiki" />

     

       
140
       
 
       
          for details on supported values.

     

       
141
       
 
       
        '';

     

       
142
       
 
       
        example = {

     

···

       
135
       
 
       
        default = {};

     

       
136
       
 
       
        description = ''

     

       
137
       
 
       
          Configuration for <package>etebase-server</package>. Refer to

     

       
138
       
+
       
          <link xlink:href="https://github.com/etesync/server/blob/master/etebase-server.ini.example"/>

     

       
139
       
+
       
          and <link xlink:href="https://github.com/etesync/server/wiki"/>

     

       
140
       
 
       
          for details on supported values.

     

       
141
       
 
       
        '';

     

       
142
       
 
       
        example = {

     

···

       
40
       
 
       
        description = ''

     

       
41
       
 
       
          <productname>geoipupdate</productname> configuration

     

       
42
       
 
       
          options. See

     

       
43
       
-
       
          <link xlink:href="https://github.com/maxmind/geoipupdate/blob/main/doc/GeoIP.conf.md" />

     

       
44
       
 
       
          for a full list of available options.

     

       
45
       
 
       


     

       
46
       
 
       
          Settings containing secret data should be set to an

     
···

       
92
       
 
       


     

       
93
       
 
       
                Always handled as a secret whether the value is

     

       
94
       
 
       
                wrapped in a <literal>{ _secret = ...; }</literal>

     

       
95
       
-
       
                attrset or not (refer to <xref

     

       
96
       
-
       
                linkend="opt-services.geoipupdate.settings" /> for

     

       
97
       
 
       
                details).

     

       
98
       
 
       
              '';

     

       
99
       
 
       
              apply = x: if isAttrs x then x else { _secret = x; };

     

···

       
40
       
 
       
        description = ''

     

       
41
       
 
       
          <productname>geoipupdate</productname> configuration

     

       
42
       
 
       
          options. See

     

       
43
       
+
       
          <link xlink:href="https://github.com/maxmind/geoipupdate/blob/main/doc/GeoIP.conf.md"/>

     

       
44
       
 
       
          for a full list of available options.

     

       
45
       
 
       


     

       
46
       
 
       
          Settings containing secret data should be set to an

     
···

       
92
       
 
       


     

       
93
       
 
       
                Always handled as a secret whether the value is

     

       
94
       
 
       
                wrapped in a <literal>{ _secret = ...; }</literal>

     

       
95
       
+
       
                attrset or not (refer to <xref linkend="opt-services.geoipupdate.settings"/> for

     

       
0
       
 
       

     

       
96
       
 
       
                details).

     

       
97
       
 
       
              '';

     

       
98
       
 
       
              apply = x: if isAttrs x then x else { _secret = x; };

     

···

       
22
       
 
       
        Physical devices should already exist in <filename class="devicefile">/dev/input/by-id/</filename>.

     

       
23
       
 
       
        Proxy devices will be automatically given a <literal>uinput-</literal> prefix.

     

       
24
       
 
       


     

       
25
       
-
       
        See the <link xlink:href="https://github.com/aiberia/persistent-evdev#example-usage-with-libvirt">

     

       
26
       
-
       
        project page</link> for example configuration of virtual devices with libvirt

     

       
27
       
 
       
        and remember to add <literal>uinput-*</literal> devices to the qemu

     

       
28
       
 
       
        <literal>cgroup_device_acl</literal> list (see <xref linkend="opt-virtualisation.libvirtd.qemu.verbatimConfig"/>).

     

       
29
       
 
       
      '';

     

···

       
22
       
 
       
        Physical devices should already exist in <filename class="devicefile">/dev/input/by-id/</filename>.

     

       
23
       
 
       
        Proxy devices will be automatically given a <literal>uinput-</literal> prefix.

     

       
24
       
 
       


     

       
25
       
+
       
        See the <link xlink:href="https://github.com/aiberia/persistent-evdev#example-usage-with-libvirt">project page</link>

     

       
26
       
+
       
        for example configuration of virtual devices with libvirt

     

       
27
       
 
       
        and remember to add <literal>uinput-*</literal> devices to the qemu

     

       
28
       
 
       
        <literal>cgroup_device_acl</literal> list (see <xref linkend="opt-virtualisation.libvirtd.qemu.verbatimConfig"/>).

     

       
29
       
 
       
      '';

     

···

       
75
       
 
       
          world-readable Nix store that contains the value of <option>storageDriverPassword</option>.

     

       
76
       
 
       


     

       
77
       
 
       
          It's recommended to override this with a path not in the Nix store.

     

       
78
       
-
       
          Tip: use <link xlink:href='https://nixos.org/nixops/manual/#idm140737318306400'>nixops key management</link>

     

       
79
       
 
       
        '';

     

       
80
       
 
       
      };

     

       
81
       
 
       


     
···

       
91
       
 
       
        description = ''

     

       
92
       
 
       
          Additional cadvisor options.

     

       
93
       
 
       


     

       
94
       
-
       
          See <link xlink:href='https://github.com/google/cadvisor/blob/master/docs/runtime_options.md'/> for available options.

     

       
95
       
 
       
        '';

     

       
96
       
 
       
      };

     

       
97
       
 
       
    };

     

···

       
75
       
 
       
          world-readable Nix store that contains the value of <option>storageDriverPassword</option>.

     

       
76
       
 
       


     

       
77
       
 
       
          It's recommended to override this with a path not in the Nix store.

     

       
78
       
+
       
          Tip: use <link xlink:href="https://nixos.org/nixops/manual/#idm140737318306400">nixops key management</link>

     

       
79
       
 
       
        '';

     

       
80
       
 
       
      };

     

       
81
       
 
       


     
···

       
91
       
 
       
        description = ''

     

       
92
       
 
       
          Additional cadvisor options.

     

       
93
       
 
       


     

       
94
       
+
       
          See <link xlink:href="https://github.com/google/cadvisor/blob/master/docs/runtime_options.md"/> for available options.

     

       
95
       
 
       
        '';

     

       
96
       
 
       
      };

     

       
97
       
 
       
    };

     

···

       
92
       
 
       
      description = ''

     

       
93
       
 
       
        Configuration attributes for <package>grafana-image-renderer</package>.

     

       
94
       
 
       


     

       
95
       
-
       
        See <link xlink:href="https://github.com/grafana/grafana-image-renderer/blob/ce1f81438e5f69c7fd7c73ce08bab624c4c92e25/default.json" />

     

       
96
       
 
       
        for supported values.

     

       
97
       
 
       
      '';

     

       
98
       
 
       
    };

     

···

       
92
       
 
       
      description = ''

     

       
93
       
 
       
        Configuration attributes for <package>grafana-image-renderer</package>.

     

       
94
       
 
       


     

       
95
       
+
       
        See <link xlink:href="https://github.com/grafana/grafana-image-renderer/blob/ce1f81438e5f69c7fd7c73ce08bab624c4c92e25/default.json"/>

     

       
96
       
 
       
        for supported values.

     

       
97
       
 
       
      '';

     

       
98
       
 
       
    };

     

···

       
253
       
 
       
        default = {};

     

       
254
       
 
       
        description = ''

     

       
255
       
 
       
          Extra seyren configuration. See

     

       
256
       
-
       
          <link xlink:href='https://github.com/scobal/seyren#config' />

     

       
257
       
 
       
        '';

     

       
258
       
 
       
        type = types.attrsOf types.str;

     

       
259
       
 
       
        example = literalExpression ''

     

···

       
253
       
 
       
        default = {};

     

       
254
       
 
       
        description = ''

     

       
255
       
 
       
          Extra seyren configuration. See

     

       
256
       
+
       
          <link xlink:href="https://github.com/scobal/seyren#config"/>

     

       
257
       
 
       
        '';

     

       
258
       
 
       
        type = types.attrsOf types.str;

     

       
259
       
 
       
        example = literalExpression ''

     

···

       
142
       
 
       
          Enable Munin Node agent. Munin node listens on 0.0.0.0 and

     

       
143
       
 
       
          by default accepts connections only from 127.0.0.1 for security reasons.

     

       
144
       
 
       


     

       
145
       
-
       
          See <link xlink:href='http://guide.munin-monitoring.org/en/latest/architecture/index.html' />.

     

       
146
       
 
       
        '';

     

       
147
       
 
       
      };

     

       
148
       
 
       


     
···

       
151
       
 
       
        type = types.lines;

     

       
152
       
 
       
        description = ''

     

       
153
       
 
       
          <filename>munin-node.conf</filename> extra configuration. See

     

       
154
       
-
       
          <link xlink:href='http://guide.munin-monitoring.org/en/latest/reference/munin-node.conf.html' />

     

       
155
       
 
       
        '';

     

       
156
       
 
       
      };

     

       
157
       
 
       


     
···

       
160
       
 
       
        type = types.lines;

     

       
161
       
 
       
        description = ''

     

       
162
       
 
       
          <filename>plugin-conf.d</filename> extra plugin configuration. See

     

       
163
       
-
       
          <link xlink:href='http://guide.munin-monitoring.org/en/latest/plugin/use.html' />

     

       
164
       
 
       
        '';

     

       
165
       
 
       
        example = ''

     

       
166
       
 
       
          [fail2ban_*]

     
···

       
268
       
 
       
        type = types.lines;

     

       
269
       
 
       
        description = ''

     

       
270
       
 
       
          <filename>munin.conf</filename> extra global configuration.

     

       
271
       
-
       
          See <link xlink:href='http://guide.munin-monitoring.org/en/latest/reference/munin.conf.html' />.

     

       
272
       
 
       
          Useful to setup notifications, see

     

       
273
       
-
       
          <link xlink:href='http://guide.munin-monitoring.org/en/latest/tutorial/alert.html' />

     

       
274
       
 
       
        '';

     

       
275
       
 
       
        example = ''

     

       
276
       
 
       
          contact.email.command mail -s "Munin notification for ''${var:host}" someone@example.com

     
···

       
283
       
 
       
        description = ''

     

       
284
       
 
       
          Definitions of hosts of nodes to collect data from. Needs at least one

     

       
285
       
 
       
          host for cron to succeed. See

     

       
286
       
-
       
          <link xlink:href='http://guide.munin-monitoring.org/en/latest/reference/munin.conf.html' />

     

       
287
       
 
       
        '';

     

       
288
       
 
       
        example = literalExpression ''

     

       
289
       
 
       
          '''

     

···

       
142
       
 
       
          Enable Munin Node agent. Munin node listens on 0.0.0.0 and

     

       
143
       
 
       
          by default accepts connections only from 127.0.0.1 for security reasons.

     

       
144
       
 
       


     

       
145
       
+
       
          See <link xlink:href="http://guide.munin-monitoring.org/en/latest/architecture/index.html"/>.

     

       
146
       
 
       
        '';

     

       
147
       
 
       
      };

     

       
148
       
 
       


     
···

       
151
       
 
       
        type = types.lines;

     

       
152
       
 
       
        description = ''

     

       
153
       
 
       
          <filename>munin-node.conf</filename> extra configuration. See

     

       
154
       
+
       
          <link xlink:href="http://guide.munin-monitoring.org/en/latest/reference/munin-node.conf.html"/>

     

       
155
       
 
       
        '';

     

       
156
       
 
       
      };

     

       
157
       
 
       


     
···

       
160
       
 
       
        type = types.lines;

     

       
161
       
 
       
        description = ''

     

       
162
       
 
       
          <filename>plugin-conf.d</filename> extra plugin configuration. See

     

       
163
       
+
       
          <link xlink:href="http://guide.munin-monitoring.org/en/latest/plugin/use.html"/>

     

       
164
       
 
       
        '';

     

       
165
       
 
       
        example = ''

     

       
166
       
 
       
          [fail2ban_*]

     
···

       
268
       
 
       
        type = types.lines;

     

       
269
       
 
       
        description = ''

     

       
270
       
 
       
          <filename>munin.conf</filename> extra global configuration.

     

       
271
       
+
       
          See <link xlink:href="http://guide.munin-monitoring.org/en/latest/reference/munin.conf.html"/>.

     

       
272
       
 
       
          Useful to setup notifications, see

     

       
273
       
+
       
          <link xlink:href="http://guide.munin-monitoring.org/en/latest/tutorial/alert.html"/>

     

       
274
       
 
       
        '';

     

       
275
       
 
       
        example = ''

     

       
276
       
 
       
          contact.email.command mail -s "Munin notification for ''${var:host}" someone@example.com

     
···

       
283
       
 
       
        description = ''

     

       
284
       
 
       
          Definitions of hosts of nodes to collect data from. Needs at least one

     

       
285
       
 
       
          host for cron to succeed. See

     

       
286
       
+
       
          <link xlink:href="http://guide.munin-monitoring.org/en/latest/reference/munin.conf.html"/>

     

       
287
       
 
       
        '';

     

       
288
       
 
       
        example = literalExpression ''

     

       
289
       
 
       
          '''

     

···

       
88
       
 
       


     

       
89
       
 
       
  options = {

     

       
90
       
 
       
    services.nagios = {

     

       
91
       
-
       
      enable = mkEnableOption "<link xlink:href='http://www.nagios.org/'>Nagios</link> to monitor your system or network.";

     

       
92
       
 
       


     

       
93
       
 
       
      objectDefs = mkOption {

     

       
94
       
 
       
        description = "

     

···

       
88
       
 
       


     

       
89
       
 
       
  options = {

     

       
90
       
 
       
    services.nagios = {

     

       
91
       
+
       
      enable = mkEnableOption ''<link xlink:href="http://www.nagios.org/">Nagios</link> to monitor your system or network.'';

     

       
92
       
 
       


     

       
93
       
 
       
      objectDefs = mkOption {

     

       
94
       
 
       
        description = "

     

···

       
69
       
 
       
        type = lib.types.bool;

     

       
70
       
 
       
        default = true;

     

       
71
       
 
       
        description = ''

     

       
72
       
-
       
          Whether to enable and configure the <link

     

       
73
       
-
       
          linkend="opt-services.geoipupdate.enable">geoipupdate</link>

     

       
74
       
 
       
          service to automatically fetch GeoIP databases. Not crucial,

     

       
75
       
 
       
          but recommended for full functionality.

     

       
76
       
 
       


     

       
77
       
-
       
          To finish the setup, you need to manually set the <xref

     

       
78
       
-
       
          linkend="opt-services.geoipupdate.settings.AccountID" /> and

     

       
79
       
-
       
          <xref linkend="opt-services.geoipupdate.settings.LicenseKey" />

     

       
80
       
 
       
          options.

     

       
81
       
 
       
        '';

     

       
82
       
 
       
      };

     
···

       
101
       
 
       
            Whether the automatically provisioned Elasticsearch

     

       
102
       
 
       
            instance should be added as a grafana datasource. Has no

     

       
103
       
 
       
            effect unless

     

       
104
       
-
       
            <xref linkend="opt-services.parsedmarc.provision.elasticsearch" />

     

       
105
       
 
       
            is also enabled.

     

       
106
       
 
       
          '';

     

       
107
       
 
       
        };

     
···

       
213
       
 
       


     

       
214
       
 
       
                Always handled as a secret whether the value is

     

       
215
       
 
       
                wrapped in a <literal>{ _secret = ...; }</literal>

     

       
216
       
-
       
                attrset or not (refer to <xref

     

       
217
       
-
       
                linkend="opt-services.parsedmarc.settings" /> for

     

       
218
       
 
       
                details).

     

       
219
       
 
       
              '';

     

       
220
       
 
       
              apply = x: if isAttrs x || x == null then x else { _secret = x; };

     
···

       
278
       
 
       


     

       
279
       
 
       
                Always handled as a secret whether the value is

     

       
280
       
 
       
                wrapped in a <literal>{ _secret = ...; }</literal>

     

       
281
       
-
       
                attrset or not (refer to <xref

     

       
282
       
-
       
                linkend="opt-services.parsedmarc.settings" /> for

     

       
283
       
 
       
                details).

     

       
284
       
 
       
              '';

     

       
285
       
 
       
              apply = x: if isAttrs x || x == null then x else { _secret = x; };

     
···

       
332
       
 
       


     

       
333
       
 
       
                Always handled as a secret whether the value is

     

       
334
       
 
       
                wrapped in a <literal>{ _secret = ...; }</literal>

     

       
335
       
-
       
                attrset or not (refer to <xref

     

       
336
       
-
       
                linkend="opt-services.parsedmarc.settings" /> for

     

       
337
       
 
       
                details).

     

       
338
       
 
       
              '';

     

       
339
       
 
       
              apply = x: if isAttrs x || x == null then x else { _secret = x; };

     

···

       
69
       
 
       
        type = lib.types.bool;

     

       
70
       
 
       
        default = true;

     

       
71
       
 
       
        description = ''

     

       
72
       
+
       
          Whether to enable and configure the <link linkend="opt-services.geoipupdate.enable">geoipupdate</link>

     

       
0
       
 
       

     

       
73
       
 
       
          service to automatically fetch GeoIP databases. Not crucial,

     

       
74
       
 
       
          but recommended for full functionality.

     

       
75
       
 
       


     

       
76
       
+
       
          To finish the setup, you need to manually set the <xref linkend="opt-services.geoipupdate.settings.AccountID"/> and

     

       
77
       
+
       
          <xref linkend="opt-services.geoipupdate.settings.LicenseKey"/>

     

       
0
       
 
       

     

       
78
       
 
       
          options.

     

       
79
       
 
       
        '';

     

       
80
       
 
       
      };

     
···

       
99
       
 
       
            Whether the automatically provisioned Elasticsearch

     

       
100
       
 
       
            instance should be added as a grafana datasource. Has no

     

       
101
       
 
       
            effect unless

     

       
102
       
+
       
            <xref linkend="opt-services.parsedmarc.provision.elasticsearch"/>

     

       
103
       
 
       
            is also enabled.

     

       
104
       
 
       
          '';

     

       
105
       
 
       
        };

     
···

       
211
       
 
       


     

       
212
       
 
       
                Always handled as a secret whether the value is

     

       
213
       
 
       
                wrapped in a <literal>{ _secret = ...; }</literal>

     

       
214
       
+
       
                attrset or not (refer to <xref linkend="opt-services.parsedmarc.settings"/> for

     

       
0
       
 
       

     

       
215
       
 
       
                details).

     

       
216
       
 
       
              '';

     

       
217
       
 
       
              apply = x: if isAttrs x || x == null then x else { _secret = x; };

     
···

       
275
       
 
       


     

       
276
       
 
       
                Always handled as a secret whether the value is

     

       
277
       
 
       
                wrapped in a <literal>{ _secret = ...; }</literal>

     

       
278
       
+
       
                attrset or not (refer to <xref linkend="opt-services.parsedmarc.settings"/> for

     

       
0
       
 
       

     

       
279
       
 
       
                details).

     

       
280
       
 
       
              '';

     

       
281
       
 
       
              apply = x: if isAttrs x || x == null then x else { _secret = x; };

     
···

       
328
       
 
       


     

       
329
       
 
       
                Always handled as a secret whether the value is

     

       
330
       
 
       
                wrapped in a <literal>{ _secret = ...; }</literal>

     

       
331
       
+
       
                attrset or not (refer to <xref linkend="opt-services.parsedmarc.settings"/> for

     

       
0
       
 
       

     

       
332
       
 
       
                details).

     

       
333
       
 
       
              '';

     

       
334
       
 
       
              apply = x: if isAttrs x || x == null then x else { _secret = x; };

     

···

       
379
       
 
       
      gce_sd_configs = mkOpt (types.listOf promTypes.gce_sd_config) ''

     

       
380
       
 
       
        List of Google Compute Engine service discovery configurations.

     

       
381
       
 
       


     

       
382
       
-
       
        See <link

     

       
383
       
-
       
        xlink:href="https://prometheus.io/docs/prometheus/latest/configuration/configuration/#gce_sd_config">the

     

       
384
       
-
       
        relevant Prometheus configuration docs</link> for more detail.

     

       
385
       
 
       
      '';

     

       
386
       
 
       


     

       
387
       
 
       
      hetzner_sd_configs = mkOpt (types.listOf promTypes.hetzner_sd_config) ''

     
···

       
807
       
 
       
      filter = mkOpt types.str ''

     

       
808
       
 
       
        Filter can be used optionally to filter the instance list by other

     

       
809
       
 
       
        criteria Syntax of this filter string is described here in the filter

     

       
810
       
-
       
        query parameter section: <link

     

       
811
       
-
       
        xlink:href="https://cloud.google.com/compute/docs/reference/latest/instances/list"

     

       
812
       
-
       
        />.

     

       
813
       
 
       
      '';

     

       
814
       
 
       


     

       
815
       
 
       
      refresh_interval = mkDefOpt types.str "60s" ''

     
···

       
825
       
 
       
        The tag separator used to separate concatenated GCE instance network tags.

     

       
826
       
 
       


     

       
827
       
 
       
        See the GCP documentation on network tags for more information:

     

       
828
       
-
       
        <link xlink:href="https://cloud.google.com/vpc/docs/add-remove-network-tags" />

     

       
829
       
 
       
      '';

     

       
830
       
 
       
    };

     

       
831
       
 
       
  };

     
···

       
1033
       
 
       


     

       
1034
       
 
       
    auth_token = mkOpt types.str ''

     

       
1035
       
 
       
      Optional authentication information for token-based authentication:

     

       
1036
       
-
       
      <link xlink:href="https://docs.mesosphere.com/1.11/security/ent/iam-api/#passing-an-authentication-token" />

     

       
1037
       
 
       
      It is mutually exclusive with <literal>auth_token_file</literal> and other authentication mechanisms.

     

       
1038
       
 
       
    '';

     

       
1039
       
 
       


     

       
1040
       
 
       
    auth_token_file = mkOpt types.str ''

     

       
1041
       
 
       
      Optional authentication information for token-based authentication:

     

       
1042
       
-
       
      <link xlink:href="https://docs.mesosphere.com/1.11/security/ent/iam-api/#passing-an-authentication-token" />

     

       
1043
       
 
       
      It is mutually exclusive with <literal>auth_token</literal> and other authentication mechanisms.

     

       
1044
       
 
       
    '';

     

       
1045
       
 
       
  };

     

···

       
379
       
 
       
      gce_sd_configs = mkOpt (types.listOf promTypes.gce_sd_config) ''

     

       
380
       
 
       
        List of Google Compute Engine service discovery configurations.

     

       
381
       
 
       


     

       
382
       
+
       
        See <link xlink:href="https://prometheus.io/docs/prometheus/latest/configuration/configuration/#gce_sd_config">the relevant Prometheus configuration docs</link>

     

       
383
       
+
       
        for more detail.

     

       
0
       
 
       

     

       
384
       
 
       
      '';

     

       
385
       
 
       


     

       
386
       
 
       
      hetzner_sd_configs = mkOpt (types.listOf promTypes.hetzner_sd_config) ''

     
···

       
806
       
 
       
      filter = mkOpt types.str ''

     

       
807
       
 
       
        Filter can be used optionally to filter the instance list by other

     

       
808
       
 
       
        criteria Syntax of this filter string is described here in the filter

     

       
809
       
+
       
        query parameter section: <link xlink:href="https://cloud.google.com/compute/docs/reference/latest/instances/list"/>.

     

       
0
       
 
       

     

       
0
       
 
       

     

       
810
       
 
       
      '';

     

       
811
       
 
       


     

       
812
       
 
       
      refresh_interval = mkDefOpt types.str "60s" ''

     
···

       
822
       
 
       
        The tag separator used to separate concatenated GCE instance network tags.

     

       
823
       
 
       


     

       
824
       
 
       
        See the GCP documentation on network tags for more information:

     

       
825
       
+
       
        <link xlink:href="https://cloud.google.com/vpc/docs/add-remove-network-tags"/>

     

       
826
       
 
       
      '';

     

       
827
       
 
       
    };

     

       
828
       
 
       
  };

     
···

       
1030
       
 
       


     

       
1031
       
 
       
    auth_token = mkOpt types.str ''

     

       
1032
       
 
       
      Optional authentication information for token-based authentication:

     

       
1033
       
+
       
      <link xlink:href="https://docs.mesosphere.com/1.11/security/ent/iam-api/#passing-an-authentication-token"/>

     

       
1034
       
 
       
      It is mutually exclusive with <literal>auth_token_file</literal> and other authentication mechanisms.

     

       
1035
       
 
       
    '';

     

       
1036
       
 
       


     

       
1037
       
 
       
    auth_token_file = mkOpt types.str ''

     

       
1038
       
 
       
      Optional authentication information for token-based authentication:

     

       
1039
       
+
       
      <link xlink:href="https://docs.mesosphere.com/1.11/security/ent/iam-api/#passing-an-authentication-token"/>

     

       
1040
       
 
       
      It is mutually exclusive with <literal>auth_token</literal> and other authentication mechanisms.

     

       
1041
       
 
       
    '';

     

       
1042
       
 
       
  };

     

···

       
33
       
 
       
        work with this exporter:

     

       
34
       
 
       
        <programlisting>

     

       
35
       
 
       
        {

     

       
36
       
-
       
          <xref linkend="opt-services.prometheus.exporters.dovecot.enable" /> = true;

     

       
37
       
-
       
          <xref linkend="opt-services.prometheus.exporters.dovecot.socketPath" /> = "/var/run/dovecot2/old-stats";

     

       
38
       
-
       
          <xref linkend="opt-services.dovecot2.mailPlugins.globally.enable" /> = [ "old_stats" ];

     

       
39
       
-
       
          <xref linkend="opt-services.dovecot2.extraConfig" /> = '''

     

       
40
       
 
       
            service old-stats {

     

       
41
       
 
       
              unix_listener old-stats {

     

       
42
       
 
       
                user = dovecot-exporter

     

···

       
33
       
 
       
        work with this exporter:

     

       
34
       
 
       
        <programlisting>

     

       
35
       
 
       
        {

     

       
36
       
+
       
          <xref linkend="opt-services.prometheus.exporters.dovecot.enable"/> = true;

     

       
37
       
+
       
          <xref linkend="opt-services.prometheus.exporters.dovecot.socketPath"/> = "/var/run/dovecot2/old-stats";

     

       
38
       
+
       
          <xref linkend="opt-services.dovecot2.mailPlugins.globally.enable"/> = [ "old_stats" ];

     

       
39
       
+
       
          <xref linkend="opt-services.dovecot2.extraConfig"/> = '''

     

       
40
       
 
       
            service old-stats {

     

       
41
       
 
       
              unix_listener old-stats {

     

       
42
       
 
       
                user = dovecot-exporter

     

···

       
22
       
 
       
        All settings expressed as an Nix attrset.

     

       
23
       
 
       


     

       
24
       
 
       
        Check the official documentation for the corresponding YAML

     

       
25
       
-
       
        settings that can all be used here: <link xlink:href="https://github.com/ncabatoff/process-exporter" />

     

       
26
       
 
       
      '';

     

       
27
       
 
       
    };

     

       
28
       
 
       
  };

     

···

       
22
       
 
       
        All settings expressed as an Nix attrset.

     

       
23
       
 
       


     

       
24
       
 
       
        Check the official documentation for the corresponding YAML

     

       
25
       
+
       
        settings that can all be used here: <link xlink:href="https://github.com/ncabatoff/process-exporter"/>

     

       
26
       
 
       
      '';

     

       
27
       
 
       
    };

     

       
28
       
 
       
  };

     

···

       
41
       
 
       
        All settings expressed as an Nix attrset.

     

       
42
       
 
       


     

       
43
       
 
       
        Check the official documentation for the corresponding YAML

     

       
44
       
-
       
        settings that can all be used here: <link xlink:href="https://github.com/adhocteam/script_exporter#sample-configuration" />

     

       
45
       
 
       
      '';

     

       
46
       
 
       
    };

     

       
47
       
 
       
  };

     

···

       
41
       
 
       
        All settings expressed as an Nix attrset.

     

       
42
       
 
       


     

       
43
       
 
       
        Check the official documentation for the corresponding YAML

     

       
44
       
+
       
        settings that can all be used here: <link xlink:href="https://github.com/adhocteam/script_exporter#sample-configuration"/>

     

       
45
       
 
       
      '';

     

       
46
       
 
       
    };

     

       
47
       
 
       
  };

     

···

       
136
       
 
       
        extraArgs = mkOption {

     

       
137
       
 
       
          type = types.lines;

     

       
138
       
 
       
          default = "";

     

       
139
       
-
       
          description = "

     

       
140
       
-
       
            Extra parameters documented <link xlink:href=\"https://github.com/xddxdd/bird-lg-go#frontend\">here</link>.

     

       
141
       
-
       
          ";

     

       
142
       
 
       
        };

     

       
143
       
 
       
      };

     

       
144
       
 
       


     
···

       
183
       
 
       
        extraArgs = mkOption {

     

       
184
       
 
       
          type = types.lines;

     

       
185
       
 
       
          default = "";

     

       
186
       
-
       
          description = "

     

       
187
       
-
       
            Extra parameters documented <link xlink:href=\"https://github.com/xddxdd/bird-lg-go#proxy\">here</link>.

     

       
188
       
-
       
          ";

     

       
189
       
 
       
        };

     

       
190
       
 
       
      };

     

       
191
       
 
       
    };

     

···

       
136
       
 
       
        extraArgs = mkOption {

     

       
137
       
 
       
          type = types.lines;

     

       
138
       
 
       
          default = "";

     

       
139
       
+
       
          description = ''

     

       
140
       
+
       
            Extra parameters documented <link xlink:href="https://github.com/xddxdd/bird-lg-go#frontend">here</link>.

     

       
141
       
+
       
          '';

     

       
142
       
 
       
        };

     

       
143
       
 
       
      };

     

       
144
       
 
       


     
···

       
183
       
 
       
        extraArgs = mkOption {

     

       
184
       
 
       
          type = types.lines;

     

       
185
       
 
       
          default = "";

     

       
186
       
+
       
          description = ''

     

       
187
       
+
       
            Extra parameters documented <link xlink:href="https://github.com/xddxdd/bird-lg-go#proxy">here</link>.

     

       
188
       
+
       
          '';

     

       
189
       
 
       
        };

     

       
190
       
 
       
      };

     

       
191
       
 
       
    };

     

···

       
15
       
 
       
        type = types.lines;

     

       
16
       
 
       
        description = ''

     

       
17
       
 
       
          BIRD Internet Routing Daemon configuration file.

     

       
18
       
-
       
          <link xlink:href='http://bird.network.cz/'/>

     

       
19
       
 
       
        '';

     

       
20
       
 
       
      };

     

       
21
       
 
       
      checkConfig = mkOption {

     

···

       
15
       
 
       
        type = types.lines;

     

       
16
       
 
       
        description = ''

     

       
17
       
 
       
          BIRD Internet Routing Daemon configuration file.

     

       
18
       
+
       
          <link xlink:href="http://bird.network.cz/"/>

     

       
19
       
 
       
        '';

     

       
20
       
 
       
      };

     

       
21
       
 
       
      checkConfig = mkOption {

     

···

       
17
       
 
       
        }

     

       
18
       
 
       
      '';

     

       
19
       
 
       
      type = types.lines;

     

       
20
       
-
       
      description = "Verbatim Corefile to use. See <link xlink:href=\"https://coredns.io/manual/toc/#configuration\"/> for details.";

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
21
       
 
       
    };

     

       
22
       
 
       


     

       
23
       
 
       
    package = mkOption {

     

···

       
17
       
 
       
        }

     

       
18
       
 
       
      '';

     

       
19
       
 
       
      type = types.lines;

     

       
20
       
+
       
      description = ''

     

       
21
       
+
       
        Verbatim Corefile to use.

     

       
22
       
+
       
        See <link xlink:href="https://coredns.io/manual/toc/#configuration"/> for details.

     

       
23
       
+
       
      '';

     

       
24
       
 
       
    };

     

       
25
       
 
       


     

       
26
       
 
       
    package = mkOption {

     

···

       
133
       
 
       
      type = types.lines;

     

       
134
       
 
       
      description = ''

     

       
135
       
 
       
        Extra config to append to `seahub_settings.py` file.

     

       
136
       
-
       
        Refer to <link xlink:href="https://manual.seafile.com/config/seahub_settings_py/" />

     

       
137
       
 
       
        for all available options.

     

       
138
       
 
       
      '';

     

       
139
       
 
       
    };

     

···

       
133
       
 
       
      type = types.lines;

     

       
134
       
 
       
      description = ''

     

       
135
       
 
       
        Extra config to append to `seahub_settings.py` file.

     

       
136
       
+
       
        Refer to <link xlink:href="https://manual.seafile.com/config/seahub_settings_py/"/>

     

       
137
       
 
       
        for all available options.

     

       
138
       
 
       
      '';

     

       
139
       
 
       
    };

     

···

       
302
       
 
       
          Allowed key exchange algorithms

     

       
303
       
 
       


     

       
304
       
 
       
          Uses the lower bound recommended in both

     

       
305
       
-
       
          <link xlink:href="https://stribika.github.io/2015/01/04/secure-secure-shell.html" />

     

       
306
       
 
       
          and

     

       
307
       
-
       
          <link xlink:href="https://infosec.mozilla.org/guidelines/openssh#modern-openssh-67" />

     

       
308
       
 
       
        '';

     

       
309
       
 
       
      };

     

       
310
       
 
       


     
···

       
322
       
 
       
          Allowed ciphers

     

       
323
       
 
       


     

       
324
       
 
       
          Defaults to recommended settings from both

     

       
325
       
-
       
          <link xlink:href="https://stribika.github.io/2015/01/04/secure-secure-shell.html" />

     

       
326
       
 
       
          and

     

       
327
       
-
       
          <link xlink:href="https://infosec.mozilla.org/guidelines/openssh#modern-openssh-67" />

     

       
328
       
 
       
        '';

     

       
329
       
 
       
      };

     

       
330
       
 
       


     
···

       
342
       
 
       
          Allowed MACs

     

       
343
       
 
       


     

       
344
       
 
       
          Defaults to recommended settings from both

     

       
345
       
-
       
          <link xlink:href="https://stribika.github.io/2015/01/04/secure-secure-shell.html" />

     

       
346
       
 
       
          and

     

       
347
       
-
       
          <link xlink:href="https://infosec.mozilla.org/guidelines/openssh#modern-openssh-67" />

     

       
348
       
 
       
        '';

     

       
349
       
 
       
      };

     

       
350
       
 
       


     

···

       
302
       
 
       
          Allowed key exchange algorithms

     

       
303
       
 
       


     

       
304
       
 
       
          Uses the lower bound recommended in both

     

       
305
       
+
       
          <link xlink:href="https://stribika.github.io/2015/01/04/secure-secure-shell.html"/>

     

       
306
       
 
       
          and

     

       
307
       
+
       
          <link xlink:href="https://infosec.mozilla.org/guidelines/openssh#modern-openssh-67"/>

     

       
308
       
 
       
        '';

     

       
309
       
 
       
      };

     

       
310
       
 
       


     
···

       
322
       
 
       
          Allowed ciphers

     

       
323
       
 
       


     

       
324
       
 
       
          Defaults to recommended settings from both

     

       
325
       
+
       
          <link xlink:href="https://stribika.github.io/2015/01/04/secure-secure-shell.html"/>

     

       
326
       
 
       
          and

     

       
327
       
+
       
          <link xlink:href="https://infosec.mozilla.org/guidelines/openssh#modern-openssh-67"/>

     

       
328
       
 
       
        '';

     

       
329
       
 
       
      };

     

       
330
       
 
       


     
···

       
342
       
 
       
          Allowed MACs

     

       
343
       
 
       


     

       
344
       
 
       
          Defaults to recommended settings from both

     

       
345
       
+
       
          <link xlink:href="https://stribika.github.io/2015/01/04/secure-secure-shell.html"/>

     

       
346
       
 
       
          and

     

       
347
       
+
       
          <link xlink:href="https://infosec.mozilla.org/guidelines/openssh#modern-openssh-67"/>

     

       
348
       
 
       
        '';

     

       
349
       
 
       
      };

     

       
350
       
 
       


     

···

       
122
       
 
       
        WireGuard interface is created, and which retains the socket even if the

     

       
123
       
 
       
        interface is moved via <option>interfaceNamespace</option>. When

     

       
124
       
 
       
        <literal>null</literal>, the interface is created in the init namespace.

     

       
125
       
-
       
        See <link

     

       
126
       
-
       
        xlink:href="https://www.wireguard.com/netns/">documentation</link>.

     

       
127
       
 
       
        '';

     

       
128
       
 
       
      };

     

       
129
       
 
       


     
···

       
135
       
 
       
        interface is moved to. The special value <literal>init</literal> means

     

       
136
       
 
       
        the init namespace. When <literal>null</literal>, the interface is not

     

       
137
       
 
       
        moved.

     

       
138
       
-
       
        See <link

     

       
139
       
-
       
        xlink:href="https://www.wireguard.com/netns/">documentation</link>.

     

       
140
       
 
       
        '';

     

       
141
       
 
       
      };

     

       
142
       
 
       
    };

     

···

       
122
       
 
       
        WireGuard interface is created, and which retains the socket even if the

     

       
123
       
 
       
        interface is moved via <option>interfaceNamespace</option>. When

     

       
124
       
 
       
        <literal>null</literal>, the interface is created in the init namespace.

     

       
125
       
+
       
        See <link xlink:href="https://www.wireguard.com/netns/">documentation</link>.

     

       
0
       
 
       

     

       
126
       
 
       
        '';

     

       
127
       
 
       
      };

     

       
128
       
 
       


     
···

       
134
       
 
       
        interface is moved to. The special value <literal>init</literal> means

     

       
135
       
 
       
        the init namespace. When <literal>null</literal>, the interface is not

     

       
136
       
 
       
        moved.

     

       
137
       
+
       
        See <link xlink:href="https://www.wireguard.com/netns/">documentation</link>.

     

       
0
       
 
       

     

       
138
       
 
       
        '';

     

       
139
       
 
       
      };

     

       
140
       
 
       
    };

     

···

       
190
       
 
       
        description = ''

     

       
191
       
 
       
          Whether to allow configuring networks "imperatively" (e.g. via

     

       
192
       
 
       
          <package>wpa_supplicant_gui</package>) and declaratively via

     

       
193
       
-
       
          <xref linkend="opt-networking.wireless.networks" />.

     

       
194
       
 
       


     

       
195
       
 
       
          Please note that this adds a custom patch to <package>wpa_supplicant</package>.

     

       
196
       
 
       
        '';

     

···

       
190
       
 
       
        description = ''

     

       
191
       
 
       
          Whether to allow configuring networks "imperatively" (e.g. via

     

       
192
       
 
       
          <package>wpa_supplicant_gui</package>) and declaratively via

     

       
193
       
+
       
          <xref linkend="opt-networking.wireless.networks"/>.

     

       
194
       
 
       


     

       
195
       
 
       
          Please note that this adds a custom patch to <package>wpa_supplicant</package>.

     

       
196
       
 
       
        '';

     

···

       
78
       
 
       
          using <package>envsubst</package> which is helpful for specifying

     

       
79
       
 
       
          secrets:

     

       
80
       
 
       
          <programlisting>

     

       
81
       
-
       
          { <xref linkend="opt-services.privacyidea.secretKey" /> = "$SECRET"; }

     

       
82
       
 
       
          </programlisting>

     

       
83
       
 
       


     

       
84
       
 
       
          The environment-file can now specify the actual secret key:

     
···

       
207
       
 
       
          description = ''

     

       
208
       
 
       
            Attribute-set containing the settings for <package>privacyidea-ldap-proxy</package>.

     

       
209
       
 
       
            It's possible to pass secrets using env-vars as substitutes and

     

       
210
       
-
       
            use the option <xref linkend="opt-services.privacyidea.ldap-proxy.environmentFile" />

     

       
211
       
 
       
            to inject them via <package>envsubst</package>.

     

       
212
       
 
       
          '';

     

       
213
       
 
       
        };

     
···

       
217
       
 
       
          type = types.nullOr types.str;

     

       
218
       
 
       
          description = ''

     

       
219
       
 
       
            Environment file containing secrets to be substituted into

     

       
220
       
-
       
            <xref linkend="opt-services.privacyidea.ldap-proxy.settings" />.

     

       
221
       
 
       
          '';

     

       
222
       
 
       
        };

     

       
223
       
 
       
      };

     

···

       
78
       
 
       
          using <package>envsubst</package> which is helpful for specifying

     

       
79
       
 
       
          secrets:

     

       
80
       
 
       
          <programlisting>

     

       
81
       
+
       
          { <xref linkend="opt-services.privacyidea.secretKey"/> = "$SECRET"; }

     

       
82
       
 
       
          </programlisting>

     

       
83
       
 
       


     

       
84
       
 
       
          The environment-file can now specify the actual secret key:

     
···

       
207
       
 
       
          description = ''

     

       
208
       
 
       
            Attribute-set containing the settings for <package>privacyidea-ldap-proxy</package>.

     

       
209
       
 
       
            It's possible to pass secrets using env-vars as substitutes and

     

       
210
       
+
       
            use the option <xref linkend="opt-services.privacyidea.ldap-proxy.environmentFile"/>

     

       
211
       
 
       
            to inject them via <package>envsubst</package>.

     

       
212
       
 
       
          '';

     

       
213
       
 
       
        };

     
···

       
217
       
 
       
          type = types.nullOr types.str;

     

       
218
       
 
       
          description = ''

     

       
219
       
 
       
            Environment file containing secrets to be substituted into

     

       
220
       
+
       
            <xref linkend="opt-services.privacyidea.ldap-proxy.settings"/>.

     

       
221
       
 
       
          '';

     

       
222
       
 
       
        };

     

       
223
       
 
       
      };

     

···

       
36
       
 
       
        type = with lib.types; attrsOf anything;

     

       
37
       
 
       
        description = ''

     

       
38
       
 
       
          Settings that go into <filename>ca.json</filename>. See

     

       
39
       
-
       
          <link xlink:href="https://smallstep.com/docs/step-ca/configuration">

     

       
40
       
-
       
          the step-ca manual</link> for more information. The easiest way to

     

       
41
       
 
       
          configure this module would be to run <literal>step ca init</literal>

     

       
42
       
 
       
          to generate <filename>ca.json</filename> and then import it using

     

       
43
       
 
       
          <literal>builtins.fromJSON</literal>.

     

···

       
36
       
 
       
        type = with lib.types; attrsOf anything;

     

       
37
       
 
       
        description = ''

     

       
38
       
 
       
          Settings that go into <filename>ca.json</filename>. See

     

       
39
       
+
       
          <link xlink:href="https://smallstep.com/docs/step-ca/configuration">the step-ca manual</link>

     

       
40
       
+
       
          for more information. The easiest way to

     

       
41
       
 
       
          configure this module would be to run <literal>step ca init</literal>

     

       
42
       
 
       
          to generate <filename>ca.json</filename> and then import it using

     

       
43
       
 
       
          <literal>builtins.fromJSON</literal>.

     

···

       
287
       
 
       
      relay = {

     

       
288
       
 
       
        enable = mkEnableOption ''relaying of Tor traffic for others.

     

       
289
       
 
       


     

       
290
       
-
       
          See <link xlink:href="https://www.torproject.org/docs/tor-doc-relay" />

     

       
291
       
 
       
          for details.

     

       
292
       
 
       


     

       
293
       
 
       
          Setting this to true requires setting

     
···

       
348
       
 
       


     

       
349
       
 
       
                <para>

     

       
350
       
 
       
                  See

     

       
351
       
-
       
                  <link xlink:href="https://www.torproject.org/docs/tor-doc-relay.html.en" />

     

       
352
       
 
       
                  for more info.

     

       
353
       
 
       
                </para>

     

       
354
       
 
       
              </listitem>

     
···

       
366
       
 
       
                <para>

     

       
367
       
 
       
                  Using this option will make Tor advertise your bridge

     

       
368
       
 
       
                  to users through various mechanisms like

     

       
369
       
-
       
                  <link xlink:href="https://bridges.torproject.org/" />, though.

     

       
370
       
 
       
                </para>

     

       
371
       
 
       


     

       
372
       
 
       
                <important>

     
···

       
384
       
 
       
                </important>

     

       
385
       
 
       


     

       
386
       
 
       
                <para>

     

       
387
       
-
       
                  See <link xlink:href="https://www.torproject.org/docs/bridges.html.en" />

     

       
388
       
 
       
                  for more info.

     

       
389
       
 
       
                </para>

     

       
390
       
 
       
              </listitem>

     
···

       
419
       
 
       
                </para>

     

       
420
       
 
       


     

       
421
       
 
       
                <para>

     

       
422
       
-
       
                  See <link xlink:href="https://www.torproject.org/docs/bridges.html.en" />

     

       
423
       
 
       
                  for more info.

     

       
424
       
 
       
                </para>

     

       
425
       
 
       
              </listitem>

     

···

       
287
       
 
       
      relay = {

     

       
288
       
 
       
        enable = mkEnableOption ''relaying of Tor traffic for others.

     

       
289
       
 
       


     

       
290
       
+
       
          See <link xlink:href="https://www.torproject.org/docs/tor-doc-relay"/>

     

       
291
       
 
       
          for details.

     

       
292
       
 
       


     

       
293
       
 
       
          Setting this to true requires setting

     
···

       
348
       
 
       


     

       
349
       
 
       
                <para>

     

       
350
       
 
       
                  See

     

       
351
       
+
       
                  <link xlink:href="https://www.torproject.org/docs/tor-doc-relay.html.en"/>

     

       
352
       
 
       
                  for more info.

     

       
353
       
 
       
                </para>

     

       
354
       
 
       
              </listitem>

     
···

       
366
       
 
       
                <para>

     

       
367
       
 
       
                  Using this option will make Tor advertise your bridge

     

       
368
       
 
       
                  to users through various mechanisms like

     

       
369
       
+
       
                  <link xlink:href="https://bridges.torproject.org/"/>, though.

     

       
370
       
 
       
                </para>

     

       
371
       
 
       


     

       
372
       
 
       
                <important>

     
···

       
384
       
 
       
                </important>

     

       
385
       
 
       


     

       
386
       
 
       
                <para>

     

       
387
       
+
       
                  See <link xlink:href="https://www.torproject.org/docs/bridges.html.en"/>

     

       
388
       
 
       
                  for more info.

     

       
389
       
 
       
                </para>

     

       
390
       
 
       
              </listitem>

     
···

       
419
       
 
       
                </para>

     

       
420
       
 
       


     

       
421
       
 
       
                <para>

     

       
422
       
+
       
                  See <link xlink:href="https://www.torproject.org/docs/bridges.html.en"/>

     

       
423
       
 
       
                  for more info.

     

       
424
       
 
       
                </para>

     

       
425
       
 
       
              </listitem>

     

···

       
116
       
 
       
        The available configuration options can be found in

     

       
117
       
 
       
        <link xlink:href="https://github.com/dani-garcia/vaultwarden/blob/${vaultwarden.version}/.env.template">the environment template file</link>.

     

       
118
       
 
       


     

       
119
       
-
       
        See <xref linkend="opt-services.vaultwarden.environmentFile" /> for how

     

       
120
       
 
       
        to set up access to the Admin UI to invite initial users.

     

       
121
       
 
       
      '';

     

       
122
       
 
       
    };

     

···

       
116
       
 
       
        The available configuration options can be found in

     

       
117
       
 
       
        <link xlink:href="https://github.com/dani-garcia/vaultwarden/blob/${vaultwarden.version}/.env.template">the environment template file</link>.

     

       
118
       
 
       


     

       
119
       
+
       
        See <xref linkend="opt-services.vaultwarden.environmentFile"/> for how

     

       
120
       
 
       
        to set up access to the Admin UI to invite initial users.

     

       
121
       
 
       
      '';

     

       
122
       
 
       
    };

     

···

       
152
       
 
       
        '';

     

       
153
       
 
       
        description = ''

     

       
154
       
 
       
          Specify the Content Security Policy which is passed to Helmet.

     

       
155
       
-
       
          For configuration details see <link xlink:href="https://helmetjs.github.io/docs/csp/"

     

       
156
       
-
       
          >https://helmetjs.github.io/docs/csp/</link>.

     

       
157
       
 
       
        '';

     

       
158
       
 
       
      };

     

       
159
       
 
       
      protocolUseSSL = mkOption {

     

···

       
152
       
 
       
        '';

     

       
153
       
 
       
        description = ''

     

       
154
       
 
       
          Specify the Content Security Policy which is passed to Helmet.

     

       
155
       
+
       
          For configuration details see <link xlink:href="https://helmetjs.github.io/docs/csp/"/>.

     

       
0
       
 
       

     

       
156
       
 
       
        '';

     

       
157
       
 
       
      };

     

       
158
       
 
       
      protocolUseSSL = mkOption {

     

···

       
215
       
 
       
            manually provisioned database; has no effect when a local

     

       
216
       
 
       
            database is automatically provisioned.

     

       
217
       
 
       


     

       
218
       
-
       
            To use this with a local database, set <xref

     

       
219
       
-
       
            linkend="opt-services.keycloak.database.createLocally" /> to

     

       
220
       
 
       
            <literal>false</literal> and create the database and user

     

       
221
       
 
       
            manually.

     

       
222
       
 
       
          '';

     
···

       
230
       
 
       
            provisioned database; has no effect when a local database is

     

       
231
       
 
       
            automatically provisioned.

     

       
232
       
 
       


     

       
233
       
-
       
            To use this with a local database, set <xref

     

       
234
       
-
       
            linkend="opt-services.keycloak.database.createLocally" /> to

     

       
235
       
 
       
            <literal>false</literal> and create the database and user

     

       
236
       
 
       
            manually.

     

       
237
       
 
       
          '';

     
···

       
329
       
 
       
                    want to set this to <literal>/auth</literal> to

     

       
330
       
 
       
                    keep compatibility with your clients.

     

       
331
       
 
       


     

       
332
       
-
       
                    See <link

     

       
333
       
-
       
                    xlink:href="https://www.keycloak.org/migration/migrating-to-quarkus"

     

       
334
       
-
       
                    /> for more information on migrating from Wildfly

     

       
335
       
-
       
                    to Quarkus.

     

       
336
       
 
       
                  </para>

     

       
337
       
 
       
                </note>

     

       
338
       
 
       
              '';

     
···

       
404
       
 
       
                  </varlistentry>

     

       
405
       
 
       
                </variablelist>

     

       
406
       
 
       


     

       
407
       
-
       
                See <link

     

       
408
       
-
       
                xlink:href="https://www.keycloak.org/server/reverseproxy"

     

       
409
       
-
       
                /> for more information.

     

       
410
       
 
       
              '';

     

       
411
       
 
       
            };

     

       
412
       
 
       
          };

     
···

       
425
       
 
       
          Configuration options corresponding to parameters set in

     

       
426
       
 
       
          <filename>conf/keycloak.conf</filename>.

     

       
427
       
 
       


     

       
428
       
-
       
          Most available options are documented at <link

     

       
429
       
-
       
          xlink:href="https://www.keycloak.org/server/all-config" />.

     

       
430
       
 
       


     

       
431
       
 
       
          Options containing secret data should be set to an attribute

     

       
432
       
 
       
          set containing the attribute <literal>_secret</literal> - a