commit d1165dba9979b6bd4ba063b7e39384ece33eec4e · pyrox.dev/nixpkgs

+2 -2

.editorconfig

···

       13
       13
        
       

     

       14
       14
        
       # see https://nixos.org/nixpkgs/manual/#chap-conventions

     

       15
       15
        
       

     

       16
       16
       -
       # Match nix/ruby files, set indent to spaces with width of two

     

       17
       17
       -
       [*.{nix,rb}]

     

       16
       16
       +
       # Match nix/ruby/docbook files, set indent to spaces with width of two

     

       17
       17
       +
       [*.{nix,rb,xml}]

     

       18
       18
        
       indent_style = space

     

       19
       19
        
       indent_size = 2

     

       20
       20

+2 -2

nixos/doc/manual/administration/cleaning-store.xml

···

       29
       29
        
       night at 03:15:

     

       30
       30
        
       

     

       31
       31
        
       <programlisting>

     

       32
       32
       -
       nix.gc.automatic = true;

     

       33
       33
       -
       nix.gc.dates = "03:15";

     

       32
       32
       +
       <xref linkend="opt-nix.gc.automatic"/> = true;

     

       33
       33
       +
       <xref linkend="opt-nix.gc.dates"/> = "03:15";

     

       34
       34
        
       </programlisting>

     

       35
       35
        
       

     

       36
       36
        
       </para>

+3 -3

nixos/doc/manual/administration/container-networking.xml

···

       39
       39
        
       on the host:

     

       40
       40
        
       

     

       41
       41
        
       <programlisting>

     

       42
       42
       -
       networking.nat.enable = true;

     

       43
       43
       -
       networking.nat.internalInterfaces = ["ve-+"];

     

       44
       44
       -
       networking.nat.externalInterface = "eth0";

     

       42
       42
       +
       <xref linkend="opt-networking.nat.enable"/> = true;

     

       43
       43
       +
       <xref linkend="opt-networking.nat.internalInterfaces"/> = ["ve-+"];

     

       44
       44
       +
       <xref linkend="opt-networking.nat.externalInterface"/> = "eth0";

     

       45
       45
        
       </programlisting>

     

       46
       46
        
       where <literal>eth0</literal> should be replaced with the desired

     

       47
       47
        
       external interface. Note that <literal>ve-+</literal> is a wildcard

+2 -2

nixos/doc/manual/administration/control-groups.xml

···

       47
       47
        
       CPU share in <filename>configuration.nix</filename>:

     

       48
       48
        
       

     

       49
       49
        
       <programlisting>

     

       50
       50
       -
       systemd.services.httpd.serviceConfig.CPUShares = 512;

     

       50
       50
       +
       <link linkend="opt-systemd.services._name_.serviceConfig">systemd.services.httpd.serviceConfig</link>.CPUShares = 512;

     

       51
       51
        
       </programlisting>

     

       52
       52
        
       

     

       53
       53
        
       By default, every cgroup has 1024 CPU shares, so this will halve the

     
···

       61
       61
        
       <literal>httpd.service</literal> to 512 MiB of RAM (excluding swap):

     

       62
       62
        
       

     

       63
       63
        
       <programlisting>

     

       64
       64
       -
       systemd.services.httpd.serviceConfig.MemoryLimit = "512M";

     

       64
       64
       +
       <link linkend="opt-systemd.services._name_.serviceConfig">systemd.services.httpd.serviceConfig</link>.MemoryLimit = "512M";

     

       65
       65
        
       </programlisting>

     

       66
       66
        
       

     

       67
       67
        
       </para>

+7 -7

nixos/doc/manual/administration/declarative-containers.xml

···

       15
       15
        
       containers.database =

     

       16
       16
        
         { config =

     

       17
       17
        
             { config, pkgs, ... }:

     

       18
       18
       -
             { services.postgresql.enable = true;

     

       19
       19
       -
               services.postgresql.package = pkgs.postgresql96;

     

       18
       18
       +
             { <xref linkend="opt-services.postgresql.enable"/> = true;

     

       19
       19
       +
             <xref linkend="opt-services.postgresql.package"/> = pkgs.postgresql96;

     

       20
       20
        
             };

     

       21
       21
        
         };

     

       22
       22
        
       </programlisting>

     
···

       33
       33
        
       give a container its own network as follows:

     

       34
       34
        
       

     

       35
       35
        
       <programlisting>

     

       36
       36
       -
       containers.database =

     

       37
       37
       -
         { privateNetwork = true;

     

       38
       38
       -
           hostAddress = "192.168.100.10";

     

       39
       39
       -
           localAddress = "192.168.100.11";

     

       40
       40
       -
         };

     

       36
       36
       +
       containers.database = {

     

       37
       37
       +
         <link linkend="opt-containers._name_.privateNetwork">privateNetwork</link> = true;

     

       38
       38
       +
         <link linkend="opt-containers._name_.hostAddress">hostAddress</link> = "192.168.100.10";

     

       39
       39
       +
         <link linkend="opt-containers._name_.localAddress">localAddress</link> = "192.168.100.11";

     

       40
       40
       +
       };

     

       41
       41
        
       </programlisting>

     

       42
       42
        
       

     

       43
       43
        
       This gives the container a private virtual Ethernet interface with IP

+5 -5

nixos/doc/manual/administration/imperative-containers.xml

···

       30
       30
        
       

     

       31
       31
        
       <screen>

     

       32
       32
        
       # nixos-container create foo --config '

     

       33
       33
       -
         services.openssh.enable = true;

     

       34
       34
       -
         users.extraUsers.root.openssh.authorizedKeys.keys = ["ssh-dss AAAAB3N…"];

     

       33
       33
       +
         <xref linkend="opt-services.openssh.enable"/> = true;

     

       34
       34
       +
         <link linkend="opt-users.users._name__.openssh.authorizedKeys.keys">users.extraUsers.root.openssh.authorizedKeys.keys</link> = ["ssh-dss AAAAB3N…"];

     

       35
       35
        
       '

     

       36
       36
        
       </screen>

     

       37
       37
        
       

     
···

       100
       100
        
       

     

       101
       101
        
       <screen>

     

       102
       102
        
       # nixos-container update foo --config '

     

       103
       103
       -
         services.httpd.enable = true;

     

       104
       104
       -
         services.httpd.adminAddr = "foo@example.org";

     

       105
       105
       -
         networking.firewall.allowedTCPPorts = [ 80 ];

     

       103
       103
       +
         <xref linkend="opt-services.httpd.enable"/> = true;

     

       104
       104
       +
         <xref linkend="opt-services.httpd.adminAddr"/> = "foo@example.org";

     

       105
       105
       +
         <xref linkend="opt-networking.firewall.allowedTCPPorts"/> = [ 80 ];

     

       106
       106
        
       '

     

       107
       107
        
       

     

       108
       108
        
       # curl http://$(nixos-container show-ip foo)/

+6 -6

nixos/doc/manual/configuration/abstractions.xml

···

       11
       11
        
       

     

       12
       12
        
       <programlisting>

     

       13
       13
        
       {

     

       14
       14
       -
         services.httpd.virtualHosts =

     

       14
       14
       +
         <xref linkend="opt-services.httpd.virtualHosts"/> =

     

       15
       15
        
           [ { hostName = "example.org";

     

       16
       16
        
               documentRoot = "/webroot";

     

       17
       17
        
               adminAddr = "alice@example.org";

     
···

       43
       43
        
           };

     

       44
       44
        
       in

     

       45
       45
        
       {

     

       46
       46
       -
         services.httpd.virtualHosts =

     

       46
       46
       +
         <xref linkend="opt-services.httpd.virtualHosts"/> =

     

       47
       47
        
           [ exampleOrgCommon

     

       48
       48
        
             (exampleOrgCommon // {

     

       49
       49
        
               enableSSL = true;

     
···

       66
       66
        
       

     

       67
       67
        
       <programlisting>

     

       68
       68
        
       {

     

       69
       69
       -
         services.httpd.virtualHosts =

     

       69
       69
       +
         <xref linkend="opt-services.httpd.virtualHosts"/> =

     

       70
       70
        
           let exampleOrgCommon = <replaceable>...</replaceable>; in

     

       71
       71
        
           [ exampleOrgCommon

     

       72
       72
        
             (exampleOrgCommon // { <replaceable>...</replaceable> })

     
···

       86
       86
        
       

     

       87
       87
        
       <programlisting>

     

       88
       88
        
       {

     

       89
       89
       -
         services.httpd.virtualHosts =

     

       89
       89
       +
         <xref linkend="opt-services.httpd.virtualHosts"/> =

     

       90
       90
        
           let

     

       91
       91
        
             makeVirtualHost = name:

     

       92
       92
        
               { hostName = name;

     
···

       113
       113
        
       

     

       114
       114
        
       <programlisting>

     

       115
       115
        
       {

     

       116
       116
       -
         services.httpd.virtualHosts =

     

       116
       116
       +
         <xref linkend="opt-services.httpd.virtualHosts"/> =

     

       117
       117
        
           let

     

       118
       118
        
             makeVirtualHost = <replaceable>...</replaceable>;

     

       119
       119
        
           in map makeVirtualHost

     
···

       132
       132
        
       

     

       133
       133
        
       <programlisting>

     

       134
       134
        
       {

     

       135
       135
       -
         services.httpd.virtualHosts =

     

       135
       135
       +
         <xref linkend="opt-services.httpd.virtualHosts"/> =

     

       136
       136
        
           let

     

       137
       137
        
             makeVirtualHost = { name, root }:

     

       138
       138
        
               { hostName = name;

+2 -2

nixos/doc/manual/configuration/ad-hoc-network-config.xml

···

       6
       6
        
       

     

       7
       7
        
       <title>Ad-Hoc Configuration</title>

     

       8
       8
        
       

     

       9
       9
       -
       <para>You can use <option>networking.localCommands</option> to specify

     

       9
       9
       +
       <para>You can use <xref linkend="opt-networking.localCommands"/> to specify

     

       10
       10
        
       shell commands to be run at the end of

     

       11
       11
        
       <literal>network-setup.service</literal>.  This is useful for doing

     

       12
       12
        
       network configuration not covered by the existing NixOS modules.  For

     

       13
       13
        
       instance, to statically configure an IPv6 address:

     

       14
       14
        
       

     

       15
       15
        
       <programlisting>

     

       16
       16
       -
       networking.localCommands =

     

       16
       16
       +
       <xref linkend="opt-networking.localCommands"/> =

     

       17
       17
        
         ''

     

       18
       18
        
           ip -6 addr add 2001:610:685:1::1/64 dev eth0

     

       19
       19
        
         '';

+3 -3

nixos/doc/manual/configuration/adding-custom-packages.xml

···

       24
       24
        
       <literal>environment.systemPackages</literal>, e.g.

     

       25
       25
        
       

     

       26
       26
        
       <programlisting>

     

       27
       27
       -
       environment.systemPackages = [ pkgs.my-package ];

     

       27
       27
       +
       <xref linkend="opt-environment.systemPackages"/> = [ pkgs.my-package ];

     

       28
       28
        
       </programlisting>

     

       29
       29
        
       

     

       30
       30
        
       and you run <command>nixos-rebuild</command>, specifying your own

     
···

       41
       41
        
       package directly in <filename>configuration.nix</filename>:

     

       42
       42
        
       

     

       43
       43
        
       <programlisting>

     

       44
       44
       -
       environment.systemPackages =

     

       44
       44
       +
       <xref linkend="opt-environment.systemPackages"/> =

     

       45
       45
        
         let

     

       46
       46
        
           my-hello = with pkgs; stdenv.mkDerivation rec {

     

       47
       47
        
             name = "hello-2.8";

     
···

       57
       57
        
       Of course, you can also move the definition of

     

       58
       58
        
       <literal>my-hello</literal> into a separate Nix expression, e.g.

     

       59
       59
        
       <programlisting>

     

       60
       60
       -
       environment.systemPackages = [ (import ./my-hello.nix) ];

     

       60
       60
       +
       <xref linkend="opt-environment.systemPackages"/> = [ (import ./my-hello.nix) ];

     

       61
       61
        
       </programlisting>

     

       62
       62
        
       where <filename>my-hello.nix</filename> contains:

     

       63
       63
        
       <programlisting>

+13 -13

nixos/doc/manual/configuration/config-file.xml

···

       28
       28
        
       <programlisting>

     

       29
       29
        
       { config, pkgs, ... }:

     

       30
       30
        
       

     

       31
       31
       -
       { services.httpd.enable = true;

     

       32
       32
       -
         services.httpd.adminAddr = "alice@example.org";

     

       33
       33
       -
         services.httpd.documentRoot = "/webroot";

     

       31
       31
       +
       { <xref linkend="opt-services.httpd.enable"/> = true;

     

       32
       32
       +
         <xref linkend="opt-services.httpd.adminAddr"/> = "alice@example.org";

     

       33
       33
       +
         <xref linkend="opt-services.httpd.documentRoot"/> = "/webroot";

     

       34
       34
        
       }

     

       35
       35
        
       </programlisting>

     

       36
       36
        
       

     
···

       40
       40
        
       

     

       41
       41
        
       <para>Sets can be nested, and in fact dots in option names are

     

       42
       42
        
       shorthand for defining a set containing another set.  For instance,

     

       43
       43
       -
       <option>services.httpd.enable</option> defines a set named

     

       43
       43
       +
       <xref linkend="opt-services.httpd.enable"/> defines a set named

     

       44
       44
        
       <varname>services</varname> that contains a set named

     

       45
       45
        
       <varname>httpd</varname>, which in turn contains an option definition

     

       46
       46
        
       named <varname>enable</varname> with value <literal>true</literal>.

     
···

       89
       89
        
             <para>Strings are enclosed in double quotes, e.g.

     

       90
       90
        
       

     

       91
       91
        
       <programlisting>

     

       92
       92
       -
       networking.hostName = "dexter";

     

       92
       92
       +
       <xref linkend="opt-networking.hostName"/> = "dexter";

     

       93
       93
        
       </programlisting>

     

       94
       94
        
       

     

       95
       95
        
             Special characters can be escaped by prefixing them with a

     
···

       99
       99
        
             single quotes</emphasis>, e.g.

     

       100
       100
        
       

     

       101
       101
        
       <programlisting>

     

       102
       102
       -
       networking.extraHosts =

     

       102
       102
       +
       <xref linkend="opt-networking.extraHosts"/> =

     

       103
       103
        
         ''

     

       104
       104
        
           127.0.0.2 other-localhost

     

       105
       105
        
           10.0.0.1 server

     
···

       125
       125
        
             <literal>false</literal>, e.g.

     

       126
       126
        
       

     

       127
       127
        
       <programlisting>

     

       128
       128
       -
       networking.firewall.enable = true;

     

       129
       129
       -
       networking.firewall.allowPing = false;

     

       128
       128
       +
       <xref linkend="opt-networking.firewall.enable"/> = true;

     

       129
       129
       +
       <xref linkend="opt-networking.firewall.allowPing"/> = false;

     

       130
       130
        
       </programlisting>

     

       131
       131
        
             </para>

     

       132
       132
        
           </listitem>

     
···

       138
       138
        
             <para>For example,

     

       139
       139
        
       

     

       140
       140
        
       <programlisting>

     

       141
       141
       -
       boot.kernel.sysctl."net.ipv4.tcp_keepalive_time" = 60;

     

       141
       141
       +
       <xref linkend="opt-boot.kernel.sysctl"/>."net.ipv4.tcp_keepalive_time" = 60;

     

       142
       142
        
       </programlisting>

     

       143
       143
        
       

     

       144
       144
        
             (Note that here the attribute name

     
···

       158
       158
        
             enclosed in braces, as in the option definition

     

       159
       159
        
       

     

       160
       160
        
       <programlisting>

     

       161
       161
       -
       fileSystems."/boot" =

     

       161
       161
       +
       <xref linkend="opt-fileSystems"/>."/boot" =

     

       162
       162
        
         { device = "/dev/sda1";

     

       163
       163
        
           fsType = "ext4";

     

       164
       164
        
           options = [ "rw" "data=ordered" "relatime" ];

     
···

       175
       175
        
             elements are separated by whitespace, like this:

     

       176
       176
        
       

     

       177
       177
        
       <programlisting>

     

       178
       178
       -
       boot.kernelModules = [ "fuse" "kvm-intel" "coretemp" ];

     

       178
       178
       +
       <xref linkend="opt-boot.kernelModules"/> = [ "fuse" "kvm-intel" "coretemp" ];

     

       179
       179
        
       </programlisting>

     

       180
       180
        
       

     

       181
       181
        
             List elements can be any other type, e.g. sets:

     
···

       195
       195
        
             the function argument <varname>pkgs</varname>.  Typical uses:

     

       196
       196
        
       

     

       197
       197
        
       <programlisting>

     

       198
       198
       -
       environment.systemPackages =

     

       198
       198
       +
       <xref linkend="opt-environment.systemPackages"/> =

     

       199
       199
        
         [ pkgs.thunderbird

     

       200
       200
        
           pkgs.emacs

     

       201
       201
        
         ];

     

       202
       202
        
       

     

       203
       203
       -
       postgresql.package = pkgs.postgresql90;

     

       203
       203
       +
       <xref linkend="opt-services.postgresql.package"/> = pkgs.postgresql90;

     

       204
       204
        
       </programlisting>

     

       205
       205
        
       

     

       206
       206
        
             The latter option definition changes the default PostgreSQL

+3 -3

nixos/doc/manual/configuration/customizing-packages.xml

···

       28
       28
        
       you can specify that as follows:

     

       29
       29
        
       

     

       30
       30
        
       <programlisting>

     

       31
       31
       -
       environment.systemPackages = [ (pkgs.emacs.override { gtk = pkgs.gtk3; }) ];

     

       31
       31
       +
       <xref linkend="opt-environment.systemPackages"/> = [ (pkgs.emacs.override { gtk = pkgs.gtk3; }) ];

     

       32
       32
        
       </programlisting>

     

       33
       33
        
       

     

       34
       34
        
       The function <varname>override</varname> performs the call to the Nix

     
···

       38
       38
        
       causing Emacs to depend on GTK+ 3.  (The parentheses are necessary

     

       39
       39
        
       because in Nix, function application binds more weakly than list

     

       40
       40
        
       construction, so without them,

     

       41
       41
       -
       <literal>environment.systemPackages</literal> would be a list with two

     

       41
       41
       +
       <xref linkend="opt-environment.systemPackages"/> would be a list with two

     

       42
       42
        
       elements.)</para>

     

       43
       43
        
       

     

       44
       44
        
       <para>Even greater customisation is possible using the function

     
···

       51
       51
        
       can say:

     

       52
       52
        
       

     

       53
       53
        
       <programlisting>

     

       54
       54
       -
       environment.systemPackages = [

     

       54
       54
       +
       <xref linkend="opt-environment.systemPackages"/> = [

     

       55
       55
        
         (pkgs.emacs.overrideAttrs (oldAttrs: {

     

       56
       56
        
           name = "emacs-25.0-pre";

     

       57
       57
        
           src = /path/to/my/emacs/tree;

+3 -3

nixos/doc/manual/configuration/declarative-packages.xml

···

       8
       8
        
       

     

       9
       9
        
       <para>With declarative package management, you specify which packages

     

       10
       10
        
       you want on your system by setting the option

     

       11
       11
       -
       <option>environment.systemPackages</option>.  For instance, adding the

     

       11
       11
       +
       <xref linkend="opt-environment.systemPackages"/>.  For instance, adding the

     

       12
       12
        
       following line to <filename>configuration.nix</filename> enables the

     

       13
       13
        
       Mozilla Thunderbird email application:

     

       14
       14
        
       

     

       15
       15
        
       <programlisting>

     

       16
       16
       -
       environment.systemPackages = [ pkgs.thunderbird ];

     

       16
       16
       +
       <xref linkend="opt-environment.systemPackages"/> = [ pkgs.thunderbird ];

     

       17
       17
        
       </programlisting>

     

       18
       18
        
       

     

       19
       19
        
       The effect of this specification is that the Thunderbird package from

     
···

       34
       34
        
       different channels that you might have.)</para>

     

       35
       35
        
       

     

       36
       36
        
       <para>To “uninstall” a package, simply remove it from

     

       37
       37
       -
       <option>environment.systemPackages</option> and run

     

       37
       37
       +
       <xref linkend="opt-environment.systemPackages"/> and run

     

       38
       38
        
       <command>nixos-rebuild switch</command>.</para>

     

       39
       39
        
       

     

       40
       40
        
       <xi:include href="customizing-packages.xml" />

+4 -4

nixos/doc/manual/configuration/file-systems.xml

···

       13
       13
        
       point <filename>/data</filename>:

     

       14
       14
        
       

     

       15
       15
        
       <programlisting>

     

       16
       16
       -
       fileSystems."/data" =

     

       16
       16
       +
       <xref linkend="opt-fileSystems"/>."/data" =

     

       17
       17
        
         { device = "/dev/disk/by-label/data";

     

       18
       18
        
           fsType = "ext4";

     

       19
       19
        
         };

     

       20
       20
        
       </programlisting>

     

       21
       21
        
       

     

       22
       22
        
       Mount points are created automatically if they don’t already exist.

     

       23
       23
       -
       For <option>device</option>, it’s best to use the topology-independent

     

       23
       23
       +
       For <option><link linkend="opt-fileSystems._name__.device">device</link></option>, it’s best to use the topology-independent

     

       24
       24
        
       device aliases in <filename>/dev/disk/by-label</filename> and

     

       25
       25
        
       <filename>/dev/disk/by-uuid</filename>, as these don’t change if the

     

       26
       26
        
       topology changes (e.g. if a disk is moved to another IDE

     

       27
       27
        
       controller).</para>

     

       28
       28
        
       

     

       29
       29
        
       <para>You can usually omit the file system type

     

       30
       30
       -
       (<option>fsType</option>), since <command>mount</command> can usually

     

       30
       30
       +
       (<option><link linkend="opt-fileSystems._name__.fsType">fsType</link></option>), since <command>mount</command> can usually

     

       31
       31
        
       detect the type and load the necessary kernel module automatically.

     

       32
       32
        
       However, if the file system is needed at early boot (in the initial

     

       33
       33
        
       ramdisk) and is not <literal>ext2</literal>, <literal>ext3</literal>

     
···

       38
       38
        
       <note><para>System startup will fail if any of the filesystems fails to mount,

     

       39
       39
        
       dropping you to the emergency shell.

     

       40
       40
        
       You can make a mount asynchronous and non-critical by adding

     

       41
       41
       -
       <literal>options = [ "nofail" ];</literal>.

     

       41
       41
       +
       <literal><link linkend="opt-fileSystems._name__.options">options</link> = [ "nofail" ];</literal>.

     

       42
       42
        
       </para></note>

     

       43
       43
        
       

     

       44
       44
        
       <xi:include href="luks-file-systems.xml" />

+7 -7

nixos/doc/manual/configuration/firewall.xml

···

       12
       12
        
       disabled as follows:

     

       13
       13
        
       

     

       14
       14
        
       <programlisting>

     

       15
       15
       -
       networking.firewall.enable = false;

     

       15
       15
       +
       <xref linkend="opt-networking.firewall.enable"/> = false;

     

       16
       16
        
       </programlisting>

     

       17
       17
        
       

     

       18
       18
        
       If the firewall is enabled, you can open specific TCP ports to the

     

       19
       19
        
       outside world:

     

       20
       20
        
       

     

       21
       21
        
       <programlisting>

     

       22
       22
       -
       networking.firewall.allowedTCPPorts = [ 80 443 ];

     

       22
       22
       +
       <xref linkend="opt-networking.firewall.allowedTCPPorts"/> = [ 80 443 ];

     

       23
       23
        
       </programlisting>

     

       24
       24
        
       

     

       25
       25
        
       Note that TCP port 22 (ssh) is opened automatically if the SSH daemon

     

       26
       26
       -
       is enabled (<option>services.openssh.enable = true</option>). UDP

     

       26
       26
       +
       is enabled (<option><xref linkend="opt-services.openssh.enable"/> = true</option>). UDP

     

       27
       27
        
       ports can be opened through

     

       28
       28
       -
       <option>networking.firewall.allowedUDPPorts</option>.</para>

     

       28
       28
       +
       <xref linkend="opt-networking.firewall.allowedUDPPorts"/>.</para>

     

       29
       29
        
       

     

       30
       30
        
       <para>To open ranges of TCP ports:

     

       31
       31
        
       

     

       32
       32
        
       <programlisting>

     

       33
       33
       -
       networking.firewall.allowedTCPPortRanges = [

     

       33
       33
       +
       <xref linkend="opt-networking.firewall.allowedTCPPortRanges"/> = [

     

       34
       34
        
         { from = 4000; to = 4007; }

     

       35
       35
        
         { from = 8000; to = 8010; }

     

       36
       36
        
       ];

     

       37
       37
        
       </programlisting>

     

       38
       38
        
       

     

       39
       39
        
       Similarly, UDP port ranges can be opened through

     

       40
       40
       -
       <option>networking.firewall.allowedUDPPortRanges</option>.</para>

     

       40
       40
       +
       <xref linkend="opt-networking.firewall.allowedUDPPortRanges"/>.</para>

     

       41
       41
        
       

     

       42
       42
        
       <para>Also of interest is

     

       43
       43
        
       

     

       44
       44
        
       <programlisting>

     

       45
       45
       -
       networking.firewall.allowPing = true;

     

       45
       45
       +
       <xref linkend="opt-networking.firewall.allowPing"/> = true;

     

       46
       46
        
       </programlisting>

     

       47
       47
        
       

     

       48
       48
        
       to allow the machine to respond to ping requests.  (ICMPv6 pings are

+8 -5

nixos/doc/manual/configuration/ipv4-config.xml

···

       12
       12
        
       follows:

     

       13
       13
        
       

     

       14
       14
        
       <programlisting>

     

       15
       15
       -
       networking.interfaces.eth0.ipv4.addresses = [ { address = "192.168.1.2"; prefixLength = 24; } ];

     

       15
       15
       +
       <link linkend="opt-networking.interfaces._name__.ipv4.addresses">networking.interfaces.eth0.ipv4.addresses</link> = [ {

     

       16
       16
       +
         address = "192.168.1.2";

     

       17
       17
       +
         prefixLength = 24;

     

       18
       18
       +
       } ];

     

       16
       19
        
       </programlisting>

     

       17
       20
        
       

     

       18
       21
        
       Typically you’ll also want to set a default gateway and set of name

     

       19
       22
        
       servers:

     

       20
       23
        
       

     

       21
       24
        
       <programlisting>

     

       22
       22
       -
       networking.defaultGateway = "192.168.1.1";

     

       23
       23
       -
       networking.nameservers = [ "8.8.8.8" ];

     

       25
       25
       +
       <xref linkend="opt-networking.defaultGateway"/> = "192.168.1.1";

     

       26
       26
       +
       <xref linkend="opt-networking.nameservers"/> = [ "8.8.8.8" ];

     

       24
       27
        
       </programlisting>

     

       25
       28
        
       

     

       26
       29
        
       </para>

     
···

       31
       34
        
       The default gateway and name server configuration is performed by

     

       32
       35
        
       <literal>network-setup.service</literal>.</para></note>

     

       33
       36
        
       

     

       34
       34
       -
       <para>The host name is set using <option>networking.hostName</option>:

     

       37
       37
       +
       <para>The host name is set using <xref linkend="opt-networking.hostName"/>:

     

       35
       38
        
       

     

       36
       39
        
       <programlisting>

     

       37
       37
       -
       networking.hostName = "cartman";

     

       40
       40
       +
       <xref linkend="opt-networking.hostName"/> = "cartman";

     

       38
       41
        
       </programlisting>

     

       39
       42
        
       

     

       40
       43
        
       The default host name is <literal>nixos</literal>.  Set it to the

+7 -4

nixos/doc/manual/configuration/ipv6-config.xml

···

       11
       11
        
       can disable IPv6 support globally by setting:

     

       12
       12
        
       

     

       13
       13
        
       <programlisting>

     

       14
       14
       -
       networking.enableIPv6 = false;

     

       14
       14
       +
       <xref linkend="opt-networking.enableIPv6"/> = false;

     

       15
       15
        
       </programlisting></para>

     

       16
       16
        
       

     

       17
       17
        
       <para>You can disable IPv6 on a single interface using a normal sysctl (in this

     

       18
       18
        
       example, we use interface <varname>eth0</varname>):

     

       19
       19
        
       

     

       20
       20
        
       <programlisting>

     

       21
       21
       -
       boot.kernel.sysctl."net.ipv6.conf.eth0.disable_ipv6" = true;

     

       21
       21
       +
       <xref linkend="opt-boot.kernel.sysctl"/>."net.ipv6.conf.eth0.disable_ipv6" = true;

     

       22
       22
        
       </programlisting>

     

       23
       23
        
       </para>

     

       24
       24
        
       

     
···

       26
       26
        
       DHCPv6. You can configure an interface manually:

     

       27
       27
        
       

     

       28
       28
        
       <programlisting>

     

       29
       29
       -
       networking.interfaces.eth0.ipv6.addresses = [ { address = "fe00:aa:bb:cc::2"; prefixLength = 64; } ];

     

       29
       29
       +
       <link linkend="opt-networking.interfaces._name__.ipv6.addresses">networking.interfaces.eth0.ipv6.addresses</link> = [ {

     

       30
       30
       +
         address = "fe00:aa:bb:cc::2";

     

       31
       31
       +
         prefixLength = 64;

     

       32
       32
       +
       } ];

     

       30
       33
        
       </programlisting>

     

       31
       34
        
       </para>

     

       32
       35
        
       

     

       33
       36
        
       <para>For configuring a gateway, optionally with explicitly specified interface:

     

       34
       37
        
       

     

       35
       38
        
       <programlisting>

     

       36
       36
       -
       networking.defaultGateway6 = {

     

       39
       39
       +
       <xref linkend="opt-networking.defaultGateway6"/> = {

     

       37
       40
        
         address = "fe00::1";

     

       38
       41
        
         interface = "enp0s3";

     

       39
       42
        
       }

+7 -7

nixos/doc/manual/configuration/linux-kernel.xml

···

       10
       10
        
       the option <option>boot.kernelPackages</option>.  For instance, this

     

       11
       11
        
       selects the Linux 3.10 kernel:

     

       12
       12
        
       <programlisting>

     

       13
       13
       -
       boot.kernelPackages = pkgs.linuxPackages_3_10;

     

       13
       13
       +
       <xref linkend="opt-boot.kernelPackages"/> = pkgs.linuxPackages_3_10;

     

       14
       14
        
       </programlisting>

     

       15
       15
        
       Note that this not only replaces the kernel, but also packages that

     

       16
       16
        
       are specific to the kernel version, such as the NVIDIA video drivers.

     
···

       45
       45
        
       

     

       46
       46
        
       <para>Kernel modules for hardware devices are generally loaded

     

       47
       47
        
       automatically by <command>udev</command>.  You can force a module to

     

       48
       48
       -
       be loaded via <option>boot.kernelModules</option>, e.g.

     

       48
       48
       +
       be loaded via <xref linkend="opt-boot.kernelModules"/>, e.g.

     

       49
       49
        
       <programlisting>

     

       50
       50
       -
       boot.kernelModules = [ "fuse" "kvm-intel" "coretemp" ];

     

       50
       50
       +
       <xref linkend="opt-boot.kernelModules"/> = [ "fuse" "kvm-intel" "coretemp" ];

     

       51
       51
        
       </programlisting>

     

       52
       52
        
       If the module is required early during the boot (e.g. to mount the

     

       53
       53
        
       root file system), you can use

     

       54
       54
       -
       <option>boot.initrd.extraKernelModules</option>:

     

       54
       54
       +
       <xref linkend="opt-boot.initrd.extraKernelModules"/>:

     

       55
       55
        
       <programlisting>

     

       56
       56
       -
       boot.initrd.extraKernelModules = [ "cifs" ];

     

       56
       56
       +
       <xref linkend="opt-boot.initrd.extraKernelModules"/> = [ "cifs" ];

     

       57
       57
        
       </programlisting>

     

       58
       58
        
       This causes the specified modules and their dependencies to be added

     

       59
       59
        
       to the initial ramdisk.</para>

     

       60
       60
        
       

     

       61
       61
        
       <para>Kernel runtime parameters can be set through

     

       62
       62
       -
       <option>boot.kernel.sysctl</option>, e.g.

     

       62
       62
       +
       <xref linkend="opt-boot.kernel.sysctl"/>, e.g.

     

       63
       63
        
       <programlisting>

     

       64
       64
       -
       boot.kernel.sysctl."net.ipv4.tcp_keepalive_time" = 120;

     

       64
       64
       +
       <xref linkend="opt-boot.kernel.sysctl"/>."net.ipv4.tcp_keepalive_time" = 120;

     

       65
       65
        
       </programlisting>

     

       66
       66
        
       sets the kernel’s TCP keepalive time to 120 seconds.  To see the

     

       67
       67
        
       available parameters, run <command>sysctl -a</command>.</para>

+3 -3

nixos/doc/manual/configuration/luks-file-systems.xml

···

       33
       33
        
       <filename>configuration.nix</filename>:

     

       34
       34
        
       

     

       35
       35
        
       <programlisting>

     

       36
       36
       -
       boot.initrd.luks.devices.crypted.device = "/dev/disk/by-uuid/3f6b0024-3a44-4fde-a43a-767b872abe5d";

     

       37
       37
       -
       fileSystems."/".device = "/dev/mapper/crypted";

     

       36
       36
       +
       <link linkend="opt-boot.initrd.luks.devices._name__.device">boot.initrd.luks.devices.crypted.device</link> = "/dev/disk/by-uuid/3f6b0024-3a44-4fde-a43a-767b872abe5d";

     

       37
       37
       +
       <xref linkend="opt-fileSystems"/>."/".device = "/dev/mapper/crypted";

     

       38
       38
        
       </programlisting>

     

       39
       39
        
       

     

       40
       40
        
       Should grub be used as bootloader, and <filename>/boot</filename> is located

     

       41
       41
        
       on an encrypted partition, it is necessary to add the following grub option:

     

       42
       42
       -
       <programlisting>boot.loader.grub.enableCryptodisk = true;</programlisting>

     

       42
       42
       +
       <programlisting><xref linkend="opt-boot.loader.grub.enableCryptodisk"/> = true;</programlisting>

     

       43
       43
        
       

     

       44
       44
        
       </para>

     

       45
       45

+18 -18

nixos/doc/manual/configuration/modularity.xml

···

       22
       22
        
       { config, pkgs, ... }:

     

       23
       23
        
       

     

       24
       24
        
       { imports = [ ./vpn.nix ./kde.nix ];

     

       25
       25
       -
         services.httpd.enable = true;

     

       26
       26
       -
         environment.systemPackages = [ pkgs.emacs ];

     

       25
       25
       +
         <xref linkend="opt-services.httpd.enable"/> = true;

     

       26
       26
       +
         <xref linkend="opt-environment.systemPackages"/> = [ pkgs.emacs ];

     

       27
       27
        
         <replaceable>...</replaceable>

     

       28
       28
        
       }

     

       29
       29
        
       </programlisting>

     
···

       35
       35
        
       <programlisting>

     

       36
       36
        
       { config, pkgs, ... }:

     

       37
       37
        
       

     

       38
       38
       -
       { services.xserver.enable = true;

     

       39
       39
       -
         services.xserver.displayManager.sddm.enable = true;

     

       40
       40
       -
         services.xserver.desktopManager.plasma5.enable = true;

     

       38
       38
       +
       { <xref linkend="opt-services.xserver.enable"/> = true;

     

       39
       39
       +
         <xref linkend="opt-services.xserver.displayManager.sddm.enable"/> = true;

     

       40
       40
       +
         <xref linkend="opt-services.xserver.desktopManager.plasma5.enable"/> = true;

     

       41
       41
        
       }

     

       42
       42
        
       </programlisting>

     

       43
       43
        
       

     

       44
       44
        
       Note that both <filename>configuration.nix</filename> and

     

       45
       45
        
       <filename>kde.nix</filename> define the option

     

       46
       46
       -
       <option>environment.systemPackages</option>.  When multiple modules

     

       46
       46
       +
       <xref linkend="opt-environment.systemPackages"/>.  When multiple modules

     

       47
       47
        
       define an option, NixOS will try to <emphasis>merge</emphasis> the

     

       48
       48
        
       definitions.  In the case of

     

       49
       49
       -
       <option>environment.systemPackages</option>, that’s easy: the lists of

     

       49
       49
       +
       <xref linkend="opt-environment.systemPackages"/>, that’s easy: the lists of

     

       50
       50
        
       packages can simply be concatenated.  The value in

     

       51
       51
        
       <filename>configuration.nix</filename> is merged last, so for

     

       52
       52
        
       list-type options, it will appear at the end of the merged list. If

     

       53
       53
        
       you want it to appear first, you can use <varname>mkBefore</varname>:

     

       54
       54
        
       

     

       55
       55
        
       <programlisting>

     

       56
       56
       -
       boot.kernelModules = mkBefore [ "kvm-intel" ];

     

       56
       56
       +
       <xref linkend="opt-boot.kernelModules"/> = mkBefore [ "kvm-intel" ];

     

       57
       57
        
       </programlisting>

     

       58
       58
        
       

     

       59
       59
        
       This causes the <literal>kvm-intel</literal> kernel module to be

     
···

       61
       61
        
       

     

       62
       62
        
       <para>For other types of options, a merge may not be possible. For

     

       63
       63
        
       instance, if two modules define

     

       64
       64
       -
       <option>services.httpd.adminAddr</option>,

     

       64
       64
       +
       <xref linkend="opt-services.httpd.adminAddr"/>,

     

       65
       65
        
       <command>nixos-rebuild</command> will give an error:

     

       66
       66
        
       

     

       67
       67
        
       <screen>

     
···

       72
       72
        
       precedence over the others:

     

       73
       73
        
       

     

       74
       74
        
       <programlisting>

     

       75
       75
       -
       services.httpd.adminAddr = pkgs.lib.mkForce "bob@example.org";

     

       75
       75
       +
       <xref linkend="opt-services.httpd.adminAddr"/> = pkgs.lib.mkForce "bob@example.org";

     

       76
       76
        
       </programlisting>

     

       77
       77
        
       

     

       78
       78
        
       </para>

     
···

       89
       89
        
       is a “lazy” language — it only computes values when they are needed.

     

       90
       90
        
       This works as long as no individual configuration value depends on

     

       91
       91
        
       itself.</para></footnote>.  For example, here is a module that adds

     

       92
       92
       -
       some packages to <option>environment.systemPackages</option> only if

     

       93
       93
       -
       <option>services.xserver.enable</option> is set to

     

       92
       92
       +
       some packages to <xref linkend="opt-environment.systemPackages"/> only if

     

       93
       93
       +
       <xref linkend="opt-services.xserver.enable"/> is set to

     

       94
       94
        
       <literal>true</literal> somewhere else:

     

       95
       95
        
       

     

       96
       96
        
       <programlisting>

     

       97
       97
        
       { config, pkgs, ... }:

     

       98
       98
        
       

     

       99
       99
       -
       { environment.systemPackages =

     

       100
       100
       -
           if config.services.xserver.enable then

     

       99
       99
       +
       { <xref linkend="opt-environment.systemPackages"/> =

     

       100
       100
       +
           if config.<xref linkend="opt-services.xserver.enable"/> then

     

       101
       101
        
             [ pkgs.firefox

     

       102
       102
        
               pkgs.thunderbird

     

       103
       103
        
             ]

     
···

       113
       113
        
       <option>nixos-option</option> allows you to find out:

     

       114
       114
        
       

     

       115
       115
        
       <screen>

     

       116
       116
       -
       $ nixos-option services.xserver.enable

     

       116
       116
       +
       $ nixos-option <xref linkend="opt-services.xserver.enable"/>

     

       117
       117
        
       true

     

       118
       118
        
       

     

       119
       119
       -
       $ nixos-option boot.kernelModules

     

       119
       119
       +
       $ nixos-option <xref linkend="opt-boot.kernelModules"/>

     

       120
       120
        
       [ "tun" "ipv6" "loop" <replaceable>...</replaceable> ]

     

       121
       121
        
       </screen>

     

       122
       122
        
       

     
···

       130
       130
        
       <screen>

     

       131
       131
        
       $ nix-repl '&lt;nixpkgs/nixos>'

     

       132
       132
        
       

     

       133
       133
       -
       nix-repl> config.networking.hostName

     

       133
       133
       +
       nix-repl> config.<xref linkend="opt-networking.hostName"/>

     

       134
       134
        
       "mandark"

     

       135
       135
        
       

     

       136
       136
       -
       nix-repl> map (x: x.hostName) config.services.httpd.virtualHosts

     

       136
       136
       +
       nix-repl> map (x: x.hostName) config.<xref linkend="opt-services.httpd.virtualHosts"/>

     

       137
       137
        
       [ "example.org" "example.gov" ]

     

       138
       138
        
       </screen>

     

       139
       139

+2 -2

nixos/doc/manual/configuration/network-manager.xml

···

       10
       10
        
       use NetworkManager. You can enable NetworkManager by setting:

     

       11
       11
        
       

     

       12
       12
        
       <programlisting>

     

       13
       13
       -
       networking.networkmanager.enable = true;

     

       13
       13
       +
       <xref linkend="opt-networking.networkmanager.enable"/> = true;

     

       14
       14
        
       </programlisting>

     

       15
       15
        
       

     

       16
       16
        
       some desktop managers (e.g., GNOME) enable NetworkManager

     
···

       20
       20
        
       belong to the <code>networkmanager</code> group:

     

       21
       21
        
       

     

       22
       22
        
       <programlisting>

     

       23
       23
       -
       users.extraUsers.youruser.extraGroups = [ "networkmanager" ];

     

       23
       23
       +
       <link linkend="opt-users.users._name__.extraGroups">users.extraUsers.youruser.extraGroups</link> = [ "networkmanager" ];

     

       24
       24
        
       </programlisting>

     

       25
       25
        
       </para>

     

       26
       26

+3 -3

nixos/doc/manual/configuration/ssh.xml

···

       10
       10
        
       setting:

     

       11
       11
        
       

     

       12
       12
        
       <programlisting>

     

       13
       13
       -
       services.openssh.enable = true;

     

       13
       13
       +
       <xref linkend="opt-services.openssh.enable"/> = true;

     

       14
       14
        
       </programlisting>

     

       15
       15
        
       

     

       16
       16
        
       By default, root logins using a password are disallowed.  They can be

     

       17
       17
        
       disabled entirely by setting

     

       18
       18
       -
       <literal>services.openssh.permitRootLogin</literal> to

     

       18
       18
       +
       <xref linkend="opt-services.openssh.permitRootLogin"/> to

     

       19
       19
        
       <literal>"no"</literal>.</para>

     

       20
       20
        
       

     

       21
       21
        
       <para>You can declaratively specify authorised RSA/DSA public keys for

     
···

       23
       23
        
       

     

       24
       24
        
       <!-- FIXME: this might not work if the user is unmanaged. -->

     

       25
       25
        
       <programlisting>

     

       26
       26
       -
       users.extraUsers.alice.openssh.authorizedKeys.keys =

     

       26
       26
       +
       <link linkend="opt-users.users._name__.openssh.authorizedKeys.keys">users.extraUsers.alice.openssh.authorizedKeys.keys</link> =

     

       27
       27
        
         [ "ssh-dss AAAAB3NzaC1kc3MAAACBAPIkGWVEt4..." ];

     

       28
       28
        
       </programlisting>

     

       29
       29

+14 -14

nixos/doc/manual/configuration/user-mgmt.xml

···

       12
       12
        
       states that a user account named <literal>alice</literal> shall exist:

     

       13
       13
        
       

     

       14
       14
        
       <programlisting>

     

       15
       15
       -
       users.users.alice =

     

       16
       16
       -
         { isNormalUser = true;

     

       17
       17
       -
           home = "/home/alice";

     

       18
       18
       -
           description = "Alice Foobar";

     

       19
       19
       -
           extraGroups = [ "wheel" "networkmanager" ];

     

       20
       20
       -
           openssh.authorizedKeys.keys = [ "ssh-dss AAAAB3Nza... alice@foobar" ];

     

       21
       21
       -
         };

     

       15
       15
       +
       <xref linkend="opt-users.users"/>.alice = {

     

       16
       16
       +
         <link linkend="opt-users.users._name__.isNormalUser">isNormalUser</link> = true;

     

       17
       17
       +
         <link linkend="opt-users.users._name__.home">home</link> = "/home/alice";

     

       18
       18
       +
         <link linkend="opt-users.users._name__.description">description</link> = "Alice Foobar";

     

       19
       19
       +
         <link linkend="opt-users.users._name__.extraGroups">extraGroups</link> = [ "wheel" "networkmanager" ];

     

       20
       20
       +
         <link linkend="opt-users.users._name__.openssh.authorizedKeys.keys">openssh.authorizedKeys.keys</link> = [ "ssh-dss AAAAB3Nza... alice@foobar" ];

     

       21
       21
       +
       };

     

       22
       22
        
       </programlisting>

     

       23
       23
        
       

     

       24
       24
        
       Note that <literal>alice</literal> is a member of the

     
···

       32
       32
        
       to set a password, which is retained across invocations of

     

       33
       33
        
       <command>nixos-rebuild</command>.</para>

     

       34
       34
        
       

     

       35
       35
       -
       <para>If you set users.mutableUsers to false, then the contents of /etc/passwd

     

       36
       36
       -
       and /etc/group will be congruent to your NixOS configuration. For instance,

     

       37
       37
       -
       if you remove a user from users.users and run nixos-rebuild, the user

     

       38
       38
       -
       account will cease to exist. Also, imperative commands for managing users

     

       35
       35
       +
       <para>If you set <xref linkend="opt-users.mutableUsers"/> to false, then the contents of

     

       36
       36
       +
       <literal>/etc/passwd</literal> and <literal>/etc/group</literal> will be congruent to

     

       37
       37
       +
       your NixOS configuration. For instance, if you remove a user from <xref linkend="opt-users.users"/>

     

       38
       38
       +
       and run nixos-rebuild, the user account will cease to exist. Also, imperative commands for managing users

     

       39
       39
        
       and groups, such as useradd, are no longer available. Passwords may still be

     

       40
       40
       -
       assigned by setting the user's <literal>hashedPassword</literal> option. A

     

       41
       41
       -
       hashed password can be generated using <command>mkpasswd -m sha-512</command>

     

       40
       40
       +
       assigned by setting the user's <link linkend="opt-users.users._name__.hashedPassword">hashedPassword</link>

     

       41
       41
       +
       option. A hashed password can be generated using <command>mkpasswd -m sha-512</command>

     

       42
       42
        
       after installing the <literal>mkpasswd</literal> package.</para>

     

       43
       43
        
       

     

       44
       44
        
       <para>A user ID (uid) is assigned automatically.  You can also specify

     
···

       54
       54
        
       group named <literal>students</literal> shall exist:

     

       55
       55
        
       

     

       56
       56
        
       <programlisting>

     

       57
       57
       -
       users.groups.students.gid = 1000;

     

       57
       57
       +
       <xref linkend="opt-users.groups"/>.students.gid = 1000;

     

       58
       58
        
       </programlisting>

     

       59
       59
        
       

     

       60
       60
        
       As with users, the group ID (gid) is optional and will be assigned

+2 -2

nixos/doc/manual/configuration/wireless.xml

···

       15
       15
        
       NixOS will start wpa_supplicant for you if you enable this setting:

     

       16
       16
        
       

     

       17
       17
        
       <programlisting>

     

       18
       18
       -
       networking.wireless.enable = true;

     

       18
       18
       +
       <xref linkend="opt-networking.wireless.enable"/> = true;

     

       19
       19
        
       </programlisting>

     

       20
       20
        
       

     

       21
       21
        
       NixOS lets you specify networks for wpa_supplicant declaratively:

     

       22
       22
        
       <programlisting>

     

       23
       23
       -
       networking.wireless.networks = {

     

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

     

       24
       24
        
         echelon = {

     

       25
       25
        
           psk = "abcdefgh";

     

       26
       26
        
         };

+23 -23

nixos/doc/manual/configuration/x-windows.xml

···

       9
       9
        
       <para>The X Window System (X11) provides the basis of NixOS’ graphical

     

       10
       10
        
       user interface.  It can be enabled as follows:

     

       11
       11
        
       <programlisting>

     

       12
       12
       -
       services.xserver.enable = true;

     

       12
       12
       +
       <xref linkend="opt-services.xserver.enable"/> = true;

     

       13
       13
        
       </programlisting>

     

       14
       14
        
       The X server will automatically detect and use the appropriate video

     

       15
       15
        
       driver from a set of X.org drivers (such as <literal>vesa</literal>

     

       16
       16
        
       and <literal>intel</literal>).  You can also specify a driver

     

       17
       17
        
       manually, e.g.

     

       18
       18
        
       <programlisting>

     

       19
       19
       -
       services.xserver.videoDrivers = [ "r128" ];

     

       19
       19
       +
       <xref linkend="opt-services.xserver.videoDrivers"/> = [ "r128" ];

     

       20
       20
        
       </programlisting>

     

       21
       21
        
       to enable X.org’s <literal>xf86-video-r128</literal> driver.</para>

     

       22
       22
        
       

     
···

       25
       25
        
       <command>xterm</command> window.  Thus you should pick one or more of

     

       26
       26
        
       the following lines:

     

       27
       27
        
       <programlisting>

     

       28
       28
       -
       services.xserver.desktopManager.plasma5.enable = true;

     

       29
       29
       -
       services.xserver.desktopManager.xfce.enable = true;

     

       30
       30
       -
       services.xserver.desktopManager.gnome3.enable = true;

     

       31
       31
       -
       services.xserver.windowManager.xmonad.enable = true;

     

       32
       32
       -
       services.xserver.windowManager.twm.enable = true;

     

       33
       33
       -
       services.xserver.windowManager.icewm.enable = true;

     

       34
       34
       -
       services.xserver.windowManager.i3.enable = true;

     

       28
       28
       +
       <xref linkend="opt-services.xserver.desktopManager.plasma5.enable"/> = true;

     

       29
       29
       +
       <xref linkend="opt-services.xserver.desktopManager.xfce.enable"/> = true;

     

       30
       30
       +
       <xref linkend="opt-services.xserver.desktopManager.gnome3.enable"/> = true;

     

       31
       31
       +
       <xref linkend="opt-services.xserver.windowManager.xmonad.enable"/> = true;

     

       32
       32
       +
       <xref linkend="opt-services.xserver.windowManager.twm.enable"/> = true;

     

       33
       33
       +
       <xref linkend="opt-services.xserver.windowManager.icewm.enable"/> = true;

     

       34
       34
       +
       <xref linkend="opt-services.xserver.windowManager.i3.enable"/> = true;

     

       35
       35
        
       </programlisting>

     

       36
       36
        
       </para>

     

       37
       37
        
       

     
···

       40
       40
        
       server) is SLiM. You can select an alternative one by picking one

     

       41
       41
        
       of the following lines:

     

       42
       42
        
       <programlisting>

     

       43
       43
       -
       services.xserver.displayManager.sddm.enable = true;

     

       44
       44
       -
       services.xserver.displayManager.lightdm.enable = true;

     

       43
       43
       +
       <xref linkend="opt-services.xserver.displayManager.sddm.enable"/> = true;

     

       44
       44
       +
       <xref linkend="opt-services.xserver.displayManager.lightdm.enable"/> = true;

     

       45
       45
        
       </programlisting>

     

       46
       46
        
       </para>

     

       47
       47
        
       

     

       48
       48
        
       <para>You can set the keyboard layout (and optionally the layout variant):

     

       49
       49
        
       <programlisting>

     

       50
       50
       -
       services.xserver.layout = "de";

     

       51
       51
       -
       services.xserver.xkbVariant = "neo";

     

       50
       50
       +
       <xref linkend="opt-services.xserver.layout"/> = "de";

     

       51
       51
       +
       <xref linkend="opt-services.xserver.xkbVariant"/> = "neo";

     

       52
       52
        
       </programlisting>

     

       53
       53
        
       </para>

     

       54
       54
        
       

     

       55
       55
        
       <para>The X server is started automatically at boot time.  If you

     

       56
       56
        
       don’t want this to happen, you can set:

     

       57
       57
        
       <programlisting>

     

       58
       58
       -
       services.xserver.autorun = false;

     

       58
       58
       +
       <xref linkend="opt-services.xserver.autorun"/> = false;

     

       59
       59
        
       </programlisting>

     

       60
       60
        
       The X server can then be started manually:

     

       61
       61
        
       <screen>

     
···

       70
       70
        
       has better 3D performance than the X.org drivers.  It is not enabled

     

       71
       71
        
       by default because it’s not free software.  You can enable it as follows:

     

       72
       72
        
       <programlisting>

     

       73
       73
       -
       services.xserver.videoDrivers = [ "nvidia" ];

     

       73
       73
       +
       <xref linkend="opt-services.xserver.videoDrivers"/> = [ "nvidia" ];

     

       74
       74
        
       </programlisting>

     

       75
       75
        
       Or if you have an older card, you may have to use one of the legacy drivers:

     

       76
       76
        
       <programlisting>

     

       77
       77
       -
       services.xserver.videoDrivers = [ "nvidiaLegacy340" ];

     

       78
       78
       -
       services.xserver.videoDrivers = [ "nvidiaLegacy304" ];

     

       79
       79
       -
       services.xserver.videoDrivers = [ "nvidiaLegacy173" ];

     

       77
       77
       +
       <xref linkend="opt-services.xserver.videoDrivers"/> = [ "nvidiaLegacy340" ];

     

       78
       78
       +
       <xref linkend="opt-services.xserver.videoDrivers"/> = [ "nvidiaLegacy304" ];

     

       79
       79
       +
       <xref linkend="opt-services.xserver.videoDrivers"/> = [ "nvidiaLegacy173" ];

     

       80
       80
        
       </programlisting>

     

       81
       81
        
       You may need to reboot after enabling this driver to prevent a clash

     

       82
       82
        
       with other kernel modules.</para>

     
···

       84
       84
        
       <para>On 64-bit systems, if you want full acceleration for 32-bit

     

       85
       85
        
       programs such as Wine, you should also set the following:

     

       86
       86
        
       <programlisting>

     

       87
       87
       -
       hardware.opengl.driSupport32Bit = true;

     

       87
       87
       +
       <xref linkend="opt-hardware.opengl.driSupport32Bit"/> = true;

     

       88
       88
        
       </programlisting>

     

       89
       89
        
       </para>

     

       90
       90
        
       

     
···

       96
       96
        
       has better 3D performance than the X.org drivers.  It is not enabled

     

       97
       97
        
       by default because it’s not free software.  You can enable it as follows:

     

       98
       98
        
       <programlisting>

     

       99
       99
       -
       services.xserver.videoDrivers = [ "ati_unfree" ];

     

       99
       99
       +
       <xref linkend="opt-services.xserver.videoDrivers"/> = [ "ati_unfree" ];

     

       100
       100
        
       </programlisting>

     

       101
       101
        
       You will need to reboot after enabling this driver to prevent a clash

     

       102
       102
        
       with other kernel modules.</para>

     
···

       104
       104
        
       <para>On 64-bit systems, if you want full acceleration for 32-bit

     

       105
       105
        
       programs such as Wine, you should also set the following:

     

       106
       106
        
       <programlisting>

     

       107
       107
       -
       hardware.opengl.driSupport32Bit = true;

     

       107
       107
       +
       <xref linkend="opt-hardware.opengl.driSupport32Bit"/> = true;

     

       108
       108
        
       </programlisting>

     

       109
       109
        
       </para>

     

       110
       110
        
       

     
···

       115
       115
        
       <para>Support for Synaptics touchpads (found in many laptops such as

     

       116
       116
        
       the Dell Latitude series) can be enabled as follows:

     

       117
       117
        
       <programlisting>

     

       118
       118
       -
       services.xserver.libinput.enable = true;

     

       118
       118
       +
       <xref linkend="opt-services.xserver.libinput.enable"/> = true;

     

       119
       119
        
       </programlisting>

     

       120
       120
        
       The driver has many options (see <xref linkend="ch-options"/>).  For

     

       121
       121
        
       instance, the following disables tap-to-click behavior:

     

       122
       122
        
       <programlisting>

     

       123
       123
       -
       services.xserver.libinput.tapping = false;

     

       123
       123
       +
       <xref linkend="opt-services.xserver.libinput.tapping"/> = false;

     

       124
       124
        
       </programlisting>

     

       125
       125
        
       Note: the use of <literal>services.xserver.synaptics</literal> is deprecated since NixOS 17.09.

     

       126
       126
        
       </para>

+12 -12

nixos/doc/manual/configuration/xfce.xml

···

       9
       9
        
           <para>

     

       10
       10
        
               To enable the Xfce Desktop Environment, set

     

       11
       11
        
               <programlisting>

     

       12
       12
       -
       services.xserver.desktopManager = {

     

       13
       13
       -
           xfce.enable = true;

     

       14
       14
       -
           default = "xfce";

     

       12
       12
       +
       <link linkend="opt-services.xserver.desktopManager.default">services.xserver.desktopManager</link> = {

     

       13
       13
       +
         <link linkend="opt-services.xserver.desktopManager.xfce.enable">xfce.enable</link> = true;

     

       14
       14
       +
         <link linkend="opt-services.xserver.desktopManager.default">default</link> = "xfce";

     

       15
       15
        
       };

     

       16
       16
        
               </programlisting>

     

       17
       17
        
           </para>

     
···

       20
       20
        
               Optionally, <emphasis>compton</emphasis>

     

       21
       21
        
               can be enabled for nice graphical effects, some example settings:

     

       22
       22
        
               <programlisting>

     

       23
       23
       -
       services.compton = {

     

       24
       24
       -
         enable          = true;

     

       25
       25
       -
         fade            = true;

     

       26
       26
       -
         inactiveOpacity = "0.9";

     

       27
       27
       -
         shadow          = true;

     

       28
       28
       -
         fadeDelta       = 4;

     

       23
       23
       +
       <link linkend="opt-services.compton.enable">services.compton</link> = {

     

       24
       24
       +
         <link linkend="opt-services.compton.enable">enable</link>          = true;

     

       25
       25
       +
         <link linkend="opt-services.compton.fade">fade</link>            = true;

     

       26
       26
       +
         <link linkend="opt-services.compton.inactiveOpacity">inactiveOpacity</link> = "0.9";

     

       27
       27
       +
         <link linkend="opt-services.compton.shadow">shadow</link>          = true;

     

       28
       28
       +
         <link linkend="opt-services.compton.fadeDelta">fadeDelta</link>       = 4;

     

       29
       29
        
       };

     

       30
       30
        
               </programlisting>

     

       31
       31
        
           </para>

     
···

       33
       33
        
           <para>

     

       34
       34
        
               Some Xfce programs are not installed automatically.

     

       35
       35
        
               To install them manually (system wide), put them into your

     

       36
       36
       -
               <literal>environment.systemPackages</literal>.

     

       36
       36
       +
               <xref linkend="opt-environment.systemPackages"/>.

     

       37
       37
        
           </para>

     

       38
       38
       -
                

     

       38
       38
       +
       

     

       39
       39
        
           <simplesect>

     

       40
       40
        
               <title>Thunar Volume Support</title>

     

       41
       41
        
       

     
···

       44
       44
        
                   <emphasis>Thunar</emphasis>

     

       45
       45
        
                   volume support, put

     

       46
       46
        
                   <programlisting>

     

       47
       47
       -
       services.xserver.desktopManager.xfce.enable = true;

     

       47
       47
       +
       <xref linkend="opt-services.xserver.desktopManager.xfce.enable"/> = true;

     

       48
       48
        
                   </programlisting>

     

       49
       49
        
                   into your <emphasis>configuration.nix</emphasis>.

     

       50
       50
        
               </para>

+1 -1

nixos/doc/manual/installation/changing-config.xml

···

       75
       75
        
       temporarily add the following to your configuration:

     

       76
       76
        
       

     

       77
       77
        
       <screen>

     

       78
       78
       -
       users.extraUsers.your-user.initialPassword = "test"  

     

       78
       78
       +
       <link linkend="opt-users.users._name__.initialHashedPassword">users.extraUsers.your-user.initialHashedPassword</link> = "test";

     

       79
       79
        
       </screen>

     

       80
       80
        
       

     

       81
       81
        
       <emphasis>Important:</emphasis> delete the $hostname.qcow2 file if you

+8 -4

nixos/doc/manual/installation/installing-from-other-distro.xml

···

       111
       111
        
                       <literal>configuration.nix</literal>:</para>

     

       112
       112
        
       

     

       113
       113
        
                   <programlisting>

     

       114
       114
       -
       boot.loader.grub.extraEntries = ''

     

       114
       114
       +
       <xref linkend="opt-boot.loader.grub.extraEntries"/> = ''

     

       115
       115
        
         menuentry "Ubuntu" {

     

       116
       116
        
           search --set=ubuntu --fs-uuid 3cc3e652-0c1f-4800-8451-033754f68e6e

     

       117
       117
        
           configfile "($ubuntu)/boot/grub/grub.cfg"

     
···

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

     

       184
       184
        
                       <literal>sudo</literal>)</para>

     

       185
       185
        
       

     

       186
       186
       -
                   <programlisting>users.extraUsers.root.initialHashedPassword = "";</programlisting>

     

       186
       186
       +
                     <programlisting>

     

       187
       187
       +
       <link linkend="opt-users.users._name__.initialHashedPassword">users.extraUsers.root.initialHashedPassword</link> = "";

     

       188
       188
       +
                     </programlisting>

     

       187
       189
        
               </listitem>

     

       188
       190
        
       

     

       189
       191
        
               <listitem>

     
···

       243
       245
        
       

     

       244
       246
        
                   <screen>

     

       245
       247
        
       $ sudo touch /etc/NIXOS

     

       246
       246
       -
       $ sudo touch /etc/NIXOS_LUSTRATE</screen>

     

       248
       248
       +
       $ sudo touch /etc/NIXOS_LUSTRATE

     

       249
       249
       +
                   </screen>

     

       247
       250
        
       

     

       248
       251
        
                   <para>Let's also make sure the NixOS configuration files are kept

     

       249
       252
        
                       once we reboot on NixOS:</para>

     

       250
       253
        
       

     

       251
       254
        
                   <screen>

     

       252
       252
       -
       $ echo etc/nixos | sudo tee -a /etc/NIXOS_LUSTRATE</screen>

     

       255
       255
       +
       $ echo etc/nixos | sudo tee -a /etc/NIXOS_LUSTRATE

     

       256
       256
       +
                   </screen>

     

       253
       257
        
               </listitem>

     

       254
       258
        
       

     

       255
       259
        
               <listitem>

+2 -2

nixos/doc/manual/installation/installing-virtualbox-guest.xml

···

       42
       42
        
       </para>

     

       43
       43
        
       

     

       44
       44
        
       <programlisting>

     

       45
       45
       -
       boot.loader.grub.device = "/dev/sda";

     

       45
       45
       +
       <xref linkend="opt-boot.loader.grub.device"/> = "/dev/sda";

     

       46
       46
        
       </programlisting>

     

       47
       47
        
       

     

       48
       48
        
       <para>

     
···

       51
       51
        
       </para>

     

       52
       52
        
       

     

       53
       53
        
       <programlisting>

     

       54
       54
       -
       boot.initrd.checkJournalingFS = false;

     

       54
       54
       +
       <xref linkend="opt-boot.initrd.checkJournalingFS"/> = false;

     

       55
       55
        
       </programlisting>

     

       56
       56
        
       

     

       57
       57
        
       <para>

+38 -36

nixos/doc/manual/installation/installing.xml

···

       203
       203
        
           <variablelist>

     

       204
       204
        
       

     

       205
       205
        
             <varlistentry><term>BIOS systems</term>

     

       206
       206
       -
             <listitem><para>You <emphasis>must</emphasis> set the option

     

       207
       207
       -
           <option>boot.loader.grub.device</option> to specify on which disk

     

       208
       208
       -
           the GRUB boot loader is to be installed.  Without it, NixOS cannot

     

       209
       209
       -
             boot.</para></listitem></varlistentry>

     

       206
       206
       +
               <listitem><para>You <emphasis>must</emphasis> set the option

     

       207
       207
       +
                   <xref linkend="opt-boot.loader.grub.device"/> to specify on which disk

     

       208
       208
       +
                   the GRUB boot loader is to be installed.  Without it, NixOS cannot

     

       209
       209
       +
                   boot.</para></listitem></varlistentry>

     

       210
       210
        
       

     

       211
       211
        
             <varlistentry><term>UEFI systems</term>

     

       212
       212
       -
             <listitem><para>You <emphasis>must</emphasis> set the option

     

       213
       213
       -
             <option>boot.loader.systemd-boot.enable</option> to <literal>true</literal>.

     

       214
       214
       -
             <command>nixos-generate-config</command> should do this automatically for new

     

       215
       215
       -
             configurations when booted in

     

       216
       216
       -
             UEFI mode.</para>

     

       217
       217
       -
             <para>You may want to look at the options starting with

     

       218
       218
       -
             <option>boot.loader.efi</option> and <option>boot.loader.systemd-boot</option>

     

       219
       219
       -
             as well.</para></listitem></varlistentry>

     

       212
       212
       +
               <listitem><para>You <emphasis>must</emphasis> set the option

     

       213
       213
       +
                   <xref linkend="opt-boot.loader.systemd-boot.enable"/> to <literal>true</literal>.

     

       214
       214
       +
                   <command>nixos-generate-config</command> should do this automatically for new

     

       215
       215
       +
                   configurations when booted in

     

       216
       216
       +
                   UEFI mode.</para>

     

       217
       217
       +
                 <para>You may want to look at the options starting with

     

       218
       218
       +
                   <option><link linkend="opt-boot.loader.efi.canTouchEfiVariables">boot.loader.efi</link></option> and

     

       219
       219
       +
                   <option><link linkend="opt-boot.loader.systemd-boot.enable">boot.loader.systemd</link></option> as well.

     

       220
       220
       +
                 </para>

     

       221
       221
       +
               </listitem>

     

       222
       222
       +
             </varlistentry>

     

       220
       223
        
       

     

       221
       224
        
           </variablelist>

     

       222
       225
        
       

     

       223
       226
        
           <para>If there are other operating systems running on the machine before

     

       224
       227
        
           installing NixOS, the

     

       225
       225
       -
           <option>boot.loader.grub.useOSProber</option> option can be set to

     

       228
       228
       +
           <xref linkend="opt-boot.loader.grub.useOSProber"/> option can be set to

     

       226
       229
        
           <literal>true</literal> to automatically add them to the grub menu.</para>

     

       227
       230
        
       

     

       228
       231
        
           <para>Another critical option is <option>fileSystems</option>,

     
···

       264
       267
        
           <para>As the last step, <command>nixos-install</command> will ask

     

       265
       268
        
           you to set the password for the <literal>root</literal> user, e.g.

     

       266
       269
        
       

     

       267
       267
       -
       <screen>

     

       270
       270
       +
           <screen>

     

       268
       271
        
       setting root password...

     

       269
       272
        
       Enter new UNIX password: ***

     

       270
       273
        
       Retype new UNIX password: ***

     

       271
       271
       -
       </screen>

     

       274
       274
       +
           </screen>

     

       272
       275
        
       

     

       273
       276
        
           <note>

     

       274
       277
        
             <para>

     

       275
       275
       -
               To prevent the password prompt, set <code>users.mutableUsers = false;</code> in

     

       278
       278
       +
               To prevent the password prompt, set <code><xref linkend="opt-users.mutableUsers"/> = false;</code> in

     

       276
       279
        
               <filename>configuration.nix</filename>, which allows unattended installation

     

       277
       280
        
               necessary in automation.

     

       278
       281
        
             </para>

     
···

       285
       288
        
         <listitem>

     

       286
       289
        
           <para>If everything went well:

     

       287
       290
        
       

     

       288
       288
       -
       <screen>

     

       289
       289
       -
       # reboot</screen>

     

       291
       291
       +
             <screen>

     

       292
       292
       +
               # reboot</screen>

     

       290
       293
        
       

     

       291
       294
        
         </para></listitem>

     

       292
       295
        
       

     

       293
       296
        
         <listitem>

     

       294
       297
        
       

     

       295
       298
        
           <para>You should now be able to boot into the installed NixOS. The

     

       296
       296
       -
           GRUB boot menu shows a list of <emphasis>available

     

       297
       297
       -
           configurations</emphasis> (initially just one). Every time you

     

       298
       298
       -
           change the NixOS configuration (see <link

     

       299
       299
       -
           linkend="sec-changing-config">Changing Configuration</link> ), a

     

       300
       300
       -
           new item is added to the menu. This allows you to easily roll back

     

       301
       301
       -
           to a previous configuration if something goes wrong.</para>

     

       299
       299
       +
             GRUB boot menu shows a list of <emphasis>available

     

       300
       300
       +
               configurations</emphasis> (initially just one). Every time you

     

       301
       301
       +
             change the NixOS configuration (see <link

     

       302
       302
       +
               linkend="sec-changing-config">Changing Configuration</link> ), a

     

       303
       303
       +
             new item is added to the menu. This allows you to easily roll back

     

       304
       304
       +
             to a previous configuration if something goes wrong.</para>

     

       302
       305
        
       

     

       303
       306
        
           <para>You should log in and change the <literal>root</literal>

     

       304
       307
        
           password with <command>passwd</command>.</para>

     
···

       372
       375
        
       </example>

     

       373
       376
        
       

     

       374
       377
        
       <example xml:id='ex-config'><title>NixOS Configuration</title>

     

       375
       375
       -
       <screen>

     

       376
       376
       -
       { config, pkgs, ... }:

     

       378
       378
       +
         <screen>

     

       379
       379
       +
       { config, pkgs, ... }: {

     

       380
       380
       +
         imports = [

     

       381
       381
       +
           # Include the results of the hardware scan.

     

       382
       382
       +
           ./hardware-configuration.nix

     

       383
       383
       +
         ];

     

       377
       384
        
       

     

       378
       378
       -
       {

     

       379
       379
       -
         imports =

     

       380
       380
       -
           [ # Include the results of the hardware scan.

     

       381
       381
       -
             ./hardware-configuration.nix

     

       382
       382
       -
           ];

     

       383
       383
       -
       

     

       384
       384
       -
         boot.loader.grub.device = "/dev/sda";   # <lineannotation>(for BIOS systems only)</lineannotation>

     

       385
       385
       -
         boot.loader.systemd-boot.enable = true; # <lineannotation>(for UEFI systems only)</lineannotation>

     

       385
       385
       +
         <xref linkend="opt-boot.loader.grub.device"/> = "/dev/sda";   # <lineannotation>(for BIOS systems only)</lineannotation>

     

       386
       386
       +
         <xref linkend="opt-boot.loader.systemd-boot.enable"/> = true; # <lineannotation>(for UEFI systems only)</lineannotation>

     

       386
       387
        
       

     

       387
       388
        
         # Note: setting fileSystems is generally not

     

       388
       389
        
         # necessary, since nixos-generate-config figures them out

     

       389
       390
        
         # automatically in hardware-configuration.nix.

     

       390
       390
       -
         #fileSystems."/".device = "/dev/disk/by-label/nixos";

     

       391
       391
       +
         #<link linkend="opt-fileSystems._name__.device">fileSystems."/".device</link> = "/dev/disk/by-label/nixos";

     

       391
       392
        
       

     

       392
       393
        
         # Enable the OpenSSH server.

     

       393
       394
        
         services.sshd.enable = true;

     

       394
       394
       -
       }</screen>

     

       395
       395
       +
       }

     

       396
       396
       +
         </screen>

     

       395
       397
        
       </example>

     

       396
       398
        
       

     

       397
       399
        
       <xi:include href="installing-usb.xml" />

+2 -2

nixos/doc/manual/installation/upgrading.xml

···

       119
       119
        
       the following to <filename>configuration.nix</filename>:

     

       120
       120
        
       

     

       121
       121
        
       <programlisting>

     

       122
       122
       -
       system.autoUpgrade.enable = true;

     

       122
       122
       +
       <xref linkend="opt-system.autoUpgrade.enable"/> = true;

     

       123
       123
        
       </programlisting>

     

       124
       124
        
       

     

       125
       125
        
       This enables a periodically executed systemd service named

     
···

       130
       130
        
       specify a channel explicitly, e.g.

     

       131
       131
        
       

     

       132
       132
        
       <programlisting>

     

       133
       133
       -
       system.autoUpgrade.channel = https://nixos.org/channels/nixos-17.03;

     

       133
       133
       +
       <xref linkend="opt-system.autoUpgrade.channel"/> = https://nixos.org/channels/nixos-17.03;

     

       134
       134
        
       </programlisting>

     

       135
       135
        
       

     

       136
       136
        
       </para>

+39 -39

nixos/modules/i18n/input-method/default.xml

···

       6
       6
        
       

     

       7
       7
        
       <title>Input Methods</title>

     

       8
       8
        
       

     

       9
       9
       -
       <para>Input methods are an operating system component that allows any data, such 

     

       10
       10
       -
         as keyboard strokes or mouse movements, to be received as input. In this way 

     

       11
       11
       -
         users can enter characters and symbols not found on their input devices. Using 

     

       12
       12
       -
         an input method is obligatory for any language that has more graphemes than 

     

       9
       9
       +
       <para>Input methods are an operating system component that allows any data, such

     

       10
       10
       +
         as keyboard strokes or mouse movements, to be received as input. In this way

     

       11
       11
       +
         users can enter characters and symbols not found on their input devices. Using

     

       12
       12
       +
         an input method is obligatory for any language that has more graphemes than

     

       13
       13
        
         there are keys on the keyboard.</para>

     

       14
       14
        
       

     

       15
       15
        
       <para>The following input methods are available in NixOS:</para>

     

       16
       16
        
       

     

       17
       17
        
       <itemizedlist>

     

       18
       18
        
         <listitem><para>IBus: The intelligent input bus.</para></listitem>

     

       19
       19
       -
         <listitem><para>Fcitx: A customizable lightweight input 

     

       19
       19
       +
         <listitem><para>Fcitx: A customizable lightweight input

     

       20
       20
        
             method.</para></listitem>

     

       21
       21
        
         <listitem><para>Nabi: A Korean input method based on XIM.</para></listitem>

     

       22
       22
       -
         <listitem><para>Uim: The universal input method, is a library with a XIM 

     

       22
       22
       +
         <listitem><para>Uim: The universal input method, is a library with a XIM

     

       23
       23
        
             bridge.</para></listitem>

     

       24
       24
        
       </itemizedlist>

     

       25
       25
        
       

     

       26
       26
        
       <section><title>IBus</title>

     

       27
       27
        
       

     

       28
       28
       -
       <para>IBus is an Intelligent Input Bus. It provides full featured and user 

     

       28
       28
       +
       <para>IBus is an Intelligent Input Bus. It provides full featured and user

     

       29
       29
        
         friendly input method user interface.</para>

     

       30
       30
        
       

     

       31
       31
        
       <para>The following snippet can be used to configure IBus:</para>

     

       32
       32
        
       

     

       33
       33
        
       <programlisting>

     

       34
       34
        
       i18n.inputMethod = {

     

       35
       35
       -
         enabled = "ibus";

     

       36
       36
       -
         ibus.engines = with pkgs.ibus-engines; [ anthy hangul mozc ];

     

       35
       35
       +
         <link linkend="opt-i18n.inputMethod.enabled">enabled</link> = "ibus";

     

       36
       36
       +
         <link linkend="opt-i18n.inputMethod.ibus.engines">ibus.engines</link> = with pkgs.ibus-engines; [ anthy hangul mozc ];

     

       37
       37
        
       };

     

       38
       38
        
       </programlisting>

     

       39
       39
        
       

     

       40
       40
       -
       <para><literal>i18n.inputMethod.ibus.engines</literal> is optional and can be 

     

       40
       40
       +
       <para><literal>i18n.inputMethod.ibus.engines</literal> is optional and can be

     

       41
       41
        
         used to add extra IBus engines.</para>

     

       42
       42
        
       

     

       43
       43
        
       <para>Available extra IBus engines are:</para>

     

       44
       44
        
       

     

       45
       45
        
       <itemizedlist>

     

       46
       46
       -
         <listitem><para>Anthy (<literal>ibus-engines.anthy</literal>): Anthy is a 

     

       47
       47
       -
             system for Japanese input method. It converts Hiragana text to Kana Kanji 

     

       46
       46
       +
         <listitem><para>Anthy (<literal>ibus-engines.anthy</literal>): Anthy is a

     

       47
       47
       +
             system for Japanese input method. It converts Hiragana text to Kana Kanji

     

       48
       48
        
             mixed text.</para></listitem>

     

       49
       49
       -
         <listitem><para>Hangul (<literal>ibus-engines.hangul</literal>): Korean input 

     

       49
       49
       +
         <listitem><para>Hangul (<literal>ibus-engines.hangul</literal>): Korean input

     

       50
       50
        
             method.</para></listitem>

     

       51
       51
       -
         <listitem><para>m17n (<literal>ibus-engines.m17n</literal>): m17n is an input 

     

       52
       52
       -
             method that uses input methods and corresponding icons in the m17n 

     

       51
       51
       +
         <listitem><para>m17n (<literal>ibus-engines.m17n</literal>): m17n is an input

     

       52
       52
       +
             method that uses input methods and corresponding icons in the m17n

     

       53
       53
        
             database.</para></listitem>

     

       54
       54
       -
         <listitem><para>mozc (<literal>ibus-engines.mozc</literal>): A Japanese input 

     

       54
       54
       +
         <listitem><para>mozc (<literal>ibus-engines.mozc</literal>): A Japanese input

     

       55
       55
        
             method from Google.</para></listitem>

     

       56
       56
       -
         <listitem><para>Table (<literal>ibus-engines.table</literal>): An input method 

     

       56
       56
       +
         <listitem><para>Table (<literal>ibus-engines.table</literal>): An input method

     

       57
       57
        
             that load tables of input methods.</para></listitem>

     

       58
       58
       -
         <listitem><para>table-others (<literal>ibus-engines.table-others</literal>): 

     

       58
       58
       +
         <listitem><para>table-others (<literal>ibus-engines.table-others</literal>):

     

       59
       59
        
             Various table-based input methods. To use this, and any other table-based

     

       60
       60
        
             input methods, it must appear in the list of engines along with

     

       61
       61
        
             <literal>table</literal>. For example:

     
···

       72
       72
        
       

     

       73
       73
        
       <section><title>Fcitx</title>

     

       74
       74
        
       

     

       75
       75
       -
       <para>Fcitx is an input method framework with extension support. It has three 

     

       76
       76
       -
         built-in Input Method Engine, Pinyin, QuWei and Table-based input 

     

       75
       75
       +
       <para>Fcitx is an input method framework with extension support. It has three

     

       76
       76
       +
         built-in Input Method Engine, Pinyin, QuWei and Table-based input

     

       77
       77
        
         methods.</para>

     

       78
       78
        
       <para>The following snippet can be used to configure Fcitx:</para>

     

       79
       79
        
       

     

       80
       80
        
       <programlisting>

     

       81
       81
        
       i18n.inputMethod = {

     

       82
       82
       -
         enabled = "fcitx";

     

       83
       83
       -
         fcitx.engines = with pkgs.fcitx-engines; [ mozc hangul m17n ];

     

       82
       82
       +
         <link linkend="opt-i18n.inputMethod.enabled">enabled</link> = "fcitx";

     

       83
       83
       +
         <link linkend="opt-i18n.inputMethod.fcitx.engines">fcitx.engines</link> = with pkgs.fcitx-engines; [ mozc hangul m17n ];

     

       84
       84
        
       };

     

       85
       85
        
       </programlisting>

     

       86
       86
        
       

     

       87
       87
       -
       <para><literal>i18n.inputMethod.fcitx.engines</literal> is optional and can be 

     

       87
       87
       +
       <para><literal>i18n.inputMethod.fcitx.engines</literal> is optional and can be

     

       88
       88
        
         used to add extra Fcitx engines.</para>

     

       89
       89
        
       

     

       90
       90
        
       <para>Available extra Fcitx engines are:</para>

     

       91
       91
        
       

     

       92
       92
        
       <itemizedlist>

     

       93
       93
       -
         <listitem><para>Anthy (<literal>fcitx-engines.anthy</literal>): Anthy is a 

     

       94
       94
       -
             system for Japanese input method. It converts Hiragana text to Kana Kanji 

     

       93
       93
       +
         <listitem><para>Anthy (<literal>fcitx-engines.anthy</literal>): Anthy is a

     

       94
       94
       +
             system for Japanese input method. It converts Hiragana text to Kana Kanji

     

       95
       95
        
             mixed text.</para></listitem>

     

       96
       96
       -
         <listitem><para>Chewing (<literal>fcitx-engines.chewing</literal>): Chewing is 

     

       97
       97
       -
             an intelligent Zhuyin input method. It is one of the most popular input 

     

       96
       96
       +
         <listitem><para>Chewing (<literal>fcitx-engines.chewing</literal>): Chewing is

     

       97
       97
       +
             an intelligent Zhuyin input method. It is one of the most popular input

     

       98
       98
        
             methods among Traditional Chinese Unix users.</para></listitem>

     

       99
       99
       -
         <listitem><para>Hangul (<literal>fcitx-engines.hangul</literal>): Korean input 

     

       99
       99
       +
         <listitem><para>Hangul (<literal>fcitx-engines.hangul</literal>): Korean input

     

       100
       100
        
             method.</para></listitem>

     

       101
       101
       -
         <listitem><para>Unikey (<literal>fcitx-engines.unikey</literal>): Vietnamese input 

     

       101
       101
       +
         <listitem><para>Unikey (<literal>fcitx-engines.unikey</literal>): Vietnamese input

     

       102
       102
        
             method.</para></listitem>

     

       103
       103
       -
         <listitem><para>m17n (<literal>fcitx-engines.m17n</literal>): m17n is an input 

     

       104
       104
       -
             method that uses input methods and corresponding icons in the m17n 

     

       103
       103
       +
         <listitem><para>m17n (<literal>fcitx-engines.m17n</literal>): m17n is an input

     

       104
       104
       +
             method that uses input methods and corresponding icons in the m17n

     

       105
       105
        
             database.</para></listitem>

     

       106
       106
       -
         <listitem><para>mozc (<literal>fcitx-engines.mozc</literal>): A Japanese input 

     

       106
       106
       +
         <listitem><para>mozc (<literal>fcitx-engines.mozc</literal>): A Japanese input

     

       107
       107
        
             method from Google.</para></listitem>

     

       108
       108
       -
         <listitem><para>table-others (<literal>fcitx-engines.table-others</literal>): 

     

       108
       108
       +
         <listitem><para>table-others (<literal>fcitx-engines.table-others</literal>):

     

       109
       109
        
             Various table-based input methods.</para></listitem>

     

       110
       110
        
       </itemizedlist>

     

       111
       111
        
       </section>

     

       112
       112
        
       

     

       113
       113
        
       <section><title>Nabi</title>

     

       114
       114
        
       

     

       115
       115
       -
       <para>Nabi is an easy to use Korean X input method. It allows you to enter 

     

       116
       116
       -
         phonetic Korean characters (hangul) and pictographic Korean characters 

     

       115
       115
       +
       <para>Nabi is an easy to use Korean X input method. It allows you to enter

     

       116
       116
       +
         phonetic Korean characters (hangul) and pictographic Korean characters

     

       117
       117
        
         (hanja).</para>

     

       118
       118
        
       <para>The following snippet can be used to configure Nabi:</para>

     

       119
       119
        
       

     

       120
       120
        
       <programlisting>

     

       121
       121
        
       i18n.inputMethod = {

     

       122
       122
       -
         enabled = "nabi";

     

       122
       122
       +
         <link linkend="opt-i18n.inputMethod.enabled">enabled</link> = "nabi";

     

       123
       123
        
       };

     

       124
       124
        
       </programlisting>

     

       125
       125
        
       </section>

     

       126
       126
        
       

     

       127
       127
        
       <section><title>Uim</title>

     

       128
       128
        
       

     

       129
       129
       -
       <para>Uim (short for "universal input method") is a multilingual input method 

     

       129
       129
       +
       <para>Uim (short for "universal input method") is a multilingual input method

     

       130
       130
        
         framework. Applications can use it through so-called bridges.</para>

     

       131
       131
        
       <para>The following snippet can be used to configure uim:</para>

     

       132
       132
        
       

     

       133
       133
        
       <programlisting>

     

       134
       134
        
       i18n.inputMethod = {

     

       135
       135
       -
         enabled = "uim";

     

       135
       135
       +
         <link linkend="opt-i18n.inputMethod.enabled">enabled</link> = "uim";

     

       136
       136
        
       };

     

       137
       137
        
       </programlisting>

     

       138
       138
        
       

     

       139
       139
       -
       <para>Note: The <literal>i18n.inputMethod.uim.toolbar</literal> option can be 

     

       139
       139
       +
       <para>Note: The <xref linkend="opt-i18n.inputMethod.uim.toolbar"/> option can be

     

       140
       140
        
         used to choose uim toolbar.</para>

     

       141
       141
        
       

     

       142
       142
        
       </section>

+19 -19

nixos/modules/programs/digitalbitbox/doc.xml

···

       15
       15
        
           installed by setting <literal>programs.digitalbitbox</literal>

     

       16
       16
        
           to <literal>true</literal> in a manner similar to

     

       17
       17
        
       

     

       18
       18
       -
           <programlisting>

     

       19
       19
       -
             programs.digitalbitbox.enable = true;

     

       20
       20
       -
           </programlisting>

     

       18
       18
       +
       <programlisting>

     

       19
       19
       +
       <xref linkend="opt-programs.digitalbitbox.enable"/> = true;

     

       20
       20
       +
       </programlisting>

     

       21
       21
        
       

     

       22
       22
        
           and bundles the <literal>digitalbitbox</literal> package (see <xref

     

       23
       23
        
             linkend="sec-digitalbitbox-package" />), which contains the

     
···

       46
       46
        
             <literal>digitalbitbox</literal> package which could be installed

     

       47
       47
        
             as follows:

     

       48
       48
        
       

     

       49
       49
       -
             <programlisting>

     

       50
       50
       -
               environment.systemPackages = [

     

       51
       51
       -
                 pkgs.digitalbitbox

     

       52
       52
       -
               ];

     

       53
       53
       -
             </programlisting>

     

       49
       49
       +
       <programlisting>

     

       50
       50
       +
       <xref linkend="opt-environment.systemPackages"/> = [

     

       51
       51
       +
         pkgs.digitalbitbox

     

       52
       52
       +
       ];

     

       53
       53
       +
       </programlisting>

     

       54
       54
        
           </para>

     

       55
       55
        
         </section>

     

       56
       56
        
       

     
···

       62
       62
        
             The digitalbitbox hardware package enables the udev rules for

     

       63
       63
        
             Digital Bitbox devices and may be installed as follows:

     

       64
       64
        
       

     

       65
       65
       -
             <programlisting>

     

       66
       66
       -
               hardware.digitalbitbox.enable = true;

     

       67
       67
       -
             </programlisting>

     

       65
       65
       +
       <programlisting>

     

       66
       66
       +
       <xref linkend="opt-hardware.digitalbitbox.enable"/> = true;

     

       67
       67
       +
       </programlisting>

     

       68
       68
        
           </para>

     

       69
       69
        
       

     

       70
       70
        
           <para>

     
···

       72
       72
        
             the <literal>udevRule51</literal> and <literal>udevRule52</literal>

     

       73
       73
        
             attributes by means of overriding as follows:

     

       74
       74
        
       

     

       75
       75
       -
             <programlisting>

     

       76
       76
       -
               programs.digitalbitbox = {

     

       77
       77
       -
                 enable = true;

     

       78
       78
       -
                 package = pkgs.digitalbitbox.override {

     

       79
       79
       -
                   udevRule51 = "something else";

     

       80
       80
       -
                 };

     

       81
       81
       -
               };

     

       82
       82
       -
             </programlisting>

     

       75
       75
       +
       <programlisting>

     

       76
       76
       +
       programs.digitalbitbox = {

     

       77
       77
       +
         <link linkend="opt-programs.digitalbitbox.enable">enable</link> = true;

     

       78
       78
       +
         <link linkend="opt-programs.digitalbitbox.package">package</link> = pkgs.digitalbitbox.override {

     

       79
       79
       +
           udevRule51 = "something else";

     

       80
       80
       +
         };

     

       81
       81
       +
       };

     

       82
       82
       +
       </programlisting>

     

       83
       83
        
           </para>

     

       84
       84
        
         </section>

     

       85
       85
        
       </chapter>

+1 -1

nixos/modules/programs/plotinus.xml

···

       17
       17
        
       <para>To enable Plotinus, add the following to your <filename>configuration.nix</filename>:

     

       18
       18
        
       

     

       19
       19
        
       <programlisting>

     

       20
       20
       -
       programs.plotinus.enable = true;

     

       20
       20
       +
       <xref linkend="opt-programs.plotinus.enable"/> = true;

     

       21
       21
        
       </programlisting>

     

       22
       22
        
       

     

       23
       23
        
       </para>

+11 -11

nixos/modules/security/acme.xml

···

       48
       48
        
       <filename>configuration.nix</filename>:

     

       49
       49
        
       

     

       50
       50
        
       <programlisting>

     

       51
       51
       -
       security.acme.certs."foo.example.com" = {

     

       52
       52
       -
         webroot = "/var/www/challenges";

     

       53
       53
       -
         email = "foo@example.com";

     

       51
       51
       +
       <xref linkend="opt-security.acme.certs"/>."foo.example.com" = {

     

       52
       52
       +
         <link linkend="opt-security.acme.certs._name_.webroot">webroot</link> = "/var/www/challenges";

     

       53
       53
       +
         <link linkend="opt-security.acme.certs._name_.email">email</link> = "foo@example.com";

     

       54
       54
        
       };

     

       55
       55
        
       </programlisting>

     

       56
       56
        
       </para>

     
···

       58
       58
        
       <para>The private key <filename>key.pem</filename> and certificate

     

       59
       59
        
       <filename>fullchain.pem</filename> will be put into

     

       60
       60
        
       <filename>/var/lib/acme/foo.example.com</filename>. The target directory can

     

       61
       61
       -
       be configured with the option <literal>security.acme.directory</literal>.

     

       61
       61
       +
       be configured with the option <xref linkend="opt-security.acme.directory"/>.

     

       62
       62
        
       </para>

     

       63
       63
        
       

     

       64
       64
        
       <para>Refer to <xref linkend="ch-options" /> for all available configuration

     

       65
       65
       -
       options for the <literal>security.acme</literal> module.</para>

     

       65
       65
       +
       options for the <link linkend="opt-security.acme.certs">security.acme</link> module.</para>

     

       66
       66
        
       

     

       67
       67
        
       </section>

     

       68
       68
        
       

     

       69
       69
        
       <section><title>Using ACME certificates in Nginx</title>

     

       70
       70
        
       <para>NixOS supports fetching ACME certificates for you by setting

     

       71
       71
       -
       <literal>enableACME = true;</literal> in a virtualHost config. We

     

       71
       71
       +
         <literal><link linkend="opt-services.nginx.virtualHosts._name_.enableACME">enableACME</link> = true;</literal> in a virtualHost config. We

     

       72
       72
        
       first create self-signed placeholder certificates in place of the

     

       73
       73
        
       real ACME certs. The placeholder certs are overwritten when the ACME

     

       74
       74
        
       certs arrive. For <literal>foo.example.com</literal> the config would

     
···

       77
       77
        
       

     

       78
       78
        
       <programlisting>

     

       79
       79
        
       services.nginx = {

     

       80
       80
       -
         enable = true;

     

       81
       81
       -
         virtualHosts = {

     

       80
       80
       +
         <link linkend="opt-services.nginx.enable">enable = true;</link>

     

       81
       81
       +
         <link linkend="opt-services.nginx.virtualHosts">virtualHosts</link> = {

     

       82
       82
        
           "foo.example.com" = {

     

       83
       83
       -
             forceSSL = true;

     

       84
       84
       -
             enableACME = true;

     

       83
       83
       +
             <link linkend="opt-services.nginx.virtualHosts._name_.forceSSL">forceSSL</link> = true;

     

       84
       84
       +
             <link linkend="opt-services.nginx.virtualHosts._name_.enableACME">enableACME</link> = true;

     

       85
       85
        
             locations."/" = {

     

       86
       86
       -
               root = "/var/www";

     

       86
       86
       +
               <link linkend="opt-services.nginx.virtualHosts._name_.locations._name_.root">root</link> = "/var/www";

     

       87
       87
        
             };

     

       88
       88
        
           };

     

       89
       89
        
         };

+6 -6

nixos/modules/security/hidepid.xml

···

       8
       8
        
       

     

       9
       9
        
         <para>

     

       10
       10
        
           Setting

     

       11
       11
       -
           <programlisting>

     

       12
       12
       -
             security.hideProcessInformation = true;

     

       13
       13
       -
           </programlisting>

     

       11
       11
       +
       <programlisting>

     

       12
       12
       +
       <xref linkend="opt-security.hideProcessInformation"/> = true;

     

       13
       13
       +
       </programlisting>

     

       14
       14
        
           ensures that access to process information is restricted to the

     

       15
       15
        
           owning user.  This implies, among other things, that command-line

     

       16
       16
        
           arguments remain private.  Unless your deployment relies on unprivileged

     
···

       25
       25
        
       

     

       26
       26
        
         <para>

     

       27
       27
        
           To allow a service <replaceable>foo</replaceable> to run without process information hiding, set

     

       28
       28
       -
           <programlisting>

     

       29
       29
       -
             systemd.services.<replaceable>foo</replaceable>.serviceConfig.SupplementaryGroups = [ "proc" ];

     

       30
       30
       -
           </programlisting>

     

       28
       28
       +
       <programlisting>

     

       29
       29
       +
       <link linkend="opt-systemd.services._name_.serviceConfig">systemd.services.<replaceable>foo</replaceable>.serviceConfig</link>.SupplementaryGroups = [ "proc" ];

     

       30
       30
       +
       </programlisting>

     

       31
       31
        
         </para>

     

       32
       32
        
       

     

       33
       33
        
       </chapter>

+6 -6

nixos/modules/services/databases/postgresql.xml

···

       23
       23
        
       <filename>configuration.nix</filename>:

     

       24
       24
        
       

     

       25
       25
        
       <programlisting>

     

       26
       26
       -
       services.postgresql.enable = true;

     

       27
       27
       -
       services.postgresql.package = pkgs.postgresql94;

     

       26
       26
       +
       <xref linkend="opt-services.postgresql.enable"/> = true;

     

       27
       27
       +
       <xref linkend="opt-services.postgresql.package"/> = pkgs.postgresql94;

     

       28
       28
        
       </programlisting>

     

       29
       29
        
       

     

       30
       30
        
       Note that you are required to specify the desired version of

     

       31
       31
        
       PostgreSQL (e.g. <literal>pkgs.postgresql94</literal>). Since

     

       32
       32
        
       upgrading your PostgreSQL version requires a database dump and reload

     

       33
       33
        
       (see below), NixOS cannot provide a default value for

     

       34
       34
       -
       <option>services.postgresql.package</option> such as the most recent

     

       34
       34
       +
       <xref linkend="opt-services.postgresql.package"/> such as the most recent

     

       35
       35
        
       release of PostgreSQL.</para>

     

       36
       36
        
       

     

       37
       37
        
       <!--

     
···

       49
       49
        
       

     

       50
       50
        
       <para>By default, PostgreSQL stores its databases in

     

       51
       51
        
       <filename>/var/db/postgresql</filename>. You can override this using

     

       52
       52
       -
       <option>services.postgresql.dataDir</option>, e.g.

     

       52
       52
       +
       <xref linkend="opt-services.postgresql.dataDir"/>, e.g.

     

       53
       53
        
       

     

       54
       54
        
       <programlisting>

     

       55
       55
       -
       services.postgresql.dataDir = "/data/postgresql";

     

       55
       55
       +
       <xref linkend="opt-services.postgresql.dataDir"/> = "/data/postgresql";

     

       56
       56
        
       </programlisting>

     

       57
       57
        
       

     

       58
       58
        
       </para>

     
···

       69
       69
        
       

     

       70
       70
        
       <section><title>Options</title>

     

       71
       71
        
       

     

       72
       72
       -
       <para>FIXME: auto-generated list of module options.</para>

     

       72
       72
       +
         <para>A complete list of options for the PostgreSQL module may be found <link linkend="opt-services.postgresql.enable">here</link>.</para>

     

       73
       73
        
       

     

       74
       74
        
       </section>

     

       75
       75

+10 -10

nixos/modules/services/editors/emacs.xml

···

       404
       404
        
             user service for Emacs daemon, add the following to your

     

       405
       405
        
             <filename>configuration.nix</filename>:

     

       406
       406
        
       

     

       407
       407
       -
             <programlisting><![CDATA[

     

       408
       408
       -
       services.emacs.enable = true;

     

       409
       409
       -
       services.emacs.package = import /home/cassou/.emacs.d { pkgs = pkgs; };

     

       410
       410
       -
       ]]></programlisting>

     

       407
       407
       +
       <programlisting>

     

       408
       408
       +
       <xref linkend="opt-services.emacs.enable"/> = true;

     

       409
       409
       +
       <xref linkend="opt-services.emacs.package"/> = import /home/cassou/.emacs.d { pkgs = pkgs; };

     

       410
       410
       +
       </programlisting>

     

       411
       411
        
           </para>

     

       412
       412
        
       

     

       413
       413
        
           <para>

     
···

       462
       462
        
           <!--<title><command>emacsclient</command> as the Default Editor</title>-->

     

       463
       463
        
       

     

       464
       464
        
           <para>

     

       465
       465
       -
             If <varname>services.emacs.defaultEditor</varname> is

     

       465
       465
       +
             If <xref linkend="opt-services.emacs.defaultEditor"/> is

     

       466
       466
        
             <literal>true</literal>, the <varname>EDITOR</varname> variable

     

       467
       467
        
             will be set to a wrapper script which launches

     

       468
       468
        
             <command>emacsclient</command>.

     
···

       497
       497
        
             Emacs daemon is not wanted for all users, it is possible to

     

       498
       498
        
             install the service but not globally enable it:

     

       499
       499
        
       

     

       500
       500
       -
             <programlisting><![CDATA[

     

       501
       501
       -
       services.emacs.enable = false;

     

       502
       502
       -
       services.emacs.install = true;

     

       503
       503
       -
       ]]></programlisting>

     

       500
       500
       +
       <programlisting>

     

       501
       501
       +
       <xref linkend="opt-services.emacs.enable"/> = false;

     

       502
       502
       +
       <xref linkend="opt-services.emacs.install"/> = true;

     

       503
       503
       +
       </programlisting>

     

       504
       504
        
           </para>

     

       505
       505
        
       

     

       506
       506
        
           <para>

     
···

       582
       582
        
           <para>

     

       583
       583
        
             To install the DocBook 5.0 schemas, either add

     

       584
       584
        
             <varname>pkgs.docbook5</varname> to

     

       585
       585
       -
             <varname>environment.systemPackages</varname> (<link

     

       585
       585
       +
             <xref linkend="opt-environment.systemPackages"/> (<link

     

       586
       586
        
             linkend="sec-declarative-package-mgmt">NixOS</link>), or run

     

       587
       587
        
             <literal>nix-env -i pkgs.docbook5</literal>

     

       588
       588
        
             (<link linkend="sec-ad-hoc-packages">Nix</link>).

+29 -30

nixos/modules/services/misc/gitlab.xml

···

       18
       18
        
           frontend proxy:

     

       19
       19
        
       

     

       20
       20
        
       <programlisting>

     

       21
       21
       -
           services.nginx = {

     

       22
       22
       -
             enable = true;

     

       23
       23
       -
             recommendedGzipSettings = true;

     

       24
       24
       -
             recommendedOptimisation = true;

     

       25
       25
       -
             recommendedProxySettings = true;

     

       26
       26
       -
             recommendedTlsSettings = true;

     

       27
       27
       -
             virtualHosts."git.example.com" = {

     

       28
       28
       -
               enableACME = true;

     

       29
       29
       -
               forceSSL = true;

     

       30
       30
       -
               locations."/".proxyPass = "http://unix:/run/gitlab/gitlab-workhorse.socket";

     

       31
       31
       -
             };

     

       32
       32
       -
           };

     

       33
       33
       -
       '';

     

       21
       21
       +
       <link linkend="opt-services.nginx.enable">services.nginx</link> = {

     

       22
       22
       +
         <link linkend="opt-services.nginx.enable">enable</link> = true;

     

       23
       23
       +
         <link linkend="opt-services.nginx.recommendedGzipSettings">recommendedGzipSettings</link> = true;

     

       24
       24
       +
         <link linkend="opt-services.nginx.recommendedOptimisation">recommendedOptimisation</link> = true;

     

       25
       25
       +
         <link linkend="opt-services.nginx.recommendedProxySettings">recommendedProxySettings</link> = true;

     

       26
       26
       +
         <link linkend="opt-services.nginx.recommendedTlsSettings">recommendedTlsSettings</link> = true;

     

       27
       27
       +
         <link linkend="opt-services.nginx.virtualHosts">virtualHosts</link>."git.example.com" = {

     

       28
       28
       +
           <link linkend="opt-services.nginx.virtualHosts._name_.enableACME">enableACME</link> = true;

     

       29
       29
       +
           <link linkend="opt-services.nginx.virtualHosts._name_.forceSSL">forceSSL</link> = true;

     

       30
       30
       +
           <link linkend="opt-services.nginx.virtualHosts._name_.locations._name_.proxyPass">locations."/".proxyPass</link> = "http://unix:/run/gitlab/gitlab-workhorse.socket";

     

       31
       31
       +
         };

     

       32
       32
       +
       };

     

       34
       33
        
       </programlisting>

     

       35
       34
        
       </para>

     

       36
       35
        
       

     
···

       49
       48
        
       

     

       50
       49
        
       <programlisting>

     

       51
       50
        
       services.gitlab = {

     

       52
       52
       -
         enable = true;

     

       53
       53
       -
         databasePassword = "eXaMpl3";

     

       54
       54
       -
         initialRootPassword = "UseNixOS!";

     

       55
       55
       -
         https = true;

     

       56
       56
       -
         host = "git.example.com";

     

       57
       57
       -
         port = 443;

     

       58
       58
       -
         user = "git";

     

       59
       59
       -
         group = "git";

     

       51
       51
       +
         <link linkend="opt-services.gitlab.enable">enable</link> = true;

     

       52
       52
       +
         <link linkend="opt-services.gitlab.databasePassword">databasePassword</link> = "eXaMpl3";

     

       53
       53
       +
         <link linkend="opt-services.gitlab.initialRootPassword">initialRootPassword</link> = "UseNixOS!";

     

       54
       54
       +
         <link linkend="opt-services.gitlab.https">https</link> = true;

     

       55
       55
       +
         <link linkend="opt-services.gitlab.host">host</link> = "git.example.com";

     

       56
       56
       +
         <link linkend="opt-services.gitlab.port">port</link> = 443;

     

       57
       57
       +
         <link linkend="opt-services.gitlab.user">user</link> = "git";

     

       58
       58
       +
         <link linkend="opt-services.gitlab.group">group</link> = "git";

     

       60
       59
        
         smtp = {

     

       61
       61
       -
           enable = true;

     

       62
       62
       -
           address = "localhost";

     

       63
       63
       -
           port = 25;

     

       60
       60
       +
           <link linkend="opt-services.gitlab.smtp.enable">enable</link> = true;

     

       61
       61
       +
           <link linkend="opt-services.gitlab.smtp.address">address</link> = "localhost";

     

       62
       62
       +
           <link linkend="opt-services.gitlab.smtp.port">port</link> = 25;

     

       64
       63
        
         };

     

       65
       64
        
         secrets = {

     

       66
       66
       -
           db = "uPgq1gtwwHiatiuE0YHqbGa5lEIXH7fMsvuTNgdzJi8P0Dg12gibTzBQbq5LT7PNzcc3BP9P1snHVnduqtGF43PgrQtU7XL93ts6gqe9CBNhjtaqUwutQUDkygP5NrV6";

     

       67
       67
       -
           secret = "devzJ0Tz0POiDBlrpWmcsjjrLaltyiAdS8TtgT9YNBOoUcDsfppiY3IXZjMVtKgXrFImIennFGOpPN8IkP8ATXpRgDD5rxVnKuTTwYQaci2NtaV1XxOQGjdIE50VGsR3";

     

       68
       68
       -
           otp = "e1GATJVuS2sUh7jxiPzZPre4qtzGGaS22FR50Xs1TerRVdgI3CBVUi5XYtQ38W4xFeS4mDqi5cQjExE838iViSzCdcG19XSL6qNsfokQP9JugwiftmhmCadtsnHErBMI";

     

       69
       69
       -
           jws = ''

     

       65
       65
       +
           <link linkend="opt-services.gitlab.secrets.db">db</link> = "uPgq1gtwwHiatiuE0YHqbGa5lEIXH7fMsvuTNgdzJi8P0Dg12gibTzBQbq5LT7PNzcc3BP9P1snHVnduqtGF43PgrQtU7XL93ts6gqe9CBNhjtaqUwutQUDkygP5NrV6";

     

       66
       66
       +
           <link linkend="opt-services.gitlab.secrets.secret">secret</link> = "devzJ0Tz0POiDBlrpWmcsjjrLaltyiAdS8TtgT9YNBOoUcDsfppiY3IXZjMVtKgXrFImIennFGOpPN8IkP8ATXpRgDD5rxVnKuTTwYQaci2NtaV1XxOQGjdIE50VGsR3";

     

       67
       67
       +
           <link linkend="opt-services.gitlab.secrets.otp">otp</link> = "e1GATJVuS2sUh7jxiPzZPre4qtzGGaS22FR50Xs1TerRVdgI3CBVUi5XYtQ38W4xFeS4mDqi5cQjExE838iViSzCdcG19XSL6qNsfokQP9JugwiftmhmCadtsnHErBMI";

     

       68
       68
       +
           <link linkend="opt-services.gitlab.secrets.jws">jws</link> = ''

     

       70
       69
        
             -----BEGIN RSA PRIVATE KEY-----

     

       71
       70
        
             MIIEpAIBAAKCAQEArrtx4oHKwXoqUbMNqnHgAklnnuDon3XG5LJB35yPsXKv/8GK

     

       72
       71
        
             ke92wkI+s1Xkvsp8tg9BIY/7c6YK4SR07EWL+dB5qwctsWR2Q8z+/BKmTx9D99pm

     
···

       96
       95
        
             -----END RSA PRIVATE KEY-----

     

       97
       96
        
           '';

     

       98
       97
        
         };

     

       99
       99
       -
         extraConfig = {

     

       98
       98
       +
         <link linkend="opt-services.gitlab.extraConfig">extraConfig</link> = {

     

       100
       99
        
           gitlab = {

     

       101
       100
        
             email_from = "gitlab-no-reply@example.com";

     

       102
       101
        
             email_display_name = "Example GitLab";

     
···

       116
       115
        
       folder.</para>

     

       117
       116
        
       

     

       118
       117
        
       <para>Refer to <xref linkend="ch-options" /> for all available configuration

     

       119
       119
       -
       options for the <literal>services.gitlab</literal> module.</para>

     

       118
       118
       +
       options for the <link linkend="opt-services.gitlab.enable">services.gitlab</link> module.</para>

     

       120
       119
        
       

     

       121
       120
        
       </section>

     

       122
       121

+6 -6

nixos/modules/services/misc/taskserver/doc.xml

···

       55
       55
        
             Because Taskserver by default only provides scripts to setup users

     

       56
       56
        
             imperatively, the <command>nixos-taskserver</command> tool is used for

     

       57
       57
        
             addition and deletion of organisations along with users and groups defined

     

       58
       58
       -
             by <option>services.taskserver.organisations</option> and as well for

     

       58
       58
       +
             by <xref linkend="opt-services.taskserver.organisations"/> and as well for

     

       59
       59
        
             imperative set up.

     

       60
       60
        
           </para>

     

       61
       61
        
       

     
···

       99
       99
        
             For example, let's say you have the following configuration:

     

       100
       100
        
       <screen>

     

       101
       101
        
       {

     

       102
       102
       -
         services.taskserver.enable = true;

     

       103
       103
       -
         services.taskserver.fqdn = "server";

     

       104
       104
       -
         services.taskserver.listenHost = "::";

     

       105
       105
       -
         services.taskserver.organisations.my-company.users = [ "alice" ];

     

       102
       102
       +
         <xref linkend="opt-services.taskserver.enable"/> = true;

     

       103
       103
       +
         <xref linkend="opt-services.taskserver.fqdn"/> = "server";

     

       104
       104
       +
         <xref linkend="opt-services.taskserver.listenHost"/> = "::";

     

       105
       105
       +
         <link linkend="opt-services.taskserver.organisations._name_.users">services.taskserver.organisations.my-company.users</link> = [ "alice" ];

     

       106
       106
        
       }

     

       107
       107
        
       </screen>

     

       108
       108
        
             This creates an organisation called <literal>my-company</literal> with the

     
···

       136
       136
        
       

     

       137
       137
        
           <para>

     

       138
       138
        
             If you set any options within

     

       139
       139
       -
             <option>service.taskserver.pki.manual.*</option>,

     

       139
       139
       +
             <link linkend="opt-services.taskserver.pki.manual.ca.cert">service.taskserver.pki.manual</link>.*,

     

       140
       140
        
             <command>nixos-taskserver</command> won't issue certificates, but you can

     

       141
       141
        
             still use it for adding or removing user accounts.

     

       142
       142
        
           </para>

+10 -10

nixos/modules/services/networking/dnscrypt-proxy.xml

···

       19
       19
        
         <para>

     

       20
       20
        
           To enable the client proxy, set

     

       21
       21
        
           <programlisting>

     

       22
       22
       -
             services.dnscrypt-proxy.enable = true;

     

       22
       22
       +
       <xref linkend="opt-services.dnscrypt-proxy.enable"/> = true;

     

       23
       23
        
           </programlisting>

     

       24
       24
        
         </para>

     

       25
       25
        
       

     
···

       38
       38
        
           DNS client, change the default proxy listening port to a

     

       39
       39
        
           non-standard value and point the other client to it:

     

       40
       40
        
           <programlisting>

     

       41
       41
       -
             services.dnscrypt-proxy.localPort = 43;

     

       41
       41
       +
       <xref linkend="opt-services.dnscrypt-proxy.localPort"/> = 43;

     

       42
       42
        
           </programlisting>

     

       43
       43
        
         </para>

     

       44
       44
        
       

     

       45
       45
        
         <sect2><title>dnsmasq</title>

     

       46
       46
        
         <para>

     

       47
       47
        
           <programlisting>

     

       48
       48
       -
             {

     

       49
       49
       -
               services.dnsmasq.enable = true;

     

       50
       50
       -
               services.dnsmasq.servers = [ "127.0.0.1#43" ];

     

       51
       51
       -
             }

     

       48
       48
       +
       {

     

       49
       49
       +
         <xref linkend="opt-services.dnsmasq.enable"/> = true;

     

       50
       50
       +
         <xref linkend="opt-services.dnsmasq.servers"/> = [ "127.0.0.1#43" ];

     

       51
       51
       +
       }

     

       52
       52
        
           </programlisting>

     

       53
       53
        
         </para>

     

       54
       54
        
         </sect2>

     
···

       56
       56
        
         <sect2><title>unbound</title>

     

       57
       57
        
         <para>

     

       58
       58
        
           <programlisting>

     

       59
       59
       -
             {

     

       60
       60
       -
               services.unbound.enable = true;

     

       61
       61
       -
               services.unbound.forwardAddresses = [ "127.0.0.1@43" ];

     

       62
       62
       -
             }

     

       59
       59
       +
       {

     

       60
       60
       +
         <xref linkend="opt-services.unbound.enable"/> = true;

     

       61
       61
       +
         <xref linkend="opt-services.unbound.forwardAddresses"/> = [ "127.0.0.1@43" ];

     

       62
       62
       +
       }

     

       63
       63
        
           </programlisting>

     

       64
       64
        
         </para>

     

       65
       65
        
         </sect2>