git.iko.soy/typeable/nixpkgs
on master help sign in
nixos/doc: re-format
commitea6e8775bd69e4676c623a85c39f1da540d29ad1 authorJan Tojnar <jtojnar@gmail.com> dateWed 18 Sep 2019, 22:13 (7 years ago) parent83c2ad8
124 files changed+1894−5663
nixos/doc/manual/administration/boot-problems.xml+6−26 nixos/doc/manual/administration/cleaning-store.xml+8−24 nixos/doc/manual/administration/container-networking.xml+5−21 nixos/doc/manual/administration/containers.xml+3−16 nixos/doc/manual/administration/control-groups.xml+6−27 nixos/doc/manual/administration/declarative-containers.xml+6−25 nixos/doc/manual/administration/imperative-containers.xml+12−45 nixos/doc/manual/administration/logging.xml+4−15 nixos/doc/manual/administration/maintenance-mode.xml+1−3 nixos/doc/manual/administration/network-problems.xml+2−11 nixos/doc/manual/administration/rebooting.xml+3−8 nixos/doc/manual/administration/rollback.xml+3−12 nixos/doc/manual/administration/running.xml+1−2 nixos/doc/manual/administration/service-mgmt.xml+5−21 nixos/doc/manual/administration/store-corruption.xml+4−13 nixos/doc/manual/administration/troubleshooting.xml+1−2 nixos/doc/manual/administration/user-sessions.xml+3−12 nixos/doc/manual/configuration/abstractions.xml+12−36 nixos/doc/manual/configuration/ad-hoc-network-config.xml+1−4 nixos/doc/manual/configuration/ad-hoc-packages.xml+5−21 nixos/doc/manual/configuration/adding-custom-packages.xml+6−17 nixos/doc/manual/configuration/config-file.xml+14−57 nixos/doc/manual/configuration/config-syntax.xml+2−12 nixos/doc/manual/configuration/configuration.xml+1−5 nixos/doc/manual/configuration/customizing-packages.xml+8−46 nixos/doc/manual/configuration/declarative-packages.xml+6−17 nixos/doc/manual/configuration/file-systems.xml+4−24 nixos/doc/manual/configuration/firewall.xml+4−11 nixos/doc/manual/configuration/ipv4-config.xml+4−11 nixos/doc/manual/configuration/ipv6-config.xml+4−9 nixos/doc/manual/configuration/kubernetes.xml+12−62 nixos/doc/manual/configuration/linux-kernel.xml+15−44 nixos/doc/manual/configuration/luks-file-systems.xml+3−9 nixos/doc/manual/configuration/matrix.xml+8−65 nixos/doc/manual/configuration/modularity.xml+13−50 nixos/doc/manual/configuration/network-manager.xml+5−17 nixos/doc/manual/configuration/networking.xml+1−2 nixos/doc/manual/configuration/package-mgmt.xml+3−10 nixos/doc/manual/configuration/profiles.xml+3−10 nixos/doc/manual/configuration/profiles/all-hardware.xml+2−8 nixos/doc/manual/configuration/profiles/base.xml+1−5 nixos/doc/manual/configuration/profiles/clone-config.xml+2−8 nixos/doc/manual/configuration/profiles/demo.xml+1−5 nixos/doc/manual/configuration/profiles/docker-container.xml+1−6 nixos/doc/manual/configuration/profiles/graphical.xml+2−9 nixos/doc/manual/configuration/profiles/hardened.xml+3−11 nixos/doc/manual/configuration/profiles/headless.xml+1−5 nixos/doc/manual/configuration/profiles/installation-device.xml+6−19 nixos/doc/manual/configuration/profiles/minimal.xml+1−7 nixos/doc/manual/configuration/profiles/qemu-guest.xml+2−5 nixos/doc/manual/configuration/ssh.xml+2−5 nixos/doc/manual/configuration/summary.xml+2−6 nixos/doc/manual/configuration/user-mgmt.xml+10−43 nixos/doc/manual/configuration/wireless.xml+5−13 nixos/doc/manual/configuration/x-windows.xml+40−111 nixos/doc/manual/configuration/xfce.xml+5−16 nixos/doc/manual/development/assertions.xml+3−15 nixos/doc/manual/development/building-nixos.xml+3−8 nixos/doc/manual/development/building-parts.xml+8−23 nixos/doc/manual/development/importing-modules.xml+2−5 nixos/doc/manual/development/meta-attributes.xml+5−14 nixos/doc/manual/development/nixos-tests.xml+2−7 nixos/doc/manual/development/option-declarations.xml+19−61 nixos/doc/manual/development/option-def.xml+8−26 nixos/doc/manual/development/option-types.xml+47−161 nixos/doc/manual/development/releases.xml+54−72 nixos/doc/manual/development/replace-modules.xml+4−18 nixos/doc/manual/development/running-nixos-tests-interactively.xml+4−10 nixos/doc/manual/development/running-nixos-tests.xml+3−10 nixos/doc/manual/development/sources.xml+9−39 nixos/doc/manual/development/testing-installer.xml+2−4 nixos/doc/manual/development/writing-documentation.xml+18−56 nixos/doc/manual/development/writing-modules.xml+13−56 nixos/doc/manual/development/writing-nixos-tests.xml+29−84 nixos/doc/manual/installation/changing-config.xml+13−40 nixos/doc/manual/installation/installation.xml+1−2 nixos/doc/manual/installation/installing-behind-a-proxy.xml+4−11 nixos/doc/manual/installation/installing-from-other-distro.xml+40−112 nixos/doc/manual/installation/installing-pxe.xml+5−20 nixos/doc/manual/installation/installing-usb.xml+3−12 nixos/doc/manual/installation/installing-virtualbox-guest.xml+7−22 nixos/doc/manual/installation/installing.xml+53−177 nixos/doc/manual/installation/obtaining.xml+9−29 nixos/doc/manual/installation/upgrading.xml+17−65 nixos/doc/manual/man-configuration.xml+1−4 nixos/doc/manual/man-nixos-build-vms.xml+12−29 nixos/doc/manual/man-nixos-enter.xml+7−15 nixos/doc/manual/man-nixos-generate-config.xml+15−49 nixos/doc/manual/man-nixos-install.xml+28−67 nixos/doc/manual/man-nixos-option.xml+10−17 nixos/doc/manual/man-nixos-rebuild.xml+90−219 nixos/doc/manual/man-nixos-version.xml+6−17 nixos/doc/manual/manual.xml+6−15 nixos/doc/manual/release-notes/release-notes.xml+1−2 nixos/doc/manual/release-notes/rl-1404.xml+17−66 nixos/doc/manual/release-notes/rl-1412.xml+19−62 nixos/doc/manual/release-notes/rl-1509.xml+45−163 nixos/doc/manual/release-notes/rl-1603.xml+41−164 nixos/doc/manual/release-notes/rl-1609.xml+35−126 nixos/doc/manual/release-notes/rl-1703.xml+45−148 nixos/doc/manual/release-notes/rl-1709.xml+65−227 nixos/doc/manual/release-notes/rl-1803.xml+56−210 nixos/doc/manual/release-notes/rl-1809.xml+69−242 nixos/doc/manual/release-notes/rl-1903.xml+82−366 nixos/doc/manual/release-notes/rl-1909.xml+325−406 nixos/doc/manual/release-notes/rl-2003.xml+2−5 nixos/modules/i18n/input-method/default.xml+20−54 nixos/modules/programs/digitalbitbox/doc.xml+9−24 nixos/modules/programs/plotinus.xml+4−9 nixos/modules/programs/zsh/oh-my-zsh.xml+13−49 nixos/modules/security/acme.xml+7−23 nixos/modules/security/hidepid.xml+3−8 nixos/modules/services/databases/foundationdb.xml+39−158 nixos/modules/services/databases/postgresql.xml+13−26 nixos/modules/services/desktops/flatpak.xml+7−18 nixos/modules/services/editors/emacs.xml+51−170 nixos/modules/services/hardware/trezord.xml+2−8 nixos/modules/services/misc/gitlab.xml+8−26 nixos/modules/services/misc/taskserver/doc.xml+18−56 nixos/modules/services/misc/weechat.xml+5−16 nixos/modules/services/monitoring/prometheus/exporters.xml+12−39 nixos/modules/services/networking/dnscrypt-proxy.xml+3−11 nixos/modules/services/web-apps/matomo-doc.xml+11−45 nixos/modules/services/web-apps/nextcloud.xml+14−41
nixos/doc/manual/administration/boot-problems.xml+6−26
@@ -6,12 +6,7 @@
66 <title>Boot Problems</title>
77
88 <para>
9− If NixOS fails to boot, there are a number of kernel command line parameters
10− that may help you to identify or fix the issue. You can add these parameters
11− in the GRUB boot menu by pressing “e” to modify the selected boot entry
12− and editing the line starting with <literal>linux</literal>. The following
13− are some useful kernel command line parameters that are recognised by the
14− NixOS boot scripts or by systemd:
9+ If NixOS fails to boot, there are a number of kernel command line parameters that may help you to identify or fix the issue. You can add these parameters in the GRUB boot menu by pressing “e” to modify the selected boot entry and editing the line starting with <literal>linux</literal>. The following are some useful kernel command line parameters that are recognised by the NixOS boot scripts or by systemd:
1510 <variablelist>
1611 <varlistentry>
1712 <term>
@@ -19,9 +14,7 @@
1914 </term>
2015 <listitem>
2116 <para>
22− Start a root shell if something goes wrong in stage 1 of the boot process
23− (the initial ramdisk). This is disabled by default because there is no
24− authentication for the root shell.
17+ Start a root shell if something goes wrong in stage 1 of the boot process (the initial ramdisk). This is disabled by default because there is no authentication for the root shell.
2518 </para>
2619 </listitem>
2720 </varlistentry>
@@ -31,10 +24,7 @@
3124 </term>
3225 <listitem>
3326 <para>
34− Start an interactive shell in stage 1 before anything useful has been
35− done. That is, no modules have been loaded and no file systems have been
36− mounted, except for <filename>/proc</filename> and
37− <filename>/sys</filename>.
27+ Start an interactive shell in stage 1 before anything useful has been done. That is, no modules have been loaded and no file systems have been mounted, except for <filename>/proc</filename> and <filename>/sys</filename>.
3828 </para>
3929 </listitem>
4030 </varlistentry>
@@ -54,11 +44,7 @@
5444 </term>
5545 <listitem>
5646 <para>
57− Boot into rescue mode (a.k.a. single user mode). This will cause systemd
58− to start nothing but the unit <literal>rescue.target</literal>, which
59− runs <command>sulogin</command> to prompt for the root password and start
60− a root login shell. Exiting the shell causes the system to continue with
61− the normal boot process.
47+ Boot into rescue mode (a.k.a. single user mode). This will cause systemd to start nothing but the unit <literal>rescue.target</literal>, which runs <command>sulogin</command> to prompt for the root password and start a root login shell. Exiting the shell causes the system to continue with the normal boot process.
6248 </para>
6349 </listitem>
6450 </varlistentry>
@@ -68,8 +54,7 @@
6854 </term>
6955 <listitem>
7056 <para>
71− Make systemd very verbose and send log messages to the console instead of
72− the journal.
57+ Make systemd very verbose and send log messages to the console instead of the journal.
7358 </para>
7459 </listitem>
7560 </varlistentry>
@@ -80,11 +65,6 @@
8065 </para>
8166
8267 <para>
83− If no login prompts or X11 login screens appear (e.g. due to hanging
84− dependencies), you can press Alt+ArrowUp. If you’re lucky, this will start
85− rescue mode (described above). (Also note that since most units have a
86− 90-second timeout before systemd gives up on them, the
87− <command>agetty</command> login prompts should appear eventually unless
88− something is very wrong.)
68+ If no login prompts or X11 login screens appear (e.g. due to hanging dependencies), you can press Alt+ArrowUp. If you’re lucky, this will start rescue mode (described above). (Also note that since most units have a 90-second timeout before systemd gives up on them, the <command>agetty</command> login prompts should appear eventually unless something is very wrong.)
8969 </para>
9070</section>
nixos/doc/manual/administration/cleaning-store.xml+8−24
@@ -5,31 +5,22 @@
55 xml:id="sec-nix-gc">
66 <title>Cleaning the Nix Store</title>
77 <para>
8− Nix has a purely functional model, meaning that packages are never upgraded
9− in place. Instead new versions of packages end up in a different location in
10− the Nix store (<filename>/nix/store</filename>). You should periodically run
11− Nix’s <emphasis>garbage collector</emphasis> to remove old, unreferenced
12− packages. This is easy:
8+ Nix has a purely functional model, meaning that packages are never upgraded in place. Instead new versions of packages end up in a different location in the Nix store (<filename>/nix/store</filename>). You should periodically run Nix’s <emphasis>garbage collector</emphasis> to remove old, unreferenced packages. This is easy:
139<screen>
1410<prompt>$ </prompt>nix-collect-garbage
1511</screen>
16− Alternatively, you can use a systemd unit that does the same in the
17− background:
12+ Alternatively, you can use a systemd unit that does the same in the background:
1813<screen>
1914<prompt># </prompt>systemctl start nix-gc.service
2015</screen>
21− You can tell NixOS in <filename>configuration.nix</filename> to run this unit
22− automatically at certain points in time, for instance, every night at 03:15:
16+ You can tell NixOS in <filename>configuration.nix</filename> to run this unit automatically at certain points in time, for instance, every night at 03:15:
2317<programlisting>
2418<xref linkend="opt-nix.gc.automatic"/> = true;
2519<xref linkend="opt-nix.gc.dates"/> = "03:15";
2620</programlisting>
2721 </para>
2822 <para>
29− The commands above do not remove garbage collector roots, such as old system
30− configurations. Thus they do not remove the ability to roll back to previous
31− configurations. The following command deletes old roots, removing the ability
32− to roll back to them:
23+ The commands above do not remove garbage collector roots, such as old system configurations. Thus they do not remove the ability to roll back to previous configurations. The following command deletes old roots, removing the ability to roll back to them:
3324<screen>
3425<prompt>$ </prompt>nix-collect-garbage -d
3526</screen>
@@ -37,27 +28,20 @@
3728<screen>
3829<prompt>$ </prompt>nix-env -p /nix/var/nix/profiles/per-user/eelco/profile --delete-generations old
3930</screen>
40− Note that NixOS system configurations are stored in the profile
41− <filename>/nix/var/nix/profiles/system</filename>.
31+ Note that NixOS system configurations are stored in the profile <filename>/nix/var/nix/profiles/system</filename>.
4232 </para>
4333 <para>
44− Another way to reclaim disk space (often as much as 40% of the size of the
45− Nix store) is to run Nix’s store optimiser, which seeks out identical files
46− in the store and replaces them with hard links to a single copy.
34+ Another way to reclaim disk space (often as much as 40% of the size of the Nix store) is to run Nix’s store optimiser, which seeks out identical files in the store and replaces them with hard links to a single copy.
4735<screen>
4836<prompt>$ </prompt>nix-store --optimise
4937</screen>
50− Since this command needs to read the entire Nix store, it can take quite a
51− while to finish.
38+ Since this command needs to read the entire Nix store, it can take quite a while to finish.
5239 </para>
5340 <section xml:id="sect-nixos-gc-boot-entries">
5441 <title>NixOS Boot Entries</title>
5542
5643 <para>
57− If your <filename>/boot</filename> partition runs out of space, after
58− clearing old profiles you must rebuild your system with
59− <literal>nixos-rebuild</literal> to update the <filename>/boot</filename>
60− partition and clear space.
44+ If your <filename>/boot</filename> partition runs out of space, after clearing old profiles you must rebuild your system with <literal>nixos-rebuild</literal> to update the <filename>/boot</filename> partition and clear space.
6145 </para>
6246 </section>
6347</chapter>
nixos/doc/manual/administration/container-networking.xml+5−21
@@ -6,10 +6,7 @@
66 <title>Container Networking</title>
77
88 <para>
9− When you create a container using <literal>nixos-container create</literal>,
10− it gets it own private IPv4 address in the range
11− <literal>10.233.0.0/16</literal>. You can get the container’s IPv4 address
12− as follows:
9+ When you create a container using <literal>nixos-container create</literal>, it gets it own private IPv4 address in the range <literal>10.233.0.0/16</literal>. You can get the container’s IPv4 address as follows:
1310<screen>
1411<prompt># </prompt>nixos-container show-ip foo
151210.233.4.2
@@ -20,34 +17,21 @@
2017 </para>
2118
2219 <para>
23− Networking is implemented using a pair of virtual Ethernet devices. The
24− network interface in the container is called <literal>eth0</literal>, while
25− the matching interface in the host is called
26− <literal>ve-<replaceable>container-name</replaceable></literal> (e.g.,
27− <literal>ve-foo</literal>). The container has its own network namespace and
28− the <literal>CAP_NET_ADMIN</literal> capability, so it can perform arbitrary
29− network configuration such as setting up firewall rules, without affecting or
30− having access to the host’s network.
20+ Networking is implemented using a pair of virtual Ethernet devices. The network interface in the container is called <literal>eth0</literal>, while the matching interface in the host is called <literal>ve-<replaceable>container-name</replaceable></literal> (e.g., <literal>ve-foo</literal>). The container has its own network namespace and the <literal>CAP_NET_ADMIN</literal> capability, so it can perform arbitrary network configuration such as setting up firewall rules, without affecting or having access to the host’s network.
3121 </para>
3222
3323 <para>
34− By default, containers cannot talk to the outside network. If you want that,
35− you should set up Network Address Translation (NAT) rules on the host to
36− rewrite container traffic to use your external IP address. This can be
37− accomplished using the following configuration on the host:
24+ By default, containers cannot talk to the outside network. If you want that, you should set up Network Address Translation (NAT) rules on the host to rewrite container traffic to use your external IP address. This can be accomplished using the following configuration on the host:
3825<programlisting>
3926<xref linkend="opt-networking.nat.enable"/> = true;
4027<xref linkend="opt-networking.nat.internalInterfaces"/> = ["ve-+"];
4128<xref linkend="opt-networking.nat.externalInterface"/> = "eth0";
4229</programlisting>
43− where <literal>eth0</literal> should be replaced with the desired external
44− interface. Note that <literal>ve-+</literal> is a wildcard that matches all
45− container interfaces.
30+ where <literal>eth0</literal> should be replaced with the desired external interface. Note that <literal>ve-+</literal> is a wildcard that matches all container interfaces.
4631 </para>
4732
4833 <para>
49− If you are using Network Manager, you need to explicitly prevent it from
50− managing container interfaces:
34+ If you are using Network Manager, you need to explicitly prevent it from managing container interfaces:
5135<programlisting>
5236networking.networkmanager.unmanaged = [ "interface-name:ve-*" ];
5337</programlisting>
nixos/doc/manual/administration/containers.xml+3−16
@@ -5,28 +5,15 @@
55 xml:id="ch-containers">
66 <title>Container Management</title>
77 <para>
8− NixOS allows you to easily run other NixOS instances as
9− <emphasis>containers</emphasis>. Containers are a light-weight approach to
10− virtualisation that runs software in the container at the same speed as in
11− the host system. NixOS containers share the Nix store of the host, making
12− container creation very efficient.
8+ NixOS allows you to easily run other NixOS instances as <emphasis>containers</emphasis>. Containers are a light-weight approach to virtualisation that runs software in the container at the same speed as in the host system. NixOS containers share the Nix store of the host, making container creation very efficient.
139 </para>
1410 <warning>
1511 <para>
16− Currently, NixOS containers are not perfectly isolated from the host system.
17− This means that a user with root access to the container can do things that
18− affect the host. So you should not give container root access to untrusted
19− users.
12+ Currently, NixOS containers are not perfectly isolated from the host system. This means that a user with root access to the container can do things that affect the host. So you should not give container root access to untrusted users.
2013 </para>
2114 </warning>
2215 <para>
23− NixOS containers can be created in two ways: imperatively, using the command
24− <command>nixos-container</command>, and declaratively, by specifying them in
25− your <filename>configuration.nix</filename>. The declarative approach implies
26− that containers get upgraded along with your host system when you run
27− <command>nixos-rebuild</command>, which is often not what you want. By
28− contrast, in the imperative approach, containers are configured and updated
29− independently from the host system.
16+ NixOS containers can be created in two ways: imperatively, using the command <command>nixos-container</command>, and declaratively, by specifying them in your <filename>configuration.nix</filename>. The declarative approach implies that containers get upgraded along with your host system when you run <command>nixos-rebuild</command>, which is often not what you want. By contrast, in the imperative approach, containers are configured and updated independently from the host system.
3017 </para>
3118 <xi:include href="imperative-containers.xml" />
3219 <xi:include href="declarative-containers.xml" />
nixos/doc/manual/administration/control-groups.xml+6−27
@@ -5,16 +5,10 @@
55 xml:id="sec-cgroups">
66 <title>Control Groups</title>
77 <para>
8− To keep track of the processes in a running system, systemd uses
9− <emphasis>control groups</emphasis> (cgroups). A control group is a set of
10− processes used to allocate resources such as CPU, memory or I/O bandwidth.
11− There can be multiple control group hierarchies, allowing each kind of
12− resource to be managed independently.
8+ To keep track of the processes in a running system, systemd uses <emphasis>control groups</emphasis> (cgroups). A control group is a set of processes used to allocate resources such as CPU, memory or I/O bandwidth. There can be multiple control group hierarchies, allowing each kind of resource to be managed independently.
139 </para>
1410 <para>
15− The command <command>systemd-cgls</command> lists all control groups in the
16− <literal>systemd</literal> hierarchy, which is what systemd uses to keep
17− track of the processes belonging to each service or user session:
11+ The command <command>systemd-cgls</command> lists all control groups in the <literal>systemd</literal> hierarchy, which is what systemd uses to keep track of the processes belonging to each service or user session:
1812<screen>
1913<prompt>$ </prompt>systemd-cgls
2014├─user
@@ -32,34 +26,19 @@
3226 │ └─2376 dhcpcd --config /nix/store/f8dif8dsi2yaa70n03xir8r653776ka6-dhcpcd.conf
3327 └─ <replaceable>...</replaceable>
3428</screen>
35− Similarly, <command>systemd-cgls cpu</command> shows the cgroups in the CPU
36− hierarchy, which allows per-cgroup CPU scheduling priorities. By default,
37− every systemd service gets its own CPU cgroup, while all user sessions are in
38− the top-level CPU cgroup. This ensures, for instance, that a thousand
39− run-away processes in the <literal>httpd.service</literal> cgroup cannot
40− starve the CPU for one process in the <literal>postgresql.service</literal>
41− cgroup. (By contrast, it they were in the same cgroup, then the PostgreSQL
42− process would get 1/1001 of the cgroup’s CPU time.) You can limit a
43− service’s CPU share in <filename>configuration.nix</filename>:
29+ Similarly, <command>systemd-cgls cpu</command> shows the cgroups in the CPU hierarchy, which allows per-cgroup CPU scheduling priorities. By default, every systemd service gets its own CPU cgroup, while all user sessions are in the top-level CPU cgroup. This ensures, for instance, that a thousand run-away processes in the <literal>httpd.service</literal> cgroup cannot starve the CPU for one process in the <literal>postgresql.service</literal> cgroup. (By contrast, it they were in the same cgroup, then the PostgreSQL process would get 1/1001 of the cgroup’s CPU time.) You can limit a service’s CPU share in <filename>configuration.nix</filename>:
4430<programlisting>
4531<link linkend="opt-systemd.services._name_.serviceConfig">systemd.services.httpd.serviceConfig</link>.CPUShares = 512;
4632</programlisting>
47− By default, every cgroup has 1024 CPU shares, so this will halve the CPU
48− allocation of the <literal>httpd.service</literal> cgroup.
33+ By default, every cgroup has 1024 CPU shares, so this will halve the CPU allocation of the <literal>httpd.service</literal> cgroup.
4934 </para>
5035 <para>
51− There also is a <literal>memory</literal> hierarchy that controls memory
52− allocation limits; by default, all processes are in the top-level cgroup, so
53− any service or session can exhaust all available memory. Per-cgroup memory
54− limits can be specified in <filename>configuration.nix</filename>; for
55− instance, to limit <literal>httpd.service</literal> to 512 MiB of RAM
56− (excluding swap):
36+ There also is a <literal>memory</literal> hierarchy that controls memory allocation limits; by default, all processes are in the top-level cgroup, so any service or session can exhaust all available memory. Per-cgroup memory limits can be specified in <filename>configuration.nix</filename>; for instance, to limit <literal>httpd.service</literal> to 512 MiB of RAM (excluding swap):
5737<programlisting>
5838<link linkend="opt-systemd.services._name_.serviceConfig">systemd.services.httpd.serviceConfig</link>.MemoryLimit = "512M";
5939</programlisting>
6040 </para>
6141 <para>
62− The command <command>systemd-cgtop</command> shows a continuously updated
63− list of all cgroups with their CPU and memory usage.
42+ The command <command>systemd-cgtop</command> shows a continuously updated list of all cgroups with their CPU and memory usage.
6443 </para>
6544</chapter>
nixos/doc/manual/administration/declarative-containers.xml+6−25
@@ -6,10 +6,7 @@
66 <title>Declarative Container Specification</title>
77
88 <para>
9− You can also specify containers and their configuration in the host’s
10− <filename>configuration.nix</filename>. For example, the following specifies
11− that there shall be a container named <literal>database</literal> running
12− PostgreSQL:
9+ You can also specify containers and their configuration in the host’s <filename>configuration.nix</filename>. For example, the following specifies that there shall be a container named <literal>database</literal> running PostgreSQL:
1310<programlisting>
1411containers.database =
1512 { config =
@@ -19,18 +16,11 @@ containers.database =
1916 };
2017 };
2118</programlisting>
22− If you run <literal>nixos-rebuild switch</literal>, the container will be
23− built. If the container was already running, it will be updated in place,
24− without rebooting. The container can be configured to start automatically by
25− setting <literal>containers.database.autoStart = true</literal> in its
26− configuration.
19+ If you run <literal>nixos-rebuild switch</literal>, the container will be built. If the container was already running, it will be updated in place, without rebooting. The container can be configured to start automatically by setting <literal>containers.database.autoStart = true</literal> in its configuration.
2720 </para>
2821
2922 <para>
30− By default, declarative containers share the network namespace of the host,
31− meaning that they can listen on (privileged) ports. However, they cannot
32− change the network configuration. You can give a container its own network as
33− follows:
23+ By default, declarative containers share the network namespace of the host, meaning that they can listen on (privileged) ports. However, they cannot change the network configuration. You can give a container its own network as follows:
3424<programlisting>
3525containers.database = {
3626 <link linkend="opt-containers._name_.privateNetwork">privateNetwork</link> = true;
@@ -38,23 +28,14 @@ containers.database = {
3828 <link linkend="opt-containers._name_.localAddress">localAddress</link> = "192.168.100.11";
3929};
4030</programlisting>
41− This gives the container a private virtual Ethernet interface with IP address
42− <literal>192.168.100.11</literal>, which is hooked up to a virtual Ethernet
43− interface on the host with IP address <literal>192.168.100.10</literal>. (See
44− the next section for details on container networking.)
31+ This gives the container a private virtual Ethernet interface with IP address <literal>192.168.100.11</literal>, which is hooked up to a virtual Ethernet interface on the host with IP address <literal>192.168.100.10</literal>. (See the next section for details on container networking.)
4532 </para>
4633
4734 <para>
48− To disable the container, just remove it from
49− <filename>configuration.nix</filename> and run <literal>nixos-rebuild
50− switch</literal>. Note that this will not delete the root directory of the
51− container in <literal>/var/lib/containers</literal>. Containers can be
52− destroyed using the imperative method: <literal>nixos-container destroy
53− foo</literal>.
35+ To disable the container, just remove it from <filename>configuration.nix</filename> and run <literal>nixos-rebuild switch</literal>. Note that this will not delete the root directory of the container in <literal>/var/lib/containers</literal>. Containers can be destroyed using the imperative method: <literal>nixos-container destroy foo</literal>.
5436 </para>
5537
5638 <para>
57− Declarative containers can be started and stopped using the corresponding
58− systemd service, e.g. <literal>systemctl start container@database</literal>.
39+ Declarative containers can be started and stopped using the corresponding systemd service, e.g. <literal>systemctl start container@database</literal>.
5940 </para>
6041</section>
nixos/doc/manual/administration/imperative-containers.xml+12−45
@@ -6,9 +6,7 @@
66 <title>Imperative Container Management</title>
77
88 <para>
9− We’ll cover imperative container management using
10− <command>nixos-container</command> first. Be aware that container management
11− is currently only possible as <literal>root</literal>.
9+ We’ll cover imperative container management using <command>nixos-container</command> first. Be aware that container management is currently only possible as <literal>root</literal>.
1210 </para>
1311
1412 <para>
@@ -16,23 +14,14 @@
1614<screen>
1715# nixos-container create foo
1816</screen>
19− This creates the container’s root directory in
20− <filename>/var/lib/containers/foo</filename> and a small configuration file
21− in <filename>/etc/containers/foo.conf</filename>. It also builds the
22− container’s initial system configuration and stores it in
23− <filename>/nix/var/nix/profiles/per-container/foo/system</filename>. You can
24− modify the initial configuration of the container on the command line. For
25− instance, to create a container that has <command>sshd</command> running,
26− with the given public key for <literal>root</literal>:
17+ This creates the container’s root directory in <filename>/var/lib/containers/foo</filename> and a small configuration file in <filename>/etc/containers/foo.conf</filename>. It also builds the container’s initial system configuration and stores it in <filename>/nix/var/nix/profiles/per-container/foo/system</filename>. You can modify the initial configuration of the container on the command line. For instance, to create a container that has <command>sshd</command> running, with the given public key for <literal>root</literal>:
2718<screen>
2819# nixos-container create foo --config '
2920 <xref linkend="opt-services.openssh.enable"/> = true;
3021 <link linkend="opt-users.users._name__.openssh.authorizedKeys.keys">users.users.root.openssh.authorizedKeys.keys</link> = ["ssh-dss AAAAB3N…"];
3122'
3223</screen>
33− By default the next free address in the <literal>10.233.0.0/16</literal> subnet will be chosen
34− as container IP. This behavior can be altered by setting <literal>--host-address</literal> and
35− <literal>--local-address</literal>:
24+ By default the next free address in the <literal>10.233.0.0/16</literal> subnet will be chosen as container IP. This behavior can be altered by setting <literal>--host-address</literal> and <literal>--local-address</literal>:
3625<screen>
3726# nixos-container create test --config-file test-container.nix \
3827 --local-address 10.235.1.2 --host-address 10.235.1.1
@@ -44,35 +33,25 @@
4433<screen>
4534# nixos-container start foo
4635</screen>
47− This command will return as soon as the container has booted and has reached
48− <literal>multi-user.target</literal>. On the host, the container runs within
49− a systemd unit called
50− <literal>container@<replaceable>container-name</replaceable>.service</literal>.
51− Thus, if something went wrong, you can get status info using
52− <command>systemctl</command>:
36+ This command will return as soon as the container has booted and has reached <literal>multi-user.target</literal>. On the host, the container runs within a systemd unit called <literal>container@<replaceable>container-name</replaceable>.service</literal>. Thus, if something went wrong, you can get status info using <command>systemctl</command>:
5337<screen>
5438# systemctl status container@foo
5539</screen>
5640 </para>
5741
5842 <para>
59− If the container has started successfully, you can log in as root using the
60− <command>root-login</command> operation:
43+ If the container has started successfully, you can log in as root using the <command>root-login</command> operation:
6144<screen>
6245# nixos-container root-login foo
6346[root@foo:~]#
6447</screen>
65− Note that only root on the host can do this (since there is no
66− authentication). You can also get a regular login prompt using the
67− <command>login</command> operation, which is available to all users on the
68− host:
48+ Note that only root on the host can do this (since there is no authentication). You can also get a regular login prompt using the <command>login</command> operation, which is available to all users on the host:
6949<screen>
7050# nixos-container login foo
7151foo login: alice
7252Password: ***
7353</screen>
74− With <command>nixos-container run</command>, you can execute arbitrary
75− commands in the container:
54+ With <command>nixos-container run</command>, you can execute arbitrary commands in the container:
7655<screen>
7756# nixos-container run foo -- uname -a
7857Linux foo 3.4.82 #1-NixOS SMP Thu Mar 20 14:44:05 UTC 2014 x86_64 GNU/Linux
@@ -80,15 +59,11 @@ Linux foo 3.4.82 #1-NixOS SMP Thu Mar 20 14:44:05 UTC 2014 x86_64 GNU/Linux
8059 </para>
8160
8261 <para>
83− There are several ways to change the configuration of the container. First,
84− on the host, you can edit
85− <literal>/var/lib/container/<replaceable>name</replaceable>/etc/nixos/configuration.nix</literal>,
86− and run
62+ There are several ways to change the configuration of the container. First, on the host, you can edit <literal>/var/lib/container/<replaceable>name</replaceable>/etc/nixos/configuration.nix</literal>, and run
8763<screen>
8864# nixos-container update foo
8965</screen>
90− This will build and activate the new configuration. You can also specify a
91− new configuration on the command line:
66+ This will build and activate the new configuration. You can also specify a new configuration on the command line:
9267<screen>
9368# nixos-container update foo --config '
9469 <xref linkend="opt-services.httpd.enable"/> = true;
@@ -99,23 +74,15 @@ Linux foo 3.4.82 #1-NixOS SMP Thu Mar 20 14:44:05 UTC 2014 x86_64 GNU/Linux
9974# curl http://$(nixos-container show-ip foo)/
10075&lt;!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 3.2 Final//EN">…
10176</screen>
102− However, note that this will overwrite the container’s
103− <filename>/etc/nixos/configuration.nix</filename>.
77+ However, note that this will overwrite the container’s <filename>/etc/nixos/configuration.nix</filename>.
10478 </para>
10579
10680 <para>
107− Alternatively, you can change the configuration from within the container
108− itself by running <command>nixos-rebuild switch</command> inside the
109− container. Note that the container by default does not have a copy of the
110− NixOS channel, so you should run <command>nix-channel --update</command>
111− first.
81+ Alternatively, you can change the configuration from within the container itself by running <command>nixos-rebuild switch</command> inside the container. Note that the container by default does not have a copy of the NixOS channel, so you should run <command>nix-channel --update</command> first.
11282 </para>
11383
11484 <para>
115− Containers can be stopped and started using <literal>nixos-container
116− stop</literal> and <literal>nixos-container start</literal>, respectively, or
117− by using <command>systemctl</command> on the container’s service unit. To
118− destroy a container, including its file system, do
85+ Containers can be stopped and started using <literal>nixos-container stop</literal> and <literal>nixos-container start</literal>, respectively, or by using <command>systemctl</command> on the container’s service unit. To destroy a container, including its file system, do
11986<screen>
12087# nixos-container destroy foo
12188</screen>
nixos/doc/manual/administration/logging.xml+4−15
@@ -5,18 +5,11 @@
55 xml:id="sec-logging">
66 <title>Logging</title>
77 <para>
8− System-wide logging is provided by systemd’s <emphasis>journal</emphasis>,
9− which subsumes traditional logging daemons such as syslogd and klogd. Log
10− entries are kept in binary files in <filename>/var/log/journal/</filename>.
11− The command <literal>journalctl</literal> allows you to see the contents of
12− the journal. For example,
8+ System-wide logging is provided by systemd’s <emphasis>journal</emphasis>, which subsumes traditional logging daemons such as syslogd and klogd. Log entries are kept in binary files in <filename>/var/log/journal/</filename>. The command <literal>journalctl</literal> allows you to see the contents of the journal. For example,
139<screen>
1410<prompt>$ </prompt>journalctl -b
1511</screen>
16− shows all journal entries since the last reboot. (The output of
17− <command>journalctl</command> is piped into <command>less</command> by
18− default.) You can use various options and match operators to restrict output
19− to messages of interest. For instance, to get all messages from PostgreSQL:
12+ shows all journal entries since the last reboot. (The output of <command>journalctl</command> is piped into <command>less</command> by default.) You can use various options and match operators to restrict output to messages of interest. For instance, to get all messages from PostgreSQL:
2013<screen>
2114<prompt>$ </prompt>journalctl -u postgresql.service
2215-- Logs begin at Mon, 2013-01-07 13:28:01 CET, end at Tue, 2013-01-08 01:09:57 CET. --
@@ -26,8 +19,7 @@ Jan 07 15:44:14 hagbard postgres[2681]: [2-1] LOG: database system is shut down
2619Jan 07 15:45:10 hagbard postgres[2532]: [1-1] LOG: database system was shut down at 2013-01-07 15:44:14 CET
2720Jan 07 15:45:13 hagbard postgres[2500]: [1-1] LOG: database system is ready to accept connections
2821</screen>
29− Or to get all messages since the last reboot that have at least a
30− “critical” severity level:
22+ Or to get all messages since the last reboot that have at least a “critical” severity level:
3123<screen>
3224<prompt>$ </prompt>journalctl -b -p crit
3325Dec 17 21:08:06 mandark sudo[3673]: pam_unix(sudo:auth): auth could not identify password for [alice]
@@ -35,9 +27,6 @@ Dec 29 01:30:22 mandark kernel[6131]: [1053513.909444] CPU6: Core temperature ab
3527</screen>
3628 </para>
3729 <para>
38− The system journal is readable by root and by users in the
39− <literal>wheel</literal> and <literal>systemd-journal</literal> groups. All
40− users have a private journal that can be read using
41− <command>journalctl</command>.
30+ The system journal is readable by root and by users in the <literal>wheel</literal> and <literal>systemd-journal</literal> groups. All users have a private journal that can be read using <command>journalctl</command>.
4231 </para>
4332</chapter>
nixos/doc/manual/administration/maintenance-mode.xml+1−3
@@ -9,8 +9,6 @@
99 You can enter rescue mode by running:
1010<screen>
1111# systemctl rescue</screen>
12− This will eventually give you a single-user root shell. Systemd will stop
13− (almost) all system services. To get out of maintenance mode, just exit from
14− the rescue shell.
12+ This will eventually give you a single-user root shell. Systemd will stop (almost) all system services. To get out of maintenance mode, just exit from the rescue shell.
1513 </para>
1614</section>
nixos/doc/manual/administration/network-problems.xml+2−11
@@ -6,20 +6,11 @@
66 <title>Network Problems</title>
77
88 <para>
9− Nix uses a so-called <emphasis>binary cache</emphasis> to optimise building a
10− package from source into downloading it as a pre-built binary. That is,
11− whenever a command like <command>nixos-rebuild</command> needs a path in the
12− Nix store, Nix will try to download that path from the Internet rather than
13− build it from source. The default binary cache is
14− <uri>https://cache.nixos.org/</uri>. If this cache is unreachable, Nix
15− operations may take a long time due to HTTP connection timeouts. You can
16− disable the use of the binary cache by adding <option>--option
17− use-binary-caches false</option>, e.g.
9+ Nix uses a so-called <emphasis>binary cache</emphasis> to optimise building a package from source into downloading it as a pre-built binary. That is, whenever a command like <command>nixos-rebuild</command> needs a path in the Nix store, Nix will try to download that path from the Internet rather than build it from source. The default binary cache is <uri>https://cache.nixos.org/</uri>. If this cache is unreachable, Nix operations may take a long time due to HTTP connection timeouts. You can disable the use of the binary cache by adding <option>--option use-binary-caches false</option>, e.g.
1810<screen>
1911# nixos-rebuild switch --option use-binary-caches false
2012</screen>
21− If you have an alternative binary cache at your disposal, you can use it
22− instead:
13+ If you have an alternative binary cache at your disposal, you can use it instead:
2314<screen>
2415# nixos-rebuild switch --option binary-caches http://my-cache.example.org/
2516</screen>
nixos/doc/manual/administration/rebooting.xml+3−8
@@ -16,20 +16,15 @@
1616<screen>
1717# reboot
1818</screen>
19− which is equivalent to <command>systemctl reboot</command>. Alternatively,
20− you can quickly reboot the system using <literal>kexec</literal>, which
21− bypasses the BIOS by directly loading the new kernel into memory:
19+ which is equivalent to <command>systemctl reboot</command>. Alternatively, you can quickly reboot the system using <literal>kexec</literal>, which bypasses the BIOS by directly loading the new kernel into memory:
2220<screen>
2321# systemctl kexec
2422</screen>
2523 </para>
2624 <para>
27− The machine can be suspended to RAM (if supported) using <command>systemctl
28− suspend</command>, and suspended to disk using <command>systemctl
29− hibernate</command>.
25+ The machine can be suspended to RAM (if supported) using <command>systemctl suspend</command>, and suspended to disk using <command>systemctl hibernate</command>.
3026 </para>
3127 <para>
32− These commands can be run by any user who is logged in locally, i.e. on a
33− virtual console or in X11; otherwise, the user is asked for authentication.
28+ These commands can be run by any user who is logged in locally, i.e. on a virtual console or in X11; otherwise, the user is asked for authentication.
3429 </para>
3530</chapter>
nixos/doc/manual/administration/rollback.xml+3−12
@@ -6,19 +6,11 @@
66 <title>Rolling Back Configuration Changes</title>
77
88 <para>
9− After running <command>nixos-rebuild</command> to switch to a new
10− configuration, you may find that the new configuration doesn’t work very
11− well. In that case, there are several ways to return to a previous
12− configuration.
9+ After running <command>nixos-rebuild</command> to switch to a new configuration, you may find that the new configuration doesn’t work very well. In that case, there are several ways to return to a previous configuration.
1310 </para>
1411
1512 <para>
16− First, the GRUB boot manager allows you to boot into any previous
17− configuration that hasn’t been garbage-collected. These configurations can
18− be found under the GRUB submenu “NixOS - All configurations”. This is
19− especially useful if the new configuration fails to boot. After the system
20− has booted, you can make the selected configuration the default for
21− subsequent boots:
13+ First, the GRUB boot manager allows you to boot into any previous configuration that hasn’t been garbage-collected. These configurations can be found under the GRUB submenu “NixOS - All configurations”. This is especially useful if the new configuration fails to boot. After the system has booted, you can make the selected configuration the default for subsequent boots:
2214<screen>
2315# /run/current-system/bin/switch-to-configuration boot</screen>
2416 </para>
@@ -30,8 +22,7 @@
3022 This is equivalent to running:
3123<screen>
3224# /nix/var/nix/profiles/system-<replaceable>N</replaceable>-link/bin/switch-to-configuration switch</screen>
33− where <replaceable>N</replaceable> is the number of the NixOS system
34− configuration. To get a list of the available configurations, do:
25+ where <replaceable>N</replaceable> is the number of the NixOS system configuration. To get a list of the available configurations, do:
3526<screen>
3627<prompt>$ </prompt>ls -l /nix/var/nix/profiles/system-*-link
3728<replaceable>...</replaceable>
nixos/doc/manual/administration/running.xml+1−2
@@ -6,8 +6,7 @@
66 <title>Administration</title>
77 <partintro xml:id="ch-running-intro">
88 <para>
9− This chapter describes various aspects of managing a running NixOS system,
10− such as how to use the <command>systemd</command> service manager.
9+ This chapter describes various aspects of managing a running NixOS system, such as how to use the <command>systemd</command> service manager.
1110 </para>
1211 </partintro>
1312 <xi:include href="service-mgmt.xml" />
nixos/doc/manual/administration/service-mgmt.xml+5−21
@@ -5,21 +5,10 @@
55 xml:id="sec-systemctl">
66 <title>Service Management</title>
77 <para>
8− In NixOS, all system services are started and monitored using the systemd
9− program. Systemd is the “init” process of the system (i.e. PID 1), the
10− parent of all other processes. It manages a set of so-called “units”,
11− which can be things like system services (programs), but also mount points,
12− swap files, devices, targets (groups of units) and more. Units can have
13− complex dependencies; for instance, one unit can require that another unit
14− must be successfully started before the first unit can be started. When the
15− system boots, it starts a unit named <literal>default.target</literal>; the
16− dependencies of this unit cause all system services to be started, file
17− systems to be mounted, swap files to be activated, and so on.
8+ In NixOS, all system services are started and monitored using the systemd program. Systemd is the “init” process of the system (i.e. PID 1), the parent of all other processes. It manages a set of so-called “units”, which can be things like system services (programs), but also mount points, swap files, devices, targets (groups of units) and more. Units can have complex dependencies; for instance, one unit can require that another unit must be successfully started before the first unit can be started. When the system boots, it starts a unit named <literal>default.target</literal>; the dependencies of this unit cause all system services to be started, file systems to be mounted, swap files to be activated, and so on.
189 </para>
1910 <para>
20− The command <command>systemctl</command> is the main way to interact with
21− <command>systemd</command>. Without any arguments, it shows the status of
22− active units:
11+ The command <command>systemctl</command> is the main way to interact with <command>systemd</command>. Without any arguments, it shows the status of active units:
2312<screen>
2413<prompt>$ </prompt>systemctl
2514-.mount loaded active mounted /
@@ -30,8 +19,7 @@ graphical.target loaded active active Graphical Interface
3019</screen>
3120 </para>
3221 <para>
33− You can ask for detailed status information about a unit, for instance, the
34− PostgreSQL database service:
22+ You can ask for detailed status information about a unit, for instance, the PostgreSQL database service:
3523<screen>
3624<prompt>$ </prompt>systemctl status postgresql.service
3725postgresql.service - PostgreSQL Server
@@ -51,9 +39,7 @@ Jan 07 15:55:57 hagbard postgres[2390]: [1-1] LOG: database system is ready to
5139Jan 07 15:55:57 hagbard postgres[2420]: [1-1] LOG: autovacuum launcher started
5240Jan 07 15:55:57 hagbard systemd[1]: Started PostgreSQL Server.
5341</screen>
54− Note that this shows the status of the unit (active and running), all the
55− processes belonging to the service, as well as the most recent log messages
56− from the service.
42+ Note that this shows the status of the unit (active and running), all the processes belonging to the service, as well as the most recent log messages from the service.
5743 </para>
5844 <para>
5945 Units can be stopped, started or restarted:
@@ -62,9 +48,7 @@ Jan 07 15:55:57 hagbard systemd[1]: Started PostgreSQL Server.
6248# systemctl start postgresql.service
6349# systemctl restart postgresql.service
6450</screen>
65− These operations are synchronous: they wait until the service has finished
66− starting or stopping (or has failed). Starting a unit will cause the
67− dependencies of that unit to be started as well (if necessary).
51+ These operations are synchronous: they wait until the service has finished starting or stopping (or has failed). Starting a unit will cause the dependencies of that unit to be started as well (if necessary).
6852 </para>
6953<!-- - cgroups: each service and user session is a cgroup
7054
nixos/doc/manual/administration/store-corruption.xml+4−13
@@ -6,23 +6,15 @@
66 <title>Nix Store Corruption</title>
77
88 <para>
9− After a system crash, it’s possible for files in the Nix store to become
10− corrupted. (For instance, the Ext4 file system has the tendency to replace
11− un-synced files with zero bytes.) NixOS tries hard to prevent this from
12− happening: it performs a <command>sync</command> before switching to a new
13− configuration, and Nix’s database is fully transactional. If corruption
14− still occurs, you may be able to fix it automatically.
9+ After a system crash, it’s possible for files in the Nix store to become corrupted. (For instance, the Ext4 file system has the tendency to replace un-synced files with zero bytes.) NixOS tries hard to prevent this from happening: it performs a <command>sync</command> before switching to a new configuration, and Nix’s database is fully transactional. If corruption still occurs, you may be able to fix it automatically.
1510 </para>
1611
1712 <para>
18− If the corruption is in a path in the closure of the NixOS system
19− configuration, you can fix it by doing
13+ If the corruption is in a path in the closure of the NixOS system configuration, you can fix it by doing
2014<screen>
2115<prompt># </prompt>nixos-rebuild switch --repair
2216</screen>
23− This will cause Nix to check every path in the closure, and if its
24− cryptographic hash differs from the hash recorded in Nix’s database, the
25− path is rebuilt or redownloaded.
17+ This will cause Nix to check every path in the closure, and if its cryptographic hash differs from the hash recorded in Nix’s database, the path is rebuilt or redownloaded.
2618 </para>
2719
2820 <para>
@@ -30,7 +22,6 @@
3022<screen>
3123<prompt># </prompt>nix-store --verify --check-contents --repair
3224</screen>
33− Any corrupt paths will be redownloaded if they’re available in a binary
34− cache; otherwise, they cannot be repaired.
25+ Any corrupt paths will be redownloaded if they’re available in a binary cache; otherwise, they cannot be repaired.
3526 </para>
3627</section>
nixos/doc/manual/administration/troubleshooting.xml+1−2
@@ -5,8 +5,7 @@
55 xml:id="ch-troubleshooting">
66 <title>Troubleshooting</title>
77 <para>
8− This chapter describes solutions to common problems you might encounter when
9− you manage your NixOS system.
8+ This chapter describes solutions to common problems you might encounter when you manage your NixOS system.
109 </para>
1110 <xi:include href="boot-problems.xml" />
1211 <xi:include href="maintenance-mode.xml" />
nixos/doc/manual/administration/user-sessions.xml+3−12
@@ -5,10 +5,7 @@
55 xml:id="sec-user-sessions">
66 <title>User Sessions</title>
77 <para>
8− Systemd keeps track of all users who are logged into the system (e.g. on a
9− virtual console or remotely via SSH). The command <command>loginctl</command>
10− allows querying and manipulating user sessions. For instance, to list all
11− user sessions:
8+ Systemd keeps track of all users who are logged into the system (e.g. on a virtual console or remotely via SSH). The command <command>loginctl</command> allows querying and manipulating user sessions. For instance, to list all user sessions:
129<screen>
1310<prompt>$ </prompt>loginctl
1411 SESSION UID USER SEAT
@@ -16,10 +13,7 @@
1613 c3 0 root seat0
1714 c4 500 alice
1815</screen>
19− This shows that two users are logged in locally, while another is logged in
20− remotely. (“Seats” are essentially the combinations of displays and input
21− devices attached to the system; usually, there is only one seat.) To get
22− information about a session:
16+ This shows that two users are logged in locally, while another is logged in remotely. (“Seats” are essentially the combinations of displays and input devices attached to the system; usually, there is only one seat.) To get information about a session:
2317<screen>
2418<prompt>$ </prompt>loginctl session-status c3
2519c3 - root (0)
@@ -34,10 +28,7 @@ c3 - root (0)
3428 ├─10339 -bash
3529 └─10355 w3m nixos.org
3630</screen>
37− This shows that the user is logged in on virtual console 3. It also lists the
38− processes belonging to this session. Since systemd keeps track of this, you
39− can terminate a session in a way that ensures that all the session’s
40− processes are gone:
31+ This shows that the user is logged in on virtual console 3. It also lists the processes belonging to this session. Since systemd keeps track of this, you can terminate a session in a way that ensures that all the session’s processes are gone:
4132<screen>
4233# loginctl terminate-session c3
4334</screen>
nixos/doc/manual/configuration/abstractions.xml+12−36
@@ -6,8 +6,7 @@
66 <title>Abstractions</title>
77
88 <para>
9− If you find yourself repeating yourself over and over, it’s time to
10− abstract. Take, for instance, this Apache HTTP Server configuration:
9+ If you find yourself repeating yourself over and over, it’s time to abstract. Take, for instance, this Apache HTTP Server configuration:
1110<programlisting>
1211{
1312 <xref linkend="opt-services.httpd.virtualHosts"/> =
@@ -27,9 +26,7 @@
2726 ];
2827}
2928</programlisting>
30− It defines two virtual hosts with nearly identical configuration; the only
31− difference is that the second one has SSL enabled. To prevent this
32− duplication, we can use a <literal>let</literal>:
29+ It defines two virtual hosts with nearly identical configuration; the only difference is that the second one has SSL enabled. To prevent this duplication, we can use a <literal>let</literal>:
3330<programlisting>
3431let
3532 exampleOrgCommon =
@@ -50,16 +47,11 @@ in
5047 ];
5148}
5249</programlisting>
53− The <literal>let exampleOrgCommon = <replaceable>...</replaceable></literal>
54− defines a variable named <literal>exampleOrgCommon</literal>. The
55− <literal>//</literal> operator merges two attribute sets, so the
56− configuration of the second virtual host is the set
57− <literal>exampleOrgCommon</literal> extended with the SSL options.
50+ The <literal>let exampleOrgCommon = <replaceable>...</replaceable></literal> defines a variable named <literal>exampleOrgCommon</literal>. The <literal>//</literal> operator merges two attribute sets, so the configuration of the second virtual host is the set <literal>exampleOrgCommon</literal> extended with the SSL options.
5851 </para>
5952
6053 <para>
61− You can write a <literal>let</literal> wherever an expression is allowed.
62− Thus, you also could have written:
54+ You can write a <literal>let</literal> wherever an expression is allowed. Thus, you also could have written:
6355<programlisting>
6456{
6557 <xref linkend="opt-services.httpd.virtualHosts"/> =
@@ -69,16 +61,11 @@ in
6961 ];
7062}
7163</programlisting>
72− but not <literal>{ let exampleOrgCommon = <replaceable>...</replaceable>; in
73− <replaceable>...</replaceable>; }</literal> since attributes (as opposed to
74− attribute values) are not expressions.
64+ but not <literal>{ let exampleOrgCommon = <replaceable>...</replaceable>; in <replaceable>...</replaceable>; }</literal> since attributes (as opposed to attribute values) are not expressions.
7565 </para>
7666
7767 <para>
78− <emphasis>Functions</emphasis> provide another method of abstraction. For
79− instance, suppose that we want to generate lots of different virtual hosts,
80− all with identical configuration except for the host name. This can be done
81− as follows:
68+ <emphasis>Functions</emphasis> provide another method of abstraction. For instance, suppose that we want to generate lots of different virtual hosts, all with identical configuration except for the host name. This can be done as follows:
8269<programlisting>
8370{
8471 <xref linkend="opt-services.httpd.virtualHosts"/> =
@@ -96,15 +83,11 @@ in
9683 ];
9784}
9885</programlisting>
99− Here, <varname>makeVirtualHost</varname> is a function that takes a single
100− argument <literal>name</literal> and returns the configuration for a virtual
101− host. That function is then called for several names to produce the list of
102− virtual host configurations.
86+ Here, <varname>makeVirtualHost</varname> is a function that takes a single argument <literal>name</literal> and returns the configuration for a virtual host. That function is then called for several names to produce the list of virtual host configurations.
10387 </para>
10488
10589 <para>
106− We can further improve on this by using the function <varname>map</varname>,
107− which applies another function to every element in a list:
90+ We can further improve on this by using the function <varname>map</varname>, which applies another function to every element in a list:
10891<programlisting>
10992{
11093 <xref linkend="opt-services.httpd.virtualHosts"/> =
@@ -114,15 +97,11 @@ in
11497 [ "example.org" "example.com" "example.gov" "example.nl" ];
11598}
11699</programlisting>
117− (The function <literal>map</literal> is called a <emphasis>higher-order
118− function</emphasis> because it takes another function as an argument.)
100+ (The function <literal>map</literal> is called a <emphasis>higher-order function</emphasis> because it takes another function as an argument.)
119101 </para>
120102
121103 <para>
122− What if you need more than one argument, for instance, if we want to use a
123− different <literal>documentRoot</literal> for each virtual host? Then we can
124− make <varname>makeVirtualHost</varname> a function that takes a
125− <emphasis>set</emphasis> as its argument, like this:
104+ What if you need more than one argument, for instance, if we want to use a different <literal>documentRoot</literal> for each virtual host? Then we can make <varname>makeVirtualHost</varname> a function that takes a <emphasis>set</emphasis> as its argument, like this:
126105<programlisting>
127106{
128107 <xref linkend="opt-services.httpd.virtualHosts"/> =
@@ -140,9 +119,7 @@ in
140119 ];
141120}
142121</programlisting>
143− But in this case (where every root is a subdirectory of
144− <filename>/sites</filename> named after the virtual host), it would have been
145− shorter to define <varname>makeVirtualHost</varname> as
122+ But in this case (where every root is a subdirectory of <filename>/sites</filename> named after the virtual host), it would have been shorter to define <varname>makeVirtualHost</varname> as
146123<programlisting>
147124makeVirtualHost = name:
148125 { hostName = name;
@@ -150,7 +127,6 @@ makeVirtualHost = name:
150127 adminAddr = "alice@example.org";
151128 };
152129</programlisting>
153− Here, the construct <literal>${<replaceable>...</replaceable>}</literal>
154− allows the result of an expression to be spliced into a string.
130+ Here, the construct <literal>${<replaceable>...</replaceable>}</literal> allows the result of an expression to be spliced into a string.
155131 </para>
156132</section>
nixos/doc/manual/configuration/ad-hoc-network-config.xml+1−4
@@ -6,10 +6,7 @@
66 <title>Ad-Hoc Configuration</title>
77
88 <para>
9− You can use <xref linkend="opt-networking.localCommands"/> to specify shell
10− commands to be run at the end of <literal>network-setup.service</literal>.
11− This is useful for doing network configuration not covered by the existing
12− NixOS modules. For instance, to statically configure an IPv6 address:
9+ You can use <xref linkend="opt-networking.localCommands"/> to specify shell commands to be run at the end of <literal>network-setup.service</literal>. This is useful for doing network configuration not covered by the existing NixOS modules. For instance, to statically configure an IPv6 address:
1310<programlisting>
1411<xref linkend="opt-networking.localCommands"/> =
1512 ''
nixos/doc/manual/configuration/ad-hoc-packages.xml+5−21
@@ -6,33 +6,18 @@
66 <title>Ad-Hoc Package Management</title>
77
88 <para>
9− With the command <command>nix-env</command>, you can install and uninstall
10− packages from the command line. For instance, to install Mozilla Thunderbird:
9+ With the command <command>nix-env</command>, you can install and uninstall packages from the command line. For instance, to install Mozilla Thunderbird:
1110<screen>
1211<prompt>$ </prompt>nix-env -iA nixos.thunderbird</screen>
13− If you invoke this as root, the package is installed in the Nix profile
14− <filename>/nix/var/nix/profiles/default</filename> and visible to all users
15− of the system; otherwise, the package ends up in
16− <filename>/nix/var/nix/profiles/per-user/<replaceable>username</replaceable>/profile</filename>
17− and is not visible to other users. The <option>-A</option> flag specifies the
18− package by its attribute name; without it, the package is installed by
19− matching against its package name (e.g. <literal>thunderbird</literal>). The
20− latter is slower because it requires matching against all available Nix
21− packages, and is ambiguous if there are multiple matching packages.
12+ If you invoke this as root, the package is installed in the Nix profile <filename>/nix/var/nix/profiles/default</filename> and visible to all users of the system; otherwise, the package ends up in <filename>/nix/var/nix/profiles/per-user/<replaceable>username</replaceable>/profile</filename> and is not visible to other users. The <option>-A</option> flag specifies the package by its attribute name; without it, the package is installed by matching against its package name (e.g. <literal>thunderbird</literal>). The latter is slower because it requires matching against all available Nix packages, and is ambiguous if there are multiple matching packages.
2213 </para>
2314
2415 <para>
25− Packages come from the NixOS channel. You typically upgrade a package by
26− updating to the latest version of the NixOS channel:
16+ Packages come from the NixOS channel. You typically upgrade a package by updating to the latest version of the NixOS channel:
2717<screen>
2818<prompt>$ </prompt>nix-channel --update nixos
2919</screen>
30− and then running <literal>nix-env -i</literal> again. Other packages in the
31− profile are <emphasis>not</emphasis> affected; this is the crucial difference
32− with the declarative style of package management, where running
33− <command>nixos-rebuild switch</command> causes all packages to be updated to
34− their current versions in the NixOS channel. You can however upgrade all
35− packages for which there is a newer version by doing:
20+ and then running <literal>nix-env -i</literal> again. Other packages in the profile are <emphasis>not</emphasis> affected; this is the crucial difference with the declarative style of package management, where running <command>nixos-rebuild switch</command> causes all packages to be updated to their current versions in the NixOS channel. You can however upgrade all packages for which there is a newer version by doing:
3621<screen>
3722<prompt>$ </prompt>nix-env -u '*'
3823</screen>
@@ -53,8 +38,7 @@
5338 </para>
5439
5540 <para>
56− <command>nix-env</command> has many more flags. For details, see the
57− <citerefentry>
41+ <command>nix-env</command> has many more flags. For details, see the <citerefentry>
5842 <refentrytitle>nix-env</refentrytitle>
5943 <manvolnum>1</manvolnum></citerefentry> manpage or the Nix manual.
6044 </para>
nixos/doc/manual/configuration/adding-custom-packages.xml+6−17
@@ -6,33 +6,23 @@
66 <title>Adding Custom Packages</title>
77
88 <para>
9− It’s possible that a package you need is not available in NixOS. In that
10− case, you can do two things. First, you can clone the Nixpkgs repository, add
11− the package to your clone, and (optionally) submit a patch or pull request to
12− have it accepted into the main Nixpkgs repository. This is described in
13− detail in the <link
14−xlink:href="http://nixos.org/nixpkgs/manual">Nixpkgs
15− manual</link>. In short, you clone Nixpkgs:
9+ It’s possible that a package you need is not available in NixOS. In that case, you can do two things. First, you can clone the Nixpkgs repository, add the package to your clone, and (optionally) submit a patch or pull request to have it accepted into the main Nixpkgs repository. This is described in detail in the <link
10+xlink:href="http://nixos.org/nixpkgs/manual">Nixpkgs manual</link>. In short, you clone Nixpkgs:
1611<screen>
1712<prompt>$ </prompt>git clone https://github.com/NixOS/nixpkgs
1813<prompt>$ </prompt>cd nixpkgs
1914</screen>
20− Then you write and test the package as described in the Nixpkgs manual.
21− Finally, you add it to <literal>environment.systemPackages</literal>, e.g.
15+ Then you write and test the package as described in the Nixpkgs manual. Finally, you add it to <literal>environment.systemPackages</literal>, e.g.
2216<programlisting>
2317<xref linkend="opt-environment.systemPackages"/> = [ pkgs.my-package ];
2418</programlisting>
25− and you run <command>nixos-rebuild</command>, specifying your own Nixpkgs
26− tree:
19+ and you run <command>nixos-rebuild</command>, specifying your own Nixpkgs tree:
2720<screen>
2821# nixos-rebuild switch -I nixpkgs=/path/to/my/nixpkgs</screen>
2922 </para>
3023
3124 <para>
32− The second possibility is to add the package outside of the Nixpkgs tree. For
33− instance, here is how you specify a build of the
34− <link xlink:href="https://www.gnu.org/software/hello/">GNU Hello</link>
35− package directly in <filename>configuration.nix</filename>:
25+ The second possibility is to add the package outside of the Nixpkgs tree. For instance, here is how you specify a build of the <link xlink:href="https://www.gnu.org/software/hello/">GNU Hello</link> package directly in <filename>configuration.nix</filename>:
3626<programlisting>
3727<xref linkend="opt-environment.systemPackages"/> =
3828 let
@@ -46,8 +36,7 @@ xlink:href="http://nixos.org/nixpkgs/manual">Nixpkgs
4636 in
4737 [ my-hello ];
4838</programlisting>
49− Of course, you can also move the definition of <literal>my-hello</literal>
50− into a separate Nix expression, e.g.
39+ Of course, you can also move the definition of <literal>my-hello</literal> into a separate Nix expression, e.g.
5140<programlisting>
5241<xref linkend="opt-environment.systemPackages"/> = [ (import ./my-hello.nix) ];
5342</programlisting>
nixos/doc/manual/configuration/config-file.xml+14−57
@@ -13,15 +13,7 @@
1313{ <replaceable>option definitions</replaceable>
1414}
1515</programlisting>
16− The first line (<literal>{ config, pkgs, ... }:</literal>) denotes that this
17− is actually a function that takes at least the two arguments
18− <varname>config</varname> and <varname>pkgs</varname>. (These are explained
19− later.) The function returns a <emphasis>set</emphasis> of option definitions
20− (<literal>{ <replaceable>...</replaceable> }</literal>). These definitions
21− have the form <literal><replaceable>name</replaceable> =
22− <replaceable>value</replaceable></literal>, where
23− <replaceable>name</replaceable> is the name of an option and
24− <replaceable>value</replaceable> is its value. For example,
16+ The first line (<literal>{ config, pkgs, ... }:</literal>) denotes that this is actually a function that takes at least the two arguments <varname>config</varname> and <varname>pkgs</varname>. (These are explained later.) The function returns a <emphasis>set</emphasis> of option definitions (<literal>{ <replaceable>...</replaceable> }</literal>). These definitions have the form <literal><replaceable>name</replaceable> = <replaceable>value</replaceable></literal>, where <replaceable>name</replaceable> is the name of an option and <replaceable>value</replaceable> is its value. For example,
2517<programlisting>
2618{ config, pkgs, ... }:
2719
@@ -30,19 +22,11 @@
3022 <xref linkend="opt-services.httpd.documentRoot"/> = "/webroot";
3123}
3224</programlisting>
33− defines a configuration with three option definitions that together enable
34− the Apache HTTP Server with <filename>/webroot</filename> as the document
35− root.
25+ defines a configuration with three option definitions that together enable the Apache HTTP Server with <filename>/webroot</filename> as the document root.
3626 </para>
3727
3828 <para>
39− Sets can be nested, and in fact dots in option names are shorthand for
40− defining a set containing another set. For instance,
41− <xref linkend="opt-services.httpd.enable"/> defines a set named
42− <varname>services</varname> that contains a set named
43− <varname>httpd</varname>, which in turn contains an option definition named
44− <varname>enable</varname> with value <literal>true</literal>. This means that
45− the example above can also be written as:
29+ Sets can be nested, and in fact dots in option names are shorthand for defining a set containing another set. For instance, <xref linkend="opt-services.httpd.enable"/> defines a set named <varname>services</varname> that contains a set named <varname>httpd</varname>, which in turn contains an option definition named <varname>enable</varname> with value <literal>true</literal>. This means that the example above can also be written as:
4630<programlisting>
4731{ config, pkgs, ... }:
4832
@@ -55,22 +39,15 @@
5539 };
5640}
5741</programlisting>
58− which may be more convenient if you have lots of option definitions that
59− share the same prefix (such as <literal>services.httpd</literal>).
42+ which may be more convenient if you have lots of option definitions that share the same prefix (such as <literal>services.httpd</literal>).
6043 </para>
6144
6245 <para>
63− NixOS checks your option definitions for correctness. For instance, if you
64− try to define an option that doesn’t exist (that is, doesn’t have a
65− corresponding <emphasis>option declaration</emphasis>),
66− <command>nixos-rebuild</command> will give an error like:
46+ NixOS checks your option definitions for correctness. For instance, if you try to define an option that doesn’t exist (that is, doesn’t have a corresponding <emphasis>option declaration</emphasis>), <command>nixos-rebuild</command> will give an error like:
6747<screen>
6848The option `services.httpd.enable' defined in `/etc/nixos/configuration.nix' does not exist.
6949</screen>
70− Likewise, values in option definitions must have a correct type. For
71− instance, <option>services.httpd.enable</option> must be a Boolean
72− (<literal>true</literal> or <literal>false</literal>). Trying to give it a
73− value of another type, such as a string, will cause an error:
50+ Likewise, values in option definitions must have a correct type. For instance, <option>services.httpd.enable</option> must be a Boolean (<literal>true</literal> or <literal>false</literal>). Trying to give it a value of another type, such as a string, will cause an error:
7451<screen>
7552The option value `services.httpd.enable' in `/etc/nixos/configuration.nix' is not a boolean.
7653</screen>
@@ -89,12 +66,10 @@ The option value `services.httpd.enable' in `/etc/nixos/configuration.nix' is no
8966<programlisting>
9067<xref linkend="opt-networking.hostName"/> = "dexter";
9168</programlisting>
92− Special characters can be escaped by prefixing them with a backslash
93− (e.g. <literal>\"</literal>).
69+ Special characters can be escaped by prefixing them with a backslash (e.g. <literal>\"</literal>).
9470 </para>
9571 <para>
96− Multi-line strings can be enclosed in <emphasis>double single
97− quotes</emphasis>, e.g.
72+ Multi-line strings can be enclosed in <emphasis>double single quotes</emphasis>, e.g.
9873<programlisting>
9974<xref linkend="opt-networking.extraHosts"/> =
10075 ''
@@ -102,13 +77,7 @@ The option value `services.httpd.enable' in `/etc/nixos/configuration.nix' is no
10277 10.0.0.1 server
10378 '';
10479</programlisting>
105− The main difference is that it strips from each line a number of spaces
106− equal to the minimal indentation of the string as a whole (disregarding
107− the indentation of empty lines), and that characters like
108− <literal>"</literal> and <literal>\</literal> are not special (making it
109− more convenient for including things like shell code). See more info
110− about this in the Nix manual
111− <link
80+ The main difference is that it strips from each line a number of spaces equal to the minimal indentation of the string as a whole (disregarding the indentation of empty lines), and that characters like <literal>"</literal> and <literal>\</literal> are not special (making it more convenient for including things like shell code). See more info about this in the Nix manual <link
11281 xlink:href="https://nixos.org/nix/manual/#ssec-values">here</link>.
11382 </para>
11483 </listitem>
@@ -137,12 +106,7 @@ The option value `services.httpd.enable' in `/etc/nixos/configuration.nix' is no
137106<programlisting>
138107<xref linkend="opt-boot.kernel.sysctl"/>."net.ipv4.tcp_keepalive_time" = 60;
139108</programlisting>
140− (Note that here the attribute name
141− <literal>net.ipv4.tcp_keepalive_time</literal> is enclosed in quotes to
142− prevent it from being interpreted as a set named <literal>net</literal>
143− containing a set named <literal>ipv4</literal>, and so on. This is
144− because it’s not a NixOS option but the literal name of a Linux kernel
145− setting.)
109+ (Note that here the attribute name <literal>net.ipv4.tcp_keepalive_time</literal> is enclosed in quotes to prevent it from being interpreted as a set named <literal>net</literal> containing a set named <literal>ipv4</literal>, and so on. This is because it’s not a NixOS option but the literal name of a Linux kernel setting.)
146110 </para>
147111 </listitem>
148112 </varlistentry>
@@ -152,8 +116,7 @@ The option value `services.httpd.enable' in `/etc/nixos/configuration.nix' is no
152116 </term>
153117 <listitem>
154118 <para>
155− Sets were introduced above. They are name/value pairs enclosed in braces,
156− as in the option definition
119+ Sets were introduced above. They are name/value pairs enclosed in braces, as in the option definition
157120<programlisting>
158121<xref linkend="opt-fileSystems"/>."/boot" =
159122 { device = "/dev/sda1";
@@ -170,8 +133,7 @@ The option value `services.httpd.enable' in `/etc/nixos/configuration.nix' is no
170133 </term>
171134 <listitem>
172135 <para>
173− The important thing to note about lists is that list elements are
174− separated by whitespace, like this:
136+ The important thing to note about lists is that list elements are separated by whitespace, like this:
175137<programlisting>
176138<xref linkend="opt-boot.kernelModules"/> = [ "fuse" "kvm-intel" "coretemp" ];
177139</programlisting>
@@ -188,9 +150,7 @@ swapDevices = [ { device = "/dev/disk/by-label/swap"; } ];
188150 </term>
189151 <listitem>
190152 <para>
191− Usually, the packages you need are already part of the Nix Packages
192− collection, which is a set that can be accessed through the function
193− argument <varname>pkgs</varname>. Typical uses:
153+ Usually, the packages you need are already part of the Nix Packages collection, which is a set that can be accessed through the function argument <varname>pkgs</varname>. Typical uses:
194154<programlisting>
195155<xref linkend="opt-environment.systemPackages"/> =
196156 [ pkgs.thunderbird
@@ -199,10 +159,7 @@ swapDevices = [ { device = "/dev/disk/by-label/swap"; } ];
199159
200160<xref linkend="opt-services.postgresql.package"/> = pkgs.postgresql_10;
201161</programlisting>
202− The latter option definition changes the default PostgreSQL package used
203− by NixOS’s PostgreSQL service to 10.x. For more information on
204− packages, including how to add new ones, see
205− <xref linkend="sec-custom-packages"/>.
162+ The latter option definition changes the default PostgreSQL package used by NixOS’s PostgreSQL service to 10.x. For more information on packages, including how to add new ones, see <xref linkend="sec-custom-packages"/>.
206163 </para>
207164 </listitem>
208165 </varlistentry>
nixos/doc/manual/configuration/config-syntax.xml+2−12
@@ -5,18 +5,8 @@
55 xml:id="sec-configuration-syntax">
66 <title>Configuration Syntax</title>
77 <para>
8− The NixOS configuration file
9− <filename>/etc/nixos/configuration.nix</filename> is actually a <emphasis>Nix
10− expression</emphasis>, which is the Nix package manager’s purely functional
11− language for describing how to build packages and configurations. This means
12− you have all the expressive power of that language at your disposal,
13− including the ability to abstract over common patterns, which is very useful
14− when managing complex systems. The syntax and semantics of the Nix language
15− are fully described in the
16− <link
17−xlink:href="http://nixos.org/nix/manual/#chap-writing-nix-expressions">Nix
18− manual</link>, but here we give a short overview of the most important
19− constructs useful in NixOS configuration files.
8+ The NixOS configuration file <filename>/etc/nixos/configuration.nix</filename> is actually a <emphasis>Nix expression</emphasis>, which is the Nix package manager’s purely functional language for describing how to build packages and configurations. This means you have all the expressive power of that language at your disposal, including the ability to abstract over common patterns, which is very useful when managing complex systems. The syntax and semantics of the Nix language are fully described in the <link
9+xlink:href="http://nixos.org/nix/manual/#chap-writing-nix-expressions">Nix manual</link>, but here we give a short overview of the most important constructs useful in NixOS configuration files.
2010 </para>
2111 <xi:include href="config-file.xml" />
2212 <xi:include href="abstractions.xml" />
nixos/doc/manual/configuration/configuration.xml+1−5
@@ -6,11 +6,7 @@
66 <title>Configuration</title>
77 <partintro xml:id="ch-configuration-intro">
88 <para>
9− This chapter describes how to configure various aspects of a NixOS machine
10− through the configuration file
11− <filename>/etc/nixos/configuration.nix</filename>. As described in
12− <xref linkend="sec-changing-config" />, changes to this file only take
13− effect after you run <command>nixos-rebuild</command>.
9+ This chapter describes how to configure various aspects of a NixOS machine through the configuration file <filename>/etc/nixos/configuration.nix</filename>. As described in <xref linkend="sec-changing-config" />, changes to this file only take effect after you run <command>nixos-rebuild</command>.
1410 </para>
1511 </partintro>
1612 <xi:include href="config-syntax.xml" />
nixos/doc/manual/configuration/customizing-packages.xml+8−46
@@ -6,47 +6,25 @@
66 <title>Customising Packages</title>
77
88 <para>
9− Some packages in Nixpkgs have options to enable or disable optional
10− functionality or change other aspects of the package. For instance, the
11− Firefox wrapper package (which provides Firefox with a set of plugins such as
12− the Adobe Flash player) has an option to enable the Google Talk plugin. It
13− can be set in <filename>configuration.nix</filename> as follows: <filename>
14− nixpkgs.config.firefox.enableGoogleTalkPlugin = true; </filename>
9+ Some packages in Nixpkgs have options to enable or disable optional functionality or change other aspects of the package. For instance, the Firefox wrapper package (which provides Firefox with a set of plugins such as the Adobe Flash player) has an option to enable the Google Talk plugin. It can be set in <filename>configuration.nix</filename> as follows: <filename> nixpkgs.config.firefox.enableGoogleTalkPlugin = true; </filename>
1510 </para>
1611
1712 <warning>
1813 <para>
19− Unfortunately, Nixpkgs currently lacks a way to query available
20− configuration options.
14+ Unfortunately, Nixpkgs currently lacks a way to query available configuration options.
2115 </para>
2216 </warning>
2317
2418 <para>
25− Apart from high-level options, it’s possible to tweak a package in almost
26− arbitrary ways, such as changing or disabling dependencies of a package. For
27− instance, the Emacs package in Nixpkgs by default has a dependency on GTK 2.
28− If you want to build it against GTK 3, you can specify that as follows:
19+ Apart from high-level options, it’s possible to tweak a package in almost arbitrary ways, such as changing or disabling dependencies of a package. For instance, the Emacs package in Nixpkgs by default has a dependency on GTK 2. If you want to build it against GTK 3, you can specify that as follows:
2920<programlisting>
3021<xref linkend="opt-environment.systemPackages"/> = [ (pkgs.emacs.override { gtk = pkgs.gtk3; }) ];
3122</programlisting>
32− The function <varname>override</varname> performs the call to the Nix
33− function that produces Emacs, with the original arguments amended by the set
34− of arguments specified by you. So here the function argument
35− <varname>gtk</varname> gets the value <literal>pkgs.gtk3</literal>, causing
36− Emacs to depend on GTK 3. (The parentheses are necessary because in Nix,
37− function application binds more weakly than list construction, so without
38− them, <xref linkend="opt-environment.systemPackages"/> would be a list with
39− two elements.)
23+ The function <varname>override</varname> performs the call to the Nix function that produces Emacs, with the original arguments amended by the set of arguments specified by you. So here the function argument <varname>gtk</varname> gets the value <literal>pkgs.gtk3</literal>, causing Emacs to depend on GTK 3. (The parentheses are necessary because in Nix, function application binds more weakly than list construction, so without them, <xref linkend="opt-environment.systemPackages"/> would be a list with two elements.)
4024 </para>
4125
4226 <para>
43− Even greater customisation is possible using the function
44− <varname>overrideAttrs</varname>. While the <varname>override</varname>
45− mechanism above overrides the arguments of a package function,
46− <varname>overrideAttrs</varname> allows changing the
47− <emphasis>attributes</emphasis> passed to <literal>mkDerivation</literal>.
48− This permits changing any aspect of the package, such as the source code. For
49− instance, if you want to override the source code of Emacs, you can say:
27+ Even greater customisation is possible using the function <varname>overrideAttrs</varname>. While the <varname>override</varname> mechanism above overrides the arguments of a package function, <varname>overrideAttrs</varname> allows changing the <emphasis>attributes</emphasis> passed to <literal>mkDerivation</literal>. This permits changing any aspect of the package, such as the source code. For instance, if you want to override the source code of Emacs, you can say:
5028<programlisting>
5129<xref linkend="opt-environment.systemPackages"/> = [
5230 (pkgs.emacs.overrideAttrs (oldAttrs: {
@@ -55,32 +33,16 @@
5533 }))
5634];
5735</programlisting>
58− Here, <varname>overrideAttrs</varname> takes the Nix derivation specified by
59− <varname>pkgs.emacs</varname> and produces a new derivation in which the
60− original’s <literal>name</literal> and <literal>src</literal> attribute
61− have been replaced by the given values by re-calling
62− <literal>stdenv.mkDerivation</literal>. The original attributes are
63− accessible via the function argument, which is conventionally named
64− <varname>oldAttrs</varname>.
36+ Here, <varname>overrideAttrs</varname> takes the Nix derivation specified by <varname>pkgs.emacs</varname> and produces a new derivation in which the original’s <literal>name</literal> and <literal>src</literal> attribute have been replaced by the given values by re-calling <literal>stdenv.mkDerivation</literal>. The original attributes are accessible via the function argument, which is conventionally named <varname>oldAttrs</varname>.
6537 </para>
6638
6739 <para>
68− The overrides shown above are not global. They do not affect the original
69− package; other packages in Nixpkgs continue to depend on the original rather
70− than the customised package. This means that if another package in your
71− system depends on the original package, you end up with two instances of the
72− package. If you want to have everything depend on your customised instance,
73− you can apply a <emphasis>global</emphasis> override as follows:
40+ The overrides shown above are not global. They do not affect the original package; other packages in Nixpkgs continue to depend on the original rather than the customised package. This means that if another package in your system depends on the original package, you end up with two instances of the package. If you want to have everything depend on your customised instance, you can apply a <emphasis>global</emphasis> override as follows:
7441<screen>
7542nixpkgs.config.packageOverrides = pkgs:
7643 { emacs = pkgs.emacs.override { gtk = pkgs.gtk3; };
7744 };
7845</screen>
79− The effect of this definition is essentially equivalent to modifying the
80− <literal>emacs</literal> attribute in the Nixpkgs source tree. Any package in
81− Nixpkgs that depends on <literal>emacs</literal> will be passed your
82− customised instance. (However, the value <literal>pkgs.emacs</literal> in
83− <varname>nixpkgs.config.packageOverrides</varname> refers to the original
84− rather than overridden instance, to prevent an infinite recursion.)
46+ The effect of this definition is essentially equivalent to modifying the <literal>emacs</literal> attribute in the Nixpkgs source tree. Any package in Nixpkgs that depends on <literal>emacs</literal> will be passed your customised instance. (However, the value <literal>pkgs.emacs</literal> in <varname>nixpkgs.config.packageOverrides</varname> refers to the original rather than overridden instance, to prevent an infinite recursion.)
8547 </para>
8648</section>
nixos/doc/manual/configuration/declarative-packages.xml+6−17
@@ -6,17 +6,11 @@
66 <title>Declarative Package Management</title>
77
88 <para>
9− With declarative package management, you specify which packages you want on
10− your system by setting the option
11− <xref linkend="opt-environment.systemPackages"/>. For instance, adding the
12− following line to <filename>configuration.nix</filename> enables the Mozilla
13− Thunderbird email application:
9+ With declarative package management, you specify which packages you want on your system by setting the option <xref linkend="opt-environment.systemPackages"/>. For instance, adding the following line to <filename>configuration.nix</filename> enables the Mozilla Thunderbird email application:
1410<programlisting>
1511<xref linkend="opt-environment.systemPackages"/> = [ pkgs.thunderbird ];
1612</programlisting>
17− The effect of this specification is that the Thunderbird package from Nixpkgs
18− will be built or downloaded as part of the system when you run
19− <command>nixos-rebuild switch</command>.
13+ The effect of this specification is that the Thunderbird package from Nixpkgs will be built or downloaded as part of the system when you run <command>nixos-rebuild switch</command>.
2014 </para>
2115
2216 <para>
@@ -26,20 +20,15 @@
2620nixos.firefox firefox-23.0 Mozilla Firefox - the browser, reloaded
2721<replaceable>...</replaceable>
2822</screen>
29− The first column in the output is the <emphasis>attribute name</emphasis>,
30− such as <literal>nixos.thunderbird</literal>.
23+ The first column in the output is the <emphasis>attribute name</emphasis>, such as <literal>nixos.thunderbird</literal>.
3124 </para>
32− <para>
33− Note: the <literal>nixos</literal> prefix tells us that we want to get the
34− package from the <literal>nixos</literal> channel and works only in CLI tools.
3525
36− In declarative configuration use <literal>pkgs</literal> prefix (variable).
26+ <para>
27+ Note: the <literal>nixos</literal> prefix tells us that we want to get the package from the <literal>nixos</literal> channel and works only in CLI tools. In declarative configuration use <literal>pkgs</literal> prefix (variable).
3728 </para>
3829
3930 <para>
40− To “uninstall” a package, simply remove it from
41− <xref linkend="opt-environment.systemPackages"/> and run
42− <command>nixos-rebuild switch</command>.
31+ To “uninstall” a package, simply remove it from <xref linkend="opt-environment.systemPackages"/> and run <command>nixos-rebuild switch</command>.
4332 </para>
4433
4534 <xi:include href="customizing-packages.xml" />
nixos/doc/manual/configuration/file-systems.xml+4−24
@@ -5,41 +5,21 @@
55 xml:id="ch-file-systems">
66 <title>File Systems</title>
77 <para>
8− You can define file systems using the <option>fileSystems</option>
9− configuration option. For instance, the following definition causes NixOS to
10− mount the Ext4 file system on device
11− <filename>/dev/disk/by-label/data</filename> onto the mount point
12− <filename>/data</filename>:
8+ You can define file systems using the <option>fileSystems</option> configuration option. For instance, the following definition causes NixOS to mount the Ext4 file system on device <filename>/dev/disk/by-label/data</filename> onto the mount point <filename>/data</filename>:
139<programlisting>
1410<xref linkend="opt-fileSystems"/>."/data" =
1511 { device = "/dev/disk/by-label/data";
1612 fsType = "ext4";
1713 };
1814</programlisting>
19− Mount points are created automatically if they don’t already exist. For
20− <option><link linkend="opt-fileSystems._name__.device">device</link></option>,
21− it’s best to use the topology-independent device aliases in
22− <filename>/dev/disk/by-label</filename> and
23− <filename>/dev/disk/by-uuid</filename>, as these don’t change if the
24− topology changes (e.g. if a disk is moved to another IDE controller).
15+ Mount points are created automatically if they don’t already exist. For <option><link linkend="opt-fileSystems._name__.device">device</link></option>, it’s best to use the topology-independent device aliases in <filename>/dev/disk/by-label</filename> and <filename>/dev/disk/by-uuid</filename>, as these don’t change if the topology changes (e.g. if a disk is moved to another IDE controller).
2516 </para>
2617 <para>
27− You can usually omit the file system type
28− (<option><link linkend="opt-fileSystems._name__.fsType">fsType</link></option>),
29− since <command>mount</command> can usually detect the type and load the
30− necessary kernel module automatically. However, if the file system is needed
31− at early boot (in the initial ramdisk) and is not <literal>ext2</literal>,
32− <literal>ext3</literal> or <literal>ext4</literal>, then it’s best to
33− specify <option>fsType</option> to ensure that the kernel module is
34− available.
18+ You can usually omit the file system type (<option><link linkend="opt-fileSystems._name__.fsType">fsType</link></option>), since <command>mount</command> can usually detect the type and load the necessary kernel module automatically. However, if the file system is needed at early boot (in the initial ramdisk) and is not <literal>ext2</literal>, <literal>ext3</literal> or <literal>ext4</literal>, then it’s best to specify <option>fsType</option> to ensure that the kernel module is available.
3519 </para>
3620 <note>
3721 <para>
38− System startup will fail if any of the filesystems fails to mount, dropping
39− you to the emergency shell. You can make a mount asynchronous and
40− non-critical by adding
41− <literal><link linkend="opt-fileSystems._name__.options">options</link> = [
42− "nofail" ];</literal>.
22+ System startup will fail if any of the filesystems fails to mount, dropping you to the emergency shell. You can make a mount asynchronous and non-critical by adding <literal><link linkend="opt-fileSystems._name__.options">options</link> = [ "nofail" ];</literal>.
4323 </para>
4424 </note>
4525 <xi:include href="luks-file-systems.xml" />
nixos/doc/manual/configuration/firewall.xml+4−11
@@ -6,21 +6,15 @@
66 <title>Firewall</title>
77
88 <para>
9− NixOS has a simple stateful firewall that blocks incoming connections and
10− other unexpected packets. The firewall applies to both IPv4 and IPv6 traffic.
11− It is enabled by default. It can be disabled as follows:
9+ NixOS has a simple stateful firewall that blocks incoming connections and other unexpected packets. The firewall applies to both IPv4 and IPv6 traffic. It is enabled by default. It can be disabled as follows:
1210<programlisting>
1311<xref linkend="opt-networking.firewall.enable"/> = false;
1412</programlisting>
15− If the firewall is enabled, you can open specific TCP ports to the outside
16− world:
13+ If the firewall is enabled, you can open specific TCP ports to the outside world:
1714<programlisting>
1815<xref linkend="opt-networking.firewall.allowedTCPPorts"/> = [ 80 443 ];
1916</programlisting>
20− Note that TCP port 22 (ssh) is opened automatically if the SSH daemon is
21− enabled (<option><xref linkend="opt-services.openssh.enable"/> =
22− true</option>). UDP ports can be opened through
23− <xref linkend="opt-networking.firewall.allowedUDPPorts"/>.
17+ Note that TCP port 22 (ssh) is opened automatically if the SSH daemon is enabled (<option><xref linkend="opt-services.openssh.enable"/> = true</option>). UDP ports can be opened through <xref linkend="opt-networking.firewall.allowedUDPPorts"/>.
2418 </para>
2519
2620 <para>
@@ -31,7 +25,6 @@
3125 { from = 8000; to = 8010; }
3226];
3327</programlisting>
34− Similarly, UDP port ranges can be opened through
35− <xref linkend="opt-networking.firewall.allowedUDPPortRanges"/>.
28+ Similarly, UDP port ranges can be opened through <xref linkend="opt-networking.firewall.allowedUDPPortRanges"/>.
3629 </para>
3730</section>
nixos/doc/manual/configuration/ipv4-config.xml+4−11
@@ -6,17 +6,14 @@
66 <title>IPv4 Configuration</title>
77
88 <para>
9− By default, NixOS uses DHCP (specifically, <command>dhcpcd</command>) to
10− automatically configure network interfaces. However, you can configure an
11− interface manually as follows:
9+ By default, NixOS uses DHCP (specifically, <command>dhcpcd</command>) to automatically configure network interfaces. However, you can configure an interface manually as follows:
1210<programlisting>
1311<link linkend="opt-networking.interfaces._name__.ipv4.addresses">networking.interfaces.eth0.ipv4.addresses</link> = [ {
1412 address = "192.168.1.2";
1513 prefixLength = 24;
1614} ];
1715</programlisting>
18− Typically you’ll also want to set a default gateway and set of name
19− servers:
16+ Typically you’ll also want to set a default gateway and set of name servers:
2017<programlisting>
2118<xref linkend="opt-networking.defaultGateway"/> = "192.168.1.1";
2219<xref linkend="opt-networking.nameservers"/> = [ "8.8.8.8" ];
@@ -25,10 +22,7 @@
2522
2623 <note>
2724 <para>
28− Statically configured interfaces are set up by the systemd service
29− <replaceable>interface-name</replaceable><literal>-cfg.service</literal>.
30− The default gateway and name server configuration is performed by
31− <literal>network-setup.service</literal>.
25+ Statically configured interfaces are set up by the systemd service <replaceable>interface-name</replaceable><literal>-cfg.service</literal>. The default gateway and name server configuration is performed by <literal>network-setup.service</literal>.
3226 </para>
3327 </note>
3428
@@ -37,7 +31,6 @@
3731<programlisting>
3832<xref linkend="opt-networking.hostName"/> = "cartman";
3933</programlisting>
40− The default host name is <literal>nixos</literal>. Set it to the empty string
41− (<literal>""</literal>) to allow the DHCP server to provide the host name.
34+ The default host name is <literal>nixos</literal>. Set it to the empty string (<literal>""</literal>) to allow the DHCP server to provide the host name.
4235 </para>
4336</section>
nixos/doc/manual/configuration/ipv6-config.xml+4−9
@@ -6,25 +6,21 @@
66 <title>IPv6 Configuration</title>
77
88 <para>
9− IPv6 is enabled by default. Stateless address autoconfiguration is used to
10− automatically assign IPv6 addresses to all interfaces. You can disable IPv6
11− support globally by setting:
9+ IPv6 is enabled by default. Stateless address autoconfiguration is used to automatically assign IPv6 addresses to all interfaces. You can disable IPv6 support globally by setting:
1210<programlisting>
1311<xref linkend="opt-networking.enableIPv6"/> = false;
1412</programlisting>
1513 </para>
1614
1715 <para>
18− You can disable IPv6 on a single interface using a normal sysctl (in this
19− example, we use interface <varname>eth0</varname>):
16+ You can disable IPv6 on a single interface using a normal sysctl (in this example, we use interface <varname>eth0</varname>):
2017<programlisting>
2118<xref linkend="opt-boot.kernel.sysctl"/>."net.ipv6.conf.eth0.disable_ipv6" = true;
2219</programlisting>
2320 </para>
2421
2522 <para>
26− As with IPv4 networking interfaces are automatically configured via DHCPv6.
27− You can configure an interface manually:
23+ As with IPv4 networking interfaces are automatically configured via DHCPv6. You can configure an interface manually:
2824<programlisting>
2925<link linkend="opt-networking.interfaces._name__.ipv6.addresses">networking.interfaces.eth0.ipv6.addresses</link> = [ {
3026 address = "fe00:aa:bb:cc::2";
@@ -44,7 +40,6 @@
4440 </para>
4541
4642 <para>
47− See <xref linkend='sec-ipv4' /> for similar examples and additional
48− information.
43+ See <xref linkend='sec-ipv4' /> for similar examples and additional information.
4944 </para>
5045</section>
nixos/doc/manual/configuration/kubernetes.xml+12−62
@@ -5,12 +5,10 @@
55 xml:id="sec-kubernetes">
66 <title>Kubernetes</title>
77 <para>
8− The NixOS Kubernetes module is a collective term for a handful of individual
9− submodules implementing the Kubernetes cluster components.
8+ The NixOS Kubernetes module is a collective term for a handful of individual submodules implementing the Kubernetes cluster components.
109 </para>
1110 <para>
12− There are generally two ways of enabling Kubernetes on NixOS. One way is to
13− enable and configure cluster components appropriately by hand:
11+ There are generally two ways of enabling Kubernetes on NixOS. One way is to enable and configure cluster components appropriately by hand:
1412<programlisting>
1513services.kubernetes = {
1614 apiserver.enable = true;
@@ -21,9 +19,7 @@ services.kubernetes = {
2119 flannel.enable = true;
2220};
2321</programlisting>
24− Another way is to assign cluster roles ("master" and/or "node") to the host.
25− This enables apiserver, controllerManager, scheduler, addonManager,
26− kube-proxy and etcd:
22+ Another way is to assign cluster roles ("master" and/or "node") to the host. This enables apiserver, controllerManager, scheduler, addonManager, kube-proxy and etcd:
2723<programlisting>
2824<xref linkend="opt-services.kubernetes.roles"/> = [ "master" ];
2925</programlisting>
@@ -31,66 +27,29 @@ services.kubernetes = {
3127<programlisting>
3228<xref linkend="opt-services.kubernetes.roles"/> = [ "node" ];
3329</programlisting>
34− Assigning both the master and node roles is usable if you want a single node
35− Kubernetes cluster for dev or testing purposes:
30+ Assigning both the master and node roles is usable if you want a single node Kubernetes cluster for dev or testing purposes:
3631<programlisting>
3732<xref linkend="opt-services.kubernetes.roles"/> = [ "master" "node" ];
3833</programlisting>
39− Note: Assigning either role will also default both
40− <xref linkend="opt-services.kubernetes.flannel.enable"/> and
41− <xref linkend="opt-services.kubernetes.easyCerts"/> to true. This sets up
42− flannel as CNI and activates automatic PKI bootstrapping.
34+ Note: Assigning either role will also default both <xref linkend="opt-services.kubernetes.flannel.enable"/> and <xref linkend="opt-services.kubernetes.easyCerts"/> to true. This sets up flannel as CNI and activates automatic PKI bootstrapping.
4335 </para>
4436 <para>
45− As of kubernetes 1.10.X it has been deprecated to open non-tls-enabled ports
46− on kubernetes components. Thus, from NixOS 19.03 all plain HTTP ports have
47− been disabled by default. While opening insecure ports is still possible, it
48− is recommended not to bind these to other interfaces than loopback. To
49− re-enable the insecure port on the apiserver, see options:
50− <xref linkend="opt-services.kubernetes.apiserver.insecurePort"/> and
51− <xref linkend="opt-services.kubernetes.apiserver.insecureBindAddress"/>
37+ As of kubernetes 1.10.X it has been deprecated to open non-tls-enabled ports on kubernetes components. Thus, from NixOS 19.03 all plain HTTP ports have been disabled by default. While opening insecure ports is still possible, it is recommended not to bind these to other interfaces than loopback. To re-enable the insecure port on the apiserver, see options: <xref linkend="opt-services.kubernetes.apiserver.insecurePort"/> and <xref linkend="opt-services.kubernetes.apiserver.insecureBindAddress"/>
5238 </para>
5339 <note>
5440 <para>
55− As of NixOS 19.03, it is mandatory to configure:
56− <xref linkend="opt-services.kubernetes.masterAddress"/>. The masterAddress
57− must be resolveable and routeable by all cluster nodes. In single node
58− clusters, this can be set to <literal>localhost</literal>.
41+ As of NixOS 19.03, it is mandatory to configure: <xref linkend="opt-services.kubernetes.masterAddress"/>. The masterAddress must be resolveable and routeable by all cluster nodes. In single node clusters, this can be set to <literal>localhost</literal>.
5942 </para>
6043 </note>
6144 <para>
62− Role-based access control (RBAC) authorization mode is enabled by default.
63− This means that anonymous requests to the apiserver secure port will
64− expectedly cause a permission denied error. All cluster components must
65− therefore be configured with x509 certificates for two-way tls communication.
66− The x509 certificate subject section determines the roles and permissions
67− granted by the apiserver to perform clusterwide or namespaced operations. See
68− also:
69− <link
70− xlink:href="https://kubernetes.io/docs/reference/access-authn-authz/rbac/">
71− Using RBAC Authorization</link>.
45+ Role-based access control (RBAC) authorization mode is enabled by default. This means that anonymous requests to the apiserver secure port will expectedly cause a permission denied error. All cluster components must therefore be configured with x509 certificates for two-way tls communication. The x509 certificate subject section determines the roles and permissions granted by the apiserver to perform clusterwide or namespaced operations. See also: <link
46+ xlink:href="https://kubernetes.io/docs/reference/access-authn-authz/rbac/"> Using RBAC Authorization</link>.
7247 </para>
7348 <para>
74− The NixOS kubernetes module provides an option for automatic certificate
75− bootstrapping and configuration,
76− <xref linkend="opt-services.kubernetes.easyCerts"/>. The PKI bootstrapping
77− process involves setting up a certificate authority (CA) daemon (cfssl) on
78− the kubernetes master node. cfssl generates a CA-cert for the cluster, and
79− uses the CA-cert for signing subordinate certs issued to each of the cluster
80− components. Subsequently, the certmgr daemon monitors active certificates and
81− renews them when needed. For single node Kubernetes clusters, setting
82− <xref linkend="opt-services.kubernetes.easyCerts"/> = true is sufficient and
83− no further action is required. For joining extra node machines to an existing
84− cluster on the other hand, establishing initial trust is mandatory.
49+ The NixOS kubernetes module provides an option for automatic certificate bootstrapping and configuration, <xref linkend="opt-services.kubernetes.easyCerts"/>. The PKI bootstrapping process involves setting up a certificate authority (CA) daemon (cfssl) on the kubernetes master node. cfssl generates a CA-cert for the cluster, and uses the CA-cert for signing subordinate certs issued to each of the cluster components. Subsequently, the certmgr daemon monitors active certificates and renews them when needed. For single node Kubernetes clusters, setting <xref linkend="opt-services.kubernetes.easyCerts"/> = true is sufficient and no further action is required. For joining extra node machines to an existing cluster on the other hand, establishing initial trust is mandatory.
8550 </para>
8651 <para>
87− To add new nodes to the cluster: On any (non-master) cluster node where
88− <xref linkend="opt-services.kubernetes.easyCerts"/> is enabled, the helper
89− script <literal>nixos-kubernetes-node-join</literal> is available on PATH.
90− Given a token on stdin, it will copy the token to the kubernetes secrets
91− directory and restart the certmgr service. As requested certificates are
92− issued, the script will restart kubernetes cluster components as needed for
93− them to pick up new keypairs.
52+ To add new nodes to the cluster: On any (non-master) cluster node where <xref linkend="opt-services.kubernetes.easyCerts"/> is enabled, the helper script <literal>nixos-kubernetes-node-join</literal> is available on PATH. Given a token on stdin, it will copy the token to the kubernetes secrets directory and restart the certmgr service. As requested certificates are issued, the script will restart kubernetes cluster components as needed for them to pick up new keypairs.
9453 </para>
9554 <note>
9655 <para>
@@ -98,15 +57,6 @@ services.kubernetes = {
9857 </para>
9958 </note>
10059 <para>
101− In order to interact with an RBAC-enabled cluster as an administrator, one
102− needs to have cluster-admin privileges. By default, when easyCerts is
103− enabled, a cluster-admin kubeconfig file is generated and linked into
104− <literal>/etc/kubernetes/cluster-admin.kubeconfig</literal> as determined by
105− <xref linkend="opt-services.kubernetes.pki.etcClusterAdminKubeconfig"/>.
106− <literal>export KUBECONFIG=/etc/kubernetes/cluster-admin.kubeconfig</literal>
107− will make kubectl use this kubeconfig to access and authenticate the cluster.
108− The cluster-admin kubeconfig references an auto-generated keypair owned by
109− root. Thus, only root on the kubernetes master may obtain cluster-admin
110− rights by means of this file.
60+ In order to interact with an RBAC-enabled cluster as an administrator, one needs to have cluster-admin privileges. By default, when easyCerts is enabled, a cluster-admin kubeconfig file is generated and linked into <literal>/etc/kubernetes/cluster-admin.kubeconfig</literal> as determined by <xref linkend="opt-services.kubernetes.pki.etcClusterAdminKubeconfig"/>. <literal>export KUBECONFIG=/etc/kubernetes/cluster-admin.kubeconfig</literal> will make kubectl use this kubeconfig to access and authenticate the cluster. The cluster-admin kubeconfig references an auto-generated keypair owned by root. Thus, only root on the kubernetes master may obtain cluster-admin rights by means of this file.
11161 </para>
11262</chapter>
nixos/doc/manual/configuration/linux-kernel.xml+15−44
@@ -5,27 +5,19 @@
55 xml:id="sec-kernel-config">
66 <title>Linux Kernel</title>
77 <para>
8− You can override the Linux kernel and associated packages using the option
9− <option>boot.kernelPackages</option>. For instance, this selects the Linux
10− 3.10 kernel:
8+ You can override the Linux kernel and associated packages using the option <option>boot.kernelPackages</option>. For instance, this selects the Linux 3.10 kernel:
119<programlisting>
1210<xref linkend="opt-boot.kernelPackages"/> = pkgs.linuxPackages_3_10;
1311</programlisting>
14− Note that this not only replaces the kernel, but also packages that are
15− specific to the kernel version, such as the NVIDIA video drivers. This
16− ensures that driver packages are consistent with the kernel.
12+ Note that this not only replaces the kernel, but also packages that are specific to the kernel version, such as the NVIDIA video drivers. This ensures that driver packages are consistent with the kernel.
1713 </para>
1814 <para>
19− The default Linux kernel configuration should be fine for most users. You can
20− see the configuration of your current kernel with the following command:
15+ The default Linux kernel configuration should be fine for most users. You can see the configuration of your current kernel with the following command:
2116<programlisting>
2217zcat /proc/config.gz
2318</programlisting>
24− If you want to change the kernel configuration, you can use the
25− <option>packageOverrides</option> feature (see
26− <xref
27−linkend="sec-customising-packages" />). For instance, to enable support
28− for the kernel debugger KGDB:
19+ If you want to change the kernel configuration, you can use the <option>packageOverrides</option> feature (see <xref
20+linkend="sec-customising-packages" />). For instance, to enable support for the kernel debugger KGDB:
2921<programlisting>
3022nixpkgs.config.packageOverrides = pkgs:
3123 { linux_3_4 = pkgs.linux_3_4.override {
@@ -36,44 +28,31 @@ nixpkgs.config.packageOverrides = pkgs:
3628 };
3729 };
3830</programlisting>
39− <varname>extraConfig</varname> takes a list of Linux kernel configuration
40− options, one per line. The name of the option should not include the prefix
41− <literal>CONFIG_</literal>. The option value is typically
42− <literal>y</literal>, <literal>n</literal> or <literal>m</literal> (to build
43− something as a kernel module).
31+ <varname>extraConfig</varname> takes a list of Linux kernel configuration options, one per line. The name of the option should not include the prefix <literal>CONFIG_</literal>. The option value is typically <literal>y</literal>, <literal>n</literal> or <literal>m</literal> (to build something as a kernel module).
4432 </para>
4533 <para>
46− Kernel modules for hardware devices are generally loaded automatically by
47− <command>udev</command>. You can force a module to be loaded via
48− <xref linkend="opt-boot.kernelModules"/>, e.g.
34+ Kernel modules for hardware devices are generally loaded automatically by <command>udev</command>. You can force a module to be loaded via <xref linkend="opt-boot.kernelModules"/>, e.g.
4935<programlisting>
5036<xref linkend="opt-boot.kernelModules"/> = [ "fuse" "kvm-intel" "coretemp" ];
5137</programlisting>
52− If the module is required early during the boot (e.g. to mount the root file
53− system), you can use <xref linkend="opt-boot.initrd.kernelModules"/>:
38+ If the module is required early during the boot (e.g. to mount the root file system), you can use <xref linkend="opt-boot.initrd.kernelModules"/>:
5439<programlisting>
5540<xref linkend="opt-boot.initrd.kernelModules"/> = [ "cifs" ];
5641</programlisting>
57− This causes the specified modules and their dependencies to be added to the
58− initial ramdisk.
42+ This causes the specified modules and their dependencies to be added to the initial ramdisk.
5943 </para>
6044 <para>
61− Kernel runtime parameters can be set through
62− <xref linkend="opt-boot.kernel.sysctl"/>, e.g.
45+ Kernel runtime parameters can be set through <xref linkend="opt-boot.kernel.sysctl"/>, e.g.
6346<programlisting>
6447<xref linkend="opt-boot.kernel.sysctl"/>."net.ipv4.tcp_keepalive_time" = 120;
6548</programlisting>
66− sets the kernel’s TCP keepalive time to 120 seconds. To see the available
67− parameters, run <command>sysctl -a</command>.
49+ sets the kernel’s TCP keepalive time to 120 seconds. To see the available parameters, run <command>sysctl -a</command>.
6850 </para>
6951 <section xml:id="sec-linux-config-customizing">
7052 <title>Customize your kernel</title>
7153
7254 <para>
73− The first step before compiling the kernel is to generate an appropriate
74− <literal>.config</literal> configuration. Either you pass your own config
75− via the <literal>configfile</literal> setting of
76− <literal>linuxManualConfig</literal>:
55+ The first step before compiling the kernel is to generate an appropriate <literal>.config</literal> configuration. Either you pass your own config via the <literal>configfile</literal> setting of <literal>linuxManualConfig</literal>:
7756<screen><![CDATA[
7857 custom-kernel = super.linuxManualConfig {
7958 inherit (super) stdenv hostPlatform;
@@ -84,17 +63,11 @@ nixpkgs.config.packageOverrides = pkgs:
8463 allowImportFromDerivation = true;
8564 };
8665 ]]></screen>
87− You can edit the config with this snippet (by default <command>make
88− menuconfig</command> won't work out of the box on nixos):
66+ You can edit the config with this snippet (by default <command>make menuconfig</command> won't work out of the box on nixos):
8967<screen><![CDATA[
9068 nix-shell -E 'with import <nixpkgs> {}; kernelToOverride.overrideAttrs (o: {nativeBuildInputs=o.nativeBuildInputs ++ [ pkgconfig ncurses ];})'
9169 ]]></screen>
92− or you can let nixpkgs generate the configuration. Nixpkgs generates it via
93− answering the interactive kernel utility <command>make config</command>. The
94− answers depend on parameters passed to
95− <filename>pkgs/os-specific/linux/kernel/generic.nix</filename> (which you
96− can influence by overriding <literal>extraConfig, autoModules,
97− modDirVersion, preferBuiltin, extraConfig</literal>).
70+ or you can let nixpkgs generate the configuration. Nixpkgs generates it via answering the interactive kernel utility <command>make config</command>. The answers depend on parameters passed to <filename>pkgs/os-specific/linux/kernel/generic.nix</filename> (which you can influence by overriding <literal>extraConfig, autoModules, modDirVersion, preferBuiltin, extraConfig</literal>).
9871<screen><![CDATA[
9972
10073 mptcp93.override ({
@@ -121,9 +94,7 @@ nixpkgs.config.packageOverrides = pkgs:
12194 <title>Developing kernel modules</title>
12295
12396 <para>
124− When developing kernel modules it's often convenient to run edit-compile-run
125− loop as quickly as possible. See below snippet as an example of developing
126− <literal>mellanox</literal> drivers.
97+ When developing kernel modules it's often convenient to run edit-compile-run loop as quickly as possible. See below snippet as an example of developing <literal>mellanox</literal> drivers.
12798 </para>
12899
129100<screen><![CDATA[
nixos/doc/manual/configuration/luks-file-systems.xml+3−9
@@ -6,10 +6,7 @@
66 <title>LUKS-Encrypted File Systems</title>
77
88 <para>
9− NixOS supports file systems that are encrypted using
10− <emphasis>LUKS</emphasis> (Linux Unified Key Setup). For example, here is how
11− you create an encrypted Ext4 file system on the device
12− <filename>/dev/disk/by-uuid/3f6b0024-3a44-4fde-a43a-767b872abe5d</filename>:
9+ NixOS supports file systems that are encrypted using <emphasis>LUKS</emphasis> (Linux Unified Key Setup). For example, here is how you create an encrypted Ext4 file system on the device <filename>/dev/disk/by-uuid/3f6b0024-3a44-4fde-a43a-767b872abe5d</filename>:
1310<screen>
1411# cryptsetup luksFormat /dev/disk/by-uuid/3f6b0024-3a44-4fde-a43a-767b872abe5d
1512
@@ -26,15 +23,12 @@ Enter passphrase for /dev/disk/by-uuid/3f6b0024-3a44-4fde-a43a-767b872abe5d: ***
2623
2724# mkfs.ext4 /dev/mapper/crypted
2825</screen>
29− To ensure that this file system is automatically mounted at boot time as
30− <filename>/</filename>, add the following to
31− <filename>configuration.nix</filename>:
26+ To ensure that this file system is automatically mounted at boot time as <filename>/</filename>, add the following to <filename>configuration.nix</filename>:
3227<programlisting>
3328<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";
3429<xref linkend="opt-fileSystems"/>."/".device = "/dev/mapper/crypted";
3530</programlisting>
36− Should grub be used as bootloader, and <filename>/boot</filename> is located
37− on an encrypted partition, it is necessary to add the following grub option:
31+ Should grub be used as bootloader, and <filename>/boot</filename> is located on an encrypted partition, it is necessary to add the following grub option:
3832<programlisting><xref linkend="opt-boot.loader.grub.enableCryptodisk"/> = true;</programlisting>
3933 </para>
4034</section>
nixos/doc/manual/configuration/matrix.xml+8−65
@@ -5,33 +5,16 @@
55 xml:id="module-services-matrix">
66 <title>Matrix</title>
77 <para>
8− <link xlink:href="https://matrix.org/">Matrix</link> is an open standard for
9− interoperable, decentralised, real-time communication over IP. It can be used
10− to power Instant Messaging, VoIP/WebRTC signalling, Internet of Things
11− communication - or anywhere you need a standard HTTP API for publishing and
12− subscribing to data whilst tracking the conversation history.
8+ <link xlink:href="https://matrix.org/">Matrix</link> is an open standard for interoperable, decentralised, real-time communication over IP. It can be used to power Instant Messaging, VoIP/WebRTC signalling, Internet of Things communication - or anywhere you need a standard HTTP API for publishing and subscribing to data whilst tracking the conversation history.
139 </para>
1410 <para>
15− This chapter will show you how to set up your own, self-hosted Matrix
16− homeserver using the Synapse reference homeserver, and how to serve your own
17− copy of the Riot web client. See the
18− <link xlink:href="https://matrix.org/docs/projects/try-matrix-now.html">Try
19− Matrix Now!</link> overview page for links to Riot Apps for Android and iOS,
20− desktop clients, as well as bridges to other networks and other projects
21− around Matrix.
11+ This chapter will show you how to set up your own, self-hosted Matrix homeserver using the Synapse reference homeserver, and how to serve your own copy of the Riot web client. See the <link xlink:href="https://matrix.org/docs/projects/try-matrix-now.html">Try Matrix Now!</link> overview page for links to Riot Apps for Android and iOS, desktop clients, as well as bridges to other networks and other projects around Matrix.
2212 </para>
2313 <section xml:id="module-services-matrix-synapse">
2414 <title>Synapse Homeserver</title>
2515
2616 <para>
27− <link xlink:href="https://github.com/matrix-org/synapse">Synapse</link> is
28− the reference homeserver implementation of Matrix from the core development
29− team at matrix.org. The following configuration example will set up a
30− synapse server for the <literal>example.org</literal> domain, served from
31− the host <literal>myhostname.example.org</literal>. For more information,
32− please refer to the
33− <link xlink:href="https://github.com/matrix-org/synapse#synapse-installation">
34− installation instructions of Synapse </link>.
17+ <link xlink:href="https://github.com/matrix-org/synapse">Synapse</link> is the reference homeserver implementation of Matrix from the core development team at matrix.org. The following configuration example will set up a synapse server for the <literal>example.org</literal> domain, served from the host <literal>myhostname.example.org</literal>. For more information, please refer to the <link xlink:href="https://github.com/matrix-org/synapse#synapse-installation"> installation instructions of Synapse </link>.
3518<programlisting>
3619let
3720 fqdn =
@@ -121,26 +104,11 @@ in {
121104 </para>
122105
123106 <para>
124− If the <code>A</code> and <code>AAAA</code> DNS records on
125− <literal>example.org</literal> do not point on the same host as the records
126− for <code>myhostname.example.org</code>, you can easily move the
127− <code>/.well-known</code> virtualHost section of the code to the host that
128− is serving <literal>example.org</literal>, while the rest stays on
129− <literal>myhostname.example.org</literal> with no other changes required.
130− This pattern also allows to seamlessly move the homeserver from
131− <literal>myhostname.example.org</literal> to
132− <literal>myotherhost.example.org</literal> by only changing the
133− <code>/.well-known</code> redirection target.
107+ If the <code>A</code> and <code>AAAA</code> DNS records on <literal>example.org</literal> do not point on the same host as the records for <code>myhostname.example.org</code>, you can easily move the <code>/.well-known</code> virtualHost section of the code to the host that is serving <literal>example.org</literal>, while the rest stays on <literal>myhostname.example.org</literal> with no other changes required. This pattern also allows to seamlessly move the homeserver from <literal>myhostname.example.org</literal> to <literal>myotherhost.example.org</literal> by only changing the <code>/.well-known</code> redirection target.
134108 </para>
135109
136110 <para>
137− If you want to run a server with public registration by anybody, you can
138− then enable <option>services.matrix-synapse.enable_registration =
139− true;</option>. Otherwise, or you can generate a registration secret with
140− <command>pwgen -s 64 1</command> and set it with
141− <option>services.matrix-synapse.registration_shared_secret</option>. To
142− create a new user or admin, run the following after you have set the secret
143− and have rebuilt NixOS:
111+ If you want to run a server with public registration by anybody, you can then enable <option>services.matrix-synapse.enable_registration = true;</option>. Otherwise, or you can generate a registration secret with <command>pwgen -s 64 1</command> and set it with <option>services.matrix-synapse.registration_shared_secret</option>. To create a new user or admin, run the following after you have set the secret and have rebuilt NixOS:
144112<screen>
145113<prompt>$ </prompt>nix run nixpkgs.matrix-synapse
146114<prompt>$ </prompt>register_new_matrix_user -k <replaceable>your-registration-shared-secret</replaceable> http://localhost:8008
@@ -150,32 +118,14 @@ in {
150118<prompt>Make admin [no]:</prompt>
151119Success!
152120</screen>
153− In the example, this would create a user with the Matrix Identifier
154− <literal>@your-username:example.org</literal>. Note that the registration
155− secret ends up in the nix store and therefore is world-readable by any user
156− on your machine, so it makes sense to only temporarily activate the
157− <option>registration_shared_secret</option> option until a better solution
158− for NixOS is in place.
121+ In the example, this would create a user with the Matrix Identifier <literal>@your-username:example.org</literal>. Note that the registration secret ends up in the nix store and therefore is world-readable by any user on your machine, so it makes sense to only temporarily activate the <option>registration_shared_secret</option> option until a better solution for NixOS is in place.
159122 </para>
160123 </section>
161124 <section xml:id="module-services-matrix-riot-web">
162125 <title>Riot Web Client</title>
163126
164127 <para>
165− <link xlink:href="https://github.com/vector-im/riot-web/">Riot Web</link> is
166− the reference web client for Matrix and developed by the core team at
167− matrix.org. The following snippet can be optionally added to the code before
168− to complete the synapse installation with a web client served at
169− <code>https://riot.myhostname.example.org</code> and
170− <code>https://riot.example.org</code>. Alternatively, you can use the hosted
171− copy at <link xlink:href="https://riot.im/app">https://riot.im/app</link>,
172− or use other web clients or native client applications. Due to the
173− <literal>/.well-known</literal> urls set up done above, many clients should
174− fill in the required connection details automatically when you enter your
175− Matrix Identifier. See
176− <link xlink:href="https://matrix.org/docs/projects/try-matrix-now.html">Try
177− Matrix Now!</link> for a list of existing clients and their supported
178− featureset.
128+ <link xlink:href="https://github.com/vector-im/riot-web/">Riot Web</link> is the reference web client for Matrix and developed by the core team at matrix.org. The following snippet can be optionally added to the code before to complete the synapse installation with a web client served at <code>https://riot.myhostname.example.org</code> and <code>https://riot.example.org</code>. Alternatively, you can use the hosted copy at <link xlink:href="https://riot.im/app">https://riot.im/app</link>, or use other web clients or native client applications. Due to the <literal>/.well-known</literal> urls set up done above, many clients should fill in the required connection details automatically when you enter your Matrix Identifier. See <link xlink:href="https://matrix.org/docs/projects/try-matrix-now.html">Try Matrix Now!</link> for a list of existing clients and their supported featureset.
179129<programlisting>
180130services.nginx.virtualHosts."riot.${fqdn}" = {
181131 enableACME = true;
@@ -190,14 +140,7 @@ services.nginx.virtualHosts."riot.${fqdn}" = {
190140 </para>
191141
192142 <para>
193− Note that the Riot developers do not recommend running Riot and your Matrix
194− homeserver on the same fully-qualified domain name for security reasons. In
195− the example, this means that you should not reuse the
196− <literal>myhostname.example.org</literal> virtualHost to also serve Riot,
197− but instead serve it on a different subdomain, like
198− <literal>riot.example.org</literal> in the example. See the
199− <link xlink:href="https://github.com/vector-im/riot-web#important-security-note">Riot
200− Important Security Notes</link> for more information on this subject.
143+ Note that the Riot developers do not recommend running Riot and your Matrix homeserver on the same fully-qualified domain name for security reasons. In the example, this means that you should not reuse the <literal>myhostname.example.org</literal> virtualHost to also serve Riot, but instead serve it on a different subdomain, like <literal>riot.example.org</literal> in the example. See the <link xlink:href="https://github.com/vector-im/riot-web#important-security-note">Riot Important Security Notes</link> for more information on this subject.
201144 </para>
202145 </section>
203146</chapter>
nixos/doc/manual/configuration/modularity.xml+13−50
@@ -6,18 +6,11 @@
66 <title>Modularity</title>
77
88 <para>
9− The NixOS configuration mechanism is modular. If your
10− <filename>configuration.nix</filename> becomes too big, you can split it into
11− multiple files. Likewise, if you have multiple NixOS configurations (e.g. for
12− different computers) with some commonality, you can move the common
13− configuration into a shared file.
9+ The NixOS configuration mechanism is modular. If your <filename>configuration.nix</filename> becomes too big, you can split it into multiple files. Likewise, if you have multiple NixOS configurations (e.g. for different computers) with some commonality, you can move the common configuration into a shared file.
1410 </para>
1511
1612 <para>
17− Modules have exactly the same syntax as
18− <filename>configuration.nix</filename>. In fact,
19− <filename>configuration.nix</filename> is itself a module. You can use other
20− modules by including them from <filename>configuration.nix</filename>, e.g.:
13+ Modules have exactly the same syntax as <filename>configuration.nix</filename>. In fact, <filename>configuration.nix</filename> is itself a module. You can use other modules by including them from <filename>configuration.nix</filename>, e.g.:
2114<programlisting>
2215{ config, pkgs, ... }:
2316
@@ -27,9 +20,7 @@
2720 <replaceable>...</replaceable>
2821}
2922</programlisting>
30− Here, we include two modules from the same directory,
31− <filename>vpn.nix</filename> and <filename>kde.nix</filename>. The latter
32− might look like this:
23+ Here, we include two modules from the same directory, <filename>vpn.nix</filename> and <filename>kde.nix</filename>. The latter might look like this:
3324<programlisting>
3425{ config, pkgs, ... }:
3526
@@ -38,55 +29,32 @@
3829 <xref linkend="opt-services.xserver.desktopManager.plasma5.enable"/> = true;
3930}
4031</programlisting>
41− Note that both <filename>configuration.nix</filename> and
42− <filename>kde.nix</filename> define the option
43− <xref linkend="opt-environment.systemPackages"/>. When multiple modules
44− define an option, NixOS will try to <emphasis>merge</emphasis> the
45− definitions. In the case of <xref linkend="opt-environment.systemPackages"/>,
46− that’s easy: the lists of packages can simply be concatenated. The value in
47− <filename>configuration.nix</filename> is merged last, so for list-type
48− options, it will appear at the end of the merged list. If you want it to
49− appear first, you can use <varname>mkBefore</varname>:
32+ Note that both <filename>configuration.nix</filename> and <filename>kde.nix</filename> define the option <xref linkend="opt-environment.systemPackages"/>. When multiple modules define an option, NixOS will try to <emphasis>merge</emphasis> the definitions. In the case of <xref linkend="opt-environment.systemPackages"/>, that’s easy: the lists of packages can simply be concatenated. The value in <filename>configuration.nix</filename> is merged last, so for list-type options, it will appear at the end of the merged list. If you want it to appear first, you can use <varname>mkBefore</varname>:
5033<programlisting>
5134<xref linkend="opt-boot.kernelModules"/> = mkBefore [ "kvm-intel" ];
5235</programlisting>
53− This causes the <literal>kvm-intel</literal> kernel module to be loaded
54− before any other kernel modules.
36+ This causes the <literal>kvm-intel</literal> kernel module to be loaded before any other kernel modules.
5537 </para>
5638
5739 <para>
58− For other types of options, a merge may not be possible. For instance, if two
59− modules define <xref linkend="opt-services.httpd.adminAddr"/>,
60− <command>nixos-rebuild</command> will give an error:
40+ For other types of options, a merge may not be possible. For instance, if two modules define <xref linkend="opt-services.httpd.adminAddr"/>, <command>nixos-rebuild</command> will give an error:
6141<screen>
6242The unique option `services.httpd.adminAddr' is defined multiple times, in `/etc/nixos/httpd.nix' and `/etc/nixos/configuration.nix'.
6343</screen>
64− When that happens, it’s possible to force one definition take precedence
65− over the others:
44+ When that happens, it’s possible to force one definition take precedence over the others:
6645<programlisting>
6746<xref linkend="opt-services.httpd.adminAddr"/> = pkgs.lib.mkForce "bob@example.org";
6847</programlisting>
6948 </para>
7049
7150 <para>
72− When using multiple modules, you may need to access configuration values
73− defined in other modules. This is what the <varname>config</varname> function
74− argument is for: it contains the complete, merged system configuration. That
75− is, <varname>config</varname> is the result of combining the configurations
76− returned by every module
51+ When using multiple modules, you may need to access configuration values defined in other modules. This is what the <varname>config</varname> function argument is for: it contains the complete, merged system configuration. That is, <varname>config</varname> is the result of combining the configurations returned by every module
7752 <footnote xml:id="footnote-nix-is-lazy">
7853 <para>
79− If you’re wondering how it’s possible that the (indirect)
80− <emphasis>result</emphasis> of a function is passed as an
81− <emphasis>input</emphasis> to that same function: that’s because Nix is a
82− “lazy” language — it only computes values when they are needed. This
83− works as long as no individual configuration value depends on itself.
54+ If you’re wondering how it’s possible that the (indirect) <emphasis>result</emphasis> of a function is passed as an <emphasis>input</emphasis> to that same function: that’s because Nix is a “lazy” language — it only computes values when they are needed. This works as long as no individual configuration value depends on itself.
8455 </para>
8556 </footnote>
86− . For example, here is a module that adds some packages to
87− <xref linkend="opt-environment.systemPackages"/> only if
88− <xref linkend="opt-services.xserver.enable"/> is set to
89− <literal>true</literal> somewhere else:
57+ . For example, here is a module that adds some packages to <xref linkend="opt-environment.systemPackages"/> only if <xref linkend="opt-services.xserver.enable"/> is set to <literal>true</literal> somewhere else:
9058<programlisting>
9159{ config, pkgs, ... }:
9260
@@ -102,9 +70,7 @@ The unique option `services.httpd.adminAddr' is defined multiple times, in `/etc
10270 </para>
10371
10472 <para>
105− With multiple modules, it may not be obvious what the final value of a
106− configuration option is. The command <option>nixos-option</option> allows you
107− to find out:
73+ With multiple modules, it may not be obvious what the final value of a configuration option is. The command <option>nixos-option</option> allows you to find out:
10874<screen>
10975<prompt>$ </prompt>nixos-option <xref linkend="opt-services.xserver.enable"/>
11076true
@@ -112,8 +78,7 @@ true
11278<prompt>$ </prompt>nixos-option <xref linkend="opt-boot.kernelModules"/>
11379[ "tun" "ipv6" "loop" <replaceable>...</replaceable> ]
11480</screen>
115− Interactive exploration of the configuration is possible using <command>nix
116− repl</command>, a read-eval-print loop for Nix expressions. A typical use:
81+ Interactive exploration of the configuration is possible using <command>nix repl</command>, a read-eval-print loop for Nix expressions. A typical use:
11782<screen>
11883<prompt>$ </prompt>nix repl '&lt;nixpkgs/nixos>'
11984
@@ -126,9 +91,7 @@ true
12691 </para>
12792
12893 <para>
129− While abstracting your configuration, you may find it useful to generate
130− modules using code, instead of writing files. The example below would have
131− the same effect as importing a file which sets those options.
94+ While abstracting your configuration, you may find it useful to generate modules using code, instead of writing files. The example below would have the same effect as importing a file which sets those options.
13295<programlisting>
13396{ config, pkgs, ... }:
13497
nixos/doc/manual/configuration/network-manager.xml+5−17
@@ -6,39 +6,27 @@
66 <title>NetworkManager</title>
77
88 <para>
9− To facilitate network configuration, some desktop environments use
10− NetworkManager. You can enable NetworkManager by setting:
9+ To facilitate network configuration, some desktop environments use NetworkManager. You can enable NetworkManager by setting:
1110<programlisting>
1211<xref linkend="opt-networking.networkmanager.enable"/> = true;
1312</programlisting>
14− some desktop managers (e.g., GNOME) enable NetworkManager automatically for
15− you.
13+ some desktop managers (e.g., GNOME) enable NetworkManager automatically for you.
1614 </para>
1715
1816 <para>
19− All users that should have permission to change network settings must belong
20− to the <code>networkmanager</code> group:
17+ All users that should have permission to change network settings must belong to the <code>networkmanager</code> group:
2118<programlisting>
2219<link linkend="opt-users.users._name__.extraGroups">users.users.alice.extraGroups</link> = [ "networkmanager" ];
2320</programlisting>
2421 </para>
2522
2623 <para>
27− NetworkManager is controlled using either <command>nmcli</command> or
28− <command>nmtui</command> (curses-based terminal user interface). See their
29− manual pages for details on their usage. Some desktop environments (GNOME,
30− KDE) have their own configuration tools for NetworkManager. On XFCE, there is
31− no configuration tool for NetworkManager by default: by adding
32− <code>networkmanagerapplet</code> to the list of system packages, the
33− graphical applet will be installed and will launch automatically when XFCE is
34− starting (and will show in the status tray).
24+ NetworkManager is controlled using either <command>nmcli</command> or <command>nmtui</command> (curses-based terminal user interface). See their manual pages for details on their usage. Some desktop environments (GNOME, KDE) have their own configuration tools for NetworkManager. On XFCE, there is no configuration tool for NetworkManager by default: by adding <code>networkmanagerapplet</code> to the list of system packages, the graphical applet will be installed and will launch automatically when XFCE is starting (and will show in the status tray).
3525 </para>
3626
3727 <note>
3828 <para>
39− <code>networking.networkmanager</code> and <code>networking.wireless</code>
40− (WPA Supplicant) cannot be enabled at the same time: you can still connect
41− to the wireless networks using NetworkManager.
29+ <code>networking.networkmanager</code> and <code>networking.wireless</code> (WPA Supplicant) cannot be enabled at the same time: you can still connect to the wireless networks using NetworkManager.
4230 </para>
4331 </note>
4432</section>
nixos/doc/manual/configuration/networking.xml+1−2
@@ -5,8 +5,7 @@
55 xml:id="sec-networking">
66 <title>Networking</title>
77 <para>
8− This section describes how to configure networking components on your NixOS
9− machine.
8+ This section describes how to configure networking components on your NixOS machine.
109 </para>
1110 <xi:include href="network-manager.xml" />
1211 <xi:include href="ssh.xml" />
nixos/doc/manual/configuration/package-mgmt.xml+3−10
@@ -5,23 +5,16 @@
55 xml:id="sec-package-management">
66 <title>Package Management</title>
77 <para>
8− This section describes how to add additional packages to your system. NixOS
9− has two distinct styles of package management:
8+ This section describes how to add additional packages to your system. NixOS has two distinct styles of package management:
109 <itemizedlist>
1110 <listitem>
1211 <para>
13− <emphasis>Declarative</emphasis>, where you declare what packages you want
14− in your <filename>configuration.nix</filename>. Every time you run
15− <command>nixos-rebuild</command>, NixOS will ensure that you get a
16− consistent set of binaries corresponding to your specification.
12+ <emphasis>Declarative</emphasis>, where you declare what packages you want in your <filename>configuration.nix</filename>. Every time you run <command>nixos-rebuild</command>, NixOS will ensure that you get a consistent set of binaries corresponding to your specification.
1713 </para>
1814 </listitem>
1915 <listitem>
2016 <para>
21− <emphasis>Ad hoc</emphasis>, where you install, upgrade and uninstall
22− packages via the <command>nix-env</command> command. This style allows
23− mixing packages from different Nixpkgs versions. It’s the only choice
24− for non-root users.
17+ <emphasis>Ad hoc</emphasis>, where you install, upgrade and uninstall packages via the <command>nix-env</command> command. This style allows mixing packages from different Nixpkgs versions. It’s the only choice for non-root users.
2518 </para>
2619 </listitem>
2720 </itemizedlist>
nixos/doc/manual/configuration/profiles.xml+3−10
@@ -5,12 +5,7 @@
55 xml:id="ch-profiles">
66 <title>Profiles</title>
77 <para>
8− In some cases, it may be desirable to take advantage of commonly-used,
9− predefined configurations provided by nixpkgs, but different from those that
10− come as default. This is a role fulfilled by NixOS's Profiles, which come as
11− files living in <filename>&lt;nixpkgs/nixos/modules/profiles&gt;</filename>.
12− That is to say, expected usage is to add them to the imports list of your
13− <filename>/etc/configuration.nix</filename> as such:
8+ In some cases, it may be desirable to take advantage of commonly-used, predefined configurations provided by nixpkgs, but different from those that come as default. This is a role fulfilled by NixOS's Profiles, which come as files living in <filename>&lt;nixpkgs/nixos/modules/profiles&gt;</filename>. That is to say, expected usage is to add them to the imports list of your <filename>/etc/configuration.nix</filename> as such:
149 </para>
1510<programlisting>
1611 imports = [
@@ -18,12 +13,10 @@
1813 ];
1914</programlisting>
2015 <para>
21− Even if some of these profiles seem only useful in the context of install
22− media, many are actually intended to be used in real installs.
16+ Even if some of these profiles seem only useful in the context of install media, many are actually intended to be used in real installs.
2317 </para>
2418 <para>
25− What follows is a brief explanation on the purpose and use-case for each
26− profile. Detailing each option configured by each one is out of scope.
19+ What follows is a brief explanation on the purpose and use-case for each profile. Detailing each option configured by each one is out of scope.
2720 </para>
2821 <xi:include href="profiles/all-hardware.xml" />
2922 <xi:include href="profiles/base.xml" />
nixos/doc/manual/configuration/profiles/all-hardware.xml+2−8
@@ -6,16 +6,10 @@
66 <title>All Hardware</title>
77
88 <para>
9− Enables all hardware supported by NixOS: i.e., all firmware is included, and
10− all devices from which one may boot are enabled in the initrd. Its primary
11− use is in the NixOS installation CDs.
9+ Enables all hardware supported by NixOS: i.e., all firmware is included, and all devices from which one may boot are enabled in the initrd. Its primary use is in the NixOS installation CDs.
1210 </para>
1311
1412 <para>
15− The enabled kernel modules include support for SATA and PATA, SCSI
16− (partially), USB, Firewire (untested), Virtio (QEMU, KVM, etc.), VMware, and
17− Hyper-V. Additionally, <xref linkend="opt-hardware.enableAllFirmware"/> is
18− enabled, and the firmware for the ZyDAS ZD1211 chipset is specifically
19− installed.
13+ The enabled kernel modules include support for SATA and PATA, SCSI (partially), USB, Firewire (untested), Virtio (QEMU, KVM, etc.), VMware, and Hyper-V. Additionally, <xref linkend="opt-hardware.enableAllFirmware"/> is enabled, and the firmware for the ZyDAS ZD1211 chipset is specifically installed.
2014 </para>
2115</section>
nixos/doc/manual/configuration/profiles/base.xml+1−5
@@ -6,10 +6,6 @@
66 <title>Base</title>
77
88 <para>
9− Defines the software packages included in the "minimal" installation CD. It
10− installs several utilities useful in a simple recovery or install media, such
11− as a text-mode web browser, and tools for manipulating block devices,
12− networking, hardware diagnostics, and filesystems (with their respective
13− kernel modules).
9+ Defines the software packages included in the "minimal" installation CD. It installs several utilities useful in a simple recovery or install media, such as a text-mode web browser, and tools for manipulating block devices, networking, hardware diagnostics, and filesystems (with their respective kernel modules).
1410 </para>
1511</section>
nixos/doc/manual/configuration/profiles/clone-config.xml+2−8
@@ -6,16 +6,10 @@
66 <title>Clone Config</title>
77
88 <para>
9− This profile is used in installer images. It provides an editable
10− configuration.nix that imports all the modules that were also used when
11− creating the image in the first place. As a result it allows users to edit
12− and rebuild the live-system.
9+ This profile is used in installer images. It provides an editable configuration.nix that imports all the modules that were also used when creating the image in the first place. As a result it allows users to edit and rebuild the live-system.
1310 </para>
1411
1512 <para>
16− On images where the installation media also becomes an installation target,
17− copying over <literal>configuration.nix</literal> should be disabled by
18− setting <literal>installer.cloneConfig</literal> to <literal>false</literal>.
19− For example, this is done in <literal>sd-image-aarch64.nix</literal>.
13+ On images where the installation media also becomes an installation target, copying over <literal>configuration.nix</literal> should be disabled by setting <literal>installer.cloneConfig</literal> to <literal>false</literal>. For example, this is done in <literal>sd-image-aarch64.nix</literal>.
2014 </para>
2115</section>
nixos/doc/manual/configuration/profiles/demo.xml+1−5
@@ -6,10 +6,6 @@
66 <title>Demo</title>
77
88 <para>
9− This profile just enables a <systemitem class="username">demo</systemitem>
10− user, with password <literal>demo</literal>, uid <literal>1000</literal>,
11− <systemitem class="groupname">wheel</systemitem> group and
12− <link linkend="opt-services.xserver.displayManager.sddm.autoLogin"> autologin
13− in the SDDM display manager</link>.
9+ This profile just enables a <systemitem class="username">demo</systemitem> user, with password <literal>demo</literal>, uid <literal>1000</literal>, <systemitem class="groupname">wheel</systemitem> group and <link linkend="opt-services.xserver.displayManager.sddm.autoLogin"> autologin in the SDDM display manager</link>.
1410 </para>
1511</section>
nixos/doc/manual/configuration/profiles/docker-container.xml+1−6
@@ -6,11 +6,6 @@
66 <title>Docker Container</title>
77
88 <para>
9− This is the profile from which the Docker images are generated. It prepares a
10− working system by importing the
11− <link linkend="sec-profile-minimal">Minimal</link> and
12− <link linkend="sec-profile-clone-config">Clone Config</link> profiles, and
13− setting appropriate configuration options that are useful inside a container
14− context, like <xref linkend="opt-boot.isContainer"/>.
9+ This is the profile from which the Docker images are generated. It prepares a working system by importing the <link linkend="sec-profile-minimal">Minimal</link> and <link linkend="sec-profile-clone-config">Clone Config</link> profiles, and setting appropriate configuration options that are useful inside a container context, like <xref linkend="opt-boot.isContainer"/>.
1510 </para>
1611</section>
nixos/doc/manual/configuration/profiles/graphical.xml+2−9
@@ -6,17 +6,10 @@
66 <title>Graphical</title>
77
88 <para>
9− Defines a NixOS configuration with the Plasma 5 desktop. It's used by the
10− graphical installation CD.
9+ Defines a NixOS configuration with the Plasma 5 desktop. It's used by the graphical installation CD.
1110 </para>
1211
1312 <para>
14− It sets <xref linkend="opt-services.xserver.enable"/>,
15− <xref linkend="opt-services.xserver.displayManager.sddm.enable"/>,
16− <xref linkend="opt-services.xserver.desktopManager.plasma5.enable"/> (
17− <link linkend="opt-services.xserver.desktopManager.plasma5.enableQt4Support">
18− without Qt4 Support</link>), and
19− <xref linkend="opt-services.xserver.libinput.enable"/> to true. It also
20− includes glxinfo and firefox in the system packages list.
13+ It sets <xref linkend="opt-services.xserver.enable"/>, <xref linkend="opt-services.xserver.displayManager.sddm.enable"/>, <xref linkend="opt-services.xserver.desktopManager.plasma5.enable"/> ( <link linkend="opt-services.xserver.desktopManager.plasma5.enableQt4Support"> without Qt4 Support</link>), and <xref linkend="opt-services.xserver.libinput.enable"/> to true. It also includes glxinfo and firefox in the system packages list.
2114 </para>
2215</section>
nixos/doc/manual/configuration/profiles/hardened.xml+3−11
@@ -6,19 +6,11 @@
66 <title>Hardened</title>
77
88 <para>
9− A profile with most (vanilla) hardening options enabled by default,
10− potentially at the cost of features and performance.
9+ A profile with most (vanilla) hardening options enabled by default, potentially at the cost of features and performance.
1110 </para>
1211
1312 <para>
14− This includes a hardened kernel, and limiting the system information
15− available to processes through the <filename>/sys</filename> and
16− <filename>/proc</filename> filesystems. It also disables the User Namespaces
17− feature of the kernel, which stops Nix from being able to build anything
18− (this particular setting can be overriden via
19− <xref linkend="opt-security.allowUserNamespaces"/>). See the
20− <literal
21− xlink:href="https://github.com/nixos/nixpkgs/tree/master/nixos/modules/profiles/hardened.nix">
22− profile source</literal> for further detail on which settings are altered.
13+ This includes a hardened kernel, and limiting the system information available to processes through the <filename>/sys</filename> and <filename>/proc</filename> filesystems. It also disables the User Namespaces feature of the kernel, which stops Nix from being able to build anything (this particular setting can be overriden via <xref linkend="opt-security.allowUserNamespaces"/>). See the <literal
14+ xlink:href="https://github.com/nixos/nixpkgs/tree/master/nixos/modules/profiles/hardened.nix"> profile source</literal> for further detail on which settings are altered.
2315 </para>
2416</section>
nixos/doc/manual/configuration/profiles/headless.xml+1−5
@@ -10,10 +10,6 @@
1010 </para>
1111
1212 <para>
13− Disables <link linkend="opt-sound.enable">sound</link>,
14− <link linkend="opt-boot.vesa">vesa</link>, serial consoles,
15− <link linkend="opt-systemd.enableEmergencyMode">emergency mode</link>,
16− <link linkend="opt-boot.loader.grub.splashImage">grub splash images</link>
17− and configures the kernel to reboot automatically on panic.
13+ Disables <link linkend="opt-sound.enable">sound</link>, <link linkend="opt-boot.vesa">vesa</link>, serial consoles, <link linkend="opt-systemd.enableEmergencyMode">emergency mode</link>, <link linkend="opt-boot.loader.grub.splashImage">grub splash images</link> and configures the kernel to reboot automatically on panic.
1814 </para>
1915</section>
nixos/doc/manual/configuration/profiles/installation-device.xml+6−19
@@ -6,31 +6,18 @@
66 <title>Installation Device</title>
77
88 <para>
9− Provides a basic configuration for installation devices like CDs.
10− This enables redistributable firmware, includes the
11− <link linkend="sec-profile-clone-config">Clone Config profile</link>
12− and a copy of the Nixpkgs channel, so <command>nixos-install</command>
13− works out of the box.
9+ Provides a basic configuration for installation devices like CDs. This enables redistributable firmware, includes the <link linkend="sec-profile-clone-config">Clone Config profile</link> and a copy of the Nixpkgs channel, so <command>nixos-install</command> works out of the box.
1410 </para>
11+
1512 <para>
16− Documentation for <link linkend="opt-documentation.enable">Nixpkgs</link>
17− and <link linkend="opt-documentation.nixos.enable">NixOS</link> are
18− forcefully enabled (to override the
19− <link linkend="sec-profile-minimal">Minimal profile</link> preference); the
20− NixOS manual is shown automatically on TTY 8, udisks is disabled.
21− Autologin is enabled as <literal>nixos</literal> user, while passwordless
22− login as both <literal>root</literal> and <literal>nixos</literal> is possible.
23− Passwordless <command>sudo</command> is enabled too.
24− <link linkend="opt-networking.wireless.enable">wpa_supplicant</link> is
25− enabled, but configured to not autostart.
13+ Documentation for <link linkend="opt-documentation.enable">Nixpkgs</link> and <link linkend="opt-documentation.nixos.enable">NixOS</link> are forcefully enabled (to override the <link linkend="sec-profile-minimal">Minimal profile</link> preference); the NixOS manual is shown automatically on TTY 8, udisks is disabled. Autologin is enabled as <literal>nixos</literal> user, while passwordless login as both <literal>root</literal> and <literal>nixos</literal> is possible. Passwordless <command>sudo</command> is enabled too. <link linkend="opt-networking.wireless.enable">wpa_supplicant</link> is enabled, but configured to not autostart.
2614 </para>
15+
2716 <para>
28− It is explained how to login, start the ssh server, and if available,
29− how to start the display manager.
17+ It is explained how to login, start the ssh server, and if available, how to start the display manager.
3018 </para>
3119
3220 <para>
33− Several settings are tweaked so that the installer has a better chance of
34− succeeding under low-memory environments.
21+ Several settings are tweaked so that the installer has a better chance of succeeding under low-memory environments.
3522 </para>
3623</section>
nixos/doc/manual/configuration/profiles/minimal.xml+1−7
@@ -6,12 +6,6 @@
66 <title>Minimal</title>
77
88 <para>
9− This profile defines a small NixOS configuration. It does not contain any
10− graphical stuff. It's a very short file that enables
11− <link linkend="opt-environment.noXlibs">noXlibs</link>, sets
12− <link linkend="opt-i18n.supportedLocales">i18n.supportedLocales</link> to
13− only support the user-selected locale,
14− <link linkend="opt-documentation.enable">disables packages' documentation
15− </link>, and <link linkend="opt-sound.enable">disables sound</link>.
9+ This profile defines a small NixOS configuration. It does not contain any graphical stuff. It's a very short file that enables <link linkend="opt-environment.noXlibs">noXlibs</link>, sets <link linkend="opt-i18n.supportedLocales">i18n.supportedLocales</link> to only support the user-selected locale, <link linkend="opt-documentation.enable">disables packages' documentation </link>, and <link linkend="opt-sound.enable">disables sound</link>.
1610 </para>
1711</section>
nixos/doc/manual/configuration/profiles/qemu-guest.xml+2−5
@@ -6,13 +6,10 @@
66 <title>QEMU Guest</title>
77
88 <para>
9− This profile contains common configuration for virtual machines running under
10− QEMU (using virtio).
9+ This profile contains common configuration for virtual machines running under QEMU (using virtio).
1110 </para>
1211
1312 <para>
14− It makes virtio modules available on the initrd, sets the system time from
15− the hardware clock to work around a bug in qemu-kvm, and
16− <link linkend="opt-security.rngd.enable">enables rngd</link>.
13+ It makes virtio modules available on the initrd, sets the system time from the hardware clock to work around a bug in qemu-kvm, and <link linkend="opt-security.rngd.enable">enables rngd</link>.
1714 </para>
1815</section>
nixos/doc/manual/configuration/ssh.xml+2−5
@@ -10,14 +10,11 @@
1010<programlisting>
1111<xref linkend="opt-services.openssh.enable"/> = true;
1212</programlisting>
13− By default, root logins using a password are disallowed. They can be disabled
14− entirely by setting <xref linkend="opt-services.openssh.permitRootLogin"/> to
15− <literal>"no"</literal>.
13+ By default, root logins using a password are disallowed. They can be disabled entirely by setting <xref linkend="opt-services.openssh.permitRootLogin"/> to <literal>"no"</literal>.
1614 </para>
1715
1816 <para>
19− You can declaratively specify authorised RSA/DSA public keys for a user as
20− follows:
17+ You can declaratively specify authorised RSA/DSA public keys for a user as follows:
2118<!-- FIXME: this might not work if the user is unmanaged. -->
2219<programlisting>
2320<link linkend="opt-users.users._name__.openssh.authorizedKeys.keys">users.users.alice.openssh.authorizedKeys.keys</link> =
nixos/doc/manual/configuration/summary.xml+2−6
@@ -6,12 +6,8 @@
66 <title>Syntax Summary</title>
77
88 <para>
9− Below is a summary of the most important syntactic constructs in the Nix
10− expression language. It’s not complete. In particular, there are many other
11− built-in functions. See the
12− <link
13−xlink:href="http://nixos.org/nix/manual/#chap-writing-nix-expressions">Nix
14− manual</link> for the rest.
9+ Below is a summary of the most important syntactic constructs in the Nix expression language. It’s not complete. In particular, there are many other built-in functions. See the <link
10+xlink:href="http://nixos.org/nix/manual/#chap-writing-nix-expressions">Nix manual</link> for the rest.
1511 </para>
1612
1713 <informaltable frame='none'>
nixos/doc/manual/configuration/user-mgmt.xml+10−43
@@ -5,10 +5,7 @@
55 xml:id="sec-user-management">
66 <title>User Management</title>
77 <para>
8− NixOS supports both declarative and imperative styles of user management. In
9− the declarative style, users are specified in
10− <filename>configuration.nix</filename>. For instance, the following states
11− that a user account named <literal>alice</literal> shall exist:
8+ NixOS supports both declarative and imperative styles of user management. In the declarative style, users are specified in <filename>configuration.nix</filename>. For instance, the following states that a user account named <literal>alice</literal> shall exist:
129<programlisting>
1310<xref linkend="opt-users.users"/>.alice = {
1411 <link linkend="opt-users.users._name__.isNormalUser">isNormalUser</link> = true;
@@ -18,60 +15,33 @@
1815 <link linkend="opt-users.users._name__.openssh.authorizedKeys.keys">openssh.authorizedKeys.keys</link> = [ "ssh-dss AAAAB3Nza... alice@foobar" ];
1916};
2017</programlisting>
21− Note that <literal>alice</literal> is a member of the
22− <literal>wheel</literal> and <literal>networkmanager</literal> groups, which
23− allows her to use <command>sudo</command> to execute commands as
24− <literal>root</literal> and to configure the network, respectively. Also note
25− the SSH public key that allows remote logins with the corresponding private
26− key. Users created in this way do not have a password by default, so they
27− cannot log in via mechanisms that require a password. However, you can use
28− the <command>passwd</command> program to set a password, which is retained
29− across invocations of <command>nixos-rebuild</command>.
18+ Note that <literal>alice</literal> is a member of the <literal>wheel</literal> and <literal>networkmanager</literal> groups, which allows her to use <command>sudo</command> to execute commands as <literal>root</literal> and to configure the network, respectively. Also note the SSH public key that allows remote logins with the corresponding private key. Users created in this way do not have a password by default, so they cannot log in via mechanisms that require a password. However, you can use the <command>passwd</command> program to set a password, which is retained across invocations of <command>nixos-rebuild</command>.
3019 </para>
3120 <para>
32− If you set <xref linkend="opt-users.mutableUsers"/> to false, then the
33− contents of <literal>/etc/passwd</literal> and <literal>/etc/group</literal>
34− will be congruent to your NixOS configuration. For instance, if you remove a
35− user from <xref linkend="opt-users.users"/> and run nixos-rebuild, the user
36− account will cease to exist. Also, imperative commands for managing users and
37− groups, such as useradd, are no longer available. Passwords may still be
38− assigned by setting the user's
39− <link linkend="opt-users.users._name__.hashedPassword">hashedPassword</link>
40− option. A hashed password can be generated using <command>mkpasswd -m
41− sha-512</command> after installing the <literal>mkpasswd</literal> package.
21+ If you set <xref linkend="opt-users.mutableUsers"/> to false, then the contents of <literal>/etc/passwd</literal> and <literal>/etc/group</literal> will be congruent to your NixOS configuration. For instance, if you remove a user from <xref linkend="opt-users.users"/> and run nixos-rebuild, the user account will cease to exist. Also, imperative commands for managing users and groups, such as useradd, are no longer available. Passwords may still be assigned by setting the user's <link linkend="opt-users.users._name__.hashedPassword">hashedPassword</link> option. A hashed password can be generated using <command>mkpasswd -m sha-512</command> after installing the <literal>mkpasswd</literal> package.
4222 </para>
4323 <para>
44− A user ID (uid) is assigned automatically. You can also specify a uid
45− manually by adding
24+ A user ID (uid) is assigned automatically. You can also specify a uid manually by adding
4625<programlisting>
4726uid = 1000;
4827</programlisting>
4928 to the user specification.
5029 </para>
5130 <para>
52− Groups can be specified similarly. The following states that a group named
53− <literal>students</literal> shall exist:
31+ Groups can be specified similarly. The following states that a group named <literal>students</literal> shall exist:
5432<programlisting>
5533<xref linkend="opt-users.groups"/>.students.gid = 1000;
5634</programlisting>
57− As with users, the group ID (gid) is optional and will be assigned
58− automatically if it’s missing.
35+ As with users, the group ID (gid) is optional and will be assigned automatically if it’s missing.
5936 </para>
6037 <para>
61− In the imperative style, users and groups are managed by commands such as
62− <command>useradd</command>, <command>groupmod</command> and so on. For
63− instance, to create a user account named <literal>alice</literal>:
38+ In the imperative style, users and groups are managed by commands such as <command>useradd</command>, <command>groupmod</command> and so on. For instance, to create a user account named <literal>alice</literal>:
6439<screen>
6540# useradd -m alice</screen>
66− To make all nix tools available to this new user use `su - USER` which opens
67− a login shell (==shell that loads the profile) for given user. This will
68− create the ~/.nix-defexpr symlink. So run:
41+ To make all nix tools available to this new user use `su - USER` which opens a login shell (==shell that loads the profile) for given user. This will create the ~/.nix-defexpr symlink. So run:
6942<screen>
7043# su - alice -c "true"</screen>
71− The flag <option>-m</option> causes the creation of a home directory for the
72− new user, which is generally what you want. The user does not have an initial
73− password and therefore cannot log in. A password can be set using the
74− <command>passwd</command> utility:
44+ The flag <option>-m</option> causes the creation of a home directory for the new user, which is generally what you want. The user does not have an initial password and therefore cannot log in. A password can be set using the <command>passwd</command> utility:
7545<screen>
7646# passwd alice
7747Enter new UNIX password: ***
@@ -80,9 +50,6 @@ Retype new UNIX password: ***
8050 A user can be deleted using <command>userdel</command>:
8151<screen>
8252# userdel -r alice</screen>
83− The flag <option>-r</option> deletes the user’s home directory. Accounts
84− can be modified using <command>usermod</command>. Unix groups can be managed
85− using <command>groupadd</command>, <command>groupmod</command> and
86− <command>groupdel</command>.
53+ The flag <option>-r</option> deletes the user’s home directory. Accounts can be modified using <command>usermod</command>. Unix groups can be managed using <command>groupadd</command>, <command>groupmod</command> and <command>groupdel</command>.
8754 </para>
8855</chapter>
nixos/doc/manual/configuration/wireless.xml+5−13
@@ -6,9 +6,7 @@
66 <title>Wireless Networks</title>
77
88 <para>
9− For a desktop installation using NetworkManager (e.g., GNOME), you just have
10− to make sure the user is in the <code>networkmanager</code> group and you can
11− skip the rest of this section on wireless networks.
9+ For a desktop installation using NetworkManager (e.g., GNOME), you just have to make sure the user is in the <code>networkmanager</code> group and you can skip the rest of this section on wireless networks.
1210 </para>
1311
1412 <para>
@@ -25,17 +23,13 @@
2523 "free.wifi" = {};
2624};
2725</programlisting>
28− Be aware that keys will be written to the nix store in plaintext! When no
29− networks are set, it will default to using a configuration file at
30− <literal>/etc/wpa_supplicant.conf</literal>. You should edit this file
31− yourself to define wireless networks, WPA keys and so on (see <citerefentry>
26+ Be aware that keys will be written to the nix store in plaintext! When no networks are set, it will default to using a configuration file at <literal>/etc/wpa_supplicant.conf</literal>. You should edit this file yourself to define wireless networks, WPA keys and so on (see <citerefentry>
3227 <refentrytitle>wpa_supplicant.conf</refentrytitle>
3328 <manvolnum>5</manvolnum> </citerefentry>).
3429 </para>
3530
3631 <para>
37− If you are using WPA2 you can generate pskRaw key using
38− <command>wpa_passphrase</command>:
32+ If you are using WPA2 you can generate pskRaw key using <command>wpa_passphrase</command>:
3933<screen>
4034<prompt>$ </prompt>wpa_passphrase ESSID PSK
4135network={
@@ -51,12 +45,10 @@ network={
5145 };
5246}
5347</programlisting>
54− or you can use it to directly generate the
55− <literal>wpa_supplicant.conf</literal>:
48+ or you can use it to directly generate the <literal>wpa_supplicant.conf</literal>:
5649<screen>
5750<prompt># </prompt>wpa_passphrase ESSID PSK > /etc/wpa_supplicant.conf</screen>
58− After you have edited the <literal>wpa_supplicant.conf</literal>, you need to
59− restart the wpa_supplicant service.
51+ After you have edited the <literal>wpa_supplicant.conf</literal>, you need to restart the wpa_supplicant service.
6052<screen>
6153<prompt># </prompt>systemctl restart wpa_supplicant.service</screen>
6254 </para>
nixos/doc/manual/configuration/x-windows.xml+40−111
@@ -5,23 +5,18 @@
55 xml:id="sec-x11">
66 <title>X Window System</title>
77 <para>
8− The X Window System (X11) provides the basis of NixOS’ graphical user
9− interface. It can be enabled as follows:
8+ The X Window System (X11) provides the basis of NixOS’ graphical user interface. It can be enabled as follows:
109<programlisting>
1110<xref linkend="opt-services.xserver.enable"/> = true;
1211</programlisting>
13− The X server will automatically detect and use the appropriate video driver
14− from a set of X.org drivers (such as <literal>vesa</literal> and
15− <literal>intel</literal>). You can also specify a driver manually, e.g.
12+ The X server will automatically detect and use the appropriate video driver from a set of X.org drivers (such as <literal>vesa</literal> and <literal>intel</literal>). You can also specify a driver manually, e.g.
1613<programlisting>
1714<xref linkend="opt-services.xserver.videoDrivers"/> = [ "r128" ];
1815</programlisting>
1916 to enable X.org’s <literal>xf86-video-r128</literal> driver.
2017 </para>
2118 <para>
22− You also need to enable at least one desktop or window manager. Otherwise,
23− you can only log into a plain undecorated <command>xterm</command> window.
24− Thus you should pick one or more of the following lines:
19+ You also need to enable at least one desktop or window manager. Otherwise, you can only log into a plain undecorated <command>xterm</command> window. Thus you should pick one or more of the following lines:
2520<programlisting>
2621<xref linkend="opt-services.xserver.desktopManager.plasma5.enable"/> = true;
2722<xref linkend="opt-services.xserver.desktopManager.xfce.enable"/> = true;
@@ -34,9 +29,7 @@
3429</programlisting>
3530 </para>
3631 <para>
37− NixOS’s default <emphasis>display manager</emphasis> (the program that
38− provides a graphical login prompt and manages the X server) is LightDM. You
39− can select an alternative one by picking one of the following lines:
32+ NixOS’s default <emphasis>display manager</emphasis> (the program that provides a graphical login prompt and manages the X server) is LightDM. You can select an alternative one by picking one of the following lines:
4033<programlisting>
4134<xref linkend="opt-services.xserver.displayManager.sddm.enable"/> = true;
4235<xref linkend="opt-services.xserver.displayManager.slim.enable"/> = true;
@@ -50,8 +43,7 @@
5043</programlisting>
5144 </para>
5245 <para>
53− The X server is started automatically at boot time. If you don’t want this
54− to happen, you can set:
46+ The X server is started automatically at boot time. If you don’t want this to happen, you can set:
5547<programlisting>
5648<xref linkend="opt-services.xserver.autorun"/> = false;
5749</programlisting>
@@ -61,8 +53,7 @@
6153</screen>
6254 </para>
6355 <para>
64− On 64-bit systems, if you want OpenGL for 32-bit programs such as in Wine,
65− you should also set the following:
56+ On 64-bit systems, if you want OpenGL for 32-bit programs such as in Wine, you should also set the following:
6657<programlisting>
6758<xref linkend="opt-hardware.opengl.driSupport32Bit"/> = true;
6859</programlisting>
@@ -70,23 +61,18 @@
7061 <simplesect xml:id="sec-x11-auto-login">
7162 <title>Auto-login</title>
7263 <para>
73− The x11 login screen can be skipped entirely, automatically logging you into
74− your window manager and desktop environment when you boot your computer.
64+ The x11 login screen can be skipped entirely, automatically logging you into your window manager and desktop environment when you boot your computer.
7565 </para>
7666 <para>
77− This is especially helpful if you have disk encryption enabled. Since you
78− already have to provide a password to decrypt your disk, entering a second
79− password to login can be redundant.
67+ This is especially helpful if you have disk encryption enabled. Since you already have to provide a password to decrypt your disk, entering a second password to login can be redundant.
8068 </para>
8169 <para>
82− To enable auto-login, you need to define your default window manager and
83− desktop environment. If you wanted no desktop environment and i3 as your your
84− window manager, you'd define:
70+ To enable auto-login, you need to define your default window manager and desktop environment. If you wanted no desktop environment and i3 as your your window manager, you'd define:
8571<programlisting>
8672<xref linkend="opt-services.xserver.desktopManager.default"/> = "none";
8773<xref linkend="opt-services.xserver.windowManager.default"/> = "i3";
8874</programlisting>
89− And, finally, to enable auto-login for a user <literal>johndoe</literal>:
75+ And, finally, to enable auto-login for a user <literal>johndoe</literal>:
9076<programlisting>
9177<xref linkend="opt-services.xserver.displayManager.auto.enable"/> = true;
9278<xref linkend="opt-services.xserver.displayManager.auto.user"/> = "johndoe";
@@ -96,9 +82,7 @@
9682 <simplesect xml:id="sec-x11-graphics-cards-nvidia">
9783 <title>Proprietary NVIDIA drivers</title>
9884 <para>
99− NVIDIA provides a proprietary driver for its graphics cards that has better
100− 3D performance than the X.org drivers. It is not enabled by default because
101− it’s not free software. You can enable it as follows:
85+ NVIDIA provides a proprietary driver for its graphics cards that has better 3D performance than the X.org drivers. It is not enabled by default because it’s not free software. You can enable it as follows:
10286<programlisting>
10387<xref linkend="opt-services.xserver.videoDrivers"/> = [ "nvidia" ];
10488</programlisting>
@@ -109,76 +93,51 @@
10993<xref linkend="opt-services.xserver.videoDrivers"/> = [ "nvidiaLegacy304" ];
11094<xref linkend="opt-services.xserver.videoDrivers"/> = [ "nvidiaLegacy173" ];
11195</programlisting>
112− You may need to reboot after enabling this driver to prevent a clash with
113− other kernel modules.
96+ You may need to reboot after enabling this driver to prevent a clash with other kernel modules.
11497 </para>
11598 </simplesect>
11699 <simplesect xml:id="sec-x11--graphics-cards-amd">
117100 <title>Proprietary AMD drivers</title>
118101 <para>
119− AMD provides a proprietary driver for its graphics cards that has better 3D
120− performance than the X.org drivers. It is not enabled by default because
121− it’s not free software. You can enable it as follows:
102+ AMD provides a proprietary driver for its graphics cards that has better 3D performance than the X.org drivers. It is not enabled by default because it’s not free software. You can enable it as follows:
122103<programlisting>
123104<xref linkend="opt-services.xserver.videoDrivers"/> = [ "ati_unfree" ];
124105</programlisting>
125− You will need to reboot after enabling this driver to prevent a clash with
126− other kernel modules.
106+ You will need to reboot after enabling this driver to prevent a clash with other kernel modules.
127107 </para>
128108 <note>
129− <para>
130− For recent AMD GPUs you most likely want to keep either the defaults
131− or <literal>"amdgpu"</literal> (both free).
132− </para>
109+ <para>
110+ For recent AMD GPUs you most likely want to keep either the defaults or <literal>"amdgpu"</literal> (both free).
111+ </para>
133112 </note>
134113 </simplesect>
135114 <simplesect xml:id="sec-x11-touchpads">
136115 <title>Touchpads</title>
137116 <para>
138− Support for Synaptics touchpads (found in many laptops such as the Dell
139− Latitude series) can be enabled as follows:
117+ Support for Synaptics touchpads (found in many laptops such as the Dell Latitude series) can be enabled as follows:
140118<programlisting>
141119<xref linkend="opt-services.xserver.libinput.enable"/> = true;
142120</programlisting>
143− The driver has many options (see <xref linkend="ch-options"/>). For
144− instance, the following disables tap-to-click behavior:
121+ The driver has many options (see <xref linkend="ch-options"/>). For instance, the following disables tap-to-click behavior:
145122<programlisting>
146123<xref linkend="opt-services.xserver.libinput.tapping"/> = false;
147124</programlisting>
148− Note: the use of <literal>services.xserver.synaptics</literal> is deprecated
149− since NixOS 17.09.
125+ Note: the use of <literal>services.xserver.synaptics</literal> is deprecated since NixOS 17.09.
150126 </para>
151127 </simplesect>
152128 <simplesect xml:id="sec-x11-gtk-and-qt-themes">
153129 <title>GTK/Qt themes</title>
154130 <para>
155− GTK themes can be installed either to user profile or system-wide (via
156− <literal>environment.systemPackages</literal>). To make Qt 5 applications
157− look similar to GTK2 ones, you can install <literal>qt5.qtbase.gtk</literal>
158− package into your system environment. It should work for all Qt 5 library
159− versions.
131+ GTK themes can be installed either to user profile or system-wide (via <literal>environment.systemPackages</literal>). To make Qt 5 applications look similar to GTK2 ones, you can install <literal>qt5.qtbase.gtk</literal> package into your system environment. It should work for all Qt 5 library versions.
160132 </para>
161133 </simplesect>
162134 <simplesect xml:id="custom-xkb-layouts">
163135 <title>Custom XKB layouts</title>
164136 <para>
165− It is possible to install custom
166− <link xlink:href="https://en.wikipedia.org/wiki/X_keyboard_extension">
167− XKB
168− </link>
169− keyboard layouts using the option
170− <option>
171− <link linkend="opt-services.xserver.extraLayouts">
172− services.xserver.extraLayouts
173− </link>
174− </option>.
175− As a first example, we are going to create a layout based on the basic US
176− layout, with an additional layer to type some greek symbols by pressing the
177− right-alt key.
137+ It is possible to install custom <link xlink:href="https://en.wikipedia.org/wiki/X_keyboard_extension"> XKB </link> keyboard layouts using the option <option> <link linkend="opt-services.xserver.extraLayouts"> services.xserver.extraLayouts </link> </option>. As a first example, we are going to create a layout based on the basic US layout, with an additional layer to type some greek symbols by pressing the right-alt key.
178138 </para>
179139 <para>
180− To do this we are going to create a <literal>us-greek</literal> file
181− with a <literal>xkb_symbols</literal> section.
140+ To do this we are going to create a <literal>us-greek</literal> file with a <literal>xkb_symbols</literal> section.
182141 </para>
183142<programlisting>
184143xkb_symbols &quot;us-greek&quot;
@@ -194,8 +153,7 @@ xkb_symbols &quot;us-greek&quot;
194153};
195154</programlisting>
196155 <para>
197− To install the layout, the filepath, a description and the list of
198− languages must be given:
156+ To install the layout, the filepath, a description and the list of languages must be given:
199157 </para>
200158<programlisting>
201159<xref linkend="opt-services.xserver.extraLayouts"/>.us-greek = {
@@ -205,32 +163,18 @@ xkb_symbols &quot;us-greek&quot;
205163}
206164</programlisting>
207165 <note>
208− <para>
209− The name should match the one given to the
210− <literal>xkb_symbols</literal> block.
211− </para>
166+ <para>
167+ The name should match the one given to the <literal>xkb_symbols</literal> block.
168+ </para>
212169 </note>
213170 <para>
214− The layout should now be installed and ready to use: try it by
215− running <literal>setxkbmap us-greek</literal> and type
216− <literal>&lt;alt&gt;+a</literal>. To change the default the usual
217− <option>
218− <link linkend="opt-services.xserver.layout">
219− services.xserver.layout
220− </link>
221− </option>
222− option can still be used.
171+ The layout should now be installed and ready to use: try it by running <literal>setxkbmap us-greek</literal> and type <literal>&lt;alt&gt;+a</literal>. To change the default the usual <option> <link linkend="opt-services.xserver.layout"> services.xserver.layout </link> </option> option can still be used.
223172 </para>
224173 <para>
225− A layout can have several other components besides
226− <literal>xkb_symbols</literal>, for example we will define new
227− keycodes for some multimedia key and bind these to some symbol.
174+ A layout can have several other components besides <literal>xkb_symbols</literal>, for example we will define new keycodes for some multimedia key and bind these to some symbol.
228175 </para>
229176 <para>
230− Use the <emphasis>xev</emphasis> utility from
231− <literal>pkgs.xorg.xev</literal> to find the codes of the keys of
232− interest, then create a <literal>media-key</literal> file to hold
233− the keycodes definitions
177+ Use the <emphasis>xev</emphasis> utility from <literal>pkgs.xorg.xev</literal> to find the codes of the keys of interest, then create a <literal>media-key</literal> file to hold the keycodes definitions
234178 </para>
235179<programlisting>
236180xkb_keycodes &quot;media&quot;
@@ -240,7 +184,7 @@ xkb_keycodes &quot;media&quot;
240184}
241185</programlisting>
242186 <para>
243− Now use the newly define keycodes in <literal>media-sym</literal>:
187+ Now use the newly define keycodes in <literal>media-sym</literal>:
244188 </para>
245189<programlisting>
246190xkb_symbols &quot;media&quot;
@@ -251,7 +195,7 @@ xkb_symbols &quot;media&quot;
251195}
252196</programlisting>
253197 <para>
254− As before, to install the layout do
198+ As before, to install the layout do
255199 </para>
256200<programlisting>
257201<xref linkend="opt-services.xserver.extraLayouts"/>.media = {
@@ -262,37 +206,22 @@ xkb_symbols &quot;media&quot;
262206};
263207</programlisting>
264208 <note>
265− <para>
266− The function <literal>pkgs.writeText &lt;filename&gt; &lt;content&gt;
267− </literal> can be useful if you prefer to keep the layout definitions
268− inside the NixOS configuration.
269− </para>
209+ <para>
210+ The function <literal>pkgs.writeText &lt;filename&gt; &lt;content&gt; </literal> can be useful if you prefer to keep the layout definitions inside the NixOS configuration.
211+ </para>
270212 </note>
271213 <para>
272− Unfortunately, the Xorg server does not (currently) support setting a
273− keymap directly but relies instead on XKB rules to select the matching
274− components (keycodes, types, ...) of a layout. This means that components
275− other than symbols won't be loaded by default. As a workaround, you
276− can set the keymap using <literal>setxkbmap</literal> at the start of the
277− session with:
214+ Unfortunately, the Xorg server does not (currently) support setting a keymap directly but relies instead on XKB rules to select the matching components (keycodes, types, ...) of a layout. This means that components other than symbols won't be loaded by default. As a workaround, you can set the keymap using <literal>setxkbmap</literal> at the start of the session with:
278215 </para>
279216<programlisting>
280217<xref linkend="opt-services.xserver.displayManager.sessionCommands"/> = "setxkbmap -keycodes media";
281218</programlisting>
282219 <para>
283− If you are manually starting the X server, you should set the argument
284− <literal>-xkbdir /etc/X11/xkb</literal>, otherwise X won't find your layout files.
285− For example with <command>xinit</command> run
286− <screen><prompt>$ </prompt>xinit -- -xkbdir /etc/X11/xkb</screen>
220+ If you are manually starting the X server, you should set the argument <literal>-xkbdir /etc/X11/xkb</literal>, otherwise X won't find your layout files. For example with <command>xinit</command> run
221+<screen><prompt>$ </prompt>xinit -- -xkbdir /etc/X11/xkb</screen>
287222 </para>
288223 <para>
289− To learn how to write layouts take a look at the XKB
290− <link xlink:href="https://www.x.org/releases/current/doc/xorg-docs/input/XKB-Enhancing.html#Defining_New_Layouts">
291− documentation
292− </link>. More example layouts can also be found
293− <link xlink:href="https://wiki.archlinux.org/index.php/X_KeyBoard_extension#Basic_examples">
294− here
295− </link>.
224+ To learn how to write layouts take a look at the XKB <link xlink:href="https://www.x.org/releases/current/doc/xorg-docs/input/XKB-Enhancing.html#Defining_New_Layouts"> documentation </link>. More example layouts can also be found <link xlink:href="https://wiki.archlinux.org/index.php/X_KeyBoard_extension#Basic_examples"> here </link>.
296225 </para>
297−</simplesect>
226+ </simplesect>
298227</chapter>
nixos/doc/manual/configuration/xfce.xml+5−16
@@ -14,8 +14,7 @@
1414</programlisting>
1515 </para>
1616 <para>
17− Optionally, <emphasis>compton</emphasis> can be enabled for nice graphical
18− effects, some example settings:
17+ Optionally, <emphasis>compton</emphasis> can be enabled for nice graphical effects, some example settings:
1918<programlisting>
2019<link linkend="opt-services.compton.enable">services.compton</link> = {
2120 <link linkend="opt-services.compton.enable">enable</link> = true;
@@ -27,9 +26,7 @@
2726</programlisting>
2827 </para>
2928 <para>
30− Some Xfce programs are not installed automatically. To install them manually
31− (system wide), put them into your
32− <xref linkend="opt-environment.systemPackages"/>.
29+ Some Xfce programs are not installed automatically. To install them manually (system wide), put them into your <xref linkend="opt-environment.systemPackages"/>.
3330 </para>
3431 <simplesect xml:id="sec-xfce-thunar-volumes">
3532 <title>Thunar Volume Support</title>
@@ -44,25 +41,17 @@
4441 <simplesect xml:id="sec-xfce-polkit">
4542 <title>Polkit Authentication Agent</title>
4643 <para>
47− There is no authentication agent automatically installed alongside Xfce. To
48− allow mounting of local (non-removable) filesystems, you will need to
49− install one. Installing <emphasis>polkit_gnome</emphasis>, a rebuild, logout
50− and login did the trick.
44+ There is no authentication agent automatically installed alongside Xfce. To allow mounting of local (non-removable) filesystems, you will need to install one. Installing <emphasis>polkit_gnome</emphasis>, a rebuild, logout and login did the trick.
5145 </para>
5246 </simplesect>
5347 <simplesect xml:id="sec-xfce-troubleshooting">
5448 <title>Troubleshooting</title>
5549 <para>
56− Even after enabling udisks2, volume management might not work. Thunar and/or
57− the desktop takes time to show up. Thunar will spit out this kind of message
58− on start (look at <command>journalctl --user -b</command>).
50+ Even after enabling udisks2, volume management might not work. Thunar and/or the desktop takes time to show up. Thunar will spit out this kind of message on start (look at <command>journalctl --user -b</command>).
5951<programlisting>
6052Thunar:2410): GVFS-RemoteVolumeMonitor-WARNING **: remote volume monitor with dbus name org.gtk.Private.UDisks2VolumeMonitor is not supported
6153</programlisting>
62− This is caused by some needed GNOME services not running. This is all fixed
63− by enabling "Launch GNOME services on startup" in the Advanced tab of the
64− Session and Startup settings panel. Alternatively, you can run this command
65− to do the same thing.
54+ This is caused by some needed GNOME services not running. This is all fixed by enabling "Launch GNOME services on startup" in the Advanced tab of the Session and Startup settings panel. Alternatively, you can run this command to do the same thing.
6655<programlisting>
6756<prompt>$ </prompt>xfconf-query -c xfce4-session -p /compat/LaunchGNOME -s true
6857</programlisting>
nixos/doc/manual/development/assertions.xml+3−15
@@ -6,18 +6,11 @@
66 <title>Warnings and Assertions</title>
77
88 <para>
9− When configuration problems are detectable in a module, it is a good idea to
10− write an assertion or warning. Doing so provides clear feedback to the user
11− and prevents errors after the build.
9+ When configuration problems are detectable in a module, it is a good idea to write an assertion or warning. Doing so provides clear feedback to the user and prevents errors after the build.
1210 </para>
1311
1412 <para>
15− Although Nix has the <literal>abort</literal> and
16− <literal>builtins.trace</literal>
17− <link xlink:href="https://nixos.org/nix/manual/#ssec-builtins">functions</link>
18− to perform such tasks, they are not ideally suited for NixOS modules. Instead
19− of these functions, you can declare your warnings and assertions using the
20− NixOS module system.
13+ Although Nix has the <literal>abort</literal> and <literal>builtins.trace</literal> <link xlink:href="https://nixos.org/nix/manual/#ssec-builtins">functions</link> to perform such tasks, they are not ideally suited for NixOS modules. Instead of these functions, you can declare your warnings and assertions using the NixOS module system.
2114 </para>
2215
2316 <section xml:id="sec-assertions-warnings">
@@ -48,12 +41,7 @@
4841 <title>Assertions</title>
4942
5043 <para>
51− This example, extracted from the
52− <link xlink:href="https://github.com/NixOS/nixpkgs/blob/release-17.09/nixos/modules/services/logging/syslogd.nix">
53− <literal>syslogd</literal> module </link> shows how to use
54− <literal>assertions</literal>. Since there can only be one active syslog
55− daemon at a time, an assertion is useful to prevent such a broken system
56− from being built.
44+ This example, extracted from the <link xlink:href="https://github.com/NixOS/nixpkgs/blob/release-17.09/nixos/modules/services/logging/syslogd.nix"> <literal>syslogd</literal> module </link> shows how to use <literal>assertions</literal>. Since there can only be one active syslog daemon at a time, an assertion is useful to prevent such a broken system from being built.
5745 </para>
5846
5947<programlisting>
nixos/doc/manual/development/building-nixos.xml+3−8
@@ -5,22 +5,17 @@
55 xml:id="sec-building-cd">
66 <title>Building Your Own NixOS CD</title>
77 <para>
8− Building a NixOS CD is as easy as configuring your own computer. The idea is
9− to use another module which will replace your
10− <filename>configuration.nix</filename> to configure the system that would be
11− installed on the CD.
8+ Building a NixOS CD is as easy as configuring your own computer. The idea is to use another module which will replace your <filename>configuration.nix</filename> to configure the system that would be installed on the CD.
129 </para>
1310 <para>
14− Default CD/DVD configurations are available inside
15− <filename>nixos/modules/installer/cd-dvd</filename>.
11+ Default CD/DVD configurations are available inside <filename>nixos/modules/installer/cd-dvd</filename>.
1612<screen>
1713<prompt>$ </prompt>git clone https://github.com/NixOS/nixpkgs.git
1814<prompt>$ </prompt>cd nixpkgs/nixos
1915<prompt>$ </prompt>nix-build -A config.system.build.isoImage -I nixos-config=modules/installer/cd-dvd/installation-cd-minimal.nix default.nix</screen>
2016 </para>
2117 <para>
22− Before burning your CD/DVD, you can check the content of the image by
23− mounting anywhere like suggested by the following command:
18+ Before burning your CD/DVD, you can check the content of the image by mounting anywhere like suggested by the following command:
2419<screen>
2520<prompt># </prompt>mount -o loop -t iso9660 ./result/iso/cd.iso /mnt/iso</screen>
2621 </para>
nixos/doc/manual/development/building-parts.xml+8−23
@@ -5,14 +5,11 @@
55 xml:id="sec-building-parts">
66 <title>Building Specific Parts of NixOS</title>
77 <para>
8− With the command <command>nix-build</command>, you can build specific parts
9− of your NixOS configuration. This is done as follows:
8+ With the command <command>nix-build</command>, you can build specific parts of your NixOS configuration. This is done as follows:
109<screen>
1110<prompt>$ </prompt>cd <replaceable>/path/to/nixpkgs/nixos</replaceable>
1211<prompt>$ </prompt>nix-build -A config.<replaceable>option</replaceable></screen>
13− where <replaceable>option</replaceable> is a NixOS option with type
14− “derivation” (i.e. something that can be built). Attributes of interest
15− include:
12+ where <replaceable>option</replaceable> is a NixOS option with type “derivation” (i.e. something that can be built). Attributes of interest include:
1613 <variablelist>
1714 <varlistentry>
1815 <term>
@@ -20,10 +17,7 @@
2017 </term>
2118 <listitem>
2219 <para>
23− The top-level option that builds the entire NixOS system. Everything else
24− in your configuration is indirectly pulled in by this option. This is
25− what <command>nixos-rebuild</command> builds and what
26− <filename>/run/current-system</filename> points to afterwards.
20+ The top-level option that builds the entire NixOS system. Everything else in your configuration is indirectly pulled in by this option. This is what <command>nixos-rebuild</command> builds and what <filename>/run/current-system</filename> points to afterwards.
2721 </para>
2822 <para>
2923 A shortcut to build this is:
@@ -48,8 +42,7 @@
4842 </term>
4943 <listitem>
5044 <para>
51− A tree of symlinks that form the static parts of
52− <filename>/etc</filename>.
45+ A tree of symlinks that form the static parts of <filename>/etc</filename>.
5346 </para>
5447 </listitem>
5548 </varlistentry>
@@ -62,9 +55,7 @@
6255 </term>
6356 <listitem>
6457 <para>
65− The initial ramdisk and kernel of the system. This allows a quick way to
66− test whether the kernel and the initial ramdisk boot correctly, by using
67− QEMU’s <option>-kernel</option> and <option>-initrd</option> options:
58+ The initial ramdisk and kernel of the system. This allows a quick way to test whether the kernel and the initial ramdisk boot correctly, by using QEMU’s <option>-kernel</option> and <option>-initrd</option> options:
6859<screen>
6960<prompt>$ </prompt>nix-build -A config.system.build.initialRamdisk -o initrd
7061<prompt>$ </prompt>nix-build -A config.system.build.kernel -o kernel
@@ -95,24 +86,18 @@
9586 </term>
9687 <listitem>
9788 <para>
98− This builds the unit with the specified name. Note that since unit names
99− contain dots (e.g. <literal>httpd.service</literal>), you need to put
100− them between quotes, like this:
89+ This builds the unit with the specified name. Note that since unit names contain dots (e.g. <literal>httpd.service</literal>), you need to put them between quotes, like this:
10190<screen>
10291<prompt>$ </prompt>nix-build -A 'config.systemd.units."httpd.service".unit'
10392</screen>
104− You can also test individual units, without rebuilding the whole system,
105− by putting them in <filename>/run/systemd/system</filename>:
93+ You can also test individual units, without rebuilding the whole system, by putting them in <filename>/run/systemd/system</filename>:
10694<screen>
10795<prompt>$ </prompt>cp $(nix-build -A 'config.systemd.units."httpd.service".unit')/httpd.service \
10896 /run/systemd/system/tmp-httpd.service
10997<prompt># </prompt>systemctl daemon-reload
11098<prompt># </prompt>systemctl start tmp-httpd.service
11199</screen>
112− Note that the unit must not have the same name as any unit in
113− <filename>/etc/systemd/system</filename> since those take precedence over
114− <filename>/run/systemd/system</filename>. That’s why the unit is
115− installed as <filename>tmp-httpd.service</filename> here.
100+ Note that the unit must not have the same name as any unit in <filename>/etc/systemd/system</filename> since those take precedence over <filename>/run/systemd/system</filename>. That’s why the unit is installed as <filename>tmp-httpd.service</filename> here.
116101 </para>
117102 </listitem>
118103 </varlistentry>
nixos/doc/manual/development/importing-modules.xml+2−5
@@ -6,8 +6,7 @@
66 <title>Importing Modules</title>
77
88 <para>
9− Sometimes NixOS modules need to be used in configuration but exist outside of
10− Nixpkgs. These modules can be imported:
9+ Sometimes NixOS modules need to be used in configuration but exist outside of Nixpkgs. These modules can be imported:
1110 </para>
1211
1312<programlisting>
@@ -25,9 +24,7 @@
2524</programlisting>
2625
2726 <para>
28− The environment variable <literal>NIXOS_EXTRA_MODULE_PATH</literal> is an
29− absolute path to a NixOS module that is included alongside the Nixpkgs NixOS
30− modules. Like any NixOS module, this module can import additional modules:
27+ The environment variable <literal>NIXOS_EXTRA_MODULE_PATH</literal> is an absolute path to a NixOS module that is included alongside the Nixpkgs NixOS modules. Like any NixOS module, this module can import additional modules:
3128 </para>
3229
3330<programlisting>
nixos/doc/manual/development/meta-attributes.xml+5−14
@@ -6,18 +6,12 @@
66 <title>Meta Attributes</title>
77
88 <para>
9− Like Nix packages, NixOS modules can declare meta-attributes to provide extra
10− information. Module meta attributes are defined in the
11− <filename
12− xlink:href="https://github.com/NixOS/nixpkgs/blob/master/nixos/modules/misc/meta.nix">meta.nix</filename>
13− special module.
9+ Like Nix packages, NixOS modules can declare meta-attributes to provide extra information. Module meta attributes are defined in the <filename
10+ xlink:href="https://github.com/NixOS/nixpkgs/blob/master/nixos/modules/misc/meta.nix">meta.nix</filename> special module.
1411 </para>
1512
1613 <para>
17− <literal>meta</literal> is a top level attribute like
18− <literal>options</literal> and <literal>config</literal>. Available
19− meta-attributes are <literal>maintainers</literal> and
20− <literal>doc</literal>.
14+ <literal>meta</literal> is a top level attribute like <literal>options</literal> and <literal>config</literal>. Available meta-attributes are <literal>maintainers</literal> and <literal>doc</literal>.
2115 </para>
2216
2317 <para>
@@ -51,11 +45,8 @@
5145 </callout>
5246 <callout arearefs='modules-meta-2'>
5347 <para>
54− <varname>doc</varname> points to a valid DocBook file containing the module
55− documentation. Its contents is automatically added to
56− <xref
57− linkend="ch-configuration"/>. Changes to a module documentation
58− have to be checked to not break building the NixOS manual:
48+ <varname>doc</varname> points to a valid DocBook file containing the module documentation. Its contents is automatically added to <xref
49+ linkend="ch-configuration"/>. Changes to a module documentation have to be checked to not break building the NixOS manual:
5950 </para>
6051<programlisting>$ nix-build nixos/release.nix -A manual</programlisting>
6152 </callout>
nixos/doc/manual/development/nixos-tests.xml+2−7
@@ -5,13 +5,8 @@
55 xml:id="sec-nixos-tests">
66 <title>NixOS Tests</title>
77 <para>
8− When you add some feature to NixOS, you should write a test for it. NixOS
9− tests are kept in the directory
10− <filename
11−xlink:href="https://github.com/NixOS/nixpkgs/tree/master/nixos/tests">nixos/tests</filename>,
12− and are executed (using Nix) by a testing framework that automatically starts
13− one or more virtual machines containing the NixOS system(s) required for the
14− test.
8+ When you add some feature to NixOS, you should write a test for it. NixOS tests are kept in the directory <filename
9+xlink:href="https://github.com/NixOS/nixpkgs/tree/master/nixos/tests">nixos/tests</filename>, and are executed (using Nix) by a testing framework that automatically starts one or more virtual machines containing the NixOS system(s) required for the test.
1510 </para>
1611 <xi:include href="writing-nixos-tests.xml" />
1712 <xi:include href="running-nixos-tests.xml" />
nixos/doc/manual/development/option-declarations.xml+19−61
@@ -6,9 +6,7 @@
66 <title>Option Declarations</title>
77
88 <para>
9− An option declaration specifies the name, type and description of a NixOS
10− configuration option. It is invalid to define an option that hasn’t been
11− declared in any module. An option declaration generally looks like this:
9+ An option declaration specifies the name, type and description of a NixOS configuration option. It is invalid to define an option that hasn’t been declared in any module. An option declaration generally looks like this:
1210<programlisting>
1311options = {
1412 <replaceable>name</replaceable> = mkOption {
@@ -19,13 +17,8 @@ options = {
1917 };
2018};
2119</programlisting>
22− The attribute names within the <replaceable>name</replaceable> attribute path
23− must be camel cased in general but should, as an exception, match the
24− <link
25−xlink:href="https://nixos.org/nixpkgs/manual/#sec-package-naming">
26− package attribute name</link> when referencing a Nixpkgs package. For
27− example, the option <varname>services.nix-serve.bindAddress</varname>
28− references the <varname>nix-serve</varname> Nixpkgs package.
20+ The attribute names within the <replaceable>name</replaceable> attribute path must be camel cased in general but should, as an exception, match the <link
21+xlink:href="https://nixos.org/nixpkgs/manual/#sec-package-naming"> package attribute name</link> when referencing a Nixpkgs package. For example, the option <varname>services.nix-serve.bindAddress</varname> references the <varname>nix-serve</varname> Nixpkgs package.
2922 </para>
3023
3124 <para>
@@ -37,9 +30,7 @@ xlink:href="https://nixos.org/nixpkgs/manual/#sec-package-naming">
3730 </term>
3831 <listitem>
3932 <para>
40− The type of the option (see <xref linkend='sec-option-types' />). It may
41− be omitted, but that’s not advisable since it may lead to errors that
42− are hard to diagnose.
33+ The type of the option (see <xref linkend='sec-option-types' />). It may be omitted, but that’s not advisable since it may lead to errors that are hard to diagnose.
4334 </para>
4435 </listitem>
4536 </varlistentry>
@@ -49,10 +40,7 @@ xlink:href="https://nixos.org/nixpkgs/manual/#sec-package-naming">
4940 </term>
5041 <listitem>
5142 <para>
52− The default value used if no value is defined by any module. A default is
53− not required; but if a default is not given, then users of the module
54− will have to define the value of the option, otherwise an error will be
55− thrown.
43+ The default value used if no value is defined by any module. A default is not required; but if a default is not given, then users of the module will have to define the value of the option, otherwise an error will be thrown.
5644 </para>
5745 </listitem>
5846 </varlistentry>
@@ -72,8 +60,7 @@ xlink:href="https://nixos.org/nixpkgs/manual/#sec-package-naming">
7260 </term>
7361 <listitem>
7462 <para>
75− A textual description of the option, in DocBook format, that will be
76− included in the NixOS manual.
63+ A textual description of the option, in DocBook format, that will be included in the NixOS manual.
7764 </para>
7865 </listitem>
7966 </varlistentry>
@@ -84,22 +71,15 @@ xlink:href="https://nixos.org/nixpkgs/manual/#sec-package-naming">
8471 <title>Extensible Option Types</title>
8572
8673 <para>
87− Extensible option types is a feature that allow to extend certain types
88− declaration through multiple module files. This feature only work with a
89− restricted set of types, namely <literal>enum</literal> and
90− <literal>submodules</literal> and any composed forms of them.
74+ Extensible option types is a feature that allow to extend certain types declaration through multiple module files. This feature only work with a restricted set of types, namely <literal>enum</literal> and <literal>submodules</literal> and any composed forms of them.
9175 </para>
9276
9377 <para>
94− Extensible option types can be used for <literal>enum</literal> options that
95− affects multiple modules, or as an alternative to related
96− <literal>enable</literal> options.
78+ Extensible option types can be used for <literal>enum</literal> options that affects multiple modules, or as an alternative to related <literal>enable</literal> options.
9779 </para>
9880
9981 <para>
100− As an example, we will take the case of display managers. There is a central
101− display manager module for generic display manager options and a module file
102− per display manager backend (slim, sddm, gdm ...).
82+ As an example, we will take the case of display managers. There is a central display manager module for generic display manager options and a module file per display manager backend (slim, sddm, gdm ...).
10383 </para>
10484
10585 <para>
@@ -107,14 +87,12 @@ xlink:href="https://nixos.org/nixpkgs/manual/#sec-package-naming">
10787 <itemizedlist>
10888 <listitem>
10989 <para>
110− Managing the display managers independently by adding an enable option to
111− every display manager module backend. (NixOS)
90+ Managing the display managers independently by adding an enable option to every display manager module backend. (NixOS)
11291 </para>
11392 </listitem>
11493 <listitem>
11594 <para>
116− Managing the display managers in the central module by adding an option
117− to select which display manager backend to use.
95+ Managing the display managers in the central module by adding an option to select which display manager backend to use.
11896 </para>
11997 </listitem>
12098 </itemizedlist>
@@ -125,37 +103,22 @@ xlink:href="https://nixos.org/nixpkgs/manual/#sec-package-naming">
125103 </para>
126104
127105 <para>
128− Making backends independent can quickly become hard to manage. For display
129− managers, there can be only one enabled at a time, but the type system can
130− not enforce this restriction as there is no relation between each backend
131− <literal>enable</literal> option. As a result, this restriction has to be
132− done explicitely by adding assertions in each display manager backend
133− module.
106+ Making backends independent can quickly become hard to manage. For display managers, there can be only one enabled at a time, but the type system can not enforce this restriction as there is no relation between each backend <literal>enable</literal> option. As a result, this restriction has to be done explicitely by adding assertions in each display manager backend module.
134107 </para>
135108
136109 <para>
137− On the other hand, managing the display managers backends in the central
138− module will require to change the central module option every time a new
139− backend is added or removed.
110+ On the other hand, managing the display managers backends in the central module will require to change the central module option every time a new backend is added or removed.
140111 </para>
141112
142113 <para>
143− By using extensible option types, it is possible to create a placeholder
144− option in the central module
145− (<xref linkend='ex-option-declaration-eot-service'
146− />), and to extend
147− it in each backend module
148− (<xref
149− linkend='ex-option-declaration-eot-backend-slim' />,
150− <xref
114+ By using extensible option types, it is possible to create a placeholder option in the central module (<xref linkend='ex-option-declaration-eot-service'
115+ />), and to extend it in each backend module (<xref
116+ linkend='ex-option-declaration-eot-backend-slim' />, <xref
151117 linkend='ex-option-declaration-eot-backend-sddm' />).
152118 </para>
153119
154120 <para>
155− As a result, <literal>displayManager.enable</literal> option values can be
156− added without changing the main service module file and the type system
157− automatically enforce that there can only be a single display manager
158− enabled.
121+ As a result, <literal>displayManager.enable</literal> option values can be added without changing the main service module file and the type system automatically enforce that there can only be a single display manager enabled.
159122 </para>
160123
161124 <example xml:id='ex-option-declaration-eot-service'>
@@ -184,16 +147,11 @@ services.xserver.displayManager.enable = mkOption {
184147 </example>
185148
186149 <para>
187− The placeholder declaration is a standard <literal>mkOption</literal>
188− declaration, but it is important that extensible option declarations only
189− use the <literal>type</literal> argument.
150+ The placeholder declaration is a standard <literal>mkOption</literal> declaration, but it is important that extensible option declarations only use the <literal>type</literal> argument.
190151 </para>
191152
192153 <para>
193− Extensible option types work with any of the composed variants of
194− <literal>enum</literal> such as <literal>with types; nullOr (enum [ "foo"
195− "bar" ])</literal> or <literal>with types; listOf (enum [ "foo" "bar"
196− ])</literal>.
154+ Extensible option types work with any of the composed variants of <literal>enum</literal> such as <literal>with types; nullOr (enum [ "foo" "bar" ])</literal> or <literal>with types; listOf (enum [ "foo" "bar" ])</literal>.
197155 </para>
198156 </section>
199157</section>
nixos/doc/manual/development/option-def.xml+8−26
@@ -6,33 +6,26 @@
66 <title>Option Definitions</title>
77
88 <para>
9− Option definitions are generally straight-forward bindings of values to
10− option names, like
9+ Option definitions are generally straight-forward bindings of values to option names, like
1110<programlisting>
1211config = {
1312 services.httpd.enable = true;
1413};
1514</programlisting>
16− However, sometimes you need to wrap an option definition or set of option
17− definitions in a <emphasis>property</emphasis> to achieve certain effects:
15+ However, sometimes you need to wrap an option definition or set of option definitions in a <emphasis>property</emphasis> to achieve certain effects:
1816 </para>
1917
2018 <simplesect xml:id="sec-option-definitions-delaying-conditionals">
2119 <title>Delaying Conditionals</title>
2220 <para>
23− If a set of option definitions is conditional on the value of another
24− option, you may need to use <varname>mkIf</varname>. Consider, for instance:
21+ If a set of option definitions is conditional on the value of another option, you may need to use <varname>mkIf</varname>. Consider, for instance:
2522<programlisting>
2623config = if config.services.httpd.enable then {
2724 environment.systemPackages = [ <replaceable>...</replaceable> ];
2825 <replaceable>...</replaceable>
2926} else {};
3027</programlisting>
31− This definition will cause Nix to fail with an “infinite recursion”
32− error. Why? Because the value of
33− <option>config.services.httpd.enable</option> depends on the value being
34− constructed here. After all, you could also write the clearly circular and
35− contradictory:
28+ This definition will cause Nix to fail with an “infinite recursion” error. Why? Because the value of <option>config.services.httpd.enable</option> depends on the value being constructed here. After all, you could also write the clearly circular and contradictory:
3629<programlisting>
3730config = if config.services.httpd.enable then {
3831 services.httpd.enable = false;
@@ -47,9 +40,7 @@ config = mkIf config.services.httpd.enable {
4740 <replaceable>...</replaceable>
4841};
4942</programlisting>
50− The special function <varname>mkIf</varname> causes the evaluation of the
51− conditional to be “pushed down” into the individual definitions, as if
52− you had written:
43+ The special function <varname>mkIf</varname> causes the evaluation of the conditional to be “pushed down” into the individual definitions, as if you had written:
5344<programlisting>
5445config = {
5546 environment.systemPackages = if config.services.httpd.enable then [ <replaceable>...</replaceable> ] else [];
@@ -62,27 +53,18 @@ config = {
6253 <simplesect xml:id="sec-option-definitions-setting-priorities">
6354 <title>Setting Priorities</title>
6455 <para>
65− A module can override the definitions of an option in other modules by
66− setting a <emphasis>priority</emphasis>. All option definitions that do not
67− have the lowest priority value are discarded. By default, option definitions
68− have priority 1000. You can specify an explicit priority by using
69− <varname>mkOverride</varname>, e.g.
56+ A module can override the definitions of an option in other modules by setting a <emphasis>priority</emphasis>. All option definitions that do not have the lowest priority value are discarded. By default, option definitions have priority 1000. You can specify an explicit priority by using <varname>mkOverride</varname>, e.g.
7057<programlisting>
7158services.openssh.enable = mkOverride 10 false;
7259</programlisting>
73− This definition causes all other definitions with priorities above 10 to be
74− discarded. The function <varname>mkForce</varname> is equal to
75− <varname>mkOverride 50</varname>.
60+ This definition causes all other definitions with priorities above 10 to be discarded. The function <varname>mkForce</varname> is equal to <varname>mkOverride 50</varname>.
7661 </para>
7762 </simplesect>
7863
7964 <simplesect xml:id="sec-option-definitions-merging">
8065 <title>Merging Configurations</title>
8166 <para>
82− In conjunction with <literal>mkIf</literal>, it is sometimes useful for a
83− module to return multiple sets of option definitions, to be merged together
84− as if they were declared in separate modules. This can be done using
85− <varname>mkMerge</varname>:
67+ In conjunction with <literal>mkIf</literal>, it is sometimes useful for a module to return multiple sets of option definitions, to be merged together as if they were declared in separate modules. This can be done using <varname>mkMerge</varname>:
8668<programlisting>
8769config = mkMerge
8870 [ # Unconditional stuff.
nixos/doc/manual/development/option-types.xml+47−161
@@ -6,18 +6,14 @@
66 <title>Options Types</title>
77
88 <para>
9− Option types are a way to put constraints on the values a module option can
10− take. Types are also responsible of how values are merged in case of multiple
11− value definitions.
9+ Option types are a way to put constraints on the values a module option can take. Types are also responsible of how values are merged in case of multiple value definitions.
1210 </para>
1311
1412 <section xml:id="sec-option-types-basic">
1513 <title>Basic Types</title>
1614
1715 <para>
18− Basic types are the simplest available types in the module system. Basic
19− types include multiple string types that mainly differ in how definition
20− merging is handled.
16+ Basic types are the simplest available types in the module system. Basic types include multiple string types that mainly differ in how definition merging is handled.
2117 </para>
2218
2319 <variablelist>
@@ -37,8 +33,7 @@
3733 </term>
3834 <listitem>
3935 <para>
40− A boolean, its values can be <literal>true</literal> or
41− <literal>false</literal>.
36+ A boolean, its values can be <literal>true</literal> or <literal>false</literal>.
4237 </para>
4338 </listitem>
4439 </varlistentry>
@@ -48,9 +43,7 @@
4843 </term>
4944 <listitem>
5045 <para>
51− A filesystem path, defined as anything that when coerced to a string
52− starts with a slash. Even if derivations can be considered as path, the
53− more specific <literal>types.package</literal> should be preferred.
46+ A filesystem path, defined as anything that when coerced to a string starts with a slash. Even if derivations can be considered as path, the more specific <literal>types.package</literal> should be preferred.
5447 </para>
5548 </listitem>
5649 </varlistentry>
@@ -87,12 +80,7 @@
8780 </term>
8881 <listitem>
8982 <para>
90− Signed integers with a fixed length (8, 16 or 32 bits). They go from
91− <inlineequation><mathphrase>−2<superscript>n</superscript>/2</mathphrase>
92− </inlineequation> to <inlineequation>
93− <mathphrase>2<superscript>n</superscript>/2−1</mathphrase>
94− </inlineequation> respectively (e.g. <literal>−128</literal> to
95− <literal>127</literal> for 8 bits).
83+ Signed integers with a fixed length (8, 16 or 32 bits). They go from <inlineequation><mathphrase>−2<superscript>n</superscript>/2</mathphrase> </inlineequation> to <inlineequation> <mathphrase>2<superscript>n</superscript>/2−1</mathphrase> </inlineequation> respectively (e.g. <literal>−128</literal> to <literal>127</literal> for 8 bits).
9684 </para>
9785 </listitem>
9886 </varlistentry>
@@ -112,12 +100,7 @@
112100 </term>
113101 <listitem>
114102 <para>
115− Unsigned integers with a fixed length (8, 16 or 32 bits). They go from
116− <inlineequation><mathphrase>0</mathphrase></inlineequation> to
117− <inlineequation>
118− <mathphrase>2<superscript>n</superscript>−1</mathphrase>
119− </inlineequation> respectively (e.g. <literal>0</literal> to
120− <literal>255</literal> for 8 bits).
103+ Unsigned integers with a fixed length (8, 16 or 32 bits). They go from <inlineequation><mathphrase>0</mathphrase></inlineequation> to <inlineequation> <mathphrase>2<superscript>n</superscript>−1</mathphrase> </inlineequation> respectively (e.g. <literal>0</literal> to <literal>255</literal> for 8 bits).
121104 </para>
122105 </listitem>
123106 </varlistentry>
@@ -137,8 +120,7 @@
137120 </term>
138121 <listitem>
139122 <para>
140− A port number. This type is an alias to
141− <link linkend='types.ints.ux'><varname>types.ints.u16</varname></link>.
123+ A port number. This type is an alias to <link linkend='types.ints.ux'><varname>types.ints.u16</varname></link>.
142124 </para>
143125 </listitem>
144126 </varlistentry>
@@ -165,8 +147,7 @@
165147 </term>
166148 <listitem>
167149 <para>
168− A string. Multiple definitions are concatenated with a new line
169− <literal>"\n"</literal>.
150+ A string. Multiple definitions are concatenated with a new line <literal>"\n"</literal>.
170151 </para>
171152 </listitem>
172153 </varlistentry>
@@ -176,8 +157,7 @@
176157 </term>
177158 <listitem>
178159 <para>
179− A string. Multiple definitions are concatenated with a comma
180− <literal>","</literal>.
160+ A string. Multiple definitions are concatenated with a comma <literal>","</literal>.
181161 </para>
182162 </listitem>
183163 </varlistentry>
@@ -187,8 +167,7 @@
187167 </term>
188168 <listitem>
189169 <para>
190− A string. Multiple definitions are concatenated with a collon
191− <literal>":"</literal>.
170+ A string. Multiple definitions are concatenated with a collon <literal>":"</literal>.
192171 </para>
193172 </listitem>
194173 </varlistentry>
@@ -198,9 +177,7 @@
198177 </term>
199178 <listitem>
200179 <para>
201− A string matching a specific regular expression. Multiple definitions
202− cannot be merged. The regular expression is processed using
203− <literal>builtins.match</literal>.
180+ A string matching a specific regular expression. Multiple definitions cannot be merged. The regular expression is processed using <literal>builtins.match</literal>.
204181 </para>
205182 </listitem>
206183 </varlistentry>
@@ -221,9 +198,7 @@
221198 </term>
222199 <listitem>
223200 <para>
224− One element of the list <replaceable>l</replaceable>, e.g.
225− <literal>types.enum [ "left" "right" ]</literal>. Multiple definitions
226− cannot be merged.
201+ One element of the list <replaceable>l</replaceable>, e.g. <literal>types.enum [ "left" "right" ]</literal>. Multiple definitions cannot be merged.
227202 </para>
228203 </listitem>
229204 </varlistentry>
@@ -233,8 +208,7 @@
233208 </term>
234209 <listitem>
235210 <para>
236− A string with a custom separator <replaceable>sep</replaceable>, e.g.
237− <literal>types.separatedString "|"</literal>.
211+ A string with a custom separator <replaceable>sep</replaceable>, e.g. <literal>types.separatedString "|"</literal>.
238212 </para>
239213 </listitem>
240214 </varlistentry>
@@ -244,9 +218,7 @@
244218 </term>
245219 <listitem>
246220 <para>
247− An integer between <replaceable>lowest</replaceable> and
248− <replaceable>highest</replaceable> (both inclusive). Useful for creating
249− types like <literal>types.port</literal>.
221+ An integer between <replaceable>lowest</replaceable> and <replaceable>highest</replaceable> (both inclusive). Useful for creating types like <literal>types.port</literal>.
250222 </para>
251223 </listitem>
252224 </varlistentry>
@@ -256,11 +228,7 @@
256228 </term>
257229 <listitem>
258230 <para>
259− A set of sub options <replaceable>o</replaceable>.
260− <replaceable>o</replaceable> can be an attribute set or a function
261− returning an attribute set. Submodules are used in composed types to
262− create modular options. Submodule are detailed in
263− <xref
231+ A set of sub options <replaceable>o</replaceable>. <replaceable>o</replaceable> can be an attribute set or a function returning an attribute set. Submodules are used in composed types to create modular options. Submodule are detailed in <xref
264232 linkend='section-option-types-submodule' />.
265233 </para>
266234 </listitem>
@@ -272,9 +240,7 @@
272240 <title>Composed Types</title>
273241
274242 <para>
275− Composed types are types that take a type as parameter. <literal>listOf
276− int</literal> and <literal>either int str</literal> are examples of composed
277− types.
243+ Composed types are types that take a type as parameter. <literal>listOf int</literal> and <literal>either int str</literal> are examples of composed types.
278244 </para>
279245
280246 <variablelist>
@@ -284,8 +250,7 @@
284250 </term>
285251 <listitem>
286252 <para>
287− A list of <replaceable>t</replaceable> type, e.g. <literal>types.listOf
288− int</literal>. Multiple definitions are merged with list concatenation.
253+ A list of <replaceable>t</replaceable> type, e.g. <literal>types.listOf int</literal>. Multiple definitions are merged with list concatenation.
289254 </para>
290255 </listitem>
291256 </varlistentry>
@@ -295,9 +260,7 @@
295260 </term>
296261 <listitem>
297262 <para>
298− An attribute set of where all the values are of
299− <replaceable>t</replaceable> type. Multiple definitions result in the
300− joined attribute set.
263+ An attribute set of where all the values are of <replaceable>t</replaceable> type. Multiple definitions result in the joined attribute set.
301264 </para>
302265 </listitem>
303266 </varlistentry>
@@ -307,8 +270,7 @@
307270 </term>
308271 <listitem>
309272 <para>
310− An attribute set or a list of <replaceable>t</replaceable> type. Multiple
311− definitions are merged according to the value.
273+ An attribute set or a list of <replaceable>t</replaceable> type. Multiple definitions are merged according to the value.
312274 </para>
313275 </listitem>
314276 </varlistentry>
@@ -318,8 +280,7 @@
318280 </term>
319281 <listitem>
320282 <para>
321− <literal>null</literal> or type <replaceable>t</replaceable>. Multiple
322− definitions are merged according to type <replaceable>t</replaceable>.
283+ <literal>null</literal> or type <replaceable>t</replaceable>. Multiple definitions are merged according to type <replaceable>t</replaceable>.
323284 </para>
324285 </listitem>
325286 </varlistentry>
@@ -329,8 +290,7 @@
329290 </term>
330291 <listitem>
331292 <para>
332− Ensures that type <replaceable>t</replaceable> cannot be merged. It is
333− used to ensure option definitions are declared only once.
293+ Ensures that type <replaceable>t</replaceable> cannot be merged. It is used to ensure option definitions are declared only once.
334294 </para>
335295 </listitem>
336296 </varlistentry>
@@ -340,9 +300,7 @@
340300 </term>
341301 <listitem>
342302 <para>
343− Type <replaceable>t1</replaceable> or type <replaceable>t2</replaceable>,
344− e.g. <literal>with types; either int str</literal>. Multiple definitions
345− cannot be merged.
303+ Type <replaceable>t1</replaceable> or type <replaceable>t2</replaceable>, e.g. <literal>with types; either int str</literal>. Multiple definitions cannot be merged.
346304 </para>
347305 </listitem>
348306 </varlistentry>
@@ -352,9 +310,7 @@
352310 </term>
353311 <listitem>
354312 <para>
355− Type <replaceable>t1</replaceable> or type <replaceable>t2</replaceable> and so forth,
356− e.g. <literal>with types; oneOf [ int str bool ]</literal>. Multiple definitions
357− cannot be merged.
313+ Type <replaceable>t1</replaceable> or type <replaceable>t2</replaceable> and so forth, e.g. <literal>with types; oneOf [ int str bool ]</literal>. Multiple definitions cannot be merged.
358314 </para>
359315 </listitem>
360316 </varlistentry>
@@ -364,12 +320,7 @@
364320 </term>
365321 <listitem>
366322 <para>
367− Type <replaceable>to</replaceable> or type
368− <replaceable>from</replaceable> which will be coerced to type
369− <replaceable>to</replaceable> using function <replaceable>f</replaceable>
370− which takes an argument of type <replaceable>from</replaceable> and
371− return a value of type <replaceable>to</replaceable>. Can be used to
372− preserve backwards compatibility of an option if its type was changed.
323+ Type <replaceable>to</replaceable> or type <replaceable>from</replaceable> which will be coerced to type <replaceable>to</replaceable> using function <replaceable>f</replaceable> which takes an argument of type <replaceable>from</replaceable> and return a value of type <replaceable>to</replaceable>. Can be used to preserve backwards compatibility of an option if its type was changed.
373324 </para>
374325 </listitem>
375326 </varlistentry>
@@ -380,22 +331,15 @@
380331 <title>Submodule</title>
381332
382333 <para>
383− <literal>submodule</literal> is a very powerful type that defines a set of
384− sub-options that are handled like a separate module.
334+ <literal>submodule</literal> is a very powerful type that defines a set of sub-options that are handled like a separate module.
385335 </para>
386336
387337 <para>
388− It takes a parameter <replaceable>o</replaceable>, that should be a set, or
389− a function returning a set with an <literal>options</literal> key defining
390− the sub-options. Submodule option definitions are type-checked accordingly
391− to the <literal>options</literal> declarations. Of course, you can nest
392− submodule option definitons for even higher modularity.
338+ It takes a parameter <replaceable>o</replaceable>, that should be a set, or a function returning a set with an <literal>options</literal> key defining the sub-options. Submodule option definitions are type-checked accordingly to the <literal>options</literal> declarations. Of course, you can nest submodule option definitons for even higher modularity.
393339 </para>
394340
395341 <para>
396− The option set can be defined directly
397− (<xref linkend='ex-submodule-direct' />) or as reference
398− (<xref linkend='ex-submodule-reference' />).
342+ The option set can be defined directly (<xref linkend='ex-submodule-direct' />) or as reference (<xref linkend='ex-submodule-reference' />).
399343 </para>
400344
401345 <example xml:id='ex-submodule-direct'>
@@ -438,12 +382,7 @@ options.mod = mkOption {
438382 </example>
439383
440384 <para>
441− The <literal>submodule</literal> type is especially interesting when used
442− with composed types like <literal>attrsOf</literal> or
443− <literal>listOf</literal>. When composed with <literal>listOf</literal>
444− (<xref linkend='ex-submodule-listof-declaration' />),
445− <literal>submodule</literal> allows multiple definitions of the submodule
446− option set (<xref linkend='ex-submodule-listof-definition' />).
385+ The <literal>submodule</literal> type is especially interesting when used with composed types like <literal>attrsOf</literal> or <literal>listOf</literal>. When composed with <literal>listOf</literal> (<xref linkend='ex-submodule-listof-declaration' />), <literal>submodule</literal> allows multiple definitions of the submodule option set (<xref linkend='ex-submodule-listof-definition' />).
447386 </para>
448387
449388 <example xml:id='ex-submodule-listof-declaration'>
@@ -474,10 +413,7 @@ config.mod = [
474413 </example>
475414
476415 <para>
477− When composed with <literal>attrsOf</literal>
478− (<xref linkend='ex-submodule-attrsof-declaration' />),
479− <literal>submodule</literal> allows multiple named definitions of the
480− submodule option set (<xref linkend='ex-submodule-attrsof-definition' />).
416+ When composed with <literal>attrsOf</literal> (<xref linkend='ex-submodule-attrsof-declaration' />), <literal>submodule</literal> allows multiple named definitions of the submodule option set (<xref linkend='ex-submodule-attrsof-definition' />).
481417 </para>
482418
483419 <example xml:id='ex-submodule-attrsof-declaration'>
@@ -510,8 +446,7 @@ config.mod.two = { foo = 2; bar = "two"; };</screen>
510446 <title>Extending types</title>
511447
512448 <para>
513− Types are mainly characterized by their <literal>check</literal> and
514− <literal>merge</literal> functions.
449+ Types are mainly characterized by their <literal>check</literal> and <literal>merge</literal> functions.
515450 </para>
516451
517452 <variablelist>
@@ -521,13 +456,8 @@ config.mod.two = { foo = 2; bar = "two"; };</screen>
521456 </term>
522457 <listitem>
523458 <para>
524− The function to type check the value. Takes a value as parameter and
525− return a boolean. It is possible to extend a type check with the
526− <literal>addCheck</literal> function
527− (<xref
528− linkend='ex-extending-type-check-1' />), or to fully
529− override the check function
530− (<xref linkend='ex-extending-type-check-2' />).
459+ The function to type check the value. Takes a value as parameter and return a boolean. It is possible to extend a type check with the <literal>addCheck</literal> function (<xref
460+ linkend='ex-extending-type-check-1' />), or to fully override the check function (<xref linkend='ex-extending-type-check-2' />).
531461 </para>
532462 <example xml:id='ex-extending-type-check-1'>
533463 <title>Adding a type check</title>
@@ -555,11 +485,7 @@ nixThings = mkOption {
555485 </term>
556486 <listitem>
557487 <para>
558− Function to merge the options values when multiple values are set. The
559− function takes two parameters, <literal>loc</literal> the option path as
560− a list of strings, and <literal>defs</literal> the list of defined values
561− as a list. It is possible to override a type merge function for custom
562− needs.
488+ Function to merge the options values when multiple values are set. The function takes two parameters, <literal>loc</literal> the option path as a list of strings, and <literal>defs</literal> the list of defined values as a list. It is possible to override a type merge function for custom needs.
563489 </para>
564490 </listitem>
565491 </varlistentry>
@@ -570,12 +496,8 @@ nixThings = mkOption {
570496 <title>Custom Types</title>
571497
572498 <para>
573− Custom types can be created with the <literal>mkOptionType</literal>
574− function. As type creation includes some more complex topics such as
575− submodule handling, it is recommended to get familiar with
576− <filename
577− xlink:href="https://github.com/NixOS/nixpkgs/blob/master/lib/types.nix">types.nix</filename>
578− code before creating a new type.
499+ Custom types can be created with the <literal>mkOptionType</literal> function. As type creation includes some more complex topics such as submodule handling, it is recommended to get familiar with <filename
500+ xlink:href="https://github.com/NixOS/nixpkgs/blob/master/lib/types.nix">types.nix</filename> code before creating a new type.
579501 </para>
580502
581503 <para>
@@ -599,8 +521,7 @@ nixThings = mkOption {
599521 </term>
600522 <listitem>
601523 <para>
602− Description of the type used in documentation. Give information of the
603− type and any of its arguments.
524+ Description of the type used in documentation. Give information of the type and any of its arguments.
604525 </para>
605526 </listitem>
606527 </varlistentry>
@@ -610,10 +531,7 @@ nixThings = mkOption {
610531 </term>
611532 <listitem>
612533 <para>
613− A function to type check the definition value. Takes the definition value
614− as a parameter and returns a boolean indicating the type check result,
615− <literal>true</literal> for success and <literal>false</literal> for
616− failure.
534+ A function to type check the definition value. Takes the definition value as a parameter and returns a boolean indicating the type check result, <literal>true</literal> for success and <literal>false</literal> for failure.
617535 </para>
618536 </listitem>
619537 </varlistentry>
@@ -632,8 +550,7 @@ nixThings = mkOption {
632550 </term>
633551 <listitem>
634552 <para>
635− The option path as a list of strings, e.g. <literal>["boot" "loader
636− "grub" "enable"]</literal>.
553+ The option path as a list of strings, e.g. <literal>["boot" "loader "grub" "enable"]</literal>.
637554 </para>
638555 </listitem>
639556 </varlistentry>
@@ -643,12 +560,7 @@ nixThings = mkOption {
643560 </term>
644561 <listitem>
645562 <para>
646− The list of sets of defined <literal>value</literal> and
647− <literal>file</literal> where the value was defined, e.g. <literal>[ {
648− file = "/foo.nix"; value = 1; } { file = "/bar.nix"; value = 2 }
649− ]</literal>. The <literal>merge</literal> function should return the
650− merged value or throw an error in case the values are impossible or
651− not meant to be merged.
563+ The list of sets of defined <literal>value</literal> and <literal>file</literal> where the value was defined, e.g. <literal>[ { file = "/foo.nix"; value = 1; } { file = "/bar.nix"; value = 2 } ]</literal>. The <literal>merge</literal> function should return the merged value or throw an error in case the values are impossible or not meant to be merged.
652564 </para>
653565 </listitem>
654566 </varlistentry>
@@ -661,13 +573,7 @@ nixThings = mkOption {
661573 </term>
662574 <listitem>
663575 <para>
664− For composed types that can take a submodule as type parameter, this
665− function generate sub-options documentation. It takes the current option
666− prefix as a list and return the set of sub-options. Usually defined in a
667− recursive manner by adding a term to the prefix, e.g. <literal>prefix:
668− elemType.getSubOptions (prefix ++
669− [<replaceable>"prefix"</replaceable>])</literal> where
670− <replaceable>"prefix"</replaceable> is the newly added prefix.
576+ For composed types that can take a submodule as type parameter, this function generate sub-options documentation. It takes the current option prefix as a list and return the set of sub-options. Usually defined in a recursive manner by adding a term to the prefix, e.g. <literal>prefix: elemType.getSubOptions (prefix ++ [<replaceable>"prefix"</replaceable>])</literal> where <replaceable>"prefix"</replaceable> is the newly added prefix.
671577 </para>
672578 </listitem>
673579 </varlistentry>
@@ -677,11 +583,7 @@ nixThings = mkOption {
677583 </term>
678584 <listitem>
679585 <para>
680− For composed types that can take a submodule as type parameter, this
681− function should return the type parameters submodules. If the type
682− parameter is called <literal>elemType</literal>, the function should just
683− recursively look into submodules by returning
684− <literal>elemType.getSubModules;</literal>.
586+ For composed types that can take a submodule as type parameter, this function should return the type parameters submodules. If the type parameter is called <literal>elemType</literal>, the function should just recursively look into submodules by returning <literal>elemType.getSubModules;</literal>.
685587 </para>
686588 </listitem>
687589 </varlistentry>
@@ -691,14 +593,7 @@ nixThings = mkOption {
691593 </term>
692594 <listitem>
693595 <para>
694− For composed types that can take a submodule as type parameter, this
695− function can be used to substitute the parameter of a submodule type. It
696− takes a module as parameter and return the type with the submodule
697− options substituted. It is usually defined as a type function call with a
698− recursive call to <literal>substSubModules</literal>, e.g for a type
699− <literal>composedType</literal> that take an <literal>elemtype</literal>
700− type parameter, this function should be defined as <literal>m:
701− composedType (elemType.substSubModules m)</literal>.
596+ For composed types that can take a submodule as type parameter, this function can be used to substitute the parameter of a submodule type. It takes a module as parameter and return the type with the submodule options substituted. It is usually defined as a type function call with a recursive call to <literal>substSubModules</literal>, e.g for a type <literal>composedType</literal> that take an <literal>elemtype</literal> type parameter, this function should be defined as <literal>m: composedType (elemType.substSubModules m)</literal>.
702597 </para>
703598 </listitem>
704599 </varlistentry>
@@ -708,9 +603,7 @@ nixThings = mkOption {
708603 </term>
709604 <listitem>
710605 <para>
711− A function to merge multiple type declarations. Takes the type to merge
712− <literal>functor</literal> as parameter. A <literal>null</literal> return
713− value means that type cannot be merged.
606+ A function to merge multiple type declarations. Takes the type to merge <literal>functor</literal> as parameter. A <literal>null</literal> return value means that type cannot be merged.
714607 </para>
715608 <variablelist>
716609 <varlistentry>
@@ -725,8 +618,7 @@ nixThings = mkOption {
725618 </varlistentry>
726619 </variablelist>
727620 <para>
728− Note: There is a generic <literal>defaultTypeMerge</literal> that work
729− with most of value and composed types.
621+ Note: There is a generic <literal>defaultTypeMerge</literal> that work with most of value and composed types.
730622 </para>
731623 </listitem>
732624 </varlistentry>
@@ -736,8 +628,7 @@ nixThings = mkOption {
736628 </term>
737629 <listitem>
738630 <para>
739− An attribute set representing the type. It is used for type operations
740− and has the following keys:
631+ An attribute set representing the type. It is used for type operations and has the following keys:
741632 </para>
742633 <variablelist>
743634 <varlistentry>
@@ -766,10 +657,7 @@ nixThings = mkOption {
766657 </term>
767658 <listitem>
768659 <para>
769− Holds the value parameter for value types. The types that have a
770− <literal>payload</literal> are the <literal>enum</literal>,
771− <literal>separatedString</literal> and <literal>submodule</literal>
772− types.
660+ Holds the value parameter for value types. The types that have a <literal>payload</literal> are the <literal>enum</literal>, <literal>separatedString</literal> and <literal>submodule</literal> types.
773661 </para>
774662 </listitem>
775663 </varlistentry>
@@ -779,9 +667,7 @@ nixThings = mkOption {
779667 </term>
780668 <listitem>
781669 <para>
782− A binary operation that can merge the payloads of two same types.
783− Defined as a function that take two payloads as parameters and return
784− the payloads merged.
670+ A binary operation that can merge the payloads of two same types. Defined as a function that take two payloads as parameters and return the payloads merged.
785671 </para>
786672 </listitem>
787673 </varlistentry>
nixos/doc/manual/development/releases.xml+54−72
@@ -17,15 +17,12 @@
1717 <itemizedlist spacing="compact">
1818 <listitem>
1919 <para>
20− Send an email to the nix-devel mailinglist as a warning about upcoming
21− beta "feature freeze" in a month.
20+ Send an email to the nix-devel mailinglist as a warning about upcoming beta "feature freeze" in a month.
2221 </para>
2322 </listitem>
2423 <listitem>
2524 <para>
26− Discuss with Eelco Dolstra and the community (via IRC, ML) about what
27− will reach the deadline. Any issue or Pull Request targeting the release
28− should be included in the release milestone.
25+ Discuss with Eelco Dolstra and the community (via IRC, ML) about what will reach the deadline. Any issue or Pull Request targeting the release should be included in the release milestone.
2926 </para>
3027 </listitem>
3128 </itemizedlist>
@@ -37,42 +34,32 @@
3734 <itemizedlist spacing="compact">
3835 <listitem>
3936 <para>
40− <link xlink:href="https://github.com/NixOS/nixpkgs/issues/13559">Create
41− an issue for tracking Zero Hydra Failures progress. ZHF is an effort to
42− get build failures down to zero.</link>
37+ <link xlink:href="https://github.com/NixOS/nixpkgs/issues/13559">Create an issue for tracking Zero Hydra Failures progress. ZHF is an effort to get build failures down to zero.</link>
4338 </para>
4439 </listitem>
4540 <listitem>
4641 <para>
47− <literal>git tag -a -s -m &quot;Release 17.09-beta&quot; 17.09-beta
48− &amp;&amp; git push --tags</literal>
42+ <literal>git tag -a -s -m &quot;Release 17.09-beta&quot; 17.09-beta &amp;&amp; git push --tags</literal>
4943 </para>
5044 </listitem>
5145 <listitem>
5246 <para>
53− From the master branch run <literal>git checkout -B
54− release-17.09</literal>.
47+ From the master branch run <literal>git checkout -B release-17.09</literal>.
5548 </para>
5649 </listitem>
5750 <listitem>
5851 <para>
59− <link xlink:href="https://github.com/NixOS/nixos-org-configurations/pull/18">
60− Make sure a channel is created at http://nixos.org/channels/. </link>
52+ <link xlink:href="https://github.com/NixOS/nixos-org-configurations/pull/18"> Make sure a channel is created at http://nixos.org/channels/. </link>
6153 </para>
6254 </listitem>
6355 <listitem>
6456 <para>
65− <link xlink:href="https://github.com/NixOS/nixpkgs/compare/bdf161ed8d21...6b63c4616790">
66− Bump the <literal>system.defaultChannel</literal> attribute in
67− <literal>nixos/modules/misc/version.nix</literal> </link>
57+ <link xlink:href="https://github.com/NixOS/nixpkgs/compare/bdf161ed8d21...6b63c4616790"> Bump the <literal>system.defaultChannel</literal> attribute in <literal>nixos/modules/misc/version.nix</literal> </link>
6858 </para>
6959 </listitem>
7060 <listitem>
7161 <para>
72− <link xlink:href="https://github.com/NixOS/nixpkgs/commit/d6b08acd1ccac0d9d502c4b635e00b04d3387f06">
73− Update <literal>versionSuffix</literal> in
74− <literal>nixos/release.nix</literal></link>, use <literal>git log
75− --format=%an|wc -l</literal> to get the commit count
62+ <link xlink:href="https://github.com/NixOS/nixpkgs/commit/d6b08acd1ccac0d9d502c4b635e00b04d3387f06"> Update <literal>versionSuffix</literal> in <literal>nixos/release.nix</literal></link>, use <literal>git log --format=%an|wc -l</literal> to get the commit count
7663 </para>
7764 </listitem>
7865 <listitem>
@@ -82,44 +69,32 @@
8269 </listitem>
8370 <listitem>
8471 <para>
85− <link xlink:href="https://github.com/NixOS/nixpkgs/commit/b8a4095003e27659092892a4708bb3698231a842">
86− Pick a new name for the unstable branch. </link>
72+ <link xlink:href="https://github.com/NixOS/nixpkgs/commit/b8a4095003e27659092892a4708bb3698231a842"> Pick a new name for the unstable branch. </link>
8773 </para>
8874 </listitem>
8975 <listitem>
9076 <para>
91− Create a new release notes file for the upcoming release + 1, in this
92− case <literal>rl-1803.xml</literal>.
77+ Create a new release notes file for the upcoming release + 1, in this case <literal>rl-1803.xml</literal>.
9378 </para>
9479 </listitem>
9580 <listitem>
9681 <para>
97− Create two Hydra jobsets: release-17.09 and release-17.09-small with
98− <literal>stableBranch</literal> set to false.
82+ Create two Hydra jobsets: release-17.09 and release-17.09-small with <literal>stableBranch</literal> set to false.
9983 </para>
10084 </listitem>
10185 <listitem>
10286 <para>
103− Remove attributes that we know we will not be able to support,
104− especially if there is a stable alternative. E.g. Check that our
105− Linux kernels'
106− <link xlink:href="https://www.kernel.org/category/releases.html">
107− projected end-of-life</link> are after our release projected
108− end-of-life
87+ Remove attributes that we know we will not be able to support, especially if there is a stable alternative. E.g. Check that our Linux kernels' <link xlink:href="https://www.kernel.org/category/releases.html"> projected end-of-life</link> are after our release projected end-of-life
10988 </para>
11089 </listitem>
11190 <listitem>
11291 <para>
113− Edit changelog at
114− <literal>nixos/doc/manual/release-notes/rl-1709.xml</literal> (double
115− check desktop versions are noted)
92+ Edit changelog at <literal>nixos/doc/manual/release-notes/rl-1709.xml</literal> (double check desktop versions are noted)
11693 </para>
11794 <itemizedlist spacing="compact">
11895 <listitem>
11996 <para>
120− Get all new NixOS modules <literal>git diff
121− release-17.03..release-17.09 nixos/modules/module-list.nix|grep
122− ^+</literal>
97+ Get all new NixOS modules <literal>git diff release-17.03..release-17.09 nixos/modules/module-list.nix|grep ^+</literal>
12398 </para>
12499 </listitem>
125100 <listitem>
@@ -138,8 +113,7 @@
138113 <itemizedlist spacing="compact">
139114 <listitem>
140115 <para>
141− Monitor the master branch for bugfixes and minor updates and cherry-pick
142− them to the release branch.
116+ Monitor the master branch for bugfixes and minor updates and cherry-pick them to the release branch.
143117 </para>
144118 </listitem>
145119 </itemizedlist>
@@ -156,21 +130,17 @@
156130 </listitem>
157131 <listitem>
158132 <para>
159− Release Nix (currently only Eelco Dolstra can do that).
160− <link xlink:href="https://github.com/NixOS/nixpkgs/commit/53710c752a85f00658882531bc90a23a3d1287e4">
161− Make sure fallback is updated. </link>
133+ Release Nix (currently only Eelco Dolstra can do that). <link xlink:href="https://github.com/NixOS/nixpkgs/commit/53710c752a85f00658882531bc90a23a3d1287e4"> Make sure fallback is updated. </link>
162134 </para>
163135 </listitem>
164136 <listitem>
165137 <para>
166− <link xlink:href="https://github.com/NixOS/nixpkgs/commit/40fd9ae3ac8048758abdcfc7d28a78b5f22fe97e">
167− Update README.md with new stable NixOS version information. </link>
138+ <link xlink:href="https://github.com/NixOS/nixpkgs/commit/40fd9ae3ac8048758abdcfc7d28a78b5f22fe97e"> Update README.md with new stable NixOS version information. </link>
168139 </para>
169140 </listitem>
170141 <listitem>
171142 <para>
172− Change <literal>stableBranch</literal> to true and wait for channel to
173− update.
143+ Change <literal>stableBranch</literal> to true and wait for channel to update.
174144 </para>
175145 </listitem>
176146 </itemizedlist>
@@ -187,34 +157,27 @@
187157 </listitem>
188158 <listitem>
189159 <para>
190− Update "Chapter 4. Upgrading NixOS" section of the manual to match
191− new stable release version.
160+ Update "Chapter 4. Upgrading NixOS" section of the manual to match new stable release version.
192161 </para>
193162 </listitem>
194163 <listitem>
195164 <para>
196− Update http://nixos.org/nixos/download.html and
197− http://nixos.org/nixos/manual in
198− https://github.com/NixOS/nixos-org-configurations
165+ Update http://nixos.org/nixos/download.html and http://nixos.org/nixos/manual in https://github.com/NixOS/nixos-org-configurations
199166 </para>
200167 </listitem>
201168 <listitem>
202169 <para>
203− Get number of commits for the release: <literal>git log
204− release-14.04..release-14.12 --format=%an|wc -l</literal>
170+ Get number of commits for the release: <literal>git log release-14.04..release-14.12 --format=%an|wc -l</literal>
205171 </para>
206172 </listitem>
207173 <listitem>
208174 <para>
209− Commits by contributor: <literal>git log release-14.04..release-14.12
210− --format=%an|sort|uniq -c|sort -rn</literal>
175+ Commits by contributor: <literal>git log release-14.04..release-14.12 --format=%an|sort|uniq -c|sort -rn</literal>
211176 </para>
212177 </listitem>
213178 <listitem>
214179 <para>
215− Send an email to nix-dev to announce the release with above information.
216− Best to check how previous email was formulated to see what needs to be
217− included.
180+ Send an email to nix-dev to announce the release with above information. Best to check how previous email was formulated to see what needs to be included.
218181 </para>
219182 </listitem>
220183 </itemizedlist>
@@ -222,26 +185,45 @@
222185 </section>
223186 <section xml:id="release-managers">
224187 <title>Release Management Team</title>
188+
225189 <para>
226− For each release there are two release managers. After each release the
227− release manager having managed two releases steps down and the release
228− management team of the last release appoints a new release manager.
190+ For each release there are two release managers. After each release the release manager having managed two releases steps down and the release management team of the last release appoints a new release manager.
229191 </para>
192+
230193 <para>
231− This makes sure a release management team always consists of one release
232− manager who already has managed one release and one release manager being
233− introduced to their role, making it easier to pass on knowledge and
234− experience.
194+ This makes sure a release management team always consists of one release manager who already has managed one release and one release manager being introduced to their role, making it easier to pass on knowledge and experience.
235195 </para>
196+
236197 <para>
237198 A release manager's role and responsibilities are:
238199 </para>
200+
239201 <itemizedlist>
240− <listitem><para>manage the release process</para></listitem>
241− <listitem><para>start discussions about features and changes for a given release</para></listitem>
242− <listitem><para>create a roadmap</para></listitem>
243− <listitem><para>release in cooperation with Eelco Dolstra</para></listitem>
244− <listitem><para>decide which bug fixes, features, etc... get backported after a release</para></listitem>
202+ <listitem>
203+ <para>
204+ manage the release process
205+ </para>
206+ </listitem>
207+ <listitem>
208+ <para>
209+ start discussions about features and changes for a given release
210+ </para>
211+ </listitem>
212+ <listitem>
213+ <para>
214+ create a roadmap
215+ </para>
216+ </listitem>
217+ <listitem>
218+ <para>
219+ release in cooperation with Eelco Dolstra
220+ </para>
221+ </listitem>
222+ <listitem>
223+ <para>
224+ decide which bug fixes, features, etc... get backported after a release
225+ </para>
226+ </listitem>
245227 </itemizedlist>
246228 </section>
247229 <section xml:id="release-schedule">
nixos/doc/manual/development/replace-modules.xml+4−18
@@ -6,27 +6,15 @@
66 <title>Replace Modules</title>
77
88 <para>
9− Modules that are imported can also be disabled. The option declarations and
10− config implementation of a disabled module will be ignored, allowing another
11− to take it's place. This can be used to import a set of modules from another
12− channel while keeping the rest of the system on a stable release.
9+ Modules that are imported can also be disabled. The option declarations and config implementation of a disabled module will be ignored, allowing another to take it's place. This can be used to import a set of modules from another channel while keeping the rest of the system on a stable release.
1310 </para>
1411
1512 <para>
16− <literal>disabledModules</literal> is a top level attribute like
17− <literal>imports</literal>, <literal>options</literal> and
18− <literal>config</literal>. It contains a list of modules that will be
19− disabled. This can either be the full path to the module or a string with the
20− filename relative to the modules path (eg. &lt;nixpkgs/nixos/modules&gt; for
21− nixos).
13+ <literal>disabledModules</literal> is a top level attribute like <literal>imports</literal>, <literal>options</literal> and <literal>config</literal>. It contains a list of modules that will be disabled. This can either be the full path to the module or a string with the filename relative to the modules path (eg. &lt;nixpkgs/nixos/modules&gt; for nixos).
2214 </para>
2315
2416 <para>
25− This example will replace the existing postgresql module with the version
26− defined in the nixos-unstable channel while keeping the rest of the modules
27− and packages from the original nixos channel. This only overrides the module
28− definition, this won't use postgresql from nixos-unstable unless explicitly
29− configured to do so.
17+ This example will replace the existing postgresql module with the version defined in the nixos-unstable channel while keeping the rest of the modules and packages from the original nixos channel. This only overrides the module definition, this won't use postgresql from nixos-unstable unless explicitly configured to do so.
3018 </para>
3119
3220<programlisting>
@@ -46,9 +34,7 @@
4634</programlisting>
4735
4836 <para>
49− This example shows how to define a custom module as a replacement for an
50− existing module. Importing this module will disable the original module
51− without having to know it's implementation details.
37+ This example shows how to define a custom module as a replacement for an existing module. Importing this module will disable the original module without having to know it's implementation details.
5238 </para>
5339
5440<programlisting>
nixos/doc/manual/development/running-nixos-tests-interactively.xml+4−10
@@ -6,8 +6,7 @@
66 <title>Running Tests interactively</title>
77
88 <para>
9− The test itself can be run interactively. This is particularly useful when
10− developing or debugging a test:
9+ The test itself can be run interactively. This is particularly useful when developing or debugging a test:
1110<screen>
1211<prompt>$ </prompt>nix-build nixos/tests/login.nix -A driver
1312<prompt>$ </prompt>./result/bin/nixos-test-driver
@@ -21,10 +20,7 @@ starting VDE switch for network 1
2120<prompt>&gt;</prompt> $machine->succeed("touch /tmp/foo")
2221<prompt>&gt;</prompt> print($machine->succeed("pwd")) # Show stdout of command
2322</screen>
24− The function <command>testScript</command> executes the entire test script
25− and drops you back into the test driver command line upon its completion.
26− This allows you to inspect the state of the VMs after the test (e.g. to debug
27− the test script).
23+ The function <command>testScript</command> executes the entire test script and drops you back into the test driver command line upon its completion. This allows you to inspect the state of the VMs after the test (e.g. to debug the test script).
2824 </para>
2925
3026 <para>
@@ -33,12 +29,10 @@ starting VDE switch for network 1
3329<prompt>$ </prompt>nix-build nixos/tests/login.nix -A driver
3430<prompt>$ </prompt>./result/bin/nixos-run-vms
3531</screen>
36− The script <command>nixos-run-vms</command> starts the virtual machines
37− defined by test.
32+ The script <command>nixos-run-vms</command> starts the virtual machines defined by test.
3833 </para>
3934
4035 <para>
41− The machine state is kept across VM restarts in
42− <filename>/tmp/vm-state-</filename><varname>machinename</varname>.
36+ The machine state is kept across VM restarts in <filename>/tmp/vm-state-</filename><varname>machinename</varname>.
4337 </para>
4438</section>
nixos/doc/manual/development/running-nixos-tests.xml+3−10
@@ -6,11 +6,8 @@
66 <title>Running Tests</title>
77
88 <para>
9− You can run tests using <command>nix-build</command>. For example, to run the
10− test
11− <filename
12−xlink:href="https://github.com/NixOS/nixpkgs/blob/master/nixos/tests/login.nix">login.nix</filename>,
13− you just do:
9+ You can run tests using <command>nix-build</command>. For example, to run the test <filename
10+xlink:href="https://github.com/NixOS/nixpkgs/blob/master/nixos/tests/login.nix">login.nix</filename>, you just do:
1411<screen>
1512<prompt>$ </prompt>nix-build '&lt;nixpkgs/nixos/tests/login.nix>'
1613</screen>
@@ -24,11 +21,7 @@ machine: QEMU running (pid 8841)
2421…
25226 out of 6 tests succeeded
2623</screen>
27− After building/downloading all required dependencies, this will perform a
28− build that starts a QEMU/KVM virtual machine containing a NixOS system. The
29− virtual machine mounts the Nix store of the host; this makes VM creation very
30− fast, as no disk image needs to be created. Afterwards, you can view a
31− pretty-printed log of the test:
24+ After building/downloading all required dependencies, this will perform a build that starts a QEMU/KVM virtual machine containing a NixOS system. The virtual machine mounts the Nix store of the host; this makes VM creation very fast, as no disk image needs to be created. Afterwards, you can view a pretty-printed log of the test:
3225<screen>
3326<prompt>$ </prompt>firefox result/log.html
3427</screen>
nixos/doc/manual/development/sources.xml+9−39
@@ -5,77 +5,47 @@
55 xml:id="sec-getting-sources">
66 <title>Getting the Sources</title>
77 <para>
8− By default, NixOS’s <command>nixos-rebuild</command> command uses the NixOS
9− and Nixpkgs sources provided by the <literal>nixos</literal> channel (kept in
10− <filename>/nix/var/nix/profiles/per-user/root/channels/nixos</filename>). To
11− modify NixOS, however, you should check out the latest sources from Git. This
12− is as follows:
8+ By default, NixOS’s <command>nixos-rebuild</command> command uses the NixOS and Nixpkgs sources provided by the <literal>nixos</literal> channel (kept in <filename>/nix/var/nix/profiles/per-user/root/channels/nixos</filename>). To modify NixOS, however, you should check out the latest sources from Git. This is as follows:
139<screen>
1410<prompt>$ </prompt>git clone https://github.com/NixOS/nixpkgs
1511<prompt>$ </prompt>cd nixpkgs
1612<prompt>$ </prompt>git remote add channels https://github.com/NixOS/nixpkgs-channels
1713<prompt>$ </prompt>git remote update channels
1814</screen>
19− This will check out the latest Nixpkgs sources to
20− <filename>./nixpkgs</filename> the NixOS sources to
21− <filename>./nixpkgs/nixos</filename>. (The NixOS source tree lives in a
22− subdirectory of the Nixpkgs repository.) The remote
23− <literal>channels</literal> refers to a read-only repository that tracks the
24− Nixpkgs/NixOS channels (see <xref linkend="sec-upgrading"/> for more
25− information about channels). Thus, the Git branch
26− <literal>channels/nixos-17.03</literal> will contain the latest built and
27− tested version available in the <literal>nixos-17.03</literal> channel.
15+ This will check out the latest Nixpkgs sources to <filename>./nixpkgs</filename> the NixOS sources to <filename>./nixpkgs/nixos</filename>. (The NixOS source tree lives in a subdirectory of the Nixpkgs repository.) The remote <literal>channels</literal> refers to a read-only repository that tracks the Nixpkgs/NixOS channels (see <xref linkend="sec-upgrading"/> for more information about channels). Thus, the Git branch <literal>channels/nixos-17.03</literal> will contain the latest built and tested version available in the <literal>nixos-17.03</literal> channel.
2816 </para>
2917 <para>
30− It’s often inconvenient to develop directly on the master branch, since if
31− somebody has just committed (say) a change to GCC, then the binary cache may
32− not have caught up yet and you’ll have to rebuild everything from source.
33− So you may want to create a local branch based on your current NixOS version:
18+ It’s often inconvenient to develop directly on the master branch, since if somebody has just committed (say) a change to GCC, then the binary cache may not have caught up yet and you’ll have to rebuild everything from source. So you may want to create a local branch based on your current NixOS version:
3419<screen>
3520<prompt>$ </prompt>nixos-version
362117.09pre104379.6e0b727 (Hummingbird)
3722
3823<prompt>$ </prompt>git checkout -b local 6e0b727
3924</screen>
40− Or, to base your local branch on the latest version available in a NixOS
41− channel:
25+ Or, to base your local branch on the latest version available in a NixOS channel:
4226<screen>
4327<prompt>$ </prompt>git remote update channels
4428<prompt>$ </prompt>git checkout -b local channels/nixos-17.03
4529</screen>
46− (Replace <literal>nixos-17.03</literal> with the name of the channel you want
47− to use.) You can use <command>git merge</command> or <command>git
48− rebase</command> to keep your local branch in sync with the channel, e.g.
30+ (Replace <literal>nixos-17.03</literal> with the name of the channel you want to use.) You can use <command>git merge</command> or <command>git rebase</command> to keep your local branch in sync with the channel, e.g.
4931<screen>
5032<prompt>$ </prompt>git remote update channels
5133<prompt>$ </prompt>git merge channels/nixos-17.03
5234</screen>
53− You can use <command>git cherry-pick</command> to copy commits from your
54− local branch to the upstream branch.
35+ You can use <command>git cherry-pick</command> to copy commits from your local branch to the upstream branch.
5536 </para>
5637 <para>
57− If you want to rebuild your system using your (modified) sources, you need to
58− tell <command>nixos-rebuild</command> about them using the
59− <option>-I</option> flag:
38+ If you want to rebuild your system using your (modified) sources, you need to tell <command>nixos-rebuild</command> about them using the <option>-I</option> flag:
6039<screen>
6140<prompt># </prompt>nixos-rebuild switch -I nixpkgs=<replaceable>/my/sources</replaceable>/nixpkgs
6241</screen>
6342 </para>
6443 <para>
65− If you want <command>nix-env</command> to use the expressions in
66− <replaceable>/my/sources</replaceable>, use <command>nix-env -f
67− <replaceable>/my/sources</replaceable>/nixpkgs</command>, or change the
68− default by adding a symlink in <filename>~/.nix-defexpr</filename>:
44+ If you want <command>nix-env</command> to use the expressions in <replaceable>/my/sources</replaceable>, use <command>nix-env -f <replaceable>/my/sources</replaceable>/nixpkgs</command>, or change the default by adding a symlink in <filename>~/.nix-defexpr</filename>:
6945<screen>
7046<prompt>$ </prompt>ln -s <replaceable>/my/sources</replaceable>/nixpkgs ~/.nix-defexpr/nixpkgs
7147</screen>
72− You may want to delete the symlink
73− <filename>~/.nix-defexpr/channels_root</filename> to prevent root’s NixOS
74− channel from clashing with your own tree (this may break the
75− command-not-found utility though). If you want to go back to the default
76− state, you may just remove the <filename>~/.nix-defexpr</filename> directory
77− completely, log out and log in again and it should have been recreated with a
78− link to the root channels.
48+ You may want to delete the symlink <filename>~/.nix-defexpr/channels_root</filename> to prevent root’s NixOS channel from clashing with your own tree (this may break the command-not-found utility though). If you want to go back to the default state, you may just remove the <filename>~/.nix-defexpr</filename> directory completely, log out and log in again and it should have been recreated with a link to the root channels.
7949 </para>
8050<!-- FIXME: not sure what this means.
8151<para>You should not pass the base directory
nixos/doc/manual/development/testing-installer.xml+2−4
@@ -5,15 +5,13 @@
55 xml:id="ch-testing-installer">
66 <title>Testing the Installer</title>
77 <para>
8− Building, burning, and booting from an installation CD is rather tedious, so
9− here is a quick way to see if the installer works properly:
8+ Building, burning, and booting from an installation CD is rather tedious, so here is a quick way to see if the installer works properly:
109<screen>
1110<prompt># </prompt>mount -t tmpfs none /mnt
1211<prompt># </prompt>nixos-generate-config --root /mnt
1312<prompt>$ </prompt>nix-build '&lt;nixpkgs/nixos>' -A config.system.build.nixos-install
1413<prompt># </prompt>./result/bin/nixos-install</screen>
15− To start a login shell in the new NixOS installation in
16− <filename>/mnt</filename>:
14+ To start a login shell in the new NixOS installation in <filename>/mnt</filename>:
1715<screen>
1816<prompt>$ </prompt>nix-build '&lt;nixpkgs/nixos>' -A config.system.build.nixos-enter
1917<prompt># </prompt>./result/bin/nixos-enter
nixos/doc/manual/development/writing-documentation.xml+18−56
@@ -5,18 +5,13 @@
55 xml:id="sec-writing-documentation">
66 <title>Writing NixOS Documentation</title>
77 <para>
8− As NixOS grows, so too does the need for a catalogue and explanation of its
9− extensive functionality. Collecting pertinent information from disparate
10− sources and presenting it in an accessible style would be a worthy
11− contribution to the project.
8+ As NixOS grows, so too does the need for a catalogue and explanation of its extensive functionality. Collecting pertinent information from disparate sources and presenting it in an accessible style would be a worthy contribution to the project.
129 </para>
1310 <section xml:id="sec-writing-docs-building-the-manual">
1411 <title>Building the Manual</title>
1512
1613 <para>
17− The DocBook sources of the <xref linkend="book-nixos-manual"/> are in the
18− <link xlink:href="https://github.com/NixOS/nixpkgs/tree/master/nixos/doc/manual"><filename>nixos/doc/manual</filename></link>
19− subdirectory of the Nixpkgs repository.
14+ The DocBook sources of the <xref linkend="book-nixos-manual"/> are in the <link xlink:href="https://github.com/NixOS/nixpkgs/tree/master/nixos/doc/manual"><filename>nixos/doc/manual</filename></link> subdirectory of the Nixpkgs repository.
2015 </para>
2116
2217 <para>
@@ -29,59 +24,45 @@
2924</screen>
3025
3126 <para>
32− Once you are done making modifications to the manual, it's important to
33− build it before committing. You can do that as follows:
27+ Once you are done making modifications to the manual, it's important to build it before committing. You can do that as follows:
3428 </para>
3529
3630<screen>nix-build nixos/release.nix -A manual.x86_64-linux</screen>
3731
3832 <para>
39− When this command successfully finishes, it will tell you where the manual
40− got generated. The HTML will be accessible through the
41− <filename>result</filename> symlink at
42− <filename>./result/share/doc/nixos/index.html</filename>.
33+ When this command successfully finishes, it will tell you where the manual got generated. The HTML will be accessible through the <filename>result</filename> symlink at <filename>./result/share/doc/nixos/index.html</filename>.
4334 </para>
4435 </section>
4536 <section xml:id="sec-writing-docs-editing-docbook-xml">
4637 <title>Editing DocBook XML</title>
4738
4839 <para>
49− For general information on how to write in DocBook, see
50− <link xlink:href="http://www.docbook.org/tdg5/en/html/docbook.html"> DocBook
51− 5: The Definitive Guide</link>.
40+ For general information on how to write in DocBook, see <link xlink:href="http://www.docbook.org/tdg5/en/html/docbook.html"> DocBook 5: The Definitive Guide</link>.
5241 </para>
5342
5443 <para>
55− Emacs nXML Mode is very helpful for editing DocBook XML because it validates
56− the document as you write, and precisely locates errors. To use it, see
57− <xref linkend="sec-emacs-docbook-xml"/>.
44+ Emacs nXML Mode is very helpful for editing DocBook XML because it validates the document as you write, and precisely locates errors. To use it, see <xref linkend="sec-emacs-docbook-xml"/>.
5845 </para>
5946
6047 <para>
61− <link xlink:href="http://pandoc.org">Pandoc</link> can generate DocBook XML
62− from a multitude of formats, which makes a good starting point.
48+ <link xlink:href="http://pandoc.org">Pandoc</link> can generate DocBook XML from a multitude of formats, which makes a good starting point.
6349 <example xml:id="ex-pandoc-xml-conv">
6450 <title>Pandoc invocation to convert GitHub-Flavoured MarkDown to DocBook 5 XML</title>
6551<screen>pandoc -f markdown_github -t docbook5 docs.md -o my-section.md</screen>
6652 </example>
67− Pandoc can also quickly convert a single <filename>section.xml</filename> to
68− HTML, which is helpful when drafting.
53+ Pandoc can also quickly convert a single <filename>section.xml</filename> to HTML, which is helpful when drafting.
6954 </para>
7055
7156 <para>
72− Sometimes writing valid DocBook is simply too difficult. In this case,
73− submit your documentation updates in a
74− <link
75− xlink:href="https://github.com/NixOS/nixpkgs/issues/new">GitHub
76− Issue</link> and someone will handle the conversion to XML for you.
57+ Sometimes writing valid DocBook is simply too difficult. In this case, submit your documentation updates in a <link
58+ xlink:href="https://github.com/NixOS/nixpkgs/issues/new">GitHub Issue</link> and someone will handle the conversion to XML for you.
7759 </para>
7860 </section>
7961 <section xml:id="sec-writing-docs-creating-a-topic">
8062 <title>Creating a Topic</title>
8163
8264 <para>
83− You can use an existing topic as a basis for the new topic or create a topic
84− from scratch.
65+ You can use an existing topic as a basis for the new topic or create a topic from scratch.
8566 </para>
8667
8768 <para>
@@ -89,40 +70,27 @@
8970 <itemizedlist>
9071 <listitem>
9172 <para>
92− The NixOS
93− <link xlink:href="http://www.docbook.org/tdg5/en/html/book.html"><tag>book</tag></link>
94− element is in <filename>nixos/doc/manual/manual.xml</filename>. It
95− includes several
96− <link xlink:href="http://www.docbook.org/tdg5/en/html/book.html"><tag>part</tag>s</link>
97− which are in subdirectories.
73+ The NixOS <link xlink:href="http://www.docbook.org/tdg5/en/html/book.html"><tag>book</tag></link> element is in <filename>nixos/doc/manual/manual.xml</filename>. It includes several <link xlink:href="http://www.docbook.org/tdg5/en/html/book.html"><tag>part</tag>s</link> which are in subdirectories.
9874 </para>
9975 </listitem>
10076 <listitem>
10177 <para>
102− Store the topic file in the same directory as the <tag>part</tag> to
103− which it belongs. If your topic is about configuring a NixOS module, then
104− the XML file can be stored alongside the module definition
105− <filename>nix</filename> file.
78+ Store the topic file in the same directory as the <tag>part</tag> to which it belongs. If your topic is about configuring a NixOS module, then the XML file can be stored alongside the module definition <filename>nix</filename> file.
10679 </para>
10780 </listitem>
10881 <listitem>
10982 <para>
110− If you include multiple words in the file name, separate the words with a
111− dash. For example: <filename>ipv6-config.xml</filename>.
83+ If you include multiple words in the file name, separate the words with a dash. For example: <filename>ipv6-config.xml</filename>.
11284 </para>
11385 </listitem>
11486 <listitem>
11587 <para>
116− Make sure that the <tag>xml:id</tag> value is unique. You can use
117− abbreviations if the ID is too long. For example:
118− <varname>nixos-config</varname>.
88+ Make sure that the <tag>xml:id</tag> value is unique. You can use abbreviations if the ID is too long. For example: <varname>nixos-config</varname>.
11989 </para>
12090 </listitem>
12191 <listitem>
12292 <para>
123− Determine whether your topic is a chapter or a section. If you are
124− unsure, open an existing topic file and check whether the main element is
125− chapter or section.
93+ Determine whether your topic is a chapter or a section. If you are unsure, open an existing topic file and check whether the main element is chapter or section.
12694 </para>
12795 </listitem>
12896 </itemizedlist>
@@ -132,17 +100,11 @@
132100 <title>Adding a Topic to the Book</title>
133101
134102 <para>
135− Open the parent XML file and add an <varname>xi:include</varname> element to
136− the list of chapters with the file name of the topic that you created. If
137− you created a <tag>section</tag>, you add the file to the <tag>chapter</tag>
138− file. If you created a <tag>chapter</tag>, you add the file to the
139− <tag>part</tag> file.
103+ Open the parent XML file and add an <varname>xi:include</varname> element to the list of chapters with the file name of the topic that you created. If you created a <tag>section</tag>, you add the file to the <tag>chapter</tag> file. If you created a <tag>chapter</tag>, you add the file to the <tag>part</tag> file.
140104 </para>
141105
142106 <para>
143− If the topic is about configuring a NixOS module, it can be automatically
144− included in the manual by using the <varname>meta.doc</varname> attribute.
145− See <xref
107+ If the topic is about configuring a NixOS module, it can be automatically included in the manual by using the <varname>meta.doc</varname> attribute. See <xref
146108 linkend="sec-meta-attributes"/> for an explanation.
147109 </para>
148110 </section>
nixos/doc/manual/development/writing-modules.xml+13−56
@@ -5,49 +5,25 @@
55 xml:id="sec-writing-modules">
66 <title>Writing NixOS Modules</title>
77 <para>
8− NixOS has a modular system for declarative configuration. This system
9− combines multiple <emphasis>modules</emphasis> to produce the full system
10− configuration. One of the modules that constitute the configuration is
11− <filename>/etc/nixos/configuration.nix</filename>. Most of the others live in
12− the
13− <link
14−xlink:href="https://github.com/NixOS/nixpkgs/tree/master/nixos/modules"><filename>nixos/modules</filename></link>
15− subdirectory of the Nixpkgs tree.
8+ NixOS has a modular system for declarative configuration. This system combines multiple <emphasis>modules</emphasis> to produce the full system configuration. One of the modules that constitute the configuration is <filename>/etc/nixos/configuration.nix</filename>. Most of the others live in the <link
9+xlink:href="https://github.com/NixOS/nixpkgs/tree/master/nixos/modules"><filename>nixos/modules</filename></link> subdirectory of the Nixpkgs tree.
1610 </para>
1711 <para>
18− Each NixOS module is a file that handles one logical aspect of the
19− configuration, such as a specific kind of hardware, a service, or network
20− settings. A module configuration does not have to handle everything from
21− scratch; it can use the functionality provided by other modules for its
22− implementation. Thus a module can <emphasis>declare</emphasis> options that
23− can be used by other modules, and conversely can <emphasis>define</emphasis>
24− options provided by other modules in its own implementation. For example, the
25− module
26− <link
27−xlink:href="https://github.com/NixOS/nixpkgs/blob/master/nixos/modules/security/pam.nix"><filename>pam.nix</filename></link>
28− declares the option <option>security.pam.services</option> that allows other
29− modules (e.g.
30− <link
31−xlink:href="https://github.com/NixOS/nixpkgs/blob/master/nixos/modules/services/networking/ssh/sshd.nix"><filename>sshd.nix</filename></link>)
32− to define PAM services; and it defines the option
33− <option>environment.etc</option> (declared by
34− <link
35−xlink:href="https://github.com/NixOS/nixpkgs/blob/master/nixos/modules/system/etc/etc.nix"><filename>etc.nix</filename></link>)
36− to cause files to be created in <filename>/etc/pam.d</filename>.
12+ Each NixOS module is a file that handles one logical aspect of the configuration, such as a specific kind of hardware, a service, or network settings. A module configuration does not have to handle everything from scratch; it can use the functionality provided by other modules for its implementation. Thus a module can <emphasis>declare</emphasis> options that can be used by other modules, and conversely can <emphasis>define</emphasis> options provided by other modules in its own implementation. For example, the module <link
13+xlink:href="https://github.com/NixOS/nixpkgs/blob/master/nixos/modules/security/pam.nix"><filename>pam.nix</filename></link> declares the option <option>security.pam.services</option> that allows other modules (e.g. <link
14+xlink:href="https://github.com/NixOS/nixpkgs/blob/master/nixos/modules/services/networking/ssh/sshd.nix"><filename>sshd.nix</filename></link>) to define PAM services; and it defines the option <option>environment.etc</option> (declared by <link
15+xlink:href="https://github.com/NixOS/nixpkgs/blob/master/nixos/modules/system/etc/etc.nix"><filename>etc.nix</filename></link>) to cause files to be created in <filename>/etc/pam.d</filename>.
3716 </para>
3817 <para xml:id="para-module-syn">
3918 In <xref
40−linkend="sec-configuration-syntax"/>, we saw the following structure
41− of NixOS modules:
19+linkend="sec-configuration-syntax"/>, we saw the following structure of NixOS modules:
4220<programlisting>
4321{ config, pkgs, ... }:
4422
4523{ <replaceable>option definitions</replaceable>
4624}
4725</programlisting>
48− This is actually an <emphasis>abbreviated</emphasis> form of module that only
49− defines options, but does not declare any. The structure of full NixOS
50− modules is shown in <xref linkend='ex-module-syntax' />.
26+ This is actually an <emphasis>abbreviated</emphasis> form of module that only defines options, but does not declare any. The structure of full NixOS modules is shown in <xref linkend='ex-module-syntax' />.
5127 </para>
5228 <example xml:id='ex-module-syntax'>
5329 <title>Structure of NixOS Modules</title>
@@ -73,47 +49,28 @@ linkend="sec-configuration-syntax"/>, we saw the following structure
7349 <calloutlist>
7450 <callout arearefs='module-syntax-1'>
7551 <para>
76− This line makes the current Nix expression a function. The variable
77− <varname>pkgs</varname> contains Nixpkgs, while <varname>config</varname>
78− contains the full system configuration. This line can be omitted if there
79− is no reference to <varname>pkgs</varname> and <varname>config</varname>
80− inside the module.
52+ This line makes the current Nix expression a function. The variable <varname>pkgs</varname> contains Nixpkgs, while <varname>config</varname> contains the full system configuration. This line can be omitted if there is no reference to <varname>pkgs</varname> and <varname>config</varname> inside the module.
8153 </para>
8254 </callout>
8355 <callout arearefs='module-syntax-2'>
8456 <para>
85− This list enumerates the paths to other NixOS modules that should be
86− included in the evaluation of the system configuration. A default set of
87− modules is defined in the file
88− <filename>modules/module-list.nix</filename>. These don't need to be added
89− in the import list.
57+ This list enumerates the paths to other NixOS modules that should be included in the evaluation of the system configuration. A default set of modules is defined in the file <filename>modules/module-list.nix</filename>. These don't need to be added in the import list.
9058 </para>
9159 </callout>
9260 <callout arearefs='module-syntax-3'>
9361 <para>
94− The attribute <varname>options</varname> is a nested set of
95− <emphasis>option declarations</emphasis> (described below).
62+ The attribute <varname>options</varname> is a nested set of <emphasis>option declarations</emphasis> (described below).
9663 </para>
9764 </callout>
9865 <callout arearefs='module-syntax-4'>
9966 <para>
100− The attribute <varname>config</varname> is a nested set of
101− <emphasis>option definitions</emphasis> (also described below).
67+ The attribute <varname>config</varname> is a nested set of <emphasis>option definitions</emphasis> (also described below).
10268 </para>
10369 </callout>
10470 </calloutlist>
10571 </para>
10672 <para>
107− <xref linkend='locate-example' /> shows a module that handles the regular
108− update of the “locate” database, an index of all files in the file
109− system. This module declares two options that can be defined by other modules
110− (typically the user’s <filename>configuration.nix</filename>):
111− <option>services.locate.enable</option> (whether the database should be
112− updated) and <option>services.locate.interval</option> (when the update
113− should be done). It implements its functionality by defining two options
114− declared by other modules: <option>systemd.services</option> (the set of all
115− systemd services) and <option>systemd.timers</option> (the list of commands
116− to be executed periodically by <command>systemd</command>).
73+ <xref linkend='locate-example' /> shows a module that handles the regular update of the “locate” database, an index of all files in the file system. This module declares two options that can be defined by other modules (typically the user’s <filename>configuration.nix</filename>): <option>services.locate.enable</option> (whether the database should be updated) and <option>services.locate.interval</option> (when the update should be done). It implements its functionality by defining two options declared by other modules: <option>systemd.services</option> (the set of all systemd services) and <option>systemd.timers</option> (the list of commands to be executed periodically by <command>systemd</command>).
11774 </para>
11875 <example xml:id='locate-example'>
11976 <title>NixOS Module for the “locate” Service</title>
nixos/doc/manual/development/writing-nixos-tests.xml+29−84
@@ -31,22 +31,9 @@ import ./make-test.nix {
3131 '';
3232}
3333</programlisting>
34− The attribute <literal>testScript</literal> is a bit of Perl code that
35− executes the test (described below). During the test, it will start one or
36− more virtual machines, the configuration of which is described by the
37− attribute <literal>machine</literal> (if you need only one machine in your
38− test) or by the attribute <literal>nodes</literal> (if you need multiple
39− machines). For instance,
40− <filename
41−xlink:href="https://github.com/NixOS/nixpkgs/blob/master/nixos/tests/login.nix">login.nix</filename>
42− only needs a single machine to test whether users can log in on the virtual
43− console, whether device ownership is correctly maintained when switching
44− between consoles, and so on. On the other hand,
45− <filename
46−xlink:href="https://github.com/NixOS/nixpkgs/blob/master/nixos/tests/nfs.nix">nfs.nix</filename>,
47− which tests NFS client and server functionality in the Linux kernel
48− (including whether locks are maintained across server crashes), requires
49− three machines: a server and two clients.
34+ The attribute <literal>testScript</literal> is a bit of Perl code that executes the test (described below). During the test, it will start one or more virtual machines, the configuration of which is described by the attribute <literal>machine</literal> (if you need only one machine in your test) or by the attribute <literal>nodes</literal> (if you need multiple machines). For instance, <filename
35+xlink:href="https://github.com/NixOS/nixpkgs/blob/master/nixos/tests/login.nix">login.nix</filename> only needs a single machine to test whether users can log in on the virtual console, whether device ownership is correctly maintained when switching between consoles, and so on. On the other hand, <filename
36+xlink:href="https://github.com/NixOS/nixpkgs/blob/master/nixos/tests/nfs.nix">nfs.nix</filename>, which tests NFS client and server functionality in the Linux kernel (including whether locks are maintained across server crashes), requires three machines: a server and two clients.
5037 </para>
5138
5239 <para>
@@ -69,10 +56,8 @@ xlink:href="https://github.com/NixOS/nixpkgs/blob/master/nixos/tests/nfs.nix">nf
6956 </term>
7057 <listitem>
7158 <para>
72− The virtual networks to which the VM is connected. See
73− <filename
74− xlink:href="https://github.com/NixOS/nixpkgs/blob/master/nixos/tests/nat.nix">nat.nix</filename>
75− for an example.
59+ The virtual networks to which the VM is connected. See <filename
60+ xlink:href="https://github.com/NixOS/nixpkgs/blob/master/nixos/tests/nat.nix">nat.nix</filename> for an example.
7661 </para>
7762 </listitem>
7863 </varlistentry>
@@ -82,38 +67,23 @@ xlink:href="https://github.com/NixOS/nixpkgs/blob/master/nixos/tests/nfs.nix">nf
8267 </term>
8368 <listitem>
8469 <para>
85− By default, the Nix store in the VM is not writable. If you enable this
86− option, a writable union file system is mounted on top of the Nix store
87− to make it appear writable. This is necessary for tests that run Nix
88− operations that modify the store.
70+ By default, the Nix store in the VM is not writable. If you enable this option, a writable union file system is mounted on top of the Nix store to make it appear writable. This is necessary for tests that run Nix operations that modify the store.
8971 </para>
9072 </listitem>
9173 </varlistentry>
9274 </variablelist>
93− For more options, see the module
94− <filename
75+ For more options, see the module <filename
9576xlink:href="https://github.com/NixOS/nixpkgs/blob/master/nixos/modules/virtualisation/qemu-vm.nix">qemu-vm.nix</filename>.
9677 </para>
9778
9879 <para>
99− The test script is a sequence of Perl statements that perform various
100− actions, such as starting VMs, executing commands in the VMs, and so on. Each
101− virtual machine is represented as an object stored in the variable
102− <literal>$<replaceable>name</replaceable></literal>, where
103− <replaceable>name</replaceable> is the identifier of the machine (which is
104− just <literal>machine</literal> if you didn’t specify multiple machines
105− using the <literal>nodes</literal> attribute). For instance, the following
106− starts the machine, waits until it has finished booting, then executes a
107− command and checks that the output is more-or-less correct:
80+ The test script is a sequence of Perl statements that perform various actions, such as starting VMs, executing commands in the VMs, and so on. Each virtual machine is represented as an object stored in the variable <literal>$<replaceable>name</replaceable></literal>, where <replaceable>name</replaceable> is the identifier of the machine (which is just <literal>machine</literal> if you didn’t specify multiple machines using the <literal>nodes</literal> attribute). For instance, the following starts the machine, waits until it has finished booting, then executes a command and checks that the output is more-or-less correct:
10881<programlisting>
10982$machine->start;
11083$machine->waitForUnit("default.target");
11184$machine->succeed("uname") =~ /Linux/ or die;
11285</programlisting>
113− The first line is actually unnecessary; machines are implicitly started when
114− you first execute an action on them (such as <literal>waitForUnit</literal>
115− or <literal>succeed</literal>). If you have multiple machines, you can speed
116− up the test by starting them in parallel:
86+ The first line is actually unnecessary; machines are implicitly started when you first execute an action on them (such as <literal>waitForUnit</literal> or <literal>succeed</literal>). If you have multiple machines, you can speed up the test by starting them in parallel:
11787<programlisting>
11888startAll;
11989</programlisting>
@@ -128,8 +98,7 @@ startAll;
12898 </term>
12999 <listitem>
130100 <para>
131− Start the virtual machine. This method is asynchronous — it does not
132− wait for the machine to finish booting.
101+ Start the virtual machine. This method is asynchronous — it does not wait for the machine to finish booting.
133102 </para>
134103 </listitem>
135104 </varlistentry>
@@ -159,8 +128,7 @@ startAll;
159128 </term>
160129 <listitem>
161130 <para>
162− Simulate unplugging the Ethernet cable that connects the machine to the
163− other machines.
131+ Simulate unplugging the Ethernet cable that connects the machine to the other machines.
164132 </para>
165133 </listitem>
166134 </varlistentry>
@@ -180,8 +148,7 @@ startAll;
180148 </term>
181149 <listitem>
182150 <para>
183− Take a picture of the display of the virtual machine, in PNG format. The
184− screenshot is linked from the HTML log.
151+ Take a picture of the display of the virtual machine, in PNG format. The screenshot is linked from the HTML log.
185152 </para>
186153 </listitem>
187154 </varlistentry>
@@ -191,13 +158,11 @@ startAll;
191158 </term>
192159 <listitem>
193160 <para>
194− Return a textual representation of what is currently visible on the
195− machine's screen using optical character recognition.
161+ Return a textual representation of what is currently visible on the machine's screen using optical character recognition.
196162 </para>
197163 <note>
198164 <para>
199− This requires passing <option>enableOCR</option> to the test attribute
200− set.
165+ This requires passing <option>enableOCR</option> to the test attribute set.
201166 </para>
202167 </note>
203168 </listitem>
@@ -208,8 +173,7 @@ startAll;
208173 </term>
209174 <listitem>
210175 <para>
211− Send a command to the QEMU monitor. This is rarely used, but allows doing
212− stuff such as attaching virtual USB disks to a running machine.
176+ Send a command to the QEMU monitor. This is rarely used, but allows doing stuff such as attaching virtual USB disks to a running machine.
213177 </para>
214178 </listitem>
215179 </varlistentry>
@@ -219,8 +183,7 @@ startAll;
219183 </term>
220184 <listitem>
221185 <para>
222− Simulate pressing keys on the virtual keyboard, e.g.,
223− <literal>sendKeys("ctrl-alt-delete")</literal>.
186+ Simulate pressing keys on the virtual keyboard, e.g., <literal>sendKeys("ctrl-alt-delete")</literal>.
224187 </para>
225188 </listitem>
226189 </varlistentry>
@@ -230,9 +193,7 @@ startAll;
230193 </term>
231194 <listitem>
232195 <para>
233− Simulate typing a sequence of characters on the virtual keyboard, e.g.,
234− <literal>sendKeys("foobar\n")</literal> will type the string
235− <literal>foobar</literal> followed by the Enter key.
196+ Simulate typing a sequence of characters on the virtual keyboard, e.g., <literal>sendKeys("foobar\n")</literal> will type the string <literal>foobar</literal> followed by the Enter key.
236197 </para>
237198 </listitem>
238199 </varlistentry>
@@ -242,9 +203,7 @@ startAll;
242203 </term>
243204 <listitem>
244205 <para>
245− Execute a shell command, returning a list
246− <literal>(<replaceable>status</replaceable>,
247− <replaceable>stdout</replaceable>)</literal>.
206+ Execute a shell command, returning a list <literal>(<replaceable>status</replaceable>, <replaceable>stdout</replaceable>)</literal>.
248207 </para>
249208 </listitem>
250209 </varlistentry>
@@ -254,8 +213,7 @@ startAll;
254213 </term>
255214 <listitem>
256215 <para>
257− Execute a shell command, raising an exception if the exit status is not
258− zero, otherwise returning the standard output.
216+ Execute a shell command, raising an exception if the exit status is not zero, otherwise returning the standard output.
259217 </para>
260218 </listitem>
261219 </varlistentry>
@@ -265,8 +223,7 @@ startAll;
265223 </term>
266224 <listitem>
267225 <para>
268− Like <methodname>succeed</methodname>, but raising an exception if the
269− command returns a zero status.
226+ Like <methodname>succeed</methodname>, but raising an exception if the command returns a zero status.
270227 </para>
271228 </listitem>
272229 </varlistentry>
@@ -316,8 +273,7 @@ startAll;
316273 </term>
317274 <listitem>
318275 <para>
319− Wait until a process is listening on the given TCP port (on
320− <literal>localhost</literal>, at least).
276+ Wait until a process is listening on the given TCP port (on <literal>localhost</literal>, at least).
321277 </para>
322278 </listitem>
323279 </varlistentry>
@@ -347,14 +303,11 @@ startAll;
347303 </term>
348304 <listitem>
349305 <para>
350− Wait until the supplied regular expressions matches the textual contents
351− of the screen by using optical character recognition (see
352− <methodname>getScreenText</methodname>).
306+ Wait until the supplied regular expressions matches the textual contents of the screen by using optical character recognition (see <methodname>getScreenText</methodname>).
353307 </para>
354308 <note>
355309 <para>
356− This requires passing <option>enableOCR</option> to the test attribute
357− set.
310+ This requires passing <option>enableOCR</option> to the test attribute set.
358311 </para>
359312 </note>
360313 </listitem>
@@ -365,8 +318,7 @@ startAll;
365318 </term>
366319 <listitem>
367320 <para>
368− Wait until an X11 window has appeared whose name matches the given
369− regular expression, e.g., <literal>waitForWindow(qr/Terminal/)</literal>.
321+ Wait until an X11 window has appeared whose name matches the given regular expression, e.g., <literal>waitForWindow(qr/Terminal/)</literal>.
370322 </para>
371323 </listitem>
372324 </varlistentry>
@@ -376,13 +328,10 @@ startAll;
376328 </term>
377329 <listitem>
378330 <para>
379− Copies a file from host to machine, e.g.,
380− <literal>copyFileFromHost("myfile", "/etc/my/important/file")</literal>.
331+ Copies a file from host to machine, e.g., <literal>copyFileFromHost("myfile", "/etc/my/important/file")</literal>.
381332 </para>
382333 <para>
383− The first argument is the file on the host. The file needs to be
384− accessible while building the nix derivation. The second argument is the
385− location of the file on the machine.
334+ The first argument is the file on the host. The file needs to be accessible while building the nix derivation. The second argument is the location of the file on the machine.
386335 </para>
387336 </listitem>
388337 </varlistentry>
@@ -392,8 +341,7 @@ startAll;
392341 </term>
393342 <listitem>
394343 <para>
395− Runs <literal>systemctl</literal> commands with optional support for
396− <literal>systemctl --user</literal>
344+ Runs <literal>systemctl</literal> commands with optional support for <literal>systemctl --user</literal>
397345 </para>
398346 <para>
399347<programlisting>
@@ -407,15 +355,12 @@ $machine->systemctl("list-jobs --no-pager", "any-user"); // spawns a shell for `
407355 </para>
408356
409357 <para>
410− To test user units declared by <literal>systemd.user.services</literal> the
411− optional <literal>$user</literal> argument can be used:
358+ To test user units declared by <literal>systemd.user.services</literal> the optional <literal>$user</literal> argument can be used:
412359<programlisting>
413360$machine->start;
414361$machine->waitForX;
415362$machine->waitForUnit("xautolock.service", "x-session-user");
416363</programlisting>
417− This applies to <literal>systemctl</literal>, <literal>getUnitInfo</literal>,
418− <literal>waitForUnit</literal>, <literal>startJob</literal> and
419− <literal>stopJob</literal>.
364+ This applies to <literal>systemctl</literal>, <literal>getUnitInfo</literal>, <literal>waitForUnit</literal>, <literal>startJob</literal> and <literal>stopJob</literal>.
420365 </para>
421366</section>
nixos/doc/manual/installation/changing-config.xml+13−40
@@ -4,28 +4,20 @@
44 xml:id="sec-changing-config">
55 <title>Changing the Configuration</title>
66 <para>
7− The file <filename>/etc/nixos/configuration.nix</filename> contains the
8− current configuration of your machine. Whenever you’ve
9− <link linkend="ch-configuration">changed something</link> in that file, you
10− should do
7+ The file <filename>/etc/nixos/configuration.nix</filename> contains the current configuration of your machine. Whenever you’ve <link linkend="ch-configuration">changed something</link> in that file, you should do
118<screen>
129<prompt># </prompt>nixos-rebuild switch
1310</screen>
14− to build the new configuration, make it the default configuration for
15− booting, and try to realise the configuration in the running system (e.g., by
16− restarting system services).
11+ to build the new configuration, make it the default configuration for booting, and try to realise the configuration in the running system (e.g., by restarting system services).
1712 <warning>
1813 <para>
19− This command doesn't start/stop <link linkend="opt-systemd.user.services">user
20− services</link> automatically. <command>nixos-rebuild</command> only runs a
21− <literal>daemon-reload</literal> for each user with running user services.
14+ This command doesn't start/stop <link linkend="opt-systemd.user.services">user services</link> automatically. <command>nixos-rebuild</command> only runs a <literal>daemon-reload</literal> for each user with running user services.
2215 </para>
2316 </warning>
2417 </para>
2518 <warning>
2619 <para>
27− These commands must be executed as root, so you should either run them from
28− a root shell or by prefixing them with <literal>sudo -i</literal>.
20+ These commands must be executed as root, so you should either run them from a root shell or by prefixing them with <literal>sudo -i</literal>.
2921 </para>
3022 </warning>
3123 <para>
@@ -33,63 +25,44 @@
3325<screen>
3426<prompt># </prompt>nixos-rebuild test
3527</screen>
36− to build the configuration and switch the running system to it, but without
37− making it the boot default. So if (say) the configuration locks up your
38− machine, you can just reboot to get back to a working configuration.
28+ to build the configuration and switch the running system to it, but without making it the boot default. So if (say) the configuration locks up your machine, you can just reboot to get back to a working configuration.
3929 </para>
4030 <para>
4131 There is also
4232<screen>
4333<prompt># </prompt>nixos-rebuild boot
4434</screen>
45− to build the configuration and make it the boot default, but not switch to it
46− now (so it will only take effect after the next reboot).
35+ to build the configuration and make it the boot default, but not switch to it now (so it will only take effect after the next reboot).
4736 </para>
4837 <para>
49− You can make your configuration show up in a different submenu of the GRUB 2
50− boot screen by giving it a different <emphasis>profile name</emphasis>, e.g.
38+ You can make your configuration show up in a different submenu of the GRUB 2 boot screen by giving it a different <emphasis>profile name</emphasis>, e.g.
5139<screen>
5240<prompt># </prompt>nixos-rebuild switch -p test
5341</screen>
54− which causes the new configuration (and previous ones created using
55− <literal>-p test</literal>) to show up in the GRUB submenu “NixOS - Profile
56− 'test'”. This can be useful to separate test configurations from
57− “stable” configurations.
42+ which causes the new configuration (and previous ones created using <literal>-p test</literal>) to show up in the GRUB submenu “NixOS - Profile 'test'”. This can be useful to separate test configurations from “stable” configurations.
5843 </para>
5944 <para>
6045 Finally, you can do
6146<screen>
6247<prompt>$ </prompt>nixos-rebuild build
6348</screen>
64− to build the configuration but nothing more. This is useful to see whether
65− everything compiles cleanly.
49+ to build the configuration but nothing more. This is useful to see whether everything compiles cleanly.
6650 </para>
6751 <para>
68− If you have a machine that supports hardware virtualisation, you can also
69− test the new configuration in a sandbox by building and running a QEMU
70− <emphasis>virtual machine</emphasis> that contains the desired configuration.
71− Just do
52+ If you have a machine that supports hardware virtualisation, you can also test the new configuration in a sandbox by building and running a QEMU <emphasis>virtual machine</emphasis> that contains the desired configuration. Just do
7253<screen>
7354<prompt>$ </prompt>nixos-rebuild build-vm
7455<prompt>$ </prompt>./result/bin/run-*-vm
7556</screen>
76− The VM does not have any data from your host system, so your existing user
77− accounts and home directories will not be available unless you have set
78− <literal>mutableUsers = false</literal>. Another way is to temporarily add
79− the following to your configuration:
57+ The VM does not have any data from your host system, so your existing user accounts and home directories will not be available unless you have set <literal>mutableUsers = false</literal>. Another way is to temporarily add the following to your configuration:
8058<screen>
8159<link linkend="opt-users.users._name__.initialHashedPassword">users.users.your-user.initialHashedPassword</link> = "test";
8260</screen>
83− <emphasis>Important:</emphasis> delete the $hostname.qcow2 file if you have
84− started the virtual machine at least once without the right users, otherwise
85− the changes will not get picked up. You can forward ports on the host to the
86− guest. For instance, the following will forward host port 2222 to guest port
87− 22 (SSH):
61+ <emphasis>Important:</emphasis> delete the $hostname.qcow2 file if you have started the virtual machine at least once without the right users, otherwise the changes will not get picked up. You can forward ports on the host to the guest. For instance, the following will forward host port 2222 to guest port 22 (SSH):
8862<screen>
8963<prompt>$ </prompt>QEMU_NET_OPTS="hostfwd=tcp::2222-:22" ./result/bin/run-*-vm
9064</screen>
91− allowing you to log in via SSH (assuming you have set the appropriate
92− passwords or SSH authorized keys):
65+ allowing you to log in via SSH (assuming you have set the appropriate passwords or SSH authorized keys):
9366<screen>
9467<prompt>$ </prompt>ssh -p 2222 localhost
9568</screen>
nixos/doc/manual/installation/installation.xml+1−2
@@ -6,8 +6,7 @@
66 <title>Installation</title>
77 <partintro xml:id="ch-installation-intro">
88 <para>
9− This section describes how to obtain, install, and configure NixOS for
10− first-time use.
9+ This section describes how to obtain, install, and configure NixOS for first-time use.
1110 </para>
1211 </partintro>
1312 <xi:include href="obtaining.xml" />
nixos/doc/manual/installation/installing-behind-a-proxy.xml+4−11
@@ -6,16 +6,13 @@
66 <title>Installing behind a proxy</title>
77
88 <para>
9− To install NixOS behind a proxy, do the following before running
10− <literal>nixos-install</literal>.
9+ To install NixOS behind a proxy, do the following before running <literal>nixos-install</literal>.
1110 </para>
1211
1312 <orderedlist numeration="arabic">
1413 <listitem>
1514 <para>
16− Update proxy configuration in
17− <literal>/mnt/etc/nixos/configuration.nix</literal> to keep the internet
18− accessible after reboot.
15+ Update proxy configuration in <literal>/mnt/etc/nixos/configuration.nix</literal> to keep the internet accessible after reboot.
1916 </para>
2017<programlisting>
2118networking.proxy.default = &quot;http://user:password@proxy:port/&quot;;
@@ -24,8 +21,7 @@ networking.proxy.noProxy = &quot;127.0.0.1,localhost,internal.domain&quot;;
2421 </listitem>
2522 <listitem>
2623 <para>
27− Setup the proxy environment variables in the shell where you are running
28− <literal>nixos-install</literal>.
24+ Setup the proxy environment variables in the shell where you are running <literal>nixos-install</literal>.
2925 </para>
3026<programlisting>
3127# proxy_url=&quot;http://user:password@proxy:port/&quot;
@@ -39,10 +35,7 @@ networking.proxy.noProxy = &quot;127.0.0.1,localhost,internal.domain&quot;;
3935
4036 <note>
4137 <para>
42− If you are switching networks with different proxy configurations, use the
43− <literal>nesting.clone</literal> option in
44− <literal>configuration.nix</literal> to switch proxies at runtime. Refer to
45− <xref linkend="ch-options" /> for more information.
38+ If you are switching networks with different proxy configurations, use the <literal>nesting.clone</literal> option in <literal>configuration.nix</literal> to switch proxies at runtime. Refer to <xref linkend="ch-options" /> for more information.
4639 </para>
4740 </note>
4841</section>
nixos/doc/manual/installation/installing-from-other-distro.xml+40−112
@@ -8,28 +8,23 @@
88 <title>Installing from another Linux distribution</title>
99
1010 <para>
11− Because Nix (the package manager) &amp; Nixpkgs (the Nix packages collection)
12− can both be installed on any (most?) Linux distributions, they can be used to
13− install NixOS in various creative ways. You can, for instance:
11+ Because Nix (the package manager) &amp; Nixpkgs (the Nix packages collection) can both be installed on any (most?) Linux distributions, they can be used to install NixOS in various creative ways. You can, for instance:
1412 </para>
1513
1614 <orderedlist>
1715 <listitem>
1816 <para>
19− Install NixOS on another partition, from your existing Linux distribution
20− (without the use of a USB or optical device!)
17+ Install NixOS on another partition, from your existing Linux distribution (without the use of a USB or optical device!)
2118 </para>
2219 </listitem>
2320 <listitem>
2421 <para>
25− Install NixOS on the same partition (in place!), from your existing
26− non-NixOS Linux distribution using <literal>NIXOS_LUSTRATE</literal>.
22+ Install NixOS on the same partition (in place!), from your existing non-NixOS Linux distribution using <literal>NIXOS_LUSTRATE</literal>.
2723 </para>
2824 </listitem>
2925 <listitem>
3026 <para>
31− Install NixOS on your hard drive from the Live CD of any Linux
32− distribution.
27+ Install NixOS on your hard drive from the Live CD of any Linux distribution.
3328 </para>
3429 </listitem>
3530 </orderedlist>
@@ -50,10 +45,8 @@
5045<prompt>$ </prompt>curl https://nixos.org/nix/install | sh
5146<prompt>$ </prompt>. $HOME/.nix-profile/etc/profile.d/nix.sh # …or open a fresh shell</screen>
5247 <para>
53− More details in the
54− <link
55− xlink:href="https://nixos.org/nix/manual/#chap-quick-start">
56− Nix manual</link>
48+ More details in the <link
49+ xlink:href="https://nixos.org/nix/manual/#chap-quick-start"> Nix manual</link>
5750 </para>
5851 </listitem>
5952 <listitem>
@@ -61,21 +54,18 @@
6154 Switch to the NixOS channel:
6255 </para>
6356 <para>
64− If you've just installed Nix on a non-NixOS distribution, you will be on
65− the <literal>nixpkgs</literal> channel by default.
57+ If you've just installed Nix on a non-NixOS distribution, you will be on the <literal>nixpkgs</literal> channel by default.
6658 </para>
6759<screen>
6860<prompt>$ </prompt>nix-channel --list
6961nixpkgs https://nixos.org/channels/nixpkgs-unstable</screen>
7062 <para>
71− As that channel gets released without running the NixOS tests, it will be
72− safer to use the <literal>nixos-*</literal> channels instead:
63+ As that channel gets released without running the NixOS tests, it will be safer to use the <literal>nixos-*</literal> channels instead:
7364 </para>
7465<screen>
7566<prompt>$ </prompt>nix-channel --add https://nixos.org/channels/nixos-<replaceable>version</replaceable> nixpkgs</screen>
7667 <para>
77− You may want to throw in a <literal>nix-channel --update</literal> for good
78− measure.
68+ You may want to throw in a <literal>nix-channel --update</literal> for good measure.
7969 </para>
8070 </listitem>
8171 <listitem>
@@ -83,33 +73,24 @@ nixpkgs https://nixos.org/channels/nixpkgs-unstable</screen>
8373 Install the NixOS installation tools:
8474 </para>
8575 <para>
86− You'll need <literal>nixos-generate-config</literal> and
87− <literal>nixos-install</literal> and we'll throw in some man pages and
88− <literal>nixos-enter</literal> just in case you want to chroot into your
89− NixOS partition. They are installed by default on NixOS, but you don't have
90− NixOS yet..
76+ You'll need <literal>nixos-generate-config</literal> and <literal>nixos-install</literal> and we'll throw in some man pages and <literal>nixos-enter</literal> just in case you want to chroot into your NixOS partition. They are installed by default on NixOS, but you don't have NixOS yet..
9177 </para>
9278<screen><prompt>$ </prompt>nix-env -iE "_: with import &lt;nixpkgs/nixos&gt; { configuration = {}; }; with config.system.build; [ nixos-generate-config nixos-install nixos-enter manual.manpages ]"</screen>
9379 </listitem>
9480 <listitem>
9581 <note>
9682 <para>
97− The following 5 steps are only for installing NixOS to another partition.
98− For installing NixOS in place using <literal>NIXOS_LUSTRATE</literal>,
99− skip ahead.
83+ The following 5 steps are only for installing NixOS to another partition. For installing NixOS in place using <literal>NIXOS_LUSTRATE</literal>, skip ahead.
10084 </para>
10185 </note>
10286 <para>
10387 Prepare your target partition:
10488 </para>
10589 <para>
106− At this point it is time to prepare your target partition. Please refer to
107− the partitioning, file-system creation, and mounting steps of
108− <xref linkend="sec-installation" />
90+ At this point it is time to prepare your target partition. Please refer to the partitioning, file-system creation, and mounting steps of <xref linkend="sec-installation" />
10991 </para>
11092 <para>
111− If you're about to install NixOS in place using
112− <literal>NIXOS_LUSTRATE</literal> there is nothing to do for this step.
93+ If you're about to install NixOS in place using <literal>NIXOS_LUSTRATE</literal> there is nothing to do for this step.
11394 </para>
11495 </listitem>
11596 <listitem>
@@ -118,17 +99,11 @@ nixpkgs https://nixos.org/channels/nixpkgs-unstable</screen>
11899 </para>
119100<screen><prompt>$ </prompt>sudo `which nixos-generate-config` --root /mnt</screen>
120101 <para>
121− You'll probably want to edit the configuration files. Refer to the
122− <literal>nixos-generate-config</literal> step in
123− <xref
124− linkend="sec-installation" /> for more
125− information.
102+ You'll probably want to edit the configuration files. Refer to the <literal>nixos-generate-config</literal> step in <xref
103+ linkend="sec-installation" /> for more information.
126104 </para>
127105 <para>
128− Consider setting up the NixOS bootloader to give you the ability to boot on
129− your existing Linux partition. For instance, if you're using GRUB and your
130− existing distribution is running Ubuntu, you may want to add something like
131− this to your <literal>configuration.nix</literal>:
106+ Consider setting up the NixOS bootloader to give you the ability to boot on your existing Linux partition. For instance, if you're using GRUB and your existing distribution is running Ubuntu, you may want to add something like this to your <literal>configuration.nix</literal>:
132107 </para>
133108<programlisting>
134109<xref linkend="opt-boot.loader.grub.extraEntries"/> = ''
@@ -138,14 +113,12 @@ nixpkgs https://nixos.org/channels/nixpkgs-unstable</screen>
138113 }
139114'';</programlisting>
140115 <para>
141− (You can find the appropriate UUID for your partition in
142− <literal>/dev/disk/by-uuid</literal>)
116+ (You can find the appropriate UUID for your partition in <literal>/dev/disk/by-uuid</literal>)
143117 </para>
144118 </listitem>
145119 <listitem>
146120 <para>
147− Create the <literal>nixbld</literal> group and user on your original
148− distribution:
121+ Create the <literal>nixbld</literal> group and user on your original distribution:
149122 </para>
150123<screen>
151124<prompt>$ </prompt>sudo groupadd -g 30000 nixbld
@@ -157,14 +130,12 @@ nixpkgs https://nixos.org/channels/nixpkgs-unstable</screen>
157130 </para>
158131 <warning>
159132 <para>
160− Once you complete this step, you might no longer be able to boot on
161− existing systems without the help of a rescue USB drive or similar.
133+ Once you complete this step, you might no longer be able to boot on existing systems without the help of a rescue USB drive or similar.
162134 </para>
163135 </warning>
164136<screen><prompt>$ </prompt>sudo PATH="$PATH" NIX_PATH="$NIX_PATH" `which nixos-install` --root /mnt</screen>
165137 <para>
166− Again, please refer to the <literal>nixos-install</literal> step in
167− <xref linkend="sec-installation" /> for more information.
138+ Again, please refer to the <literal>nixos-install</literal> step in <xref linkend="sec-installation" /> for more information.
168139 </para>
169140 <para>
170141 That should be it for installation to another partition!
@@ -178,16 +149,13 @@ nixpkgs https://nixos.org/channels/nixpkgs-unstable</screen>
178149<prompt>$ </prompt>sudo userdel nixbld
179150<prompt>$ </prompt>sudo groupdel nixbld</screen>
180151 <para>
181− If you do not wish to keep the Nix package manager installed either, run
182− something like <literal>sudo rm -rv ~/.nix-* /nix</literal> and remove the
183− line that the Nix installer added to your <literal>~/.profile</literal>.
152+ If you do not wish to keep the Nix package manager installed either, run something like <literal>sudo rm -rv ~/.nix-* /nix</literal> and remove the line that the Nix installer added to your <literal>~/.profile</literal>.
184153 </para>
185154 </listitem>
186155 <listitem>
187156 <note>
188157 <para>
189− The following steps are only for installing NixOS in place using
190− <literal>NIXOS_LUSTRATE</literal>:
158+ The following steps are only for installing NixOS in place using <literal>NIXOS_LUSTRATE</literal>:
191159 </para>
192160 </note>
193161 <para>
@@ -195,20 +163,11 @@ nixpkgs https://nixos.org/channels/nixpkgs-unstable</screen>
195163 </para>
196164<screen><prompt>$ </prompt>sudo `which nixos-generate-config` --root /</screen>
197165 <para>
198− Note that this will place the generated configuration files in
199− <literal>/etc/nixos</literal>. You'll probably want to edit the
200− configuration files. Refer to the <literal>nixos-generate-config</literal>
201− step in <xref
202− linkend="sec-installation" /> for more
203− information.
166+ Note that this will place the generated configuration files in <literal>/etc/nixos</literal>. You'll probably want to edit the configuration files. Refer to the <literal>nixos-generate-config</literal> step in <xref
167+ linkend="sec-installation" /> for more information.
204168 </para>
205169 <para>
206− You'll likely want to set a root password for your first boot using the
207− configuration files because you won't have a chance to enter a password
208− until after you reboot. You can initalize the root password to an empty one
209− with this line: (and of course don't forget to set one once you've rebooted
210− or to lock the account with <literal>sudo passwd -l root</literal> if you
211− use <literal>sudo</literal>)
170+ You'll likely want to set a root password for your first boot using the configuration files because you won't have a chance to enter a password until after you reboot. You can initalize the root password to an empty one with this line: (and of course don't forget to set one once you've rebooted or to lock the account with <literal>sudo passwd -l root</literal> if you use <literal>sudo</literal>)
212171 </para>
213172<programlisting>
214173<link linkend="opt-users.users._name__.initialHashedPassword">users.users.root.initialHashedPassword</link> = "";
@@ -216,34 +175,25 @@ nixpkgs https://nixos.org/channels/nixpkgs-unstable</screen>
216175 </listitem>
217176 <listitem>
218177 <para>
219− Build the NixOS closure and install it in the <literal>system</literal>
220− profile:
178+ Build the NixOS closure and install it in the <literal>system</literal> profile:
221179 </para>
222180<screen><prompt>$ </prompt>nix-env -p /nix/var/nix/profiles/system -f '&lt;nixpkgs/nixos&gt;' -I nixos-config=/etc/nixos/configuration.nix -iA system</screen>
223181 </listitem>
224182 <listitem>
225183 <para>
226− Change ownership of the <literal>/nix</literal> tree to root (since your
227− Nix install was probably single user):
184+ Change ownership of the <literal>/nix</literal> tree to root (since your Nix install was probably single user):
228185 </para>
229186<screen><prompt>$ </prompt>sudo chown -R 0.0 /nix</screen>
230187 </listitem>
231188 <listitem>
232189 <para>
233− Set up the <literal>/etc/NIXOS</literal> and
234− <literal>/etc/NIXOS_LUSTRATE</literal> files:
190+ Set up the <literal>/etc/NIXOS</literal> and <literal>/etc/NIXOS_LUSTRATE</literal> files:
235191 </para>
236192 <para>
237− <literal>/etc/NIXOS</literal> officializes that this is now a NixOS
238− partition (the bootup scripts require its presence).
193+ <literal>/etc/NIXOS</literal> officializes that this is now a NixOS partition (the bootup scripts require its presence).
239194 </para>
240195 <para>
241− <literal>/etc/NIXOS_LUSTRATE</literal> tells the NixOS bootup scripts to
242− move <emphasis>everything</emphasis> that's in the root partition to
243− <literal>/old-root</literal>. This will move your existing distribution out
244− of the way in the very early stages of the NixOS bootup. There are
245− exceptions (we do need to keep NixOS there after all), so the NixOS
246− lustrate process will not touch:
196+ <literal>/etc/NIXOS_LUSTRATE</literal> tells the NixOS bootup scripts to move <emphasis>everything</emphasis> that's in the root partition to <literal>/old-root</literal>. This will move your existing distribution out of the way in the very early stages of the NixOS bootup. There are exceptions (we do need to keep NixOS there after all), so the NixOS lustrate process will not touch:
247197 </para>
248198 <itemizedlist>
249199 <listitem>
@@ -258,26 +208,19 @@ nixpkgs https://nixos.org/channels/nixpkgs-unstable</screen>
258208 </listitem>
259209 <listitem>
260210 <para>
261− Any file or directory listed in <literal>/etc/NIXOS_LUSTRATE</literal>
262− (one per line)
211+ Any file or directory listed in <literal>/etc/NIXOS_LUSTRATE</literal> (one per line)
263212 </para>
264213 </listitem>
265214 </itemizedlist>
266215 <note>
267216 <para>
268− Support for <literal>NIXOS_LUSTRATE</literal> was added in NixOS 16.09.
269− The act of "lustrating" refers to the wiping of the existing distribution.
270− Creating <literal>/etc/NIXOS_LUSTRATE</literal> can also be used on NixOS
271− to remove all mutable files from your root partition (anything that's not
272− in <literal>/nix</literal> or <literal>/boot</literal> gets "lustrated" on
273− the next boot.
217+ Support for <literal>NIXOS_LUSTRATE</literal> was added in NixOS 16.09. The act of "lustrating" refers to the wiping of the existing distribution. Creating <literal>/etc/NIXOS_LUSTRATE</literal> can also be used on NixOS to remove all mutable files from your root partition (anything that's not in <literal>/nix</literal> or <literal>/boot</literal> gets "lustrated" on the next boot.
274218 </para>
275219 <para>
276220 lustrate /ˈlʌstreɪt/ verb.
277221 </para>
278222 <para>
279− purify by expiatory sacrifice, ceremonial washing, or some other ritual
280− action.
223+ purify by expiatory sacrifice, ceremonial washing, or some other ritual action.
281224 </para>
282225 </note>
283226 <para>
@@ -288,8 +231,7 @@ nixpkgs https://nixos.org/channels/nixpkgs-unstable</screen>
288231<prompt>$ </prompt>sudo touch /etc/NIXOS_LUSTRATE
289232</screen>
290233 <para>
291− Let's also make sure the NixOS configuration files are kept once we reboot
292− on NixOS:
234+ Let's also make sure the NixOS configuration files are kept once we reboot on NixOS:
293235 </para>
294236<screen>
295237<prompt>$ </prompt>echo etc/nixos | sudo tee -a /etc/NIXOS_LUSTRATE
@@ -297,18 +239,11 @@ nixpkgs https://nixos.org/channels/nixpkgs-unstable</screen>
297239 </listitem>
298240 <listitem>
299241 <para>
300− Finally, move the <literal>/boot</literal> directory of your current
301− distribution out of the way (the lustrate process will take care of the
302− rest once you reboot, but this one must be moved out now because NixOS
303− needs to install its own boot files:
242+ Finally, move the <literal>/boot</literal> directory of your current distribution out of the way (the lustrate process will take care of the rest once you reboot, but this one must be moved out now because NixOS needs to install its own boot files:
304243 </para>
305244 <warning>
306245 <para>
307− Once you complete this step, your current distribution will no longer be
308− bootable! If you didn't get all the NixOS configuration right, especially
309− those settings pertaining to boot loading and root partition, NixOS may
310− not be bootable either. Have a USB rescue device ready in case this
311− happens.
246+ Once you complete this step, your current distribution will no longer be bootable! If you didn't get all the NixOS configuration right, especially those settings pertaining to boot loading and root partition, NixOS may not be bootable either. Have a USB rescue device ready in case this happens.
312247 </para>
313248 </warning>
314249<screen>
@@ -321,8 +256,7 @@ sudo /nix/var/nix/profiles/system/bin/switch-to-configuration boot
321256 </listitem>
322257 <listitem>
323258 <para>
324− If for some reason you want to revert to the old distribution, you'll need
325− to boot on a USB rescue disk and do something along these lines:
259+ If for some reason you want to revert to the old distribution, you'll need to boot on a USB rescue disk and do something along these lines:
326260 </para>
327261<screen>
328262# mkdir root
@@ -337,20 +271,14 @@ sudo /nix/var/nix/profiles/system/bin/switch-to-configuration boot
337271 This may work as is or you might also need to reinstall the boot loader
338272 </para>
339273 <para>
340− And of course, if you're happy with NixOS and no longer need the old
341− distribution:
274+ And of course, if you're happy with NixOS and no longer need the old distribution:
342275 </para>
343276<screen>sudo rm -rf /old-root</screen>
344277 </listitem>
345278 <listitem>
346279 <para>
347− It's also worth noting that this whole process can be automated. This is
348− especially useful for Cloud VMs, where provider do not provide NixOS. For
349− instance,
350− <link
351− xlink:href="https://github.com/elitak/nixos-infect">nixos-infect</link>
352− uses the lustrate process to convert Digital Ocean droplets to NixOS from
353− other distributions automatically.
280+ It's also worth noting that this whole process can be automated. This is especially useful for Cloud VMs, where provider do not provide NixOS. For instance, <link
281+ xlink:href="https://github.com/elitak/nixos-infect">nixos-infect</link> uses the lustrate process to convert Digital Ocean droplets to NixOS from other distributions automatically.
354282 </para>
355283 </listitem>
356284 </orderedlist>
nixos/doc/manual/installation/installing-pxe.xml+5−20
@@ -10,9 +10,7 @@
1010 </para>
1111
1212 <para>
13− These instructions assume that you have an existing PXE or iPXE
14− infrastructure and simply want to add the NixOS installer as another option.
15− To build the necessary files from a recent version of nixpkgs, you can run:
13+ These instructions assume that you have an existing PXE or iPXE infrastructure and simply want to add the NixOS installer as another option. To build the necessary files from a recent version of nixpkgs, you can run:
1614 </para>
1715
1816<programlisting>
@@ -20,31 +18,18 @@ nix-build -A netboot nixos/release.nix
2018</programlisting>
2119
2220 <para>
23− This will create a <literal>result</literal> directory containing: *
24− <literal>bzImage</literal> – the Linux kernel * <literal>initrd</literal>
25− – the initrd file * <literal>netboot.ipxe</literal> – an example ipxe
26− script demonstrating the appropriate kernel command line arguments for this
27− image
21+ This will create a <literal>result</literal> directory containing: * <literal>bzImage</literal> – the Linux kernel * <literal>initrd</literal> – the initrd file * <literal>netboot.ipxe</literal> – an example ipxe script demonstrating the appropriate kernel command line arguments for this image
2822 </para>
2923
3024 <para>
31− If you’re using plain PXE, configure your boot loader to use the
32− <literal>bzImage</literal> and <literal>initrd</literal> files and have it
33− provide the same kernel command line arguments found in
34− <literal>netboot.ipxe</literal>.
25+ If you’re using plain PXE, configure your boot loader to use the <literal>bzImage</literal> and <literal>initrd</literal> files and have it provide the same kernel command line arguments found in <literal>netboot.ipxe</literal>.
3526 </para>
3627
3728 <para>
38− If you’re using iPXE, depending on how your HTTP/FTP/etc. server is
39− configured you may be able to use <literal>netboot.ipxe</literal> unmodified,
40− or you may need to update the paths to the files to match your server’s
41− directory layout
29+ If you’re using iPXE, depending on how your HTTP/FTP/etc. server is configured you may be able to use <literal>netboot.ipxe</literal> unmodified, or you may need to update the paths to the files to match your server’s directory layout
4230 </para>
4331
4432 <para>
45− In the future we may begin making these files available as build products
46− from hydra at which point we will update this documentation with instructions
47− on how to obtain them either for placing on a dedicated TFTP server or to
48− boot them directly over the internet.
33+ In the future we may begin making these files available as build products from hydra at which point we will update this documentation with instructions on how to obtain them either for placing on a dedicated TFTP server or to boot them directly over the internet.
4934 </para>
5035</section>
nixos/doc/manual/installation/installing-usb.xml+3−12
@@ -6,12 +6,7 @@
66 <title>Booting from a USB Drive</title>
77
88 <para>
9− For systems without CD drive, the NixOS live CD can be booted from a USB
10− stick. You can use the <command>dd</command> utility to write the image:
11− <command>dd if=<replaceable>path-to-image</replaceable>
12− of=<replaceable>/dev/sdX</replaceable></command>. Be careful about specifying
13− the correct drive; you can use the <command>lsblk</command> command to get a
14− list of block devices.
9+ For systems without CD drive, the NixOS live CD can be booted from a USB stick. You can use the <command>dd</command> utility to write the image: <command>dd if=<replaceable>path-to-image</replaceable> of=<replaceable>/dev/sdX</replaceable></command>. Be careful about specifying the correct drive; you can use the <command>lsblk</command> command to get a list of block devices.
1510 <note>
1611 <title>On macOS</title>
1712 <para>
@@ -25,16 +20,12 @@
2520Unmount of all volumes on diskN was successful
2621<prompt>$ </prompt>sudo dd if=nix.iso of=/dev/rdiskN
2722</screen>
28− Using the 'raw' <command>rdiskN</command> device instead of
29− <command>diskN</command> completes in minutes instead of hours. After
30− <command>dd</command> completes, a GUI dialog "The disk you inserted was
31− not readable by this computer" will pop up, which can be ignored.
23+ Using the 'raw' <command>rdiskN</command> device instead of <command>diskN</command> completes in minutes instead of hours. After <command>dd</command> completes, a GUI dialog "The disk you inserted was not readable by this computer" will pop up, which can be ignored.
3224 </para>
3325 </note>
3426 </para>
3527
3628 <para>
37− The <command>dd</command> utility will write the image verbatim to the drive,
38− making it the recommended option for both UEFI and non-UEFI installations.
29+ The <command>dd</command> utility will write the image verbatim to the drive, making it the recommended option for both UEFI and non-UEFI installations.
3930 </para>
4031</section>
nixos/doc/manual/installation/installing-virtualbox-guest.xml+7−22
@@ -6,13 +6,8 @@
66 <title>Installing in a VirtualBox guest</title>
77
88 <para>
9− Installing NixOS into a VirtualBox guest is convenient for users who want to
10− try NixOS without installing it on bare metal. If you want to use a pre-made
11− VirtualBox appliance, it is available at
12− <link
13− xlink:href="https://nixos.org/nixos/download.html">the downloads
14− page</link>. If you want to set up a VirtualBox guest manually, follow these
15− instructions:
9+ Installing NixOS into a VirtualBox guest is convenient for users who want to try NixOS without installing it on bare metal. If you want to use a pre-made VirtualBox appliance, it is available at <link
10+ xlink:href="https://nixos.org/nixos/download.html">the downloads page</link>. If you want to set up a VirtualBox guest manually, follow these instructions:
1611 </para>
1712
1813 <orderedlist>
@@ -43,21 +38,18 @@
4338 </listitem>
4439 <listitem>
4540 <para>
46− Click on Settings / System / Acceleration and enable "VT-x/AMD-V"
47− acceleration
41+ Click on Settings / System / Acceleration and enable "VT-x/AMD-V" acceleration
4842 </para>
4943 </listitem>
5044 <listitem>
5145 <para>
52− Save the settings, start the virtual machine, and continue installation
53− like normal
46+ Save the settings, start the virtual machine, and continue installation like normal
5447 </para>
5548 </listitem>
5649 </orderedlist>
5750
5851 <para>
59− There are a few modifications you should make in configuration.nix. Enable
60− booting:
52+ There are a few modifications you should make in configuration.nix. Enable booting:
6153 </para>
6254
6355<programlisting>
@@ -65,8 +57,7 @@
6557</programlisting>
6658
6759 <para>
68− Also remove the fsck that runs at startup. It will always fail to run,
69− stopping your boot until you press <literal>*</literal>.
60+ Also remove the fsck that runs at startup. It will always fail to run, stopping your boot until you press <literal>*</literal>.
7061 </para>
7162
7263<programlisting>
@@ -74,13 +65,7 @@
7465</programlisting>
7566
7667 <para>
77− Shared folders can be given a name and a path in the host system in the
78− VirtualBox settings (Machine / Settings / Shared Folders, then click on the
79− "Add" icon). Add the following to the
80− <literal>/etc/nixos/configuration.nix</literal> to auto-mount them. If you do
81− not add <literal>"nofail"</literal>, the system will no boot properly. The
82− same goes for disabling <literal>rngd</literal> which is normally used to get
83− randomness but this does not work in virtual machines.
68+ Shared folders can be given a name and a path in the host system in the VirtualBox settings (Machine / Settings / Shared Folders, then click on the "Add" icon). Add the following to the <literal>/etc/nixos/configuration.nix</literal> to auto-mount them. If you do not add <literal>"nofail"</literal>, the system will no boot properly. The same goes for disabling <literal>rngd</literal> which is normally used to get randomness but this does not work in virtual machines.
8469 </para>
8570
8671<programlisting>
nixos/doc/manual/installation/installing.xml+53−177
@@ -8,67 +8,46 @@
88 <title>Booting the system</title>
99
1010 <para>
11− NixOS can be installed on BIOS or UEFI systems. The procedure for a UEFI
12− installation is by and large the same as a BIOS installation. The
13− differences are mentioned in the steps that follow.
11+ NixOS can be installed on BIOS or UEFI systems. The procedure for a UEFI installation is by and large the same as a BIOS installation. The differences are mentioned in the steps that follow.
1412 </para>
1513
1614 <para>
17− The installation media can be burned to a CD, or now more commonly, "burned"
18− to a USB drive (see <xref linkend="sec-booting-from-usb"/>).
15+ The installation media can be burned to a CD, or now more commonly, "burned" to a USB drive (see <xref linkend="sec-booting-from-usb"/>).
1916 </para>
2017
2118 <para>
22− The installation media contains a basic NixOS installation. When it’s
23− finished booting, it should have detected most of your hardware.
19+ The installation media contains a basic NixOS installation. When it’s finished booting, it should have detected most of your hardware.
2420 </para>
2521
2622 <para>
27− The NixOS manual is available on virtual console 8 (press Alt+F8 to access)
28− or by running <command>nixos-help</command>.
23+ The NixOS manual is available on virtual console 8 (press Alt+F8 to access) or by running <command>nixos-help</command>.
2924 </para>
3025
3126 <para>
32− You are logged-in automatically as <literal>nixos</literal>.
33− The <literal>nixos</literal> user account has an empty password so you
34− can use <command>sudo</command> without a password.
27+ You are logged-in automatically as <literal>nixos</literal>. The <literal>nixos</literal> user account has an empty password so you can use <command>sudo</command> without a password.
3528 </para>
3629
3730 <para>
38− If you downloaded the graphical ISO image, you can run <command>systemctl
39− start display-manager</command> to start the desktop environment. If you want to continue on the
40− terminal, you can use <command>loadkeys</command> to switch to your
41− preferred keyboard layout. (We even provide neo2 via <command>loadkeys de
42− neo</command>!)
31+ If you downloaded the graphical ISO image, you can run <command>systemctl start display-manager</command> to start the desktop environment. If you want to continue on the terminal, you can use <command>loadkeys</command> to switch to your preferred keyboard layout. (We even provide neo2 via <command>loadkeys de neo</command>!)
4332 </para>
4433
4534 <section xml:id="sec-installation-booting-networking">
4635 <title>Networking in the installer</title>
4736
4837 <para>
49− The boot process should have brought up networking (check <command>ip
50− a</command>). Networking is necessary for the installer, since it will
51− download lots of stuff (such as source tarballs or Nixpkgs channel
52− binaries). It’s best if you have a DHCP server on your network. Otherwise
53− configure networking manually using <command>ifconfig</command>.
38+ The boot process should have brought up networking (check <command>ip a</command>). Networking is necessary for the installer, since it will download lots of stuff (such as source tarballs or Nixpkgs channel binaries). It’s best if you have a DHCP server on your network. Otherwise configure networking manually using <command>ifconfig</command>.
5439 </para>
5540
5641 <para>
57− To manually configure the network on the graphical installer, first disable
58− network-manager with <command>systemctl stop NetworkManager</command>.
42+ To manually configure the network on the graphical installer, first disable network-manager with <command>systemctl stop NetworkManager</command>.
5943 </para>
6044
6145 <para>
62− To manually configure the wifi on the minimal installer, run
63− <command>wpa_supplicant -B -i interface -c &lt;(wpa_passphrase 'SSID'
64− 'key')</command>.
46+ To manually configure the wifi on the minimal installer, run <command>wpa_supplicant -B -i interface -c &lt;(wpa_passphrase 'SSID' 'key')</command>.
6547 </para>
6648
6749 <para>
68− If you would like to continue the installation from a different machine you
69− need to activate the SSH daemon via <command>systemctl start
70− sshd</command>. You then must set a password for either <literal>root</literal> or
71− <literal>nixos</literal> with <command>passwd></command> to be able to login.
50+ If you would like to continue the installation from a different machine you need to activate the SSH daemon via <command>systemctl start sshd</command>. You then must set a password for either <literal>root</literal> or <literal>nixos</literal> with <command>passwd></command> to be able to login.
7251 </para>
7352 </section>
7453 </section>
@@ -76,32 +55,25 @@
7655 <title>Partitioning and formatting</title>
7756
7857 <para>
79− The NixOS installer doesn’t do any partitioning or formatting, so you need
80− to do that yourself.
58+ The NixOS installer doesn’t do any partitioning or formatting, so you need to do that yourself.
8159 </para>
8260
8361 <para>
84− The NixOS installer ships with multiple partitioning tools. The examples
85− below use <command>parted</command>, but also provides
86− <command>fdisk</command>, <command>gdisk</command>,
87− <command>cfdisk</command>, and <command>cgdisk</command>.
62+ The NixOS installer ships with multiple partitioning tools. The examples below use <command>parted</command>, but also provides <command>fdisk</command>, <command>gdisk</command>, <command>cfdisk</command>, and <command>cgdisk</command>.
8863 </para>
8964
9065 <para>
91− The recommended partition scheme differs depending if the computer uses
92− <emphasis>Legacy Boot</emphasis> or <emphasis>UEFI</emphasis>.
66+ The recommended partition scheme differs depending if the computer uses <emphasis>Legacy Boot</emphasis> or <emphasis>UEFI</emphasis>.
9367 </para>
9468
9569 <section xml:id="sec-installation-partitioning-UEFI">
9670 <title>UEFI (GPT)</title>
9771
9872 <para>
99− Here's an example partition scheme for UEFI, using
100− <filename>/dev/sda</filename> as the device.
73+ Here's an example partition scheme for UEFI, using <filename>/dev/sda</filename> as the device.
10174 <note>
10275 <para>
103− You can safely ignore <command>parted</command>'s informational message
104− about needing to update /etc/fstab.
76+ You can safely ignore <command>parted</command>'s informational message about needing to update /etc/fstab.
10577 </para>
10678 </note>
10779 </para>
@@ -116,31 +88,24 @@
11688 </listitem>
11789 <listitem>
11890 <para>
119− Add the <emphasis>root</emphasis> partition. This will fill the disk
120− except for the end part, where the swap will live, and the space left in
121− front (512MiB) which will be used by the boot partition.
91+ Add the <emphasis>root</emphasis> partition. This will fill the disk except for the end part, where the swap will live, and the space left in front (512MiB) which will be used by the boot partition.
12292<screen language="commands"><prompt># </prompt>parted /dev/sda -- mkpart primary 512MiB -8GiB</screen>
12393 </para>
12494 </listitem>
12595 <listitem>
12696 <para>
127− Next, add a <emphasis>swap</emphasis> partition. The size required will
128− vary according to needs, here a 8GiB one is created.
97+ Next, add a <emphasis>swap</emphasis> partition. The size required will vary according to needs, here a 8GiB one is created.
12998<screen language="commands"><prompt># </prompt>parted /dev/sda -- mkpart primary linux-swap -8GiB 100%</screen>
13099 <note>
131100 <para>
132− The swap partition size rules are no different than for other Linux
133− distributions.
101+ The swap partition size rules are no different than for other Linux distributions.
134102 </para>
135103 </note>
136104 </para>
137105 </listitem>
138106 <listitem>
139107 <para>
140− Finally, the <emphasis>boot</emphasis> partition. NixOS by default uses
141− the ESP (EFI system partition) as its <emphasis>/boot</emphasis>
142− partition. It uses the initially reserved 512MiB at the start of the
143− disk.
108+ Finally, the <emphasis>boot</emphasis> partition. NixOS by default uses the ESP (EFI system partition) as its <emphasis>/boot</emphasis> partition. It uses the initially reserved 512MiB at the start of the disk.
144109<screen language="commands"><prompt># </prompt>parted /dev/sda -- mkpart ESP fat32 1MiB 512MiB
145110<prompt># </prompt>parted /dev/sda -- set 3 boot on</screen>
146111 </para>
@@ -149,8 +114,7 @@
149114 </para>
150115
151116 <para>
152− Once complete, you can follow with
153− <xref linkend="sec-installation-partitioning-formatting"/>.
117+ Once complete, you can follow with <xref linkend="sec-installation-partitioning-formatting"/>.
154118 </para>
155119 </section>
156120
@@ -158,12 +122,10 @@
158122 <title>Legacy Boot (MBR)</title>
159123
160124 <para>
161− Here's an example partition scheme for Legacy Boot, using
162− <filename>/dev/sda</filename> as the device.
125+ Here's an example partition scheme for Legacy Boot, using <filename>/dev/sda</filename> as the device.
163126 <note>
164127 <para>
165− You can safely ignore <command>parted</command>'s informational message
166− about needing to update /etc/fstab.
128+ You can safely ignore <command>parted</command>'s informational message about needing to update /etc/fstab.
167129 </para>
168130 </note>
169131 </para>
@@ -178,20 +140,17 @@
178140 </listitem>
179141 <listitem>
180142 <para>
181− Add the <emphasis>root</emphasis> partition. This will fill the the disk
182− except for the end part, where the swap will live.
143+ Add the <emphasis>root</emphasis> partition. This will fill the the disk except for the end part, where the swap will live.
183144<screen language="commands"><prompt># </prompt>parted /dev/sda -- mkpart primary 1MiB -8GiB</screen>
184145 </para>
185146 </listitem>
186147 <listitem>
187148 <para>
188− Finally, add a <emphasis>swap</emphasis> partition. The size required
189− will vary according to needs, here a 8GiB one is created.
149+ Finally, add a <emphasis>swap</emphasis> partition. The size required will vary according to needs, here a 8GiB one is created.
190150<screen language="commands"><prompt># </prompt>parted /dev/sda -- mkpart primary linux-swap -8GiB 100%</screen>
191151 <note>
192152 <para>
193− The swap partition size rules are no different than for other Linux
194− distributions.
153+ The swap partition size rules are no different than for other Linux distributions.
195154 </para>
196155 </note>
197156 </para>
@@ -200,8 +159,7 @@
200159 </para>
201160
202161 <para>
203− Once complete, you can follow with
204− <xref linkend="sec-installation-partitioning-formatting"/>.
162+ Once complete, you can follow with <xref linkend="sec-installation-partitioning-formatting"/>.
205163 </para>
206164 </section>
207165
@@ -213,20 +171,14 @@
213171 <itemizedlist>
214172 <listitem>
215173 <para>
216− For initialising Ext4 partitions: <command>mkfs.ext4</command>. It is
217− recommended that you assign a unique symbolic label to the file system
218− using the option <option>-L <replaceable>label</replaceable></option>,
219− since this makes the file system configuration independent from device
220− changes. For example:
174+ For initialising Ext4 partitions: <command>mkfs.ext4</command>. It is recommended that you assign a unique symbolic label to the file system using the option <option>-L <replaceable>label</replaceable></option>, since this makes the file system configuration independent from device changes. For example:
221175<screen>
222176<prompt># </prompt>mkfs.ext4 -L nixos /dev/sda1</screen>
223177 </para>
224178 </listitem>
225179 <listitem>
226180 <para>
227− For creating swap partitions: <command>mkswap</command>. Again it’s
228− recommended to assign a label to the swap partition: <option>-L
229− <replaceable>label</replaceable></option>. For example:
181+ For creating swap partitions: <command>mkswap</command>. Again it’s recommended to assign a label to the swap partition: <option>-L <replaceable>label</replaceable></option>. For example:
230182<screen>
231183<prompt># </prompt>mkswap -L swap /dev/sda2</screen>
232184 </para>
@@ -239,9 +191,7 @@
239191 </term>
240192 <listitem>
241193 <para>
242− For creating boot partitions: <command>mkfs.fat</command>. Again
243− it’s recommended to assign a label to the boot partition:
244− <option>-n <replaceable>label</replaceable></option>. For example:
194+ For creating boot partitions: <command>mkfs.fat</command>. Again it’s recommended to assign a label to the boot partition: <option>-n <replaceable>label</replaceable></option>. For example:
245195<screen>
246196<prompt># </prompt>mkfs.fat -F 32 -n boot /dev/sda3</screen>
247197 </para>
@@ -251,9 +201,7 @@
251201 </listitem>
252202 <listitem>
253203 <para>
254− For creating LVM volumes, the LVM commands, e.g.,
255− <command>pvcreate</command>, <command>vgcreate</command>, and
256− <command>lvcreate</command>.
204+ For creating LVM volumes, the LVM commands, e.g., <command>pvcreate</command>, <command>vgcreate</command>, and <command>lvcreate</command>.
257205 </para>
258206 </listitem>
259207 <listitem>
@@ -271,8 +219,7 @@
271219 <orderedlist>
272220 <listitem>
273221 <para>
274− Mount the target file system on which NixOS should be installed on
275− <filename>/mnt</filename>, e.g.
222+ Mount the target file system on which NixOS should be installed on <filename>/mnt</filename>, e.g.
276223<screen>
277224<prompt># </prompt>mount /dev/disk/by-label/nixos /mnt
278225</screen>
@@ -298,44 +245,26 @@
298245 </listitem>
299246 <listitem>
300247 <para>
301− If your machine has a limited amount of memory, you may want to activate
302− swap devices now (<command>swapon
303− <replaceable>device</replaceable></command>). The installer (or rather,
304− the build actions that it may spawn) may need quite a bit of RAM,
305− depending on your configuration.
248+ If your machine has a limited amount of memory, you may want to activate swap devices now (<command>swapon <replaceable>device</replaceable></command>). The installer (or rather, the build actions that it may spawn) may need quite a bit of RAM, depending on your configuration.
306249<screen>
307250<prompt># </prompt>swapon /dev/sda2</screen>
308251 </para>
309252 </listitem>
310253 <listitem>
311254 <para>
312− You now need to create a file
313− <filename>/mnt/etc/nixos/configuration.nix</filename> that specifies the
314− intended configuration of the system. This is because NixOS has a
315− <emphasis>declarative</emphasis> configuration model: you create or edit a
316− description of the desired configuration of your system, and then NixOS
317− takes care of making it happen. The syntax of the NixOS configuration file
318− is described in <xref linkend="sec-configuration-syntax"/>, while a list
319− of available configuration options appears in
320− <xref
321− linkend="ch-options"/>. A minimal example is shown in
322− <xref
255+ You now need to create a file <filename>/mnt/etc/nixos/configuration.nix</filename> that specifies the intended configuration of the system. This is because NixOS has a <emphasis>declarative</emphasis> configuration model: you create or edit a description of the desired configuration of your system, and then NixOS takes care of making it happen. The syntax of the NixOS configuration file is described in <xref linkend="sec-configuration-syntax"/>, while a list of available configuration options appears in <xref
256+ linkend="ch-options"/>. A minimal example is shown in <xref
323257 linkend="ex-config"/>.
324258 </para>
325259 <para>
326− The command <command>nixos-generate-config</command> can generate an
327− initial configuration file for you:
260+ The command <command>nixos-generate-config</command> can generate an initial configuration file for you:
328261<screen>
329262<prompt># </prompt>nixos-generate-config --root /mnt</screen>
330− You should then edit <filename>/mnt/etc/nixos/configuration.nix</filename>
331− to suit your needs:
263+ You should then edit <filename>/mnt/etc/nixos/configuration.nix</filename> to suit your needs:
332264<screen>
333265<prompt># </prompt>nano /mnt/etc/nixos/configuration.nix
334266</screen>
335− If you’re using the graphical ISO image, other editors may be available
336− (such as <command>vim</command>). If you have network access, you can also
337− install other editors — for instance, you can install Emacs by running
338− <literal>nix-env -f '&lt;nixpkgs&gt;' -iA emacs</literal>.
267+ If you’re using the graphical ISO image, other editors may be available (such as <command>vim</command>). If you have network access, you can also install other editors — for instance, you can install Emacs by running <literal>nix-env -f '&lt;nixpkgs&gt;' -iA emacs</literal>.
339268 </para>
340269 <variablelist>
341270 <varlistentry>
@@ -344,9 +273,7 @@
344273 </term>
345274 <listitem>
346275 <para>
347− You <emphasis>must</emphasis> set the option
348− <xref linkend="opt-boot.loader.grub.device"/> to specify on which disk
349− the GRUB boot loader is to be installed. Without it, NixOS cannot boot.
276+ You <emphasis>must</emphasis> set the option <xref linkend="opt-boot.loader.grub.device"/> to specify on which disk the GRUB boot loader is to be installed. Without it, NixOS cannot boot.
350277 </para>
351278 </listitem>
352279 </varlistentry>
@@ -356,60 +283,26 @@
356283 </term>
357284 <listitem>
358285 <para>
359− You <emphasis>must</emphasis> set the option
360− <xref linkend="opt-boot.loader.systemd-boot.enable"/> to
361− <literal>true</literal>. <command>nixos-generate-config</command>
362− should do this automatically for new configurations when booted in UEFI
363− mode.
286+ You <emphasis>must</emphasis> set the option <xref linkend="opt-boot.loader.systemd-boot.enable"/> to <literal>true</literal>. <command>nixos-generate-config</command> should do this automatically for new configurations when booted in UEFI mode.
364287 </para>
365288 <para>
366− You may want to look at the options starting with
367− <option><link linkend="opt-boot.loader.efi.canTouchEfiVariables">boot.loader.efi</link></option>
368− and
369− <option><link linkend="opt-boot.loader.systemd-boot.enable">boot.loader.systemd</link></option>
370− as well.
289+ You may want to look at the options starting with <option><link linkend="opt-boot.loader.efi.canTouchEfiVariables">boot.loader.efi</link></option> and <option><link linkend="opt-boot.loader.systemd-boot.enable">boot.loader.systemd</link></option> as well.
371290 </para>
372291 </listitem>
373292 </varlistentry>
374293 </variablelist>
375294 <para>
376− If there are other operating systems running on the machine before
377− installing NixOS, the <xref linkend="opt-boot.loader.grub.useOSProber"/>
378− option can be set to <literal>true</literal> to automatically add them to
379− the grub menu.
295+ If there are other operating systems running on the machine before installing NixOS, the <xref linkend="opt-boot.loader.grub.useOSProber"/> option can be set to <literal>true</literal> to automatically add them to the grub menu.
380296 </para>
381297 <para>
382− If you need to configure networking for your machine the configuration
383− options are described in <xref linkend="sec-networking"/>.
298+ If you need to configure networking for your machine the configuration options are described in <xref linkend="sec-networking"/>.
384299 </para>
385300 <para>
386− Another critical option is <option>fileSystems</option>, specifying the
387− file systems that need to be mounted by NixOS. However, you typically
388− don’t need to set it yourself, because
389− <command>nixos-generate-config</command> sets it automatically in
390− <filename>/mnt/etc/nixos/hardware-configuration.nix</filename> from your
391− currently mounted file systems. (The configuration file
392− <filename>hardware-configuration.nix</filename> is included from
393− <filename>configuration.nix</filename> and will be overwritten by future
394− invocations of <command>nixos-generate-config</command>; thus, you
395− generally should not modify it.) Additionally, you may want to look at
396− <link xlink:href="https://github.com/NixOS/nixos-hardware">Hardware
397− configuration for known-hardware</link> at this point or after
398− installation.
399−
301+ Another critical option is <option>fileSystems</option>, specifying the file systems that need to be mounted by NixOS. However, you typically don’t need to set it yourself, because <command>nixos-generate-config</command> sets it automatically in <filename>/mnt/etc/nixos/hardware-configuration.nix</filename> from your currently mounted file systems. (The configuration file <filename>hardware-configuration.nix</filename> is included from <filename>configuration.nix</filename> and will be overwritten by future invocations of <command>nixos-generate-config</command>; thus, you generally should not modify it.) Additionally, you may want to look at <link xlink:href="https://github.com/NixOS/nixos-hardware">Hardware configuration for known-hardware</link> at this point or after installation.
400302 </para>
401303 <note>
402304 <para>
403− Depending on your hardware configuration or type of file system, you may
404− need to set the option <option>boot.initrd.kernelModules</option> to
405− include the kernel modules that are necessary for mounting the root file
406− system, otherwise the installed system will not be able to boot. (If this
407− happens, boot from the installation media again, mount the target file
408− system on <filename>/mnt</filename>, fix
409− <filename>/mnt/etc/nixos/configuration.nix</filename> and rerun
410− <filename>nixos-install</filename>.) In most cases,
411− <command>nixos-generate-config</command> will figure out the required
412− modules.
305+ Depending on your hardware configuration or type of file system, you may need to set the option <option>boot.initrd.kernelModules</option> to include the kernel modules that are necessary for mounting the root file system, otherwise the installed system will not be able to boot. (If this happens, boot from the installation media again, mount the target file system on <filename>/mnt</filename>, fix <filename>/mnt/etc/nixos/configuration.nix</filename> and rerun <filename>nixos-install</filename>.) In most cases, <command>nixos-generate-config</command> will figure out the required modules.
413306 </para>
414307 </note>
415308 </listitem>
@@ -418,24 +311,17 @@
418311 Do the installation:
419312<screen>
420313<prompt># </prompt>nixos-install</screen>
421− Cross fingers. If this fails due to a temporary problem (such as a network
422− issue while downloading binaries from the NixOS binary cache), you can
423− just re-run <command>nixos-install</command>. Otherwise, fix your
424− <filename>configuration.nix</filename> and then re-run
425− <command>nixos-install</command>.
314+ Cross fingers. If this fails due to a temporary problem (such as a network issue while downloading binaries from the NixOS binary cache), you can just re-run <command>nixos-install</command>. Otherwise, fix your <filename>configuration.nix</filename> and then re-run <command>nixos-install</command>.
426315 </para>
427316 <para>
428− As the last step, <command>nixos-install</command> will ask you to set the
429− password for the <literal>root</literal> user, e.g.
317+ As the last step, <command>nixos-install</command> will ask you to set the password for the <literal>root</literal> user, e.g.
430318<screen>
431319setting root password...
432320Enter new UNIX password: ***
433321Retype new UNIX password: ***</screen>
434322 <note>
435323 <para>
436− For unattended installations, it is possible to use
437− <command>nixos-install --no-root-passwd</command> in order to disable
438− the password prompt entirely.
324+ For unattended installations, it is possible to use <command>nixos-install --no-root-passwd</command> in order to disable the password prompt entirely.
439325 </para>
440326 </note>
441327 </para>
@@ -449,21 +335,14 @@ Retype new UNIX password: ***</screen>
449335 </listitem>
450336 <listitem>
451337 <para>
452− You should now be able to boot into the installed NixOS. The GRUB boot
453− menu shows a list of <emphasis>available configurations</emphasis>
454− (initially just one). Every time you change the NixOS configuration (see
455− <link
456− linkend="sec-changing-config">Changing Configuration</link>
457− ), a new item is added to the menu. This allows you to easily roll back to
458− a previous configuration if something goes wrong.
338+ You should now be able to boot into the installed NixOS. The GRUB boot menu shows a list of <emphasis>available configurations</emphasis> (initially just one). Every time you change the NixOS configuration (see <link
339+ linkend="sec-changing-config">Changing Configuration</link> ), a new item is added to the menu. This allows you to easily roll back to a previous configuration if something goes wrong.
459340 </para>
460341 <para>
461− You should log in and change the <literal>root</literal> password with
462− <command>passwd</command>.
342+ You should log in and change the <literal>root</literal> password with <command>passwd</command>.
463343 </para>
464344 <para>
465− You’ll probably want to create some user accounts as well, which can be
466− done with <command>useradd</command>:
345+ You’ll probably want to create some user accounts as well, which can be done with <command>useradd</command>:
467346<screen>
468347<prompt>$ </prompt>useradd -c 'Eelco Dolstra' -m eelco
469348<prompt>$ </prompt>passwd eelco</screen>
@@ -484,11 +363,8 @@ Retype new UNIX password: ***</screen>
484363 <title>Installation summary</title>
485364
486365 <para>
487− To summarise, <xref linkend="ex-install-sequence" /> shows a typical
488− sequence of commands for installing NixOS on an empty hard drive (here
489− <filename>/dev/sda</filename>). <xref linkend="ex-config"
490−/> shows a
491− corresponding configuration Nix expression.
366+ To summarise, <xref linkend="ex-install-sequence" /> shows a typical sequence of commands for installing NixOS on an empty hard drive (here <filename>/dev/sda</filename>). <xref linkend="ex-config"
367+/> shows a corresponding configuration Nix expression.
492368 </para>
493369
494370 <example xml:id="ex-partition-scheme-MBR">
nixos/doc/manual/installation/obtaining.xml+9−29
@@ -5,48 +5,28 @@
55 xml:id="sec-obtaining">
66 <title>Obtaining NixOS</title>
77 <para>
8− NixOS ISO images can be downloaded from the
9− <link
10−xlink:href="http://nixos.org/nixos/download.html">NixOS download
11− page</link>. There are a number of installation options. If you happen to
12− have an optical drive and a spare CD, burning the image to CD and booting
13− from that is probably the easiest option. Most people will need to prepare a
14− USB stick to boot from. <xref linkend="sec-booting-from-usb"/> describes the
15− preferred method to prepare a USB stick. A number of alternative methods are
16− presented in the
17− <link
18−xlink:href="https://nixos.wiki/wiki/NixOS_Installation_Guide#Making_the_installation_media">NixOS
19− Wiki</link>.
8+ NixOS ISO images can be downloaded from the <link
9+xlink:href="http://nixos.org/nixos/download.html">NixOS download page</link>. There are a number of installation options. If you happen to have an optical drive and a spare CD, burning the image to CD and booting from that is probably the easiest option. Most people will need to prepare a USB stick to boot from. <xref linkend="sec-booting-from-usb"/> describes the preferred method to prepare a USB stick. A number of alternative methods are presented in the <link
10+xlink:href="https://nixos.wiki/wiki/NixOS_Installation_Guide#Making_the_installation_media">NixOS Wiki</link>.
2011 </para>
2112 <para>
22− As an alternative to installing NixOS yourself, you can get a running NixOS
23− system through several other means:
13+ As an alternative to installing NixOS yourself, you can get a running NixOS system through several other means:
2414 <itemizedlist>
2515 <listitem>
2616 <para>
27− Using virtual appliances in Open Virtualization Format (OVF) that can be
28− imported into VirtualBox. These are available from the
29− <link xlink:href="http://nixos.org/nixos/download.html">NixOS download
30− page</link>.
17+ Using virtual appliances in Open Virtualization Format (OVF) that can be imported into VirtualBox. These are available from the <link xlink:href="http://nixos.org/nixos/download.html">NixOS download page</link>.
3118 </para>
3219 </listitem>
3320 <listitem>
3421 <para>
35− Using AMIs for Amazon’s EC2. To find one for your region and instance
36− type, please refer to the
37− <link
38− xlink:href="https://github.com/NixOS/nixpkgs/blob/master/nixos/modules/virtualisation/ec2-amis.nix">list
39− of most recent AMIs</link>.
22+ Using AMIs for Amazon’s EC2. To find one for your region and instance type, please refer to the <link
23+ xlink:href="https://github.com/NixOS/nixpkgs/blob/master/nixos/modules/virtualisation/ec2-amis.nix">list of most recent AMIs</link>.
4024 </para>
4125 </listitem>
4226 <listitem>
4327 <para>
44− Using NixOps, the NixOS-based cloud deployment tool, which allows you to
45− provision VirtualBox and EC2 NixOS instances from declarative
46− specifications. Check out the
47− <link
48− xlink:href="https://nixos.org/nixops">NixOps homepage</link> for
49− details.
28+ Using NixOps, the NixOS-based cloud deployment tool, which allows you to provision VirtualBox and EC2 NixOS instances from declarative specifications. Check out the <link
29+ xlink:href="https://nixos.org/nixops">NixOps homepage</link> for details.
5030 </para>
5131 </listitem>
5232 </itemizedlist>
nixos/doc/manual/installation/upgrading.xml+17−65
@@ -4,68 +4,33 @@
44 xml:id="sec-upgrading">
55 <title>Upgrading NixOS</title>
66 <para>
7− The best way to keep your NixOS installation up to date is to use one of the
8− NixOS <emphasis>channels</emphasis>. A channel is a Nix mechanism for
9− distributing Nix expressions and associated binaries. The NixOS channels are
10− updated automatically from NixOS’s Git repository after certain tests have
11− passed and all packages have been built. These channels are:
7+ The best way to keep your NixOS installation up to date is to use one of the NixOS <emphasis>channels</emphasis>. A channel is a Nix mechanism for distributing Nix expressions and associated binaries. The NixOS channels are updated automatically from NixOS’s Git repository after certain tests have passed and all packages have been built. These channels are:
128 <itemizedlist>
139 <listitem>
1410 <para>
15− <emphasis>Stable channels</emphasis>, such as
16− <literal
17− xlink:href="https://nixos.org/channels/nixos-19.03">nixos-19.03</literal>.
18− These only get conservative bug fixes and package upgrades. For instance,
19− a channel update may cause the Linux kernel on your system to be upgraded
20− from 4.19.34 to 4.19.38 (a minor bug fix), but not from
21− 4.19.<replaceable>x</replaceable> to 4.20.<replaceable>x</replaceable> (a
22− major change that has the potential to break things). Stable channels are
23− generally maintained until the next stable branch is created.
11+ <emphasis>Stable channels</emphasis>, such as <literal
12+ xlink:href="https://nixos.org/channels/nixos-19.03">nixos-19.03</literal>. These only get conservative bug fixes and package upgrades. For instance, a channel update may cause the Linux kernel on your system to be upgraded from 4.19.34 to 4.19.38 (a minor bug fix), but not from 4.19.<replaceable>x</replaceable> to 4.20.<replaceable>x</replaceable> (a major change that has the potential to break things). Stable channels are generally maintained until the next stable branch is created.
2413 </para>
2514 <para></para>
2615 </listitem>
2716 <listitem>
2817 <para>
29− The <emphasis>unstable channel</emphasis>,
30− <literal
31− xlink:href="https://nixos.org/channels/nixos-unstable">nixos-unstable</literal>.
32− This corresponds to NixOS’s main development branch, and may thus see
33− radical changes between channel updates. It’s not recommended for
34− production systems.
18+ The <emphasis>unstable channel</emphasis>, <literal
19+ xlink:href="https://nixos.org/channels/nixos-unstable">nixos-unstable</literal>. This corresponds to NixOS’s main development branch, and may thus see radical changes between channel updates. It’s not recommended for production systems.
3520 </para>
3621 </listitem>
3722 <listitem>
3823 <para>
39− <emphasis>Small channels</emphasis>, such as
40− <literal
41− xlink:href="https://nixos.org/channels/nixos-19.03-small">nixos-19.03-small</literal>
42− or
43− <literal
44− xlink:href="https://nixos.org/channels/nixos-unstable-small">nixos-unstable-small</literal>.
45− These are identical to the stable and unstable channels described above,
46− except that they contain fewer binary packages. This means they get
47− updated faster than the regular channels (for instance, when a critical
48− security patch is committed to NixOS’s source tree), but may require
49− more packages to be built from source than usual. They’re mostly
50− intended for server environments and as such contain few GUI applications.
24+ <emphasis>Small channels</emphasis>, such as <literal
25+ xlink:href="https://nixos.org/channels/nixos-19.03-small">nixos-19.03-small</literal> or <literal
26+ xlink:href="https://nixos.org/channels/nixos-unstable-small">nixos-unstable-small</literal>. These are identical to the stable and unstable channels described above, except that they contain fewer binary packages. This means they get updated faster than the regular channels (for instance, when a critical security patch is committed to NixOS’s source tree), but may require more packages to be built from source than usual. They’re mostly intended for server environments and as such contain few GUI applications.
5127 </para>
5228 </listitem>
5329 </itemizedlist>
54− To see what channels are available, go to
55− <link xlink:href="https://nixos.org/channels"/>. (Note that the URIs of the
56− various channels redirect to a directory that contains the channel’s latest
57− version and includes ISO images and VirtualBox appliances.) Please note that
58− during the release process, channels that are not yet released will be
59− present here as well. See the Getting NixOS page
60− <link xlink:href="https://nixos.org/nixos/download.html"/> to find the newest
61− supported stable release.
30+ To see what channels are available, go to <link xlink:href="https://nixos.org/channels"/>. (Note that the URIs of the various channels redirect to a directory that contains the channel’s latest version and includes ISO images and VirtualBox appliances.) Please note that during the release process, channels that are not yet released will be present here as well. See the Getting NixOS page <link xlink:href="https://nixos.org/nixos/download.html"/> to find the newest supported stable release.
6231 </para>
6332 <para>
64− When you first install NixOS, you’re automatically subscribed to the NixOS
65− channel that corresponds to your installation source. For instance, if you
66− installed from a 19.03 ISO, you will be subscribed to the
67− <literal>nixos-19.03</literal> channel. To see which NixOS channel you’re
68− subscribed to, run the following as root:
33+ When you first install NixOS, you’re automatically subscribed to the NixOS channel that corresponds to your installation source. For instance, if you installed from a 19.03 ISO, you will be subscribed to the <literal>nixos-19.03</literal> channel. To see which NixOS channel you’re subscribed to, run the following as root:
6934<screen>
7035# nix-channel --list | grep nixos
7136nixos https://nixos.org/channels/nixos-unstable
@@ -74,8 +39,7 @@ nixos https://nixos.org/channels/nixos-unstable
7439<screen>
7540# nix-channel --add https://nixos.org/channels/<replaceable>channel-name</replaceable> nixos
7641</screen>
77− (Be sure to include the <literal>nixos</literal> parameter at the end.) For
78− instance, to use the NixOS 19.03 stable channel:
42+ (Be sure to include the <literal>nixos</literal> parameter at the end.) For instance, to use the NixOS 19.03 stable channel:
7943<screen>
8044# nix-channel --add https://nixos.org/channels/nixos-19.03 nixos
8145</screen>
@@ -89,43 +53,31 @@ nixos https://nixos.org/channels/nixos-unstable
8953</screen>
9054 </para>
9155 <para>
92− You can then upgrade NixOS to the latest version in your chosen channel by
93− running
56+ You can then upgrade NixOS to the latest version in your chosen channel by running
9457<screen>
9558# nixos-rebuild switch --upgrade
9659</screen>
97− which is equivalent to the more verbose <literal>nix-channel --update nixos;
98− nixos-rebuild switch</literal>.
60+ which is equivalent to the more verbose <literal>nix-channel --update nixos; nixos-rebuild switch</literal>.
9961 </para>
10062 <note>
10163 <para>
102− Channels are set per user. This means that running <literal> nix-channel
103− --add</literal> as a non root user (or without sudo) will not affect
104− configuration in <literal>/etc/nixos/configuration.nix</literal>
64+ Channels are set per user. This means that running <literal> nix-channel --add</literal> as a non root user (or without sudo) will not affect configuration in <literal>/etc/nixos/configuration.nix</literal>
10565 </para>
10666 </note>
10767 <warning>
10868 <para>
109− It is generally safe to switch back and forth between channels. The only
110− exception is that a newer NixOS may also have a newer Nix version, which may
111− involve an upgrade of Nix’s database schema. This cannot be undone easily,
112− so in that case you will not be able to go back to your original channel.
69+ It is generally safe to switch back and forth between channels. The only exception is that a newer NixOS may also have a newer Nix version, which may involve an upgrade of Nix’s database schema. This cannot be undone easily, so in that case you will not be able to go back to your original channel.
11370 </para>
11471 </warning>
11572 <section xml:id="sec-upgrading-automatic">
11673 <title>Automatic Upgrades</title>
11774
11875 <para>
119− You can keep a NixOS system up-to-date automatically by adding the following
120− to <filename>configuration.nix</filename>:
76+ You can keep a NixOS system up-to-date automatically by adding the following to <filename>configuration.nix</filename>:
12177<programlisting>
12278<xref linkend="opt-system.autoUpgrade.enable"/> = true;
12379</programlisting>
124− This enables a periodically executed systemd service named
125− <literal>nixos-upgrade.service</literal>. It runs <command>nixos-rebuild
126− switch --upgrade</command> to upgrade NixOS to the latest version in the
127− current channel. (To see when the service runs, see <command>systemctl
128− list-timers</command>.) You can also specify a channel explicitly, e.g.
80+ This enables a periodically executed systemd service named <literal>nixos-upgrade.service</literal>. It runs <command>nixos-rebuild switch --upgrade</command> to upgrade NixOS to the latest version in the current channel. (To see when the service runs, see <command>systemctl list-timers</command>.) You can also specify a channel explicitly, e.g.
12981<programlisting>
13082<xref linkend="opt-system.autoUpgrade.channel"/> = https://nixos.org/channels/nixos-19.03;
13183</programlisting>
nixos/doc/manual/man-configuration.xml+1−4
@@ -14,10 +14,7 @@
1414 <refsection>
1515 <title>Description</title>
1616 <para>
17− The file <filename>/etc/nixos/configuration.nix</filename> contains the
18− declarative specification of your NixOS system configuration. The command
19− <command>nixos-rebuild</command> takes this file and realises the system
20− configuration specified therein.
17+ The file <filename>/etc/nixos/configuration.nix</filename> contains the declarative specification of your NixOS system configuration. The command <command>nixos-rebuild</command> takes this file and realises the system configuration specified therein.
2118 </para>
2219 </refsection>
2320 <refsection>
nixos/doc/manual/man-nixos-build-vms.xml+12−29
@@ -24,14 +24,12 @@
2424
2525 <arg>
2626 <option>--help</option>
27− </arg>
28−
29− <arg>
30− <option>--option</option>
31− <replaceable>name</replaceable>
32− <replaceable>value</replaceable>
33− </arg>
34−
27+ </arg>
28+
29+ <arg>
30+ <option>--option</option> <replaceable>name</replaceable> <replaceable>value</replaceable>
31+ </arg>
32+
3533 <arg choice="plain">
3634 <replaceable>network.nix</replaceable>
3735 </arg>
@@ -40,11 +38,7 @@
4038 <refsection>
4139 <title>Description</title>
4240 <para>
43− This command builds a network of QEMU-KVM virtual machines of a Nix
44− expression specifying a network of NixOS machines. The virtual network can
45− be started by executing the <filename>bin/run-vms</filename> shell script
46− that is generated by this command. By default, a <filename>result</filename>
47− symlink is produced that points to the generated virtual network.
41+ This command builds a network of QEMU-KVM virtual machines of a Nix expression specifying a network of NixOS machines. The virtual network can be started by executing the <filename>bin/run-vms</filename> shell script that is generated by this command. By default, a <filename>result</filename> symlink is produced that points to the generated virtual network.
4842 </para>
4943 <para>
5044 A network Nix expression has the following structure:
@@ -71,18 +65,7 @@
7165 };
7266}
7367</screen>
74− Each attribute in the expression represents a machine in the network (e.g.
75− <varname>test1</varname> and <varname>test2</varname>) referring to a
76− function defining a NixOS configuration. In each NixOS configuration, two
77− attributes have a special meaning. The
78− <varname>deployment.targetHost</varname> specifies the address (domain name
79− or IP address) of the system which is used by <command>ssh</command> to
80− perform remote deployment operations. The
81− <varname>nixpkgs.localSystem.system</varname> attribute can be used to
82− specify an architecture for the target machine, such as
83− <varname>i686-linux</varname> which builds a 32-bit NixOS configuration.
84− Omitting this property will build the configuration for the same
85− architecture as the host system.
68+ Each attribute in the expression represents a machine in the network (e.g. <varname>test1</varname> and <varname>test2</varname>) referring to a function defining a NixOS configuration. In each NixOS configuration, two attributes have a special meaning. The <varname>deployment.targetHost</varname> specifies the address (domain name or IP address) of the system which is used by <command>ssh</command> to perform remote deployment operations. The <varname>nixpkgs.localSystem.system</varname> attribute can be used to specify an architecture for the target machine, such as <varname>i686-linux</varname> which builds a 32-bit NixOS configuration. Omitting this property will build the configuration for the same architecture as the host system.
8669 </para>
8770 </refsection>
8871 <refsection>
@@ -126,10 +109,10 @@
126109 <option>--option</option> <replaceable>name</replaceable> <replaceable>value</replaceable>
127110 </term>
128111 <listitem>
129− <para>Set the Nix configuration option
130− <replaceable>name</replaceable> to <replaceable>value</replaceable>.
131− This overrides settings in the Nix configuration file (see
132− <citerefentry><refentrytitle>nix.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry>).
112+ <para>
113+ Set the Nix configuration option <replaceable>name</replaceable> to <replaceable>value</replaceable>. This overrides settings in the Nix configuration file (see <citerefentry>
114+ <refentrytitle>nix.conf</refentrytitle>
115+ <manvolnum>5</manvolnum></citerefentry>).
133116 </para>
134117 </listitem>
135118 </varlistentry>
nixos/doc/manual/man-nixos-enter.xml+7−15
@@ -34,7 +34,7 @@
3434 </arg>
3535 <replaceable>shell-command</replaceable>
3636 </arg>
37−
37+
3838 <arg>
3939 <arg choice='plain'>
4040 <option>--silent</option>
@@ -58,9 +58,7 @@
5858 <refsection>
5959 <title>Description</title>
6060 <para>
61− This command runs a command in a NixOS chroot environment, that is, in a
62− filesystem hierarchy previously prepared using
63− <command>nixos-install</command>.
61+ This command runs a command in a NixOS chroot environment, that is, in a filesystem hierarchy previously prepared using <command>nixos-install</command>.
6462 </para>
6563 </refsection>
6664 <refsection>
@@ -75,8 +73,7 @@
7573 </term>
7674 <listitem>
7775 <para>
78− The path to the NixOS system you want to enter. It defaults to
79− <filename>/mnt</filename>.
76+ The path to the NixOS system you want to enter. It defaults to <filename>/mnt</filename>.
8077 </para>
8178 </listitem>
8279 </varlistentry>
@@ -86,10 +83,7 @@
8683 </term>
8784 <listitem>
8885 <para>
89− The NixOS system configuration to use. It defaults to
90− <filename>/nix/var/nix/profiles/system</filename>. You can enter a
91− previous NixOS configuration by specifying a path such as
92− <filename>/nix/var/nix/profiles/system-106-link</filename>.
86+ The NixOS system configuration to use. It defaults to <filename>/nix/var/nix/profiles/system</filename>. You can enter a previous NixOS configuration by specifying a path such as <filename>/nix/var/nix/profiles/system-106-link</filename>.
9387 </para>
9488 </listitem>
9589 </varlistentry>
@@ -112,7 +106,7 @@
112106 </term>
113107 <listitem>
114108 <para>
115− Suppresses all output from the activation script of the target system.
109+ Suppresses all output from the activation script of the target system.
116110 </para>
117111 </listitem>
118112 </varlistentry>
@@ -122,8 +116,7 @@
122116 </term>
123117 <listitem>
124118 <para>
125− Interpret the remaining arguments as the program name and arguments to be
126− invoked. The program is not executed in a shell.
119+ Interpret the remaining arguments as the program name and arguments to be invoked. The program is not executed in a shell.
127120 </para>
128121 </listitem>
129122 </varlistentry>
@@ -132,8 +125,7 @@
132125 <refsection>
133126 <title>Examples</title>
134127 <para>
135− Start an interactive shell in the NixOS installation in
136− <filename>/mnt</filename>:
128+ Start an interactive shell in the NixOS installation in <filename>/mnt</filename>:
137129 </para>
138130<screen>
139131# nixos-enter /mnt
nixos/doc/manual/man-nixos-generate-config.xml+15−49
@@ -13,18 +13,18 @@
1313 </refnamediv>
1414 <refsynopsisdiv>
1515 <cmdsynopsis>
16− <command>nixos-generate-config</command>
16+ <command>nixos-generate-config</command>
1717 <arg>
1818 <option>--force</option>
1919 </arg>
20−
20+
2121 <arg>
2222 <arg choice='plain'>
2323 <option>--root</option>
2424 </arg>
2525 <replaceable>root</replaceable>
2626 </arg>
27−
27+
2828 <arg>
2929 <arg choice='plain'>
3030 <option>--dir</option>
@@ -44,20 +44,10 @@
4444 </term>
4545 <listitem>
4646 <para>
47− This module sets NixOS configuration options based on your current
48− hardware configuration. In particular, it sets the
49− <option>fileSystem</option> option to reflect all currently mounted file
50− systems, the <option>swapDevices</option> option to reflect active swap
51− devices, and the <option>boot.initrd.*</option> options to ensure that
52− the initial ramdisk contains any kernel modules necessary for mounting
53− the root file system.
47+ This module sets NixOS configuration options based on your current hardware configuration. In particular, it sets the <option>fileSystem</option> option to reflect all currently mounted file systems, the <option>swapDevices</option> option to reflect active swap devices, and the <option>boot.initrd.*</option> options to ensure that the initial ramdisk contains any kernel modules necessary for mounting the root file system.
5448 </para>
5549 <para>
56− If this file already exists, it is overwritten. Thus, you should not
57− modify it manually. Rather, you should include it from your
58− <filename>/etc/nixos/configuration.nix</filename>, and re-run
59− <command>nixos-generate-config</command> to update it whenever your
60− hardware configuration changes.
50+ If this file already exists, it is overwritten. Thus, you should not modify it manually. Rather, you should include it from your <filename>/etc/nixos/configuration.nix</filename>, and re-run <command>nixos-generate-config</command> to update it whenever your hardware configuration changes.
6151 </para>
6252 </listitem>
6353 </varlistentry>
@@ -67,10 +57,7 @@
6757 </term>
6858 <listitem>
6959 <para>
70− This is the main NixOS system configuration module. If it already
71− exists, it’s left unchanged. Otherwise,
72− <command>nixos-generate-config</command> will write a template for you
73− to customise.
60+ This is the main NixOS system configuration module. If it already exists, it’s left unchanged. Otherwise, <command>nixos-generate-config</command> will write a template for you to customise.
7461 </para>
7562 </listitem>
7663 </varlistentry>
@@ -89,12 +76,7 @@
8976 </term>
9077 <listitem>
9178 <para>
92− If this option is given, treat the directory
93− <replaceable>root</replaceable> as the root of the file system. This
94− means that configuration files will be written to
95− <filename><replaceable>root</replaceable>/etc/nixos</filename>, and that
96− any file systems outside of <replaceable>root</replaceable> are ignored
97− for the purpose of generating the <option>fileSystems</option> option.
79+ If this option is given, treat the directory <replaceable>root</replaceable> as the root of the file system. This means that configuration files will be written to <filename><replaceable>root</replaceable>/etc/nixos</filename>, and that any file systems outside of <replaceable>root</replaceable> are ignored for the purpose of generating the <option>fileSystems</option> option.
9880 </para>
9981 </listitem>
10082 </varlistentry>
@@ -104,9 +86,7 @@
10486 </term>
10587 <listitem>
10688 <para>
107− If this option is given, write the configuration files to the directory
108− <replaceable>dir</replaceable> instead of
109− <filename>/etc/nixos</filename>.
89+ If this option is given, write the configuration files to the directory <replaceable>dir</replaceable> instead of <filename>/etc/nixos</filename>.
11090 </para>
11191 </listitem>
11292 </varlistentry>
@@ -116,8 +96,7 @@
11696 </term>
11797 <listitem>
11898 <para>
119− Overwrite <filename>/etc/nixos/configuration.nix</filename> if it already
120− exists.
99+ Overwrite <filename>/etc/nixos/configuration.nix</filename> if it already exists.
121100 </para>
122101 </listitem>
123102 </varlistentry>
@@ -127,8 +106,7 @@
127106 </term>
128107 <listitem>
129108 <para>
130− Omit everything concerning file systems and swap devices from the
131− hardware configuration.
109+ Omit everything concerning file systems and swap devices from the hardware configuration.
132110 </para>
133111 </listitem>
134112 </varlistentry>
@@ -138,9 +116,7 @@
138116 </term>
139117 <listitem>
140118 <para>
141− Don't generate <filename>configuration.nix</filename> or
142− <filename>hardware-configuration.nix</filename> and print the hardware
143− configuration to stdout only.
119+ Don't generate <filename>configuration.nix</filename> or <filename>hardware-configuration.nix</filename> and print the hardware configuration to stdout only.
144120 </para>
145121 </listitem>
146122 </varlistentry>
@@ -149,16 +125,11 @@
149125 <refsection>
150126 <title>Examples</title>
151127 <para>
152− This command is typically used during NixOS installation to write initial
153− configuration modules. For example, if you created and mounted the target
154− file systems on <filename>/mnt</filename> and
155− <filename>/mnt/boot</filename>, you would run:
128+ This command is typically used during NixOS installation to write initial configuration modules. For example, if you created and mounted the target file systems on <filename>/mnt</filename> and <filename>/mnt/boot</filename>, you would run:
156129<screen>
157130<prompt>$ </prompt>nixos-generate-config --root /mnt
158131</screen>
159− The resulting file
160− <filename>/mnt/etc/nixos/hardware-configuration.nix</filename> might look
161− like this:
132+ The resulting file <filename>/mnt/etc/nixos/hardware-configuration.nix</filename> might look like this:
162133<programlisting>
163134# Do not modify this file! It was generated by ‘nixos-generate-config’
164135# and may be overwritten by future invocations. Please make changes
@@ -193,10 +164,7 @@
193164 nix.maxJobs = 8;
194165}
195166</programlisting>
196− It will also create a basic
197− <filename>/mnt/etc/nixos/configuration.nix</filename>, which you should edit
198− to customise the logical configuration of your system. This file includes
199− the result of the hardware scan as follows:
167+ It will also create a basic <filename>/mnt/etc/nixos/configuration.nix</filename>, which you should edit to customise the logical configuration of your system. This file includes the result of the hardware scan as follows:
200168<programlisting>
201169 imports = [ ./hardware-configuration.nix ];
202170</programlisting>
@@ -206,9 +174,7 @@
206174<screen>
207175<prompt>$ </prompt>nixos-generate-config
208176</screen>
209− to update <filename>/etc/nixos/hardware-configuration.nix</filename>. Your
210− <filename>/etc/nixos/configuration.nix</filename> will
211− <emphasis>not</emphasis> be overwritten.
177+ to update <filename>/etc/nixos/hardware-configuration.nix</filename>. Your <filename>/etc/nixos/configuration.nix</filename> will <emphasis>not</emphasis> be overwritten.
212178 </para>
213179 </refsection>
214180</refentry>
nixos/doc/manual/man-nixos-install.xml+28−67
@@ -13,72 +13,72 @@
1313 </refnamediv>
1414 <refsynopsisdiv>
1515 <cmdsynopsis>
16− <command>nixos-install</command>
16+ <command>nixos-install</command>
1717 <arg>
1818 <arg choice='plain'>
1919 <option>-I</option>
2020 </arg>
2121 <replaceable>path</replaceable>
2222 </arg>
23−
23+
2424 <arg>
2525 <arg choice='plain'>
2626 <option>--root</option>
2727 </arg>
2828 <replaceable>root</replaceable>
2929 </arg>
30−
30+
3131 <arg>
3232 <arg choice='plain'>
3333 <option>--system</option>
3434 </arg>
3535 <replaceable>path</replaceable>
3636 </arg>
37−
37+
3838 <arg>
3939 <arg choice='plain'>
4040 <option>--no-channel-copy</option>
4141 </arg>
4242 </arg>
43−
43+
4444 <arg>
4545 <arg choice='plain'>
4646 <option>--no-root-passwd</option>
4747 </arg>
4848 </arg>
49−
49+
5050 <arg>
5151 <arg choice='plain'>
5252 <option>--no-bootloader</option>
5353 </arg>
5454 </arg>
55−
55+
5656 <arg>
57− <group choice='req'>
57+ <group choice='req'>
5858 <arg choice='plain'>
5959 <option>--max-jobs</option>
6060 </arg>
61−
61+
6262 <arg choice='plain'>
6363 <option>-j</option>
6464 </arg>
6565 </group> <replaceable>number</replaceable>
6666 </arg>
67−
67+
6868 <arg>
6969 <option>--cores</option> <replaceable>number</replaceable>
7070 </arg>
71−
71+
7272 <arg>
7373 <option>--option</option> <replaceable>name</replaceable> <replaceable>value</replaceable>
7474 </arg>
75−
75+
7676 <arg>
7777 <arg choice='plain'>
7878 <option>--show-trace</option>
7979 </arg>
8080 </arg>
81−
81+
8282 <arg>
8383 <arg choice='plain'>
8484 <option>--help</option>
@@ -89,43 +89,32 @@
8989 <refsection>
9090 <title>Description</title>
9191 <para>
92− This command installs NixOS in the file system mounted on
93− <filename>/mnt</filename>, based on the NixOS configuration specified in
94− <filename>/mnt/etc/nixos/configuration.nix</filename>. It performs the
95− following steps:
92+ This command installs NixOS in the file system mounted on <filename>/mnt</filename>, based on the NixOS configuration specified in <filename>/mnt/etc/nixos/configuration.nix</filename>. It performs the following steps:
9693 <itemizedlist>
9794 <listitem>
9895 <para>
99− It copies Nix and its dependencies to
100− <filename>/mnt/nix/store</filename>.
96+ It copies Nix and its dependencies to <filename>/mnt/nix/store</filename>.
10197 </para>
10298 </listitem>
10399 <listitem>
104100 <para>
105− It runs Nix in <filename>/mnt</filename> to build the NixOS configuration
106− specified in <filename>/mnt/etc/nixos/configuration.nix</filename>.
101+ It runs Nix in <filename>/mnt</filename> to build the NixOS configuration specified in <filename>/mnt/etc/nixos/configuration.nix</filename>.
107102 </para>
108103 </listitem>
109104 <listitem>
110105 <para>
111− It installs the GRUB boot loader on the device specified in the option
112− <option>boot.loader.grub.device</option> (unless
113− <option>--no-bootloader</option> is specified), and generates a GRUB
114− configuration file that boots into the NixOS configuration just
115− installed.
106+ It installs the GRUB boot loader on the device specified in the option <option>boot.loader.grub.device</option> (unless <option>--no-bootloader</option> is specified), and generates a GRUB configuration file that boots into the NixOS configuration just installed.
116107 </para>
117108 </listitem>
118109 <listitem>
119110 <para>
120− It prompts you for a password for the root account (unless
121− <option>--no-root-passwd</option> is specified).
111+ It prompts you for a password for the root account (unless <option>--no-root-passwd</option> is specified).
122112 </para>
123113 </listitem>
124114 </itemizedlist>
125115 </para>
126116 <para>
127− This command is idempotent: if it is interrupted or fails due to a temporary
128− problem (e.g. a network issue), you can safely re-run it.
117+ This command is idempotent: if it is interrupted or fails due to a temporary problem (e.g. a network issue), you can safely re-run it.
129118 </para>
130119 </refsection>
131120 <refsection>
@@ -140,9 +129,7 @@
140129 </term>
141130 <listitem>
142131 <para>
143− Defaults to <filename>/mnt</filename>. If this option is given, treat the
144− directory <replaceable>root</replaceable> as the root of the NixOS
145− installation.
132+ Defaults to <filename>/mnt</filename>. If this option is given, treat the directory <replaceable>root</replaceable> as the root of the NixOS installation.
146133 </para>
147134 </listitem>
148135 </varlistentry>
@@ -152,16 +139,10 @@
152139 </term>
153140 <listitem>
154141 <para>
155− If this option is provided, <command>nixos-install</command> will install
156− the specified closure rather than attempt to build one from
157− <filename>/mnt/etc/nixos/configuration.nix</filename>.
142+ If this option is provided, <command>nixos-install</command> will install the specified closure rather than attempt to build one from <filename>/mnt/etc/nixos/configuration.nix</filename>.
158143 </para>
159144 <para>
160− The closure must be an appropriately configured NixOS system, with boot
161− loader and partition configuration that fits the target host. Such a
162− closure is typically obtained with a command such as <command>nix-build
163− -I nixos-config=./configuration.nix '&lt;nixos&gt;' -A system
164− --no-out-link</command>
145+ The closure must be an appropriately configured NixOS system, with boot loader and partition configuration that fits the target host. Such a closure is typically obtained with a command such as <command>nix-build -I nixos-config=./configuration.nix '&lt;nixos&gt;' -A system --no-out-link</command>
165146 </para>
166147 </listitem>
167148 </varlistentry>
@@ -171,10 +152,7 @@
171152 </term>
172153 <listitem>
173154 <para>
174− Add a path to the Nix expression search path. This option may be given
175− multiple times. See the NIX_PATH environment variable for information on
176− the semantics of the Nix search path. Paths added through
177− <replaceable>-I</replaceable> take precedence over NIX_PATH.
155+ Add a path to the Nix expression search path. This option may be given multiple times. See the NIX_PATH environment variable for information on the semantics of the Nix search path. Paths added through <replaceable>-I</replaceable> take precedence over NIX_PATH.
178156 </para>
179157 </listitem>
180158 </varlistentry>
@@ -187,9 +165,7 @@
187165 </term>
188166 <listitem>
189167 <para>
190− Sets the maximum number of build jobs that Nix will perform in parallel
191− to the specified number. The default is <literal>1</literal>. A higher
192− value is useful on SMP systems or to exploit I/O latency.
168+ Sets the maximum number of build jobs that Nix will perform in parallel to the specified number. The default is <literal>1</literal>. A higher value is useful on SMP systems or to exploit I/O latency.
193169 </para>
194170 </listitem>
195171 </varlistentry>
@@ -199,15 +175,7 @@
199175 </term>
200176 <listitem>
201177 <para>
202− Sets the value of the <envar>NIX_BUILD_CORES</envar> environment variable
203− in the invocation of builders. Builders can use this variable at their
204− discretion to control the maximum amount of parallelism. For instance, in
205− Nixpkgs, if the derivation attribute
206− <varname>enableParallelBuilding</varname> is set to
207− <literal>true</literal>, the builder passes the
208− <option>-j<replaceable>N</replaceable></option> flag to GNU Make. The
209− value <literal>0</literal> means that the builder should use all
210− available CPU cores in the system.
178+ Sets the value of the <envar>NIX_BUILD_CORES</envar> environment variable in the invocation of builders. Builders can use this variable at their discretion to control the maximum amount of parallelism. For instance, in Nixpkgs, if the derivation attribute <varname>enableParallelBuilding</varname> is set to <literal>true</literal>, the builder passes the <option>-j<replaceable>N</replaceable></option> flag to GNU Make. The value <literal>0</literal> means that the builder should use all available CPU cores in the system.
211179 </para>
212180 </listitem>
213181 </varlistentry>
@@ -217,8 +185,7 @@
217185 </term>
218186 <listitem>
219187 <para>
220− Set the Nix configuration option <replaceable>name</replaceable> to
221− <replaceable>value</replaceable>.
188+ Set the Nix configuration option <replaceable>name</replaceable> to <replaceable>value</replaceable>.
222189 </para>
223190 </listitem>
224191 </varlistentry>
@@ -228,8 +195,7 @@
228195 </term>
229196 <listitem>
230197 <para>
231− Causes Nix to print out a stack trace in case of Nix expression
232− evaluation errors.
198+ Causes Nix to print out a stack trace in case of Nix expression evaluation errors.
233199 </para>
234200 </listitem>
235201 </varlistentry>
@@ -248,12 +214,7 @@
248214 <refsection>
249215 <title>Examples</title>
250216 <para>
251− A typical NixOS installation is done by creating and mounting a file system
252− on <filename>/mnt</filename>, generating a NixOS configuration in
253− <filename>/mnt/etc/nixos/configuration.nix</filename>, and running
254− <command>nixos-install</command>. For instance, if we want to install NixOS
255− on an <literal>ext4</literal> file system created in
256− <filename>/dev/sda1</filename>:
217+ A typical NixOS installation is done by creating and mounting a file system on <filename>/mnt</filename>, generating a NixOS configuration in <filename>/mnt/etc/nixos/configuration.nix</filename>, and running <command>nixos-install</command>. For instance, if we want to install NixOS on an <literal>ext4</literal> file system created in <filename>/dev/sda1</filename>:
257218<screen>
258219<prompt>$ </prompt>mkfs.ext4 /dev/sda1
259220<prompt>$ </prompt>mount /dev/sda1 /mnt
nixos/doc/manual/man-nixos-option.xml+10−17
@@ -13,19 +13,19 @@
1313 </refnamediv>
1414 <refsynopsisdiv>
1515 <cmdsynopsis>
16− <command>nixos-option</command>
16+ <command>nixos-option</command>
1717 <arg>
1818 <option>-I</option> <replaceable>path</replaceable>
1919 </arg>
20−
20+
2121 <arg>
2222 <option>--verbose</option>
2323 </arg>
24−
24+
2525 <arg>
2626 <option>--xml</option>
2727 </arg>
28−
28+
2929 <arg choice="plain">
3030 <replaceable>option.name</replaceable>
3131 </arg>
@@ -34,13 +34,10 @@
3434 <refsection>
3535 <title>Description</title>
3636 <para>
37− This command evaluates the configuration specified in
38− <filename>/etc/nixos/configuration.nix</filename> and returns the properties
39− of the option name given as argument.
37+ This command evaluates the configuration specified in <filename>/etc/nixos/configuration.nix</filename> and returns the properties of the option name given as argument.
4038 </para>
4139 <para>
42− When the option name is not an option, the command prints the list of
43− attributes contained in the attribute set.
40+ When the option name is not an option, the command prints the list of attributes contained in the attribute set.
4441 </para>
4542 </refsection>
4643 <refsection>
@@ -55,8 +52,7 @@
5552 </term>
5653 <listitem>
5754 <para>
58− This option is passed to the underlying
59− <command>nix-instantiate</command> invocation.
55+ This option is passed to the underlying <command>nix-instantiate</command> invocation.
6056 </para>
6157 </listitem>
6258 </varlistentry>
@@ -66,8 +62,7 @@
6662 </term>
6763 <listitem>
6864 <para>
69− This option enables verbose mode, which currently is just the Bash
70− <command>set</command> <option>-x</option> debug mode.
65+ This option enables verbose mode, which currently is just the Bash <command>set</command> <option>-x</option> debug mode.
7166 </para>
7267 </listitem>
7368 </varlistentry>
@@ -92,8 +87,7 @@
9287 </term>
9388 <listitem>
9489 <para>
95− Path to the main NixOS configuration module. Defaults to
96− <filename>/etc/nixos/configuration.nix</filename>.
90+ Path to the main NixOS configuration module. Defaults to <filename>/etc/nixos/configuration.nix</filename>.
9791 </para>
9892 </listitem>
9993 </varlistentry>
@@ -130,8 +124,7 @@ Defined by:
130124 <refsection>
131125 <title>Bugs</title>
132126 <para>
133− The author listed in the following section is wrong. If there is any other
134− bug, please report to Nicolas Pierron.
127+ The author listed in the following section is wrong. If there is any other bug, please report to Nicolas Pierron.
135128 </para>
136129 </refsection>
137130</refentry>
nixos/doc/manual/man-nixos-rebuild.xml+90−219
@@ -7,47 +7,45 @@
77 <refmiscinfo class="source">NixOS</refmiscinfo>
88<!-- <refmiscinfo class="version"><xi:include href="version.txt" parse="text"/></refmiscinfo> -->
99 </refmeta>
10−
1110 <refnamediv>
1211 <refname><command>nixos-rebuild</command>
1312 </refname><refpurpose>reconfigure a NixOS machine</refpurpose>
1413 </refnamediv>
15−
1614 <refsynopsisdiv>
1715 <cmdsynopsis>
18− <command>nixos-rebuild</command><group choice='req'>
16+ <command>nixos-rebuild</command><group choice='req'>
1917 <arg choice='plain'>
2018 <option>switch</option>
2119 </arg>
22−
20+
2321 <arg choice='plain'>
2422 <option>boot</option>
2523 </arg>
26−
24+
2725 <arg choice='plain'>
2826 <option>test</option>
2927 </arg>
30−
28+
3129 <arg choice='plain'>
3230 <option>build</option>
3331 </arg>
34−
32+
3533 <arg choice='plain'>
3634 <option>dry-build</option>
3735 </arg>
38−
36+
3937 <arg choice='plain'>
4038 <option>dry-activate</option>
4139 </arg>
42−
40+
4341 <arg choice='plain'>
4442 <option>edit</option>
4543 </arg>
46−
44+
4745 <arg choice='plain'>
4846 <option>build-vm</option>
4947 </arg>
50−
48+
5149 <arg choice='plain'>
5250 <option>build-vm-with-bootloader</option>
5351 </arg>
@@ -56,34 +54,33 @@
5654 <arg>
5755 <option>--upgrade</option>
5856 </arg>
59−
57+
6058 <arg>
6159 <option>--install-bootloader</option>
6260 </arg>
63−
61+
6462 <arg>
6563 <option>--no-build-nix</option>
6664 </arg>
67−
65+
6866 <arg>
6967 <option>--fast</option>
7068 </arg>
71−
69+
7270 <arg>
7371 <option>--rollback</option>
7472 </arg>
75−
73+
7674 <arg>
7775 <option>--builders</option> <replaceable>builder-spec</replaceable>
7876 </arg>
79−
8077 <sbr />
8178 <arg>
82− <group choice='req'>
79+ <group choice='req'>
8380 <arg choice='plain'>
8481 <option>--profile-name</option>
8582 </arg>
86−
83+
8784 <arg choice='plain'>
8885 <option>-p</option>
8986 </arg>
@@ -93,56 +90,67 @@
9390 <arg>
9491 <option>--show-trace</option>
9592 </arg>
93+
9694 <arg>
97− <option>-I</option>
98− <replaceable>path</replaceable>
95+ <option>-I</option> <replaceable>path</replaceable>
9996 </arg>
97+
10098 <arg>
101− <group choice='req'>
102− <arg choice='plain'><option>--verbose</option></arg>
103− <arg choice='plain'><option>-v</option></arg>
104− </group>
99+ <group choice='req'>
100+ <arg choice='plain'>
101+ <option>--verbose</option>
102+ </arg>
103+
104+ <arg choice='plain'>
105+ <option>-v</option>
106+ </arg>
107+ </group>
105108 </arg>
109+
106110 <arg>
107− <group choice='req'>
108− <arg choice='plain'><option>--max-jobs</option></arg>
109− <arg choice='plain'><option>-j</option></arg>
110− </group>
111− <replaceable>number</replaceable>
111+ <group choice='req'>
112+ <arg choice='plain'>
113+ <option>--max-jobs</option>
114+ </arg>
115+
116+ <arg choice='plain'>
117+ <option>-j</option>
118+ </arg>
119+ </group> <replaceable>number</replaceable>
112120 </arg>
121+
113122 <arg>
114− <group choice='req'>
115− <arg choice='plain'><option>--keep-failed</option></arg>
116− <arg choice='plain'><option>-K</option></arg>
117− </group>
123+ <group choice='req'>
124+ <arg choice='plain'>
125+ <option>--keep-failed</option>
126+ </arg>
127+
128+ <arg choice='plain'>
129+ <option>-K</option>
130+ </arg>
131+ </group>
118132 </arg>
133+
119134 <arg>
120− <group choice='req'>
121− <arg choice='plain'><option>--keep-going</option></arg>
122− <arg choice='plain'><option>-k</option></arg>
123− </group>
135+ <group choice='req'>
136+ <arg choice='plain'>
137+ <option>--keep-going</option>
138+ </arg>
139+
140+ <arg choice='plain'>
141+ <option>-k</option>
142+ </arg>
143+ </group>
124144 </arg>
125145 </cmdsynopsis>
126146 </refsynopsisdiv>
127−
128147 <refsection>
129148 <title>Description</title>
130−
131149 <para>
132− This command updates the system so that it corresponds to the configuration
133− specified in <filename>/etc/nixos/configuration.nix</filename>. Thus, every
134− time you modify <filename>/etc/nixos/configuration.nix</filename> or any
135− NixOS module, you must run <command>nixos-rebuild</command> to make the
136− changes take effect. It builds the new system in
137− <filename>/nix/store</filename>, runs its activation script, and stop and
138− (re)starts any system services if needed. Please note that user services need
139− to be started manually as they aren't detected by the activation script at the moment.
150+ This command updates the system so that it corresponds to the configuration specified in <filename>/etc/nixos/configuration.nix</filename>. Thus, every time you modify <filename>/etc/nixos/configuration.nix</filename> or any NixOS module, you must run <command>nixos-rebuild</command> to make the changes take effect. It builds the new system in <filename>/nix/store</filename>, runs its activation script, and stop and (re)starts any system services if needed. Please note that user services need to be started manually as they aren't detected by the activation script at the moment.
140151 </para>
141−
142152 <para>
143− This command has one required argument, which specifies the desired
144− operation. It must be one of the following:
145−
153+ This command has one required argument, which specifies the desired operation. It must be one of the following:
146154 <variablelist>
147155 <varlistentry>
148156 <term>
@@ -150,91 +158,64 @@
150158 </term>
151159 <listitem>
152160 <para>
153− Build and activate the new configuration, and make it the boot default.
154− That is, the configuration is added to the GRUB boot menu as the default
155− menu entry, so that subsequent reboots will boot the system into the new
156− configuration. Previous configurations activated with
157− <command>nixos-rebuild switch</command> or <command>nixos-rebuild
158− boot</command> remain available in the GRUB menu.
161+ Build and activate the new configuration, and make it the boot default. That is, the configuration is added to the GRUB boot menu as the default menu entry, so that subsequent reboots will boot the system into the new configuration. Previous configurations activated with <command>nixos-rebuild switch</command> or <command>nixos-rebuild boot</command> remain available in the GRUB menu.
159162 </para>
160163 </listitem>
161164 </varlistentry>
162−
163165 <varlistentry>
164166 <term>
165167 <option>boot</option>
166168 </term>
167169 <listitem>
168170 <para>
169− Build the new configuration and make it the boot default (as with
170− <command>nixos-rebuild switch</command>), but do not activate it. That
171− is, the system continues to run the previous configuration until the
172− next reboot.
171+ Build the new configuration and make it the boot default (as with <command>nixos-rebuild switch</command>), but do not activate it. That is, the system continues to run the previous configuration until the next reboot.
173172 </para>
174173 </listitem>
175174 </varlistentry>
176−
177175 <varlistentry>
178176 <term>
179177 <option>test</option>
180178 </term>
181179 <listitem>
182180 <para>
183− Build and activate the new configuration, but do not add it to the GRUB
184− boot menu. Thus, if you reboot the system (or if it crashes), you will
185− automatically revert to the default configuration (i.e. the
186− configuration resulting from the last call to <command>nixos-rebuild
187− switch</command> or <command>nixos-rebuild boot</command>).
181+ Build and activate the new configuration, but do not add it to the GRUB boot menu. Thus, if you reboot the system (or if it crashes), you will automatically revert to the default configuration (i.e. the configuration resulting from the last call to <command>nixos-rebuild switch</command> or <command>nixos-rebuild boot</command>).
188182 </para>
189183 </listitem>
190184 </varlistentry>
191−
192185 <varlistentry>
193186 <term>
194187 <option>build</option>
195188 </term>
196189 <listitem>
197190 <para>
198− Build the new configuration, but neither activate it nor add it to the
199− GRUB boot menu. It leaves a symlink named <filename>result</filename> in
200− the current directory, which points to the output of the top-level
201− “system” derivation. This is essentially the same as doing
191+ Build the new configuration, but neither activate it nor add it to the GRUB boot menu. It leaves a symlink named <filename>result</filename> in the current directory, which points to the output of the top-level “system” derivation. This is essentially the same as doing
202192<screen>
203193<prompt>$ </prompt>nix-build /path/to/nixpkgs/nixos -A system
204194</screen>
205− Note that you do not need to be <literal>root</literal> to run
206− <command>nixos-rebuild build</command>.
195+ Note that you do not need to be <literal>root</literal> to run <command>nixos-rebuild build</command>.
207196 </para>
208197 </listitem>
209198 </varlistentry>
210−
211199 <varlistentry>
212200 <term>
213201 <option>dry-build</option>
214202 </term>
215203 <listitem>
216204 <para>
217− Show what store paths would be built or downloaded by any of the
218− operations above, but otherwise do nothing.
205+ Show what store paths would be built or downloaded by any of the operations above, but otherwise do nothing.
219206 </para>
220207 </listitem>
221208 </varlistentry>
222−
223209 <varlistentry>
224210 <term>
225211 <option>dry-activate</option>
226212 </term>
227213 <listitem>
228214 <para>
229− Build the new configuration, but instead of activating it, show what
230− changes would be performed by the activation (i.e. by
231− <command>nixos-rebuild test</command>). For instance, this command will
232− print which systemd units would be restarted. The list of changes is not
233− guaranteed to be complete.
215+ Build the new configuration, but instead of activating it, show what changes would be performed by the activation (i.e. by <command>nixos-rebuild test</command>). For instance, this command will print which systemd units would be restarted. The list of changes is not guaranteed to be complete.
234216 </para>
235217 </listitem>
236218 </varlistentry>
237−
238219 <varlistentry>
239220 <term>
240221 <option>edit</option>
@@ -245,80 +226,49 @@
245226 </para>
246227 </listitem>
247228 </varlistentry>
248−
249229 <varlistentry>
250230 <term>
251231 <option>build-vm</option>
252232 </term>
253233 <listitem>
254234 <para>
255− Build a script that starts a NixOS virtual machine with the desired
256− configuration. It leaves a symlink <filename>result</filename> in the
257− current directory that points (under
258− <filename>result/bin/run-<replaceable>hostname</replaceable>-vm</filename>)
259− at the script that starts the VM. Thus, to test a NixOS configuration in
260− a virtual machine, you should do the following:
235+ Build a script that starts a NixOS virtual machine with the desired configuration. It leaves a symlink <filename>result</filename> in the current directory that points (under <filename>result/bin/run-<replaceable>hostname</replaceable>-vm</filename>) at the script that starts the VM. Thus, to test a NixOS configuration in a virtual machine, you should do the following:
261236<screen>
262237<prompt>$ </prompt>nixos-rebuild build-vm
263238<prompt>$ </prompt>./result/bin/run-*-vm
264239</screen>
265240 </para>
266−
267241 <para>
268− The VM is implemented using the <literal>qemu</literal> package. For
269− best performance, you should load the <literal>kvm-intel</literal> or
270− <literal>kvm-amd</literal> kernel modules to get hardware
271− virtualisation.
242+ The VM is implemented using the <literal>qemu</literal> package. For best performance, you should load the <literal>kvm-intel</literal> or <literal>kvm-amd</literal> kernel modules to get hardware virtualisation.
272243 </para>
273−
274244 <para>
275− The VM mounts the Nix store of the host through the 9P file system. The
276− host Nix store is read-only, so Nix commands that modify the Nix store
277− will not work in the VM. This includes commands such as
278− <command>nixos-rebuild</command>; to change the VM’s configuration,
279− you must halt the VM and re-run the commands above.
245+ The VM mounts the Nix store of the host through the 9P file system. The host Nix store is read-only, so Nix commands that modify the Nix store will not work in the VM. This includes commands such as <command>nixos-rebuild</command>; to change the VM’s configuration, you must halt the VM and re-run the commands above.
280246 </para>
281−
282247 <para>
283− The VM has its own <literal>ext3</literal> root file system, which is
284− automatically created when the VM is first started, and is persistent
285− across reboots of the VM. It is stored in
286− <literal>./<replaceable>hostname</replaceable>.qcow2</literal>.
248+ The VM has its own <literal>ext3</literal> root file system, which is automatically created when the VM is first started, and is persistent across reboots of the VM. It is stored in <literal>./<replaceable>hostname</replaceable>.qcow2</literal>.
287249<!-- The entire file system hierarchy of the host is available in
288250 the VM under <filename>/hostfs</filename>.-->
289251 </para>
290252 </listitem>
291253 </varlistentry>
292−
293254 <varlistentry>
294255 <term>
295256 <option>build-vm-with-bootloader</option>
296257 </term>
297258 <listitem>
298259 <para>
299− Like <option>build-vm</option>, but boots using the regular boot loader
300− of your configuration (e.g., GRUB 1 or 2), rather than booting directly
301− into the kernel and initial ramdisk of the system. This allows you to
302− test whether the boot loader works correctly. However, it does not
303− guarantee that your NixOS configuration will boot successfully on the
304− host hardware (i.e., after running <command>nixos-rebuild
305− switch</command>), because the hardware and boot loader configuration in
306− the VM are different. The boot loader is installed on an automatically
307− generated virtual disk containing a <filename>/boot</filename>
308− partition, which is mounted read-only in the VM.
260+ Like <option>build-vm</option>, but boots using the regular boot loader of your configuration (e.g., GRUB 1 or 2), rather than booting directly into the kernel and initial ramdisk of the system. This allows you to test whether the boot loader works correctly. However, it does not guarantee that your NixOS configuration will boot successfully on the host hardware (i.e., after running <command>nixos-rebuild switch</command>), because the hardware and boot loader configuration in the VM are different. The boot loader is installed on an automatically generated virtual disk containing a <filename>/boot</filename> partition, which is mounted read-only in the VM.
309261 </para>
310262 </listitem>
311263 </varlistentry>
312264 </variablelist>
313265 </para>
314266 </refsection>
315−
316267 <refsection>
317268 <title>Options</title>
318269 <para>
319270 This command accepts the following options:
320271 </para>
321−
322272 <variablelist>
323273 <varlistentry>
324274 <term>
@@ -330,84 +280,56 @@
330280 </para>
331281 </listitem>
332282 </varlistentry>
333−
334283 <varlistentry>
335284 <term>
336285 <option>--install-bootloader</option>
337286 </term>
338287 <listitem>
339288 <para>
340− Causes the boot loader to be (re)installed on the device specified by the
341− relevant configuration options.
289+ Causes the boot loader to be (re)installed on the device specified by the relevant configuration options.
342290 </para>
343291 </listitem>
344292 </varlistentry>
345−
346293 <varlistentry>
347294 <term>
348295 <option>--no-build-nix</option>
349296 </term>
350297 <listitem>
351298 <para>
352− Normally, <command>nixos-rebuild</command> first builds the
353− <varname>nixUnstable</varname> attribute in Nixpkgs, and uses the
354− resulting instance of the Nix package manager to build the new system
355− configuration. This is necessary if the NixOS modules use features not
356− provided by the currently installed version of Nix. This option disables
357− building a new Nix.
299+ Normally, <command>nixos-rebuild</command> first builds the <varname>nixUnstable</varname> attribute in Nixpkgs, and uses the resulting instance of the Nix package manager to build the new system configuration. This is necessary if the NixOS modules use features not provided by the currently installed version of Nix. This option disables building a new Nix.
358300 </para>
359301 </listitem>
360302 </varlistentry>
361−
362303 <varlistentry>
363304 <term>
364305 <option>--fast</option>
365306 </term>
366307 <listitem>
367308 <para>
368− Equivalent to <option>--no-build-nix</option>
369− <option>--show-trace</option>. This option is useful if you call
370− <command>nixos-rebuild</command> frequently (e.g. if you’re hacking on
371− a NixOS module).
309+ Equivalent to <option>--no-build-nix</option> <option>--show-trace</option>. This option is useful if you call <command>nixos-rebuild</command> frequently (e.g. if you’re hacking on a NixOS module).
372310 </para>
373311 </listitem>
374312 </varlistentry>
375−
376313 <varlistentry>
377314 <term>
378315 <option>--rollback</option>
379316 </term>
380317 <listitem>
381318 <para>
382− Instead of building a new configuration as specified by
383− <filename>/etc/nixos/configuration.nix</filename>, roll back to the
384− previous configuration. (The previous configuration is defined as the one
385− before the “current” generation of the Nix profile
386− <filename>/nix/var/nix/profiles/system</filename>.)
319+ Instead of building a new configuration as specified by <filename>/etc/nixos/configuration.nix</filename>, roll back to the previous configuration. (The previous configuration is defined as the one before the “current” generation of the Nix profile <filename>/nix/var/nix/profiles/system</filename>.)
387320 </para>
388321 </listitem>
389322 </varlistentry>
390−
391323 <varlistentry>
392324 <term>
393325 <option>--builders</option> <replaceable>builder-spec</replaceable>
394326 </term>
395327 <listitem>
396328 <para>
397− Allow ad-hoc remote builders for building the new system. This requires
398− the user executing <command>nixos-rebuild</command> (usually root) to be
399− configured as a trusted user in the Nix daemon. This can be achieved by
400− using the <literal>nix.trustedUsers</literal> NixOS option. Examples
401− values for that option are described in the <literal>Remote builds
402− chapter</literal> in the Nix manual, (i.e. <command>--builders
403− "ssh://bigbrother x86_64-linux"</command>). By specifying an empty string
404− existing builders specified in <filename>/etc/nix/machines</filename> can
405− be ignored: <command>--builders ""</command> for example when they are
406− not reachable due to network connectivity.
329+ Allow ad-hoc remote builders for building the new system. This requires the user executing <command>nixos-rebuild</command> (usually root) to be configured as a trusted user in the Nix daemon. This can be achieved by using the <literal>nix.trustedUsers</literal> NixOS option. Examples values for that option are described in the <literal>Remote builds chapter</literal> in the Nix manual, (i.e. <command>--builders "ssh://bigbrother x86_64-linux"</command>). By specifying an empty string existing builders specified in <filename>/etc/nix/machines</filename> can be ignored: <command>--builders ""</command> for example when they are not reachable due to network connectivity.
407330 </para>
408331 </listitem>
409332 </varlistentry>
410−
411333 <varlistentry>
412334 <term>
413335 <option>--profile-name</option>
@@ -417,97 +339,56 @@
417339 </term>
418340 <listitem>
419341 <para>
420− Instead of using the Nix profile
421− <filename>/nix/var/nix/profiles/system</filename> to keep track of the
422− current and previous system configurations, use
423− <filename>/nix/var/nix/profiles/system-profiles/<replaceable>name</replaceable></filename>.
424− When you use GRUB 2, for every system profile created with this flag,
425− NixOS will create a submenu named “NixOS - Profile
426− '<replaceable>name</replaceable>'” in GRUB’s boot menu, containing
427− the current and previous configurations of this profile.
342+ Instead of using the Nix profile <filename>/nix/var/nix/profiles/system</filename> to keep track of the current and previous system configurations, use <filename>/nix/var/nix/profiles/system-profiles/<replaceable>name</replaceable></filename>. When you use GRUB 2, for every system profile created with this flag, NixOS will create a submenu named “NixOS - Profile '<replaceable>name</replaceable>'” in GRUB’s boot menu, containing the current and previous configurations of this profile.
428343 </para>
429344 <para>
430− For instance, if you want to test a configuration file named
431− <filename>test.nix</filename> without affecting the default system
432− profile, you would do:
345+ For instance, if you want to test a configuration file named <filename>test.nix</filename> without affecting the default system profile, you would do:
433346<screen>
434347<prompt>$ </prompt>nixos-rebuild switch -p test -I nixos-config=./test.nix
435348</screen>
436− The new configuration will appear in the GRUB 2 submenu “NixOS -
437− Profile 'test'”.
349+ The new configuration will appear in the GRUB 2 submenu “NixOS - Profile 'test'”.
438350 </para>
439351 </listitem>
440352 </varlistentry>
441−
442353 <varlistentry>
443354 <term>
444355 <option>--build-host</option>
445356 </term>
446357 <listitem>
447358 <para>
448− Instead of building the new configuration locally, use the specified host
449− to perform the build. The host needs to be accessible with ssh, and must
450− be able to perform Nix builds. If the option
451− <option>--target-host</option> is not set, the build will be copied back
452− to the local machine when done.
359+ Instead of building the new configuration locally, use the specified host to perform the build. The host needs to be accessible with ssh, and must be able to perform Nix builds. If the option <option>--target-host</option> is not set, the build will be copied back to the local machine when done.
453360 </para>
454361 <para>
455− Note that, if <option>--no-build-nix</option> is not specified, Nix will
456− be built both locally and remotely. This is because the configuration
457− will always be evaluated locally even though the building might be
458− performed remotely.
362+ Note that, if <option>--no-build-nix</option> is not specified, Nix will be built both locally and remotely. This is because the configuration will always be evaluated locally even though the building might be performed remotely.
459363 </para>
460364 <para>
461− You can include a remote user name in the host name
462− (<replaceable>user@host</replaceable>). You can also set ssh options by
463− defining the <envar>NIX_SSHOPTS</envar> environment variable.
365+ You can include a remote user name in the host name (<replaceable>user@host</replaceable>). You can also set ssh options by defining the <envar>NIX_SSHOPTS</envar> environment variable.
464366 </para>
465367 </listitem>
466368 </varlistentry>
467−
468369 <varlistentry>
469370 <term>
470371 <option>--target-host</option>
471372 </term>
472373 <listitem>
473374 <para>
474− Specifies the NixOS target host. By setting this to something other than
475− <replaceable>localhost</replaceable>, the system activation will happen
476− on the remote host instead of the local machine. The remote host needs to
477− be accessible over ssh, and for the commands <option>switch</option>,
478− <option>boot</option> and <option>test</option> you need root access.
375+ Specifies the NixOS target host. By setting this to something other than <replaceable>localhost</replaceable>, the system activation will happen on the remote host instead of the local machine. The remote host needs to be accessible over ssh, and for the commands <option>switch</option>, <option>boot</option> and <option>test</option> you need root access.
479376 </para>
480−
481377 <para>
482− If <option>--build-host</option> is not explicitly specified,
483− <option>--build-host</option> will implicitly be set to the same value as
484− <option>--target-host</option>. So, if you only specify
485− <option>--target-host</option> both building and activation will take
486− place remotely (and no build artifacts will be copied to the local
487− machine).
378+ If <option>--build-host</option> is not explicitly specified, <option>--build-host</option> will implicitly be set to the same value as <option>--target-host</option>. So, if you only specify <option>--target-host</option> both building and activation will take place remotely (and no build artifacts will be copied to the local machine).
488379 </para>
489−
490380 <para>
491− You can include a remote user name in the host name
492− (<replaceable>user@host</replaceable>). You can also set ssh options by
493− defining the <envar>NIX_SSHOPTS</envar> environment variable.
381+ You can include a remote user name in the host name (<replaceable>user@host</replaceable>). You can also set ssh options by defining the <envar>NIX_SSHOPTS</envar> environment variable.
494382 </para>
495383 </listitem>
496384 </varlistentry>
497385 </variablelist>
498−
499386 <para>
500− In addition, <command>nixos-rebuild</command> accepts various Nix-related
501− flags, including <option>--max-jobs</option> / <option>-j</option>,
502− <option>--show-trace</option>, <option>--keep-failed</option>,
503− <option>--keep-going</option> and <option>--verbose</option> /
504− <option>-v</option>. See the Nix manual for details.
387+ In addition, <command>nixos-rebuild</command> accepts various Nix-related flags, including <option>--max-jobs</option> / <option>-j</option>, <option>--show-trace</option>, <option>--keep-failed</option>, <option>--keep-going</option> and <option>--verbose</option> / <option>-v</option>. See the Nix manual for details.
505388 </para>
506389 </refsection>
507−
508390 <refsection>
509391 <title>Environment</title>
510−
511392 <variablelist>
512393 <varlistentry>
513394 <term>
@@ -515,31 +396,25 @@
515396 </term>
516397 <listitem>
517398 <para>
518− Path to the main NixOS configuration module. Defaults to
519− <filename>/etc/nixos/configuration.nix</filename>.
399+ Path to the main NixOS configuration module. Defaults to <filename>/etc/nixos/configuration.nix</filename>.
520400 </para>
521401 </listitem>
522402 </varlistentry>
523−
524403 <varlistentry>
525404 <term>
526405 <envar>NIX_SSHOPTS</envar>
527406 </term>
528407 <listitem>
529408 <para>
530− Additional options to be passed to <command>ssh</command> on the command
531− line.
409+ Additional options to be passed to <command>ssh</command> on the command line.
532410 </para>
533411 </listitem>
534412 </varlistentry>
535413 </variablelist>
536414 </refsection>
537−
538415 <refsection>
539416 <title>Files</title>
540−
541417 <variablelist>
542−
543418 <varlistentry>
544419 <term>
545420 <filename>/run/current-system</filename>
@@ -550,22 +425,18 @@
550425 </para>
551426 </listitem>
552427 </varlistentry>
553−
554428 <varlistentry>
555429 <term>
556430 <filename>/nix/var/nix/profiles/system</filename>
557431 </term>
558432 <listitem>
559433 <para>
560− The Nix profile that contains the current and previous system
561− configurations. Used to generate the GRUB boot menu.
434+ The Nix profile that contains the current and previous system configurations. Used to generate the GRUB boot menu.
562435 </para>
563436 </listitem>
564437 </varlistentry>
565−
566438 </variablelist>
567439 </refsection>
568−
569440 <refsection>
570441 <title>Bugs</title>
571442 <para>
nixos/doc/manual/man-nixos-version.xml+6−17
@@ -25,8 +25,7 @@
2525 <refsection>
2626 <title>Description</title>
2727 <para>
28− This command shows the version of the currently active NixOS configuration.
29− For example:
28+ This command shows the version of the currently active NixOS configuration. For example:
3029<screen>$ nixos-version
313016.03.1011.6317da4 (Emu)
3231</screen>
@@ -38,8 +37,7 @@
3837 </term>
3938 <listitem>
4039 <para>
41− The NixOS release, indicating the year and month in which it was
42− released (e.g. March 2016).
40+ The NixOS release, indicating the year and month in which it was released (e.g. March 2016).
4341 </para>
4442 </listitem>
4543 </varlistentry>
@@ -49,12 +47,7 @@
4947 </term>
5048 <listitem>
5149 <para>
52− The number of commits in the Nixpkgs Git repository between the start of
53− the release branch and the commit from which this version was built.
54− This ensures that NixOS versions are monotonically increasing. It is
55− <literal>git</literal> when the current NixOS configuration was built
56− from a checkout of the Nixpkgs Git repository rather than from a NixOS
57− channel.
50+ The number of commits in the Nixpkgs Git repository between the start of the release branch and the commit from which this version was built. This ensures that NixOS versions are monotonically increasing. It is <literal>git</literal> when the current NixOS configuration was built from a checkout of the Nixpkgs Git repository rather than from a NixOS channel.
5851 </para>
5952 </listitem>
6053 </varlistentry>
@@ -64,8 +57,7 @@
6457 </term>
6558 <listitem>
6659 <para>
67− The first 7 characters of the commit in the Nixpkgs Git repository from
68− which this version was built.
60+ The first 7 characters of the commit in the Nixpkgs Git repository from which this version was built.
6961 </para>
7062 </listitem>
7163 </varlistentry>
@@ -75,9 +67,7 @@
7567 </term>
7668 <listitem>
7769 <para>
78− The code name of the NixOS release. The first letter of the code name
79− indicates that this is the N'th stable NixOS release; for example, Emu
80− is the fifth release.
70+ The code name of the NixOS release. The first letter of the code name indicates that this is the N'th stable NixOS release; for example, Emu is the fifth release.
8171 </para>
8272 </listitem>
8373 </varlistentry>
@@ -99,8 +89,7 @@
9989 </term>
10090 <listitem>
10191 <para>
102− Show the full SHA1 hash of the Git commit from which this configuration
103− was built, e.g.
92+ Show the full SHA1 hash of the Git commit from which this configuration was built, e.g.
10493<screen>$ nixos-version --hash
105946317da40006f6bc2480c6781999c52d88dde2acf
10695</screen>
nixos/doc/manual/manual.xml+6−15
@@ -11,26 +11,17 @@
1111 <preface xml:id="preface">
1212 <title>Preface</title>
1313 <para>
14− This manual describes how to install, use and extend NixOS, a Linux
15− distribution based on the purely functional package management system Nix.
14+ This manual describes how to install, use and extend NixOS, a Linux distribution based on the purely functional package management system Nix.
1615 </para>
1716 <para>
18− If you encounter problems, please report them on the
19− <literal
20− xlink:href="https://discourse.nixos.org">Discourse</literal> or
21− on the <link
22− xlink:href="irc://irc.freenode.net/#nixos">
23− <literal>#nixos</literal> channel on Freenode</link>. Bugs should be
24− reported in
25− <link
26− xlink:href="https://github.com/NixOS/nixpkgs/issues">NixOS’
27− GitHub issue tracker</link>.
17+ If you encounter problems, please report them on the <literal
18+ xlink:href="https://discourse.nixos.org">Discourse</literal> or on the <link
19+ xlink:href="irc://irc.freenode.net/#nixos"> <literal>#nixos</literal> channel on Freenode</link>. Bugs should be reported in <link
20+ xlink:href="https://github.com/NixOS/nixpkgs/issues">NixOS’ GitHub issue tracker</link>.
2821 </para>
2922 <note>
3023 <para>
31− Commands prefixed with <literal>#</literal> have to be run as root, either
32− requiring to login as root user or temporarily switching to it using
33− <literal>sudo</literal> for example.
24+ Commands prefixed with <literal>#</literal> have to be run as root, either requiring to login as root user or temporarily switching to it using <literal>sudo</literal> for example.
3425 </para>
3526 </note>
3627 </preface>
nixos/doc/manual/release-notes/release-notes.xml+1−2
@@ -5,8 +5,7 @@
55 xml:id="ch-release-notes">
66 <title>Release Notes</title>
77 <para>
8− This section lists the release notes for each stable version of NixOS and
9− current unstable revision.
8+ This section lists the release notes for each stable version of NixOS and current unstable revision.
109 </para>
1110 <xi:include href="rl-2003.xml" />
1211 <xi:include href="rl-1909.xml" />
nixos/doc/manual/release-notes/rl-1404.xml+17−66
@@ -6,23 +6,16 @@
66 <title>Release 14.04 (“Baboon”, 2014/04/30)</title>
77
88 <para>
9− This is the second stable release branch of NixOS. In addition to numerous
10− new and upgraded packages and modules, this release has the following
11− highlights:
9+ This is the second stable release branch of NixOS. In addition to numerous new and upgraded packages and modules, this release has the following highlights:
1210 <itemizedlist>
1311 <listitem>
1412 <para>
15− Installation on UEFI systems is now supported. See
16− <xref linkend="sec-installation"/> for details.
13+ Installation on UEFI systems is now supported. See <xref linkend="sec-installation"/> for details.
1714 </para>
1815 </listitem>
1916 <listitem>
2017 <para>
21− Systemd has been updated to version 212, which has
22− <link xlink:href="http://cgit.freedesktop.org/systemd/systemd/plain/NEWS?id=v212">numerous
23− improvements</link>. NixOS now automatically starts systemd user instances
24− when you log in. You can define global user units through the
25− <option>systemd.unit.*</option> options.
18+ Systemd has been updated to version 212, which has <link xlink:href="http://cgit.freedesktop.org/systemd/systemd/plain/NEWS?id=v212">numerous improvements</link>. NixOS now automatically starts systemd user instances when you log in. You can define global user units through the <option>systemd.unit.*</option> options.
2619 </para>
2720 </listitem>
2821 <listitem>
@@ -47,47 +40,28 @@
4740 </listitem>
4841 <listitem>
4942 <para>
50− Nix has been updated to 1.7
51− (<link
43+ Nix has been updated to 1.7 (<link
5244 xlink:href="http://nixos.org/nix/manual/#ssec-relnotes-1.7">details</link>).
5345 </para>
5446 </listitem>
5547 <listitem>
5648 <para>
57− NixOS now supports fully declarative management of users and groups. If
58− you set <option>users.mutableUsers</option> to <literal>false</literal>,
59− then the contents of <filename>/etc/passwd</filename> and
60− <filename>/etc/group</filename> will be
61− <link
62− xlink:href="https://www.usenix.org/legacy/event/lisa02/tech/full_papers/traugott/traugott_html/">congruent</link>
63− to your NixOS configuration. For instance, if you remove a user from
64− <option>users.extraUsers</option> and run
65− <command>nixos-rebuild</command>, the user account will cease to exist.
66− Also, imperative commands for managing users and groups, such as
67− <command>useradd</command>, are no longer available. If
68− <option>users.mutableUsers</option> is <literal>true</literal> (the
69− default), then behaviour is unchanged from NixOS 13.10.
49+ NixOS now supports fully declarative management of users and groups. If you set <option>users.mutableUsers</option> to <literal>false</literal>, then the contents of <filename>/etc/passwd</filename> and <filename>/etc/group</filename> will be <link
50+ xlink:href="https://www.usenix.org/legacy/event/lisa02/tech/full_papers/traugott/traugott_html/">congruent</link> to your NixOS configuration. For instance, if you remove a user from <option>users.extraUsers</option> and run <command>nixos-rebuild</command>, the user account will cease to exist. Also, imperative commands for managing users and groups, such as <command>useradd</command>, are no longer available. If <option>users.mutableUsers</option> is <literal>true</literal> (the default), then behaviour is unchanged from NixOS 13.10.
7051 </para>
7152 </listitem>
7253 <listitem>
7354 <para>
74− NixOS now has basic container support, meaning you can easily run a NixOS
75− instance as a container in a NixOS host system. These containers are
76− suitable for testing and experimentation but not production use, since
77− they’re not fully isolated from the host. See
78− <xref linkend="ch-containers"/> for details.
55+ NixOS now has basic container support, meaning you can easily run a NixOS instance as a container in a NixOS host system. These containers are suitable for testing and experimentation but not production use, since they’re not fully isolated from the host. See <xref linkend="ch-containers"/> for details.
7956 </para>
8057 </listitem>
8158 <listitem>
8259 <para>
83− Systemd units provided by packages can now be overridden from the NixOS
84− configuration. For instance, if a package <literal>foo</literal> provides
85− systemd units, you can say:
60+ Systemd units provided by packages can now be overridden from the NixOS configuration. For instance, if a package <literal>foo</literal> provides systemd units, you can say:
8661<programlisting>
8762systemd.packages = [ pkgs.foo ];
8863</programlisting>
89− to enable those units. You can then set or override unit options in the
90− usual way, e.g.
64+ to enable those units. You can then set or override unit options in the usual way, e.g.
9165<programlisting>
9266systemd.services.foo.wantedBy = [ "multi-user.target" ];
9367systemd.services.foo.serviceConfig.MemoryLimit = "512M";
@@ -98,14 +72,11 @@ systemd.services.foo.serviceConfig.MemoryLimit = "512M";
9872 </para>
9973
10074 <para>
101− When upgrading from a previous release, please be aware of the following
102− incompatible changes:
75+ When upgrading from a previous release, please be aware of the following incompatible changes:
10376 <itemizedlist>
10477 <listitem>
10578 <para>
106− Nixpkgs no longer exposes unfree packages by default. If your NixOS
107− configuration requires unfree packages from Nixpkgs, you need to enable
108− support for them explicitly by setting:
79+ Nixpkgs no longer exposes unfree packages by default. If your NixOS configuration requires unfree packages from Nixpkgs, you need to enable support for them explicitly by setting:
10980<programlisting>
11081nixpkgs.config.allowUnfree = true;
11182</programlisting>
@@ -118,8 +89,7 @@ error: package ‘nvidia-x11-331.49-3.12.17’ in ‘…/nvidia-x11/default.nix:
11889 </listitem>
11990 <listitem>
12091 <para>
121− The Adobe Flash player is no longer enabled by default in the Firefox and
122− Chromium wrappers. To enable it, you must set:
92+ The Adobe Flash player is no longer enabled by default in the Firefox and Chromium wrappers. To enable it, you must set:
12393<programlisting>
12494nixpkgs.config.allowUnfree = true;
12595nixpkgs.config.firefox.enableAdobeFlash = true; # for Firefox
@@ -129,8 +99,7 @@ nixpkgs.config.chromium.enableAdobeFlash = true; # for Chromium
12999 </listitem>
130100 <listitem>
131101 <para>
132− The firewall is now enabled by default. If you don’t want this, you need
133− to disable it explicitly:
102+ The firewall is now enabled by default. If you don’t want this, you need to disable it explicitly:
134103<programlisting>
135104networking.firewall.enable = false;
136105</programlisting>
@@ -138,40 +107,22 @@ networking.firewall.enable = false;
138107 </listitem>
139108 <listitem>
140109 <para>
141− The option <option>boot.loader.grub.memtest86</option> has been renamed to
142− <option>boot.loader.grub.memtest86.enable</option>.
110+ The option <option>boot.loader.grub.memtest86</option> has been renamed to <option>boot.loader.grub.memtest86.enable</option>.
143111 </para>
144112 </listitem>
145113 <listitem>
146114 <para>
147− The <literal>mysql55</literal> service has been merged into the
148− <literal>mysql</literal> service, which no longer sets a default for the
149− option <option>services.mysql.package</option>.
115+ The <literal>mysql55</literal> service has been merged into the <literal>mysql</literal> service, which no longer sets a default for the option <option>services.mysql.package</option>.
150116 </para>
151117 </listitem>
152118 <listitem>
153119 <para>
154− Package variants are now differentiated by suffixing the name, rather than
155− the version. For instance, <filename>sqlite-3.8.4.3-interactive</filename>
156− is now called <filename>sqlite-interactive-3.8.4.3</filename>. This
157− ensures that <literal>nix-env -i sqlite</literal> is unambiguous, and that
158− <literal>nix-env -u</literal> won’t “upgrade”
159− <literal>sqlite</literal> to <literal>sqlite-interactive</literal> or vice
160− versa. Notably, this change affects the Firefox wrapper (which provides
161− plugins), as it is now called <literal>firefox-wrapper</literal>. So when
162− using <command>nix-env</command>, you should do <literal>nix-env -e
163− firefox; nix-env -i firefox-wrapper</literal> if you want to keep using
164− the wrapper. This change does not affect declarative package management,
165− since attribute names like <literal>pkgs.firefoxWrapper</literal> were
166− already unambiguous.
120+ Package variants are now differentiated by suffixing the name, rather than the version. For instance, <filename>sqlite-3.8.4.3-interactive</filename> is now called <filename>sqlite-interactive-3.8.4.3</filename>. This ensures that <literal>nix-env -i sqlite</literal> is unambiguous, and that <literal>nix-env -u</literal> won’t “upgrade” <literal>sqlite</literal> to <literal>sqlite-interactive</literal> or vice versa. Notably, this change affects the Firefox wrapper (which provides plugins), as it is now called <literal>firefox-wrapper</literal>. So when using <command>nix-env</command>, you should do <literal>nix-env -e firefox; nix-env -i firefox-wrapper</literal> if you want to keep using the wrapper. This change does not affect declarative package management, since attribute names like <literal>pkgs.firefoxWrapper</literal> were already unambiguous.
167121 </para>
168122 </listitem>
169123 <listitem>
170124 <para>
171− The symlink <filename>/etc/ca-bundle.crt</filename> is gone. Programs
172− should instead use the environment variable
173− <envar>OPENSSL_X509_CERT_FILE</envar> (which points to
174− <filename>/etc/ssl/certs/ca-bundle.crt</filename>).
125+ The symlink <filename>/etc/ca-bundle.crt</filename> is gone. Programs should instead use the environment variable <envar>OPENSSL_X509_CERT_FILE</envar> (which points to <filename>/etc/ssl/certs/ca-bundle.crt</filename>).
175126 </para>
176127 </listitem>
177128 </itemizedlist>
nixos/doc/manual/release-notes/rl-1412.xml+19−62
@@ -6,19 +6,16 @@
66 <title>Release 14.12 (“Caterpillar”, 2014/12/30)</title>
77
88 <para>
9− In addition to numerous new and upgraded packages, this release has the
10− following highlights:
9+ In addition to numerous new and upgraded packages, this release has the following highlights:
1110 <itemizedlist>
1211 <listitem>
1312 <para>
14− Systemd has been updated to version 217, which has numerous
15− <link xlink:href="http://lists.freedesktop.org/archives/systemd-devel/2014-October/024662.html">improvements.</link>
13+ Systemd has been updated to version 217, which has numerous <link xlink:href="http://lists.freedesktop.org/archives/systemd-devel/2014-October/024662.html">improvements.</link>
1614 </para>
1715 </listitem>
1816 <listitem>
1917 <para>
20− <link xlink:href="https://www.mail-archive.com/nix-dev@lists.science.uu.nl/msg13957.html">
21− Nix has been updated to 1.8.</link>
18+ <link xlink:href="https://www.mail-archive.com/nix-dev@lists.science.uu.nl/msg13957.html"> Nix has been updated to 1.8.</link>
2219 </para>
2320 </listitem>
2421 <listitem>
@@ -38,13 +35,7 @@
3835 </listitem>
3936 <listitem>
4037 <para>
41− If <option>users.mutableUsers</option> is enabled (the default), changes
42− made to the declaration of a user or group will be correctly realised when
43− running <command>nixos-rebuild</command>. For instance, removing a user
44− specification from <filename>configuration.nix</filename> will cause the
45− actual user account to be deleted. If <option>users.mutableUsers</option>
46− is disabled, it is no longer necessary to specify UIDs or GIDs; if
47− omitted, they are allocated dynamically.
38+ If <option>users.mutableUsers</option> is enabled (the default), changes made to the declaration of a user or group will be correctly realised when running <command>nixos-rebuild</command>. For instance, removing a user specification from <filename>configuration.nix</filename> will cause the actual user account to be deleted. If <option>users.mutableUsers</option> is disabled, it is no longer necessary to specify UIDs or GIDs; if omitted, they are allocated dynamically.
4839 </para>
4940 </listitem>
5041 </itemizedlist>
@@ -362,18 +353,12 @@
362353 </para>
363354
364355 <para>
365− When upgrading from a previous release, please be aware of the following
366− incompatible changes:
356+ When upgrading from a previous release, please be aware of the following incompatible changes:
367357 <itemizedlist>
368358 <listitem>
369359 <para>
370− The default version of Apache httpd is now 2.4. If you use the
371− <option>extraConfig</option> option to pass literal Apache configuration
372− text, you may need to update it — see
373− <link
374−xlink:href="http://httpd.apache.org/docs/2.4/upgrading.html">Apache’s
375− documentation</link> for details. If you wish to continue to use httpd
376− 2.2, add the following line to your NixOS configuration:
360+ The default version of Apache httpd is now 2.4. If you use the <option>extraConfig</option> option to pass literal Apache configuration text, you may need to update it — see <link
361+xlink:href="http://httpd.apache.org/docs/2.4/upgrading.html">Apache’s documentation</link> for details. If you wish to continue to use httpd 2.2, add the following line to your NixOS configuration:
377362<programlisting>
378363services.httpd.package = pkgs.apacheHttpd_2_2;
379364</programlisting>
@@ -381,85 +366,57 @@ services.httpd.package = pkgs.apacheHttpd_2_2;
381366 </listitem>
382367 <listitem>
383368 <para>
384− PHP 5.3 has been removed because it is no longer supported by the PHP
385− project. A <link
386−xlink:href="http://php.net/migration54">migration
387− guide</link> is available.
369+ PHP 5.3 has been removed because it is no longer supported by the PHP project. A <link
370+xlink:href="http://php.net/migration54">migration guide</link> is available.
388371 </para>
389372 </listitem>
390373 <listitem>
391374 <para>
392− The host side of a container virtual Ethernet pair is now called
393− <literal>ve-<replaceable>container-name</replaceable></literal> rather
394− than <literal>c-<replaceable>container-name</replaceable></literal>.
375+ The host side of a container virtual Ethernet pair is now called <literal>ve-<replaceable>container-name</replaceable></literal> rather than <literal>c-<replaceable>container-name</replaceable></literal>.
395376 </para>
396377 </listitem>
397378 <listitem>
398379 <para>
399− GNOME 3.10 support has been dropped. The default GNOME version is now
400− 3.12.
380+ GNOME 3.10 support has been dropped. The default GNOME version is now 3.12.
401381 </para>
402382 </listitem>
403383 <listitem>
404384 <para>
405− VirtualBox has been upgraded to 4.3.20 release. Users may be required to
406− run <command>rm -rf /tmp/.vbox*</command>. The line <literal>imports = [
407− &lt;nixpkgs/nixos/modules/programs/virtualbox.nix&gt; ]</literal> is no
408− longer necessary, use <literal>services.virtualboxHost.enable =
409− true</literal> instead.
385+ VirtualBox has been upgraded to 4.3.20 release. Users may be required to run <command>rm -rf /tmp/.vbox*</command>. The line <literal>imports = [ &lt;nixpkgs/nixos/modules/programs/virtualbox.nix&gt; ]</literal> is no longer necessary, use <literal>services.virtualboxHost.enable = true</literal> instead.
410386 </para>
411387 <para>
412− Also, hardening mode is now enabled by default, which means that unless
413− you want to use USB support, you no longer need to be a member of the
414− <literal>vboxusers</literal> group.
388+ Also, hardening mode is now enabled by default, which means that unless you want to use USB support, you no longer need to be a member of the <literal>vboxusers</literal> group.
415389 </para>
416390 </listitem>
417391 <listitem>
418392 <para>
419− Chromium has been updated to 39.0.2171.65.
420− <option>enablePepperPDF</option> is now enabled by default.
421− <literal>chromium*Wrapper</literal> packages no longer exist, because
422− upstream removed NSAPI support. <literal>chromium-stable</literal> has
423− been renamed to <literal>chromium</literal>.
393+ Chromium has been updated to 39.0.2171.65. <option>enablePepperPDF</option> is now enabled by default. <literal>chromium*Wrapper</literal> packages no longer exist, because upstream removed NSAPI support. <literal>chromium-stable</literal> has been renamed to <literal>chromium</literal>.
424394 </para>
425395 </listitem>
426396 <listitem>
427397 <para>
428− Python packaging documentation is now part of nixpkgs manual. To override
429− the python packages available to a custom python you now use
430− <literal>pkgs.pythonFull.buildEnv.override</literal> instead of
431− <literal>pkgs.pythonFull.override</literal>.
398+ Python packaging documentation is now part of nixpkgs manual. To override the python packages available to a custom python you now use <literal>pkgs.pythonFull.buildEnv.override</literal> instead of <literal>pkgs.pythonFull.override</literal>.
432399 </para>
433400 </listitem>
434401 <listitem>
435402 <para>
436− <literal>boot.resumeDevice = "8:6"</literal> is no longer supported. Most
437− users will want to leave it undefined, which takes the swap partitions
438− automatically. There is an evaluation assertion to ensure that the string
439− starts with a slash.
403+ <literal>boot.resumeDevice = "8:6"</literal> is no longer supported. Most users will want to leave it undefined, which takes the swap partitions automatically. There is an evaluation assertion to ensure that the string starts with a slash.
440404 </para>
441405 </listitem>
442406 <listitem>
443407 <para>
444− The system-wide default timezone for NixOS installations changed from
445− <literal>CET</literal> to <literal>UTC</literal>. To choose a different
446− timezone for your system, configure <literal>time.timeZone</literal> in
447− <literal>configuration.nix</literal>. A fairly complete list of possible
448− values for that setting is available at
449− <link
408+ The system-wide default timezone for NixOS installations changed from <literal>CET</literal> to <literal>UTC</literal>. To choose a different timezone for your system, configure <literal>time.timeZone</literal> in <literal>configuration.nix</literal>. A fairly complete list of possible values for that setting is available at <link
450409xlink:href="https://en.wikipedia.org/wiki/List_of_tz_database_time_zones"/>.
451410 </para>
452411 </listitem>
453412 <listitem>
454413 <para>
455− GNU screen has been updated to 4.2.1, which breaks the ability to connect
456− to sessions created by older versions of screen.
414+ GNU screen has been updated to 4.2.1, which breaks the ability to connect to sessions created by older versions of screen.
457415 </para>
458416 </listitem>
459417 <listitem>
460418 <para>
461− The Intel GPU driver was updated to the 3.x prerelease version (used by
462− most distributions) and supports DRI3 now.
419+ The Intel GPU driver was updated to the 3.x prerelease version (used by most distributions) and supports DRI3 now.
463420 </para>
464421 </listitem>
465422 </itemizedlist>
nixos/doc/manual/release-notes/rl-1509.xml+45−163
@@ -6,42 +6,23 @@
66 <title>Release 15.09 (“Dingo”, 2015/09/30)</title>
77
88 <para>
9− In addition to numerous new and upgraded packages, this release has the
10− following highlights:
9+ In addition to numerous new and upgraded packages, this release has the following highlights:
1110 </para>
1211
1312 <itemizedlist>
1413 <listitem>
1514 <para>
16− The <link xlink:href="http://haskell.org/">Haskell</link> packages
17− infrastructure has been re-designed from the ground up (&quot;Haskell
18− NG&quot;). NixOS now distributes the latest version of every single package
19− registered on
20− <link
21− xlink:href="http://hackage.haskell.org/">Hackage</link> -- well
22− in excess of 8,000 Haskell packages. Detailed instructions on how to use
23− that infrastructure can be found in the
24− <link
25− xlink:href="http://nixos.org/nixpkgs/manual/#users-guide-to-the-haskell-infrastructure">User's
26− Guide to the Haskell Infrastructure</link>. Users migrating from an earlier
27− release may find helpful information below, in the list of
28− backwards-incompatible changes. Furthermore, we distribute 51(!) additional
29− Haskell package sets that provide every single
30− <link
31− xlink:href="http://www.stackage.org/">LTS Haskell</link> release
32− since version 0.0 as well as the most recent
33− <link
34− xlink:href="http://www.stackage.org/">Stackage Nightly</link>
35− snapshot. The announcement
36− <link
37− xlink:href="https://nixos.org/nix-dev/2015-September/018138.html">&quot;Full
38− Stackage Support in Nixpkgs&quot;</link> gives additional details.
15+ The <link xlink:href="http://haskell.org/">Haskell</link> packages infrastructure has been re-designed from the ground up (&quot;Haskell NG&quot;). NixOS now distributes the latest version of every single package registered on <link
16+ xlink:href="http://hackage.haskell.org/">Hackage</link> -- well in excess of 8,000 Haskell packages. Detailed instructions on how to use that infrastructure can be found in the <link
17+ xlink:href="http://nixos.org/nixpkgs/manual/#users-guide-to-the-haskell-infrastructure">User's Guide to the Haskell Infrastructure</link>. Users migrating from an earlier release may find helpful information below, in the list of backwards-incompatible changes. Furthermore, we distribute 51(!) additional Haskell package sets that provide every single <link
18+ xlink:href="http://www.stackage.org/">LTS Haskell</link> release since version 0.0 as well as the most recent <link
19+ xlink:href="http://www.stackage.org/">Stackage Nightly</link> snapshot. The announcement <link
20+ xlink:href="https://nixos.org/nix-dev/2015-September/018138.html">&quot;Full Stackage Support in Nixpkgs&quot;</link> gives additional details.
3921 </para>
4022 </listitem>
4123 <listitem>
4224 <para>
43− Nix has been updated to version 1.10, which among other improvements
44− enables cryptographic signatures on binary caches for improved security.
25+ Nix has been updated to version 1.10, which among other improvements enables cryptographic signatures on binary caches for improved security.
4526 </para>
4627 </listitem>
4728 <listitem>
@@ -50,8 +31,7 @@
5031<programlisting>
5132system.autoUpgrade.enable = true;
5233</programlisting>
53− This will cause the system to periodically check for updates in your
54− current channel and run <command>nixos-rebuild</command>.
34+ This will cause the system to periodically check for updates in your current channel and run <command>nixos-rebuild</command>.
5535 </para>
5636 </listitem>
5737 <listitem>
@@ -71,8 +51,7 @@ system.autoUpgrade.enable = true;
7151 </listitem>
7252 <listitem>
7353 <para>
74− KDE 5 has been upgraded to KDE Frameworks 5.10, Plasma 5.3.2 and
75− Applications 15.04.3. KDE 4 has been updated to kdelibs-4.14.10.
54+ KDE 5 has been upgraded to KDE Frameworks 5.10, Plasma 5.3.2 and Applications 15.04.3. KDE 4 has been updated to kdelibs-4.14.10.
7655 </para>
7756 </listitem>
7857 <listitem>
@@ -424,93 +403,61 @@ system.autoUpgrade.enable = true;
424403 </para>
425404
426405 <para>
427− When upgrading from a previous release, please be aware of the following
428− incompatible changes:
406+ When upgrading from a previous release, please be aware of the following incompatible changes:
429407 <itemizedlist>
430408 <listitem>
431409 <para>
432− <command>sshd</command> no longer supports DSA and ECDSA host keys by
433− default. If you have existing systems with such host keys and want to
434− continue to use them, please set
410+ <command>sshd</command> no longer supports DSA and ECDSA host keys by default. If you have existing systems with such host keys and want to continue to use them, please set
435411<programlisting>
436412system.stateVersion = "14.12";
437413</programlisting>
438− The new option <option>system.stateVersion</option> ensures that certain
439− configuration changes that could break existing systems (such as the
440− <command>sshd</command> host key setting) will maintain compatibility with
441− the specified NixOS release. NixOps sets the state version of existing
442− deployments automatically.
414+ The new option <option>system.stateVersion</option> ensures that certain configuration changes that could break existing systems (such as the <command>sshd</command> host key setting) will maintain compatibility with the specified NixOS release. NixOps sets the state version of existing deployments automatically.
443415 </para>
444416 </listitem>
445417 <listitem>
446418 <para>
447− <command>cron</command> is no longer enabled by default, unless you have a
448− non-empty <option>services.cron.systemCronJobs</option>. To force
449− <command>cron</command> to be enabled, set <option>services.cron.enable =
450− true</option>.
419+ <command>cron</command> is no longer enabled by default, unless you have a non-empty <option>services.cron.systemCronJobs</option>. To force <command>cron</command> to be enabled, set <option>services.cron.enable = true</option>.
451420 </para>
452421 </listitem>
453422 <listitem>
454423 <para>
455− Nix now requires binary caches to be cryptographically signed. If you have
456− unsigned binary caches that you want to continue to use, you should set
457− <option>nix.requireSignedBinaryCaches = false</option>.
424+ Nix now requires binary caches to be cryptographically signed. If you have unsigned binary caches that you want to continue to use, you should set <option>nix.requireSignedBinaryCaches = false</option>.
458425 </para>
459426 </listitem>
460427 <listitem>
461428 <para>
462− Steam now doesn't need root rights to work. Instead of using
463− <literal>*-steam-chrootenv</literal>, you should now just run
464− <literal>steam</literal>. <literal>steamChrootEnv</literal> package was
465− renamed to <literal>steam</literal>, and old <literal>steam</literal>
466− package -- to <literal>steamOriginal</literal>.
429+ Steam now doesn't need root rights to work. Instead of using <literal>*-steam-chrootenv</literal>, you should now just run <literal>steam</literal>. <literal>steamChrootEnv</literal> package was renamed to <literal>steam</literal>, and old <literal>steam</literal> package -- to <literal>steamOriginal</literal>.
467430 </para>
468431 </listitem>
469432 <listitem>
470433 <para>
471− CMPlayer has been renamed to bomi upstream. Package
472− <literal>cmplayer</literal> was accordingly renamed to
473− <literal>bomi</literal>
434+ CMPlayer has been renamed to bomi upstream. Package <literal>cmplayer</literal> was accordingly renamed to <literal>bomi</literal>
474435 </para>
475436 </listitem>
476437 <listitem>
477438 <para>
478− Atom Shell has been renamed to Electron upstream. Package
479− <literal>atom-shell</literal> was accordingly renamed to
480− <literal>electron</literal>
439+ Atom Shell has been renamed to Electron upstream. Package <literal>atom-shell</literal> was accordingly renamed to <literal>electron</literal>
481440 </para>
482441 </listitem>
483442 <listitem>
484443 <para>
485− Elm is not released on Hackage anymore. You should now use
486− <literal>elmPackages.elm</literal> which contains the latest Elm platform.
444+ Elm is not released on Hackage anymore. You should now use <literal>elmPackages.elm</literal> which contains the latest Elm platform.
487445 </para>
488446 </listitem>
489447 <listitem>
490448 <para>
491− The CUPS printing service has been updated to version
492− <literal>2.0.2</literal>. Furthermore its systemd service has been renamed
493− to <literal>cups.service</literal>.
449+ The CUPS printing service has been updated to version <literal>2.0.2</literal>. Furthermore its systemd service has been renamed to <literal>cups.service</literal>.
494450 </para>
495451 <para>
496− Local printers are no longer shared or advertised by default. This
497− behavior can be changed by enabling
498− <option>services.printing.defaultShared</option> or
499− <option>services.printing.browsing</option> respectively.
452+ Local printers are no longer shared or advertised by default. This behavior can be changed by enabling <option>services.printing.defaultShared</option> or <option>services.printing.browsing</option> respectively.
500453 </para>
501454 </listitem>
502455 <listitem>
503456 <para>
504− The VirtualBox host and guest options have been named more consistently.
505− They can now found in <option>virtualisation.virtualbox.host.*</option>
506− instead of <option>services.virtualboxHost.*</option> and
507− <option>virtualisation.virtualbox.guest.*</option> instead of
508− <option>services.virtualboxGuest.*</option>.
457+ The VirtualBox host and guest options have been named more consistently. They can now found in <option>virtualisation.virtualbox.host.*</option> instead of <option>services.virtualboxHost.*</option> and <option>virtualisation.virtualbox.guest.*</option> instead of <option>services.virtualboxGuest.*</option>.
509458 </para>
510459 <para>
511− Also, there now is support for the <literal>vboxsf</literal> file system
512− using the <option>fileSystems</option> configuration attribute. An example
513− of how this can be used in a configuration:
460+ Also, there now is support for the <literal>vboxsf</literal> file system using the <option>fileSystems</option> configuration attribute. An example of how this can be used in a configuration:
514461<programlisting>
515462fileSystems."/shiny" = {
516463 device = "myshinysharedfolder";
@@ -521,15 +468,7 @@ fileSystems."/shiny" = {
521468 </listitem>
522469 <listitem>
523470 <para>
524− &quot;<literal>nix-env -qa</literal>&quot; no longer discovers Haskell
525− packages by name. The only packages visible in the global scope are
526− <literal>ghc</literal>, <literal>cabal-install</literal>, and
527− <literal>stack</literal>, but all other packages are hidden. The reason
528− for this inconvenience is the sheer size of the Haskell package set.
529− Name-based lookups are expensive, and most <literal>nix-env -qa</literal>
530− operations would become much slower if we'd add the entire Hackage
531− database into the top level attribute set. Instead, the list of Haskell
532− packages can be displayed by running:
471+ &quot;<literal>nix-env -qa</literal>&quot; no longer discovers Haskell packages by name. The only packages visible in the global scope are <literal>ghc</literal>, <literal>cabal-install</literal>, and <literal>stack</literal>, but all other packages are hidden. The reason for this inconvenience is the sheer size of the Haskell package set. Name-based lookups are expensive, and most <literal>nix-env -qa</literal> operations would become much slower if we'd add the entire Hackage database into the top level attribute set. Instead, the list of Haskell packages can be displayed by running:
533472 </para>
534473<programlisting>
535474nix-env -f &quot;&lt;nixpkgs&gt;&quot; -qaP -A haskellPackages
@@ -541,91 +480,56 @@ nix-env -f &quot;&lt;nixpkgs&gt;&quot; -qaP -A haskellPackages
541480nix-env -f &quot;&lt;nixpkgs&gt;&quot; -iA haskellPackages.pandoc
542481</programlisting>
543482 <para>
544− Installing Haskell <emphasis>libraries</emphasis> this way, however, is no
545− longer supported. See the next item for more details.
483+ Installing Haskell <emphasis>libraries</emphasis> this way, however, is no longer supported. See the next item for more details.
546484 </para>
547485 </listitem>
548486 <listitem>
549487 <para>
550− Previous versions of NixOS came with a feature called
551− <literal>ghc-wrapper</literal>, a small script that allowed GHC to
552− transparently pick up on libraries installed in the user's profile. This
553− feature has been deprecated; <literal>ghc-wrapper</literal> was removed
554− from the distribution. The proper way to register Haskell libraries with
555− the compiler now is the <literal>haskellPackages.ghcWithPackages</literal>
556− function. The
557− <link
558− xlink:href="http://nixos.org/nixpkgs/manual/#users-guide-to-the-haskell-infrastructure">User's
559− Guide to the Haskell Infrastructure</link> provides more information about
560− this subject.
488+ Previous versions of NixOS came with a feature called <literal>ghc-wrapper</literal>, a small script that allowed GHC to transparently pick up on libraries installed in the user's profile. This feature has been deprecated; <literal>ghc-wrapper</literal> was removed from the distribution. The proper way to register Haskell libraries with the compiler now is the <literal>haskellPackages.ghcWithPackages</literal> function. The <link
489+ xlink:href="http://nixos.org/nixpkgs/manual/#users-guide-to-the-haskell-infrastructure">User's Guide to the Haskell Infrastructure</link> provides more information about this subject.
561490 </para>
562491 </listitem>
563492 <listitem>
564493 <para>
565− All Haskell builds that have been generated with version 1.x of the
566− <literal>cabal2nix</literal> utility are now invalid and need to be
567− re-generated with a current version of <literal>cabal2nix</literal> to
568− function. The most recent version of this tool can be installed by running
569− <literal>nix-env -i cabal2nix</literal>.
494+ All Haskell builds that have been generated with version 1.x of the <literal>cabal2nix</literal> utility are now invalid and need to be re-generated with a current version of <literal>cabal2nix</literal> to function. The most recent version of this tool can be installed by running <literal>nix-env -i cabal2nix</literal>.
570495 </para>
571496 </listitem>
572497 <listitem>
573498 <para>
574− The <literal>haskellPackages</literal> set in Nixpkgs used to have a
575− function attribute called <literal>extension</literal> that users could
576− override in their <literal>~/.nixpkgs/config.nix</literal> files to
577− configure additional attributes, etc. That function still exists, but it's
578− now called <literal>overrides</literal>.
499+ The <literal>haskellPackages</literal> set in Nixpkgs used to have a function attribute called <literal>extension</literal> that users could override in their <literal>~/.nixpkgs/config.nix</literal> files to configure additional attributes, etc. That function still exists, but it's now called <literal>overrides</literal>.
579500 </para>
580501 </listitem>
581502 <listitem>
582503 <para>
583− The OpenBLAS library has been updated to version
584− <literal>0.2.14</literal>. Support for the
585− <literal>x86_64-darwin</literal> platform was added. Dynamic architecture
586− detection was enabled; OpenBLAS now selects microarchitecture-optimized
587− routines at runtime, so optimal performance is achieved without the need
588− to rebuild OpenBLAS locally. OpenBLAS has replaced ATLAS in most packages
589− which use an optimized BLAS or LAPACK implementation.
504+ The OpenBLAS library has been updated to version <literal>0.2.14</literal>. Support for the <literal>x86_64-darwin</literal> platform was added. Dynamic architecture detection was enabled; OpenBLAS now selects microarchitecture-optimized routines at runtime, so optimal performance is achieved without the need to rebuild OpenBLAS locally. OpenBLAS has replaced ATLAS in most packages which use an optimized BLAS or LAPACK implementation.
590505 </para>
591506 </listitem>
592507 <listitem>
593508 <para>
594− The <literal>phpfpm</literal> is now using the default PHP version
595− (<literal>pkgs.php</literal>) instead of PHP 5.4
596− (<literal>pkgs.php54</literal>).
509+ The <literal>phpfpm</literal> is now using the default PHP version (<literal>pkgs.php</literal>) instead of PHP 5.4 (<literal>pkgs.php54</literal>).
597510 </para>
598511 </listitem>
599512 <listitem>
600513 <para>
601− The <literal>locate</literal> service no longer indexes the Nix store by
602− default, preventing packages with potentially numerous versions from
603− cluttering the output. Indexing the store can be activated by setting
604− <option>services.locate.includeStore = true</option>.
514+ The <literal>locate</literal> service no longer indexes the Nix store by default, preventing packages with potentially numerous versions from cluttering the output. Indexing the store can be activated by setting <option>services.locate.includeStore = true</option>.
605515 </para>
606516 </listitem>
607517 <listitem>
608518 <para>
609− The Nix expression search path (<envar>NIX_PATH</envar>) no longer
610− contains <filename>/etc/nixos/nixpkgs</filename> by default. You can
611− override <envar>NIX_PATH</envar> by setting <option>nix.nixPath</option>.
519+ The Nix expression search path (<envar>NIX_PATH</envar>) no longer contains <filename>/etc/nixos/nixpkgs</filename> by default. You can override <envar>NIX_PATH</envar> by setting <option>nix.nixPath</option>.
612520 </para>
613521 </listitem>
614522 <listitem>
615523 <para>
616− Python 2.6 has been marked as broken (as it no longer receives security
617− updates from upstream).
524+ Python 2.6 has been marked as broken (as it no longer receives security updates from upstream).
618525 </para>
619526 </listitem>
620527 <listitem>
621528 <para>
622− Any use of module arguments such as <varname>pkgs</varname> to access
623− library functions, or to define <literal>imports</literal> attributes will
624− now lead to an infinite loop at the time of the evaluation.
529+ Any use of module arguments such as <varname>pkgs</varname> to access library functions, or to define <literal>imports</literal> attributes will now lead to an infinite loop at the time of the evaluation.
625530 </para>
626531 <para>
627− In case of an infinite loop, use the <command>--show-trace</command>
628− command line argument and read the line just above the error message.
532+ In case of an infinite loop, use the <command>--show-trace</command> command line argument and read the line just above the error message.
629533<screen>
630534<prompt>$ </prompt>nixos-rebuild build --show-trace
631535…
@@ -634,9 +538,7 @@ infinite recursion encountered
634538</screen>
635539 </para>
636540 <para>
637− Any use of <literal>pkgs.lib</literal>, should be replaced by
638− <varname>lib</varname>, after adding it as argument of the module. The
639− following module
541+ Any use of <literal>pkgs.lib</literal>, should be replaced by <varname>lib</varname>, after adding it as argument of the module. The following module
640542<programlisting>
641543{ config, pkgs, ... }:
642544
@@ -664,9 +566,7 @@ with lib;
664566</programlisting>
665567 </para>
666568 <para>
667− When <varname>pkgs</varname> is used to download other projects to import
668− their modules, and only in such cases, it should be replaced by
669− <literal>(import &lt;nixpkgs&gt; {})</literal>. The following module
569+ When <varname>pkgs</varname> is used to download other projects to import their modules, and only in such cases, it should be replaced by <literal>(import &lt;nixpkgs&gt; {})</literal>. The following module
670570<programlisting>
671571{ config, pkgs, ... }:
672572
@@ -706,43 +606,25 @@ in
706606 <itemizedlist>
707607 <listitem>
708608 <para>
709− The nixos and nixpkgs channels were unified, so one
710− <emphasis>can</emphasis> use <literal>nix-env -iA nixos.bash</literal>
711− instead of <literal>nix-env -iA nixos.pkgs.bash</literal>. See
712− <link xlink:href="https://github.com/NixOS/nixpkgs/commit/2cd7c1f198">the
713− commit</link> for details.
609+ The nixos and nixpkgs channels were unified, so one <emphasis>can</emphasis> use <literal>nix-env -iA nixos.bash</literal> instead of <literal>nix-env -iA nixos.pkgs.bash</literal>. See <link xlink:href="https://github.com/NixOS/nixpkgs/commit/2cd7c1f198">the commit</link> for details.
714610 </para>
715611 </listitem>
716612 <listitem>
717613 <para>
718− Users running an SSH server who worry about the quality of their
719− <literal>/etc/ssh/moduli</literal> file with respect to the
720− <link
721− xlink:href="https://stribika.github.io/2015/01/04/secure-secure-shell.html">vulnerabilities
722− discovered in the Diffie-Hellman key exchange</link> can now replace
723− OpenSSH's default version with one they generated themselves using the new
724− <option>services.openssh.moduliFile</option> option.
614+ Users running an SSH server who worry about the quality of their <literal>/etc/ssh/moduli</literal> file with respect to the <link
615+ xlink:href="https://stribika.github.io/2015/01/04/secure-secure-shell.html">vulnerabilities discovered in the Diffie-Hellman key exchange</link> can now replace OpenSSH's default version with one they generated themselves using the new <option>services.openssh.moduliFile</option> option.
725616 </para>
726617 </listitem>
727618 <listitem>
728619 <para>
729− A newly packaged TeX Live 2015 is provided in
730− <literal>pkgs.texlive</literal>, split into 6500 nix packages. For basic
731− user documentation see
732− <link xlink:href="https://github.com/NixOS/nixpkgs/blob/release-15.09/pkgs/tools/typesetting/tex/texlive/default.nix#L1"
733− >the
734− source</link>. Beware of
735− <link xlink:href="https://github.com/NixOS/nixpkgs/issues/9757"
736− >an
737− issue</link> when installing a too large package set. The plan is to
738− deprecate and maybe delete the original TeX packages until the next
739− release.
620+ A newly packaged TeX Live 2015 is provided in <literal>pkgs.texlive</literal>, split into 6500 nix packages. For basic user documentation see <link xlink:href="https://github.com/NixOS/nixpkgs/blob/release-15.09/pkgs/tools/typesetting/tex/texlive/default.nix#L1"
621+ >the source</link>. Beware of <link xlink:href="https://github.com/NixOS/nixpkgs/issues/9757"
622+ >an issue</link> when installing a too large package set. The plan is to deprecate and maybe delete the original TeX packages until the next release.
740623 </para>
741624 </listitem>
742625 <listitem>
743626 <para>
744− <option>buildEnv.env</option> on all Python interpreters is now available
745− for nix-shell interoperability.
627+ <option>buildEnv.env</option> on all Python interpreters is now available for nix-shell interoperability.
746628 </para>
747629 </listitem>
748630 </itemizedlist>
nixos/doc/manual/release-notes/rl-1603.xml+41−164
@@ -6,17 +6,14 @@
66 <title>Release 16.03 (“Emu”, 2016/03/31)</title>
77
88 <para>
9− In addition to numerous new and upgraded packages, this release has the
10− following highlights:
9+ In addition to numerous new and upgraded packages, this release has the following highlights:
1110 </para>
1211
1312 <itemizedlist>
1413 <listitem>
1514 <para>
16− Systemd 229, bringing
17− <link
18− xlink:href="https://github.com/systemd/systemd/blob/v229/NEWS">numerous
19− improvements</link> over 217.
15+ Systemd 229, bringing <link
16+ xlink:href="https://github.com/systemd/systemd/blob/v229/NEWS">numerous improvements</link> over 217.
2017 </para>
2118 </listitem>
2219 <listitem>
@@ -26,11 +23,8 @@
2623 </listitem>
2724 <listitem>
2825 <para>
29− GCC 5.3 (was 4.9). Note that GCC 5
30− <link
31− xlink:href="https://gcc.gnu.org/onlinedocs/libstdc++/manual/using_dual_abi.html">changes
32− the C++ ABI in an incompatible way</link>; this may cause problems if you
33− try to link objects compiled with different versions of GCC.
26+ GCC 5.3 (was 4.9). Note that GCC 5 <link
27+ xlink:href="https://gcc.gnu.org/onlinedocs/libstdc++/manual/using_dual_abi.html">changes the C++ ABI in an incompatible way</link>; this may cause problems if you try to link objects compiled with different versions of GCC.
3428 </para>
3529 </listitem>
3630 <listitem>
@@ -45,20 +39,10 @@
4539 </listitem>
4640 <listitem>
4741 <para>
48− Improved support for ensuring
49− <link
50− xlink:href="https://reproducible-builds.org/">bitwise
51− reproducible builds</link>. For example, <literal>stdenv</literal> now sets
52− the environment variable
53− <envar
54− xlink:href="https://reproducible-builds.org/specs/source-date-epoch/">SOURCE_DATE_EPOCH</envar>
55− to a deterministic value, and Nix has
56− <link
57− xlink:href="http://nixos.org/nix/manual/#ssec-relnotes-1.11">gained
58− an option</link> to repeat a build a number of times to test determinism.
59− An ongoing project, the goal of exact reproducibility is to allow binaries
60− to be verified independently (e.g., a user might only trust binaries that
61− appear in three independent binary caches).
42+ Improved support for ensuring <link
43+ xlink:href="https://reproducible-builds.org/">bitwise reproducible builds</link>. For example, <literal>stdenv</literal> now sets the environment variable <envar
44+ xlink:href="https://reproducible-builds.org/specs/source-date-epoch/">SOURCE_DATE_EPOCH</envar> to a deterministic value, and Nix has <link
45+ xlink:href="http://nixos.org/nix/manual/#ssec-relnotes-1.11">gained an option</link> to repeat a build a number of times to test determinism. An ongoing project, the goal of exact reproducibility is to allow binaries to be verified independently (e.g., a user might only trust binaries that appear in three independent binary caches).
6246 </para>
6347 </listitem>
6448 <listitem>
@@ -335,56 +319,38 @@
335319 </para>
336320
337321 <para>
338− When upgrading from a previous release, please be aware of the following
339− incompatible changes:
322+ When upgrading from a previous release, please be aware of the following incompatible changes:
340323 </para>
341324
342325 <itemizedlist>
343326 <listitem>
344327 <para>
345− We no longer produce graphical ISO images and VirtualBox images for
346− <literal>i686-linux</literal>. A minimal ISO image is still provided.
328+ We no longer produce graphical ISO images and VirtualBox images for <literal>i686-linux</literal>. A minimal ISO image is still provided.
347329 </para>
348330 </listitem>
349331 <listitem>
350332 <para>
351− Firefox and similar browsers are now <emphasis>wrapped by
352− default</emphasis>. The package and attribute names are plain
353− <literal>firefox</literal> or <literal>midori</literal>, etc.
354− Backward-compatibility attributes were set up, but note that
355− <command>nix-env -u</command> will <emphasis>not</emphasis> update your
356− current <literal>firefox-with-plugins</literal>; you have to uninstall it
357− and install <literal>firefox</literal> instead.
333+ Firefox and similar browsers are now <emphasis>wrapped by default</emphasis>. The package and attribute names are plain <literal>firefox</literal> or <literal>midori</literal>, etc. Backward-compatibility attributes were set up, but note that <command>nix-env -u</command> will <emphasis>not</emphasis> update your current <literal>firefox-with-plugins</literal>; you have to uninstall it and install <literal>firefox</literal> instead.
358334 </para>
359335 </listitem>
360336 <listitem>
361337 <para>
362− <command>wmiiSnap</command> has been replaced with
363− <command>wmii_hg</command>, but
364− <command>services.xserver.windowManager.wmii.enable</command> has been
365− updated respectively so this only affects you if you have explicitly
366− installed <command>wmiiSnap</command>.
338+ <command>wmiiSnap</command> has been replaced with <command>wmii_hg</command>, but <command>services.xserver.windowManager.wmii.enable</command> has been updated respectively so this only affects you if you have explicitly installed <command>wmiiSnap</command>.
367339 </para>
368340 </listitem>
369341 <listitem>
370342 <para>
371− <literal>jobs</literal> NixOS option has been removed. It served as
372− compatibility layer between Upstart jobs and SystemD services. All services
373− have been rewritten to use <literal>systemd.services</literal>
343+ <literal>jobs</literal> NixOS option has been removed. It served as compatibility layer between Upstart jobs and SystemD services. All services have been rewritten to use <literal>systemd.services</literal>
374344 </para>
375345 </listitem>
376346 <listitem>
377347 <para>
378− <command>wmiimenu</command> is removed, as it has been removed by the
379− developers upstream. Use <command>wimenu</command> from the
380− <command>wmii-hg</command> package.
348+ <command>wmiimenu</command> is removed, as it has been removed by the developers upstream. Use <command>wimenu</command> from the <command>wmii-hg</command> package.
381349 </para>
382350 </listitem>
383351 <listitem>
384352 <para>
385− Gitit is no longer automatically added to the module list in NixOS and as
386− such there will not be any manual entries for it. You will need to add an
387− import statement to your NixOS configuration in order to use it, e.g.
353+ Gitit is no longer automatically added to the module list in NixOS and as such there will not be any manual entries for it. You will need to add an import statement to your NixOS configuration in order to use it, e.g.
388354<programlisting><![CDATA[
389355{
390356 imports = [ <nixpkgs/nixos/modules/services/misc/gitit.nix> ];
@@ -395,10 +361,7 @@
395361 </listitem>
396362 <listitem>
397363 <para>
398− <command>nginx</command> does not accept flags for enabling and disabling
399− modules anymore. Instead it accepts <literal>modules</literal> argument,
400− which is a list of modules to be built in. All modules now reside in
401− <literal>nginxModules</literal> set. Example configuration:
364+ <command>nginx</command> does not accept flags for enabling and disabling modules anymore. Instead it accepts <literal>modules</literal> argument, which is a list of modules to be built in. All modules now reside in <literal>nginxModules</literal> set. Example configuration:
402365<programlisting><![CDATA[
403366nginx.override {
404367 modules = [ nginxModules.rtmp nginxModules.dav nginxModules.moreheaders ];
@@ -408,66 +371,42 @@ nginx.override {
408371 </listitem>
409372 <listitem>
410373 <para>
411− <command>s3sync</command> is removed, as it hasn't been developed by
412− upstream for 4 years and only runs with ruby 1.8. For an actively-developer
413− alternative look at <command>tarsnap</command> and others.
374+ <command>s3sync</command> is removed, as it hasn't been developed by upstream for 4 years and only runs with ruby 1.8. For an actively-developer alternative look at <command>tarsnap</command> and others.
414375 </para>
415376 </listitem>
416377 <listitem>
417378 <para>
418− <command>ruby_1_8</command> has been removed as it's not supported from
419− upstream anymore and probably contains security issues.
379+ <command>ruby_1_8</command> has been removed as it's not supported from upstream anymore and probably contains security issues.
420380 </para>
421381 </listitem>
422382 <listitem>
423383 <para>
424− <literal>tidy-html5</literal> package is removed. Upstream only provided
425− <literal>(lib)tidy5</literal> during development, and now they went back to
426− <literal>(lib)tidy</literal> to work as a drop-in replacement of the
427− original package that has been unmaintained for years. You can (still) use
428− the <literal>html-tidy</literal> package, which got updated to a stable
429− release from this new upstream.
384+ <literal>tidy-html5</literal> package is removed. Upstream only provided <literal>(lib)tidy5</literal> during development, and now they went back to <literal>(lib)tidy</literal> to work as a drop-in replacement of the original package that has been unmaintained for years. You can (still) use the <literal>html-tidy</literal> package, which got updated to a stable release from this new upstream.
430385 </para>
431386 </listitem>
432387 <listitem>
433388 <para>
434− <literal>extraDeviceOptions</literal> argument is removed from
435− <literal>bumblebee</literal> package. Instead there are now two separate
436− arguments: <literal>extraNvidiaDeviceOptions</literal> and
437− <literal>extraNouveauDeviceOptions</literal> for setting extra X11 options
438− for nvidia and nouveau drivers, respectively.
389+ <literal>extraDeviceOptions</literal> argument is removed from <literal>bumblebee</literal> package. Instead there are now two separate arguments: <literal>extraNvidiaDeviceOptions</literal> and <literal>extraNouveauDeviceOptions</literal> for setting extra X11 options for nvidia and nouveau drivers, respectively.
439390 </para>
440391 </listitem>
441392 <listitem>
442393 <para>
443− The <literal>Ctrl+Alt+Backspace</literal> key combination no longer kills
444− the X server by default. There's a new option
445− <option>services.xserver.enableCtrlAltBackspace</option> allowing to enable
446− the combination again.
394+ The <literal>Ctrl+Alt+Backspace</literal> key combination no longer kills the X server by default. There's a new option <option>services.xserver.enableCtrlAltBackspace</option> allowing to enable the combination again.
447395 </para>
448396 </listitem>
449397 <listitem>
450398 <para>
451− <literal>emacsPackagesNg</literal> now contains all packages from the ELPA,
452− MELPA, and MELPA Stable repositories.
399+ <literal>emacsPackagesNg</literal> now contains all packages from the ELPA, MELPA, and MELPA Stable repositories.
453400 </para>
454401 </listitem>
455402 <listitem>
456403 <para>
457− Data directory for Postfix MTA server is moved from
458− <filename>/var/postfix</filename> to <filename>/var/lib/postfix</filename>.
459− Old configurations are migrated automatically.
460− <literal>service.postfix</literal> module has also received many
461− improvements, such as correct directories' access rights, new
462− <literal>aliasFiles</literal> and <literal>mapFiles</literal> options and
463− more.
404+ Data directory for Postfix MTA server is moved from <filename>/var/postfix</filename> to <filename>/var/lib/postfix</filename>. Old configurations are migrated automatically. <literal>service.postfix</literal> module has also received many improvements, such as correct directories' access rights, new <literal>aliasFiles</literal> and <literal>mapFiles</literal> options and more.
464405 </para>
465406 </listitem>
466407 <listitem>
467408 <para>
468− Filesystem options should now be configured as a list of strings, not a
469− comma-separated string. The old style will continue to work, but print a
470− warning, until the 16.09 release. An example of the new style:
409+ Filesystem options should now be configured as a list of strings, not a comma-separated string. The old style will continue to work, but print a warning, until the 16.09 release. An example of the new style:
471410<programlisting>
472411fileSystems."/example" = {
473412 device = "/dev/sdc";
@@ -479,44 +418,20 @@ fileSystems."/example" = {
479418 </listitem>
480419 <listitem>
481420 <para>
482− CUPS, installed by <literal>services.printing</literal> module, now has its
483− data directory in <filename>/var/lib/cups</filename>. Old configurations
484− from <filename>/etc/cups</filename> are moved there automatically, but
485− there might be problems. Also configuration options
486− <literal>services.printing.cupsdConf</literal> and
487− <literal>services.printing.cupsdFilesConf</literal> were removed because
488− they had been allowing one to override configuration variables required for
489− CUPS to work at all on NixOS. For most use cases,
490− <literal>services.printing.extraConf</literal> and new option
491− <literal>services.printing.extraFilesConf</literal> should be enough; if
492− you encounter a situation when they are not, please file a bug.
421+ CUPS, installed by <literal>services.printing</literal> module, now has its data directory in <filename>/var/lib/cups</filename>. Old configurations from <filename>/etc/cups</filename> are moved there automatically, but there might be problems. Also configuration options <literal>services.printing.cupsdConf</literal> and <literal>services.printing.cupsdFilesConf</literal> were removed because they had been allowing one to override configuration variables required for CUPS to work at all on NixOS. For most use cases, <literal>services.printing.extraConf</literal> and new option <literal>services.printing.extraFilesConf</literal> should be enough; if you encounter a situation when they are not, please file a bug.
493422 </para>
494423 <para>
495− There are also Gutenprint improvements; in particular, a new option
496− <literal>services.printing.gutenprint</literal> is added to enable
497− automatic updating of Gutenprint PPMs; it's greatly recommended to enable
498− it instead of adding <literal>gutenprint</literal> to the
499− <literal>drivers</literal> list.
424+ There are also Gutenprint improvements; in particular, a new option <literal>services.printing.gutenprint</literal> is added to enable automatic updating of Gutenprint PPMs; it's greatly recommended to enable it instead of adding <literal>gutenprint</literal> to the <literal>drivers</literal> list.
500425 </para>
501426 </listitem>
502427 <listitem>
503428 <para>
504− <literal>services.xserver.vaapiDrivers</literal> has been removed. Use
505− <literal>hardware.opengl.extraPackages{,32}</literal> instead. You can also
506− specify VDPAU drivers there.
429+ <literal>services.xserver.vaapiDrivers</literal> has been removed. Use <literal>hardware.opengl.extraPackages{,32}</literal> instead. You can also specify VDPAU drivers there.
507430 </para>
508431 </listitem>
509432 <listitem>
510433 <para>
511− <literal>programs.ibus</literal> moved to
512− <literal>i18n.inputMethod.ibus</literal>. The option
513− <literal>programs.ibus.plugins</literal> changed to
514− <literal>i18n.inputMethod.ibus.engines</literal> and the option to enable
515− ibus changed from <literal>programs.ibus.enable</literal> to
516− <literal>i18n.inputMethod.enabled</literal>.
517− <literal>i18n.inputMethod.enabled</literal> should be set to the used input
518− method name, <literal>"ibus"</literal> for ibus. An example of the new
519− style:
434+ <literal>programs.ibus</literal> moved to <literal>i18n.inputMethod.ibus</literal>. The option <literal>programs.ibus.plugins</literal> changed to <literal>i18n.inputMethod.ibus.engines</literal> and the option to enable ibus changed from <literal>programs.ibus.enable</literal> to <literal>i18n.inputMethod.enabled</literal>. <literal>i18n.inputMethod.enabled</literal> should be set to the used input method name, <literal>"ibus"</literal> for ibus. An example of the new style:
520435<programlisting>
521436i18n.inputMethod.enabled = "ibus";
522437i18n.inputMethod.ibus.engines = with pkgs.ibus-engines; [ anthy mozc ];
@@ -530,26 +445,17 @@ programs.ibus.plugins = with pkgs; [ ibus-anthy mozc ];
530445 </listitem>
531446 <listitem>
532447 <para>
533− <literal>services.udev.extraRules</literal> option now writes rules to
534− <filename>99-local.rules</filename> instead of
535− <filename>10-local.rules</filename>. This makes all the user rules apply
536− after others, so their results wouldn't be overriden by anything else.
448+ <literal>services.udev.extraRules</literal> option now writes rules to <filename>99-local.rules</filename> instead of <filename>10-local.rules</filename>. This makes all the user rules apply after others, so their results wouldn't be overriden by anything else.
537449 </para>
538450 </listitem>
539451 <listitem>
540452 <para>
541− Large parts of the <literal>services.gitlab</literal> module has been been
542− rewritten. There are new configuration options available. The
543− <literal>stateDir</literal> option was renamned to
544− <literal>statePath</literal> and the <literal>satellitesDir</literal>
545− option was removed. Please review the currently available options.
453+ Large parts of the <literal>services.gitlab</literal> module has been been rewritten. There are new configuration options available. The <literal>stateDir</literal> option was renamned to <literal>statePath</literal> and the <literal>satellitesDir</literal> option was removed. Please review the currently available options.
546454 </para>
547455 </listitem>
548456 <listitem>
549457 <para>
550− The option <option>services.nsd.zones.&lt;name&gt;.data</option> no longer
551− interpret the dollar sign ($) as a shell variable, as such it should not be
552− escaped anymore. Thus the following zone data:
458+ The option <option>services.nsd.zones.&lt;name&gt;.data</option> no longer interpret the dollar sign ($) as a shell variable, as such it should not be escaped anymore. Thus the following zone data:
553459 </para>
554460<programlisting>
555461\$ORIGIN example.com.
@@ -567,9 +473,7 @@ $TTL 1800
567473 </listitem>
568474 <listitem>
569475 <para>
570− <literal>service.syncthing.dataDir</literal> options now has to point to
571− exact folder where syncthing is writing to. Example configuration should
572− look something like:
476+ <literal>service.syncthing.dataDir</literal> options now has to point to exact folder where syncthing is writing to. Example configuration should look something like:
573477 </para>
574478<programlisting>
575479services.syncthing = {
@@ -581,45 +485,24 @@ services.syncthing = {
581485 </listitem>
582486 <listitem>
583487 <para>
584− <literal>networking.firewall.allowPing</literal> is now enabled by default.
585− Users are encouraged to configure an appropriate rate limit for their
586− machines using the Kernel interface at
587− <filename>/proc/sys/net/ipv4/icmp_ratelimit</filename> and
588− <filename>/proc/sys/net/ipv6/icmp/ratelimit</filename> or using the
589− firewall itself, i.e. by setting the NixOS option
590− <literal>networking.firewall.pingLimit</literal>.
488+ <literal>networking.firewall.allowPing</literal> is now enabled by default. Users are encouraged to configure an appropriate rate limit for their machines using the Kernel interface at <filename>/proc/sys/net/ipv4/icmp_ratelimit</filename> and <filename>/proc/sys/net/ipv6/icmp/ratelimit</filename> or using the firewall itself, i.e. by setting the NixOS option <literal>networking.firewall.pingLimit</literal>.
591489 </para>
592490 </listitem>
593491 <listitem>
594492 <para>
595− Systems with some broadcom cards used to result into a generated config
596− that is no longer accepted. If you get errors like
493+ Systems with some broadcom cards used to result into a generated config that is no longer accepted. If you get errors like
597494<screen>error: path ‘/nix/store/*-broadcom-sta-*’ does not exist and cannot be created</screen>
598− you should either re-run <command>nixos-generate-config</command> or
599− manually replace
600− <literal>"${config.boot.kernelPackages.broadcom_sta}"</literal> by
601− <literal>config.boot.kernelPackages.broadcom_sta</literal> in your
602− <filename>/etc/nixos/hardware-configuration.nix</filename>. More discussion
603− is on <link xlink:href="https://github.com/NixOS/nixpkgs/pull/12595"> the
604− github issue</link>.
495+ you should either re-run <command>nixos-generate-config</command> or manually replace <literal>"${config.boot.kernelPackages.broadcom_sta}"</literal> by <literal>config.boot.kernelPackages.broadcom_sta</literal> in your <filename>/etc/nixos/hardware-configuration.nix</filename>. More discussion is on <link xlink:href="https://github.com/NixOS/nixpkgs/pull/12595"> the github issue</link>.
605496 </para>
606497 </listitem>
607498 <listitem>
608499 <para>
609− The <literal>services.xserver.startGnuPGAgent</literal> option has been
610− removed. GnuPG 2.1.x changed the way the gpg-agent works, and that new
611− approach no longer requires (or even supports) the "start everything as a
612− child of the agent" scheme we've implemented in NixOS for older versions.
613− To configure the gpg-agent for your X session, add the following code to
614− <filename>~/.bashrc</filename> or some file that’s sourced when your
615− shell is started:
500+ The <literal>services.xserver.startGnuPGAgent</literal> option has been removed. GnuPG 2.1.x changed the way the gpg-agent works, and that new approach no longer requires (or even supports) the "start everything as a child of the agent" scheme we've implemented in NixOS for older versions. To configure the gpg-agent for your X session, add the following code to <filename>~/.bashrc</filename> or some file that’s sourced when your shell is started:
616501<programlisting>
617502GPG_TTY=$(tty)
618503export GPG_TTY
619504 </programlisting>
620− If you want to use gpg-agent for SSH, too, add the following to your
621− session initialization (e.g.
622− <literal>displayManager.sessionCommands</literal>)
505+ If you want to use gpg-agent for SSH, too, add the following to your session initialization (e.g. <literal>displayManager.sessionCommands</literal>)
623506<programlisting>
624507gpg-connect-agent /bye
625508unset SSH_AGENT_PID
@@ -629,15 +512,11 @@ export SSH_AUTH_SOCK="''${HOME}/.gnupg/S.gpg-agent.ssh"
629512<programlisting>
630513enable-ssh-support
631514 </programlisting>
632− is included in your <filename>~/.gnupg/gpg-agent.conf</filename>. You will
633− need to use <command>ssh-add</command> to re-add your ssh keys. If gpg’s
634− automatic transformation of the private keys to the new format fails, you
635− will need to re-import your private keyring as well:
515+ is included in your <filename>~/.gnupg/gpg-agent.conf</filename>. You will need to use <command>ssh-add</command> to re-add your ssh keys. If gpg’s automatic transformation of the private keys to the new format fails, you will need to re-import your private keyring as well:
636516<programlisting>
637517gpg --import ~/.gnupg/secring.gpg
638518 </programlisting>
639− The <command>gpg-agent(1)</command> man page has more details about this
640− subject, i.e. in the "EXAMPLES" section.
519+ The <command>gpg-agent(1)</command> man page has more details about this subject, i.e. in the "EXAMPLES" section.
641520 </para>
642521 </listitem>
643522 </itemizedlist>
@@ -661,9 +540,7 @@ gpg --import ~/.gnupg/secring.gpg
661540 </listitem>
662541 <listitem>
663542 <para>
664− Input method support was improved. New NixOS modules (fcitx, nabi and
665− uim), fcitx engines (chewing, hangul, m17n, mozc and table-other) and ibus
666− engines (hangul and m17n) have been added.
543+ Input method support was improved. New NixOS modules (fcitx, nabi and uim), fcitx engines (chewing, hangul, m17n, mozc and table-other) and ibus engines (hangul and m17n) have been added.
667544 </para>
668545 </listitem>
669546 </itemizedlist>
nixos/doc/manual/release-notes/rl-1609.xml+35−126
@@ -6,48 +6,36 @@
66 <title>Release 16.09 (“Flounder”, 2016/09/30)</title>
77
88 <para>
9− In addition to numerous new and upgraded packages, this release has the
10− following highlights:
9+ In addition to numerous new and upgraded packages, this release has the following highlights:
1110 </para>
1211
1312 <itemizedlist>
1413 <listitem>
1514 <para>
16− Many NixOS configurations and Nix packages now use significantly less disk
17− space, thanks to the
18− <link
19− xlink:href="https://github.com/NixOS/nixpkgs/issues/7117">extensive
20− work on closure size reduction</link>. For example, the closure size of a
21− minimal NixOS container went down from ~424 MiB in 16.03 to ~212 MiB in
22− 16.09, while the closure size of Firefox went from ~651 MiB to ~259 MiB.
15+ Many NixOS configurations and Nix packages now use significantly less disk space, thanks to the <link
16+ xlink:href="https://github.com/NixOS/nixpkgs/issues/7117">extensive work on closure size reduction</link>. For example, the closure size of a minimal NixOS container went down from ~424 MiB in 16.03 to ~212 MiB in 16.09, while the closure size of Firefox went from ~651 MiB to ~259 MiB.
2317 </para>
2418 </listitem>
2519 <listitem>
2620 <para>
27− To improve security, packages are now
28− <link
29− xlink:href="https://github.com/NixOS/nixpkgs/pull/12895">built
30− using various hardening features</link>. See the Nixpkgs manual for more
31− information.
21+ To improve security, packages are now <link
22+ xlink:href="https://github.com/NixOS/nixpkgs/pull/12895">built using various hardening features</link>. See the Nixpkgs manual for more information.
3223 </para>
3324 </listitem>
3425 <listitem>
3526 <para>
3627 Support for PXE netboot. See <xref
37− linkend="sec-booting-from-pxe" />
38− for documentation.
28+ linkend="sec-booting-from-pxe" /> for documentation.
3929 </para>
4030 </listitem>
4131 <listitem>
4232 <para>
43− X.org server 1.18. If you use the <literal>ati_unfree</literal> driver,
44− 1.17 is still used due to an ABI incompatibility.
33+ X.org server 1.18. If you use the <literal>ati_unfree</literal> driver, 1.17 is still used due to an ABI incompatibility.
4534 </para>
4635 </listitem>
4736 <listitem>
4837 <para>
49− This release is based on Glibc 2.24, GCC 5.4.0 and systemd 231. The default
50− Linux kernel remains 4.4.
38+ This release is based on Glibc 2.24, GCC 5.4.0 and systemd 231. The default Linux kernel remains 4.4.
5139 </para>
5240 </listitem>
5341 </itemizedlist>
@@ -65,122 +53,71 @@
6553 </itemizedlist>
6654
6755 <para>
68− When upgrading from a previous release, please be aware of the following
69− incompatible changes:
56+ When upgrading from a previous release, please be aware of the following incompatible changes:
7057 </para>
7158
7259 <itemizedlist>
7360 <listitem>
7461 <para>
75− A large number of packages have been converted to use the multiple outputs
76− feature of Nix to greatly reduce the amount of required disk space, as
77− mentioned above. This may require changes to any custom packages to make
78− them build again; see the relevant chapter in the Nixpkgs manual for more
79− information. (Additional caveat to packagers: some packaging conventions
80− related to multiple-output packages
81− <link xlink:href="https://github.com/NixOS/nixpkgs/pull/14766">were
82− changed</link> late (August 2016) in the release cycle and differ from the
83− initial introduction of multiple outputs.)
62+ A large number of packages have been converted to use the multiple outputs feature of Nix to greatly reduce the amount of required disk space, as mentioned above. This may require changes to any custom packages to make them build again; see the relevant chapter in the Nixpkgs manual for more information. (Additional caveat to packagers: some packaging conventions related to multiple-output packages <link xlink:href="https://github.com/NixOS/nixpkgs/pull/14766">were changed</link> late (August 2016) in the release cycle and differ from the initial introduction of multiple outputs.)
8463 </para>
8564 </listitem>
8665 <listitem>
8766 <para>
88− Previous versions of Nixpkgs had support for all versions of the LTS
89− Haskell package set. That support has been dropped. The previously provided
90− <literal>haskell.packages.lts-x_y</literal> package sets still exist in
91− name to aviod breaking user code, but these package sets don't actually
92− contain the versions mandated by the corresponding LTS release. Instead,
93− our package set it loosely based on the latest available LTS release, i.e.
94− LTS 7.x at the time of this writing. New releases of NixOS and Nixpkgs will
95− drop those old names entirely.
96− <link
97− xlink:href="https://nixos.org/nix-dev/2016-June/020585.html">The
98− motivation for this change</link> has been discussed at length on the
99− <literal>nix-dev</literal> mailing list and in
100− <link
101− xlink:href="https://github.com/NixOS/nixpkgs/issues/14897">Github
102− issue #14897</link>. Development strategies for Haskell hackers who want to
103− rely on Nix and NixOS have been described in
104− <link
105− xlink:href="https://nixos.org/nix-dev/2016-June/020642.html">another
106− nix-dev article</link>.
67+ Previous versions of Nixpkgs had support for all versions of the LTS Haskell package set. That support has been dropped. The previously provided <literal>haskell.packages.lts-x_y</literal> package sets still exist in name to aviod breaking user code, but these package sets don't actually contain the versions mandated by the corresponding LTS release. Instead, our package set it loosely based on the latest available LTS release, i.e. LTS 7.x at the time of this writing. New releases of NixOS and Nixpkgs will drop those old names entirely. <link
68+ xlink:href="https://nixos.org/nix-dev/2016-June/020585.html">The motivation for this change</link> has been discussed at length on the <literal>nix-dev</literal> mailing list and in <link
69+ xlink:href="https://github.com/NixOS/nixpkgs/issues/14897">Github issue #14897</link>. Development strategies for Haskell hackers who want to rely on Nix and NixOS have been described in <link
70+ xlink:href="https://nixos.org/nix-dev/2016-June/020642.html">another nix-dev article</link>.
10771 </para>
10872 </listitem>
10973 <listitem>
11074 <para>
111− Shell aliases for systemd sub-commands
112− <link xlink:href="https://github.com/NixOS/nixpkgs/pull/15598">were
113− dropped</link>: <command>start</command>, <command>stop</command>,
114− <command>restart</command>, <command>status</command>.
75+ Shell aliases for systemd sub-commands <link xlink:href="https://github.com/NixOS/nixpkgs/pull/15598">were dropped</link>: <command>start</command>, <command>stop</command>, <command>restart</command>, <command>status</command>.
11576 </para>
11677 </listitem>
11778 <listitem>
11879 <para>
119− Redis now binds to 127.0.0.1 only instead of listening to all network
120− interfaces. This is the default behavior of Redis 3.2
80+ Redis now binds to 127.0.0.1 only instead of listening to all network interfaces. This is the default behavior of Redis 3.2
12181 </para>
12282 </listitem>
12383 <listitem>
12484 <para>
125− <literal>/var/empty</literal> is now immutable. Activation script runs
126− <command>chattr +i</command> to forbid any modifications inside the folder.
127− See <link xlink:href="https://github.com/NixOS/nixpkgs/pull/18365"> the
128− pull request</link> for what bugs this caused.
85+ <literal>/var/empty</literal> is now immutable. Activation script runs <command>chattr +i</command> to forbid any modifications inside the folder. See <link xlink:href="https://github.com/NixOS/nixpkgs/pull/18365"> the pull request</link> for what bugs this caused.
12986 </para>
13087 </listitem>
13188 <listitem>
13289 <para>
133− Gitlab's maintainance script <command>gitlab-runner</command> was removed
134− and split up into the more clearer <command>gitlab-run</command> and
135− <command>gitlab-rake</command> scripts, because
136− <command>gitlab-runner</command> is a component of Gitlab CI.
90+ Gitlab's maintainance script <command>gitlab-runner</command> was removed and split up into the more clearer <command>gitlab-run</command> and <command>gitlab-rake</command> scripts, because <command>gitlab-runner</command> is a component of Gitlab CI.
13791 </para>
13892 </listitem>
13993 <listitem>
14094 <para>
141− <literal>services.xserver.libinput.accelProfile</literal> default changed
142− from <literal>flat</literal> to <literal>adaptive</literal>, as per
143− <link xlink:href="https://wayland.freedesktop.org/libinput/doc/latest/group__config.html#gad63796972347f318b180e322e35cee79">
144− official documentation</link>.
95+ <literal>services.xserver.libinput.accelProfile</literal> default changed from <literal>flat</literal> to <literal>adaptive</literal>, as per <link xlink:href="https://wayland.freedesktop.org/libinput/doc/latest/group__config.html#gad63796972347f318b180e322e35cee79"> official documentation</link>.
14596 </para>
14697 </listitem>
14798 <listitem>
14899 <para>
149− <literal>fonts.fontconfig.ultimate.rendering</literal> was removed because
150− our presets were obsolete for some time. New presets are hardcoded into
151− FreeType; you can select a preset via
152− <literal>fonts.fontconfig.ultimate.preset</literal>. You can customize
153− those presets via ordinary environment variables, using
154− <literal>environment.variables</literal>.
100+ <literal>fonts.fontconfig.ultimate.rendering</literal> was removed because our presets were obsolete for some time. New presets are hardcoded into FreeType; you can select a preset via <literal>fonts.fontconfig.ultimate.preset</literal>. You can customize those presets via ordinary environment variables, using <literal>environment.variables</literal>.
155101 </para>
156102 </listitem>
157103 <listitem>
158104 <para>
159− The <literal>audit</literal> service is no longer enabled by default. Use
160− <literal>security.audit.enable = true</literal> to explicitly enable it.
105+ The <literal>audit</literal> service is no longer enabled by default. Use <literal>security.audit.enable = true</literal> to explicitly enable it.
161106 </para>
162107 </listitem>
163108 <listitem>
164109 <para>
165− <literal>pkgs.linuxPackages.virtualbox</literal> now contains only the
166− kernel modules instead of the VirtualBox user space binaries. If you want
167− to reference the user space binaries, you have to use the new
168− <literal>pkgs.virtualbox</literal> instead.
110+ <literal>pkgs.linuxPackages.virtualbox</literal> now contains only the kernel modules instead of the VirtualBox user space binaries. If you want to reference the user space binaries, you have to use the new <literal>pkgs.virtualbox</literal> instead.
169111 </para>
170112 </listitem>
171113 <listitem>
172114 <para>
173− <literal>goPackages</literal> was replaced with separated Go applications
174− in appropriate <literal>nixpkgs</literal> categories. Each Go package uses
175− its own dependency set. There's also a new <literal>go2nix</literal> tool
176− introduced to generate a Go package definition from its Go source
177− automatically.
115+ <literal>goPackages</literal> was replaced with separated Go applications in appropriate <literal>nixpkgs</literal> categories. Each Go package uses its own dependency set. There's also a new <literal>go2nix</literal> tool introduced to generate a Go package definition from its Go source automatically.
178116 </para>
179117 </listitem>
180118 <listitem>
181119 <para>
182− <literal>services.mongodb.extraConfig</literal> configuration format was
183− changed to YAML.
120+ <literal>services.mongodb.extraConfig</literal> configuration format was changed to YAML.
184121 </para>
185122 </listitem>
186123 <listitem>
@@ -197,70 +134,42 @@
197134 <itemizedlist>
198135 <listitem>
199136 <para>
200− Revamped grsecurity/PaX support. There is now only a single general-purpose
201− distribution kernel and the configuration interface has been streamlined.
202− Desktop users should be able to simply set
137+ Revamped grsecurity/PaX support. There is now only a single general-purpose distribution kernel and the configuration interface has been streamlined. Desktop users should be able to simply set
203138<programlisting>security.grsecurity.enable = true</programlisting>
204− to get a reasonably secure system without having to sacrifice too much
205− functionality.
139+ to get a reasonably secure system without having to sacrifice too much functionality.
206140 </para>
207141 </listitem>
208142 <listitem>
209143 <para>
210− Special filesystems, like <literal>/proc</literal>, <literal>/run</literal>
211− and others, now have the same mount options as recommended by systemd and
212− are unified across different places in NixOS. Mount options are updated
213− during <command>nixos-rebuild switch</command> if possible. One benefit
214− from this is improved security — most such filesystems are now mounted
215− with <literal>noexec</literal>, <literal>nodev</literal> and/or
216− <literal>nosuid</literal> options.
144+ Special filesystems, like <literal>/proc</literal>, <literal>/run</literal> and others, now have the same mount options as recommended by systemd and are unified across different places in NixOS. Mount options are updated during <command>nixos-rebuild switch</command> if possible. One benefit from this is improved security — most such filesystems are now mounted with <literal>noexec</literal>, <literal>nodev</literal> and/or <literal>nosuid</literal> options.
217145 </para>
218146 </listitem>
219147 <listitem>
220148 <para>
221− The reverse path filter was interfering with DHCPv4 server operation in the
222− past. An exception for DHCPv4 and a new option to log packets that were
223− dropped due to the reverse path filter was added
224− (<literal>networking.firewall.logReversePathDrops</literal>) for easier
225− debugging.
149+ The reverse path filter was interfering with DHCPv4 server operation in the past. An exception for DHCPv4 and a new option to log packets that were dropped due to the reverse path filter was added (<literal>networking.firewall.logReversePathDrops</literal>) for easier debugging.
226150 </para>
227151 </listitem>
228152 <listitem>
229153 <para>
230− Containers configuration within
231− <literal>containers.&lt;name&gt;.config</literal> is
232− <link
233− xlink:href="https://github.com/NixOS/nixpkgs/pull/17365">now
234− properly typed and checked</link>. In particular, partial configurations
235− are merged correctly.
154+ Containers configuration within <literal>containers.&lt;name&gt;.config</literal> is <link
155+ xlink:href="https://github.com/NixOS/nixpkgs/pull/17365">now properly typed and checked</link>. In particular, partial configurations are merged correctly.
236156 </para>
237157 </listitem>
238158 <listitem>
239159 <para>
240− The directory container setuid wrapper programs,
241− <filename>/var/setuid-wrappers</filename>,
242− <link
243− xlink:href="https://github.com/NixOS/nixpkgs/pull/18124">is now
244− updated atomically to prevent failures if the switch to a new configuration
245− is interrupted.</link>
160+ The directory container setuid wrapper programs, <filename>/var/setuid-wrappers</filename>, <link
161+ xlink:href="https://github.com/NixOS/nixpkgs/pull/18124">is now updated atomically to prevent failures if the switch to a new configuration is interrupted.</link>
246162 </para>
247163 </listitem>
248164 <listitem>
249165 <para>
250− <literal>services.xserver.startGnuPGAgent</literal> has been removed due to
251− GnuPG 2.1.x bump. See
252− <link
253− xlink:href="https://github.com/NixOS/nixpkgs/commit/5391882ebd781149e213e8817fba6ac3c503740c">
254− how to achieve similar behavior</link>. You might need to <literal>pkill
255− gpg-agent</literal> after the upgrade to prevent a stale agent being in the
256− way.
166+ <literal>services.xserver.startGnuPGAgent</literal> has been removed due to GnuPG 2.1.x bump. See <link
167+ xlink:href="https://github.com/NixOS/nixpkgs/commit/5391882ebd781149e213e8817fba6ac3c503740c"> how to achieve similar behavior</link>. You might need to <literal>pkill gpg-agent</literal> after the upgrade to prevent a stale agent being in the way.
257168 </para>
258169 </listitem>
259170 <listitem>
260171 <para>
261− <link xlink:href="https://github.com/NixOS/nixpkgs/commit/e561edc322d275c3687fec431935095cfc717147">
262− Declarative users could share the uid due to the bug in the script handling
263− conflict resolution. </link>
172+ <link xlink:href="https://github.com/NixOS/nixpkgs/commit/e561edc322d275c3687fec431935095cfc717147"> Declarative users could share the uid due to the bug in the script handling conflict resolution. </link>
264173 </para>
265174 </listitem>
266175 <listitem>
nixos/doc/manual/release-notes/rl-1703.xml+45−148
@@ -13,29 +13,24 @@
1313 <title>Highlights</title>
1414
1515 <para>
16− In addition to numerous new and upgraded packages, this release has the
17− following highlights:
16+ In addition to numerous new and upgraded packages, this release has the following highlights:
1817 </para>
1918
2019 <itemizedlist>
2120 <listitem>
2221 <para>
23− Nixpkgs is now extensible through overlays. See the
24− <link
25− xlink:href="https://nixos.org/nixpkgs/manual/#sec-overlays-install">Nixpkgs
26− manual</link> for more information.
22+ Nixpkgs is now extensible through overlays. See the <link
23+ xlink:href="https://nixos.org/nixpkgs/manual/#sec-overlays-install">Nixpkgs manual</link> for more information.
2724 </para>
2825 </listitem>
2926 <listitem>
3027 <para>
31− This release is based on Glibc 2.25, GCC 5.4.0 and systemd 232. The
32− default Linux kernel is 4.9 and Nix is at 1.11.8.
28+ This release is based on Glibc 2.25, GCC 5.4.0 and systemd 232. The default Linux kernel is 4.9 and Nix is at 1.11.8.
3329 </para>
3430 </listitem>
3531 <listitem>
3632 <para>
37− The default desktop environment now is KDE's Plasma 5. KDE 4 has been
38− removed
33+ The default desktop environment now is KDE's Plasma 5. KDE 4 has been removed
3934 </para>
4035 </listitem>
4136 <listitem>
@@ -45,35 +40,24 @@
4540 </listitem>
4641 <listitem>
4742 <para>
48− X.org server uses branch 1.19. Due to ABI incompatibilities,
49− <literal>ati_unfree</literal> keeps forcing 1.17 and
50− <literal>amdgpu-pro</literal> starts forcing 1.18.
43+ X.org server uses branch 1.19. Due to ABI incompatibilities, <literal>ati_unfree</literal> keeps forcing 1.17 and <literal>amdgpu-pro</literal> starts forcing 1.18.
5144 </para>
5245 </listitem>
5346 <listitem>
5447 <para>
55− Cross compilation has been rewritten. See the nixpkgs manual for details.
56− The most obvious breaking change is that in derivations there is no
57− <literal>.nativeDrv</literal> nor <literal>.crossDrv</literal> are now
58− cross by default, not native.
48+ Cross compilation has been rewritten. See the nixpkgs manual for details. The most obvious breaking change is that in derivations there is no <literal>.nativeDrv</literal> nor <literal>.crossDrv</literal> are now cross by default, not native.
5949 </para>
6050 </listitem>
6151 <listitem>
6252 <para>
63− The <literal>overridePackages</literal> function has been rewritten to be
64− replaced by
65− <link
66− xlink:href="https://nixos.org/nixpkgs/manual/#sec-overlays-install">
67− overlays</link>
53+ The <literal>overridePackages</literal> function has been rewritten to be replaced by <link
54+ xlink:href="https://nixos.org/nixpkgs/manual/#sec-overlays-install"> overlays</link>
6855 </para>
6956 </listitem>
7057 <listitem>
7158 <para>
72− Packages in nixpkgs can be marked as insecure through listed
73− vulnerabilities. See the
74− <link
75− xlink:href="https://nixos.org/nixpkgs/manual/#sec-allow-insecure">Nixpkgs
76− manual</link> for more information.
59+ Packages in nixpkgs can be marked as insecure through listed vulnerabilities. See the <link
60+ xlink:href="https://nixos.org/nixpkgs/manual/#sec-allow-insecure">Nixpkgs manual</link> for more information.
7761 </para>
7862 </listitem>
7963 <listitem>
@@ -512,92 +496,64 @@
512496 <title>Backward Incompatibilities</title>
513497
514498 <para>
515− When upgrading from a previous release, please be aware of the following
516− incompatible changes:
499+ When upgrading from a previous release, please be aware of the following incompatible changes:
517500 </para>
518501
519502 <itemizedlist>
520503 <listitem>
521504 <para>
522− Derivations have no <literal>.nativeDrv</literal> nor
523− <literal>.crossDrv</literal> and are now cross by default, not native.
505+ Derivations have no <literal>.nativeDrv</literal> nor <literal>.crossDrv</literal> and are now cross by default, not native.
524506 </para>
525507 </listitem>
526508 <listitem>
527509 <para>
528− <literal>stdenv.overrides</literal> is now expected to take
529− <literal>self</literal> and <literal>super</literal> arguments. See
530− <literal>lib.trivial.extends</literal> for what those parameters
531− represent.
510+ <literal>stdenv.overrides</literal> is now expected to take <literal>self</literal> and <literal>super</literal> arguments. See <literal>lib.trivial.extends</literal> for what those parameters represent.
532511 </para>
533512 </listitem>
534513 <listitem>
535514 <para>
536− <literal>ansible</literal> now defaults to ansible version 2 as version 1
537− has been removed due to a serious
538− <link
539− xlink:href="https://www.computest.nl/advisories/CT-2017-0109_Ansible.txt">
540− vulnerability</link> unpatched by upstream.
515+ <literal>ansible</literal> now defaults to ansible version 2 as version 1 has been removed due to a serious <link
516+ xlink:href="https://www.computest.nl/advisories/CT-2017-0109_Ansible.txt"> vulnerability</link> unpatched by upstream.
541517 </para>
542518 </listitem>
543519 <listitem>
544520 <para>
545− <literal>gnome</literal> alias has been removed along with
546− <literal>gtk</literal>, <literal>gtkmm</literal> and several others. Now
547− you need to use versioned attributes, like <literal>gnome3</literal>.
521+ <literal>gnome</literal> alias has been removed along with <literal>gtk</literal>, <literal>gtkmm</literal> and several others. Now you need to use versioned attributes, like <literal>gnome3</literal>.
548522 </para>
549523 </listitem>
550524 <listitem>
551525 <para>
552− The attribute name of the Radicale daemon has been changed from
553− <literal>pythonPackages.radicale</literal> to <literal>radicale</literal>.
526+ The attribute name of the Radicale daemon has been changed from <literal>pythonPackages.radicale</literal> to <literal>radicale</literal>.
554527 </para>
555528 </listitem>
556529 <listitem>
557530 <para>
558− The <literal>stripHash</literal> bash function in
559− <literal>stdenv</literal> changed according to its documentation; it now
560− outputs the stripped name to <literal>stdout</literal> instead of putting
561− it in the variable <literal>strippedName</literal>.
531+ The <literal>stripHash</literal> bash function in <literal>stdenv</literal> changed according to its documentation; it now outputs the stripped name to <literal>stdout</literal> instead of putting it in the variable <literal>strippedName</literal>.
562532 </para>
563533 </listitem>
564534 <listitem>
565535 <para>
566− PHP now scans for extra configuration .ini files in /etc/php.d instead of
567− /etc. This prevents accidentally loading non-PHP .ini files that may be in
568− /etc.
536+ PHP now scans for extra configuration .ini files in /etc/php.d instead of /etc. This prevents accidentally loading non-PHP .ini files that may be in /etc.
569537 </para>
570538 </listitem>
571539 <listitem>
572540 <para>
573− Two lone top-level dict dbs moved into <literal>dictdDBs</literal>. This
574− affects: <literal>dictdWordnet</literal> which is now at
575− <literal>dictdDBs.wordnet</literal> and <literal>dictdWiktionary</literal>
576− which is now at <literal>dictdDBs.wiktionary</literal>
541+ Two lone top-level dict dbs moved into <literal>dictdDBs</literal>. This affects: <literal>dictdWordnet</literal> which is now at <literal>dictdDBs.wordnet</literal> and <literal>dictdWiktionary</literal> which is now at <literal>dictdDBs.wiktionary</literal>
577542 </para>
578543 </listitem>
579544 <listitem>
580545 <para>
581− Parsoid service now uses YAML configuration format.
582− <literal>service.parsoid.interwikis</literal> is now called
583− <literal>service.parsoid.wikis</literal> and is a list of either API URLs
584− or attribute sets as specified in parsoid's documentation.
546+ Parsoid service now uses YAML configuration format. <literal>service.parsoid.interwikis</literal> is now called <literal>service.parsoid.wikis</literal> and is a list of either API URLs or attribute sets as specified in parsoid's documentation.
585547 </para>
586548 </listitem>
587549 <listitem>
588550 <para>
589− <literal>Ntpd</literal> was replaced by
590− <literal>systemd-timesyncd</literal> as the default service to synchronize
591− system time with a remote NTP server. The old behavior can be restored by
592− setting <literal>services.ntp.enable</literal> to <literal>true</literal>.
593− Upstream time servers for all NTP implementations are now configured using
594− <literal>networking.timeServers</literal>.
551+ <literal>Ntpd</literal> was replaced by <literal>systemd-timesyncd</literal> as the default service to synchronize system time with a remote NTP server. The old behavior can be restored by setting <literal>services.ntp.enable</literal> to <literal>true</literal>. Upstream time servers for all NTP implementations are now configured using <literal>networking.timeServers</literal>.
595552 </para>
596553 </listitem>
597554 <listitem>
598555 <para>
599− <literal>service.nylon</literal> is now declared using named instances. As
600− an example:
556+ <literal>service.nylon</literal> is now declared using named instances. As an example:
601557<programlisting>
602558 services.nylon = {
603559 enable = true;
@@ -620,11 +576,8 @@
620576 </listitem>
621577 <listitem>
622578 <para>
623− <literal>overridePackages</literal> function no longer exists. It is
624− replaced by
625− <link
626− xlink:href="https://nixos.org/nixpkgs/manual/#sec-overlays-install">
627− overlays</link>. For example, the following code:
579+ <literal>overridePackages</literal> function no longer exists. It is replaced by <link
580+ xlink:href="https://nixos.org/nixpkgs/manual/#sec-overlays-install"> overlays</link>. For example, the following code:
628581<programlisting>
629582let
630583 pkgs = import &lt;nixpkgs&gt; {};
@@ -642,72 +595,42 @@ in
642595 </listitem>
643596 <listitem>
644597 <para>
645− Autoloading connection tracking helpers is now disabled by default. This
646− default was also changed in the Linux kernel and is considered insecure if
647− not configured properly in your firewall. If you need connection tracking
648− helpers (i.e. for active FTP) please enable
649− <literal>networking.firewall.autoLoadConntrackHelpers</literal> and tune
650− <literal>networking.firewall.connectionTrackingModules</literal> to suit
651− your needs.
598+ Autoloading connection tracking helpers is now disabled by default. This default was also changed in the Linux kernel and is considered insecure if not configured properly in your firewall. If you need connection tracking helpers (i.e. for active FTP) please enable <literal>networking.firewall.autoLoadConntrackHelpers</literal> and tune <literal>networking.firewall.connectionTrackingModules</literal> to suit your needs.
652599 </para>
653600 </listitem>
654601 <listitem>
655602 <para>
656− <literal>local_recipient_maps</literal> is not set to empty value by
657− Postfix service. It's an insecure default as stated by Postfix
658− documentation. Those who want to retain this setting need to set it via
659− <literal>services.postfix.extraConfig</literal>.
603+ <literal>local_recipient_maps</literal> is not set to empty value by Postfix service. It's an insecure default as stated by Postfix documentation. Those who want to retain this setting need to set it via <literal>services.postfix.extraConfig</literal>.
660604 </para>
661605 </listitem>
662606 <listitem>
663607 <para>
664− Iputils no longer provide ping6 and traceroute6. The functionality of
665− these tools has been integrated into ping and traceroute respectively. To
666− enforce an address family the new flags <literal>-4</literal> and
667− <literal>-6</literal> have been added. One notable incompatibility is that
668− specifying an interface (for link-local IPv6 for instance) is no longer
669− done with the <literal>-I</literal> flag, but by encoding the interface
670− into the address (<literal>ping fe80::1%eth0</literal>).
608+ Iputils no longer provide ping6 and traceroute6. The functionality of these tools has been integrated into ping and traceroute respectively. To enforce an address family the new flags <literal>-4</literal> and <literal>-6</literal> have been added. One notable incompatibility is that specifying an interface (for link-local IPv6 for instance) is no longer done with the <literal>-I</literal> flag, but by encoding the interface into the address (<literal>ping fe80::1%eth0</literal>).
671609 </para>
672610 </listitem>
673611 <listitem>
674612 <para>
675− The socket handling of the <literal>services.rmilter</literal> module has
676− been fixed and refactored. As rmilter doesn't support binding to more than
677− one socket, the options <literal>bindUnixSockets</literal> and
678− <literal>bindInetSockets</literal> have been replaced by
679− <literal>services.rmilter.bindSocket.*</literal>. The default is still a
680− unix socket in <literal>/run/rmilter/rmilter.sock</literal>. Refer to the
681− options documentation for more information.
613+ The socket handling of the <literal>services.rmilter</literal> module has been fixed and refactored. As rmilter doesn't support binding to more than one socket, the options <literal>bindUnixSockets</literal> and <literal>bindInetSockets</literal> have been replaced by <literal>services.rmilter.bindSocket.*</literal>. The default is still a unix socket in <literal>/run/rmilter/rmilter.sock</literal>. Refer to the options documentation for more information.
682614 </para>
683615 </listitem>
684616 <listitem>
685617 <para>
686− The <literal>fetch*</literal> functions no longer support md5, please use
687− sha256 instead.
618+ The <literal>fetch*</literal> functions no longer support md5, please use sha256 instead.
688619 </para>
689620 </listitem>
690621 <listitem>
691622 <para>
692− The dnscrypt-proxy module interface has been streamlined around the
693− <option>extraArgs</option> option. Where possible, legacy option
694− declarations are mapped to <option>extraArgs</option> but will emit
695− warnings. The <option>resolverList</option> has been outright removed: to
696− use an unlisted resolver, use the <option>customResolver</option> option.
623+ The dnscrypt-proxy module interface has been streamlined around the <option>extraArgs</option> option. Where possible, legacy option declarations are mapped to <option>extraArgs</option> but will emit warnings. The <option>resolverList</option> has been outright removed: to use an unlisted resolver, use the <option>customResolver</option> option.
697624 </para>
698625 </listitem>
699626 <listitem>
700627 <para>
701− torbrowser now stores local state under
702− <filename>~/.local/share/tor-browser</filename> by default. Any browser
703− profile data from the old location, <filename>~/.torbrowser4</filename>,
704− must be migrated manually.
628+ torbrowser now stores local state under <filename>~/.local/share/tor-browser</filename> by default. Any browser profile data from the old location, <filename>~/.torbrowser4</filename>, must be migrated manually.
705629 </para>
706630 </listitem>
707631 <listitem>
708632 <para>
709− The ihaskell, monetdb, offlineimap and sitecopy services have been
710− removed.
633+ The ihaskell, monetdb, offlineimap and sitecopy services have been removed.
711634 </para>
712635 </listitem>
713636 </itemizedlist>
@@ -723,18 +646,12 @@ in
723646 <itemizedlist>
724647 <listitem>
725648 <para>
726− Module type system have a new extensible option types feature that allow
727− to extend certain types, such as enum, through multiple option
728− declarations of the same option across multiple modules.
649+ Module type system have a new extensible option types feature that allow to extend certain types, such as enum, through multiple option declarations of the same option across multiple modules.
729650 </para>
730651 </listitem>
731652 <listitem>
732653 <para>
733− <literal>jre</literal> now defaults to GTK UI by default. This improves
734− visual consistency and makes Java follow system font style, improving the
735− situation on HighDPI displays. This has a cost of increased closure size;
736− for server and other headless workloads it's recommended to use
737− <literal>jre_headless</literal>.
654+ <literal>jre</literal> now defaults to GTK UI by default. This improves visual consistency and makes Java follow system font style, improving the situation on HighDPI displays. This has a cost of increased closure size; for server and other headless workloads it's recommended to use <literal>jre_headless</literal>.
738655 </para>
739656 </listitem>
740657 <listitem>
@@ -744,53 +661,37 @@ in
744661 </listitem>
745662 <listitem>
746663 <para>
747− The Python 2.7 interpreter does not use modules anymore. Instead, all
748− CPython interpreters now include the whole standard library except for
749− `tkinter`, which is available in the Python package set.
664+ The Python 2.7 interpreter does not use modules anymore. Instead, all CPython interpreters now include the whole standard library except for `tkinter`, which is available in the Python package set.
750665 </para>
751666 </listitem>
752667 <listitem>
753668 <para>
754− Python 2.7, 3.5 and 3.6 are now built deterministically and 3.4 mostly.
755− Minor modifications had to be made to the interpreters in order to
756− generate deterministic bytecode. This has security implications and is
757− relevant for those using Python in a <literal>nix-shell</literal>. See the
758− Nixpkgs manual for details.
669+ Python 2.7, 3.5 and 3.6 are now built deterministically and 3.4 mostly. Minor modifications had to be made to the interpreters in order to generate deterministic bytecode. This has security implications and is relevant for those using Python in a <literal>nix-shell</literal>. See the Nixpkgs manual for details.
759670 </para>
760671 </listitem>
761672 <listitem>
762673 <para>
763− The Python package sets now use a fixed-point combinator and the sets are
764− available as attributes of the interpreters.
674+ The Python package sets now use a fixed-point combinator and the sets are available as attributes of the interpreters.
765675 </para>
766676 </listitem>
767677 <listitem>
768678 <para>
769− The Python function <literal>buildPythonPackage</literal> has been
770− improved and can be used to build from Setuptools source, Flit source, and
771− precompiled Wheels.
679+ The Python function <literal>buildPythonPackage</literal> has been improved and can be used to build from Setuptools source, Flit source, and precompiled Wheels.
772680 </para>
773681 </listitem>
774682 <listitem>
775683 <para>
776− When adding new or updating current Python libraries, the expressions
777− should be put in separate files in
778− <literal>pkgs/development/python-modules</literal> and called from
779− <literal>python-packages.nix</literal>.
684+ When adding new or updating current Python libraries, the expressions should be put in separate files in <literal>pkgs/development/python-modules</literal> and called from <literal>python-packages.nix</literal>.
780685 </para>
781686 </listitem>
782687 <listitem>
783688 <para>
784− The dnscrypt-proxy service supports synchronizing the list of public
785− resolvers without working DNS resolution. This fixes issues caused by the
786− resolver list becoming outdated. It also improves the viability of
787− DNSCrypt only configurations.
689+ The dnscrypt-proxy service supports synchronizing the list of public resolvers without working DNS resolution. This fixes issues caused by the resolver list becoming outdated. It also improves the viability of DNSCrypt only configurations.
788690 </para>
789691 </listitem>
790692 <listitem>
791693 <para>
792− Containers using bridged networking no longer lose their connection after
793− changes to the host networking.
694+ Containers using bridged networking no longer lose their connection after changes to the host networking.
794695 </para>
795696 </listitem>
796697 <listitem>
@@ -800,16 +701,12 @@ in
800701 </listitem>
801702 <listitem>
802703 <para>
803− The bind DNS utilities (e.g. dig) have been split into their own output
804− and are now also available in <literal>pkgs.dnsutils</literal> and it is
805− no longer necessary to pull in all of <literal>bind</literal> to use them.
704+ The bind DNS utilities (e.g. dig) have been split into their own output and are now also available in <literal>pkgs.dnsutils</literal> and it is no longer necessary to pull in all of <literal>bind</literal> to use them.
806705 </para>
807706 </listitem>
808707 <listitem>
809708 <para>
810− Per-user configuration was moved from <filename>~/.nixpkgs</filename> to
811− <filename>~/.config/nixpkgs</filename>. The former is still valid for
812− <filename>config.nix</filename> for backwards compatibility.
709+ Per-user configuration was moved from <filename>~/.nixpkgs</filename> to <filename>~/.config/nixpkgs</filename>. The former is still valid for <filename>config.nix</filename> for backwards compatibility.
813710 </para>
814711 </listitem>
815712 </itemizedlist>
nixos/doc/manual/release-notes/rl-1709.xml+65−227
@@ -13,30 +13,23 @@
1313 <title>Highlights</title>
1414
1515 <para>
16− In addition to numerous new and upgraded packages, this release has the
17− following highlights:
16+ In addition to numerous new and upgraded packages, this release has the following highlights:
1817 </para>
1918
2019 <itemizedlist>
2120 <listitem>
2221 <para>
23− The GNOME version is now 3.24. KDE Plasma was upgraded to 5.10, KDE
24− Applications to 17.08.1 and KDE Frameworks to 5.37.
22+ The GNOME version is now 3.24. KDE Plasma was upgraded to 5.10, KDE Applications to 17.08.1 and KDE Frameworks to 5.37.
2523 </para>
2624 </listitem>
2725 <listitem>
2826 <para>
29− The user handling now keeps track of deallocated UIDs/GIDs. When a user or
30− group is revived, this allows it to be allocated the UID/GID it had
31− before. A consequence is that UIDs and GIDs are no longer reused.
27+ The user handling now keeps track of deallocated UIDs/GIDs. When a user or group is revived, this allows it to be allocated the UID/GID it had before. A consequence is that UIDs and GIDs are no longer reused.
3228 </para>
3329 </listitem>
3430 <listitem>
3531 <para>
36− The module option <option>services.xserver.xrandrHeads</option> now causes
37− the first head specified in this list to be set as the primary head. Apart
38− from that, it's now possible to also set additional options by using an
39− attribute set, for example:
32+ The module option <option>services.xserver.xrandrHeads</option> now causes the first head specified in this list to be set as the primary head. Apart from that, it's now possible to also set additional options by using an attribute set, for example:
4033<programlisting>
4134{ services.xserver.xrandrHeads = [
4235 "HDMI-0"
@@ -50,36 +43,21 @@
5043 ];
5144}
5245</programlisting>
53− This will set the <literal>DVI-0</literal> output to be the primary head,
54− even though <literal>HDMI-0</literal> is the first head in the list.
46+ This will set the <literal>DVI-0</literal> output to be the primary head, even though <literal>HDMI-0</literal> is the first head in the list.
5547 </para>
5648 </listitem>
5749 <listitem>
5850 <para>
59− The handling of SSL in the <literal>services.nginx</literal> module has
60− been cleaned up, renaming the misnamed <literal>enableSSL</literal> to
61− <literal>onlySSL</literal> which reflects its original intention. This is
62− not to be used with the already existing <literal>forceSSL</literal> which
63− creates a second non-SSL virtual host redirecting to the SSL virtual host.
64− This by chance had worked earlier due to specific implementation details.
65− In case you had specified both please remove the
66− <literal>enableSSL</literal> option to keep the previous behaviour.
51+ The handling of SSL in the <literal>services.nginx</literal> module has been cleaned up, renaming the misnamed <literal>enableSSL</literal> to <literal>onlySSL</literal> which reflects its original intention. This is not to be used with the already existing <literal>forceSSL</literal> which creates a second non-SSL virtual host redirecting to the SSL virtual host. This by chance had worked earlier due to specific implementation details. In case you had specified both please remove the <literal>enableSSL</literal> option to keep the previous behaviour.
6752 </para>
6853 <para>
69− Another <literal>addSSL</literal> option has been introduced to configure
70− both a non-SSL virtual host and an SSL virtual host with the same
71− configuration.
54+ Another <literal>addSSL</literal> option has been introduced to configure both a non-SSL virtual host and an SSL virtual host with the same configuration.
7255 </para>
7356 <para>
74− Options to configure <literal>resolver</literal> options and
75− <literal>upstream</literal> blocks have been introduced. See their
76− information for further details.
57+ Options to configure <literal>resolver</literal> options and <literal>upstream</literal> blocks have been introduced. See their information for further details.
7758 </para>
7859 <para>
79− The <literal>port</literal> option has been replaced by a more generic
80− <literal>listen</literal> option which makes it possible to specify
81− multiple addresses, ports and SSL configs dependant on the new SSL
82− handling mentioned above.
60+ The <literal>port</literal> option has been replaced by a more generic <literal>listen</literal> option which makes it possible to specify multiple addresses, ports and SSL configs dependant on the new SSL handling mentioned above.
8361 </para>
8462 </listitem>
8563 </itemizedlist>
@@ -468,47 +446,31 @@
468446 <title>Backward Incompatibilities</title>
469447
470448 <para>
471− When upgrading from a previous release, please be aware of the following
472− incompatible changes:
449+ When upgrading from a previous release, please be aware of the following incompatible changes:
473450 </para>
474451
475452 <itemizedlist>
476453 <listitem>
477454 <para>
478− <emphasis role="strong"> In an Qemu-based virtualization environment, the
479− network interface names changed from i.e. <literal>enp0s3</literal> to
480− <literal>ens3</literal>. </emphasis>
455+ <emphasis role="strong"> In an Qemu-based virtualization environment, the network interface names changed from i.e. <literal>enp0s3</literal> to <literal>ens3</literal>. </emphasis>
481456 </para>
482457 <para>
483− This is due to a kernel configuration change. The new naming is consistent
484− with those of other Linux distributions with systemd. See
485− <link xlink:href="https://github.com/NixOS/nixpkgs/issues/29197">#29197</link>
486− for more information.
458+ This is due to a kernel configuration change. The new naming is consistent with those of other Linux distributions with systemd. See <link xlink:href="https://github.com/NixOS/nixpkgs/issues/29197">#29197</link> for more information.
487459 </para>
488460 <para>
489− A machine is affected if the <literal>virt-what</literal> tool either
490− returns <literal>qemu</literal> or <literal>kvm</literal>
491− <emphasis>and</emphasis> has interface names used in any part of its NixOS
492− configuration, in particular if a static network configuration with
493− <literal>networking.interfaces</literal> is used.
461+ A machine is affected if the <literal>virt-what</literal> tool either returns <literal>qemu</literal> or <literal>kvm</literal> <emphasis>and</emphasis> has interface names used in any part of its NixOS configuration, in particular if a static network configuration with <literal>networking.interfaces</literal> is used.
494462 </para>
495463 <para>
496464 Before rebooting affected machines, please ensure:
497465 <itemizedlist>
498466 <listitem>
499467 <para>
500− Change the interface names in your NixOS configuration. The first
501− interface will be called <literal>ens3</literal>, the second one
502− <literal>ens8</literal> and starting from there incremented by 1.
468+ Change the interface names in your NixOS configuration. The first interface will be called <literal>ens3</literal>, the second one <literal>ens8</literal> and starting from there incremented by 1.
503469 </para>
504470 </listitem>
505471 <listitem>
506472 <para>
507− After changing the interface names, rebuild your system with
508− <literal>nixos-rebuild boot</literal> to activate the new configuration
509− after a reboot. If you switch to the new configuration right away you
510− might lose network connectivity! If using <literal>nixops</literal>,
511− deploy with <literal>nixops deploy --force-reboot</literal>.
473+ After changing the interface names, rebuild your system with <literal>nixos-rebuild boot</literal> to activate the new configuration after a reboot. If you switch to the new configuration right away you might lose network connectivity! If using <literal>nixops</literal>, deploy with <literal>nixops deploy --force-reboot</literal>.
512474 </para>
513475 </listitem>
514476 </itemizedlist>
@@ -516,88 +478,59 @@
516478 </listitem>
517479 <listitem>
518480 <para>
519− The following changes apply if the <literal>stateVersion</literal> is
520− changed to 17.09 or higher. For <literal>stateVersion = "17.03"</literal>
521− or lower the old behavior is preserved.
481+ The following changes apply if the <literal>stateVersion</literal> is changed to 17.09 or higher. For <literal>stateVersion = "17.03"</literal> or lower the old behavior is preserved.
522482 </para>
523483 <itemizedlist>
524484 <listitem>
525485 <para>
526− The <literal>postgres</literal> default version was changed from 9.5 to
527− 9.6.
486+ The <literal>postgres</literal> default version was changed from 9.5 to 9.6.
528487 </para>
529488 </listitem>
530489 <listitem>
531490 <para>
532− The <literal>postgres</literal> superuser name has changed from
533− <literal>root</literal> to <literal>postgres</literal> to more closely
534− follow what other Linux distributions are doing.
491+ The <literal>postgres</literal> superuser name has changed from <literal>root</literal> to <literal>postgres</literal> to more closely follow what other Linux distributions are doing.
535492 </para>
536493 </listitem>
537494 <listitem>
538495 <para>
539− The <literal>postgres</literal> default <literal>dataDir</literal> has
540− changed from <literal>/var/db/postgres</literal> to
541− <literal>/var/lib/postgresql/$psqlSchema</literal> where $psqlSchema is
542− 9.6 for example.
496+ The <literal>postgres</literal> default <literal>dataDir</literal> has changed from <literal>/var/db/postgres</literal> to <literal>/var/lib/postgresql/$psqlSchema</literal> where $psqlSchema is 9.6 for example.
543497 </para>
544498 </listitem>
545499 <listitem>
546500 <para>
547− The <literal>mysql</literal> default <literal>dataDir</literal> has
548− changed from <literal>/var/mysql</literal> to
549− <literal>/var/lib/mysql</literal>.
501+ The <literal>mysql</literal> default <literal>dataDir</literal> has changed from <literal>/var/mysql</literal> to <literal>/var/lib/mysql</literal>.
550502 </para>
551503 </listitem>
552504 <listitem>
553505 <para>
554− Radicale's default package has changed from 1.x to 2.x. Instructions to
555− migrate can be found <link xlink:href="http://radicale.org/1to2/"> here
556− </link>. It is also possible to use the newer version by setting the
557− <literal>package</literal> to <literal>radicale2</literal>, which is
558− done automatically when <literal>stateVersion</literal> is 17.09 or
559− higher. The <literal>extraArgs</literal> option has been added to allow
560− passing the data migration arguments specified in the instructions; see
561− the
562− <filename xlink:href="https://github.com/NixOS/nixpkgs/blob/master/nixos/tests/radicale.nix">radicale.nix</filename>
563− NixOS test for an example migration.
506+ Radicale's default package has changed from 1.x to 2.x. Instructions to migrate can be found <link xlink:href="http://radicale.org/1to2/"> here </link>. It is also possible to use the newer version by setting the <literal>package</literal> to <literal>radicale2</literal>, which is done automatically when <literal>stateVersion</literal> is 17.09 or higher. The <literal>extraArgs</literal> option has been added to allow passing the data migration arguments specified in the instructions; see the <filename xlink:href="https://github.com/NixOS/nixpkgs/blob/master/nixos/tests/radicale.nix">radicale.nix</filename> NixOS test for an example migration.
564507 </para>
565508 </listitem>
566509 </itemizedlist>
567510 </listitem>
568511 <listitem>
569512 <para>
570− The <literal>aiccu</literal> package was removed. This is due to SixXS
571− <link xlink:href="https://www.sixxs.net/main/"> sunsetting</link> its IPv6
572− tunnel.
513+ The <literal>aiccu</literal> package was removed. This is due to SixXS <link xlink:href="https://www.sixxs.net/main/"> sunsetting</link> its IPv6 tunnel.
573514 </para>
574515 </listitem>
575516 <listitem>
576517 <para>
577− The <literal>fanctl</literal> package and <literal>fan</literal> module
578− have been removed due to the developers not upstreaming their iproute2
579− patches and lagging with compatibility to recent iproute2 versions.
518+ The <literal>fanctl</literal> package and <literal>fan</literal> module have been removed due to the developers not upstreaming their iproute2 patches and lagging with compatibility to recent iproute2 versions.
580519 </para>
581520 </listitem>
582521 <listitem>
583522 <para>
584− Top-level <literal>idea</literal> package collection was renamed. All
585− JetBrains IDEs are now at <literal>jetbrains</literal>.
523+ Top-level <literal>idea</literal> package collection was renamed. All JetBrains IDEs are now at <literal>jetbrains</literal>.
586524 </para>
587525 </listitem>
588526 <listitem>
589527 <para>
590− <literal>flexget</literal>'s state database cannot be upgraded to its new
591− internal format, requiring removal of any existing
592− <literal>db-config.sqlite</literal> which will be automatically recreated.
528+ <literal>flexget</literal>'s state database cannot be upgraded to its new internal format, requiring removal of any existing <literal>db-config.sqlite</literal> which will be automatically recreated.
593529 </para>
594530 </listitem>
595531 <listitem>
596532 <para>
597− The <literal>ipfs</literal> service now doesn't ignore the
598− <literal>dataDir</literal> option anymore. If you've ever set this option
599− to anything other than the default you'll have to either unset it (so the
600− default gets used) or migrate the old data manually with
533+ The <literal>ipfs</literal> service now doesn't ignore the <literal>dataDir</literal> option anymore. If you've ever set this option to anything other than the default you'll have to either unset it (so the default gets used) or migrate the old data manually with
601534<programlisting>
602535dataDir=&lt;valueOfDataDir&gt;
603536mv /var/lib/ipfs/.ipfs/* $dataDir
@@ -607,107 +540,66 @@ rmdir /var/lib/ipfs/.ipfs
607540 </listitem>
608541 <listitem>
609542 <para>
610− The <literal>caddy</literal> service was previously using an extra
611− <literal>.caddy</literal> directory in the data directory specified with
612− the <literal>dataDir</literal> option. The contents of the
613− <literal>.caddy</literal> directory are now expected to be in the
614− <literal>dataDir</literal>.
543+ The <literal>caddy</literal> service was previously using an extra <literal>.caddy</literal> directory in the data directory specified with the <literal>dataDir</literal> option. The contents of the <literal>.caddy</literal> directory are now expected to be in the <literal>dataDir</literal>.
615544 </para>
616545 </listitem>
617546 <listitem>
618547 <para>
619− The <literal>ssh-agent</literal> user service is not started by default
620− anymore. Use <literal>programs.ssh.startAgent</literal> to enable it if
621− needed. There is also a new <literal>programs.gnupg.agent</literal> module
622− that creates a <literal>gpg-agent</literal> user service. It can also
623− serve as a SSH agent if <literal>enableSSHSupport</literal> is set.
548+ The <literal>ssh-agent</literal> user service is not started by default anymore. Use <literal>programs.ssh.startAgent</literal> to enable it if needed. There is also a new <literal>programs.gnupg.agent</literal> module that creates a <literal>gpg-agent</literal> user service. It can also serve as a SSH agent if <literal>enableSSHSupport</literal> is set.
624549 </para>
625550 </listitem>
626551 <listitem>
627552 <para>
628− The <literal>services.tinc.networks.&lt;name&gt;.listenAddress</literal>
629− option had a misleading name that did not correspond to its behavior. It
630− now correctly defines the ip to listen for incoming connections on. To
631− keep the previous behaviour, use
632− <literal>services.tinc.networks.&lt;name&gt;.bindToAddress</literal>
633− instead. Refer to the description of the options for more details.
553+ The <literal>services.tinc.networks.&lt;name&gt;.listenAddress</literal> option had a misleading name that did not correspond to its behavior. It now correctly defines the ip to listen for incoming connections on. To keep the previous behaviour, use <literal>services.tinc.networks.&lt;name&gt;.bindToAddress</literal> instead. Refer to the description of the options for more details.
634554 </para>
635555 </listitem>
636556 <listitem>
637557 <para>
638− <literal>tlsdate</literal> package and module were removed. This is due to
639− the project being dead and not building with openssl 1.1.
558+ <literal>tlsdate</literal> package and module were removed. This is due to the project being dead and not building with openssl 1.1.
640559 </para>
641560 </listitem>
642561 <listitem>
643562 <para>
644− <literal>wvdial</literal> package and module were removed. This is due to
645− the project being dead and not building with openssl 1.1.
563+ <literal>wvdial</literal> package and module were removed. This is due to the project being dead and not building with openssl 1.1.
646564 </para>
647565 </listitem>
648566 <listitem>
649567 <para>
650− <literal>cc-wrapper</literal>'s setup-hook now exports a number of
651− environment variables corresponding to binutils binaries, (e.g.
652− <envar>LD</envar>, <envar>STRIP</envar>, <envar>RANLIB</envar>, etc). This
653− is done to prevent packages' build systems guessing, which is harder to
654− predict, especially when cross-compiling. However, some packages have
655− broken due to this—their build systems either not supporting, or
656− claiming to support without adequate testing, taking such environment
657− variables as parameters.
568+ <literal>cc-wrapper</literal>'s setup-hook now exports a number of environment variables corresponding to binutils binaries, (e.g. <envar>LD</envar>, <envar>STRIP</envar>, <envar>RANLIB</envar>, etc). This is done to prevent packages' build systems guessing, which is harder to predict, especially when cross-compiling. However, some packages have broken due to this—their build systems either not supporting, or claiming to support without adequate testing, taking such environment variables as parameters.
658569 </para>
659570 </listitem>
660571 <listitem>
661572 <para>
662− <literal>services.firefox.syncserver</literal> now runs by default as a
663− non-root user. To accomodate this change, the default sqlite database
664− location has also been changed. Migration should work automatically. Refer
665− to the description of the options for more details.
573+ <literal>services.firefox.syncserver</literal> now runs by default as a non-root user. To accomodate this change, the default sqlite database location has also been changed. Migration should work automatically. Refer to the description of the options for more details.
666574 </para>
667575 </listitem>
668576 <listitem>
669577 <para>
670− The <literal>compiz</literal> window manager and package was removed. The
671− system support had been broken for several years.
578+ The <literal>compiz</literal> window manager and package was removed. The system support had been broken for several years.
672579 </para>
673580 </listitem>
674581 <listitem>
675582 <para>
676− Touchpad support should now be enabled through <literal>libinput</literal>
677− as <literal>synaptics</literal> is now deprecated. See the option
678− <literal>services.xserver.libinput.enable</literal>.
583+ Touchpad support should now be enabled through <literal>libinput</literal> as <literal>synaptics</literal> is now deprecated. See the option <literal>services.xserver.libinput.enable</literal>.
679584 </para>
680585 </listitem>
681586 <listitem>
682587 <para>
683− grsecurity/PaX support has been dropped, following upstream's decision to
684− cease free support. See
685− <link xlink:href="https://grsecurity.net/passing_the_baton.php">
686− upstream's announcement</link> for more information. No complete
687− replacement for grsecurity/PaX is available presently.
588+ grsecurity/PaX support has been dropped, following upstream's decision to cease free support. See <link xlink:href="https://grsecurity.net/passing_the_baton.php"> upstream's announcement</link> for more information. No complete replacement for grsecurity/PaX is available presently.
688589 </para>
689590 </listitem>
690591 <listitem>
691592 <para>
692− <literal>services.mysql</literal> now has declarative configuration of
693− databases and users with the <literal>ensureDatabases</literal> and
694− <literal>ensureUsers</literal> options.
593+ <literal>services.mysql</literal> now has declarative configuration of databases and users with the <literal>ensureDatabases</literal> and <literal>ensureUsers</literal> options.
695594 </para>
696595 <para>
697− These options will never delete existing databases and users, especially
698− not when the value of the options are changed.
596+ These options will never delete existing databases and users, especially not when the value of the options are changed.
699597 </para>
700598 <para>
701− The MySQL users will be identified using
702− <link xlink:href="https://mariadb.com/kb/en/library/authentication-plugin-unix-socket/">
703− Unix socket authentication</link>. This authenticates the Unix user with
704− the same name only, and that without the need for a password.
599+ The MySQL users will be identified using <link xlink:href="https://mariadb.com/kb/en/library/authentication-plugin-unix-socket/"> Unix socket authentication</link>. This authenticates the Unix user with the same name only, and that without the need for a password.
705600 </para>
706601 <para>
707− If you have previously created a MySQL <literal>root</literal> user
708− <emphasis>with a password</emphasis>, you will need to add
709− <literal>root</literal> user for unix socket authentication before using
710− the new options. This can be done by running the following SQL script:
602+ If you have previously created a MySQL <literal>root</literal> user <emphasis>with a password</emphasis>, you will need to add <literal>root</literal> user for unix socket authentication before using the new options. This can be done by running the following SQL script:
711603<programlisting language="sql">
712604CREATE USER 'root'@'%' IDENTIFIED BY '';
713605GRANT ALL PRIVILEGES ON *.* TO 'root'@'%' WITH GRANT OPTION;
@@ -720,55 +612,38 @@ FLUSH PRIVILEGES;
720612 </listitem>
721613 <listitem>
722614 <para>
723− <literal>services.mysqlBackup</literal> now works by default without any
724− user setup, including for users other than <literal>mysql</literal>.
615+ <literal>services.mysqlBackup</literal> now works by default without any user setup, including for users other than <literal>mysql</literal>.
725616 </para>
726617 <para>
727− By default, the <literal>mysql</literal> user is no longer the user which
728− performs the backup. Instead a system account
729− <literal>mysqlbackup</literal> is used.
618+ By default, the <literal>mysql</literal> user is no longer the user which performs the backup. Instead a system account <literal>mysqlbackup</literal> is used.
730619 </para>
731620 <para>
732− The <literal>mysqlBackup</literal> service is also now using systemd
733− timers instead of <literal>cron</literal>.
621+ The <literal>mysqlBackup</literal> service is also now using systemd timers instead of <literal>cron</literal>.
734622 </para>
735623 <para>
736− Therefore, the <literal>services.mysqlBackup.period</literal> option no
737− longer exists, and has been replaced with
738− <literal>services.mysqlBackup.calendar</literal>, which is in the format
739− of
740− <link
624+ Therefore, the <literal>services.mysqlBackup.period</literal> option no longer exists, and has been replaced with <literal>services.mysqlBackup.calendar</literal>, which is in the format of <link
741625 xlink:href="https://www.freedesktop.org/software/systemd/man/systemd.time.html#Calendar%20Events">systemd.time(7)</link>.
742626 </para>
743627 <para>
744− If you expect to be sent an e-mail when the backup fails, consider using a
745− script which monitors the systemd journal for errors. Regretfully, at
746− present there is no built-in functionality for this.
628+ If you expect to be sent an e-mail when the backup fails, consider using a script which monitors the systemd journal for errors. Regretfully, at present there is no built-in functionality for this.
747629 </para>
748630 <para>
749− You can check that backups still work by running <command>systemctl start
750− mysql-backup</command> then <command>systemctl status
751− mysql-backup</command>.
631+ You can check that backups still work by running <command>systemctl start mysql-backup</command> then <command>systemctl status mysql-backup</command>.
752632 </para>
753633 </listitem>
754634 <listitem>
755635 <para>
756− Templated systemd services e.g <literal>container@name</literal> are now
757− handled currectly when switching to a new configuration, resulting in them
758− being reloaded.
636+ Templated systemd services e.g <literal>container@name</literal> are now handled currectly when switching to a new configuration, resulting in them being reloaded.
759637 </para>
760638 </listitem>
761639 <listitem>
762640 <para>
763− Steam: the <literal>newStdcpp</literal> parameter was removed and should
764− not be needed anymore.
641+ Steam: the <literal>newStdcpp</literal> parameter was removed and should not be needed anymore.
765642 </para>
766643 </listitem>
767644 <listitem>
768645 <para>
769− Redis has been updated to version 4 which mandates a cluster mass-restart,
770− due to changes in the network handling, in order to ensure compatibility
771− with networks NATing traffic.
646+ Redis has been updated to version 4 which mandates a cluster mass-restart, due to changes in the network handling, in order to ensure compatibility with networks NATing traffic.
772647 </para>
773648 </listitem>
774649 </itemizedlist>
@@ -784,46 +659,28 @@ FLUSH PRIVILEGES;
784659 <itemizedlist>
785660 <listitem>
786661 <para>
787− Modules can now be disabled by using
788− <link
789− xlink:href="https://nixos.org/nixpkgs/manual/#sec-replace-modules">
790− disabledModules</link>, allowing another to take it's place. This can be
791− used to import a set of modules from another channel while keeping the
792− rest of the system on a stable release.
662+ Modules can now be disabled by using <link
663+ xlink:href="https://nixos.org/nixpkgs/manual/#sec-replace-modules"> disabledModules</link>, allowing another to take it's place. This can be used to import a set of modules from another channel while keeping the rest of the system on a stable release.
793664 </para>
794665 </listitem>
795666 <listitem>
796667 <para>
797− Updated to FreeType 2.7.1, including a new TrueType engine. The new engine
798− replaces the Infinality engine which was the default in NixOS. The default
799− font rendering settings are now provided by fontconfig-penultimate,
800− replacing fontconfig-ultimate; the new defaults are less invasive and
801− provide rendering that is more consistent with other systems and hopefully
802− with each font designer's intent. Some system-wide configuration has been
803− removed from the Fontconfig NixOS module where user Fontconfig settings
804− are available.
668+ Updated to FreeType 2.7.1, including a new TrueType engine. The new engine replaces the Infinality engine which was the default in NixOS. The default font rendering settings are now provided by fontconfig-penultimate, replacing fontconfig-ultimate; the new defaults are less invasive and provide rendering that is more consistent with other systems and hopefully with each font designer's intent. Some system-wide configuration has been removed from the Fontconfig NixOS module where user Fontconfig settings are available.
805669 </para>
806670 </listitem>
807671 <listitem>
808672 <para>
809− ZFS/SPL have been updated to 0.7.0, <literal>zfsUnstable,
810− splUnstable</literal> have therefore been removed.
673+ ZFS/SPL have been updated to 0.7.0, <literal>zfsUnstable, splUnstable</literal> have therefore been removed.
811674 </para>
812675 </listitem>
813676 <listitem>
814677 <para>
815− The <option>time.timeZone</option> option now allows the value
816− <literal>null</literal> in addition to timezone strings. This value allows
817− changing the timezone of a system imperatively using <command>timedatectl
818− set-timezone</command>. The default timezone is still UTC.
678+ The <option>time.timeZone</option> option now allows the value <literal>null</literal> in addition to timezone strings. This value allows changing the timezone of a system imperatively using <command>timedatectl set-timezone</command>. The default timezone is still UTC.
819679 </para>
820680 </listitem>
821681 <listitem>
822682 <para>
823− Nixpkgs overlays may now be specified with a file as well as a directory.
824− The value of <literal>&lt;nixpkgs-overlays></literal> may be a file, and
825− <filename>~/.config/nixpkgs/overlays.nix</filename> can be used instead of
826− the <filename>~/.config/nixpkgs/overlays</filename> directory.
683+ Nixpkgs overlays may now be specified with a file as well as a directory. The value of <literal>&lt;nixpkgs-overlays></literal> may be a file, and <filename>~/.config/nixpkgs/overlays.nix</filename> can be used instead of the <filename>~/.config/nixpkgs/overlays</filename> directory.
827684 </para>
828685 <para>
829686 See the overlays chapter of the Nixpkgs manual for more details.
@@ -831,67 +688,48 @@ FLUSH PRIVILEGES;
831688 </listitem>
832689 <listitem>
833690 <para>
834− Definitions for <filename>/etc/hosts</filename> can now be specified
835− declaratively with <literal>networking.hosts</literal>.
691+ Definitions for <filename>/etc/hosts</filename> can now be specified declaratively with <literal>networking.hosts</literal>.
836692 </para>
837693 </listitem>
838694 <listitem>
839695 <para>
840− Two new options have been added to the installer loader, in addition to
841− the default having changed. The kernel log verbosity has been lowered to
842− the upstream default for the default options, in order to not spam the
843− console when e.g. joining a network.
696+ Two new options have been added to the installer loader, in addition to the default having changed. The kernel log verbosity has been lowered to the upstream default for the default options, in order to not spam the console when e.g. joining a network.
844697 </para>
845698 <para>
846− This therefore leads to adding a new <literal>debug</literal> option to
847− set the log level to the previous verbose mode, to make debugging easier,
848− but still accessible easily.
699+ This therefore leads to adding a new <literal>debug</literal> option to set the log level to the previous verbose mode, to make debugging easier, but still accessible easily.
849700 </para>
850701 <para>
851− Additionally a <literal>copytoram</literal> option has been added, which
852− makes it possible to remove the install medium after booting. This allows
853− tethering from your phone after booting from it.
702+ Additionally a <literal>copytoram</literal> option has been added, which makes it possible to remove the install medium after booting. This allows tethering from your phone after booting from it.
854703 </para>
855704 </listitem>
856705 <listitem>
857706 <para>
858− <literal>services.gitlab-runner.configOptions</literal> has been added to
859− specify the configuration of gitlab-runners declaratively.
707+ <literal>services.gitlab-runner.configOptions</literal> has been added to specify the configuration of gitlab-runners declaratively.
860708 </para>
861709 </listitem>
862710 <listitem>
863711 <para>
864− <literal>services.jenkins.plugins</literal> has been added to install
865− plugins easily, this can be generated with jenkinsPlugins2nix.
712+ <literal>services.jenkins.plugins</literal> has been added to install plugins easily, this can be generated with jenkinsPlugins2nix.
866713 </para>
867714 </listitem>
868715 <listitem>
869716 <para>
870− <literal>services.postfix.config</literal> has been added to specify the
871− main.cf with NixOS options. Additionally other options have been added to
872− the postfix module and has been improved further.
717+ <literal>services.postfix.config</literal> has been added to specify the main.cf with NixOS options. Additionally other options have been added to the postfix module and has been improved further.
873718 </para>
874719 </listitem>
875720 <listitem>
876721 <para>
877− The GitLab package and module have been updated to the latest 10.0
878− release.
722+ The GitLab package and module have been updated to the latest 10.0 release.
879723 </para>
880724 </listitem>
881725 <listitem>
882726 <para>
883− The <literal>systemd-boot</literal> boot loader now lists the NixOS
884− version, kernel version and build date of all bootable generations.
727+ The <literal>systemd-boot</literal> boot loader now lists the NixOS version, kernel version and build date of all bootable generations.
885728 </para>
886729 </listitem>
887730 <listitem>
888731 <para>
889− The dnscrypt-proxy service now defaults to using a random upstream
890− resolver, selected from the list of public non-logging resolvers with
891− DNSSEC support. Existing configurations can be migrated to this mode of
892− operation by omitting the
893− <option>services.dnscrypt-proxy.resolverName</option> option or setting it
894− to <literal>"random"</literal>.
732+ The dnscrypt-proxy service now defaults to using a random upstream resolver, selected from the list of public non-logging resolvers with DNSSEC support. Existing configurations can be migrated to this mode of operation by omitting the <option>services.dnscrypt-proxy.resolverName</option> option or setting it to <literal>"random"</literal>.
895733 </para>
896734 </listitem>
897735 </itemizedlist>
nixos/doc/manual/release-notes/rl-1803.xml+56−210
@@ -13,8 +13,7 @@
1313 <title>Highlights</title>
1414
1515 <para>
16− In addition to numerous new and upgraded packages, this release has the
17− following highlights:
16+ In addition to numerous new and upgraded packages, this release has the following highlights:
1817 </para>
1918
2019 <itemizedlist>
@@ -25,48 +24,36 @@
2524 </listitem>
2625 <listitem>
2726 <para>
28− Platform support: x86_64-linux and x86_64-darwin since release time (the
29− latter isn't NixOS, really). Binaries for aarch64-linux are available, but
30− no channel exists yet, as it's waiting for some test fixes, etc.
27+ Platform support: x86_64-linux and x86_64-darwin since release time (the latter isn't NixOS, really). Binaries for aarch64-linux are available, but no channel exists yet, as it's waiting for some test fixes, etc.
3128 </para>
3229 </listitem>
3330 <listitem>
3431 <para>
35− Nix now defaults to 2.0; see its
36− <link xlink:href="https://nixos.org/nix/manual/#ssec-relnotes-2.0">release
37− notes</link>.
32+ Nix now defaults to 2.0; see its <link xlink:href="https://nixos.org/nix/manual/#ssec-relnotes-2.0">release notes</link>.
3833 </para>
3934 </listitem>
4035 <listitem>
4136 <para>
42− Core version changes: linux: 4.9 -> 4.14, glibc: 2.25 -> 2.26, gcc: 6 ->
43− 7, systemd: 234 -> 237.
37+ Core version changes: linux: 4.9 -> 4.14, glibc: 2.25 -> 2.26, gcc: 6 -> 7, systemd: 234 -> 237.
4438 </para>
4539 </listitem>
4640 <listitem>
4741 <para>
48− Desktop version changes: gnome: 3.24 -> 3.26, (KDE) plasma-desktop: 5.10
49− -> 5.12.
42+ Desktop version changes: gnome: 3.24 -> 3.26, (KDE) plasma-desktop: 5.10 -> 5.12.
5043 </para>
5144 </listitem>
5245 <listitem>
5346 <para>
54− MariaDB 10.2, updated from 10.1, is now the default MySQL implementation.
55− While upgrading a few changes have been made to the infrastructure
56− involved:
47+ MariaDB 10.2, updated from 10.1, is now the default MySQL implementation. While upgrading a few changes have been made to the infrastructure involved:
5748 <itemizedlist>
5849 <listitem>
5950 <para>
60− <literal>libmysql</literal> has been deprecated, please use
61− <literal>mysql.connector-c</literal> instead, a compatibility passthru
62− has been added to the MySQL packages.
51+ <literal>libmysql</literal> has been deprecated, please use <literal>mysql.connector-c</literal> instead, a compatibility passthru has been added to the MySQL packages.
6352 </para>
6453 </listitem>
6554 <listitem>
6655 <para>
67− The <literal>mysql57</literal> package has a new
68− <literal>static</literal> output containing the static libraries
69− including <literal>libmysqld.a</literal>
56+ The <literal>mysql57</literal> package has a new <literal>static</literal> output containing the static libraries including <literal>libmysqld.a</literal>
7057 </para>
7158 </listitem>
7259 </itemizedlist>
@@ -403,8 +390,7 @@
403390 <title>Backward Incompatibilities</title>
404391
405392 <para>
406− When upgrading from a previous release, please be aware of the following
407− incompatible changes:
393+ When upgrading from a previous release, please be aware of the following incompatible changes:
408394 </para>
409395
410396 <itemizedlist>
@@ -415,39 +401,26 @@
415401 </listitem>
416402 <listitem>
417403 <para>
418− Dollar signs in options under <option>services.postfix</option> are passed
419− verbatim to Postfix, which will interpret them as the beginning of a
420− parameter expression. This was already true for string-valued options in
421− the previous release, but not for list-valued options. If you need to pass
422− literal dollar signs through Postfix, double them.
404+ Dollar signs in options under <option>services.postfix</option> are passed verbatim to Postfix, which will interpret them as the beginning of a parameter expression. This was already true for string-valued options in the previous release, but not for list-valued options. If you need to pass literal dollar signs through Postfix, double them.
423405 </para>
424406 </listitem>
425407 <listitem>
426408 <para>
427− The <literal>postage</literal> package (for web-based PostgreSQL
428− administration) has been renamed to <literal>pgmanage</literal>. The
429− corresponding module has also been renamed. To migrate please rename all
430− <option>services.postage</option> options to
431− <option>services.pgmanage</option>.
409+ The <literal>postage</literal> package (for web-based PostgreSQL administration) has been renamed to <literal>pgmanage</literal>. The corresponding module has also been renamed. To migrate please rename all <option>services.postage</option> options to <option>services.pgmanage</option>.
432410 </para>
433411 </listitem>
434412 <listitem>
435413 <para>
436− Package attributes starting with a digit have been prefixed with an
437− underscore sign. This is to avoid quoting in the configuration and other
438− issues with command-line tools like <literal>nix-env</literal>. The change
439− affects the following packages:
414+ Package attributes starting with a digit have been prefixed with an underscore sign. This is to avoid quoting in the configuration and other issues with command-line tools like <literal>nix-env</literal>. The change affects the following packages:
440415 <itemizedlist>
441416 <listitem>
442417 <para>
443− <literal>2048-in-terminal</literal> →
444− <literal>_2048-in-terminal</literal>
418+ <literal>2048-in-terminal</literal> → <literal>_2048-in-terminal</literal>
445419 </para>
446420 </listitem>
447421 <listitem>
448422 <para>
449− <literal>90secondportraits</literal> →
450− <literal>_90secondportraits</literal>
423+ <literal>90secondportraits</literal> → <literal>_90secondportraits</literal>
451424 </para>
452425 </listitem>
453426 <listitem>
@@ -465,134 +438,77 @@
465438 </listitem>
466439 <listitem>
467440 <para>
468− <emphasis role="strong"> The OpenSSH service no longer enables support for
469− DSA keys by default, which could cause a system lock out. Update your keys
470− or, unfavorably, re-enable DSA support manually. </emphasis>
441+ <emphasis role="strong"> The OpenSSH service no longer enables support for DSA keys by default, which could cause a system lock out. Update your keys or, unfavorably, re-enable DSA support manually. </emphasis>
471442 </para>
472443 <para>
473− DSA support was
474− <link xlink:href="https://www.openssh.com/legacy.html">deprecated in
475− OpenSSH 7.0</link>, due to it being too weak. To re-enable support, add
476− <literal>PubkeyAcceptedKeyTypes +ssh-dss</literal> to the end of your
477− <option>services.openssh.extraConfig</option>.
444+ DSA support was <link xlink:href="https://www.openssh.com/legacy.html">deprecated in OpenSSH 7.0</link>, due to it being too weak. To re-enable support, add <literal>PubkeyAcceptedKeyTypes +ssh-dss</literal> to the end of your <option>services.openssh.extraConfig</option>.
478445 </para>
479446 <para>
480− After updating the keys to be stronger, anyone still on a pre-17.03
481− version is safe to jump to 17.03, as vetted
482− <link xlink:href="https://search.nix.gsc.io/?q=stateVersion">here</link>.
447+ After updating the keys to be stronger, anyone still on a pre-17.03 version is safe to jump to 17.03, as vetted <link xlink:href="https://search.nix.gsc.io/?q=stateVersion">here</link>.
483448 </para>
484449 </listitem>
485450 <listitem>
486451 <para>
487− The <literal>openssh</literal> package now includes Kerberos support by
488− default; the <literal>openssh_with_kerberos</literal> package is now a
489− deprecated alias. If you do not want Kerberos support, you can do
490− <literal>openssh.override { withKerberos = false; }</literal>. Note, this
491− also applies to the <literal>openssh_hpn</literal> package.
452+ The <literal>openssh</literal> package now includes Kerberos support by default; the <literal>openssh_with_kerberos</literal> package is now a deprecated alias. If you do not want Kerberos support, you can do <literal>openssh.override { withKerberos = false; }</literal>. Note, this also applies to the <literal>openssh_hpn</literal> package.
492453 </para>
493454 </listitem>
494455 <listitem>
495456 <para>
496− <literal>cc-wrapper</literal> has been split in two; there is now also a
497− <literal>bintools-wrapper</literal>. The most commonly used files in
498− <filename>nix-support</filename> are now split between the two wrappers.
499− Some commonly used ones, like
500− <filename>nix-support/dynamic-linker</filename>, are duplicated for
501− backwards compatability, even though they rightly belong only in
502− <literal>bintools-wrapper</literal>. Other more obscure ones are just
503− moved.
457+ <literal>cc-wrapper</literal> has been split in two; there is now also a <literal>bintools-wrapper</literal>. The most commonly used files in <filename>nix-support</filename> are now split between the two wrappers. Some commonly used ones, like <filename>nix-support/dynamic-linker</filename>, are duplicated for backwards compatability, even though they rightly belong only in <literal>bintools-wrapper</literal>. Other more obscure ones are just moved.
504458 </para>
505459 </listitem>
506460 <listitem>
507461 <para>
508− The propagation logic has been changed. The new logic, along with new
509− types of dependencies that go with, is thoroughly documented in the
510− "Specifying dependencies" section of the "Standard Environment" chapter of
511− the nixpkgs manual.
462+ The propagation logic has been changed. The new logic, along with new types of dependencies that go with, is thoroughly documented in the "Specifying dependencies" section of the "Standard Environment" chapter of the nixpkgs manual.
512463<!-- That's <xref linkend="ssec-stdenv-attributes"> were we to merge the manuals. -->
513− The old logic isn't but is easy to describe: dependencies were propagated
514− as the same type of dependency no matter what. In practice, that means
515− that many <function>propagatedNativeBuildInputs</function> should instead
516− be <function>propagatedBuildInputs</function>. Thankfully, that was and is
517− the least used type of dependency. Also, it means that some
518− <function>propagatedBuildInputs</function> should instead be
519− <function>depsTargetTargetPropagated</function>. Other types dependencies
520− should be unaffected.
464+ The old logic isn't but is easy to describe: dependencies were propagated as the same type of dependency no matter what. In practice, that means that many <function>propagatedNativeBuildInputs</function> should instead be <function>propagatedBuildInputs</function>. Thankfully, that was and is the least used type of dependency. Also, it means that some <function>propagatedBuildInputs</function> should instead be <function>depsTargetTargetPropagated</function>. Other types dependencies should be unaffected.
521465 </para>
522466 </listitem>
523467 <listitem>
524468 <para>
525− <literal>lib.addPassthru drv passthru</literal> is removed. Use
526− <literal>lib.extendDerivation true passthru drv</literal> instead.
469+ <literal>lib.addPassthru drv passthru</literal> is removed. Use <literal>lib.extendDerivation true passthru drv</literal> instead.
527470 </para>
528471 </listitem>
529472 <listitem>
530473 <para>
531− The <literal>memcached</literal> service no longer accept dynamic socket
532− paths via <option>services.memcached.socket</option>. Unix sockets can be
533− still enabled by <option>services.memcached.enableUnixSocket</option> and
534− will be accessible at <literal>/run/memcached/memcached.sock</literal>.
474+ The <literal>memcached</literal> service no longer accept dynamic socket paths via <option>services.memcached.socket</option>. Unix sockets can be still enabled by <option>services.memcached.enableUnixSocket</option> and will be accessible at <literal>/run/memcached/memcached.sock</literal>.
535475 </para>
536476 </listitem>
537477 <listitem>
538478 <para>
539− The <varname>hardware.amdHybridGraphics.disable</varname> option was
540− removed for lack of a maintainer. If you still need this module, you may
541− wish to include a copy of it from an older version of nixos in your
542− imports.
479+ The <varname>hardware.amdHybridGraphics.disable</varname> option was removed for lack of a maintainer. If you still need this module, you may wish to include a copy of it from an older version of nixos in your imports.
543480 </para>
544481 </listitem>
545482 <listitem>
546483 <para>
547− The merging of config options for
548− <varname>services.postfix.config</varname> was buggy. Previously, if other
549− options in the Postfix module like
550− <varname>services.postfix.useSrs</varname> were set and the user set
551− config options that were also set by such options, the resulting config
552− wouldn't include all options that were needed. They are now merged
553− correctly. If config options need to be overridden,
554− <literal>lib.mkForce</literal> or <literal>lib.mkOverride</literal> can be
555− used.
484+ The merging of config options for <varname>services.postfix.config</varname> was buggy. Previously, if other options in the Postfix module like <varname>services.postfix.useSrs</varname> were set and the user set config options that were also set by such options, the resulting config wouldn't include all options that were needed. They are now merged correctly. If config options need to be overridden, <literal>lib.mkForce</literal> or <literal>lib.mkOverride</literal> can be used.
556485 </para>
557486 </listitem>
558487 <listitem>
559488 <para>
560− The following changes apply if the <literal>stateVersion</literal> is
561− changed to 18.03 or higher. For <literal>stateVersion = "17.09"</literal>
562− or lower the old behavior is preserved.
489+ The following changes apply if the <literal>stateVersion</literal> is changed to 18.03 or higher. For <literal>stateVersion = "17.09"</literal> or lower the old behavior is preserved.
563490 </para>
564491 <itemizedlist>
565492 <listitem>
566493 <para>
567− <literal>matrix-synapse</literal> uses postgresql by default instead of
568− sqlite. Migration instructions can be found
569− <link xlink:href="https://github.com/matrix-org/synapse/blob/master/docs/postgres.rst#porting-from-sqlite">
570− here </link>.
494+ <literal>matrix-synapse</literal> uses postgresql by default instead of sqlite. Migration instructions can be found <link xlink:href="https://github.com/matrix-org/synapse/blob/master/docs/postgres.rst#porting-from-sqlite"> here </link>.
571495 </para>
572496 </listitem>
573497 </itemizedlist>
574498 </listitem>
575499 <listitem>
576500 <para>
577− The <literal>jid</literal> package has been removed, due to maintenance
578− overhead of a go package having non-versioned dependencies.
501+ The <literal>jid</literal> package has been removed, due to maintenance overhead of a go package having non-versioned dependencies.
579502 </para>
580503 </listitem>
581504 <listitem>
582505 <para>
583− When using <option>services.xserver.libinput</option> (enabled by default
584− in GNOME), it now handles all input devices, not just touchpads. As a
585− result, you might need to re-evaluate any custom Xorg configuration. In
586− particular, <literal>Option "XkbRules" "base"</literal> may result in
587− broken keyboard layout.
506+ When using <option>services.xserver.libinput</option> (enabled by default in GNOME), it now handles all input devices, not just touchpads. As a result, you might need to re-evaluate any custom Xorg configuration. In particular, <literal>Option "XkbRules" "base"</literal> may result in broken keyboard layout.
588507 </para>
589508 </listitem>
590509 <listitem>
591510 <para>
592− The <literal>attic</literal> package was removed. A maintained fork called
593− <link xlink:href="https://www.borgbackup.org/">Borg</link> should be used
594− instead. Migration instructions can be found
595− <link xlink:href="http://borgbackup.readthedocs.io/en/stable/usage/upgrade.html#attic-and-borg-0-xx-to-borg-1-x">here</link>.
511+ The <literal>attic</literal> package was removed. A maintained fork called <link xlink:href="https://www.borgbackup.org/">Borg</link> should be used instead. Migration instructions can be found <link xlink:href="http://borgbackup.readthedocs.io/en/stable/usage/upgrade.html#attic-and-borg-0-xx-to-borg-1-x">here</link>.
596512 </para>
597513 </listitem>
598514 <listitem>
@@ -601,52 +517,32 @@
601517 <itemizedlist>
602518 <listitem>
603519 <para>
604− The package <literal>pkgs.piwik</literal> was renamed to
605− <literal>pkgs.matomo</literal>.
520+ The package <literal>pkgs.piwik</literal> was renamed to <literal>pkgs.matomo</literal>.
606521 </para>
607522 </listitem>
608523 <listitem>
609524 <para>
610− The service <literal>services.piwik</literal> was renamed to
611− <literal>services.matomo</literal>.
525+ The service <literal>services.piwik</literal> was renamed to <literal>services.matomo</literal>.
612526 </para>
613527 </listitem>
614528 <listitem>
615529 <para>
616− The data directory <filename>/var/lib/piwik</filename> was renamed to
617− <filename>/var/lib/matomo</filename>. All files will be moved
618− automatically on first startup, but you might need to adjust your
619− backup scripts.
530+ The data directory <filename>/var/lib/piwik</filename> was renamed to <filename>/var/lib/matomo</filename>. All files will be moved automatically on first startup, but you might need to adjust your backup scripts.
620531 </para>
621532 </listitem>
622533 <listitem>
623534 <para>
624− The default <option>serverName</option> for the nginx configuration
625− changed from <literal>piwik.${config.networking.hostName}</literal> to
626− <literal>matomo.${config.networking.hostName}.${config.networking.domain}</literal>
627− if <option>config.networking.domain</option> is set,
628− <literal>matomo.${config.networking.hostName}</literal> if it is not
629− set. If you change your <option>serverName</option>, remember you'll
630− need to update the <literal>trustedHosts[]</literal> array in
631− <filename>/var/lib/matomo/config/config.ini.php</filename> as well.
535+ The default <option>serverName</option> for the nginx configuration changed from <literal>piwik.${config.networking.hostName}</literal> to <literal>matomo.${config.networking.hostName}.${config.networking.domain}</literal> if <option>config.networking.domain</option> is set, <literal>matomo.${config.networking.hostName}</literal> if it is not set. If you change your <option>serverName</option>, remember you'll need to update the <literal>trustedHosts[]</literal> array in <filename>/var/lib/matomo/config/config.ini.php</filename> as well.
632536 </para>
633537 </listitem>
634538 <listitem>
635539 <para>
636− The <literal>piwik</literal> user was renamed to
637− <literal>matomo</literal>. The service will adjust ownership
638− automatically for files in the data directory. If you use unix socket
639− authentication, remember to give the new <literal>matomo</literal> user
640− access to the database and to change the <literal>username</literal> to
641− <literal>matomo</literal> in the <literal>[database]</literal> section
642− of <filename>/var/lib/matomo/config/config.ini.php</filename>.
540+ The <literal>piwik</literal> user was renamed to <literal>matomo</literal>. The service will adjust ownership automatically for files in the data directory. If you use unix socket authentication, remember to give the new <literal>matomo</literal> user access to the database and to change the <literal>username</literal> to <literal>matomo</literal> in the <literal>[database]</literal> section of <filename>/var/lib/matomo/config/config.ini.php</filename>.
643541 </para>
644542 </listitem>
645543 <listitem>
646544 <para>
647− If you named your database `piwik`, you might want to rename it to
648− `matomo` to keep things clean, but this is neither enforced nor
649− required.
545+ If you named your database `piwik`, you might want to rename it to `matomo` to keep things clean, but this is neither enforced nor required.
650546 </para>
651547 </listitem>
652548 </itemizedlist>
@@ -654,59 +550,43 @@
654550 </listitem>
655551 <listitem>
656552 <para>
657− <literal>nodejs-4_x</literal> is end-of-life.
658− <literal>nodejs-4_x</literal>, <literal>nodejs-slim-4_x</literal> and
659− <literal>nodePackages_4_x</literal> are removed.
553+ <literal>nodejs-4_x</literal> is end-of-life. <literal>nodejs-4_x</literal>, <literal>nodejs-slim-4_x</literal> and <literal>nodePackages_4_x</literal> are removed.
660554 </para>
661555 </listitem>
662556 <listitem>
663557 <para>
664− The <literal>pump.io</literal> NixOS module was removed. It is now
665− maintained as an
666− <link xlink:href="https://github.com/rvl/pump.io-nixos">external
667− module</link>.
558+ The <literal>pump.io</literal> NixOS module was removed. It is now maintained as an <link xlink:href="https://github.com/rvl/pump.io-nixos">external module</link>.
668559 </para>
669560 </listitem>
670561 <listitem>
671562 <para>
672− The Prosody XMPP server has received a major update. The following modules
673− were renamed:
563+ The Prosody XMPP server has received a major update. The following modules were renamed:
674564 <itemizedlist>
675565 <listitem>
676566 <para>
677− <option>services.prosody.modules.httpserver</option> is now
678− <option>services.prosody.modules.http_files</option>
567+ <option>services.prosody.modules.httpserver</option> is now <option>services.prosody.modules.http_files</option>
679568 </para>
680569 </listitem>
681570 <listitem>
682571 <para>
683− <option>services.prosody.modules.console</option> is now
684− <option>services.prosody.modules.admin_telnet</option>
572+ <option>services.prosody.modules.console</option> is now <option>services.prosody.modules.admin_telnet</option>
685573 </para>
686574 </listitem>
687575 </itemizedlist>
688576 </para>
689577 <para>
690− Many new modules are now core modules, most notably
691− <option>services.prosody.modules.carbons</option> and
692− <option>services.prosody.modules.mam</option>.
578+ Many new modules are now core modules, most notably <option>services.prosody.modules.carbons</option> and <option>services.prosody.modules.mam</option>.
693579 </para>
694580 <para>
695− The better-performing <literal>libevent</literal> backend is now enabled
696− by default.
581+ The better-performing <literal>libevent</literal> backend is now enabled by default.
697582 </para>
698583 <para>
699− <literal>withCommunityModules</literal> now passes through the modules to
700− <option>services.prosody.extraModules</option>. Use
701− <literal>withOnlyInstalledCommunityModules</literal> for modules that
702− should not be enabled directly, e.g <literal>lib_ldap</literal>.
584+ <literal>withCommunityModules</literal> now passes through the modules to <option>services.prosody.extraModules</option>. Use <literal>withOnlyInstalledCommunityModules</literal> for modules that should not be enabled directly, e.g <literal>lib_ldap</literal>.
703585 </para>
704586 </listitem>
705587 <listitem>
706588 <para>
707− All prometheus exporter modules are now defined as submodules. The
708− exporters are configured using
709− <literal>services.prometheus.exporters</literal>.
589+ All prometheus exporter modules are now defined as submodules. The exporters are configured using <literal>services.prometheus.exporters</literal>.
710590 </para>
711591 </listitem>
712592 </itemizedlist>
@@ -722,24 +602,17 @@
722602 <itemizedlist>
723603 <listitem>
724604 <para>
725− ZNC option <option>services.znc.mutable</option> now defaults to
726− <literal>true</literal>. That means that old configuration is not
727− overwritten by default when update to the znc options are made.
605+ ZNC option <option>services.znc.mutable</option> now defaults to <literal>true</literal>. That means that old configuration is not overwritten by default when update to the znc options are made.
728606 </para>
729607 </listitem>
730608 <listitem>
731609 <para>
732− The option <option>networking.wireless.networks.&lt;name&gt;.auth</option>
733− has been added for wireless networks with WPA-Enterprise authentication.
734− There is also a new <option>extraConfig</option> option to directly
735− configure <literal>wpa_supplicant</literal> and <option>hidden</option> to
736− connect to hidden networks.
610+ The option <option>networking.wireless.networks.&lt;name&gt;.auth</option> has been added for wireless networks with WPA-Enterprise authentication. There is also a new <option>extraConfig</option> option to directly configure <literal>wpa_supplicant</literal> and <option>hidden</option> to connect to hidden networks.
737611 </para>
738612 </listitem>
739613 <listitem>
740614 <para>
741− In the module <option>networking.interfaces.&lt;name&gt;</option> the
742− following options have been removed:
615+ In the module <option>networking.interfaces.&lt;name&gt;</option> the following options have been removed:
743616 <itemizedlist>
744617 <listitem>
745618 <para>
@@ -767,34 +640,22 @@
767640 </para>
768641 </listitem>
769642 </itemizedlist>
770− To assign static addresses to an interface the options
771− <option>ipv4.addresses</option> and <option>ipv6.addresses</option> should
772− be used instead. The options <option>ip4</option> and <option>ip6</option>
773− have been renamed to <option>ipv4.addresses</option>
774− <option>ipv6.addresses</option> respectively. The new options
775− <option>ipv4.routes</option> and <option>ipv6.routes</option> have been
776− added to set up static routing.
643+ To assign static addresses to an interface the options <option>ipv4.addresses</option> and <option>ipv6.addresses</option> should be used instead. The options <option>ip4</option> and <option>ip6</option> have been renamed to <option>ipv4.addresses</option> <option>ipv6.addresses</option> respectively. The new options <option>ipv4.routes</option> and <option>ipv6.routes</option> have been added to set up static routing.
777644 </para>
778645 </listitem>
779646 <listitem>
780647 <para>
781− The option <option>services.logstash.listenAddress</option> is now
782− <literal>127.0.0.1</literal> by default. Previously the default behaviour
783− was to listen on all interfaces.
648+ The option <option>services.logstash.listenAddress</option> is now <literal>127.0.0.1</literal> by default. Previously the default behaviour was to listen on all interfaces.
784649 </para>
785650 </listitem>
786651 <listitem>
787652 <para>
788− <literal>services.btrfs.autoScrub</literal> has been added, to
789− periodically check btrfs filesystems for data corruption. If there's a
790− correct copy available, it will automatically repair corrupted blocks.
653+ <literal>services.btrfs.autoScrub</literal> has been added, to periodically check btrfs filesystems for data corruption. If there's a correct copy available, it will automatically repair corrupted blocks.
791654 </para>
792655 </listitem>
793656 <listitem>
794657 <para>
795− <literal>displayManager.lightdm.greeters.gtk.clock-format.</literal> has
796− been added, the clock format string (as expected by strftime, e.g.
797− <literal>%H:%M</literal>) to use with the lightdm gtk greeter panel.
658+ <literal>displayManager.lightdm.greeters.gtk.clock-format.</literal> has been added, the clock format string (as expected by strftime, e.g. <literal>%H:%M</literal>) to use with the lightdm gtk greeter panel.
798659 </para>
799660 <para>
800661 If set to null the default clock format is used.
@@ -802,17 +663,10 @@
802663 </listitem>
803664 <listitem>
804665 <para>
805− <literal>displayManager.lightdm.greeters.gtk.indicators</literal> has been
806− added, a list of allowed indicator modules to use with the lightdm gtk
807− greeter panel.
666+ <literal>displayManager.lightdm.greeters.gtk.indicators</literal> has been added, a list of allowed indicator modules to use with the lightdm gtk greeter panel.
808667 </para>
809668 <para>
810− Built-in indicators include <literal>~a11y</literal>,
811− <literal>~language</literal>, <literal>~session</literal>,
812− <literal>~power</literal>, <literal>~clock</literal>,
813− <literal>~host</literal>, <literal>~spacer</literal>. Unity indicators can
814− be represented by short name (e.g. <literal>sound</literal>,
815− <literal>power</literal>), service file name, or absolute path.
669+ Built-in indicators include <literal>~a11y</literal>, <literal>~language</literal>, <literal>~session</literal>, <literal>~power</literal>, <literal>~clock</literal>, <literal>~host</literal>, <literal>~spacer</literal>. Unity indicators can be represented by short name (e.g. <literal>sound</literal>, <literal>power</literal>), service file name, or absolute path.
816670 </para>
817671 <para>
818672 If set to <literal>null</literal> the default indicators are used.
@@ -834,20 +688,12 @@
834688 </listitem>
835689 <listitem>
836690 <para>
837− The NixOS test driver supports user services declared by
838− <literal>systemd.user.services</literal>. The methods
839− <literal>waitForUnit</literal>, <literal>getUnitInfo</literal>,
840− <literal>startJob</literal> and <literal>stopJob</literal> provide an
841− optional <literal>$user</literal> argument for that purpose.
691+ The NixOS test driver supports user services declared by <literal>systemd.user.services</literal>. The methods <literal>waitForUnit</literal>, <literal>getUnitInfo</literal>, <literal>startJob</literal> and <literal>stopJob</literal> provide an optional <literal>$user</literal> argument for that purpose.
842692 </para>
843693 </listitem>
844694 <listitem>
845695 <para>
846− Enabling bash completion on NixOS,
847− <literal>programs.bash.enableCompletion</literal>, will now also enable
848− completion for the Nix command line tools by installing the
849− <link xlink:href="https://github.com/hedning/nix-bash-completions">nix-bash-completions</link>
850− package.
696+ Enabling bash completion on NixOS, <literal>programs.bash.enableCompletion</literal>, will now also enable completion for the Nix command line tools by installing the <link xlink:href="https://github.com/hedning/nix-bash-completions">nix-bash-completions</link> package.
851697 </para>
852698 </listitem>
853699 </itemizedlist>
nixos/doc/manual/release-notes/rl-1809.xml+69−242
@@ -13,8 +13,7 @@
1313 <title>Highlights</title>
1414
1515 <para>
16− In addition to numerous new and upgraded packages, this release has the
17− following notable updates:
16+ In addition to numerous new and upgraded packages, this release has the following notable updates:
1817 </para>
1918
2019 <itemizedlist>
@@ -25,28 +24,22 @@
2524 </listitem>
2625 <listitem>
2726 <para>
28− Platform support: x86_64-linux and x86_64-darwin as always. Support for
29− aarch64-linux is as with the previous releases, not equivalent to the
30− x86-64-linux release, but with efforts to reach parity.
27+ Platform support: x86_64-linux and x86_64-darwin as always. Support for aarch64-linux is as with the previous releases, not equivalent to the x86-64-linux release, but with efforts to reach parity.
3128 </para>
3229 </listitem>
3330 <listitem>
3431 <para>
35− Nix has been updated to 2.1; see its
36− <link xlink:href="https://nixos.org/nix/manual/#ssec-relnotes-2.1">release
37− notes</link>.
32+ Nix has been updated to 2.1; see its <link xlink:href="https://nixos.org/nix/manual/#ssec-relnotes-2.1">release notes</link>.
3833 </para>
3934 </listitem>
4035 <listitem>
4136 <para>
42− Core versions: linux: 4.14 LTS (unchanged), glibc: 2.26 → 2.27, gcc: 7
43− (unchanged), systemd: 237 → 239.
37+ Core versions: linux: 4.14 LTS (unchanged), glibc: 2.26 → 2.27, gcc: 7 (unchanged), systemd: 237 → 239.
4438 </para>
4539 </listitem>
4640 <listitem>
4741 <para>
48− Desktop version changes: gnome: 3.26 → 3.28, (KDE) plasma-desktop: 5.12
49− → 5.13.
42+ Desktop version changes: gnome: 3.26 → 3.28, (KDE) plasma-desktop: 5.12 → 5.13.
5043 </para>
5144 </listitem>
5245 </itemizedlist>
@@ -58,8 +51,7 @@
5851 <itemizedlist>
5952 <listitem>
6053 <para>
61− Support for wrapping binaries using <literal>firejail</literal> has been
62− added through <varname>programs.firejail.wrappedBinaries</varname>.
54+ Support for wrapping binaries using <literal>firejail</literal> has been added through <varname>programs.firejail.wrappedBinaries</varname>.
6355 </para>
6456 <para>
6557 For example
@@ -74,17 +66,12 @@ programs.firejail = {
7466};
7567</programlisting>
7668 <para>
77− This will place <literal>firefox</literal> and <literal>mpv</literal>
78− binaries in the global path wrapped by firejail.
69+ This will place <literal>firefox</literal> and <literal>mpv</literal> binaries in the global path wrapped by firejail.
7970 </para>
8071 </listitem>
8172 <listitem>
8273 <para>
83− User channels are now in the default <literal>NIX_PATH</literal>, allowing
84− users to use their personal <command>nix-channel</command> defined
85− channels in <command>nix-build</command> and <command>nix-shell</command>
86− commands, as well as in imports like <code>import
87− &lt;mychannel&gt;</code>.
74+ User channels are now in the default <literal>NIX_PATH</literal>, allowing users to use their personal <command>nix-channel</command> defined channels in <command>nix-build</command> and <command>nix-shell</command> commands, as well as in imports like <code>import &lt;mychannel&gt;</code>.
8875 </para>
8976 <para>
9077 For example
@@ -114,52 +101,31 @@ $ nix-instantiate -E '(import &lt;nixpkgsunstable&gt; {}).gitFull'
114101 <itemizedlist>
115102 <listitem>
116103 <para>
117− The <varname>services.cassandra</varname> module has been reworked and was
118− rewritten from scratch. The service has succeeding tests for the versions
119− 2.1, 2.2, 3.0 and 3.11 of
120− <link
121− xlink:href="https://cassandra.apache.org/">Apache
122− Cassandra</link>.
104+ The <varname>services.cassandra</varname> module has been reworked and was rewritten from scratch. The service has succeeding tests for the versions 2.1, 2.2, 3.0 and 3.11 of <link
105+ xlink:href="https://cassandra.apache.org/">Apache Cassandra</link>.
123106 </para>
124107 </listitem>
125108 <listitem>
126109 <para>
127− There is a new <varname>services.foundationdb</varname> module for
128− deploying
129− <link xlink:href="https://www.foundationdb.org">FoundationDB</link>
130− clusters.
110+ There is a new <varname>services.foundationdb</varname> module for deploying <link xlink:href="https://www.foundationdb.org">FoundationDB</link> clusters.
131111 </para>
132112 </listitem>
133113 <listitem>
134114 <para>
135− When enabled the <literal>iproute2</literal> will copy the files expected
136− by ip route (e.g., <filename>rt_tables</filename>) in
137− <filename>/etc/iproute2</filename>. This allows to write aliases for
138− routing tables for instance.
115+ When enabled the <literal>iproute2</literal> will copy the files expected by ip route (e.g., <filename>rt_tables</filename>) in <filename>/etc/iproute2</filename>. This allows to write aliases for routing tables for instance.
139116 </para>
140117 </listitem>
141118 <listitem>
142119 <para>
143− <varname>services.strongswan-swanctl</varname> is a modern replacement for
144− <varname>services.strongswan</varname>. You can use either one of them to
145− setup IPsec VPNs but not both at the same time.
120+ <varname>services.strongswan-swanctl</varname> is a modern replacement for <varname>services.strongswan</varname>. You can use either one of them to setup IPsec VPNs but not both at the same time.
146121 </para>
147122 <para>
148− <varname>services.strongswan-swanctl</varname> uses the
149− <link xlink:href="https://wiki.strongswan.org/projects/strongswan/wiki/swanctl">swanctl</link>
150− command which uses the modern
151− <link xlink:href="https://github.com/strongswan/strongswan/blob/master/src/libcharon/plugins/vici/README.md">vici</link>
152− <emphasis>Versatile IKE Configuration Interface</emphasis>. The deprecated
153− <literal>ipsec</literal> command used in
154− <varname>services.strongswan</varname> is using the legacy
155− <link xlink:href="https://github.com/strongswan/strongswan/blob/master/README_LEGACY.md">stroke
156− configuration interface</link>.
123+ <varname>services.strongswan-swanctl</varname> uses the <link xlink:href="https://wiki.strongswan.org/projects/strongswan/wiki/swanctl">swanctl</link> command which uses the modern <link xlink:href="https://github.com/strongswan/strongswan/blob/master/src/libcharon/plugins/vici/README.md">vici</link> <emphasis>Versatile IKE Configuration Interface</emphasis>. The deprecated <literal>ipsec</literal> command used in <varname>services.strongswan</varname> is using the legacy <link xlink:href="https://github.com/strongswan/strongswan/blob/master/README_LEGACY.md">stroke configuration interface</link>.
157124 </para>
158125 </listitem>
159126 <listitem>
160127 <para>
161− The new <varname>services.elasticsearch-curator</varname> service
162− periodically curates or manages, your Elasticsearch indices and snapshots.
128+ The new <varname>services.elasticsearch-curator</varname> service periodically curates or manages, your Elasticsearch indices and snapshots.
163129 </para>
164130 </listitem>
165131 </itemizedlist>
@@ -470,38 +436,32 @@ $ nix-instantiate -E '(import &lt;nixpkgsunstable&gt; {}).gitFull'
470436 <title>Backward Incompatibilities</title>
471437
472438 <para>
473− When upgrading from a previous release, please be aware of the following
474− incompatible changes:
439+ When upgrading from a previous release, please be aware of the following incompatible changes:
475440 </para>
476441
477442 <itemizedlist>
478443 <listitem>
479444 <para>
480− Some licenses that were incorrectly not marked as unfree now are. This is
481− the case for:
445+ Some licenses that were incorrectly not marked as unfree now are. This is the case for:
482446 <itemizedlist>
483447 <listitem>
484448 <para>
485− cc-by-nc-sa-20: Creative Commons Attribution Non Commercial Share Alike
486− 2.0
449+ cc-by-nc-sa-20: Creative Commons Attribution Non Commercial Share Alike 2.0
487450 </para>
488451 </listitem>
489452 <listitem>
490453 <para>
491− cc-by-nc-sa-25: Creative Commons Attribution Non Commercial Share Alike
492− 2.5
454+ cc-by-nc-sa-25: Creative Commons Attribution Non Commercial Share Alike 2.5
493455 </para>
494456 </listitem>
495457 <listitem>
496458 <para>
497− cc-by-nc-sa-30: Creative Commons Attribution Non Commercial Share Alike
498− 3.0
459+ cc-by-nc-sa-30: Creative Commons Attribution Non Commercial Share Alike 3.0
499460 </para>
500461 </listitem>
501462 <listitem>
502463 <para>
503− cc-by-nc-sa-40: Creative Commons Attribution Non Commercial Share Alike
504− 4.0
464+ cc-by-nc-sa-40: Creative Commons Attribution Non Commercial Share Alike 4.0
505465 </para>
506466 </listitem>
507467 <listitem>
@@ -519,128 +479,71 @@ $ nix-instantiate -E '(import &lt;nixpkgsunstable&gt; {}).gitFull'
519479 </listitem>
520480 <listitem>
521481 <para>
522− The deprecated <varname>services.cassandra</varname> module has seen a
523− complete rewrite. (See above.)
482+ The deprecated <varname>services.cassandra</varname> module has seen a complete rewrite. (See above.)
524483 </para>
525484 </listitem>
526485 <listitem>
527486 <para>
528− <literal>lib.strict</literal> is removed. Use
529− <literal>builtins.seq</literal> instead.
487+ <literal>lib.strict</literal> is removed. Use <literal>builtins.seq</literal> instead.
530488 </para>
531489 </listitem>
532490 <listitem>
533491 <para>
534− The <literal>clementine</literal> package points now to the free
535− derivation. <literal>clementineFree</literal> is removed now and
536− <literal>clementineUnfree</literal> points to the package which is bundled
537− with the unfree <literal>libspotify</literal> package.
492+ The <literal>clementine</literal> package points now to the free derivation. <literal>clementineFree</literal> is removed now and <literal>clementineUnfree</literal> points to the package which is bundled with the unfree <literal>libspotify</literal> package.
538493 </para>
539494 </listitem>
540495 <listitem>
541496 <para>
542− The <literal>netcat</literal> package is now taken directly from OpenBSD's
543− <literal>libressl</literal>, instead of relying on Debian's fork. The new
544− version should be very close to the old version, but there are some minor
545− differences. Importantly, flags like -b, -q, -C, and -Z are no longer
546− accepted by the nc command.
497+ The <literal>netcat</literal> package is now taken directly from OpenBSD's <literal>libressl</literal>, instead of relying on Debian's fork. The new version should be very close to the old version, but there are some minor differences. Importantly, flags like -b, -q, -C, and -Z are no longer accepted by the nc command.
547498 </para>
548499 </listitem>
549500 <listitem>
550501 <para>
551− The <varname>services.docker-registry.extraConfig</varname> object doesn't
552− contain environment variables anymore. Instead it needs to provide an
553− object structure that can be mapped onto the YAML configuration defined in
554− <link xlink:href="https://github.com/docker/distribution/blob/v2.6.2/docs/configuration.md">the
555− <varname>docker/distribution</varname> docs</link>.
502+ The <varname>services.docker-registry.extraConfig</varname> object doesn't contain environment variables anymore. Instead it needs to provide an object structure that can be mapped onto the YAML configuration defined in <link xlink:href="https://github.com/docker/distribution/blob/v2.6.2/docs/configuration.md">the <varname>docker/distribution</varname> docs</link>.
556503 </para>
557504 </listitem>
558505 <listitem>
559506 <para>
560− <literal>gnucash</literal> has changed from version 2.4 to 3.x. If you've
561− been using <literal>gnucash</literal> (version 2.4) instead of
562− <literal>gnucash26</literal> (version 2.6) you must open your Gnucash data
563− file(s) with <literal>gnucash26</literal> and then save them to upgrade
564− the file format. Then you may use your data file(s) with Gnucash 3.x. See
565− the upgrade
566− <link xlink:href="https://wiki.gnucash.org/wiki/FAQ#Using_Different_Versions.2C_Up_And_Downgrade">documentation</link>.
567− Gnucash 2.4 is still available under the attribute
568− <literal>gnucash24</literal>.
507+ <literal>gnucash</literal> has changed from version 2.4 to 3.x. If you've been using <literal>gnucash</literal> (version 2.4) instead of <literal>gnucash26</literal> (version 2.6) you must open your Gnucash data file(s) with <literal>gnucash26</literal> and then save them to upgrade the file format. Then you may use your data file(s) with Gnucash 3.x. See the upgrade <link xlink:href="https://wiki.gnucash.org/wiki/FAQ#Using_Different_Versions.2C_Up_And_Downgrade">documentation</link>. Gnucash 2.4 is still available under the attribute <literal>gnucash24</literal>.
569508 </para>
570509 </listitem>
571510 <listitem>
572511 <para>
573− <varname>services.munge</varname> now runs as user (and group)
574− <literal>munge</literal> instead of root. Make sure the key file is
575− accessible to the daemon.
512+ <varname>services.munge</varname> now runs as user (and group) <literal>munge</literal> instead of root. Make sure the key file is accessible to the daemon.
576513 </para>
577514 </listitem>
578515 <listitem>
579516 <para>
580− <varname>dockerTools.buildImage</varname> now uses <literal>null</literal>
581− as default value for <varname>tag</varname>, which indicates that the nix
582− output hash will be used as tag.
517+ <varname>dockerTools.buildImage</varname> now uses <literal>null</literal> as default value for <varname>tag</varname>, which indicates that the nix output hash will be used as tag.
583518 </para>
584519 </listitem>
585520 <listitem>
586521 <para>
587− The ELK stack: <varname>elasticsearch</varname>,
588− <varname>logstash</varname> and <varname>kibana</varname> has been
589− upgraded from 2.* to 6.3.*. The 2.* versions have been
590− <link xlink:href="https://www.elastic.co/support/eol">unsupported since
591− last year</link> so they have been removed. You can still use the 5.*
592− versions under the names <varname>elasticsearch5</varname>,
593− <varname>logstash5</varname> and <varname>kibana5</varname>.
522+ The ELK stack: <varname>elasticsearch</varname>, <varname>logstash</varname> and <varname>kibana</varname> has been upgraded from 2.* to 6.3.*. The 2.* versions have been <link xlink:href="https://www.elastic.co/support/eol">unsupported since last year</link> so they have been removed. You can still use the 5.* versions under the names <varname>elasticsearch5</varname>, <varname>logstash5</varname> and <varname>kibana5</varname>.
594523 </para>
595524 <para>
596− The elastic beats: <varname>filebeat</varname>,
597− <varname>heartbeat</varname>, <varname>metricbeat</varname> and
598− <varname>packetbeat</varname> have had the same treatment: they now target
599− 6.3.* as well. The 5.* versions are available under the names:
600− <varname>filebeat5</varname>, <varname>heartbeat5</varname>,
601− <varname>metricbeat5</varname> and <varname>packetbeat5</varname>
525+ The elastic beats: <varname>filebeat</varname>, <varname>heartbeat</varname>, <varname>metricbeat</varname> and <varname>packetbeat</varname> have had the same treatment: they now target 6.3.* as well. The 5.* versions are available under the names: <varname>filebeat5</varname>, <varname>heartbeat5</varname>, <varname>metricbeat5</varname> and <varname>packetbeat5</varname>
602526 </para>
603527 <para>
604− The ELK-6.3 stack now comes with
605− <link xlink:href="https://www.elastic.co/products/x-pack/open">X-Pack by
606− default</link>. Since X-Pack is licensed under the
607− <link xlink:href="https://github.com/elastic/elasticsearch/blob/master/licenses/ELASTIC-LICENSE.txt">Elastic
608− License</link> the ELK packages now have an unfree license. To use them
609− you need to specify <literal>allowUnfree = true;</literal> in your nixpkgs
610− configuration.
528+ The ELK-6.3 stack now comes with <link xlink:href="https://www.elastic.co/products/x-pack/open">X-Pack by default</link>. Since X-Pack is licensed under the <link xlink:href="https://github.com/elastic/elasticsearch/blob/master/licenses/ELASTIC-LICENSE.txt">Elastic License</link> the ELK packages now have an unfree license. To use them you need to specify <literal>allowUnfree = true;</literal> in your nixpkgs configuration.
611529 </para>
612530 <para>
613− Fortunately there is also a free variant of the ELK stack without X-Pack.
614− The packages are available under the names:
615− <varname>elasticsearch-oss</varname>, <varname>logstash-oss</varname> and
616− <varname>kibana-oss</varname>.
531+ Fortunately there is also a free variant of the ELK stack without X-Pack. The packages are available under the names: <varname>elasticsearch-oss</varname>, <varname>logstash-oss</varname> and <varname>kibana-oss</varname>.
617532 </para>
618533 </listitem>
619534 <listitem>
620535 <para>
621− Options
622− <literal>boot.initrd.luks.devices.<replaceable>name</replaceable>.yubikey.ramfsMountPoint</literal>
623− <literal>boot.initrd.luks.devices.<replaceable>name</replaceable>.yubikey.storage.mountPoint</literal>
624− were removed. <literal>luksroot.nix</literal> module never supported more
625− than one YubiKey at a time anyway, hence those options never had any
626− effect. You should be able to remove them from your config without any
627− issues.
536+ Options <literal>boot.initrd.luks.devices.<replaceable>name</replaceable>.yubikey.ramfsMountPoint</literal> <literal>boot.initrd.luks.devices.<replaceable>name</replaceable>.yubikey.storage.mountPoint</literal> were removed. <literal>luksroot.nix</literal> module never supported more than one YubiKey at a time anyway, hence those options never had any effect. You should be able to remove them from your config without any issues.
628537 </para>
629538 </listitem>
630539 <listitem>
631540 <para>
632− <literal>stdenv.system</literal> and <literal>system</literal> in nixpkgs
633− now refer to the host platform instead of the build platform. For native
634− builds this is not change, let alone a breaking one. For cross builds, it
635− is a breaking change, and <literal>stdenv.buildPlatform.system</literal>
636− can be used instead for the old behavior. They should be using that
637− anyways for clarity.
541+ <literal>stdenv.system</literal> and <literal>system</literal> in nixpkgs now refer to the host platform instead of the build platform. For native builds this is not change, let alone a breaking one. For cross builds, it is a breaking change, and <literal>stdenv.buildPlatform.system</literal> can be used instead for the old behavior. They should be using that anyways for clarity.
638542 </para>
639543 </listitem>
640544 <listitem>
641545 <para>
642− Groups <literal>kvm</literal> and <literal>render</literal> are introduced
643− now, as systemd requires them.
546+ Groups <literal>kvm</literal> and <literal>render</literal> are introduced now, as systemd requires them.
644547 </para>
645548 </listitem>
646549 </itemizedlist>
@@ -656,92 +559,69 @@ $ nix-instantiate -E '(import &lt;nixpkgsunstable&gt; {}).gitFull'
656559 <itemizedlist>
657560 <listitem>
658561 <para>
659− <literal>dockerTools.pullImage</literal> relies on image digest instead of
660− image tag to download the image. The <literal>sha256</literal> of a pulled
661− image has to be updated.
562+ <literal>dockerTools.pullImage</literal> relies on image digest instead of image tag to download the image. The <literal>sha256</literal> of a pulled image has to be updated.
662563 </para>
663564 </listitem>
664565 <listitem>
665566 <para>
666− <literal>lib.attrNamesToStr</literal> has been deprecated. Use more
667− specific concatenation (<literal>lib.concat(Map)StringsSep</literal>)
668− instead.
567+ <literal>lib.attrNamesToStr</literal> has been deprecated. Use more specific concatenation (<literal>lib.concat(Map)StringsSep</literal>) instead.
669568 </para>
670569 </listitem>
671570 <listitem>
672571 <para>
673− <literal>lib.addErrorContextToAttrs</literal> has been deprecated. Use
674− <literal>builtins.addErrorContext</literal> directly.
572+ <literal>lib.addErrorContextToAttrs</literal> has been deprecated. Use <literal>builtins.addErrorContext</literal> directly.
675573 </para>
676574 </listitem>
677575 <listitem>
678576 <para>
679− <literal>lib.showVal</literal> has been deprecated. Use
680− <literal>lib.traceSeqN</literal> instead.
577+ <literal>lib.showVal</literal> has been deprecated. Use <literal>lib.traceSeqN</literal> instead.
681578 </para>
682579 </listitem>
683580 <listitem>
684581 <para>
685− <literal>lib.traceXMLVal</literal> has been deprecated. Use
686− <literal>lib.traceValFn builtins.toXml</literal> instead.
582+ <literal>lib.traceXMLVal</literal> has been deprecated. Use <literal>lib.traceValFn builtins.toXml</literal> instead.
687583 </para>
688584 </listitem>
689585 <listitem>
690586 <para>
691− <literal>lib.traceXMLValMarked</literal> has been deprecated. Use
692− <literal>lib.traceValFn (x: str + builtins.toXML x)</literal> instead.
587+ <literal>lib.traceXMLValMarked</literal> has been deprecated. Use <literal>lib.traceValFn (x: str + builtins.toXML x)</literal> instead.
693588 </para>
694589 </listitem>
695590 <listitem>
696591 <para>
697− The <literal>pkgs</literal> argument to NixOS modules can now be set
698− directly using <literal>nixpkgs.pkgs</literal>. Previously, only the
699− <literal>system</literal>, <literal>config</literal> and
700− <literal>overlays</literal> arguments could be used to influence
701− <literal>pkgs</literal>.
592+ The <literal>pkgs</literal> argument to NixOS modules can now be set directly using <literal>nixpkgs.pkgs</literal>. Previously, only the <literal>system</literal>, <literal>config</literal> and <literal>overlays</literal> arguments could be used to influence <literal>pkgs</literal>.
702593 </para>
703594 </listitem>
704595 <listitem>
705596 <para>
706− A NixOS system can now be constructed more easily based on a preexisting
707− invocation of Nixpkgs. For example:
597+ A NixOS system can now be constructed more easily based on a preexisting invocation of Nixpkgs. For example:
708598<programlisting>
709599inherit (pkgs.nixos {
710600 boot.loader.grub.enable = false;
711601 fileSystems."/".device = "/dev/xvda1";
712602}) toplevel kernel initialRamdisk manual;
713603 </programlisting>
714− This benefits evaluation performance, lets you write Nixpkgs packages that
715− depend on NixOS images and is consistent with a deployment architecture
716− that would be centered around Nixpkgs overlays.
604+ This benefits evaluation performance, lets you write Nixpkgs packages that depend on NixOS images and is consistent with a deployment architecture that would be centered around Nixpkgs overlays.
717605 </para>
718606 </listitem>
719607 <listitem>
720608 <para>
721− <literal>lib.traceValIfNot</literal> has been deprecated. Use
722− <literal>if/then/else</literal> and <literal>lib.traceValSeq</literal>
723− instead.
609+ <literal>lib.traceValIfNot</literal> has been deprecated. Use <literal>if/then/else</literal> and <literal>lib.traceValSeq</literal> instead.
724610 </para>
725611 </listitem>
726612 <listitem>
727613 <para>
728− <literal>lib.traceCallXml</literal> has been deprecated. Please complain
729− if you use the function regularly.
614+ <literal>lib.traceCallXml</literal> has been deprecated. Please complain if you use the function regularly.
730615 </para>
731616 </listitem>
732617 <listitem>
733618 <para>
734− The attribute <literal>lib.nixpkgsVersion</literal> has been deprecated in
735− favor of <literal>lib.version</literal>. Please refer to the discussion in
736− <link xlink:href="https://github.com/NixOS/nixpkgs/pull/39416#discussion_r183845745">NixOS/nixpkgs#39416</link>
737− for further reference.
619+ The attribute <literal>lib.nixpkgsVersion</literal> has been deprecated in favor of <literal>lib.version</literal>. Please refer to the discussion in <link xlink:href="https://github.com/NixOS/nixpkgs/pull/39416#discussion_r183845745">NixOS/nixpkgs#39416</link> for further reference.
738620 </para>
739621 </listitem>
740622 <listitem>
741623 <para>
742− <literal>lib.recursiveUpdateUntil</literal> was not acting according to
743− its specification. It has been fixed to act according to the docstring,
744− and a test has been added.
624+ <literal>lib.recursiveUpdateUntil</literal> was not acting according to its specification. It has been fixed to act according to the docstring, and a test has been added.
745625 </para>
746626 </listitem>
747627 <listitem>
@@ -755,9 +635,7 @@ inherit (pkgs.nixos {
755635 </term>
756636 <listitem>
757637 <para>
758− Puts the generated Diffie-Hellman parameters into the Nix store instead
759− of managing them in a stateful manner in
760− <filename class="directory">/var/lib/dhparams</filename>.
638+ Puts the generated Diffie-Hellman parameters into the Nix store instead of managing them in a stateful manner in <filename class="directory">/var/lib/dhparams</filename>.
761639 </para>
762640 </listitem>
763641 </varlistentry>
@@ -767,27 +645,20 @@ inherit (pkgs.nixos {
767645 </term>
768646 <listitem>
769647 <para>
770− The default bit size to use for the generated Diffie-Hellman
771− parameters.
648+ The default bit size to use for the generated Diffie-Hellman parameters.
772649 </para>
773650 </listitem>
774651 </varlistentry>
775652 </variablelist>
776653 <note>
777654 <para>
778− The path to the actual generated parameter files should now be queried
779− using
780− <literal>config.security.dhparams.params.<replaceable>name</replaceable>.path</literal>
781− because it might be either in the Nix store or in a directory configured
782− by <option>security.dhparams.path</option>.
655+ The path to the actual generated parameter files should now be queried using <literal>config.security.dhparams.params.<replaceable>name</replaceable>.path</literal> because it might be either in the Nix store or in a directory configured by <option>security.dhparams.path</option>.
783656 </para>
784657 </note>
785658 <note>
786659 <title>For developers:</title>
787660 <para>
788− Module implementers should not set a specific bit size in order to let
789− users configure it by themselves if they want to have a different bit
790− size than the default (2048).
661+ Module implementers should not set a specific bit size in order to let users configure it by themselves if they want to have a different bit size than the default (2048).
791662 </para>
792663 <para>
793664 An example usage of this would be:
@@ -806,126 +677,82 @@ inherit (pkgs.nixos {
806677 </listitem>
807678 <listitem>
808679 <para>
809− <literal>networking.networkmanager.useDnsmasq</literal> has been
810− deprecated. Use <literal>networking.networkmanager.dns</literal> instead.
680+ <literal>networking.networkmanager.useDnsmasq</literal> has been deprecated. Use <literal>networking.networkmanager.dns</literal> instead.
811681 </para>
812682 </listitem>
813683 <listitem>
814684 <para>
815− The Kubernetes package has been bumped to major version 1.11. Please
816− consult the
817− <link xlink:href="https://github.com/kubernetes/kubernetes/blob/release-1.11/CHANGELOG-1.11.md">release
818− notes</link> for details on new features and api changes.
685+ The Kubernetes package has been bumped to major version 1.11. Please consult the <link xlink:href="https://github.com/kubernetes/kubernetes/blob/release-1.11/CHANGELOG-1.11.md">release notes</link> for details on new features and api changes.
819686 </para>
820687 </listitem>
821688 <listitem>
822689 <para>
823− The option
824− <varname>services.kubernetes.apiserver.admissionControl</varname> was
825− renamed to
826− <varname>services.kubernetes.apiserver.enableAdmissionPlugins</varname>.
690+ The option <varname>services.kubernetes.apiserver.admissionControl</varname> was renamed to <varname>services.kubernetes.apiserver.enableAdmissionPlugins</varname>.
827691 </para>
828692 </listitem>
829693 <listitem>
830694 <para>
831− Recommended way to access the Kubernetes Dashboard is via HTTPS (TLS)
832− Therefore; public service port for the dashboard has changed to 443
833− (container port 8443) and scheme to https.
695+ Recommended way to access the Kubernetes Dashboard is via HTTPS (TLS) Therefore; public service port for the dashboard has changed to 443 (container port 8443) and scheme to https.
834696 </para>
835697 </listitem>
836698 <listitem>
837699 <para>
838− The option <varname>services.kubernetes.apiserver.address</varname> was
839− renamed to <varname>services.kubernetes.apiserver.bindAddress</varname>.
840− Note that the default value has changed from 127.0.0.1 to 0.0.0.0.
700+ The option <varname>services.kubernetes.apiserver.address</varname> was renamed to <varname>services.kubernetes.apiserver.bindAddress</varname>. Note that the default value has changed from 127.0.0.1 to 0.0.0.0.
841701 </para>
842702 </listitem>
843703 <listitem>
844704 <para>
845− The option <varname>services.kubernetes.apiserver.publicAddress</varname>
846− was not used and thus has been removed.
705+ The option <varname>services.kubernetes.apiserver.publicAddress</varname> was not used and thus has been removed.
847706 </para>
848707 </listitem>
849708 <listitem>
850709 <para>
851− The option
852− <varname>services.kubernetes.addons.dashboard.enableRBAC</varname> was
853− renamed to
854− <varname>services.kubernetes.addons.dashboard.rbac.enable</varname>.
710+ The option <varname>services.kubernetes.addons.dashboard.enableRBAC</varname> was renamed to <varname>services.kubernetes.addons.dashboard.rbac.enable</varname>.
855711 </para>
856712 </listitem>
857713 <listitem>
858714 <para>
859− The Kubernetes Dashboard now has only minimal RBAC permissions by default.
860− If dashboard cluster-admin rights are desired, set
861− <varname>services.kubernetes.addons.dashboard.rbac.clusterAdmin</varname>
862− to true. On existing clusters, in order for the revocation of privileges
863− to take effect, the current ClusterRoleBinding for kubernetes-dashboard
864− must be manually removed: <literal>kubectl delete clusterrolebinding
865− kubernetes-dashboard</literal>
715+ The Kubernetes Dashboard now has only minimal RBAC permissions by default. If dashboard cluster-admin rights are desired, set <varname>services.kubernetes.addons.dashboard.rbac.clusterAdmin</varname> to true. On existing clusters, in order for the revocation of privileges to take effect, the current ClusterRoleBinding for kubernetes-dashboard must be manually removed: <literal>kubectl delete clusterrolebinding kubernetes-dashboard</literal>
866716 </para>
867717 </listitem>
868718 <listitem>
869719 <para>
870− The <varname>programs.screen</varname> module provides allows to configure
871− <literal>/etc/screenrc</literal>, however the module behaved fairly
872− counterintuitive as the config exists, but the package wasn't available.
873− Since 18.09 <literal>pkgs.screen</literal> will be added to
874− <literal>environment.systemPackages</literal>.
720+ The <varname>programs.screen</varname> module provides allows to configure <literal>/etc/screenrc</literal>, however the module behaved fairly counterintuitive as the config exists, but the package wasn't available. Since 18.09 <literal>pkgs.screen</literal> will be added to <literal>environment.systemPackages</literal>.
875721 </para>
876722 </listitem>
877723 <listitem>
878724 <para>
879− The module <option>services.networking.hostapd</option> now uses WPA2 by
880− default.
725+ The module <option>services.networking.hostapd</option> now uses WPA2 by default.
881726 </para>
882727 </listitem>
883728 <listitem>
884729 <para>
885− <varname>s6Dns</varname>, <varname>s6Networking</varname>,
886− <varname>s6LinuxUtils</varname> and <varname>s6PortableUtils</varname>
887− renamed to <varname>s6-dns</varname>, <varname>s6-networking</varname>,
888− <varname>s6-linux-utils</varname> and <varname>s6-portable-utils</varname>
889− respectively.
730+ <varname>s6Dns</varname>, <varname>s6Networking</varname>, <varname>s6LinuxUtils</varname> and <varname>s6PortableUtils</varname> renamed to <varname>s6-dns</varname>, <varname>s6-networking</varname>, <varname>s6-linux-utils</varname> and <varname>s6-portable-utils</varname> respectively.
890731 </para>
891732 </listitem>
892733 <listitem>
893734 <para>
894− The module option <option>nix.useSandbox</option> is now defaulted to
895− <literal>true</literal>.
735+ The module option <option>nix.useSandbox</option> is now defaulted to <literal>true</literal>.
896736 </para>
897737 </listitem>
898738 <listitem>
899739 <para>
900− The config activation script of <literal>nixos-rebuild</literal> now
901− <link xlink:href="https://www.freedesktop.org/software/systemd/man/systemctl.html#Manager%20Lifecycle%20Commands">reloads</link>
902− all user units for each authenticated user.
740+ The config activation script of <literal>nixos-rebuild</literal> now <link xlink:href="https://www.freedesktop.org/software/systemd/man/systemctl.html#Manager%20Lifecycle%20Commands">reloads</link> all user units for each authenticated user.
903741 </para>
904742 </listitem>
905743 <listitem>
906744 <para>
907− The default display manager is now LightDM. To use SLiM set
908− <literal>services.xserver.displayManager.slim.enable</literal> to
909− <literal>true</literal>.
745+ The default display manager is now LightDM. To use SLiM set <literal>services.xserver.displayManager.slim.enable</literal> to <literal>true</literal>.
910746 </para>
911747 </listitem>
912748 <listitem>
913749 <para>
914− NixOS option descriptions are now automatically broken up into individual
915− paragraphs if the text contains two consecutive newlines, so it's no
916− longer necessary to use <code>&lt;/para&gt;&lt;para&gt;</code> to start a
917− new paragraph.
750+ NixOS option descriptions are now automatically broken up into individual paragraphs if the text contains two consecutive newlines, so it's no longer necessary to use <code>&lt;/para&gt;&lt;para&gt;</code> to start a new paragraph.
918751 </para>
919752 </listitem>
920753 <listitem>
921754 <para>
922− Top-level <literal>buildPlatform</literal>,
923− <literal>hostPlatform</literal>, and <literal>targetPlatform</literal> in
924− Nixpkgs are deprecated. Please use their equivalents in
925− <literal>stdenv</literal> instead:
926− <literal>stdenv.buildPlatform</literal>,
927− <literal>stdenv.hostPlatform</literal>, and
928− <literal>stdenv.targetPlatform</literal>.
755+ Top-level <literal>buildPlatform</literal>, <literal>hostPlatform</literal>, and <literal>targetPlatform</literal> in Nixpkgs are deprecated. Please use their equivalents in <literal>stdenv</literal> instead: <literal>stdenv.buildPlatform</literal>, <literal>stdenv.hostPlatform</literal>, and <literal>stdenv.targetPlatform</literal>.
929756 </para>
930757 </listitem>
931758 </itemizedlist>
nixos/doc/manual/release-notes/rl-1903.xml+82−366
@@ -13,8 +13,7 @@
1313 <title>Highlights</title>
1414
1515 <para>
16− In addition to numerous new and upgraded packages, this release has the
17− following highlights:
16+ In addition to numerous new and upgraded packages, this release has the following highlights:
1817 </para>
1918
2019 <itemizedlist>
@@ -25,53 +24,36 @@
2524 </listitem>
2625 <listitem>
2726 <para>
28− The default Python 3 interpreter is now CPython 3.7 instead of CPython
29− 3.6.
27+ The default Python 3 interpreter is now CPython 3.7 instead of CPython 3.6.
3028 </para>
3129 </listitem>
3230 <listitem>
3331 <para>
34− Added the Pantheon desktop environment. It can be enabled through
35− <varname>services.xserver.desktopManager.pantheon.enable</varname>.
32+ Added the Pantheon desktop environment. It can be enabled through <varname>services.xserver.desktopManager.pantheon.enable</varname>.
3633 </para>
3734 <note>
3835 <para>
39− By default, <varname>services.xserver.desktopManager.pantheon</varname>
40− enables LightDM as a display manager, as pantheon's screen locking
41− implementation relies on it.
36+ By default, <varname>services.xserver.desktopManager.pantheon</varname> enables LightDM as a display manager, as pantheon's screen locking implementation relies on it.
4237 </para>
4338 <para>
44− Because of that it is recommended to leave LightDM enabled. If you'd like
45− to disable it anyway, set
46− <option>services.xserver.displayManager.lightdm.enable</option> to
47− <literal>false</literal> and enable your preferred display manager.
39+ Because of that it is recommended to leave LightDM enabled. If you'd like to disable it anyway, set <option>services.xserver.displayManager.lightdm.enable</option> to <literal>false</literal> and enable your preferred display manager.
4840 </para>
4941 </note>
5042 <para>
51− Also note that Pantheon's LightDM greeter is not enabled by default,
52− because it has numerous issues in NixOS and isn't optimal for use here
53− yet.
43+ Also note that Pantheon's LightDM greeter is not enabled by default, because it has numerous issues in NixOS and isn't optimal for use here yet.
5444 </para>
5545 </listitem>
5646 <listitem>
5747 <para>
58− A major refactoring of the Kubernetes module has been completed.
59− Refactorings primarily focus on decoupling components and enhancing
60− security. Two-way TLS and RBAC has been enabled by default for all
61− components, which slightly changes the way the module is configured. See:
62− <xref linkend="sec-kubernetes"/> for details.
48+ A major refactoring of the Kubernetes module has been completed. Refactorings primarily focus on decoupling components and enhancing security. Two-way TLS and RBAC has been enabled by default for all components, which slightly changes the way the module is configured. See: <xref linkend="sec-kubernetes"/> for details.
6349 </para>
6450 </listitem>
6551 <listitem>
66− <para>
67− There is now a set of <option>confinement</option> options for
68− <option>systemd.services</option>, which allows to restrict services
69− into a <citerefentry>
70− <refentrytitle>chroot</refentrytitle>
71− <manvolnum>2</manvolnum>
72− </citerefentry>ed environment that only contains the store paths from
73− the runtime closure of the service.
74− </para>
52+ <para>
53+ There is now a set of <option>confinement</option> options for <option>systemd.services</option>, which allows to restrict services into a <citerefentry>
54+ <refentrytitle>chroot</refentrytitle>
55+ <manvolnum>2</manvolnum> </citerefentry>ed environment that only contains the store paths from the runtime closure of the service.
56+ </para>
7557 </listitem>
7658 </itemizedlist>
7759 </section>
@@ -95,12 +77,7 @@
9577 </listitem>
9678 <listitem>
9779 <para>
98− There is a new <varname>security.googleOsLogin</varname> module for using
99− <link xlink:href="https://cloud.google.com/compute/docs/instances/managing-instance-access">OS
100− Login</link> to manage SSH access to Google Compute Engine instances,
101− which supersedes the imperative and broken
102− <literal>google-accounts-daemon</literal> used in
103− <literal>nixos/modules/virtualisation/google-compute-config.nix</literal>.
80+ There is a new <varname>security.googleOsLogin</varname> module for using <link xlink:href="https://cloud.google.com/compute/docs/instances/managing-instance-access">OS Login</link> to manage SSH access to Google Compute Engine instances, which supersedes the imperative and broken <literal>google-accounts-daemon</literal> used in <literal>nixos/modules/virtualisation/google-compute-config.nix</literal>.
10481 </para>
10582 </listitem>
10683 <listitem>
@@ -110,10 +87,7 @@
11087 </listitem>
11188 <listitem>
11289 <para>
113− There is a new <varname>services.cockroachdb</varname> module for running
114− CockroachDB databases. NixOS now ships with CockroachDB 2.1.x as well,
115− available on <literal>x86_64-linux</literal> and
116− <literal>aarch64-linux</literal>.
90+ There is a new <varname>services.cockroachdb</varname> module for running CockroachDB databases. NixOS now ships with CockroachDB 2.1.x as well, available on <literal>x86_64-linux</literal> and <literal>aarch64-linux</literal>.
11791 </para>
11892 </listitem>
11993 </itemizedlist>
@@ -126,11 +100,7 @@
126100 </listitem>
127101 <listitem>
128102 <para>
129− The <link xlink:href="https://duo.com/docs/duounix">PAM module for Duo
130− Security</link> has been enabled for use. One can configure it using the
131− <option>security.duosec</option> options along with the corresponding PAM
132− option in
133− <option>security.pam.services.&lt;name?&gt;.duoSecurity.enable</option>.
103+ The <link xlink:href="https://duo.com/docs/duounix">PAM module for Duo Security</link> has been enabled for use. One can configure it using the <option>security.duosec</option> options along with the corresponding PAM option in <option>security.pam.services.&lt;name?&gt;.duoSecurity.enable</option>.
134104 </para>
135105 </listitem>
136106 </itemizedlist>
@@ -144,8 +114,7 @@
144114 <title>Backward Incompatibilities</title>
145115
146116 <para>
147− When upgrading from a previous release, please be aware of the following
148− incompatible changes:
117+ When upgrading from a previous release, please be aware of the following incompatible changes:
149118 </para>
150119
151120 <itemizedlist>
@@ -156,233 +125,131 @@
156125 <itemizedlist>
157126 <listitem>
158127 <para>
159− For users of NixOS 18.03 and 19.03, NixOS defaults to Nix 2.0, but
160− supports using Nix 1.11 by setting <literal>nix.package =
161− pkgs.nix1;</literal>. If this option is set to a Nix 1.11 package, you
162− will need to either unset the option or upgrade it to Nix 2.0.
128+ For users of NixOS 18.03 and 19.03, NixOS defaults to Nix 2.0, but supports using Nix 1.11 by setting <literal>nix.package = pkgs.nix1;</literal>. If this option is set to a Nix 1.11 package, you will need to either unset the option or upgrade it to Nix 2.0.
163129 </para>
164130 </listitem>
165131 <listitem>
166132 <para>
167− For users of NixOS 17.09, you will first need to upgrade Nix by setting
168− <literal>nix.package = pkgs.nixStable2;</literal> and run
169− <command>nixos-rebuild switch</command> as the <literal>root</literal>
170− user.
133+ For users of NixOS 17.09, you will first need to upgrade Nix by setting <literal>nix.package = pkgs.nixStable2;</literal> and run <command>nixos-rebuild switch</command> as the <literal>root</literal> user.
171134 </para>
172135 </listitem>
173136 <listitem>
174137 <para>
175− For users of a daemon-less Nix installation on Linux or macOS, you can
176− upgrade Nix by running <command>curl https://nixos.org/nix/install |
177− sh</command>, or prior to doing a channel update, running
178− <command>nix-env -iA nix</command>.
138+ For users of a daemon-less Nix installation on Linux or macOS, you can upgrade Nix by running <command>curl https://nixos.org/nix/install | sh</command>, or prior to doing a channel update, running <command>nix-env -iA nix</command>.
179139 </para>
180140 <para>
181− If you have already run a channel update and Nix is no longer able to
182− evaluate Nixpkgs, the error message printed should provide adequate
183− directions for upgrading Nix.
141+ If you have already run a channel update and Nix is no longer able to evaluate Nixpkgs, the error message printed should provide adequate directions for upgrading Nix.
184142 </para>
185143 </listitem>
186144 <listitem>
187145 <para>
188− For users of the Nix daemon on macOS, you can upgrade Nix by running
189− <command>sudo -i sh -c 'nix-channel --update &amp;&amp; nix-env -iA
190− nixpkgs.nix'; sudo launchctl stop org.nixos.nix-daemon; sudo launchctl
191− start org.nixos.nix-daemon</command>.
146+ For users of the Nix daemon on macOS, you can upgrade Nix by running <command>sudo -i sh -c 'nix-channel --update &amp;&amp; nix-env -iA nixpkgs.nix'; sudo launchctl stop org.nixos.nix-daemon; sudo launchctl start org.nixos.nix-daemon</command>.
192147 </para>
193148 </listitem>
194149 </itemizedlist>
195150 </listitem>
196151 <listitem>
197152 <para>
198− The <varname>buildPythonPackage</varname> function now sets
199− <varname>strictDeps = true</varname> to help distinguish between native
200− and non-native dependencies in order to improve cross-compilation
201− compatibility. Note however that this may break user expressions.
153+ The <varname>buildPythonPackage</varname> function now sets <varname>strictDeps = true</varname> to help distinguish between native and non-native dependencies in order to improve cross-compilation compatibility. Note however that this may break user expressions.
202154 </para>
203155 </listitem>
204156 <listitem>
205157 <para>
206− The <varname>buildPythonPackage</varname> function now sets <varname>LANG
207− = C.UTF-8</varname> to enable Unicode support. The
208− <varname>glibcLocales</varname> package is no longer needed as a build
209− input.
158+ The <varname>buildPythonPackage</varname> function now sets <varname>LANG = C.UTF-8</varname> to enable Unicode support. The <varname>glibcLocales</varname> package is no longer needed as a build input.
210159 </para>
211160 </listitem>
212161 <listitem>
213162 <para>
214− The Syncthing state and configuration data has been moved from
215− <varname>services.syncthing.dataDir</varname> to the newly defined
216− <varname>services.syncthing.configDir</varname>, which default to
217− <literal>/var/lib/syncthing/.config/syncthing</literal>. This change makes
218− possible to share synced directories using ACLs without Syncthing
219− resetting the permission on every start.
163+ The Syncthing state and configuration data has been moved from <varname>services.syncthing.dataDir</varname> to the newly defined <varname>services.syncthing.configDir</varname>, which default to <literal>/var/lib/syncthing/.config/syncthing</literal>. This change makes possible to share synced directories using ACLs without Syncthing resetting the permission on every start.
220164 </para>
221165 </listitem>
222166 <listitem>
223167 <para>
224− The <literal>ntp</literal> module now has sane default restrictions. If
225− you're relying on the previous defaults, which permitted all queries and
226− commands from all firewall-permitted sources, you can set
227− <varname>services.ntp.restrictDefault</varname> and
228− <varname>services.ntp.restrictSource</varname> to <literal>[]</literal>.
168+ The <literal>ntp</literal> module now has sane default restrictions. If you're relying on the previous defaults, which permitted all queries and commands from all firewall-permitted sources, you can set <varname>services.ntp.restrictDefault</varname> and <varname>services.ntp.restrictSource</varname> to <literal>[]</literal>.
229169 </para>
230170 </listitem>
231171 <listitem>
232172 <para>
233− Package <varname>rabbitmq_server</varname> is renamed to
234− <varname>rabbitmq-server</varname>.
173+ Package <varname>rabbitmq_server</varname> is renamed to <varname>rabbitmq-server</varname>.
235174 </para>
236175 </listitem>
237176 <listitem>
238177 <para>
239− The <literal>light</literal> module no longer uses setuid binaries, but
240− udev rules. As a consequence users of that module have to belong to the
241− <literal>video</literal> group in order to use the executable (i.e.
242− <literal>users.users.yourusername.extraGroups = ["video"];</literal>).
178+ The <literal>light</literal> module no longer uses setuid binaries, but udev rules. As a consequence users of that module have to belong to the <literal>video</literal> group in order to use the executable (i.e. <literal>users.users.yourusername.extraGroups = ["video"];</literal>).
243179 </para>
244180 </listitem>
245181 <listitem>
246182 <para>
247− Buildbot now supports Python 3 and its packages have been moved to
248− <literal>pythonPackages</literal>. The options
249− <option>services.buildbot-master.package</option> and
250− <option>services.buildbot-worker.package</option> can be used to select
251− the Python 2 or 3 version of the package.
183+ Buildbot now supports Python 3 and its packages have been moved to <literal>pythonPackages</literal>. The options <option>services.buildbot-master.package</option> and <option>services.buildbot-worker.package</option> can be used to select the Python 2 or 3 version of the package.
252184 </para>
253185 </listitem>
254186 <listitem>
255187 <para>
256− Options
257− <literal>services.znc.confOptions.networks.<replaceable>name</replaceable>.userName</literal>
258− and
259− <literal>services.znc.confOptions.networks.<replaceable>name</replaceable>.modulePackages</literal>
260− were removed. They were never used for anything and can therefore safely
261− be removed.
188+ Options <literal>services.znc.confOptions.networks.<replaceable>name</replaceable>.userName</literal> and <literal>services.znc.confOptions.networks.<replaceable>name</replaceable>.modulePackages</literal> were removed. They were never used for anything and can therefore safely be removed.
262189 </para>
263190 </listitem>
264191 <listitem>
265192 <para>
266− Package <literal>wasm</literal> has been renamed
267− <literal>proglodyte-wasm</literal>. The package <literal>wasm</literal>
268− will be pointed to <literal>ocamlPackages.wasm</literal> in 19.09, so make
269− sure to update your configuration if you want to keep
270− <literal>proglodyte-wasm</literal>
193+ Package <literal>wasm</literal> has been renamed <literal>proglodyte-wasm</literal>. The package <literal>wasm</literal> will be pointed to <literal>ocamlPackages.wasm</literal> in 19.09, so make sure to update your configuration if you want to keep <literal>proglodyte-wasm</literal>
271194 </para>
272195 </listitem>
273196 <listitem>
274197 <para>
275− When the <literal>nixpkgs.pkgs</literal> option is set, NixOS will no
276− longer ignore the <literal>nixpkgs.overlays</literal> option. The old
277− behavior can be recovered by setting <literal>nixpkgs.overlays =
278− lib.mkForce [];</literal>.
198+ When the <literal>nixpkgs.pkgs</literal> option is set, NixOS will no longer ignore the <literal>nixpkgs.overlays</literal> option. The old behavior can be recovered by setting <literal>nixpkgs.overlays = lib.mkForce [];</literal>.
279199 </para>
280200 </listitem>
281201 <listitem>
282202 <para>
283− OpenSMTPD has been upgraded to version 6.4.0p1. This release makes
284− backwards-incompatible changes to the configuration file format. See
285− <command>man smtpd.conf</command> for more information on the new file
286− format.
203+ OpenSMTPD has been upgraded to version 6.4.0p1. This release makes backwards-incompatible changes to the configuration file format. See <command>man smtpd.conf</command> for more information on the new file format.
287204 </para>
288205 </listitem>
289206 <listitem>
290207 <para>
291− The versioned <varname>postgresql</varname> have been renamed to use
292− underscore number seperators. For example, <varname>postgresql96</varname>
293− has been renamed to <varname>postgresql_9_6</varname>.
208+ The versioned <varname>postgresql</varname> have been renamed to use underscore number seperators. For example, <varname>postgresql96</varname> has been renamed to <varname>postgresql_9_6</varname>.
294209 </para>
295210 </listitem>
296211 <listitem>
297212 <para>
298− Package <literal>consul-ui</literal> and passthrough
299− <literal>consul.ui</literal> have been removed. The package
300− <literal>consul</literal> now uses upstream releases that vendor the UI
301− into the binary. See
302− <link xlink:href="https://github.com/NixOS/nixpkgs/pull/48714#issuecomment-433454834">#48714</link>
303− for details.
213+ Package <literal>consul-ui</literal> and passthrough <literal>consul.ui</literal> have been removed. The package <literal>consul</literal> now uses upstream releases that vendor the UI into the binary. See <link xlink:href="https://github.com/NixOS/nixpkgs/pull/48714#issuecomment-433454834">#48714</link> for details.
304214 </para>
305215 </listitem>
306216 <listitem>
307217 <para>
308− Slurm introduces the new option
309− <literal>services.slurm.stateSaveLocation</literal>, which is now set to
310− <literal>/var/spool/slurm</literal> by default (instead of
311− <literal>/var/spool</literal>). Make sure to move all files to the new
312− directory or to set the option accordingly.
218+ Slurm introduces the new option <literal>services.slurm.stateSaveLocation</literal>, which is now set to <literal>/var/spool/slurm</literal> by default (instead of <literal>/var/spool</literal>). Make sure to move all files to the new directory or to set the option accordingly.
313219 </para>
314220 <para>
315− The slurmctld now runs as user <literal>slurm</literal> instead of
316− <literal>root</literal>. If you want to keep slurmctld running as
317− <literal>root</literal>, set <literal>services.slurm.user =
318− root</literal>.
221+ The slurmctld now runs as user <literal>slurm</literal> instead of <literal>root</literal>. If you want to keep slurmctld running as <literal>root</literal>, set <literal>services.slurm.user = root</literal>.
319222 </para>
320223 <para>
321− The options <literal>services.slurm.nodeName</literal> and
322− <literal>services.slurm.partitionName</literal> are now sets of strings to
323− correctly reflect that fact that each of these options can occour more
324− than once in the configuration.
224+ The options <literal>services.slurm.nodeName</literal> and <literal>services.slurm.partitionName</literal> are now sets of strings to correctly reflect that fact that each of these options can occour more than once in the configuration.
325225 </para>
326226 </listitem>
327227 <listitem>
328228 <para>
329− The <literal>solr</literal> package has been upgraded from 4.10.3 to 7.5.0
330− and has undergone some major changes. The <literal>services.solr</literal>
331− module has been updated to reflect these changes. Please review
332− http://lucene.apache.org/solr/ carefully before upgrading.
229+ The <literal>solr</literal> package has been upgraded from 4.10.3 to 7.5.0 and has undergone some major changes. The <literal>services.solr</literal> module has been updated to reflect these changes. Please review http://lucene.apache.org/solr/ carefully before upgrading.
333230 </para>
334231 </listitem>
335232 <listitem>
336233 <para>
337− Package <literal>ckb</literal> is renamed to <literal>ckb-next</literal>,
338− and options <literal>hardware.ckb.*</literal> are renamed to
339− <literal>hardware.ckb-next.*</literal>.
234+ Package <literal>ckb</literal> is renamed to <literal>ckb-next</literal>, and options <literal>hardware.ckb.*</literal> are renamed to <literal>hardware.ckb-next.*</literal>.
340235 </para>
341236 </listitem>
342237 <listitem>
343238 <para>
344− The option
345− <literal>services.xserver.displayManager.job.logToFile</literal> which was
346− previously set to <literal>true</literal> when using the display managers
347− <literal>lightdm</literal>, <literal>sddm</literal> or
348− <literal>xpra</literal> has been reset to the default value
349− (<literal>false</literal>).
239+ The option <literal>services.xserver.displayManager.job.logToFile</literal> which was previously set to <literal>true</literal> when using the display managers <literal>lightdm</literal>, <literal>sddm</literal> or <literal>xpra</literal> has been reset to the default value (<literal>false</literal>).
350240 </para>
351241 </listitem>
352242 <listitem>
353243 <para>
354− Network interface indiscriminate NixOS firewall options
355− (<literal>networking.firewall.allow*</literal>) are now preserved when
356− also setting interface specific rules such as
357− <literal>networking.firewall.interfaces.en0.allow*</literal>. These rules
358− continue to use the pseudo device "default"
359− (<literal>networking.firewall.interfaces.default.*</literal>), and
360− assigning to this pseudo device will override the
361− (<literal>networking.firewall.allow*</literal>) options.
244+ Network interface indiscriminate NixOS firewall options (<literal>networking.firewall.allow*</literal>) are now preserved when also setting interface specific rules such as <literal>networking.firewall.interfaces.en0.allow*</literal>. These rules continue to use the pseudo device "default" (<literal>networking.firewall.interfaces.default.*</literal>), and assigning to this pseudo device will override the (<literal>networking.firewall.allow*</literal>) options.
362245 </para>
363246 </listitem>
364247 <listitem>
365248 <para>
366− The <literal>nscd</literal> service now disables all caching of
367− <literal>passwd</literal> and <literal>group</literal> databases by
368− default. This was interferring with the correct functioning of the
369− <literal>libnss_systemd.so</literal> module which is used by
370− <literal>systemd</literal> to manage uids and usernames in the presence of
371− <literal>DynamicUser=</literal> in systemd services. This was already the
372− default behaviour in presence of <literal>services.sssd.enable =
373− true</literal> because nscd caching would interfere with
374− <literal>sssd</literal> in unpredictable ways as well. Because we're using
375− nscd not for caching, but for convincing glibc to find NSS modules in the
376− nix store instead of an absolute path, we have decided to disable caching
377− globally now, as it's usually not the behaviour the user wants and can
378− lead to surprising behaviour. Furthermore, negative caching of host
379− lookups is also disabled now by default. This should fix the issue of dns
380− lookups failing in the presence of an unreliable network.
249+ The <literal>nscd</literal> service now disables all caching of <literal>passwd</literal> and <literal>group</literal> databases by default. This was interferring with the correct functioning of the <literal>libnss_systemd.so</literal> module which is used by <literal>systemd</literal> to manage uids and usernames in the presence of <literal>DynamicUser=</literal> in systemd services. This was already the default behaviour in presence of <literal>services.sssd.enable = true</literal> because nscd caching would interfere with <literal>sssd</literal> in unpredictable ways as well. Because we're using nscd not for caching, but for convincing glibc to find NSS modules in the nix store instead of an absolute path, we have decided to disable caching globally now, as it's usually not the behaviour the user wants and can lead to surprising behaviour. Furthermore, negative caching of host lookups is also disabled now by default. This should fix the issue of dns lookups failing in the presence of an unreliable network.
381250 </para>
382251 <para>
383− If the old behaviour is desired, this can be restored by setting the
384− <literal>services.nscd.config</literal> option with the desired caching
385− parameters.
252+ If the old behaviour is desired, this can be restored by setting the <literal>services.nscd.config</literal> option with the desired caching parameters.
386253<programlisting>
387254 services.nscd.config =
388255 ''
@@ -416,124 +283,65 @@
416283 shared hosts yes
417284 '';
418285 </programlisting>
419− See
420− <link xlink:href="https://github.com/NixOS/nixpkgs/pull/50316">#50316</link>
421− for details.
286+ See <link xlink:href="https://github.com/NixOS/nixpkgs/pull/50316">#50316</link> for details.
422287 </para>
423288 </listitem>
424289 <listitem>
425290 <para>
426− GitLab Shell previously used the nix store paths for the
427− <literal>gitlab-shell</literal> command in its
428− <literal>authorized_keys</literal> file, which might stop working after
429− garbage collection. To circumvent that, we regenerated that file on each
430− startup. As <literal>gitlab-shell</literal> has now been changed to use
431− <literal>/var/run/current-system/sw/bin/gitlab-shell</literal>, this is
432− not necessary anymore, but there might be leftover lines with a nix store
433− path. Regenerate the <literal>authorized_keys</literal> file via
434− <command>sudo -u git -H gitlab-rake gitlab:shell:setup</command> in that
435− case.
291+ GitLab Shell previously used the nix store paths for the <literal>gitlab-shell</literal> command in its <literal>authorized_keys</literal> file, which might stop working after garbage collection. To circumvent that, we regenerated that file on each startup. As <literal>gitlab-shell</literal> has now been changed to use <literal>/var/run/current-system/sw/bin/gitlab-shell</literal>, this is not necessary anymore, but there might be leftover lines with a nix store path. Regenerate the <literal>authorized_keys</literal> file via <command>sudo -u git -H gitlab-rake gitlab:shell:setup</command> in that case.
436292 </para>
437293 </listitem>
438294 <listitem>
439295 <para>
440− The <literal>pam_unix</literal> account module is now loaded with its
441− control field set to <literal>required</literal> instead of
442− <literal>sufficient</literal>, so that later PAM account modules that
443− might do more extensive checks are being executed. Previously, the whole
444− account module verification was exited prematurely in case a nss module
445− provided the account name to <literal>pam_unix</literal>. The LDAP and
446− SSSD NixOS modules already add their NSS modules when enabled. In case
447− your setup breaks due to some later PAM account module previosuly
448− shadowed, or failing NSS lookups, please file a bug. You can get back the
449− old behaviour by manually setting <literal>
296+ The <literal>pam_unix</literal> account module is now loaded with its control field set to <literal>required</literal> instead of <literal>sufficient</literal>, so that later PAM account modules that might do more extensive checks are being executed. Previously, the whole account module verification was exited prematurely in case a nss module provided the account name to <literal>pam_unix</literal>. The LDAP and SSSD NixOS modules already add their NSS modules when enabled. In case your setup breaks due to some later PAM account module previosuly shadowed, or failing NSS lookups, please file a bug. You can get back the old behaviour by manually setting <literal>
450297<![CDATA[security.pam.services.<name?>.text]]>
451298 </literal>.
452299 </para>
453300 </listitem>
454301 <listitem>
455302 <para>
456− The <literal>pam_unix</literal> password module is now loaded with its
457− control field set to <literal>sufficient</literal> instead of
458− <literal>required</literal>, so that password managed only by later PAM
459− password modules are being executed. Previously, for example, changing an
460− LDAP account's password through PAM was not possible: the whole password
461− module verification was exited prematurely by <literal>pam_unix</literal>,
462− preventing <literal>pam_ldap</literal> to manage the password as it
463− should.
303+ The <literal>pam_unix</literal> password module is now loaded with its control field set to <literal>sufficient</literal> instead of <literal>required</literal>, so that password managed only by later PAM password modules are being executed. Previously, for example, changing an LDAP account's password through PAM was not possible: the whole password module verification was exited prematurely by <literal>pam_unix</literal>, preventing <literal>pam_ldap</literal> to manage the password as it should.
464304 </para>
465305 </listitem>
466306 <listitem>
467307 <para>
468− <literal>fish</literal> has been upgraded to 3.0. It comes with a number
469− of improvements and backwards incompatible changes. See the
470− <literal>fish</literal>
471− <link xlink:href="https://github.com/fish-shell/fish-shell/releases/tag/3.0.0">release
472− notes</link> for more information.
308+ <literal>fish</literal> has been upgraded to 3.0. It comes with a number of improvements and backwards incompatible changes. See the <literal>fish</literal> <link xlink:href="https://github.com/fish-shell/fish-shell/releases/tag/3.0.0">release notes</link> for more information.
473309 </para>
474310 </listitem>
475311 <listitem>
476312 <para>
477− The ibus-table input method has had a change in config format, which
478− causes all previous settings to be lost. See
479− <link xlink:href="https://github.com/mike-fabian/ibus-table/commit/f9195f877c5212fef0dfa446acb328c45ba5852b">this
480− commit message</link> for details.
313+ The ibus-table input method has had a change in config format, which causes all previous settings to be lost. See <link xlink:href="https://github.com/mike-fabian/ibus-table/commit/f9195f877c5212fef0dfa446acb328c45ba5852b">this commit message</link> for details.
481314 </para>
482315 </listitem>
483316 <listitem>
484317 <para>
485− NixOS module system type <literal>types.optionSet</literal> and
486− <literal>lib.mkOption</literal> argument <literal>options</literal> are
487− deprecated. Use <literal>types.submodule</literal> instead.
488− (<link xlink:href="https://github.com/NixOS/nixpkgs/pull/54637">#54637</link>)
318+ NixOS module system type <literal>types.optionSet</literal> and <literal>lib.mkOption</literal> argument <literal>options</literal> are deprecated. Use <literal>types.submodule</literal> instead. (<link xlink:href="https://github.com/NixOS/nixpkgs/pull/54637">#54637</link>)
489319 </para>
490320 </listitem>
491321 <listitem>
492322 <para>
493− <literal>matrix-synapse</literal> has been updated to version 0.99. It
494− will <link xlink:href="https://github.com/matrix-org/synapse/pull/4509">no
495− longer generate a self-signed certificate on first launch</link> and will
496− be
497− <link xlink:href="https://matrix.org/blog/2019/02/05/synapse-0-99-0/">the
498− last version to accept self-signed certificates</link>. As such, it is now
499− recommended to use a proper certificate verified by a root CA (for example
500− Let's Encrypt). The new <link linkend="module-services-matrix">manual
501− chapter on Matrix</link> contains a working example of using nginx as a
502− reverse proxy in front of <literal>matrix-synapse</literal>, using Let's
503− Encrypt certificates.
323+ <literal>matrix-synapse</literal> has been updated to version 0.99. It will <link xlink:href="https://github.com/matrix-org/synapse/pull/4509">no longer generate a self-signed certificate on first launch</link> and will be <link xlink:href="https://matrix.org/blog/2019/02/05/synapse-0-99-0/">the last version to accept self-signed certificates</link>. As such, it is now recommended to use a proper certificate verified by a root CA (for example Let's Encrypt). The new <link linkend="module-services-matrix">manual chapter on Matrix</link> contains a working example of using nginx as a reverse proxy in front of <literal>matrix-synapse</literal>, using Let's Encrypt certificates.
504324 </para>
505325 </listitem>
506326 <listitem>
507327 <para>
508− <literal>mailutils</literal> now works by default when
509− <literal>sendmail</literal> is not in a setuid wrapper. As a consequence,
510− the <literal>sendmailPath</literal> argument, having lost its main use,
511− has been removed.
328+ <literal>mailutils</literal> now works by default when <literal>sendmail</literal> is not in a setuid wrapper. As a consequence, the <literal>sendmailPath</literal> argument, having lost its main use, has been removed.
512329 </para>
513330 </listitem>
514331 <listitem>
515332 <para>
516− <literal>graylog</literal> has been upgraded from version 2.* to 3.*. Some
517− setups making use of extraConfig (especially those exposing Graylog via
518− reverse proxies) need to be updated as upstream removed/replaced some
519− settings. See
520− <link xlink:href="http://docs.graylog.org/en/3.0/pages/upgrade/graylog-3.0.html#simplified-http-interface-configuration">Upgrading
521− Graylog</link> for details.
333+ <literal>graylog</literal> has been upgraded from version 2.* to 3.*. Some setups making use of extraConfig (especially those exposing Graylog via reverse proxies) need to be updated as upstream removed/replaced some settings. See <link xlink:href="http://docs.graylog.org/en/3.0/pages/upgrade/graylog-3.0.html#simplified-http-interface-configuration">Upgrading Graylog</link> for details.
522334 </para>
523335 </listitem>
524336 <listitem>
525337 <para>
526− The option <literal>users.ldap.bind.password</literal> was renamed to <literal>users.ldap.bind.passwordFile</literal>,
527− and needs to be readable by the <literal>nslcd</literal> user.
528− Same applies to the new <literal>users.ldap.daemon.rootpwmodpwFile</literal> option.
338+ The option <literal>users.ldap.bind.password</literal> was renamed to <literal>users.ldap.bind.passwordFile</literal>, and needs to be readable by the <literal>nslcd</literal> user. Same applies to the new <literal>users.ldap.daemon.rootpwmodpwFile</literal> option.
529339 </para>
530340 </listitem>
531341 <listitem>
532− <para>
533− <literal>nodejs-6_x</literal> is end-of-life.
534− <literal>nodejs-6_x</literal>, <literal>nodejs-slim-6_x</literal> and
535− <literal>nodePackages_6_x</literal> are removed.
536− </para>
342+ <para>
343+ <literal>nodejs-6_x</literal> is end-of-life. <literal>nodejs-6_x</literal>, <literal>nodejs-slim-6_x</literal> and <literal>nodePackages_6_x</literal> are removed.
344+ </para>
537345 </listitem>
538346 </itemizedlist>
539347 </section>
@@ -548,214 +356,122 @@
548356 <itemizedlist>
549357 <listitem>
550358 <para>
551− The <option>services.matomo</option> module gained the option
552− <option>services.matomo.package</option> which determines the used Matomo
553− version.
359+ The <option>services.matomo</option> module gained the option <option>services.matomo.package</option> which determines the used Matomo version.
554360 </para>
555361 <para>
556− The Matomo module now also comes with the systemd service
557− <literal>matomo-archive-processing.service</literal> and a timer that
558− automatically triggers archive processing every hour. This means that you
559− can safely
560− <link xlink:href="https://matomo.org/docs/setup-auto-archiving/#disable-browser-triggers-for-matomo-archiving-and-limit-matomo-reports-to-updating-every-hour">
561− disable browser triggers for Matomo archiving </link> at
562− <literal>Administration > System > General Settings</literal>.
362+ The Matomo module now also comes with the systemd service <literal>matomo-archive-processing.service</literal> and a timer that automatically triggers archive processing every hour. This means that you can safely <link xlink:href="https://matomo.org/docs/setup-auto-archiving/#disable-browser-triggers-for-matomo-archiving-and-limit-matomo-reports-to-updating-every-hour"> disable browser triggers for Matomo archiving </link> at <literal>Administration > System > General Settings</literal>.
563363 </para>
564364 <para>
565− Additionally, you can enable to
566− <link xlink:href="https://matomo.org/docs/privacy/#step-2-delete-old-visitors-logs">
567− delete old visitor logs </link> at <literal>Administration > System >
568− Privacy</literal>, but make sure that you run <literal>systemctl start
569− matomo-archive-processing.service</literal> at least once without errors
570− if you have already collected data before, so that the reports get
571− archived before the source data gets deleted.
365+ Additionally, you can enable to <link xlink:href="https://matomo.org/docs/privacy/#step-2-delete-old-visitors-logs"> delete old visitor logs </link> at <literal>Administration > System > Privacy</literal>, but make sure that you run <literal>systemctl start matomo-archive-processing.service</literal> at least once without errors if you have already collected data before, so that the reports get archived before the source data gets deleted.
572366 </para>
573367 </listitem>
574368 <listitem>
575369 <para>
576− <literal>composableDerivation</literal> along with supporting library
577− functions has been removed.
370+ <literal>composableDerivation</literal> along with supporting library functions has been removed.
578371 </para>
579372 </listitem>
580373 <listitem>
581374 <para>
582− The deprecated <literal>truecrypt</literal> package has been removed and
583− <literal>truecrypt</literal> attribute is now an alias for
584− <literal>veracrypt</literal>. VeraCrypt is backward-compatible with
585− TrueCrypt volumes. Note that <literal>cryptsetup</literal> also supports
586− loading TrueCrypt volumes.
375+ The deprecated <literal>truecrypt</literal> package has been removed and <literal>truecrypt</literal> attribute is now an alias for <literal>veracrypt</literal>. VeraCrypt is backward-compatible with TrueCrypt volumes. Note that <literal>cryptsetup</literal> also supports loading TrueCrypt volumes.
587376 </para>
588377 </listitem>
589378 <listitem>
590379 <para>
591− The Kubernetes DNS addons, kube-dns, has been replaced with CoreDNS. This
592− change is made in accordance with Kubernetes making CoreDNS the official
593− default starting from
594− <link xlink:href="https://github.com/kubernetes/kubernetes/blob/master/CHANGELOG-1.11.md#sig-cluster-lifecycle">Kubernetes
595− v1.11</link>. Please beware that upgrading DNS-addon on existing clusters
596− might induce minor downtime while the DNS-addon terminates and
597− re-initializes. Also note that the DNS-service now runs with 2 pod
598− replicas by default. The desired number of replicas can be configured
599− using: <option>services.kubernetes.addons.dns.replicas</option>.
380+ The Kubernetes DNS addons, kube-dns, has been replaced with CoreDNS. This change is made in accordance with Kubernetes making CoreDNS the official default starting from <link xlink:href="https://github.com/kubernetes/kubernetes/blob/master/CHANGELOG-1.11.md#sig-cluster-lifecycle">Kubernetes v1.11</link>. Please beware that upgrading DNS-addon on existing clusters might induce minor downtime while the DNS-addon terminates and re-initializes. Also note that the DNS-service now runs with 2 pod replicas by default. The desired number of replicas can be configured using: <option>services.kubernetes.addons.dns.replicas</option>.
600381 </para>
601382 </listitem>
602383 <listitem>
603384 <para>
604− The quassel-webserver package and module was removed from nixpkgs due to
605− the lack of maintainers.
385+ The quassel-webserver package and module was removed from nixpkgs due to the lack of maintainers.
606386 </para>
607387 </listitem>
608388 <listitem>
609389 <para>
610− The manual gained a <link linkend="module-services-matrix"> new chapter on
611− self-hosting <literal>matrix-synapse</literal> and
612− <literal>riot-web</literal> </link>, the most prevalent server and client
613− implementations for the
614− <link xlink:href="https://matrix.org/">Matrix</link> federated
615− communication network.
390+ The manual gained a <link linkend="module-services-matrix"> new chapter on self-hosting <literal>matrix-synapse</literal> and <literal>riot-web</literal> </link>, the most prevalent server and client implementations for the <link xlink:href="https://matrix.org/">Matrix</link> federated communication network.
616391 </para>
617392 </listitem>
618393 <listitem>
619394 <para>
620− The astah-community package was removed from nixpkgs due to it being
621− discontinued and the downloads not being available anymore.
395+ The astah-community package was removed from nixpkgs due to it being discontinued and the downloads not being available anymore.
622396 </para>
623397 </listitem>
624398 <listitem>
625399 <para>
626− The httpd service now saves log files with a .log file extension by
627− default for easier integration with the logrotate service.
400+ The httpd service now saves log files with a .log file extension by default for easier integration with the logrotate service.
628401 </para>
629402 </listitem>
630403 <listitem>
631404 <para>
632− The owncloud server packages and httpd subservice module were removed from
633− nixpkgs due to the lack of maintainers.
405+ The owncloud server packages and httpd subservice module were removed from nixpkgs due to the lack of maintainers.
634406 </para>
635407 </listitem>
636408 <listitem>
637409 <para>
638− It is possible now to uze ZRAM devices as general purpose ephemeral block
639− devices, not only as swap. Using more than 1 device as ZRAM swap is no
640− longer recommended, but is still possible by setting
641− <literal>zramSwap.swapDevices</literal> explicitly.
410+ It is possible now to uze ZRAM devices as general purpose ephemeral block devices, not only as swap. Using more than 1 device as ZRAM swap is no longer recommended, but is still possible by setting <literal>zramSwap.swapDevices</literal> explicitly.
642411 </para>
643412 <para>
644413 ZRAM algorithm can be changed now.
645414 </para>
646415 <para>
647− Changes to ZRAM algorithm are applied during <literal>nixos-rebuild
648− switch</literal>, so make sure you have enough swap space on disk to
649− survive ZRAM device rebuild. Alternatively, use <literal>nixos-rebuild
650− boot; reboot</literal>.
416+ Changes to ZRAM algorithm are applied during <literal>nixos-rebuild switch</literal>, so make sure you have enough swap space on disk to survive ZRAM device rebuild. Alternatively, use <literal>nixos-rebuild boot; reboot</literal>.
651417 </para>
652418 </listitem>
653419 <listitem>
654420 <para>
655− Flat volumes are now disabled by default in
656− <literal>hardware.pulseaudio</literal>. This has been done to prevent
657− applications, which are unaware of this feature, setting their volumes to
658− 100% on startup causing harm to your audio hardware and potentially your
659− ears.
421+ Flat volumes are now disabled by default in <literal>hardware.pulseaudio</literal>. This has been done to prevent applications, which are unaware of this feature, setting their volumes to 100% on startup causing harm to your audio hardware and potentially your ears.
660422 </para>
661423 <note>
662424 <para>
663− With this change application specific volumes are relative to the master
664− volume which can be adjusted independently, whereas before they were
665− absolute; meaning that in effect, it scaled the device-volume with the
666− volume of the loudest application.
425+ With this change application specific volumes are relative to the master volume which can be adjusted independently, whereas before they were absolute; meaning that in effect, it scaled the device-volume with the volume of the loudest application.
667426 </para>
668427 </note>
669428 </listitem>
670429 <listitem>
671430 <para>
672− The
673− <link xlink:href="https://github.com/DanielAdolfsson/ndppd"><literal>ndppd</literal></link>
674− module now supports <link linkend="opt-services.ndppd.enable">all config
675− options</link> provided by the current upstream version as service
676− options. Additionally the <literal>ndppd</literal> package doesn't contain
677− the systemd unit configuration from upstream anymore, the unit is
678− completely configured by the NixOS module now.
431+ The <link xlink:href="https://github.com/DanielAdolfsson/ndppd"><literal>ndppd</literal></link> module now supports <link linkend="opt-services.ndppd.enable">all config options</link> provided by the current upstream version as service options. Additionally the <literal>ndppd</literal> package doesn't contain the systemd unit configuration from upstream anymore, the unit is completely configured by the NixOS module now.
679432 </para>
680433 </listitem>
681434 <listitem>
682435 <para>
683− New installs of NixOS will default to the Redmine 4.x series unless
684− otherwise specified in <literal>services.redmine.package</literal> while
685− existing installs of NixOS will default to the Redmine 3.x series.
436+ New installs of NixOS will default to the Redmine 4.x series unless otherwise specified in <literal>services.redmine.package</literal> while existing installs of NixOS will default to the Redmine 3.x series.
686437 </para>
687438 </listitem>
688439 <listitem>
689440 <para>
690− The <link linkend="opt-services.grafana.enable">Grafana module</link> now
691− supports declarative
692− <link xlink:href="http://docs.grafana.org/administration/provisioning/">datasource
693− and dashboard</link> provisioning.
441+ The <link linkend="opt-services.grafana.enable">Grafana module</link> now supports declarative <link xlink:href="http://docs.grafana.org/administration/provisioning/">datasource and dashboard</link> provisioning.
694442 </para>
695443 </listitem>
696444 <listitem>
697445 <para>
698− The use of insecure ports on kubernetes has been deprecated. Thus options:
699− <varname>services.kubernetes.apiserver.port</varname> and
700− <varname>services.kubernetes.controllerManager.port</varname> has been
701− renamed to <varname>.insecurePort</varname>, and default of both options
702− has changed to 0 (disabled).
446+ The use of insecure ports on kubernetes has been deprecated. Thus options: <varname>services.kubernetes.apiserver.port</varname> and <varname>services.kubernetes.controllerManager.port</varname> has been renamed to <varname>.insecurePort</varname>, and default of both options has changed to 0 (disabled).
703447 </para>
704448 </listitem>
705449 <listitem>
706450 <para>
707− Note that the default value of
708− <varname>services.kubernetes.apiserver.bindAddress</varname> has changed
709− from 127.0.0.1 to 0.0.0.0, allowing the apiserver to be accessible from
710− outside the master node itself. If the apiserver insecurePort is enabled,
711− it is strongly recommended to only bind on the loopback interface. See:
712− <varname>services.kubernetes.apiserver.insecurebindAddress</varname>.
451+ Note that the default value of <varname>services.kubernetes.apiserver.bindAddress</varname> has changed from 127.0.0.1 to 0.0.0.0, allowing the apiserver to be accessible from outside the master node itself. If the apiserver insecurePort is enabled, it is strongly recommended to only bind on the loopback interface. See: <varname>services.kubernetes.apiserver.insecurebindAddress</varname>.
713452 </para>
714453 </listitem>
715454 <listitem>
716455 <para>
717− The option
718− <varname>services.kubernetes.apiserver.allowPrivileged</varname> and
719− <varname>services.kubernetes.kubelet.allowPrivileged</varname> now
720− defaults to false. Disallowing privileged containers on the cluster.
456+ The option <varname>services.kubernetes.apiserver.allowPrivileged</varname> and <varname>services.kubernetes.kubelet.allowPrivileged</varname> now defaults to false. Disallowing privileged containers on the cluster.
721457 </para>
722458 </listitem>
723459 <listitem>
724460 <para>
725− The kubernetes module does no longer add the kubernetes package to
726− <varname>environment.systemPackages</varname> implicitly.
461+ The kubernetes module does no longer add the kubernetes package to <varname>environment.systemPackages</varname> implicitly.
727462 </para>
728463 </listitem>
729464 <listitem>
730465 <para>
731− The <literal>intel</literal> driver has been removed from the default list
732− of <link linkend="opt-services.xserver.videoDrivers">X.org video
733− drivers</link>. The <literal>modesetting</literal> driver should take over
734− automatically, it is better maintained upstream and has less problems with
735− advanced X11 features. This can lead to a change in the output names used
736− by <literal>xrandr</literal>. Some performance regressions on some GPU
737− models might happen. Some OpenCL and VA-API applications might also break
738− (Beignet seems to provide OpenCL support with
739− <literal>modesetting</literal> driver, too). Kernel mode setting API does
740− not support backlight control, so <literal>xbacklight</literal> tool will
741− not work; backlight level can be controlled directly via
742− <literal>/sys/</literal> or with <literal>brightnessctl</literal>. Users
743− who need this functionality more than multi-output XRandR are advised to
744− add `intel` to `videoDrivers` and report an issue (or provide additional
745− details in an existing one)
466+ The <literal>intel</literal> driver has been removed from the default list of <link linkend="opt-services.xserver.videoDrivers">X.org video drivers</link>. The <literal>modesetting</literal> driver should take over automatically, it is better maintained upstream and has less problems with advanced X11 features. This can lead to a change in the output names used by <literal>xrandr</literal>. Some performance regressions on some GPU models might happen. Some OpenCL and VA-API applications might also break (Beignet seems to provide OpenCL support with <literal>modesetting</literal> driver, too). Kernel mode setting API does not support backlight control, so <literal>xbacklight</literal> tool will not work; backlight level can be controlled directly via <literal>/sys/</literal> or with <literal>brightnessctl</literal>. Users who need this functionality more than multi-output XRandR are advised to add `intel` to `videoDrivers` and report an issue (or provide additional details in an existing one)
746467 </para>
747468 </listitem>
748469 <listitem>
749470 <para>
750− Openmpi has been updated to version 4.0.0, which removes some deprecated
751− MPI-1 symbols. This may break some older applications that still rely on
752− those symbols. An upgrade guide can be found
753− <link xlink:href="https://www.open-mpi.org/faq/?category=mpi-removed">here</link>.
471+ Openmpi has been updated to version 4.0.0, which removes some deprecated MPI-1 symbols. This may break some older applications that still rely on those symbols. An upgrade guide can be found <link xlink:href="https://www.open-mpi.org/faq/?category=mpi-removed">here</link>.
754472 </para>
755473 <para>
756− The nginx package now relies on OpenSSL 1.1 and supports TLS 1.3 by
757− default. You can set the protocols used by the nginx service using
758− <xref linkend="opt-services.nginx.sslProtocols"/>.
474+ The nginx package now relies on OpenSSL 1.1 and supports TLS 1.3 by default. You can set the protocols used by the nginx service using <xref linkend="opt-services.nginx.sslProtocols"/>.
759475 </para>
760476 </listitem>
761477 <listitem>
nixos/doc/manual/release-notes/rl-1909.xml+325−406
@@ -13,8 +13,7 @@
1313 <title>Highlights</title>
1414
1515 <para>
16− In addition to numerous new and upgraded packages, this release has the
17− following highlights:
16+ In addition to numerous new and upgraded packages, this release has the following highlights:
1817 </para>
1918
2019 <itemizedlist>
@@ -34,85 +33,155 @@
3433 </para>
3534 </listitem>
3635 <listitem>
37− <para>
38− The binfmt module is now easier to use. Additional systems can
39− be added through <option>boot.binfmt.emulatedSystems</option>.
40− For instance, <literal>boot.binfmt.emulatedSystems = [
41− "wasm32-wasi" "x86_64-windows" "aarch64-linux" ];</literal> will
42− set up binfmt interpreters for each of those listed systems.
43− </para>
36+ <para>
37+ The binfmt module is now easier to use. Additional systems can be added through <option>boot.binfmt.emulatedSystems</option>. For instance, <literal>boot.binfmt.emulatedSystems = [ "wasm32-wasi" "x86_64-windows" "aarch64-linux" ];</literal> will set up binfmt interpreters for each of those listed systems.
38+ </para>
4439 </listitem>
4540 <listitem>
46− <para>
47− The installer now uses a less privileged <literal>nixos</literal> user whereas before we logged in as root.
48− To gain root privileges use <literal>sudo -i</literal> without a password.
41+ <para>
42+ The installer now uses a less privileged <literal>nixos</literal> user whereas before we logged in as root. To gain root privileges use <literal>sudo -i</literal> without a password.
4943 </para>
5044 </listitem>
5145 <listitem>
5246 <para>
53− We've updated to Xfce 4.14, which brings a new module <option>services.xserver.desktopManager.xfce4-14</option>.
54− If you'd like to upgrade, please switch from the <option>services.xserver.desktopManager.xfce</option> module as it
55− will be deprecated in a future release. They're incompatibilities with the current Xfce module; it doesn't support
56− <option>thunarPlugins</option> and it isn't recommended to use <option>services.xserver.desktopManager.xfce</option>
57− and <option>services.xserver.desktopManager.xfce4-14</option> simultaneously or to downgrade from Xfce 4.14 after upgrading.
47+ We've updated to Xfce 4.14, which brings a new module <option>services.xserver.desktopManager.xfce4-14</option>. If you'd like to upgrade, please switch from the <option>services.xserver.desktopManager.xfce</option> module as it will be deprecated in a future release. They're incompatibilities with the current Xfce module; it doesn't support <option>thunarPlugins</option> and it isn't recommended to use <option>services.xserver.desktopManager.xfce</option> and <option>services.xserver.desktopManager.xfce4-14</option> simultaneously or to downgrade from Xfce 4.14 after upgrading.
5848 </para>
5949 </listitem>
6050 <listitem>
6151 <para>
62− The GNOME 3 desktop manager module sports an interface to enable/disable core services, applications, and optional GNOME packages
63− like games.
64− <itemizedlist>
65− <para>This can be achieved with the following options which the desktop manager default enables, excluding <literal>games</literal>.</para>
66− <listitem><para><xref linkend="opt-services.gnome3.core-os-services.enable"/></para></listitem>
67− <listitem><para><xref linkend="opt-services.gnome3.core-shell.enable"/></para></listitem>
68− <listitem><para><xref linkend="opt-services.gnome3.core-utilities.enable"/></para></listitem>
69− <listitem><para><xref linkend="opt-services.gnome3.games.enable"/></para></listitem>
70− </itemizedlist>
71− With these options we hope to give users finer grained control over their systems. Prior to this change you'd either have to manually
72− disable options or use <option>environment.gnome3.excludePackages</option> which only excluded the optional applications.
73− <option>environment.gnome3.excludePackages</option> is now unguarded, it can exclude any package installed with <option>environment.systemPackages</option>
74− in the GNOME 3 module.
52+ The GNOME 3 desktop manager module sports an interface to enable/disable core services, applications, and optional GNOME packages like games.
53+ <itemizedlist>
54+ <para>
55+ This can be achieved with the following options which the desktop manager default enables, excluding <literal>games</literal>.
56+ </para>
57+ <listitem>
58+ <para>
59+ <xref linkend="opt-services.gnome3.core-os-services.enable"/>
60+ </para>
61+ </listitem>
62+ <listitem>
63+ <para>
64+ <xref linkend="opt-services.gnome3.core-shell.enable"/>
65+ </para>
66+ </listitem>
67+ <listitem>
68+ <para>
69+ <xref linkend="opt-services.gnome3.core-utilities.enable"/>
70+ </para>
71+ </listitem>
72+ <listitem>
73+ <para>
74+ <xref linkend="opt-services.gnome3.games.enable"/>
75+ </para>
76+ </listitem>
77+ </itemizedlist>
78+ With these options we hope to give users finer grained control over their systems. Prior to this change you'd either have to manually disable options or use <option>environment.gnome3.excludePackages</option> which only excluded the optional applications. <option>environment.gnome3.excludePackages</option> is now unguarded, it can exclude any package installed with <option>environment.systemPackages</option> in the GNOME 3 module.
7579 </para>
7680 </listitem>
7781 <listitem>
7882 <para>
79− Orthogonal to the previous changes to the GNOME 3 desktop manager module, we've updated all default services and applications
80− to match as close as possible to a default reference GNOME 3 experience.
83+ Orthogonal to the previous changes to the GNOME 3 desktop manager module, we've updated all default services and applications to match as close as possible to a default reference GNOME 3 experience.
8184 </para>
82−
83− <bridgehead>The following changes were enacted in <option>services.gnome3.core-utilities.enable</option></bridgehead>
84−
85+ <bridgehead>The following changes were enacted in <option>services.gnome3.core-utilities.enable</option>
86+ </bridgehead>
8587 <itemizedlist>
8688 <title>Applications removed from defaults:</title>
87− <listitem><para><literal>accerciser</literal></para></listitem>
88− <listitem><para><literal>dconf-editor</literal></para></listitem>
89− <listitem><para><literal>evolution</literal></para></listitem>
90− <listitem><para><literal>gnome-documents</literal></para></listitem>
91− <listitem><para><literal>gnome-nettool</literal></para></listitem>
92− <listitem><para><literal>gnome-power-manager</literal></para></listitem>
93− <listitem><para><literal>gnome-todo</literal></para></listitem>
94− <listitem><para><literal>gnome-tweaks</literal></para></listitem>
95− <listitem><para><literal>gnome-usage</literal></para></listitem>
96− <listitem><para><literal>gucharmap</literal></para></listitem>
97− <listitem><para><literal>nautilus-sendto</literal></para></listitem>
98− <listitem><para><literal>vinagre</literal></para></listitem>
89+ <listitem>
90+ <para>
91+ <literal>accerciser</literal>
92+ </para>
93+ </listitem>
94+ <listitem>
95+ <para>
96+ <literal>dconf-editor</literal>
97+ </para>
98+ </listitem>
99+ <listitem>
100+ <para>
101+ <literal>evolution</literal>
102+ </para>
103+ </listitem>
104+ <listitem>
105+ <para>
106+ <literal>gnome-documents</literal>
107+ </para>
108+ </listitem>
109+ <listitem>
110+ <para>
111+ <literal>gnome-nettool</literal>
112+ </para>
113+ </listitem>
114+ <listitem>
115+ <para>
116+ <literal>gnome-power-manager</literal>
117+ </para>
118+ </listitem>
119+ <listitem>
120+ <para>
121+ <literal>gnome-todo</literal>
122+ </para>
123+ </listitem>
124+ <listitem>
125+ <para>
126+ <literal>gnome-tweaks</literal>
127+ </para>
128+ </listitem>
129+ <listitem>
130+ <para>
131+ <literal>gnome-usage</literal>
132+ </para>
133+ </listitem>
134+ <listitem>
135+ <para>
136+ <literal>gucharmap</literal>
137+ </para>
138+ </listitem>
139+ <listitem>
140+ <para>
141+ <literal>nautilus-sendto</literal>
142+ </para>
143+ </listitem>
144+ <listitem>
145+ <para>
146+ <literal>vinagre</literal>
147+ </para>
148+ </listitem>
99149 </itemizedlist>
100150 <itemizedlist>
101151 <title>Applications added to defaults:</title>
102− <listitem><para><literal>cheese</literal></para></listitem>
103− <listitem><para><literal>geary</literal></para></listitem>
152+ <listitem>
153+ <para>
154+ <literal>cheese</literal>
155+ </para>
156+ </listitem>
157+ <listitem>
158+ <para>
159+ <literal>geary</literal>
160+ </para>
161+ </listitem>
104162 </itemizedlist>
105−
106− <bridgehead>The following changes were enacted in <option>services.gnome3.core-shell.enable</option></bridgehead>
107−
163+ <bridgehead>The following changes were enacted in <option>services.gnome3.core-shell.enable</option>
164+ </bridgehead>
108165 <itemizedlist>
109166 <title>Applications added to defaults:</title>
110− <listitem><para><literal>gnome-color-manager</literal></para></listitem>
111− <listitem><para><literal>orca</literal></para></listitem>
167+ <listitem>
168+ <para>
169+ <literal>gnome-color-manager</literal>
170+ </para>
171+ </listitem>
172+ <listitem>
173+ <para>
174+ <literal>orca</literal>
175+ </para>
176+ </listitem>
112177 </itemizedlist>
113178 <itemizedlist>
114179 <title>Services enabled:</title>
115− <listitem><para><option>services.avahi.enable</option></para></listitem>
180+ <listitem>
181+ <para>
182+ <option>services.avahi.enable</option>
183+ </para>
184+ </listitem>
116185 </itemizedlist>
117186 </listitem>
118187 </itemizedlist>
@@ -137,41 +206,43 @@
137206 </listitem>
138207 <listitem>
139208 <para>
140− The new <varname>hardware.printers</varname> module allows to declaratively configure CUPS printers
141− via the <varname>ensurePrinters</varname> and
142− <varname>ensureDefaultPrinter</varname> options.
143− <varname>ensurePrinters</varname> will never delete existing printers,
144− but will make sure that the given printers are configured as declared.
209+ The new <varname>hardware.printers</varname> module allows to declaratively configure CUPS printers via the <varname>ensurePrinters</varname> and <varname>ensureDefaultPrinter</varname> options. <varname>ensurePrinters</varname> will never delete existing printers, but will make sure that the given printers are configured as declared.
145210 </para>
146211 </listitem>
147212 <listitem>
148213 <para>
149− There is a new <xref linkend="opt-services.system-config-printer.enable"/> and <xref linkend="opt-programs.system-config-printer.enable"/> module
150− for the program of the same name. If you previously had <literal>system-config-printer</literal> enabled through some other
151− means you should migrate to using one of these modules.
214+ There is a new <xref linkend="opt-services.system-config-printer.enable"/> and <xref linkend="opt-programs.system-config-printer.enable"/> module for the program of the same name. If you previously had <literal>system-config-printer</literal> enabled through some other means you should migrate to using one of these modules.
152215 </para>
153216 <itemizedlist>
154− <para>If you're a user of the following desktopManager modules no action is needed:</para>
217+ <para>
218+ If you're a user of the following desktopManager modules no action is needed:
219+ </para>
155220 <listitem>
156− <para><option>services.xserver.desktopManager.plasma5</option></para>
221+ <para>
222+ <option>services.xserver.desktopManager.plasma5</option>
223+ </para>
157224 </listitem>
158225 <listitem>
159− <para><option>services.xserver.desktopManager.gnome3</option></para>
226+ <para>
227+ <option>services.xserver.desktopManager.gnome3</option>
228+ </para>
160229 </listitem>
161230 <listitem>
162− <para><option>services.xserver.desktopManager.pantheon</option></para>
231+ <para>
232+ <option>services.xserver.desktopManager.pantheon</option>
233+ </para>
163234 </listitem>
164235 <listitem>
165− <para><option>services.xserver.desktopManager.mate</option></para>
166236 <para>
167− Note Mate uses <literal>programs.system-config-printer</literal> as it doesn't
168− use it as a service, but its graphical interface directly.
237+ <option>services.xserver.desktopManager.mate</option>
238+ </para>
239+ <para>
240+ Note Mate uses <literal>programs.system-config-printer</literal> as it doesn't use it as a service, but its graphical interface directly.
169241 </para>
170242 </listitem>
171243 </itemizedlist>
172244 </listitem>
173245 </itemizedlist>
174−
175246 </section>
176247
177248 <section xmlns="http://docbook.org/ns/docbook"
@@ -182,26 +253,18 @@
182253 <title>Backward Incompatibilities</title>
183254
184255 <para>
185− When upgrading from a previous release, please be aware of the following
186− incompatible changes:
256+ When upgrading from a previous release, please be aware of the following incompatible changes:
187257 </para>
188258
189259 <itemizedlist>
190260 <listitem>
191261 <para>
192− Buildbot no longer supports Python 2, as support was dropped upstream in
193− version 2.0.0. Configurations may need to be modified to make them
194− compatible with Python 3.
262+ Buildbot no longer supports Python 2, as support was dropped upstream in version 2.0.0. Configurations may need to be modified to make them compatible with Python 3.
195263 </para>
196264 </listitem>
197265 <listitem>
198266 <para>
199− PostgreSQL now uses
200− <filename class="directory">/run/postgresql</filename> as its socket
201− directory instead of <filename class="directory">/tmp</filename>. So
202− if you run an application like eg. Nextcloud, where you need to use
203− the Unix socket path as the database host name, you need to change it
204− accordingly.
267+ PostgreSQL now uses <filename class="directory">/run/postgresql</filename> as its socket directory instead of <filename class="directory">/tmp</filename>. So if you run an application like eg. Nextcloud, where you need to use the Unix socket path as the database host name, you need to change it accordingly.
205268 </para>
206269 </listitem>
207270 <listitem>
@@ -211,278 +274,212 @@
211274 </listitem>
212275 <listitem>
213276 <para>
214− The options <option>services.prometheus.alertmanager.user</option> and
215− <option>services.prometheus.alertmanager.group</option> have been removed
216− because the alertmanager service is now using systemd's <link
217− xlink:href="http://0pointer.net/blog/dynamic-users-with-systemd.html">
218− DynamicUser mechanism</link> which obviates these options.
277+ The options <option>services.prometheus.alertmanager.user</option> and <option>services.prometheus.alertmanager.group</option> have been removed because the alertmanager service is now using systemd's <link
278+ xlink:href="http://0pointer.net/blog/dynamic-users-with-systemd.html"> DynamicUser mechanism</link> which obviates these options.
219279 </para>
220280 </listitem>
221281 <listitem>
222282 <para>
223− The NetworkManager systemd unit was renamed back from network-manager.service to
224− NetworkManager.service for better compatibility with other applications expecting this name.
225− The same applies to ModemManager where modem-manager.service is now called ModemManager.service again.
283+ The NetworkManager systemd unit was renamed back from network-manager.service to NetworkManager.service for better compatibility with other applications expecting this name. The same applies to ModemManager where modem-manager.service is now called ModemManager.service again.
226284 </para>
227285 </listitem>
228286 <listitem>
229287 <para>
230− The <option>services.nzbget.configFile</option> and <option>services.nzbget.openFirewall</option>
231− options were removed as they are managed internally by the nzbget. The
232− <option>services.nzbget.dataDir</option> option hadn't actually been used by
233− the module for some time and so was removed as cleanup.
288+ The <option>services.nzbget.configFile</option> and <option>services.nzbget.openFirewall</option> options were removed as they are managed internally by the nzbget. The <option>services.nzbget.dataDir</option> option hadn't actually been used by the module for some time and so was removed as cleanup.
234289 </para>
235290 </listitem>
236291 <listitem>
237292 <para>
238− The <option>services.mysql.pidDir</option> option was removed, as it was only used by the wordpress
239− apache-httpd service to wait for mysql to have started up.
240− This can be accomplished by either describing a dependency on mysql.service (preferred)
241− or waiting for the (hardcoded) <filename>/run/mysqld/mysql.sock</filename> file to appear.
293+ The <option>services.mysql.pidDir</option> option was removed, as it was only used by the wordpress apache-httpd service to wait for mysql to have started up. This can be accomplished by either describing a dependency on mysql.service (preferred) or waiting for the (hardcoded) <filename>/run/mysqld/mysql.sock</filename> file to appear.
242294 </para>
243295 </listitem>
244296 <listitem>
245297 <para>
246− The <option>services.emby.enable</option> module has been removed, see
247− <option>services.jellyfin.enable</option> instead for a free software fork of Emby.
248−
249− See the Jellyfin documentation:
250− <link xlink:href="https://jellyfin.readthedocs.io/en/latest/administrator-docs/migrate-from-emby/">
251− Migrating from Emby to Jellyfin
252− </link>
298+ The <option>services.emby.enable</option> module has been removed, see <option>services.jellyfin.enable</option> instead for a free software fork of Emby. See the Jellyfin documentation: <link xlink:href="https://jellyfin.readthedocs.io/en/latest/administrator-docs/migrate-from-emby/"> Migrating from Emby to Jellyfin </link>
253299 </para>
254300 </listitem>
255301 <listitem>
256− <para>
257− IPv6 Privacy Extensions are now enabled by default for undeclared
258− interfaces. The previous behaviour was quite misleading — even though
259− the default value for
260− <option>networking.interfaces.*.preferTempAddress</option> was
261− <literal>true</literal>, undeclared interfaces would not prefer temporary
262− addresses. Now, interfaces not mentioned in the config will prefer
263− temporary addresses. EUI64 addresses can still be set as preferred by
264− explicitly setting the option to <literal>false</literal> for the
265− interface in question.
302+ <para>
303+ IPv6 Privacy Extensions are now enabled by default for undeclared interfaces. The previous behaviour was quite misleading — even though the default value for <option>networking.interfaces.*.preferTempAddress</option> was <literal>true</literal>, undeclared interfaces would not prefer temporary addresses. Now, interfaces not mentioned in the config will prefer temporary addresses. EUI64 addresses can still be set as preferred by explicitly setting the option to <literal>false</literal> for the interface in question.
266304 </para>
267305 </listitem>
268306 <listitem>
269307 <para>
270− Since Bittorrent Sync was superseded by Resilio Sync in 2016, the
271− <literal>bittorrentSync</literal>, <literal>bittorrentSync14</literal>,
272− and <literal>bittorrentSync16</literal> packages have been removed in
273− favor of <literal>resilio-sync</literal>.
308+ Since Bittorrent Sync was superseded by Resilio Sync in 2016, the <literal>bittorrentSync</literal>, <literal>bittorrentSync14</literal>, and <literal>bittorrentSync16</literal> packages have been removed in favor of <literal>resilio-sync</literal>.
274309 </para>
275310 <para>
276− The corresponding module, <option>services.btsync</option> has been
277− replaced by the <option>services.resilio</option> module.
311+ The corresponding module, <option>services.btsync</option> has been replaced by the <option>services.resilio</option> module.
278312 </para>
279313 </listitem>
280314 <listitem>
281315 <para>
282− The httpd service no longer attempts to start the postgresql service. If you have come to depend
283− on this behaviour then you can preserve the behavior with the following configuration:
284− <literal>systemd.services.httpd.after = [ "postgresql.service" ];</literal>
316+ The httpd service no longer attempts to start the postgresql service. If you have come to depend on this behaviour then you can preserve the behavior with the following configuration: <literal>systemd.services.httpd.after = [ "postgresql.service" ];</literal>
285317 </para>
286318 <para>
287− The option <option>services.httpd.extraSubservices</option> has been
288− marked as deprecated. You may still use this feature, but it will be
289− removed in a future release of NixOS. You are encouraged to convert any
290− httpd subservices you may have written to a full NixOS module.
319+ The option <option>services.httpd.extraSubservices</option> has been marked as deprecated. You may still use this feature, but it will be removed in a future release of NixOS. You are encouraged to convert any httpd subservices you may have written to a full NixOS module.
291320 </para>
292321 <para>
293− Most of the httpd subservices packaged with NixOS have been replaced with
294− full NixOS modules including LimeSurvey, WordPress, and Zabbix. These
295− modules can be enabled using the <option>services.limesurvey.enable</option>,
296− <option>services.mediawiki.enable</option>, <option>services.wordpress.enable</option>,
297− and <option>services.zabbixWeb.enable</option> options.
322+ Most of the httpd subservices packaged with NixOS have been replaced with full NixOS modules including LimeSurvey, WordPress, and Zabbix. These modules can be enabled using the <option>services.limesurvey.enable</option>, <option>services.mediawiki.enable</option>, <option>services.wordpress.enable</option>, and <option>services.zabbixWeb.enable</option> options.
298323 </para>
299324 </listitem>
300325 <listitem>
301326 <para>
302− The option <option>systemd.network.networks.&lt;name&gt;.routes.*.routeConfig.GatewayOnlink</option>
303− was renamed to <option>systemd.network.networks.&lt;name&gt;.routes.*.routeConfig.GatewayOnLink</option>
304− (capital <literal>L</literal>). This follows
305− <link xlink:href="https://github.com/systemd/systemd/commit/9cb8c5593443d24c19e40bfd4fc06d672f8c554c">
306− upstreams renaming
307− </link> of the setting.
327+ The option <option>systemd.network.networks.&lt;name&gt;.routes.*.routeConfig.GatewayOnlink</option> was renamed to <option>systemd.network.networks.&lt;name&gt;.routes.*.routeConfig.GatewayOnLink</option> (capital <literal>L</literal>). This follows <link xlink:href="https://github.com/systemd/systemd/commit/9cb8c5593443d24c19e40bfd4fc06d672f8c554c"> upstreams renaming </link> of the setting.
308328 </para>
309329 </listitem>
310330 <listitem>
311331 <para>
312− As of this release the NixOps feature <literal>autoLuks</literal> is deprecated. It no longer works
313− with our systemd version without manual intervention.
332+ As of this release the NixOps feature <literal>autoLuks</literal> is deprecated. It no longer works with our systemd version without manual intervention.
314333 </para>
315334 <para>
316− Whenever the usage of the module is detected the evaluation will fail with a message
317− explaining why and how to deal with the situation.
335+ Whenever the usage of the module is detected the evaluation will fail with a message explaining why and how to deal with the situation.
318336 </para>
319337 <para>
320− A new knob named <literal>nixops.enableDeprecatedAutoLuks</literal>
321− has been introduced to disable the eval failure and to acknowledge the notice was received and read.
322− If you plan on using the feature please note that it might break with subsequent updates.
338+ A new knob named <literal>nixops.enableDeprecatedAutoLuks</literal> has been introduced to disable the eval failure and to acknowledge the notice was received and read. If you plan on using the feature please note that it might break with subsequent updates.
323339 </para>
324340 <para>
325− Make sure you set the <literal>_netdev</literal> option for each of the file systems referring to block
326− devices provided by the autoLuks module. Not doing this might render the system in a
327− state where it doesn't boot anymore.
341+ Make sure you set the <literal>_netdev</literal> option for each of the file systems referring to block devices provided by the autoLuks module. Not doing this might render the system in a state where it doesn't boot anymore.
328342 </para>
329343 <para>
330− If you are actively using the <literal>autoLuks</literal> module please let us know in
331− <link xlink:href="https://github.com/NixOS/nixpkgs/issues/62211">issue #62211</link>.
344+ If you are actively using the <literal>autoLuks</literal> module please let us know in <link xlink:href="https://github.com/NixOS/nixpkgs/issues/62211">issue #62211</link>.
332345 </para>
333346 </listitem>
334347 <listitem>
335348 <para>
336− The setopt declarations will be evaluated at the end of <literal>/etc/zshrc</literal>, so any code in <xref linkend="opt-programs.zsh.interactiveShellInit" />,
337− <xref linkend="opt-programs.zsh.loginShellInit" /> and <xref linkend="opt-programs.zsh.promptInit" /> may break if it relies on those options being set.
349+ The setopt declarations will be evaluated at the end of <literal>/etc/zshrc</literal>, so any code in <xref linkend="opt-programs.zsh.interactiveShellInit" />, <xref linkend="opt-programs.zsh.loginShellInit" /> and <xref linkend="opt-programs.zsh.promptInit" /> may break if it relies on those options being set.
338350 </para>
339351 </listitem>
340352 <listitem>
341353 <para>
342− The <literal>prometheus-nginx-exporter</literal> package now uses the offical exporter provided by NGINX Inc.
343− Its metrics are differently structured and are incompatible to the old ones. For information about the metrics,
344− have a look at the <link xlink:href="https://github.com/nginxinc/nginx-prometheus-exporter">official repo</link>.
354+ The <literal>prometheus-nginx-exporter</literal> package now uses the offical exporter provided by NGINX Inc. Its metrics are differently structured and are incompatible to the old ones. For information about the metrics, have a look at the <link xlink:href="https://github.com/nginxinc/nginx-prometheus-exporter">official repo</link>.
345355 </para>
346356 </listitem>
347357 <listitem>
348358 <para>
349− The <literal>shibboleth-sp</literal> package has been updated to version 3.
350− It is largely backward compatible, for further information refer to the
351− <link xlink:href="https://wiki.shibboleth.net/confluence/display/SP3/ReleaseNotes">release notes</link>
352− and <link xlink:href="https://wiki.shibboleth.net/confluence/display/SP3/UpgradingFromV2">upgrade guide</link>.
359+ The <literal>shibboleth-sp</literal> package has been updated to version 3. It is largely backward compatible, for further information refer to the <link xlink:href="https://wiki.shibboleth.net/confluence/display/SP3/ReleaseNotes">release notes</link> and <link xlink:href="https://wiki.shibboleth.net/confluence/display/SP3/UpgradingFromV2">upgrade guide</link>.
360+ </para>
361+ <para>
362+ Nodejs 8 is scheduled EOL under the lifetime of 19.09 and has been dropped.
353363 </para>
354− <para>
355− Nodejs 8 is scheduled EOL under the lifetime of 19.09 and has been dropped.
356− </para>
357364 </listitem>
358365 <listitem>
359− <para>
360− By default, prometheus exporters are now run with <literal>DynamicUser</literal> enabled.
361− Exporters that need a real user, now run under a seperate user and group which follow the pattern <literal>&lt;exporter-name&gt;-exporter</literal>, instead of the previous default <literal>nobody</literal> and <literal>nogroup</literal>.
362− Only some exporters are affected by the latter, namely the exporters <literal>dovecot</literal>, <literal>node</literal>, <literal>postfix</literal> and <literal>varnish</literal>.
363− </para>
366+ <para>
367+ By default, prometheus exporters are now run with <literal>DynamicUser</literal> enabled. Exporters that need a real user, now run under a seperate user and group which follow the pattern <literal>&lt;exporter-name&gt;-exporter</literal>, instead of the previous default <literal>nobody</literal> and <literal>nogroup</literal>. Only some exporters are affected by the latter, namely the exporters <literal>dovecot</literal>, <literal>node</literal>, <literal>postfix</literal> and <literal>varnish</literal>.
368+ </para>
364369 </listitem>
365370 <listitem>
366− <para>
367− The <literal>ibus-qt</literal> package is not installed by default anymore when <xref linkend="opt-i18n.inputMethod.enabled" /> is set to <literal>ibus</literal>.
368− If IBus support in Qt 4.x applications is required, add the <literal>ibus-qt</literal> package to your <xref linkend="opt-environment.systemPackages" /> manually.
369− </para>
371+ <para>
372+ The <literal>ibus-qt</literal> package is not installed by default anymore when <xref linkend="opt-i18n.inputMethod.enabled" /> is set to <literal>ibus</literal>. If IBus support in Qt 4.x applications is required, add the <literal>ibus-qt</literal> package to your <xref linkend="opt-environment.systemPackages" /> manually.
373+ </para>
370374 </listitem>
371375 <listitem>
372− <para>
373− The CUPS Printing service now uses socket-based activation by
374− default, only starting when needed. The previous behavior can
375− be restored by setting
376− <option>services.cups.startWhenNeeded</option> to
377− <literal>false</literal>.
378− </para>
376+ <para>
377+ The CUPS Printing service now uses socket-based activation by default, only starting when needed. The previous behavior can be restored by setting <option>services.cups.startWhenNeeded</option> to <literal>false</literal>.
378+ </para>
379379 </listitem>
380380 <listitem>
381− <para>
382− The <option>services.systemhealth</option> module has been removed from nixpkgs due to lack of maintainer.
383− </para>
381+ <para>
382+ The <option>services.systemhealth</option> module has been removed from nixpkgs due to lack of maintainer.
383+ </para>
384384 </listitem>
385385 <listitem>
386− <para>
387− The <option>services.mantisbt</option> module has been removed from nixpkgs due to lack of maintainer.
388− </para>
386+ <para>
387+ The <option>services.mantisbt</option> module has been removed from nixpkgs due to lack of maintainer.
388+ </para>
389389 </listitem>
390390 <listitem>
391− <para>
392− Squid 3 has been removed and the <option>squid</option> derivation now refers to Squid 4.
393− </para>
391+ <para>
392+ Squid 3 has been removed and the <option>squid</option> derivation now refers to Squid 4.
393+ </para>
394394 </listitem>
395395 <listitem>
396− <para>
397− The <option>services.pdns-recursor.extraConfig</option> option has been replaced by
398− <option>services.pdns-recursor.settings</option>. The new option allows setting extra
399− configuration while being better type-checked and mergeable.
400− </para>
396+ <para>
397+ The <option>services.pdns-recursor.extraConfig</option> option has been replaced by <option>services.pdns-recursor.settings</option>. The new option allows setting extra configuration while being better type-checked and mergeable.
398+ </para>
401399 </listitem>
402400 <listitem>
403401 <para>
404− No service depends on <literal>keys.target</literal> anymore which is a systemd
405− target that indicates if all <link xlink:href="https://nixos.org/nixops/manual/#idm140737322342384">NixOps keys</link> were successfully uploaded.
406− Instead, <literal>&lt;key-name&gt;-key.service</literal> should be used to define
407− a dependency of a key in a service. The full issue behind the <literal>keys.target</literal>
408− dependency is described at <link xlink:href="https://github.com/NixOS/nixpkgs/issues/67265">NixOS/nixpkgs#67265</link>.
402+ No service depends on <literal>keys.target</literal> anymore which is a systemd target that indicates if all <link xlink:href="https://nixos.org/nixops/manual/#idm140737322342384">NixOps keys</link> were successfully uploaded. Instead, <literal>&lt;key-name&gt;-key.service</literal> should be used to define a dependency of a key in a service. The full issue behind the <literal>keys.target</literal> dependency is described at <link xlink:href="https://github.com/NixOS/nixpkgs/issues/67265">NixOS/nixpkgs#67265</link>.
409403 </para>
410404 <para>
411405 The following services are affected by this:
412406 <itemizedlist>
413− <listitem><para><link linkend="opt-services.dovecot2.enable"><literal>services.dovecot2</literal></link></para></listitem>
414− <listitem><para><link linkend="opt-services.nsd.enable"><literal>services.nsd</literal></link></para></listitem>
415− <listitem><para><link linkend="opt-services.softether.enable"><literal>services.softether</literal></link></para></listitem>
416− <listitem><para><link linkend="opt-services.strongswan.enable"><literal>services.strongswan</literal></link></para></listitem>
417− <listitem><para><link linkend="opt-services.strongswan-swanctl.enable"><literal>services.strongswan-swanctl</literal></link></para></listitem>
418− <listitem><para><link linkend="opt-services.httpd.enable"><literal>services.httpd</literal></link></para></listitem>
407+ <listitem>
408+ <para>
409+ <link linkend="opt-services.dovecot2.enable"><literal>services.dovecot2</literal></link>
410+ </para>
411+ </listitem>
412+ <listitem>
413+ <para>
414+ <link linkend="opt-services.nsd.enable"><literal>services.nsd</literal></link>
415+ </para>
416+ </listitem>
417+ <listitem>
418+ <para>
419+ <link linkend="opt-services.softether.enable"><literal>services.softether</literal></link>
420+ </para>
421+ </listitem>
422+ <listitem>
423+ <para>
424+ <link linkend="opt-services.strongswan.enable"><literal>services.strongswan</literal></link>
425+ </para>
426+ </listitem>
427+ <listitem>
428+ <para>
429+ <link linkend="opt-services.strongswan-swanctl.enable"><literal>services.strongswan-swanctl</literal></link>
430+ </para>
431+ </listitem>
432+ <listitem>
433+ <para>
434+ <link linkend="opt-services.httpd.enable"><literal>services.httpd</literal></link>
435+ </para>
436+ </listitem>
419437 </itemizedlist>
420438 </para>
421439 </listitem>
422440 <listitem>
423− <para>
424− The <option>security.acme.directory</option> option has been replaced by a read-only <option>security.acme.certs.&lt;cert&gt;.directory</option> option for each certificate you define. This will be
425− a subdirectory of <literal>/var/lib/acme</literal>. You can use this read-only option to figure out where the certificates are stored for a specific certificate. For example,
426− the <option>services.nginx.virtualhosts.&lt;name&gt;.enableACME</option> option will use this directory option to find the certs for the virtual host.
427− </para>
428− <para>
429− <option>security.acme.preDelay</option> and <option>security.acme.activationDelay</option> options have been removed. To execute a service before certificates
430− are provisioned or renewed add a <literal>RequiredBy=acme-${cert}.service</literal> to any service.
431− </para>
432− <para>
433− Furthermore, the acme module will not automatically add a dependency on <literal>lighttpd.service</literal> anymore. If you are using certficates provided by letsencrypt
434− for lighttpd, then you should depend on the certificate service <literal>acme-${cert}.service></literal> manually.
435− </para>
436− <para>
437− For nginx, the dependencies are still automatically managed when <option>services.nginx.virtualhosts.&lt;name&gt;.enableACME</option> is enabled just like before. What changed is that nginx now directly depends on the specific certificates that it needs,
438− instead of depending on the catch-all <literal>acme-certificates.target</literal>. This target unit was also removed from the codebase.
439− This will mean nginx will no longer depend on certificates it isn't explicitly managing and fixes a bug with certificate renewal
440− ordering racing with nginx restarting which could lead to nginx getting in a broken state as described at
441− <link xlink:href="https://github.com/NixOS/nixpkgs/issues/60180">NixOS/nixpkgs#60180</link>.
442− </para>
441+ <para>
442+ The <option>security.acme.directory</option> option has been replaced by a read-only <option>security.acme.certs.&lt;cert&gt;.directory</option> option for each certificate you define. This will be a subdirectory of <literal>/var/lib/acme</literal>. You can use this read-only option to figure out where the certificates are stored for a specific certificate. For example, the <option>services.nginx.virtualhosts.&lt;name&gt;.enableACME</option> option will use this directory option to find the certs for the virtual host.
443+ </para>
444+ <para>
445+ <option>security.acme.preDelay</option> and <option>security.acme.activationDelay</option> options have been removed. To execute a service before certificates are provisioned or renewed add a <literal>RequiredBy=acme-${cert}.service</literal> to any service.
446+ </para>
447+ <para>
448+ Furthermore, the acme module will not automatically add a dependency on <literal>lighttpd.service</literal> anymore. If you are using certficates provided by letsencrypt for lighttpd, then you should depend on the certificate service <literal>acme-${cert}.service></literal> manually.
449+ </para>
450+ <para>
451+ For nginx, the dependencies are still automatically managed when <option>services.nginx.virtualhosts.&lt;name&gt;.enableACME</option> is enabled just like before. What changed is that nginx now directly depends on the specific certificates that it needs, instead of depending on the catch-all <literal>acme-certificates.target</literal>. This target unit was also removed from the codebase. This will mean nginx will no longer depend on certificates it isn't explicitly managing and fixes a bug with certificate renewal ordering racing with nginx restarting which could lead to nginx getting in a broken state as described at <link xlink:href="https://github.com/NixOS/nixpkgs/issues/60180">NixOS/nixpkgs#60180</link>.
452+ </para>
443453 </listitem>
444454 <listitem>
445− <para>
446− The old deprecated <literal>emacs</literal> package sets have been dropped.
447− What used to be called <literal>emacsPackagesNg</literal> is now simply called <literal>emacsPackages</literal>.
448− </para>
455+ <para>
456+ The old deprecated <literal>emacs</literal> package sets have been dropped. What used to be called <literal>emacsPackagesNg</literal> is now simply called <literal>emacsPackages</literal>.
457+ </para>
449458 </listitem>
450459 <listitem>
451− <para>
452− <option>services.xserver.desktopManager.xterm</option> is now disabled by default if <literal>stateVersion</literal> is 19.09 or higher.
453− Previously the xterm desktopManager was enabled when xserver was enabled, but it isn't useful for all people so it didn't make sense to
454− have any desktopManager enabled default.
455− </para>
460+ <para>
461+ <option>services.xserver.desktopManager.xterm</option> is now disabled by default if <literal>stateVersion</literal> is 19.09 or higher. Previously the xterm desktopManager was enabled when xserver was enabled, but it isn't useful for all people so it didn't make sense to have any desktopManager enabled default.
462+ </para>
456463 </listitem>
457464 <listitem>
458465 <para>
459− The WeeChat plugin <literal>pkgs.weechatScripts.weechat-xmpp</literal> has been removed as it doesn't receive
460− any updates from upstream and depends on outdated Python2-based modules.
466+ The WeeChat plugin <literal>pkgs.weechatScripts.weechat-xmpp</literal> has been removed as it doesn't receive any updates from upstream and depends on outdated Python2-based modules.
461467 </para>
462468 </listitem>
463469 <listitem>
464470 <para>
465− Old unsupported versions (<literal>logstash5</literal>,
466− <literal>kibana5</literal>,
467− <literal>filebeat5</literal>,
468− <literal>heartbeat5</literal>,
469− <literal>metricbeat5</literal>,
470− <literal>packetbeat5</literal>) of the ELK-stack and Elastic beats have been removed.
471+ Old unsupported versions (<literal>logstash5</literal>, <literal>kibana5</literal>, <literal>filebeat5</literal>, <literal>heartbeat5</literal>, <literal>metricbeat5</literal>, <literal>packetbeat5</literal>) of the ELK-stack and Elastic beats have been removed.
471472 </para>
472473 </listitem>
473474 <listitem>
474475 <para>
475− For NixOS 19.03, both Prometheus 1 and 2 were available to allow for
476− a seamless transition from version 1 to 2 with existing setups.
477− Because Prometheus 1 is no longer developed, it was removed.
478− Prometheus 2 is now configured with <literal>services.prometheus</literal>.
476+ For NixOS 19.03, both Prometheus 1 and 2 were available to allow for a seamless transition from version 1 to 2 with existing setups. Because Prometheus 1 is no longer developed, it was removed. Prometheus 2 is now configured with <literal>services.prometheus</literal>.
479477 </para>
480478 </listitem>
481479 <listitem>
482− <para>
483− Citrix Receiver (<literal>citrix_receiver</literal>) has been dropped in favor of Citrix Workspace
484− (<literal>citrix_workspace</literal>).
485− </para>
480+ <para>
481+ Citrix Receiver (<literal>citrix_receiver</literal>) has been dropped in favor of Citrix Workspace (<literal>citrix_workspace</literal>).
482+ </para>
486483 </listitem>
487484 </itemizedlist>
488485 </section>
@@ -497,122 +494,74 @@
497494 <itemizedlist>
498495 <listitem>
499496 <para>
500− The <option>documentation</option> module gained an option named
501− <option>documentation.nixos.includeAllModules</option> which makes the
502− generated <citerefentry>
497+ The <option>documentation</option> module gained an option named <option>documentation.nixos.includeAllModules</option> which makes the generated <citerefentry>
503498 <refentrytitle>configuration.nix</refentrytitle>
504− <manvolnum>5</manvolnum></citerefentry> manual page include all options
505− from all NixOS modules included in a given
506− <literal>configuration.nix</literal> configuration file. Currently, it is
507− set to <literal>false</literal> by default as enabling it frequently
508− prevents evaluation. But the plan is to eventually have it set to
509− <literal>true</literal> by default. Please set it to
510− <literal>true</literal> now in your <literal>configuration.nix</literal>
511− and fix all the bugs it uncovers.
499+ <manvolnum>5</manvolnum></citerefentry> manual page include all options from all NixOS modules included in a given <literal>configuration.nix</literal> configuration file. Currently, it is set to <literal>false</literal> by default as enabling it frequently prevents evaluation. But the plan is to eventually have it set to <literal>true</literal> by default. Please set it to <literal>true</literal> now in your <literal>configuration.nix</literal> and fix all the bugs it uncovers.
512500 </para>
513501 </listitem>
514502 <listitem>
515503 <para>
516− The <literal>vlc</literal> package gained support for Chromecast
517− streaming, enabled by default. TCP port 8010 must be open for it to work,
518− so something like <literal>networking.firewall.allowedTCPPorts = [ 8010
519− ];</literal> may be required in your configuration. Also consider enabling
520− <link xlink:href="https://nixos.wiki/wiki/Accelerated_Video_Playback">
521− Accelerated Video Playback</link> for better transcoding performance.
504+ The <literal>vlc</literal> package gained support for Chromecast streaming, enabled by default. TCP port 8010 must be open for it to work, so something like <literal>networking.firewall.allowedTCPPorts = [ 8010 ];</literal> may be required in your configuration. Also consider enabling <link xlink:href="https://nixos.wiki/wiki/Accelerated_Video_Playback"> Accelerated Video Playback</link> for better transcoding performance.
522505 </para>
523506 </listitem>
524507 <listitem>
525508 <para>
526− The following changes apply if the <literal>stateVersion</literal> is
527− changed to 19.09 or higher. For <literal>stateVersion = "19.03"</literal>
528− or lower the old behavior is preserved.
509+ The following changes apply if the <literal>stateVersion</literal> is changed to 19.09 or higher. For <literal>stateVersion = "19.03"</literal> or lower the old behavior is preserved.
529510 </para>
530511 <itemizedlist>
531512 <listitem>
532513 <para>
533− <literal>solr.package</literal> defaults to
534− <literal>pkgs.solr_8</literal>.
514+ <literal>solr.package</literal> defaults to <literal>pkgs.solr_8</literal>.
535515 </para>
536516 </listitem>
537517 </itemizedlist>
538518 </listitem>
539519 <listitem>
540520 <para>
541− The <literal>hunspellDicts.fr-any</literal> dictionary now ships with <literal>fr_FR.{aff,dic}</literal>
542− which is linked to <literal>fr-toutesvariantes.{aff,dic}</literal>.
521+ The <literal>hunspellDicts.fr-any</literal> dictionary now ships with <literal>fr_FR.{aff,dic}</literal> which is linked to <literal>fr-toutesvariantes.{aff,dic}</literal>.
543522 </para>
544523 </listitem>
545524 <listitem>
546525 <para>
547− The <literal>mysql</literal> service now runs as <literal>mysql</literal>
548− user. Previously, systemd did execute it as root, and mysql dropped privileges
549− itself.
550− This includes <literal>ExecStartPre=</literal> and
551− <literal>ExecStartPost=</literal> phases.
552− To accomplish that, runtime and data directory setup was delegated to
553− RuntimeDirectory and tmpfiles.
526+ The <literal>mysql</literal> service now runs as <literal>mysql</literal> user. Previously, systemd did execute it as root, and mysql dropped privileges itself. This includes <literal>ExecStartPre=</literal> and <literal>ExecStartPost=</literal> phases. To accomplish that, runtime and data directory setup was delegated to RuntimeDirectory and tmpfiles.
554527 </para>
555528 </listitem>
556529 <listitem>
557530 <para>
558− With the upgrade to systemd version 242 the <literal>systemd-timesyncd</literal>
559− service is no longer using <literal>DynamicUser=yes</literal>. In order for the
560− upgrade to work we rely on an activation script to move the state from the old
561− to the new directory. The older directory (prior <literal>19.09</literal>) was
562− <literal>/var/lib/private/systemd/timesync</literal>.
531+ With the upgrade to systemd version 242 the <literal>systemd-timesyncd</literal> service is no longer using <literal>DynamicUser=yes</literal>. In order for the upgrade to work we rely on an activation script to move the state from the old to the new directory. The older directory (prior <literal>19.09</literal>) was <literal>/var/lib/private/systemd/timesync</literal>.
563532 </para>
564533 <para>
565− As long as the <literal>system.config.stateVersion</literal> is below
566− <literal>19.09</literal> the state folder will migrated to its proper location
567− (<literal>/var/lib/systemd/timesync</literal>), if required.
534+ As long as the <literal>system.config.stateVersion</literal> is below <literal>19.09</literal> the state folder will migrated to its proper location (<literal>/var/lib/systemd/timesync</literal>), if required.
568535 </para>
569536 </listitem>
570537 <listitem>
571538 <para>
572− The package <literal>avahi</literal> is now built to look up service
573− definitions from <literal>/etc/avahi/services</literal> instead of its
574− output directory in the nix store. Accordingly the module
575− <option>avahi</option> now supports custom service definitions via
576− <option>services.avahi.extraServiceFiles</option>, which are then placed
577− in the aforementioned directory. See <citerefentry>
578− <refentrytitle>avahi.service</refentrytitle><manvolnum>5</manvolnum>
579− </citerefentry> for more information on custom service definitions.
539+ The package <literal>avahi</literal> is now built to look up service definitions from <literal>/etc/avahi/services</literal> instead of its output directory in the nix store. Accordingly the module <option>avahi</option> now supports custom service definitions via <option>services.avahi.extraServiceFiles</option>, which are then placed in the aforementioned directory. See <citerefentry>
540+ <refentrytitle>avahi.service</refentrytitle>
541+ <manvolnum>5</manvolnum> </citerefentry> for more information on custom service definitions.
580542 </para>
581543 </listitem>
582544 <listitem>
583545 <para>
584− Since version 0.1.19, <literal>cargo-vendor</literal> honors package
585− includes that are specified in the <filename>Cargo.toml</filename>
586− file of Rust crates. <literal>rustPlatform.buildRustPackage</literal> uses
587− <literal>cargo-vendor</literal> to collect and build dependent crates.
588− Since this change in <literal>cargo-vendor</literal> changes the set of
589− vendored files for most Rust packages, the hash that use used to verify
590− the dependencies, <literal>cargoSha256</literal>, also changes.
546+ Since version 0.1.19, <literal>cargo-vendor</literal> honors package includes that are specified in the <filename>Cargo.toml</filename> file of Rust crates. <literal>rustPlatform.buildRustPackage</literal> uses <literal>cargo-vendor</literal> to collect and build dependent crates. Since this change in <literal>cargo-vendor</literal> changes the set of vendored files for most Rust packages, the hash that use used to verify the dependencies, <literal>cargoSha256</literal>, also changes.
591547 </para>
592548 <para>
593− The <literal>cargoSha256</literal> hashes of all in-tree derivations that
594− use <literal>buildRustPackage</literal> have been updated to reflect this
595− change. However, third-party derivations that use
596− <literal>buildRustPackage</literal> may have to be updated as well.
549+ The <literal>cargoSha256</literal> hashes of all in-tree derivations that use <literal>buildRustPackage</literal> have been updated to reflect this change. However, third-party derivations that use <literal>buildRustPackage</literal> may have to be updated as well.
597550 </para>
598551 </listitem>
599552 <listitem>
600553 <para>
601− The <literal>consul</literal> package was upgraded past version <literal>1.5</literal>,
602− so its deprecated legacy UI is no longer available.
554+ The <literal>consul</literal> package was upgraded past version <literal>1.5</literal>, so its deprecated legacy UI is no longer available.
603555 </para>
604556 </listitem>
605557 <listitem>
606558 <para>
607− The default resample-method for PulseAudio has been changed from the upstream default <literal>speex-float-1</literal>
608− to <literal>speex-float-5</literal>. Be aware that low-powered ARM-based and MIPS-based boards will struggle with this
609− so you'll need to set <option>hardware.pulseaudio.daemon.config.resample-method</option> back to <literal>speex-float-1</literal>.
559+ The default resample-method for PulseAudio has been changed from the upstream default <literal>speex-float-1</literal> to <literal>speex-float-5</literal>. Be aware that low-powered ARM-based and MIPS-based boards will struggle with this so you'll need to set <option>hardware.pulseaudio.daemon.config.resample-method</option> back to <literal>speex-float-1</literal>.
610560 </para>
611561 </listitem>
612562 <listitem>
613563 <para>
614− The <literal>phabricator</literal> package and associated <literal>httpd.extraSubservice</literal>, as well as the
615− <literal>phd</literal> service have been removed from nixpkgs due to lack of maintainer.
564+ The <literal>phabricator</literal> package and associated <literal>httpd.extraSubservice</literal>, as well as the <literal>phd</literal> service have been removed from nixpkgs due to lack of maintainer.
616565 </para>
617566 </listitem>
618567 <listitem>
@@ -627,8 +576,7 @@
627576 </listitem>
628577 <listitem>
629578 <para>
630− The <literal>foswiki</literal> package and associated <literal>httpd.extraSubservice</literal> have been removed
631− from nixpkgs due to lack of maintainer.
579+ The <literal>foswiki</literal> package and associated <literal>httpd.extraSubservice</literal> have been removed from nixpkgs due to lack of maintainer.
632580 </para>
633581 </listitem>
634582 <listitem>
@@ -638,155 +586,126 @@
638586 </listitem>
639587 <listitem>
640588 <para>
641− It's now possible to change configuration in
642− <link linkend="opt-services.nextcloud.enable">services.nextcloud</link> after the initial deploy
643− since all config parameters are persisted in an additional config file generated by the module.
644− Previously core configuration like database parameters were set using their imperative
645− installer after creating <literal>/var/lib/nextcloud</literal>.
589+ It's now possible to change configuration in <link linkend="opt-services.nextcloud.enable">services.nextcloud</link> after the initial deploy since all config parameters are persisted in an additional config file generated by the module. Previously core configuration like database parameters were set using their imperative installer after creating <literal>/var/lib/nextcloud</literal>.
646590 </para>
647591 </listitem>
648592 <listitem>
649593 <para>
650− There exists now <literal>lib.forEach</literal>, which is like <literal>map</literal>, but with
651− arguments flipped. When mapping function body spans many lines (or has nested
652− <literal>map</literal>s), it is often hard to follow which list is modified.
594+ There exists now <literal>lib.forEach</literal>, which is like <literal>map</literal>, but with arguments flipped. When mapping function body spans many lines (or has nested <literal>map</literal>s), it is often hard to follow which list is modified.
653595 </para>
654596 <para>
655− Previous solution to this problem was either to use <literal>lib.flip map</literal>
656− idiom or extract that anonymous mapping function to a named one. Both can still be used
657− but <literal>lib.forEach</literal> is preferred over <literal>lib.flip map</literal>.
597+ Previous solution to this problem was either to use <literal>lib.flip map</literal> idiom or extract that anonymous mapping function to a named one. Both can still be used but <literal>lib.forEach</literal> is preferred over <literal>lib.flip map</literal>.
658598 </para>
659599 <para>
660− The <literal>/etc/sysctl.d/nixos.conf</literal> file containing all the options set via
661− <link linkend="opt-boot.kernel.sysctl">boot.kernel.sysctl</link> was moved to
662− <literal>/etc/sysctl.d/60-nixos.conf</literal>, as
663− <citerefentry><refentrytitle>sysctl.d</refentrytitle><manvolnum>5</manvolnum></citerefentry>
664− recommends prefixing all filenames in <literal>/etc/sysctl.d</literal> with a
665− two-digit number and a dash to simplify the ordering of the files.
600+ The <literal>/etc/sysctl.d/nixos.conf</literal> file containing all the options set via <link linkend="opt-boot.kernel.sysctl">boot.kernel.sysctl</link> was moved to <literal>/etc/sysctl.d/60-nixos.conf</literal>, as <citerefentry>
601+ <refentrytitle>sysctl.d</refentrytitle>
602+ <manvolnum>5</manvolnum></citerefentry> recommends prefixing all filenames in <literal>/etc/sysctl.d</literal> with a two-digit number and a dash to simplify the ordering of the files.
666603 </para>
667604 </listitem>
668605 <listitem>
669606 <para>
670− We now install the sysctl snippets shipped with systemd.
671− <itemizedlist>
672− <para>This enables:</para>
673− <listitem>
674− <para>Loose reverse path filtering</para>
675− </listitem>
676− <listitem>
677− <para>Source route filtering</para>
678− </listitem>
679− <listitem>
607+ We now install the sysctl snippets shipped with systemd.
608+ <itemizedlist>
680609 <para>
681− <literal>fq_codel</literal> as a packet scheduler (this helps to fight bufferbloat)
610+ This enables:
682611 </para>
683− </listitem>
684− </itemizedlist>
685− This also configures the kernel to pass coredumps to <literal>systemd-coredump</literal>,
686− and restricts the SysRq key combinations to the sync command only.
687− These sysctl snippets can be found in <literal>/etc/sysctl.d/50-*.conf</literal>,
688− and overridden via <link linkend="opt-boot.kernel.sysctl">boot.kernel.sysctl</link>
689− (which will place the parameters in <literal>/etc/sysctl.d/60-nixos.conf</literal>).
690− </para>
612+ <listitem>
613+ <para>
614+ Loose reverse path filtering
615+ </para>
616+ </listitem>
617+ <listitem>
618+ <para>
619+ Source route filtering
620+ </para>
621+ </listitem>
622+ <listitem>
623+ <para>
624+ <literal>fq_codel</literal> as a packet scheduler (this helps to fight bufferbloat)
625+ </para>
626+ </listitem>
627+ </itemizedlist>
628+ This also configures the kernel to pass coredumps to <literal>systemd-coredump</literal>, and restricts the SysRq key combinations to the sync command only. These sysctl snippets can be found in <literal>/etc/sysctl.d/50-*.conf</literal>, and overridden via <link linkend="opt-boot.kernel.sysctl">boot.kernel.sysctl</link> (which will place the parameters in <literal>/etc/sysctl.d/60-nixos.conf</literal>).
629+ </para>
691630 </listitem>
692631 <listitem>
693632 <para>
694− Coredumps are now acquired by <literal>systemd-coredump</literal> by default.
695− <literal>systemd-coredump</literal> behaviour can still be modified via
696− <option>systemd.coredump.extraConfig</option>.
697− To stick to the old behaviour (having the kernel dump to a file called <literal>core</literal>
698− in the working directory), without piping it through <literal>systemd-coredump</literal>, set
699− <option>boot.kernel.sysctl."kernel.core_pattern"</option> to <literal>"core"</literal>.
633+ Coredumps are now acquired by <literal>systemd-coredump</literal> by default. <literal>systemd-coredump</literal> behaviour can still be modified via <option>systemd.coredump.extraConfig</option>. To stick to the old behaviour (having the kernel dump to a file called <literal>core</literal> in the working directory), without piping it through <literal>systemd-coredump</literal>, set <option>boot.kernel.sysctl."kernel.core_pattern"</option> to <literal>"core"</literal>.
700634 </para>
701635 </listitem>
702636 <listitem>
703637 <para>
704− <literal>systemd.packages</literal> option now also supports generators and
705− shutdown scripts. Old <literal>systemd.generator-packages</literal> option has
706− been removed.
638+ <literal>systemd.packages</literal> option now also supports generators and shutdown scripts. Old <literal>systemd.generator-packages</literal> option has been removed.
707639 </para>
708640 </listitem>
709641 <listitem>
710642 <para>
711− The <literal>rmilter</literal> package was removed with associated module and options due deprecation by upstream developer.
712− Use <literal>rspamd</literal> in proxy mode instead.
643+ The <literal>rmilter</literal> package was removed with associated module and options due deprecation by upstream developer. Use <literal>rspamd</literal> in proxy mode instead.
713644 </para>
714645 </listitem>
715646 <listitem>
716647 <para>
717− systemd cgroup accounting via the
718− <link linkend="opt-systemd.enableCgroupAccounting">systemd.enableCgroupAccounting</link>
719− option is now enabled by default. It now also enables the more recent Block IO and IP accounting
720− features.
648+ systemd cgroup accounting via the <link linkend="opt-systemd.enableCgroupAccounting">systemd.enableCgroupAccounting</link> option is now enabled by default. It now also enables the more recent Block IO and IP accounting features.
721649 </para>
722650 </listitem>
723651 <listitem>
724652 <para>
725− We no longer enable custom font rendering settings with <option>fonts.fontconfig.penultimate.enable</option> by default.
726− The defaults from fontconfig are sufficient.
653+ We no longer enable custom font rendering settings with <option>fonts.fontconfig.penultimate.enable</option> by default. The defaults from fontconfig are sufficient.
727654 </para>
728655 </listitem>
729656 <listitem>
730657 <para>
731− The <literal>crashplan</literal> package and the
732− <literal>crashplan</literal> service have been removed from nixpkgs due to
733− crashplan shutting down the service, while the <literal>crashplansb</literal>
734− package and <literal>crashplan-small-business</literal> service have been
735− removed from nixpkgs due to lack of maintainer.
658+ The <literal>crashplan</literal> package and the <literal>crashplan</literal> service have been removed from nixpkgs due to crashplan shutting down the service, while the <literal>crashplansb</literal> package and <literal>crashplan-small-business</literal> service have been removed from nixpkgs due to lack of maintainer.
736659 </para>
737660 <para>
738− The <link linkend="opt-services.redis.enable">redis module</link> was hardcoded to use the <literal>redis</literal> user,
739− <filename class="directory">/run/redis</filename> as runtime directory and
740− <filename class="directory">/var/lib/redis</filename> as state directory.
741− Note that the NixOS module for Redis now disables kernel support for Transparent Huge Pages (THP),
742− because this features causes major performance problems for Redis,
743− e.g. (https://redis.io/topics/latency).
661+ The <link linkend="opt-services.redis.enable">redis module</link> was hardcoded to use the <literal>redis</literal> user, <filename class="directory">/run/redis</filename> as runtime directory and <filename class="directory">/var/lib/redis</filename> as state directory. Note that the NixOS module for Redis now disables kernel support for Transparent Huge Pages (THP), because this features causes major performance problems for Redis, e.g. (https://redis.io/topics/latency).
744662 </para>
745663 </listitem>
746664 <listitem>
747665 <para>
748666 Using <option>fonts.enableDefaultFonts</option> adds a default emoji font <literal>noto-fonts-emoji</literal>.
749667 <itemizedlist>
750− <para>Users of the following options will have this enabled by default:</para>
668+ <para>
669+ Users of the following options will have this enabled by default:
670+ </para>
751671 <listitem>
752− <para><option>services.xserver.enable</option></para>
672+ <para>
673+ <option>services.xserver.enable</option>
674+ </para>
753675 </listitem>
754676 <listitem>
755− <para><option>programs.sway.enable</option></para>
677+ <para>
678+ <option>programs.sway.enable</option>
679+ </para>
756680 </listitem>
757681 <listitem>
758− <para><option>programs.way-cooler.enable</option></para>
682+ <para>
683+ <option>programs.way-cooler.enable</option>
684+ </para>
759685 </listitem>
760686 <listitem>
761− <para><option>services.xrdp.enable</option></para>
687+ <para>
688+ <option>services.xrdp.enable</option>
689+ </para>
762690 </listitem>
763691 </itemizedlist>
764692 </para>
765693 </listitem>
766694 <listitem>
767− <para>
768− The <literal>altcoins</literal> categorization of packages has
769− been removed. You now access these packages at the top level,
770− ie. <literal>nix-shell -p dogecoin</literal> instead of
771− <literal>nix-shell -p altcoins.dogecoin</literal>, etc.
772− </para>
695+ <para>
696+ The <literal>altcoins</literal> categorization of packages has been removed. You now access these packages at the top level, ie. <literal>nix-shell -p dogecoin</literal> instead of <literal>nix-shell -p altcoins.dogecoin</literal>, etc.
697+ </para>
773698 </listitem>
774699 <listitem>
775− <para>
776− Ceph has been upgraded to v14.2.1.
777− See the <link xlink:href="https://ceph.com/releases/v14-2-0-nautilus-released/">release notes</link> for details.
778− The mgr dashboard as well as osds backed by loop-devices is no longer explicitly supported by the package and module.
779− Note: There's been some issues with python-cherrypy, which is used by the dashboard
780− and prometheus mgr modules (and possibly others), hence 0000-dont-check-cherrypy-version.patch.
781− </para>
782− </listitem>
783− <listitem>
784− <para>
785− <literal>pkgs.weechat</literal> is now compiled against <literal>pkgs.python3</literal>.
786− Weechat also recommends <link xlink:href="https://weechat.org/scripts/python3/">to use Python3
787− in their docs.</link>
788− </para>
789− </listitem>
700+ <para>
701+ Ceph has been upgraded to v14.2.1. See the <link xlink:href="https://ceph.com/releases/v14-2-0-nautilus-released/">release notes</link> for details. The mgr dashboard as well as osds backed by loop-devices is no longer explicitly supported by the package and module. Note: There's been some issues with python-cherrypy, which is used by the dashboard and prometheus mgr modules (and possibly others), hence 0000-dont-check-cherrypy-version.patch.
702+ </para>
703+ </listitem>
704+ <listitem>
705+ <para>
706+ <literal>pkgs.weechat</literal> is now compiled against <literal>pkgs.python3</literal>. Weechat also recommends <link xlink:href="https://weechat.org/scripts/python3/">to use Python3 in their docs.</link>
707+ </para>
708+ </listitem>
790709 </itemizedlist>
791710 </section>
792711</section>
nixos/doc/manual/release-notes/rl-2003.xml+2−5
@@ -13,8 +13,7 @@
1313 <title>Highlights</title>
1414
1515 <para>
16− In addition to numerous new and upgraded packages, this release has the
17− following highlights:
16+ In addition to numerous new and upgraded packages, this release has the following highlights:
1817 </para>
1918
2019 <itemizedlist>
@@ -42,7 +41,6 @@
4241 <para />
4342 </listitem>
4443 </itemizedlist>
45−
4644 </section>
4745
4846 <section xmlns="http://docbook.org/ns/docbook"
@@ -53,8 +51,7 @@
5351 <title>Backward Incompatibilities</title>
5452
5553 <para>
56− When upgrading from a previous release, please be aware of the following
57− incompatible changes:
54+ When upgrading from a previous release, please be aware of the following incompatible changes:
5855 </para>
5956
6057 <itemizedlist>
nixos/modules/i18n/input-method/default.xml+20−54
@@ -5,11 +5,7 @@
55 xml:id="module-services-input-methods">
66 <title>Input Methods</title>
77 <para>
8− Input methods are an operating system component that allows any data, such as
9− keyboard strokes or mouse movements, to be received as input. In this way
10− users can enter characters and symbols not found on their input devices.
11− Using an input method is obligatory for any language that has more graphemes
12− than there are keys on the keyboard.
8+ Input methods are an operating system component that allows any data, such as keyboard strokes or mouse movements, to be received as input. In this way users can enter characters and symbols not found on their input devices. Using an input method is obligatory for any language that has more graphemes than there are keys on the keyboard.
139 </para>
1410 <para>
1511 The following input methods are available in NixOS:
@@ -40,8 +36,7 @@
4036 <title>IBus</title>
4137
4238 <para>
43− IBus is an Intelligent Input Bus. It provides full featured and user
44− friendly input method user interface.
39+ IBus is an Intelligent Input Bus. It provides full featured and user friendly input method user interface.
4540 </para>
4641
4742 <para>
@@ -56,8 +51,7 @@ i18n.inputMethod = {
5651</programlisting>
5752
5853 <para>
59− <literal>i18n.inputMethod.ibus.engines</literal> is optional and can be used
60− to add extra IBus engines.
54+ <literal>i18n.inputMethod.ibus.engines</literal> is optional and can be used to add extra IBus engines.
6155 </para>
6256
6357 <para>
@@ -67,8 +61,7 @@ i18n.inputMethod = {
6761 <itemizedlist>
6862 <listitem>
6963 <para>
70− Anthy (<literal>ibus-engines.anthy</literal>): Anthy is a system for
71− Japanese input method. It converts Hiragana text to Kana Kanji mixed text.
64+ Anthy (<literal>ibus-engines.anthy</literal>): Anthy is a system for Japanese input method. It converts Hiragana text to Kana Kanji mixed text.
7265 </para>
7366 </listitem>
7467 <listitem>
@@ -78,28 +71,22 @@ i18n.inputMethod = {
7871 </listitem>
7972 <listitem>
8073 <para>
81− m17n (<literal>ibus-engines.m17n</literal>): m17n is an input method that
82− uses input methods and corresponding icons in the m17n database.
74+ m17n (<literal>ibus-engines.m17n</literal>): m17n is an input method that uses input methods and corresponding icons in the m17n database.
8375 </para>
8476 </listitem>
8577 <listitem>
8678 <para>
87− mozc (<literal>ibus-engines.mozc</literal>): A Japanese input method from
88− Google.
79+ mozc (<literal>ibus-engines.mozc</literal>): A Japanese input method from Google.
8980 </para>
9081 </listitem>
9182 <listitem>
9283 <para>
93− Table (<literal>ibus-engines.table</literal>): An input method that load
94− tables of input methods.
84+ Table (<literal>ibus-engines.table</literal>): An input method that load tables of input methods.
9585 </para>
9686 </listitem>
9787 <listitem>
9888 <para>
99− table-others (<literal>ibus-engines.table-others</literal>): Various
100− table-based input methods. To use this, and any other table-based input
101− methods, it must appear in the list of engines along with
102− <literal>table</literal>. For example:
89+ table-others (<literal>ibus-engines.table-others</literal>): Various table-based input methods. To use this, and any other table-based input methods, it must appear in the list of engines along with <literal>table</literal>. For example:
10390<programlisting>
10491ibus.engines = with pkgs.ibus-engines; [ table table-others ];
10592</programlisting>
@@ -108,22 +95,13 @@ ibus.engines = with pkgs.ibus-engines; [ table table-others ];
10895 </itemizedlist>
10996
11097 <para>
111− To use any input method, the package must be added in the configuration, as
112− shown above, and also (after running <literal>nixos-rebuild</literal>) the
113− input method must be added from IBus' preference dialog.
98+ To use any input method, the package must be added in the configuration, as shown above, and also (after running <literal>nixos-rebuild</literal>) the input method must be added from IBus' preference dialog.
11499 </para>
115100
116101 <simplesect xml:id="module-services-input-methods-troubleshooting">
117102 <title>Troubleshooting</title>
118103 <para>
119− If IBus works in some applications but not others, a likely cause of this
120− is that IBus is depending on a different version of <literal>glib</literal>
121− to what the applications are depending on. This can be checked by running
122− <literal>nix-store -q --requisites &lt;path&gt; | grep glib</literal>,
123− where <literal>&lt;path&gt;</literal> is the path of either IBus or an
124− application in the Nix store. The <literal>glib</literal> packages must
125− match exactly. If they do not, uninstalling and reinstalling the
126− application is a likely fix.
104+ If IBus works in some applications but not others, a likely cause of this is that IBus is depending on a different version of <literal>glib</literal> to what the applications are depending on. This can be checked by running <literal>nix-store -q --requisites &lt;path&gt; | grep glib</literal>, where <literal>&lt;path&gt;</literal> is the path of either IBus or an application in the Nix store. The <literal>glib</literal> packages must match exactly. If they do not, uninstalling and reinstalling the application is a likely fix.
127105 </para>
128106 </simplesect>
129107 </section>
@@ -131,8 +109,7 @@ ibus.engines = with pkgs.ibus-engines; [ table table-others ];
131109 <title>Fcitx</title>
132110
133111 <para>
134− Fcitx is an input method framework with extension support. It has three
135− built-in Input Method Engine, Pinyin, QuWei and Table-based input methods.
112+ Fcitx is an input method framework with extension support. It has three built-in Input Method Engine, Pinyin, QuWei and Table-based input methods.
136113 </para>
137114
138115 <para>
@@ -147,8 +124,7 @@ i18n.inputMethod = {
147124</programlisting>
148125
149126 <para>
150− <literal>i18n.inputMethod.fcitx.engines</literal> is optional and can be
151− used to add extra Fcitx engines.
127+ <literal>i18n.inputMethod.fcitx.engines</literal> is optional and can be used to add extra Fcitx engines.
152128 </para>
153129
154130 <para>
@@ -158,15 +134,12 @@ i18n.inputMethod = {
158134 <itemizedlist>
159135 <listitem>
160136 <para>
161− Anthy (<literal>fcitx-engines.anthy</literal>): Anthy is a system for
162− Japanese input method. It converts Hiragana text to Kana Kanji mixed text.
137+ Anthy (<literal>fcitx-engines.anthy</literal>): Anthy is a system for Japanese input method. It converts Hiragana text to Kana Kanji mixed text.
163138 </para>
164139 </listitem>
165140 <listitem>
166141 <para>
167− Chewing (<literal>fcitx-engines.chewing</literal>): Chewing is an
168− intelligent Zhuyin input method. It is one of the most popular input
169− methods among Traditional Chinese Unix users.
142+ Chewing (<literal>fcitx-engines.chewing</literal>): Chewing is an intelligent Zhuyin input method. It is one of the most popular input methods among Traditional Chinese Unix users.
170143 </para>
171144 </listitem>
172145 <listitem>
@@ -181,20 +154,17 @@ i18n.inputMethod = {
181154 </listitem>
182155 <listitem>
183156 <para>
184− m17n (<literal>fcitx-engines.m17n</literal>): m17n is an input method that
185− uses input methods and corresponding icons in the m17n database.
157+ m17n (<literal>fcitx-engines.m17n</literal>): m17n is an input method that uses input methods and corresponding icons in the m17n database.
186158 </para>
187159 </listitem>
188160 <listitem>
189161 <para>
190− mozc (<literal>fcitx-engines.mozc</literal>): A Japanese input method from
191− Google.
162+ mozc (<literal>fcitx-engines.mozc</literal>): A Japanese input method from Google.
192163 </para>
193164 </listitem>
194165 <listitem>
195166 <para>
196− table-others (<literal>fcitx-engines.table-others</literal>): Various
197− table-based input methods.
167+ table-others (<literal>fcitx-engines.table-others</literal>): Various table-based input methods.
198168 </para>
199169 </listitem>
200170 </itemizedlist>
@@ -203,9 +173,7 @@ i18n.inputMethod = {
203173 <title>Nabi</title>
204174
205175 <para>
206− Nabi is an easy to use Korean X input method. It allows you to enter
207− phonetic Korean characters (hangul) and pictographic Korean characters
208− (hanja).
176+ Nabi is an easy to use Korean X input method. It allows you to enter phonetic Korean characters (hangul) and pictographic Korean characters (hanja).
209177 </para>
210178
211179 <para>
@@ -222,8 +190,7 @@ i18n.inputMethod = {
222190 <title>Uim</title>
223191
224192 <para>
225− Uim (short for "universal input method") is a multilingual input method
226− framework. Applications can use it through so-called bridges.
193+ Uim (short for "universal input method") is a multilingual input method framework. Applications can use it through so-called bridges.
227194 </para>
228195
229196 <para>
@@ -237,8 +204,7 @@ i18n.inputMethod = {
237204</programlisting>
238205
239206 <para>
240− Note: The <xref linkend="opt-i18n.inputMethod.uim.toolbar"/> option can be
241− used to choose uim toolbar.
207+ Note: The <xref linkend="opt-i18n.inputMethod.uim.toolbar"/> option can be used to choose uim toolbar.
242208 </para>
243209 </section>
244210</chapter>
nixos/modules/programs/digitalbitbox/doc.xml+9−24
@@ -8,37 +8,25 @@
88 Digital Bitbox is a hardware wallet and second-factor authenticator.
99 </para>
1010 <para>
11− The <literal>digitalbitbox</literal> programs module may be installed by
12− setting <literal>programs.digitalbitbox</literal> to <literal>true</literal>
13− in a manner similar to
11+ The <literal>digitalbitbox</literal> programs module may be installed by setting <literal>programs.digitalbitbox</literal> to <literal>true</literal> in a manner similar to
1412<programlisting>
1513<xref linkend="opt-programs.digitalbitbox.enable"/> = true;
1614</programlisting>
17− and bundles the <literal>digitalbitbox</literal> package (see
18− <xref
19− linkend="sec-digitalbitbox-package" />), which contains the
20− <literal>dbb-app</literal> and <literal>dbb-cli</literal> binaries, along
21− with the hardware module (see
22− <xref
23− linkend="sec-digitalbitbox-hardware-module" />) which sets up the
24− necessary udev rules to access the device.
15+ and bundles the <literal>digitalbitbox</literal> package (see <xref
16+ linkend="sec-digitalbitbox-package" />), which contains the <literal>dbb-app</literal> and <literal>dbb-cli</literal> binaries, along with the hardware module (see <xref
17+ linkend="sec-digitalbitbox-hardware-module" />) which sets up the necessary udev rules to access the device.
2518 </para>
2619 <para>
27− Enabling the digitalbitbox module is pretty much the easiest way to get a
28− Digital Bitbox device working on your system.
20+ Enabling the digitalbitbox module is pretty much the easiest way to get a Digital Bitbox device working on your system.
2921 </para>
3022 <para>
31− For more information, see
32− <link xlink:href="https://digitalbitbox.com/start_linux" />.
23+ For more information, see <link xlink:href="https://digitalbitbox.com/start_linux" />.
3324 </para>
3425 <section xml:id="sec-digitalbitbox-package">
3526 <title>Package</title>
3627
3728 <para>
38− The binaries, <literal>dbb-app</literal> (a GUI tool) and
39− <literal>dbb-cli</literal> (a CLI tool), are available through the
40− <literal>digitalbitbox</literal> package which could be installed as
41− follows:
29+ The binaries, <literal>dbb-app</literal> (a GUI tool) and <literal>dbb-cli</literal> (a CLI tool), are available through the <literal>digitalbitbox</literal> package which could be installed as follows:
4230<programlisting>
4331<xref linkend="opt-environment.systemPackages"/> = [
4432 pkgs.digitalbitbox
@@ -50,17 +38,14 @@
5038 <title>Hardware</title>
5139
5240 <para>
53− The digitalbitbox hardware package enables the udev rules for Digital Bitbox
54− devices and may be installed as follows:
41+ The digitalbitbox hardware package enables the udev rules for Digital Bitbox devices and may be installed as follows:
5542<programlisting>
5643<xref linkend="opt-hardware.digitalbitbox.enable"/> = true;
5744</programlisting>
5845 </para>
5946
6047 <para>
61− In order to alter the udev rules, one may provide different values for the
62− <literal>udevRule51</literal> and <literal>udevRule52</literal> attributes
63− by means of overriding as follows:
48+ In order to alter the udev rules, one may provide different values for the <literal>udevRule51</literal> and <literal>udevRule52</literal> attributes by means of overriding as follows:
6449<programlisting>
6550programs.digitalbitbox = {
6651 <link linkend="opt-programs.digitalbitbox.enable">enable</link> = true;
nixos/modules/programs/plotinus.xml+4−9
@@ -5,24 +5,19 @@
55 xml:id="module-program-plotinus">
66 <title>Plotinus</title>
77 <para>
8− <emphasis>Source:</emphasis>
9− <filename>modules/programs/plotinus.nix</filename>
8+ <emphasis>Source:</emphasis> <filename>modules/programs/plotinus.nix</filename>
109 </para>
1110 <para>
12− <emphasis>Upstream documentation:</emphasis>
13− <link xlink:href="https://github.com/p-e-w/plotinus"/>
11+ <emphasis>Upstream documentation:</emphasis> <link xlink:href="https://github.com/p-e-w/plotinus"/>
1412 </para>
1513 <para>
1614 Plotinus is a searchable command palette in every modern GTK application.
1715 </para>
1816 <para>
19− When in a GTK 3 application and Plotinus is enabled, you can press
20− <literal>Ctrl+Shift+P</literal> to open the command palette. The command
21− palette provides a searchable list of of all menu items in the application.
17+ When in a GTK 3 application and Plotinus is enabled, you can press <literal>Ctrl+Shift+P</literal> to open the command palette. The command palette provides a searchable list of of all menu items in the application.
2218 </para>
2319 <para>
24− To enable Plotinus, add the following to your
25− <filename>configuration.nix</filename>:
20+ To enable Plotinus, add the following to your <filename>configuration.nix</filename>:
2621<programlisting>
2722<xref linkend="opt-programs.plotinus.enable"/> = true;
2823</programlisting>
nixos/modules/programs/zsh/oh-my-zsh.xml+13−49
@@ -5,18 +5,13 @@
55 xml:id="module-programs-zsh-ohmyzsh">
66 <title>Oh my ZSH</title>
77 <para>
8− <literal><link xlink:href="https://ohmyz.sh/">oh-my-zsh</link></literal> is a
9− framework to manage your <link xlink:href="https://www.zsh.org/">ZSH</link>
10− configuration including completion scripts for several CLI tools or custom
11− prompt themes.
8+ <literal><link xlink:href="https://ohmyz.sh/">oh-my-zsh</link></literal> is a framework to manage your <link xlink:href="https://www.zsh.org/">ZSH</link> configuration including completion scripts for several CLI tools or custom prompt themes.
129 </para>
1310 <section xml:id="module-programs-oh-my-zsh-usage">
1411 <title>Basic usage</title>
1512
1613 <para>
17− The module uses the <literal>oh-my-zsh</literal> package with all available
18− features. The initial setup using Nix expressions is fairly similar to the
19− configuration format of <literal>oh-my-zsh</literal>.
14+ The module uses the <literal>oh-my-zsh</literal> package with all available features. The initial setup using Nix expressions is fairly similar to the configuration format of <literal>oh-my-zsh</literal>.
2015<programlisting>
2116{
2217 programs.zsh.ohMyZsh = {
@@ -26,25 +21,18 @@
2621 };
2722}
2823</programlisting>
29− For a detailed explanation of these arguments please refer to the
30− <link xlink:href="https://github.com/robbyrussell/oh-my-zsh/wiki"><literal>oh-my-zsh</literal>
31− docs</link>.
24+ For a detailed explanation of these arguments please refer to the <link xlink:href="https://github.com/robbyrussell/oh-my-zsh/wiki"><literal>oh-my-zsh</literal> docs</link>.
3225 </para>
3326
3427 <para>
35− The expression generates the needed configuration and writes it into your
36− <literal>/etc/zshrc</literal>.
28+ The expression generates the needed configuration and writes it into your <literal>/etc/zshrc</literal>.
3729 </para>
3830 </section>
3931 <section xml:id="module-programs-oh-my-zsh-additions">
4032 <title>Custom additions</title>
4133
4234 <para>
43− Sometimes third-party or custom scripts such as a modified theme may be
44− needed. <literal>oh-my-zsh</literal> provides the
45− <link xlink:href="https://github.com/robbyrussell/oh-my-zsh/wiki/Customization#overriding-internals"><literal>ZSH_CUSTOM</literal></link>
46− environment variable for this which points to a directory with additional
47− scripts.
35+ Sometimes third-party or custom scripts such as a modified theme may be needed. <literal>oh-my-zsh</literal> provides the <link xlink:href="https://github.com/robbyrussell/oh-my-zsh/wiki/Customization#overriding-internals"><literal>ZSH_CUSTOM</literal></link> environment variable for this which points to a directory with additional scripts.
4836 </para>
4937
5038 <para>
@@ -60,16 +48,11 @@
6048 <title>Custom environments</title>
6149
6250 <para>
63− There are several extensions for <literal>oh-my-zsh</literal> packaged in
64− <literal>nixpkgs</literal>. One of them is
65− <link xlink:href="https://github.com/spwhitt/nix-zsh-completions">nix-zsh-completions</link>
66− which bundles completion scripts and a plugin for
67− <literal>oh-my-zsh</literal>.
51+ There are several extensions for <literal>oh-my-zsh</literal> packaged in <literal>nixpkgs</literal>. One of them is <link xlink:href="https://github.com/spwhitt/nix-zsh-completions">nix-zsh-completions</link> which bundles completion scripts and a plugin for <literal>oh-my-zsh</literal>.
6852 </para>
6953
7054 <para>
71− Rather than using a single mutable path for <literal>ZSH_CUSTOM</literal>,
72− it's also possible to generate this path from a list of Nix packages:
55+ Rather than using a single mutable path for <literal>ZSH_CUSTOM</literal>, it's also possible to generate this path from a list of Nix packages:
7356<programlisting>
7457{ pkgs, ... }:
7558{
@@ -79,53 +62,34 @@
7962 ];
8063}
8164</programlisting>
82− Internally a single store path will be created using
83− <literal>buildEnv</literal>. Please refer to the docs of
84− <link xlink:href="https://nixos.org/nixpkgs/manual/#sec-building-environment"><literal>buildEnv</literal></link>
85− for further reference.
65+ Internally a single store path will be created using <literal>buildEnv</literal>. Please refer to the docs of <link xlink:href="https://nixos.org/nixpkgs/manual/#sec-building-environment"><literal>buildEnv</literal></link> for further reference.
8666 </para>
8767
8868 <para>
89− <emphasis>Please keep in mind that this is not compatible with
90− <literal>programs.zsh.ohMyZsh.custom</literal> as it requires an immutable
91− store path while <literal>custom</literal> shall remain mutable! An
92− evaluation failure will be thrown if both <literal>custom</literal> and
93− <literal>customPkgs</literal> are set.</emphasis>
69+ <emphasis>Please keep in mind that this is not compatible with <literal>programs.zsh.ohMyZsh.custom</literal> as it requires an immutable store path while <literal>custom</literal> shall remain mutable! An evaluation failure will be thrown if both <literal>custom</literal> and <literal>customPkgs</literal> are set.</emphasis>
9470 </para>
9571 </section>
9672 <section xml:id="module-programs-oh-my-zsh-packaging-customizations">
9773 <title>Package your own customizations</title>
9874
9975 <para>
100− If third-party customizations (e.g. new themes) are supposed to be added to
101− <literal>oh-my-zsh</literal> there are several pitfalls to keep in mind:
76+ If third-party customizations (e.g. new themes) are supposed to be added to <literal>oh-my-zsh</literal> there are several pitfalls to keep in mind:
10277 </para>
10378
10479 <itemizedlist>
10580 <listitem>
10681 <para>
107− To comply with the default structure of <literal>ZSH</literal> the entire
108− output needs to be written to <literal>$out/share/zsh.</literal>
82+ To comply with the default structure of <literal>ZSH</literal> the entire output needs to be written to <literal>$out/share/zsh.</literal>
10983 </para>
11084 </listitem>
11185 <listitem>
11286 <para>
113− Completion scripts are supposed to be stored at
114− <literal>$out/share/zsh/site-functions</literal>. This directory is part
115− of the
116− <literal><link xlink:href="http://zsh.sourceforge.net/Doc/Release/Functions.html">fpath</link></literal>
117− and the package should be compatible with pure <literal>ZSH</literal>
118− setups. The module will automatically link the contents of
119− <literal>site-functions</literal> to completions directory in the proper
120− store path.
87+ Completion scripts are supposed to be stored at <literal>$out/share/zsh/site-functions</literal>. This directory is part of the <literal><link xlink:href="http://zsh.sourceforge.net/Doc/Release/Functions.html">fpath</link></literal> and the package should be compatible with pure <literal>ZSH</literal> setups. The module will automatically link the contents of <literal>site-functions</literal> to completions directory in the proper store path.
12188 </para>
12289 </listitem>
12390 <listitem>
12491 <para>
125− The <literal>plugins</literal> directory needs the structure
126− <literal>pluginname/pluginname.plugin.zsh</literal> as structured in the
127− <link xlink:href="https://github.com/robbyrussell/oh-my-zsh/tree/91b771914bc7c43dd7c7a43b586c5de2c225ceb7/plugins">upstream
128− repo.</link>
92+ The <literal>plugins</literal> directory needs the structure <literal>pluginname/pluginname.plugin.zsh</literal> as structured in the <link xlink:href="https://github.com/robbyrussell/oh-my-zsh/tree/91b771914bc7c43dd7c7a43b586c5de2c225ceb7/plugins">upstream repo.</link>
12993 </para>
13094 </listitem>
13195 </itemizedlist>
nixos/modules/security/acme.xml+7−23
@@ -5,19 +5,13 @@
55 xml:id="module-security-acme">
66 <title>SSL/TLS Certificates with ACME</title>
77 <para>
8− NixOS supports automatic domain validation &amp; certificate retrieval and
9− renewal using the ACME protocol. This is currently only implemented by and
10− for Let's Encrypt. The alternative ACME client <literal>simp_le</literal> is
11− used under the hood.
8+ NixOS supports automatic domain validation &amp; certificate retrieval and renewal using the ACME protocol. This is currently only implemented by and for Let's Encrypt. The alternative ACME client <literal>simp_le</literal> is used under the hood.
129 </para>
1310 <section xml:id="module-security-acme-prerequisites">
1411 <title>Prerequisites</title>
1512
1613 <para>
17− You need to have a running HTTP server for verification. The server must
18− have a webroot defined that can serve
19− <filename>.well-known/acme-challenge</filename>. This directory must be
20− writeable by the user that will run the ACME client.
14+ You need to have a running HTTP server for verification. The server must have a webroot defined that can serve <filename>.well-known/acme-challenge</filename>. This directory must be writeable by the user that will run the ACME client.
2115 </para>
2216
2317 <para>
@@ -45,9 +39,7 @@ http {
4539 <title>Configuring</title>
4640
4741 <para>
48− To enable ACME certificate retrieval &amp; renewal for a certificate for
49− <literal>foo.example.com</literal>, add the following in your
50− <filename>configuration.nix</filename>:
42+ To enable ACME certificate retrieval &amp; renewal for a certificate for <literal>foo.example.com</literal>, add the following in your <filename>configuration.nix</filename>:
5143<programlisting>
5244<xref linkend="opt-security.acme.certs"/>."foo.example.com" = {
5345 <link linkend="opt-security.acme.certs._name_.webroot">webroot</link> = "/var/www/challenges";
@@ -57,26 +49,18 @@ http {
5749 </para>
5850
5951 <para>
60− The private key <filename>key.pem</filename> and certificate
61− <filename>fullchain.pem</filename> will be put into
62− <filename>/var/lib/acme/foo.example.com</filename>.
52+ The private key <filename>key.pem</filename> and certificate <filename>fullchain.pem</filename> will be put into <filename>/var/lib/acme/foo.example.com</filename>.
6353 </para>
54+
6455 <para>
65− Refer to <xref linkend="ch-options" /> for all available configuration
66− options for the <link linkend="opt-security.acme.certs">security.acme</link>
67− module.
56+ Refer to <xref linkend="ch-options" /> for all available configuration options for the <link linkend="opt-security.acme.certs">security.acme</link> module.
6857 </para>
6958 </section>
7059 <section xml:id="module-security-acme-nginx">
7160 <title>Using ACME certificates in Nginx</title>
7261
7362 <para>
74− NixOS supports fetching ACME certificates for you by setting
75− <literal><link linkend="opt-services.nginx.virtualHosts._name_.enableACME">enableACME</link>
76− = true;</literal> in a virtualHost config. We first create self-signed
77− placeholder certificates in place of the real ACME certs. The placeholder
78− certs are overwritten when the ACME certs arrive. For
79− <literal>foo.example.com</literal> the config would look like.
63+ NixOS supports fetching ACME certificates for you by setting <literal><link linkend="opt-services.nginx.virtualHosts._name_.enableACME">enableACME</link> = true;</literal> in a virtualHost config. We first create self-signed placeholder certificates in place of the real ACME certs. The placeholder certs are overwritten when the ACME certs arrive. For <literal>foo.example.com</literal> the config would look like.
8064 </para>
8165
8266<programlisting>
nixos/modules/security/hidepid.xml+3−8
@@ -9,18 +9,13 @@
99<programlisting>
1010<xref linkend="opt-security.hideProcessInformation"/> = true;
1111</programlisting>
12− ensures that access to process information is restricted to the owning user.
13− This implies, among other things, that command-line arguments remain private.
14− Unless your deployment relies on unprivileged users being able to inspect the
15− process information of other users, this option should be safe to enable.
12+ ensures that access to process information is restricted to the owning user. This implies, among other things, that command-line arguments remain private. Unless your deployment relies on unprivileged users being able to inspect the process information of other users, this option should be safe to enable.
1613 </para>
1714 <para>
18− Members of the <literal>proc</literal> group are exempt from process
19− information hiding.
15+ Members of the <literal>proc</literal> group are exempt from process information hiding.
2016 </para>
2117 <para>
22− To allow a service <replaceable>foo</replaceable> to run without process
23− information hiding, set
18+ To allow a service <replaceable>foo</replaceable> to run without process information hiding, set
2419<programlisting>
2520<link linkend="opt-systemd.services._name_.serviceConfig">systemd.services.<replaceable>foo</replaceable>.serviceConfig</link>.SupplementaryGroups = [ "proc" ];
2621</programlisting>
nixos/modules/services/databases/foundationdb.xml+39−158
@@ -5,12 +5,10 @@
55 xml:id="module-services-foundationdb">
66 <title>FoundationDB</title>
77 <para>
8− <emphasis>Source:</emphasis>
9− <filename>modules/services/databases/foundationdb.nix</filename>
8+ <emphasis>Source:</emphasis> <filename>modules/services/databases/foundationdb.nix</filename>
109 </para>
1110 <para>
12− <emphasis>Upstream documentation:</emphasis>
13− <link xlink:href="https://apple.github.io/foundationdb/"/>
11+ <emphasis>Upstream documentation:</emphasis> <link xlink:href="https://apple.github.io/foundationdb/"/>
1412 </para>
1513 <para>
1614 <emphasis>Maintainer:</emphasis> Austin Seipp
@@ -19,15 +17,13 @@
1917 <emphasis>Available version(s):</emphasis> 5.1.x, 5.2.x, 6.0.x
2018 </para>
2119 <para>
22− FoundationDB (or "FDB") is an open source, distributed, transactional
23− key-value store.
20+ FoundationDB (or "FDB") is an open source, distributed, transactional key-value store.
2421 </para>
2522 <section xml:id="module-services-foundationdb-configuring">
2623 <title>Configuring and basic setup</title>
2724
2825 <para>
29− To enable FoundationDB, add the following to your
30− <filename>configuration.nix</filename>:
26+ To enable FoundationDB, add the following to your <filename>configuration.nix</filename>:
3127<programlisting>
3228services.foundationdb.enable = true;
3329services.foundationdb.package = pkgs.foundationdb52; # FoundationDB 5.2.x
@@ -35,18 +31,11 @@ services.foundationdb.package = pkgs.foundationdb52; # FoundationDB 5.2.x
3531 </para>
3632
3733 <para>
38− The <option>services.foundationdb.package</option> option is required, and
39− must always be specified. Due to the fact FoundationDB network protocols and
40− on-disk storage formats may change between (major) versions, and upgrades
41− must be explicitly handled by the user, you must always manually specify
42− this yourself so that the NixOS module will use the proper version. Note
43− that minor, bugfix releases are always compatible.
34+ The <option>services.foundationdb.package</option> option is required, and must always be specified. Due to the fact FoundationDB network protocols and on-disk storage formats may change between (major) versions, and upgrades must be explicitly handled by the user, you must always manually specify this yourself so that the NixOS module will use the proper version. Note that minor, bugfix releases are always compatible.
4435 </para>
4536
4637 <para>
47− After running <command>nixos-rebuild</command>, you can verify whether
48− FoundationDB is running by executing <command>fdbcli</command> (which is
49− added to <option>environment.systemPackages</option>):
38+ After running <command>nixos-rebuild</command>, you can verify whether FoundationDB is running by executing <command>fdbcli</command> (which is added to <option>environment.systemPackages</option>):
5039<screen>
5140<prompt>$ </prompt>sudo -u foundationdb fdbcli
5241Using cluster file `/etc/foundationdb/fdb.cluster'.
@@ -77,11 +66,7 @@ Cluster:
7766 </para>
7867
7968 <para>
80− You can also write programs using the available client libraries. For
81− example, the following Python program can be run in order to grab the
82− cluster status, as a quick example. (This example uses
83− <command>nix-shell</command> shebang support to automatically supply the
84− necessary Python modules).
69+ You can also write programs using the available client libraries. For example, the following Python program can be run in order to grab the cluster status, as a quick example. (This example uses <command>nix-shell</command> shebang support to automatically supply the necessary Python modules).
8570<screen>
8671<prompt>a@link> </prompt>cat fdb-status.py
8772#! /usr/bin/env nix-shell
@@ -111,91 +96,56 @@ FoundationDB available: True
11196 </para>
11297
11398 <para>
114− FoundationDB is run under the <command>foundationdb</command> user and group
115− by default, but this may be changed in the NixOS configuration. The systemd
116− unit <command>foundationdb.service</command> controls the
117− <command>fdbmonitor</command> process.
99+ FoundationDB is run under the <command>foundationdb</command> user and group by default, but this may be changed in the NixOS configuration. The systemd unit <command>foundationdb.service</command> controls the <command>fdbmonitor</command> process.
118100 </para>
119101
120102 <para>
121− By default, the NixOS module for FoundationDB creates a single SSD-storage
122− based database for development and basic usage. This storage engine is
123− designed for SSDs and will perform poorly on HDDs; however it can handle far
124− more data than the alternative "memory" engine and is a better default
125− choice for most deployments. (Note that you can change the storage backend
126− on-the-fly for a given FoundationDB cluster using
127− <command>fdbcli</command>.)
103+ By default, the NixOS module for FoundationDB creates a single SSD-storage based database for development and basic usage. This storage engine is designed for SSDs and will perform poorly on HDDs; however it can handle far more data than the alternative "memory" engine and is a better default choice for most deployments. (Note that you can change the storage backend on-the-fly for a given FoundationDB cluster using <command>fdbcli</command>.)
128104 </para>
129105
130106 <para>
131− Furthermore, only 1 server process and 1 backup agent are started in the
132− default configuration. See below for more on scaling to increase this.
107+ Furthermore, only 1 server process and 1 backup agent are started in the default configuration. See below for more on scaling to increase this.
133108 </para>
134109
135110 <para>
136− FoundationDB stores all data for all server processes under
137− <filename>/var/lib/foundationdb</filename>. You can override this using
138− <option>services.foundationdb.dataDir</option>, e.g.
111+ FoundationDB stores all data for all server processes under <filename>/var/lib/foundationdb</filename>. You can override this using <option>services.foundationdb.dataDir</option>, e.g.
139112<programlisting>
140113services.foundationdb.dataDir = "/data/fdb";
141114</programlisting>
142115 </para>
143116
144117 <para>
145− Similarly, logs are stored under <filename>/var/log/foundationdb</filename>
146− by default, and there is a corresponding
147− <option>services.foundationdb.logDir</option> as well.
118+ Similarly, logs are stored under <filename>/var/log/foundationdb</filename> by default, and there is a corresponding <option>services.foundationdb.logDir</option> as well.
148119 </para>
149120 </section>
150121 <section xml:id="module-services-foundationdb-scaling">
151122 <title>Scaling processes and backup agents</title>
152123
153124 <para>
154− Scaling the number of server processes is quite easy; simply specify
155− <option>services.foundationdb.serverProcesses</option> to be the number of
156− FoundationDB worker processes that should be started on the machine.
125+ Scaling the number of server processes is quite easy; simply specify <option>services.foundationdb.serverProcesses</option> to be the number of FoundationDB worker processes that should be started on the machine.
157126 </para>
158127
159128 <para>
160− FoundationDB worker processes typically require 4GB of RAM per-process at
161− minimum for good performance, so this option is set to 1 by default since
162− the maximum amount of RAM is unknown. You're advised to abide by this
163− restriction, so pick a number of processes so that each has 4GB or more.
129+ FoundationDB worker processes typically require 4GB of RAM per-process at minimum for good performance, so this option is set to 1 by default since the maximum amount of RAM is unknown. You're advised to abide by this restriction, so pick a number of processes so that each has 4GB or more.
164130 </para>
165131
166132 <para>
167− A similar option exists in order to scale backup agent processes,
168− <option>services.foundationdb.backupProcesses</option>. Backup agents are
169− not as performance/RAM sensitive, so feel free to experiment with the number
170− of available backup processes.
133+ A similar option exists in order to scale backup agent processes, <option>services.foundationdb.backupProcesses</option>. Backup agents are not as performance/RAM sensitive, so feel free to experiment with the number of available backup processes.
171134 </para>
172135 </section>
173136 <section xml:id="module-services-foundationdb-clustering">
174137 <title>Clustering</title>
175138
176139 <para>
177− FoundationDB on NixOS works similarly to other Linux systems, so this
178− section will be brief. Please refer to the full FoundationDB documentation
179− for more on clustering.
140+ FoundationDB on NixOS works similarly to other Linux systems, so this section will be brief. Please refer to the full FoundationDB documentation for more on clustering.
180141 </para>
181142
182143 <para>
183− FoundationDB organizes clusters using a set of
184− <emphasis>coordinators</emphasis>, which are just specially-designated
185− worker processes. By default, every installation of FoundationDB on NixOS
186− will start as its own individual cluster, with a single coordinator: the
187− first worker process on <command>localhost</command>.
144+ FoundationDB organizes clusters using a set of <emphasis>coordinators</emphasis>, which are just specially-designated worker processes. By default, every installation of FoundationDB on NixOS will start as its own individual cluster, with a single coordinator: the first worker process on <command>localhost</command>.
188145 </para>
189146
190147 <para>
191− Coordinators are specified globally using the
192− <command>/etc/foundationdb/fdb.cluster</command> file, which all servers and
193− client applications will use to find and join coordinators. Note that this
194− file <emphasis>can not</emphasis> be managed by NixOS so easily:
195− FoundationDB is designed so that it will rewrite the file at runtime for all
196− clients and nodes when cluster coordinators change, with clients
197− transparently handling this without intervention. It is fundamentally a
198− mutable file, and you should not try to manage it in any way in NixOS.
148+ Coordinators are specified globally using the <command>/etc/foundationdb/fdb.cluster</command> file, which all servers and client applications will use to find and join coordinators. Note that this file <emphasis>can not</emphasis> be managed by NixOS so easily: FoundationDB is designed so that it will rewrite the file at runtime for all clients and nodes when cluster coordinators change, with clients transparently handling this without intervention. It is fundamentally a mutable file, and you should not try to manage it in any way in NixOS.
199149 </para>
200150
201151 <para>
@@ -216,9 +166,7 @@ services.foundationdb.dataDir = "/data/fdb";
216166 </itemizedlist>
217167
218168 <para>
219− A node must already be a member of the cluster in order to properly be
220− promoted to a coordinator, so you must always add it first if you wish to
221− promote it.
169+ A node must already be a member of the cluster in order to properly be promoted to a coordinator, so you must always add it first if you wish to promote it.
222170 </para>
223171
224172 <para>
@@ -233,37 +181,26 @@ services.foundationdb.dataDir = "/data/fdb";
233181 </listitem>
234182 <listitem>
235183 <para>
236− Copy the <command>/etc/foundationdb/fdb.cluster</command> file from this
237− server to all the other servers. Restart FoundationDB on all of these
238− other servers, so they join the cluster.
184+ Copy the <command>/etc/foundationdb/fdb.cluster</command> file from this server to all the other servers. Restart FoundationDB on all of these other servers, so they join the cluster.
239185 </para>
240186 </listitem>
241187 <listitem>
242188 <para>
243− All of these servers are now connected and working together in the
244− cluster, under the chosen coordinator.
189+ All of these servers are now connected and working together in the cluster, under the chosen coordinator.
245190 </para>
246191 </listitem>
247192 </itemizedlist>
248193
249194 <para>
250− At this point, you can add as many nodes as you want by just repeating the
251− above steps. By default there will still be a single coordinator: you can
252− use <command>fdbcli</command> to change this and add new coordinators.
195+ At this point, you can add as many nodes as you want by just repeating the above steps. By default there will still be a single coordinator: you can use <command>fdbcli</command> to change this and add new coordinators.
253196 </para>
254197
255198 <para>
256− As a convenience, FoundationDB can automatically assign coordinators based
257− on the redundancy mode you wish to achieve for the cluster. Once all the
258− nodes have been joined, simply set the replication policy, and then issue
259− the <command>coordinators auto</command> command
199+ As a convenience, FoundationDB can automatically assign coordinators based on the redundancy mode you wish to achieve for the cluster. Once all the nodes have been joined, simply set the replication policy, and then issue the <command>coordinators auto</command> command
260200 </para>
261201
262202 <para>
263− For example, assuming we have 3 nodes available, we can enable double
264− redundancy mode, then auto-select coordinators. For double redundancy, 3
265− coordinators is ideal: therefore FoundationDB will make
266− <emphasis>every</emphasis> node a coordinator automatically:
203+ For example, assuming we have 3 nodes available, we can enable double redundancy mode, then auto-select coordinators. For double redundancy, 3 coordinators is ideal: therefore FoundationDB will make <emphasis>every</emphasis> node a coordinator automatically:
267204 </para>
268205
269206<screen>
@@ -272,58 +209,33 @@ services.foundationdb.dataDir = "/data/fdb";
272209</screen>
273210
274211 <para>
275− This will transparently update all the servers within seconds, and
276− appropriately rewrite the <command>fdb.cluster</command> file, as well as
277− informing all client processes to do the same.
212+ This will transparently update all the servers within seconds, and appropriately rewrite the <command>fdb.cluster</command> file, as well as informing all client processes to do the same.
278213 </para>
279214 </section>
280215 <section xml:id="module-services-foundationdb-connectivity">
281216 <title>Client connectivity</title>
282217
283218 <para>
284− By default, all clients must use the current <command>fdb.cluster</command>
285− file to access a given FoundationDB cluster. This file is located by default
286− in <command>/etc/foundationdb/fdb.cluster</command> on all machines with the
287− FoundationDB service enabled, so you may copy the active one from your
288− cluster to a new node in order to connect, if it is not part of the cluster.
219+ By default, all clients must use the current <command>fdb.cluster</command> file to access a given FoundationDB cluster. This file is located by default in <command>/etc/foundationdb/fdb.cluster</command> on all machines with the FoundationDB service enabled, so you may copy the active one from your cluster to a new node in order to connect, if it is not part of the cluster.
289220 </para>
290221 </section>
291222 <section xml:id="module-services-foundationdb-authorization">
292223 <title>Client authorization and TLS</title>
293224
294225 <para>
295− By default, any user who can connect to a FoundationDB process with the
296− correct cluster configuration can access anything. FoundationDB uses a
297− pluggable design to transport security, and out of the box it supports a
298− LibreSSL-based plugin for TLS support. This plugin not only does in-flight
299− encryption, but also performs client authorization based on the given
300− endpoint's certificate chain. For example, a FoundationDB server may be
301− configured to only accept client connections over TLS, where the client TLS
302− certificate is from organization <emphasis>Acme Co</emphasis> in the
303− <emphasis>Research and Development</emphasis> unit.
226+ By default, any user who can connect to a FoundationDB process with the correct cluster configuration can access anything. FoundationDB uses a pluggable design to transport security, and out of the box it supports a LibreSSL-based plugin for TLS support. This plugin not only does in-flight encryption, but also performs client authorization based on the given endpoint's certificate chain. For example, a FoundationDB server may be configured to only accept client connections over TLS, where the client TLS certificate is from organization <emphasis>Acme Co</emphasis> in the <emphasis>Research and Development</emphasis> unit.
304227 </para>
305228
306229 <para>
307− Configuring TLS with FoundationDB is done using the
308− <option>services.foundationdb.tls</option> options in order to control the
309− peer verification string, as well as the certificate and its private key.
230+ Configuring TLS with FoundationDB is done using the <option>services.foundationdb.tls</option> options in order to control the peer verification string, as well as the certificate and its private key.
310231 </para>
311232
312233 <para>
313− Note that the certificate and its private key must be accessible to the
314− FoundationDB user account that the server runs under. These files are also
315− NOT managed by NixOS, as putting them into the store may reveal private
316− information.
234+ Note that the certificate and its private key must be accessible to the FoundationDB user account that the server runs under. These files are also NOT managed by NixOS, as putting them into the store may reveal private information.
317235 </para>
318236
319237 <para>
320− After you have a key and certificate file in place, it is not enough to
321− simply set the NixOS module options -- you must also configure the
322− <command>fdb.cluster</command> file to specify that a given set of
323− coordinators use TLS. This is as simple as adding the suffix
324− <command>:tls</command> to your cluster coordinator configuration, after the
325− port number. For example, assuming you have a coordinator on localhost with
326− the default configuration, simply specifying:
238+ After you have a key and certificate file in place, it is not enough to simply set the NixOS module options -- you must also configure the <command>fdb.cluster</command> file to specify that a given set of coordinators use TLS. This is as simple as adding the suffix <command>:tls</command> to your cluster coordinator configuration, after the port number. For example, assuming you have a coordinator on localhost with the default configuration, simply specifying:
327239 </para>
328240
329241<programlisting>
@@ -338,36 +250,19 @@ XXXXXX:XXXXXX@127.0.0.1:4500:tls
338250 <title>Backups and Disaster Recovery</title>
339251
340252 <para>
341− The usual rules for doing FoundationDB backups apply on NixOS as written in
342− the FoundationDB manual. However, one important difference is the security
343− profile for NixOS: by default, the <command>foundationdb</command> systemd
344− unit uses <emphasis>Linux namespaces</emphasis> to restrict write access to
345− the system, except for the log directory, data directory, and the
346− <command>/etc/foundationdb/</command> directory. This is enforced by default
347− and cannot be disabled.
253+ The usual rules for doing FoundationDB backups apply on NixOS as written in the FoundationDB manual. However, one important difference is the security profile for NixOS: by default, the <command>foundationdb</command> systemd unit uses <emphasis>Linux namespaces</emphasis> to restrict write access to the system, except for the log directory, data directory, and the <command>/etc/foundationdb/</command> directory. This is enforced by default and cannot be disabled.
348254 </para>
349255
350256 <para>
351− However, a side effect of this is that the <command>fdbbackup</command>
352− command doesn't work properly for local filesystem backups: FoundationDB
353− uses a server process alongside the database processes to perform backups
354− and copy the backups to the filesystem. As a result, this process is put
355− under the restricted namespaces above: the backup process can only write to
356− a limited number of paths.
257+ However, a side effect of this is that the <command>fdbbackup</command> command doesn't work properly for local filesystem backups: FoundationDB uses a server process alongside the database processes to perform backups and copy the backups to the filesystem. As a result, this process is put under the restricted namespaces above: the backup process can only write to a limited number of paths.
357258 </para>
358259
359260 <para>
360− In order to allow flexible backup locations on local disks, the FoundationDB
361− NixOS module supports a
362− <option>services.foundationdb.extraReadWritePaths</option> option. This
363− option takes a list of paths, and adds them to the systemd unit, allowing
364− the processes inside the service to write (and read) the specified
365− directories.
261+ In order to allow flexible backup locations on local disks, the FoundationDB NixOS module supports a <option>services.foundationdb.extraReadWritePaths</option> option. This option takes a list of paths, and adds them to the systemd unit, allowing the processes inside the service to write (and read) the specified directories.
366262 </para>
367263
368264 <para>
369− For example, to create backups in <command>/opt/fdb-backups</command>, first
370− set up the paths in the module options:
265+ For example, to create backups in <command>/opt/fdb-backups</command>, first set up the paths in the module options:
371266 </para>
372267
373268<programlisting>
@@ -375,11 +270,7 @@ services.foundationdb.extraReadWritePaths = [ "/opt/fdb-backups" ];
375270</programlisting>
376271
377272 <para>
378− Restart the FoundationDB service, and it will now be able to write to this
379− directory (even if it does not yet exist.) Note: this path
380− <emphasis>must</emphasis> exist before restarting the unit. Otherwise,
381− systemd will not include it in the private FoundationDB namespace (and it
382− will not add it dynamically at runtime).
273+ Restart the FoundationDB service, and it will now be able to write to this directory (even if it does not yet exist.) Note: this path <emphasis>must</emphasis> exist before restarting the unit. Otherwise, systemd will not include it in the private FoundationDB namespace (and it will not add it dynamically at runtime).
383274 </para>
384275
385276 <para>
@@ -395,17 +286,13 @@ services.foundationdb.extraReadWritePaths = [ "/opt/fdb-backups" ];
395286 <title>Known limitations</title>
396287
397288 <para>
398− The FoundationDB setup for NixOS should currently be considered beta.
399− FoundationDB is not new software, but the NixOS compilation and integration
400− has only undergone fairly basic testing of all the available functionality.
289+ The FoundationDB setup for NixOS should currently be considered beta. FoundationDB is not new software, but the NixOS compilation and integration has only undergone fairly basic testing of all the available functionality.
401290 </para>
402291
403292 <itemizedlist>
404293 <listitem>
405294 <para>
406− There is no way to specify individual parameters for individual
407− <command>fdbserver</command> processes. Currently, all server processes
408− inherit all the global <command>fdbmonitor</command> settings.
295+ There is no way to specify individual parameters for individual <command>fdbserver</command> processes. Currently, all server processes inherit all the global <command>fdbmonitor</command> settings.
409296 </para>
410297 </listitem>
411298 <listitem>
@@ -424,20 +311,14 @@ services.foundationdb.extraReadWritePaths = [ "/opt/fdb-backups" ];
424311 <title>Options</title>
425312
426313 <para>
427− NixOS's FoundationDB module allows you to configure all of the most relevant
428− configuration options for <command>fdbmonitor</command>, matching it quite
429− closely. A complete list of options for the FoundationDB module may be found
430− <link linkend="opt-services.foundationdb.enable">here</link>. You should
431− also read the FoundationDB documentation as well.
314+ NixOS's FoundationDB module allows you to configure all of the most relevant configuration options for <command>fdbmonitor</command>, matching it quite closely. A complete list of options for the FoundationDB module may be found <link linkend="opt-services.foundationdb.enable">here</link>. You should also read the FoundationDB documentation as well.
432315 </para>
433316 </section>
434317 <section xml:id="module-services-foundationdb-full-docs">
435318 <title>Full documentation</title>
436319
437320 <para>
438− FoundationDB is a complex piece of software, and requires careful
439− administration to properly use. Full documentation for administration can be
440− found here: <link xlink:href="https://apple.github.io/foundationdb/"/>.
321+ FoundationDB is a complex piece of software, and requires careful administration to properly use. Full documentation for administration can be found here: <link xlink:href="https://apple.github.io/foundationdb/"/>.
441322 </para>
442323 </section>
443324</chapter>
nixos/modules/services/databases/postgresql.xml+13−26
@@ -7,12 +7,10 @@
77<!-- FIXME: render nicely -->
88<!-- FIXME: source can be added automatically -->
99 <para>
10− <emphasis>Source:</emphasis>
11− <filename>modules/services/databases/postgresql.nix</filename>
10+ <emphasis>Source:</emphasis> <filename>modules/services/databases/postgresql.nix</filename>
1211 </para>
1312 <para>
14− <emphasis>Upstream documentation:</emphasis>
15− <link xlink:href="http://www.postgresql.org/docs/"/>
13+ <emphasis>Upstream documentation:</emphasis> <link xlink:href="http://www.postgresql.org/docs/"/>
1614 </para>
1715<!-- FIXME: more stuff, like maintainer? -->
1816 <para>
@@ -23,18 +21,12 @@
2321 <title>Configuring</title>
2422
2523 <para>
26− To enable PostgreSQL, add the following to your
27− <filename>configuration.nix</filename>:
24+ To enable PostgreSQL, add the following to your <filename>configuration.nix</filename>:
2825<programlisting>
2926<xref linkend="opt-services.postgresql.enable"/> = true;
3027<xref linkend="opt-services.postgresql.package"/> = pkgs.postgresql_11;
3128</programlisting>
32− Note that you are required to specify the desired version of PostgreSQL
33− (e.g. <literal>pkgs.postgresql_11</literal>). Since upgrading your
34− PostgreSQL version requires a database dump and reload (see below), NixOS
35− cannot provide a default value for
36− <xref linkend="opt-services.postgresql.package"/> such as the most recent
37− release of PostgreSQL.
29+ Note that you are required to specify the desired version of PostgreSQL (e.g. <literal>pkgs.postgresql_11</literal>). Since upgrading your PostgreSQL version requires a database dump and reload (see below), NixOS cannot provide a default value for <xref linkend="opt-services.postgresql.package"/> such as the most recent release of PostgreSQL.
3830 </para>
3931
4032<!--
@@ -51,9 +43,7 @@ Type "help" for help.
5143-->
5244
5345 <para>
54− By default, PostgreSQL stores its databases in
55− <filename>/var/lib/postgresql/$psqlSchema</filename>. You can override this using
56− <xref linkend="opt-services.postgresql.dataDir"/>, e.g.
46+ By default, PostgreSQL stores its databases in <filename>/var/lib/postgresql/$psqlSchema</filename>. You can override this using <xref linkend="opt-services.postgresql.dataDir"/>, e.g.
5747<programlisting>
5848<xref linkend="opt-services.postgresql.dataDir"/> = "/data/postgresql";
5949</programlisting>
@@ -70,18 +60,14 @@ Type "help" for help.
7060 <title>Options</title>
7161
7262 <para>
73− A complete list of options for the PostgreSQL module may be found
74− <link linkend="opt-services.postgresql.enable">here</link>.
63+ A complete list of options for the PostgreSQL module may be found <link linkend="opt-services.postgresql.enable">here</link>.
7564 </para>
7665 </section>
7766 <section xml:id="module-services-postgres-plugins">
7867 <title>Plugins</title>
7968
8069 <para>
81− Plugins collection for each PostgreSQL version can be accessed with
82− <literal>.pkgs</literal>. For example, for
83− <literal>pkgs.postgresql_11</literal> package, its plugin collection is
84− accessed by <literal>pkgs.postgresql_11.pkgs</literal>:
70+ Plugins collection for each PostgreSQL version can be accessed with <literal>.pkgs</literal>. For example, for <literal>pkgs.postgresql_11</literal> package, its plugin collection is accessed by <literal>pkgs.postgresql_11.pkgs</literal>:
8571<screen>
8672<prompt>$ </prompt>nix repl '&lt;nixpkgs&gt;'
8773
@@ -98,8 +84,9 @@ postgresql_11.pkgs.pg_partman postgresql_11.pkgs.pgroonga
9884...
9985</screen>
10086 </para>
87+
10188 <para>
102− To add plugins via NixOS configuration, set <literal>services.postgresql.extraPlugins</literal>:
89+ To add plugins via NixOS configuration, set <literal>services.postgresql.extraPlugins</literal>:
10390<programlisting>
10491<xref linkend="opt-services.postgresql.package"/> = pkgs.postgresql_11;
10592<xref linkend="opt-services.postgresql.extraPlugins"/> = with pkgs.postgresql_11.pkgs; [
@@ -108,10 +95,9 @@ postgresql_11.pkgs.pg_partman postgresql_11.pkgs.pgroonga
10895];
10996</programlisting>
11097 </para>
98+
11199 <para>
112− You can build custom PostgreSQL-with-plugins (to be used outside of NixOS) using
113− function <literal>.withPackages</literal>. For example, creating a custom
114− PostgreSQL package in an overlay can look like:
100+ You can build custom PostgreSQL-with-plugins (to be used outside of NixOS) using function <literal>.withPackages</literal>. For example, creating a custom PostgreSQL package in an overlay can look like:
115101<programlisting>
116102self: super: {
117103 postgresql_custom = self.postgresql_11.withPackages (ps: [
@@ -121,8 +107,9 @@ self: super: {
121107}
122108</programlisting>
123109 </para>
110+
124111 <para>
125− Here's a recipe on how to override a particular plugin through an overlay:
112+ Here's a recipe on how to override a particular plugin through an overlay:
126113<programlisting>
127114self: super: {
128115 postgresql_11 = super.postgresql_11.override { this = self.postgresql_11; } // {
nixos/modules/services/desktops/flatpak.xml+7−18
@@ -5,44 +5,33 @@
55 xml:id="module-services-flatpak">
66 <title>Flatpak</title>
77 <para>
8− <emphasis>Source:</emphasis>
9− <filename>modules/services/desktop/flatpak.nix</filename>
8+ <emphasis>Source:</emphasis> <filename>modules/services/desktop/flatpak.nix</filename>
109 </para>
1110 <para>
12− <emphasis>Upstream documentation:</emphasis>
13− <link xlink:href="https://github.com/flatpak/flatpak/wiki"/>
11+ <emphasis>Upstream documentation:</emphasis> <link xlink:href="https://github.com/flatpak/flatpak/wiki"/>
1412 </para>
1513 <para>
16− Flatpak is a system for building, distributing, and running sandboxed desktop
17− applications on Linux.
14+ Flatpak is a system for building, distributing, and running sandboxed desktop applications on Linux.
1815 </para>
1916 <para>
20− To enable Flatpak, add the following to your
21− <filename>configuration.nix</filename>:
17+ To enable Flatpak, add the following to your <filename>configuration.nix</filename>:
2218<programlisting>
2319 <xref linkend="opt-services.flatpak.enable"/> = true;
2420</programlisting>
2521 </para>
2622 <para>
27− For the sandboxed apps to work correctly, desktop integration portals need to
28− be installed. If you run GNOME, this will be handled automatically for you;
29− in other cases, you will need to add something like the following to your
30− <filename>configuration.nix</filename>:
23+ For the sandboxed apps to work correctly, desktop integration portals need to be installed. If you run GNOME, this will be handled automatically for you; in other cases, you will need to add something like the following to your <filename>configuration.nix</filename>:
3124<programlisting>
3225 <xref linkend="opt-xdg.portal.extraPortals"/> = [ pkgs.xdg-desktop-portal-gtk ];
3326</programlisting>
3427 </para>
3528 <para>
36− Then, you will need to add a repository, for example,
37− <link xlink:href="https://github.com/flatpak/flatpak/wiki">Flathub</link>,
38− either using the following commands:
29+ Then, you will need to add a repository, for example, <link xlink:href="https://github.com/flatpak/flatpak/wiki">Flathub</link>, either using the following commands:
3930<screen>
4031<prompt>$ </prompt>flatpak remote-add --if-not-exists flathub https://flathub.org/repo/flathub.flatpakrepo
4132<prompt>$ </prompt>flatpak update
4233</screen>
43− or by opening the
44− <link xlink:href="https://flathub.org/repo/flathub.flatpakrepo">repository
45− file</link> in GNOME Software.
34+ or by opening the <link xlink:href="https://flathub.org/repo/flathub.flatpakrepo">repository file</link> in GNOME Software.
4635 </para>
4736 <para>
4837 Finally, you can search and install programs:
nixos/modules/services/editors/emacs.xml+51−170
@@ -12,41 +12,26 @@
1212 Adam Hoese @adisbladis
1313 -->
1414 <para>
15− <link xlink:href="https://www.gnu.org/software/emacs/">Emacs</link> is an
16− extensible, customizable, self-documenting real-time display editor — and
17− more. At its core is an interpreter for Emacs Lisp, a dialect of the Lisp
18− programming language with extensions to support text editing.
15+ <link xlink:href="https://www.gnu.org/software/emacs/">Emacs</link> is an extensible, customizable, self-documenting real-time display editor — and more. At its core is an interpreter for Emacs Lisp, a dialect of the Lisp programming language with extensions to support text editing.
1916 </para>
2017 <para>
21− Emacs runs within a graphical desktop environment using the X Window System,
22− but works equally well on a text terminal. Under
23− <productname>macOS</productname>, a "Mac port" edition is available, which
24− uses Apple's native GUI frameworks.
18+ Emacs runs within a graphical desktop environment using the X Window System, but works equally well on a text terminal. Under <productname>macOS</productname>, a "Mac port" edition is available, which uses Apple's native GUI frameworks.
2519 </para>
2620 <para>
27− <productname>Nixpkgs</productname> provides a superior environment for
28− running <application>Emacs</application>. It's simple to create custom builds
29− by overriding the default packages. Chaotic collections of Emacs Lisp code
30− and extensions can be brought under control using declarative package
31− management. <productname>NixOS</productname> even provides a
32− <command>systemd</command> user service for automatically starting the Emacs
33− daemon.
21+ <productname>Nixpkgs</productname> provides a superior environment for running <application>Emacs</application>. It's simple to create custom builds by overriding the default packages. Chaotic collections of Emacs Lisp code and extensions can be brought under control using declarative package management. <productname>NixOS</productname> even provides a <command>systemd</command> user service for automatically starting the Emacs daemon.
3422 </para>
3523 <section xml:id="module-services-emacs-installing">
3624 <title>Installing <application>Emacs</application></title>
3725
3826 <para>
39− Emacs can be installed in the normal way for Nix (see
40− <xref linkend="sec-package-management" />). In addition, a NixOS
41− <emphasis>service</emphasis> can be enabled.
27+ Emacs can be installed in the normal way for Nix (see <xref linkend="sec-package-management" />). In addition, a NixOS <emphasis>service</emphasis> can be enabled.
4228 </para>
4329
4430 <section xml:id="module-services-emacs-releases">
4531 <title>The Different Releases of Emacs</title>
4632
4733 <para>
48− <productname>Nixpkgs</productname> defines several basic Emacs packages.
49− The following are attributes belonging to the <varname>pkgs</varname> set:
34+ <productname>Nixpkgs</productname> defines several basic Emacs packages. The following are attributes belonging to the <varname>pkgs</varname> set:
5035 <variablelist>
5136 <varlistentry>
5237 <term>
@@ -57,10 +42,8 @@
5742 </term>
5843 <listitem>
5944 <para>
60− The latest stable version of Emacs 25 using the
61− <link
62− xlink:href="http://www.gtk.org">GTK 2</link>
63− widget toolkit.
45+ The latest stable version of Emacs 25 using the <link
46+ xlink:href="http://www.gtk.org">GTK 2</link> widget toolkit.
6447 </para>
6548 </listitem>
6649 </varlistentry>
@@ -83,8 +66,7 @@
8366 </term>
8467 <listitem>
8568 <para>
86− Emacs 25 with the "Mac port" patches, providing a more native look and
87− feel under macOS.
69+ Emacs 25 with the "Mac port" patches, providing a more native look and feel under macOS.
8870 </para>
8971 </listitem>
9072 </varlistentry>
@@ -92,12 +74,7 @@
9274 </para>
9375
9476 <para>
95− If those aren't suitable, then the following imitation Emacs editors are
96− also available in Nixpkgs:
97− <link xlink:href="https://www.gnu.org/software/zile/">Zile</link>,
98− <link xlink:href="http://homepage.boetes.org/software/mg/">mg</link>,
99− <link xlink:href="http://yi-editor.github.io/">Yi</link>,
100− <link xlink:href="https://joe-editor.sourceforge.io/">jmacs</link>.
77+ If those aren't suitable, then the following imitation Emacs editors are also available in Nixpkgs: <link xlink:href="https://www.gnu.org/software/zile/">Zile</link>, <link xlink:href="http://homepage.boetes.org/software/mg/">mg</link>, <link xlink:href="http://yi-editor.github.io/">Yi</link>, <link xlink:href="https://joe-editor.sourceforge.io/">jmacs</link>.
10178 </para>
10279 </section>
10380
@@ -105,36 +82,20 @@
10582 <title>Adding Packages to Emacs</title>
10683
10784 <para>
108− Emacs includes an entire ecosystem of functionality beyond text editing,
109− including a project planner, mail and news reader, debugger interface,
110− calendar, and more.
85+ Emacs includes an entire ecosystem of functionality beyond text editing, including a project planner, mail and news reader, debugger interface, calendar, and more.
11186 </para>
11287
11388 <para>
114− Most extensions are gotten with the Emacs packaging system
115− (<filename>package.el</filename>) from
116− <link
117− xlink:href="https://elpa.gnu.org/">Emacs Lisp Package Archive
118− (<acronym>ELPA</acronym>)</link>,
119− <link xlink:href="https://melpa.org/"><acronym>MELPA</acronym></link>,
120− <link xlink:href="https://stable.melpa.org/">MELPA Stable</link>, and
121− <link xlink:href="http://orgmode.org/elpa.html">Org ELPA</link>. Nixpkgs is
122− regularly updated to mirror all these archives.
89+ Most extensions are gotten with the Emacs packaging system (<filename>package.el</filename>) from <link
90+ xlink:href="https://elpa.gnu.org/">Emacs Lisp Package Archive (<acronym>ELPA</acronym>)</link>, <link xlink:href="https://melpa.org/"><acronym>MELPA</acronym></link>, <link xlink:href="https://stable.melpa.org/">MELPA Stable</link>, and <link xlink:href="http://orgmode.org/elpa.html">Org ELPA</link>. Nixpkgs is regularly updated to mirror all these archives.
12391 </para>
12492
12593 <para>
126− Under NixOS, you can continue to use
127− <function>package-list-packages</function> and
128− <function>package-install</function> to install packages. You can also
129− declare the set of Emacs packages you need using the derivations from
130− Nixpkgs. The rest of this section discusses declarative installation of
131− Emacs packages through nixpkgs.
94+ Under NixOS, you can continue to use <function>package-list-packages</function> and <function>package-install</function> to install packages. You can also declare the set of Emacs packages you need using the derivations from Nixpkgs. The rest of this section discusses declarative installation of Emacs packages through nixpkgs.
13295 </para>
13396
13497 <para>
135− The first step to declare the list of packages you want in your Emacs
136− installation is to create a dedicated derivation. This can be done in a
137− dedicated <filename>emacs.nix</filename> file such as:
98+ The first step to declare the list of packages you want in your Emacs installation is to create a dedicated derivation. This can be done in a dedicated <filename>emacs.nix</filename> file such as:
13899 <example xml:id="ex-emacsNix">
139100 <title>Nix expression to build Emacs with packages (<filename>emacs.nix</filename>)</title>
140101<programlisting language="nix">
@@ -176,36 +137,27 @@ in
176137 <calloutlist>
177138 <callout arearefs="ex-emacsNix-1">
178139 <para>
179− The first non-comment line in this file (<literal>{ pkgs ? ...
180− }</literal>) indicates that the whole file represents a function.
140+ The first non-comment line in this file (<literal>{ pkgs ? ... }</literal>) indicates that the whole file represents a function.
181141 </para>
182142 </callout>
183143 <callout arearefs="ex-emacsNix-2">
184144 <para>
185− The <varname>let</varname> expression below defines a
186− <varname>myEmacs</varname> binding pointing to the current stable
187− version of Emacs. This binding is here to separate the choice of the
188− Emacs binary from the specification of the required packages.
145+ The <varname>let</varname> expression below defines a <varname>myEmacs</varname> binding pointing to the current stable version of Emacs. This binding is here to separate the choice of the Emacs binary from the specification of the required packages.
189146 </para>
190147 </callout>
191148 <callout arearefs="ex-emacsNix-3">
192149 <para>
193− This generates an <varname>emacsWithPackages</varname> function. It
194− takes a single argument: a function from a package set to a list of
195− packages (the packages that will be available in Emacs).
150+ This generates an <varname>emacsWithPackages</varname> function. It takes a single argument: a function from a package set to a list of packages (the packages that will be available in Emacs).
196151 </para>
197152 </callout>
198153 <callout arearefs="ex-emacsNix-4">
199154 <para>
200− The rest of the file specifies the list of packages to install. In the
201− example, two packages (<varname>magit</varname> and
202− <varname>zerodark-theme</varname>) are taken from MELPA stable.
155+ The rest of the file specifies the list of packages to install. In the example, two packages (<varname>magit</varname> and <varname>zerodark-theme</varname>) are taken from MELPA stable.
203156 </para>
204157 </callout>
205158 <callout arearefs="ex-emacsNix-5">
206159 <para>
207− Two packages (<varname>undo-tree</varname> and
208− <varname>zoom-frm</varname>) are taken from MELPA.
160+ Two packages (<varname>undo-tree</varname> and <varname>zoom-frm</varname>) are taken from MELPA.
209161 </para>
210162 </callout>
211163 <callout arearefs="ex-emacsNix-6">
@@ -215,17 +167,14 @@ in
215167 </callout>
216168 <callout arearefs="ex-emacsNix-7">
217169 <para>
218− <varname>notmuch</varname> is taken from a nixpkgs derivation which
219− contains an Emacs mode.
170+ <varname>notmuch</varname> is taken from a nixpkgs derivation which contains an Emacs mode.
220171 </para>
221172 </callout>
222173 </calloutlist>
223174 </para>
224175
225176 <para>
226− The result of this configuration will be an <command>emacs</command>
227− command which launches Emacs with all of your chosen packages in the
228− <varname>load-path</varname>.
177+ The result of this configuration will be an <command>emacs</command> command which launches Emacs with all of your chosen packages in the <varname>load-path</varname>.
229178 </para>
230179
231180 <para>
@@ -234,23 +183,17 @@ in
234183<prompt>$ </prompt>nix-build emacs.nix
235184<prompt>$ </prompt>./result/bin/emacs -q
236185</screen>
237− and then typing <literal>M-x package-initialize</literal>. Check that you
238− can use all the packages you want in this Emacs instance. For example, try
239− switching to the zerodark theme through <literal>M-x load-theme &lt;RET&gt;
240− zerodark &lt;RET&gt; y</literal>.
186+ and then typing <literal>M-x package-initialize</literal>. Check that you can use all the packages you want in this Emacs instance. For example, try switching to the zerodark theme through <literal>M-x load-theme &lt;RET&gt; zerodark &lt;RET&gt; y</literal>.
241187 </para>
242188
243189 <tip>
244190 <para>
245− A few popular extensions worth checking out are: auctex, company,
246− edit-server, flycheck, helm, iedit, magit, multiple-cursors, projectile,
247− and yasnippet.
191+ A few popular extensions worth checking out are: auctex, company, edit-server, flycheck, helm, iedit, magit, multiple-cursors, projectile, and yasnippet.
248192 </para>
249193 </tip>
250194
251195 <para>
252− The list of available packages in the various ELPA repositories can be seen
253− with the following commands:
196+ The list of available packages in the various ELPA repositories can be seen with the following commands:
254197 <example xml:id="module-services-emacs-querying-packages">
255198 <title>Querying Emacs packages</title>
256199<programlisting><![CDATA[
@@ -263,10 +206,7 @@ nix-env -f "<nixpkgs>" -qaP -A emacsPackages.orgPackages
263206 </para>
264207
265208 <para>
266− If you are on NixOS, you can install this particular Emacs for all users by
267− adding it to the list of system packages (see
268− <xref linkend="sec-declarative-package-mgmt" />). Simply modify your file
269− <filename>configuration.nix</filename> to make it contain:
209+ If you are on NixOS, you can install this particular Emacs for all users by adding it to the list of system packages (see <xref linkend="sec-declarative-package-mgmt" />). Simply modify your file <filename>configuration.nix</filename> to make it contain:
270210 <example xml:id="module-services-emacs-configuration-nix">
271211 <title>Custom Emacs in <filename>configuration.nix</filename></title>
272212<programlisting><![CDATA[
@@ -281,9 +221,7 @@ nix-env -f "<nixpkgs>" -qaP -A emacsPackages.orgPackages
281221 </para>
282222
283223 <para>
284− In this case, the next <command>nixos-rebuild switch</command> will take
285− care of adding your <command>emacs</command> to the <varname>PATH</varname>
286− environment variable (see <xref linkend="sec-changing-config" />).
224+ In this case, the next <command>nixos-rebuild switch</command> will take care of adding your <command>emacs</command> to the <varname>PATH</varname> environment variable (see <xref linkend="sec-changing-config" />).
287225 </para>
288226
289227<!-- fixme: i think the following is better done with config.nix
@@ -291,11 +229,7 @@ https://nixos.org/nixpkgs/manual/#sec-modify-via-packageOverrides
291229-->
292230
293231 <para>
294− If you are not on NixOS or want to install this particular Emacs only for
295− yourself, you can do so by adding it to your
296− <filename>~/.config/nixpkgs/config.nix</filename> (see
297− <link xlink:href="http://nixos.org/nixpkgs/manual/#sec-modify-via-packageOverrides">Nixpkgs
298− manual</link>):
232+ If you are not on NixOS or want to install this particular Emacs only for yourself, you can do so by adding it to your <filename>~/.config/nixpkgs/config.nix</filename> (see <link xlink:href="http://nixos.org/nixpkgs/manual/#sec-modify-via-packageOverrides">Nixpkgs manual</link>):
299233 <example xml:id="module-services-emacs-config-nix">
300234 <title>Custom Emacs in <filename>~/.config/nixpkgs/config.nix</filename></title>
301235<programlisting><![CDATA[
@@ -309,9 +243,7 @@ https://nixos.org/nixpkgs/manual/#sec-modify-via-packageOverrides
309243 </para>
310244
311245 <para>
312− In this case, the next <literal>nix-env -f '&lt;nixpkgs&gt;' -iA
313− myemacs</literal> will take care of adding your emacs to the
314− <varname>PATH</varname> environment variable.
246+ In this case, the next <literal>nix-env -f '&lt;nixpkgs&gt;' -iA myemacs</literal> will take care of adding your emacs to the <varname>PATH</varname> environment variable.
315247 </para>
316248 </section>
317249
@@ -319,12 +251,7 @@ https://nixos.org/nixpkgs/manual/#sec-modify-via-packageOverrides
319251 <title>Advanced Emacs Configuration</title>
320252
321253 <para>
322− If you want, you can tweak the Emacs package itself from your
323− <filename>emacs.nix</filename>. For example, if you want to have a
324− GTK 3-based Emacs instead of the default GTK 2-based binary and remove the
325− automatically generated <filename>emacs.desktop</filename> (useful is you
326− only use <command>emacsclient</command>), you can change your file
327− <filename>emacs.nix</filename> in this way:
254+ If you want, you can tweak the Emacs package itself from your <filename>emacs.nix</filename>. For example, if you want to have a GTK 3-based Emacs instead of the default GTK 2-based binary and remove the automatically generated <filename>emacs.desktop</filename> (useful is you only use <command>emacsclient</command>), you can change your file <filename>emacs.nix</filename> in this way:
328255 </para>
329256
330257 <example xml:id="ex-emacsGtk3Nix">
@@ -348,8 +275,7 @@ in [...]
348275 </example>
349276
350277 <para>
351− After building this file as shown in <xref linkend="ex-emacsNix" />, you
352− will get an GTK 3-based Emacs binary pre-loaded with your favorite packages.
278+ After building this file as shown in <xref linkend="ex-emacsNix" />, you will get an GTK 3-based Emacs binary pre-loaded with your favorite packages.
353279 </para>
354280 </section>
355281 </section>
@@ -357,23 +283,18 @@ in [...]
357283 <title>Running Emacs as a Service</title>
358284
359285 <para>
360− <productname>NixOS</productname> provides an optional
361− <command>systemd</command> service which launches
362− <link xlink:href="https://www.gnu.org/software/emacs/manual/html_node/emacs/Emacs-Server.html">
363− Emacs daemon </link> with the user's login session.
286+ <productname>NixOS</productname> provides an optional <command>systemd</command> service which launches <link xlink:href="https://www.gnu.org/software/emacs/manual/html_node/emacs/Emacs-Server.html"> Emacs daemon </link> with the user's login session.
364287 </para>
365288
366289 <para>
367− <emphasis>Source:</emphasis>
368− <filename>modules/services/editors/emacs.nix</filename>
290+ <emphasis>Source:</emphasis> <filename>modules/services/editors/emacs.nix</filename>
369291 </para>
370292
371293 <section xml:id="module-services-emacs-enabling">
372294 <title>Enabling the Service</title>
373295
374296 <para>
375− To install and enable the <command>systemd</command> user service for Emacs
376− daemon, add the following to your <filename>configuration.nix</filename>:
297+ To install and enable the <command>systemd</command> user service for Emacs daemon, add the following to your <filename>configuration.nix</filename>:
377298<programlisting>
378299<xref linkend="opt-services.emacs.enable"/> = true;
379300<xref linkend="opt-services.emacs.package"/> = import /home/cassou/.emacs.d { pkgs = pkgs; };
@@ -381,16 +302,11 @@ in [...]
381302 </para>
382303
383304 <para>
384− The <varname>services.emacs.package</varname> option allows a custom
385− derivation to be used, for example, one created by
386− <function>emacsWithPackages</function>.
305+ The <varname>services.emacs.package</varname> option allows a custom derivation to be used, for example, one created by <function>emacsWithPackages</function>.
387306 </para>
388307
389308 <para>
390− Ensure that the Emacs server is enabled for your user's Emacs
391− configuration, either by customizing the <varname>server-mode</varname>
392− variable, or by adding <literal>(server-start)</literal> to
393− <filename>~/.emacs.d/init.el</filename>.
309+ Ensure that the Emacs server is enabled for your user's Emacs configuration, either by customizing the <varname>server-mode</varname> variable, or by adding <literal>(server-start)</literal> to <filename>~/.emacs.d/init.el</filename>.
394310 </para>
395311
396312 <para>
@@ -408,9 +324,7 @@ in [...]
408324 <title>Starting the client</title>
409325
410326 <para>
411− Ensure that the emacs server is enabled, either by customizing the
412− <varname>server-mode</varname> variable, or by adding
413− <literal>(server-start)</literal> to <filename>~/.emacs</filename>.
327+ Ensure that the emacs server is enabled, either by customizing the <varname>server-mode</varname> variable, or by adding <literal>(server-start)</literal> to <filename>~/.emacs</filename>.
414328 </para>
415329
416330 <para>
@@ -429,23 +343,15 @@ emacsclient --create-frame --tty # opens a new frame on the current terminal
429343<!--<title><command>emacsclient</command> as the Default Editor</title>-->
430344
431345 <para>
432− If <xref linkend="opt-services.emacs.defaultEditor"/> is
433− <literal>true</literal>, the <varname>EDITOR</varname> variable will be set
434− to a wrapper script which launches <command>emacsclient</command>.
346+ If <xref linkend="opt-services.emacs.defaultEditor"/> is <literal>true</literal>, the <varname>EDITOR</varname> variable will be set to a wrapper script which launches <command>emacsclient</command>.
435347 </para>
436348
437349 <para>
438− Any setting of <varname>EDITOR</varname> in the shell config files will
439− override <varname>services.emacs.defaultEditor</varname>. To make sure
440− <varname>EDITOR</varname> refers to the Emacs wrapper script, remove any
441− existing <varname>EDITOR</varname> assignment from
442− <filename>.profile</filename>, <filename>.bashrc</filename>,
443− <filename>.zshenv</filename> or any other shell config file.
350+ Any setting of <varname>EDITOR</varname> in the shell config files will override <varname>services.emacs.defaultEditor</varname>. To make sure <varname>EDITOR</varname> refers to the Emacs wrapper script, remove any existing <varname>EDITOR</varname> assignment from <filename>.profile</filename>, <filename>.bashrc</filename>, <filename>.zshenv</filename> or any other shell config file.
444351 </para>
445352
446353 <para>
447− If you have formed certain bad habits when editing files, these can be
448− corrected with a shell alias to the wrapper script:
354+ If you have formed certain bad habits when editing files, these can be corrected with a shell alias to the wrapper script:
449355<programlisting>alias vi=$EDITOR</programlisting>
450356 </para>
451357 </section>
@@ -454,10 +360,7 @@ emacsclient --create-frame --tty # opens a new frame on the current terminal
454360 <title>Per-User Enabling of the Service</title>
455361
456362 <para>
457− In general, <command>systemd</command> user services are globally enabled
458− by symlinks in <filename>/etc/systemd/user</filename>. In the case where
459− Emacs daemon is not wanted for all users, it is possible to install the
460− service but not globally enable it:
363+ In general, <command>systemd</command> user services are globally enabled by symlinks in <filename>/etc/systemd/user</filename>. In the case where Emacs daemon is not wanted for all users, it is possible to install the service but not globally enable it:
461364<programlisting>
462365<xref linkend="opt-services.emacs.enable"/> = false;
463366<xref linkend="opt-services.emacs.install"/> = true;
@@ -465,11 +368,9 @@ emacsclient --create-frame --tty # opens a new frame on the current terminal
465368 </para>
466369
467370 <para>
468− To enable the <command>systemd</command> user service for just the
469− currently logged in user, run:
371+ To enable the <command>systemd</command> user service for just the currently logged in user, run:
470372<programlisting>systemctl --user enable emacs</programlisting>
471− This will add the symlink
472− <filename>~/.config/systemd/user/emacs.service</filename>.
373+ This will add the symlink <filename>~/.config/systemd/user/emacs.service</filename>.
473374 </para>
474375 </section>
475376 </section>
@@ -477,8 +378,7 @@ emacsclient --create-frame --tty # opens a new frame on the current terminal
477378 <title>Configuring Emacs</title>
478379
479380 <para>
480− The Emacs init file should be changed to load the extension packages at
481− startup:
381+ The Emacs init file should be changed to load the extension packages at startup:
482382 <example xml:id="module-services-emacs-package-initialisation">
483383 <title>Package initialization in <filename>.emacs</filename></title>
484384<programlisting><![CDATA[
@@ -494,10 +394,7 @@ emacsclient --create-frame --tty # opens a new frame on the current terminal
494394 </para>
495395
496396 <para>
497− After the declarative emacs package configuration has been tested,
498− previously downloaded packages can be cleaned up by removing
499− <filename>~/.emacs.d/elpa</filename> (do make a backup first, in case you
500− forgot a package).
397+ After the declarative emacs package configuration has been tested, previously downloaded packages can be cleaned up by removing <filename>~/.emacs.d/elpa</filename> (do make a backup first, in case you forgot a package).
501398 </para>
502399
503400<!--
@@ -509,9 +406,7 @@ emacsclient --create-frame --tty # opens a new frame on the current terminal
509406 <title>A Major Mode for Nix Expressions</title>
510407
511408 <para>
512− Of interest may be <varname>melpaPackages.nix-mode</varname>, which
513− provides syntax highlighting for the Nix language. This is particularly
514− convenient if you regularly edit Nix files.
409+ Of interest may be <varname>melpaPackages.nix-mode</varname>, which provides syntax highlighting for the Nix language. This is particularly convenient if you regularly edit Nix files.
515410 </para>
516411 </section>
517412
@@ -519,9 +414,7 @@ emacsclient --create-frame --tty # opens a new frame on the current terminal
519414 <title>Accessing man pages</title>
520415
521416 <para>
522− You can use <function>woman</function> to get completion of all available
523− man pages. For example, type <literal>M-x woman &lt;RET&gt; nixos-rebuild
524− &lt;RET&gt;.</literal>
417+ You can use <function>woman</function> to get completion of all available man pages. For example, type <literal>M-x woman &lt;RET&gt; nixos-rebuild &lt;RET&gt;.</literal>
525418 </para>
526419 </section>
527420
@@ -529,29 +422,17 @@ emacsclient --create-frame --tty # opens a new frame on the current terminal
529422 <title>Editing DocBook 5 XML Documents</title>
530423
531424 <para>
532− Emacs includes
533− <link
534− xlink:href="https://www.gnu.org/software/emacs/manual/html_node/nxml-mode/Introduction.html">nXML</link>,
535− a major-mode for validating and editing XML documents. When editing DocBook
536− 5.0 documents, such as <link linkend="book-nixos-manual">this one</link>,
537− nXML needs to be configured with the relevant schema, which is not
538− included.
425+ Emacs includes <link
426+ xlink:href="https://www.gnu.org/software/emacs/manual/html_node/nxml-mode/Introduction.html">nXML</link>, a major-mode for validating and editing XML documents. When editing DocBook 5.0 documents, such as <link linkend="book-nixos-manual">this one</link>, nXML needs to be configured with the relevant schema, which is not included.
539427 </para>
540428
541429 <para>
542− To install the DocBook 5.0 schemas, either add
543− <varname>pkgs.docbook5</varname> to
544− <xref linkend="opt-environment.systemPackages"/>
545− (<link
546− linkend="sec-declarative-package-mgmt">NixOS</link>), or run
547− <literal>nix-env -f '&lt;nixpkgs&gt;' -iA docbook5</literal>
548− (<link linkend="sec-ad-hoc-packages">Nix</link>).
430+ To install the DocBook 5.0 schemas, either add <varname>pkgs.docbook5</varname> to <xref linkend="opt-environment.systemPackages"/> (<link
431+ linkend="sec-declarative-package-mgmt">NixOS</link>), or run <literal>nix-env -f '&lt;nixpkgs&gt;' -iA docbook5</literal> (<link linkend="sec-ad-hoc-packages">Nix</link>).
549432 </para>
550433
551434 <para>
552− Then customize the variable <varname>rng-schema-locating-files</varname> to
553− include <filename>~/.emacs.d/schemas.xml</filename> and put the following
554− text into that file:
435+ Then customize the variable <varname>rng-schema-locating-files</varname> to include <filename>~/.emacs.d/schemas.xml</filename> and put the following text into that file:
555436 <example xml:id="ex-emacs-docbook-xml">
556437 <title>nXML Schema Configuration (<filename>~/.emacs.d/schemas.xml</filename>)</title>
557438<programlisting language="xml"><![CDATA[
nixos/modules/services/hardware/trezord.xml+2−8
@@ -5,16 +5,10 @@
55 xml:id="trezor">
66 <title>Trezor</title>
77 <para>
8− Trezor is an open-source cryptocurrency hardware wallet and security token
9− allowing secure storage of private keys.
8+ Trezor is an open-source cryptocurrency hardware wallet and security token allowing secure storage of private keys.
109 </para>
1110 <para>
12− It offers advanced features such U2F two-factor authorization, SSH login
13− through
14− <link xlink:href="https://wiki.trezor.io/Apps:SSH_agent">Trezor SSH agent</link>,
15− <link xlink:href="https://wiki.trezor.io/GPG">GPG</link> and a
16− <link xlink:href="https://wiki.trezor.io/Trezor_Password_Manager">password manager</link>.
17− For more information, guides and documentation, see <link xlink:href="https://wiki.trezor.io"/>.
11+ It offers advanced features such U2F two-factor authorization, SSH login through <link xlink:href="https://wiki.trezor.io/Apps:SSH_agent">Trezor SSH agent</link>, <link xlink:href="https://wiki.trezor.io/GPG">GPG</link> and a <link xlink:href="https://wiki.trezor.io/Trezor_Password_Manager">password manager</link>. For more information, guides and documentation, see <link xlink:href="https://wiki.trezor.io"/>.
1812 </para>
1913 <para>
2014 To enable Trezor support, add the following to your <filename>configuration.nix</filename>:
nixos/modules/services/misc/gitlab.xml+8−26
@@ -11,14 +11,11 @@
1111 <title>Prerequisites</title>
1212
1313 <para>
14− The gitlab service exposes only an Unix socket at
15− <literal>/run/gitlab/gitlab-workhorse.socket</literal>. You need to
16− configure a webserver to proxy HTTP requests to the socket.
14+ The gitlab service exposes only an Unix socket at <literal>/run/gitlab/gitlab-workhorse.socket</literal>. You need to configure a webserver to proxy HTTP requests to the socket.
1715 </para>
1816
1917 <para>
20− For instance, the following configuration could be used to use nginx as
21− frontend proxy:
18+ For instance, the following configuration could be used to use nginx as frontend proxy:
2219<programlisting>
2320<link linkend="opt-services.nginx.enable">services.nginx</link> = {
2421 <link linkend="opt-services.nginx.enable">enable</link> = true;
@@ -39,14 +36,11 @@
3936 <title>Configuring</title>
4037
4138 <para>
42− Gitlab depends on both PostgreSQL and Redis and will automatically enable
43− both services. In the case of PostgreSQL, a database and a role will be
44− created.
39+ Gitlab depends on both PostgreSQL and Redis and will automatically enable both services. In the case of PostgreSQL, a database and a role will be created.
4540 </para>
4641
4742 <para>
48− The default state dir is <literal>/var/gitlab/state</literal>. This is where
49− all data like the repositories and uploads will be stored.
43+ The default state dir is <literal>/var/gitlab/state</literal>. This is where all data like the repositories and uploads will be stored.
5044 </para>
5145
5246 <para>
@@ -85,31 +79,19 @@ services.gitlab = {
8579 </para>
8680
8781 <para>
88− If you're setting up a new Gitlab instance, generate new
89− secrets. You for instance use <literal>tr -dc A-Za-z0-9 &lt;
90− /dev/urandom | head -c 128 &gt; /var/keys/gitlab/db</literal> to
91− generate a new db secret. Make sure the files can be read by, and
92− only by, the user specified by <link
93− linkend="opt-services.gitlab.user">services.gitlab.user</link>. Gitlab
94− encrypts sensitive data stored in the database. If you're restoring
95− an existing Gitlab instance, you must specify the secrets secret
96− from <literal>config/secrets.yml</literal> located in your Gitlab
97− state folder.
82+ If you're setting up a new Gitlab instance, generate new secrets. You for instance use <literal>tr -dc A-Za-z0-9 &lt; /dev/urandom | head -c 128 &gt; /var/keys/gitlab/db</literal> to generate a new db secret. Make sure the files can be read by, and only by, the user specified by <link
83+ linkend="opt-services.gitlab.user">services.gitlab.user</link>. Gitlab encrypts sensitive data stored in the database. If you're restoring an existing Gitlab instance, you must specify the secrets secret from <literal>config/secrets.yml</literal> located in your Gitlab state folder.
9884 </para>
9985
10086 <para>
101− Refer to <xref linkend="ch-options" /> for all available configuration
102− options for the
103− <link linkend="opt-services.gitlab.enable">services.gitlab</link> module.
87+ Refer to <xref linkend="ch-options" /> for all available configuration options for the <link linkend="opt-services.gitlab.enable">services.gitlab</link> module.
10488 </para>
10589 </section>
10690 <section xml:id="module-services-gitlab-maintenance">
10791 <title>Maintenance</title>
10892
10993 <para>
110− You can run Gitlab's rake tasks with <literal>gitlab-rake</literal> which
111− will be available on the system when gitlab is enabled. You will have to run
112− the command as the user that you configured to run gitlab with.
94+ You can run Gitlab's rake tasks with <literal>gitlab-rake</literal> which will be available on the system when gitlab is enabled. You will have to run the command as the user that you configured to run gitlab with.
11395 </para>
11496
11597 <para>
nixos/modules/services/misc/taskserver/doc.xml+18−56
@@ -4,87 +4,58 @@
44 xml:id="module-taskserver">
55 <title>Taskserver</title>
66 <para>
7− Taskserver is the server component of
8− <link xlink:href="https://taskwarrior.org/">Taskwarrior</link>, a free and
9− open source todo list application.
7+ Taskserver is the server component of <link xlink:href="https://taskwarrior.org/">Taskwarrior</link>, a free and open source todo list application.
108 </para>
119 <para>
12− <emphasis>Upstream documentation:</emphasis>
13− <link xlink:href="https://taskwarrior.org/docs/#taskd"/>
10+ <emphasis>Upstream documentation:</emphasis> <link xlink:href="https://taskwarrior.org/docs/#taskd"/>
1411 </para>
1512 <section xml:id="module-services-taskserver-configuration">
1613 <title>Configuration</title>
1714
1815 <para>
19− Taskserver does all of its authentication via TLS using client certificates,
20− so you either need to roll your own CA or purchase a certificate from a
21− known CA, which allows creation of client certificates. These certificates
22− are usually advertised as <quote>server certificates</quote>.
16+ Taskserver does all of its authentication via TLS using client certificates, so you either need to roll your own CA or purchase a certificate from a known CA, which allows creation of client certificates. These certificates are usually advertised as <quote>server certificates</quote>.
2317 </para>
2418
2519 <para>
26− So in order to make it easier to handle your own CA, there is a helper tool
27− called <command>nixos-taskserver</command> which manages the custom CA along
28− with Taskserver organisations, users and groups.
20+ So in order to make it easier to handle your own CA, there is a helper tool called <command>nixos-taskserver</command> which manages the custom CA along with Taskserver organisations, users and groups.
2921 </para>
3022
3123 <para>
32− While the client certificates in Taskserver only authenticate whether a user
33− is allowed to connect, every user has its own UUID which identifies it as an
34− entity.
24+ While the client certificates in Taskserver only authenticate whether a user is allowed to connect, every user has its own UUID which identifies it as an entity.
3525 </para>
3626
3727 <para>
38− With <command>nixos-taskserver</command> the client certificate is created
39− along with the UUID of the user, so it handles all of the credentials needed
40− in order to setup the Taskwarrior client to work with a Taskserver.
28+ With <command>nixos-taskserver</command> the client certificate is created along with the UUID of the user, so it handles all of the credentials needed in order to setup the Taskwarrior client to work with a Taskserver.
4129 </para>
4230 </section>
4331 <section xml:id="module-services-taskserver-nixos-taskserver-tool">
4432 <title>The nixos-taskserver tool</title>
4533
4634 <para>
47− Because Taskserver by default only provides scripts to setup users
48− imperatively, the <command>nixos-taskserver</command> tool is used for
49− addition and deletion of organisations along with users and groups defined
50− by <xref linkend="opt-services.taskserver.organisations"/> and as well for
51− imperative set up.
35+ Because Taskserver by default only provides scripts to setup users imperatively, the <command>nixos-taskserver</command> tool is used for addition and deletion of organisations along with users and groups defined by <xref linkend="opt-services.taskserver.organisations"/> and as well for imperative set up.
5236 </para>
5337
5438 <para>
55− The tool is designed to not interfere if the command is used to manually set
56− up some organisations, users or groups.
39+ The tool is designed to not interfere if the command is used to manually set up some organisations, users or groups.
5740 </para>
5841
5942 <para>
60− For example if you add a new organisation using <command>nixos-taskserver
61− org add foo</command>, the organisation is not modified and deleted no
62− matter what you define in
63− <option>services.taskserver.organisations</option>, even if you're adding
64− the same organisation in that option.
43+ For example if you add a new organisation using <command>nixos-taskserver org add foo</command>, the organisation is not modified and deleted no matter what you define in <option>services.taskserver.organisations</option>, even if you're adding the same organisation in that option.
6544 </para>
6645
6746 <para>
68− The tool is modelled to imitate the official <command>taskd</command>
69− command, documentation for each subcommand can be shown by using the
70− <option>--help</option> switch.
47+ The tool is modelled to imitate the official <command>taskd</command> command, documentation for each subcommand can be shown by using the <option>--help</option> switch.
7148 </para>
7249 </section>
7350 <section xml:id="module-services-taskserver-declarative-ca-management">
7451 <title>Declarative/automatic CA management</title>
7552
7653 <para>
77− Everything is done according to what you specify in the module options,
78− however in order to set up a Taskwarrior client for synchronisation with a
79− Taskserver instance, you have to transfer the keys and certificates to the
80− client machine.
54+ Everything is done according to what you specify in the module options, however in order to set up a Taskwarrior client for synchronisation with a Taskserver instance, you have to transfer the keys and certificates to the client machine.
8155 </para>
8256
8357 <para>
84− This is done using <command>nixos-taskserver user export $orgname
85− $username</command> which is printing a shell script fragment to stdout
86− which can either be used verbatim or adjusted to import the user on the
87− client machine.
58+ This is done using <command>nixos-taskserver user export $orgname $username</command> which is printing a shell script fragment to stdout which can either be used verbatim or adjusted to import the user on the client machine.
8859 </para>
8960
9061 <para>
@@ -97,39 +68,30 @@
9768 <link linkend="opt-services.taskserver.organisations._name_.users">services.taskserver.organisations.my-company.users</link> = [ "alice" ];
9869}
9970</screen>
100− This creates an organisation called <literal>my-company</literal> with the
101− user <literal>alice</literal>.
71+ This creates an organisation called <literal>my-company</literal> with the user <literal>alice</literal>.
10272 </para>
10373
10474 <para>
105− Now in order to import the <literal>alice</literal> user to another machine
106− <literal>alicebox</literal>, all we need to do is something like this:
75+ Now in order to import the <literal>alice</literal> user to another machine <literal>alicebox</literal>, all we need to do is something like this:
10776<screen>
10877<prompt>$ </prompt>ssh server nixos-taskserver user export my-company alice | sh
10978</screen>
110− Of course, if no SSH daemon is available on the server you can also copy
111− &amp; paste it directly into a shell.
79+ Of course, if no SSH daemon is available on the server you can also copy &amp; paste it directly into a shell.
11280 </para>
11381
11482 <para>
115− After this step the user should be set up and you can start synchronising
116− your tasks for the first time with <command>task sync init</command> on
117− <literal>alicebox</literal>.
83+ After this step the user should be set up and you can start synchronising your tasks for the first time with <command>task sync init</command> on <literal>alicebox</literal>.
11884 </para>
11985
12086 <para>
121− Subsequent synchronisation requests merely require the command <command>task
122− sync</command> after that stage.
87+ Subsequent synchronisation requests merely require the command <command>task sync</command> after that stage.
12388 </para>
12489 </section>
12590 <section xml:id="module-services-taskserver-manual-ca-management">
12691 <title>Manual CA management</title>
12792
12893 <para>
129− If you set any options within
130− <link linkend="opt-services.taskserver.pki.manual.ca.cert">service.taskserver.pki.manual</link>.*,
131− <command>nixos-taskserver</command> won't issue certificates, but you can
132− still use it for adding or removing user accounts.
94+ If you set any options within <link linkend="opt-services.taskserver.pki.manual.ca.cert">service.taskserver.pki.manual</link>.*, <command>nixos-taskserver</command> won't issue certificates, but you can still use it for adding or removing user accounts.
13395 </para>
13496 </section>
13597</chapter>
nixos/modules/services/misc/weechat.xml+5−16
@@ -5,18 +5,13 @@
55 xml:id="module-services-weechat">
66 <title>WeeChat</title>
77 <para>
8− <link xlink:href="https://weechat.org/">WeeChat</link> is a fast and
9− extensible IRC client.
8+ <link xlink:href="https://weechat.org/">WeeChat</link> is a fast and extensible IRC client.
109 </para>
1110 <section xml:id="module-services-weechat-basic-usage">
1211 <title>Basic Usage</title>
1312
1413 <para>
15− By default, the module creates a
16− <literal><link xlink:href="https://www.freedesktop.org/wiki/Software/systemd/">systemd</link></literal>
17− unit which runs the chat client in a detached
18− <literal><link xlink:href="https://www.gnu.org/software/screen/">screen</link></literal>
19− session.
14+ By default, the module creates a <literal><link xlink:href="https://www.freedesktop.org/wiki/Software/systemd/">systemd</link></literal> unit which runs the chat client in a detached <literal><link xlink:href="https://www.gnu.org/software/screen/">screen</link></literal> session.
2015 </para>
2116
2217 <para>
@@ -31,19 +26,14 @@
3126 </para>
3227
3328 <para>
34− The service is managed by a dedicated user named <literal>weechat</literal>
35− in the state directory <literal>/var/lib/weechat</literal>.
29+ The service is managed by a dedicated user named <literal>weechat</literal> in the state directory <literal>/var/lib/weechat</literal>.
3630 </para>
3731 </section>
3832 <section xml:id="module-services-weechat-reattach">
3933 <title>Re-attaching to WeeChat</title>
4034
4135 <para>
42− WeeChat runs in a screen session owned by a dedicated user. To explicitly
43− allow your another user to attach to this session, the
44− <literal>screenrc</literal> needs to be tweaked by adding
45− <link xlink:href="https://www.gnu.org/software/screen/manual/html_node/Multiuser.html#Multiuser">multiuser</link>
46− support:
36+ WeeChat runs in a screen session owned by a dedicated user. To explicitly allow your another user to attach to this session, the <literal>screenrc</literal> needs to be tweaked by adding <link xlink:href="https://www.gnu.org/software/screen/manual/html_node/Multiuser.html#Multiuser">multiuser</link> support:
4737<programlisting>
4838{
4939 <link linkend="opt-programs.screen.screenrc">programs.screen.screenrc</link> = ''
@@ -59,8 +49,7 @@ screen -x weechat/weechat-screen
5949 </para>
6050
6151 <para>
62− <emphasis>The session name can be changed using
63− <link linkend="opt-services.weechat.sessionName">services.weechat.sessionName.</link></emphasis>
52+ <emphasis>The session name can be changed using <link linkend="opt-services.weechat.sessionName">services.weechat.sessionName.</link></emphasis>
6453 </para>
6554 </section>
6655</chapter>
nixos/modules/services/monitoring/prometheus/exporters.xml+12−39
@@ -5,17 +5,13 @@
55 xml:id="module-services-prometheus-exporters">
66 <title>Prometheus exporters</title>
77 <para>
8− Prometheus exporters provide metrics for the
9− <link xlink:href="https://prometheus.io">prometheus monitoring system</link>.
8+ Prometheus exporters provide metrics for the <link xlink:href="https://prometheus.io">prometheus monitoring system</link>.
109 </para>
1110 <section xml:id="module-services-prometheus-exporters-configuration">
1211 <title>Configuration</title>
1312
1413 <para>
15− One of the most common exporters is the
16− <link xlink:href="https://github.com/prometheus/node_exporter">node
17− exporter</link>, it provides hardware and OS metrics from the host it's
18− running on. The exporter could be configured as follows:
14+ One of the most common exporters is the <link xlink:href="https://github.com/prometheus/node_exporter">node exporter</link>, it provides hardware and OS metrics from the host it's running on. The exporter could be configured as follows:
1915<programlisting>
2016 services.prometheus.exporters.node = {
2117 enable = true;
@@ -30,34 +26,20 @@
3026 firewallFilter = "-i br0 -p tcp -m tcp --dport 9100";
3127 };
3228</programlisting>
33− It should now serve all metrics from the collectors that are explicitly
34− enabled and the ones that are
35− <link xlink:href="https://github.com/prometheus/node_exporter#enabled-by-default">enabled
36− by default</link>, via http under <literal>/metrics</literal>. In this
37− example the firewall should just allow incoming connections to the
38− exporter's port on the bridge interface <literal>br0</literal> (this would
39− have to be configured seperately of course). For more information about
40− configuration see <literal>man configuration.nix</literal> or search through
41− the
42− <link xlink:href="https://nixos.org/nixos/options.html#prometheus.exporters">available
43− options</link>.
29+ It should now serve all metrics from the collectors that are explicitly enabled and the ones that are <link xlink:href="https://github.com/prometheus/node_exporter#enabled-by-default">enabled by default</link>, via http under <literal>/metrics</literal>. In this example the firewall should just allow incoming connections to the exporter's port on the bridge interface <literal>br0</literal> (this would have to be configured seperately of course). For more information about configuration see <literal>man configuration.nix</literal> or search through the <link xlink:href="https://nixos.org/nixos/options.html#prometheus.exporters">available options</link>.
4430 </para>
4531 </section>
4632 <section xml:id="module-services-prometheus-exporters-new-exporter">
4733 <title>Adding a new exporter</title>
4834
4935 <para>
50− To add a new exporter, it has to be packaged first (see
51− <literal>nixpkgs/pkgs/servers/monitoring/prometheus/</literal> for
52− examples), then a module can be added. The postfix exporter is used in this
53− example:
36+ To add a new exporter, it has to be packaged first (see <literal>nixpkgs/pkgs/servers/monitoring/prometheus/</literal> for examples), then a module can be added. The postfix exporter is used in this example:
5437 </para>
5538
5639 <itemizedlist>
5740 <listitem>
5841 <para>
59− Some default options for all exporters are provided by
60− <literal>nixpkgs/nixos/modules/services/monitoring/prometheus/exporters.nix</literal>:
42+ Some default options for all exporters are provided by <literal>nixpkgs/nixos/modules/services/monitoring/prometheus/exporters.nix</literal>:
6143 </para>
6244 </listitem>
6345 <listitem override='none'>
@@ -106,11 +88,7 @@
10688 </listitem>
10789 <listitem>
10890 <para>
109− As there is already a package available, the module can now be added. This
110− is accomplished by adding a new file to the
111− <literal>nixos/modules/services/monitoring/prometheus/exporters/</literal>
112− directory, which will be called postfix.nix and contains all exporter
113− specific options and configuration:
91+ As there is already a package available, the module can now be added. This is accomplished by adding a new file to the <literal>nixos/modules/services/monitoring/prometheus/exporters/</literal> directory, which will be called postfix.nix and contains all exporter specific options and configuration:
11492<programlisting>
11593# nixpgs/nixos/modules/services/prometheus/exporters/postfix.nix
11694{ config, lib, pkgs, options }:
@@ -177,21 +155,16 @@ in
177155 </listitem>
178156 <listitem>
179157 <para>
180− This should already be enough for the postfix exporter. Additionally one
181− could now add assertions and conditional default values. This can be done
182− in the 'meta-module' that combines all exporter definitions and generates
183− the submodules:
184− <literal>nixpkgs/nixos/modules/services/prometheus/exporters.nix</literal>
158+ This should already be enough for the postfix exporter. Additionally one could now add assertions and conditional default values. This can be done in the 'meta-module' that combines all exporter definitions and generates the submodules: <literal>nixpkgs/nixos/modules/services/prometheus/exporters.nix</literal>
185159 </para>
186160 </listitem>
187161 </itemizedlist>
188162 </section>
189163 <section xml:id="module-services-prometheus-exporters-update-exporter-module">
190164 <title>Updating an exporter module</title>
191− <para>
192− Should an exporter option change at some point, it is possible to add
193− information about the change to the exporter definition similar to
194− <literal>nixpkgs/nixos/modules/rename.nix</literal>:
165+
166+ <para>
167+ Should an exporter option change at some point, it is possible to add information about the change to the exporter definition similar to <literal>nixpkgs/nixos/modules/rename.nix</literal>:
195168<programlisting>
196169{ config, lib, pkgs, options }:
197170
@@ -222,6 +195,6 @@ in
222195 ];
223196}
224197</programlisting>
225− </para>
226− </section>
198+ </para>
199+ </section>
227200</chapter>
nixos/modules/services/networking/dnscrypt-proxy.xml+3−11
@@ -5,11 +5,7 @@
55 xml:id="sec-dnscrypt-proxy">
66 <title>DNSCrypt client proxy</title>
77 <para>
8− The DNSCrypt client proxy relays DNS queries to a DNSCrypt enabled upstream
9− resolver. The traffic between the client and the upstream resolver is
10− encrypted and authenticated, mitigating the risk of MITM attacks, DNS
11− poisoning attacks, and third-party snooping (assuming the upstream is
12− trustworthy).
8+ The DNSCrypt client proxy relays DNS queries to a DNSCrypt enabled upstream resolver. The traffic between the client and the upstream resolver is encrypted and authenticated, mitigating the risk of MITM attacks, DNS poisoning attacks, and third-party snooping (assuming the upstream is trustworthy).
139 </para>
1410 <sect1 xml:id="sec-dnscrypt-proxy-configuration">
1511 <title>Basic configuration</title>
@@ -22,18 +18,14 @@
2218 </para>
2319
2420 <para>
25− Enabling the client proxy does not alter the system nameserver; to relay
26− local queries, prepend <literal>127.0.0.1</literal> to
27− <option>networking.nameservers</option>.
21+ Enabling the client proxy does not alter the system nameserver; to relay local queries, prepend <literal>127.0.0.1</literal> to <option>networking.nameservers</option>.
2822 </para>
2923 </sect1>
3024 <sect1 xml:id="sec-dnscrypt-proxy-forwarder">
3125 <title>As a forwarder for another DNS client</title>
3226
3327 <para>
34− To run the DNSCrypt proxy client as a forwarder for another DNS client,
35− change the default proxy listening port to a non-standard value and point
36− the other client to it:
28+ To run the DNSCrypt proxy client as a forwarder for another DNS client, change the default proxy listening port to a non-standard value and point the other client to it:
3729<programlisting>
3830<xref linkend="opt-services.dnscrypt-proxy.localPort"/> = 43;
3931</programlisting>
nixos/modules/services/web-apps/matomo-doc.xml+11−45
@@ -5,21 +5,16 @@
55 xml:id="module-services-matomo">
66 <title>Matomo</title>
77 <para>
8− Matomo is a real-time web analytics application. This module configures
9− php-fpm as backend for Matomo, optionally configuring an nginx vhost as well.
8+ Matomo is a real-time web analytics application. This module configures php-fpm as backend for Matomo, optionally configuring an nginx vhost as well.
109 </para>
1110 <para>
12− An automatic setup is not suported by Matomo, so you need to configure Matomo
13− itself in the browser-based Matomo setup.
11+ An automatic setup is not suported by Matomo, so you need to configure Matomo itself in the browser-based Matomo setup.
1412 </para>
1513 <section xml:id="module-services-matomo-database-setup">
1614 <title>Database Setup</title>
1715
1816 <para>
19− You also need to configure a MariaDB or MySQL database and -user for Matomo
20− yourself, and enter those credentials in your browser. You can use
21− passwordless database authentication via the UNIX_SOCKET authentication
22− plugin with the following SQL commands:
17+ You also need to configure a MariaDB or MySQL database and -user for Matomo yourself, and enter those credentials in your browser. You can use passwordless database authentication via the UNIX_SOCKET authentication plugin with the following SQL commands:
2318<programlisting>
2419# For MariaDB
2520INSTALL PLUGIN unix_socket SONAME 'auth_socket';
@@ -33,51 +28,29 @@ CREATE DATABASE matomo;
3328CREATE USER 'matomo'@'localhost' IDENTIFIED WITH auth_socket;
3429GRANT ALL PRIVILEGES ON matomo.* TO 'matomo'@'localhost';
3530</programlisting>
36− Then fill in <literal>matomo</literal> as database user and database name,
37− and leave the password field blank. This authentication works by allowing
38− only the <literal>matomo</literal> unix user to authenticate as the
39− <literal>matomo</literal> database user (without needing a password), but no
40− other users. For more information on passwordless login, see
41− <link xlink:href="https://mariadb.com/kb/en/mariadb/unix_socket-authentication-plugin/" />.
31+ Then fill in <literal>matomo</literal> as database user and database name, and leave the password field blank. This authentication works by allowing only the <literal>matomo</literal> unix user to authenticate as the <literal>matomo</literal> database user (without needing a password), but no other users. For more information on passwordless login, see <link xlink:href="https://mariadb.com/kb/en/mariadb/unix_socket-authentication-plugin/" />.
4232 </para>
4333
4434 <para>
45− Of course, you can use password based authentication as well, e.g. when the
46− database is not on the same host.
35+ Of course, you can use password based authentication as well, e.g. when the database is not on the same host.
4736 </para>
4837 </section>
4938 <section xml:id="module-services-matomo-archive-processing">
5039 <title>Archive Processing</title>
5140
5241 <para>
53− This module comes with the systemd service
54− <literal>matomo-archive-processing.service</literal> and a timer that
55− automatically triggers archive processing every hour. This means that you
56− can safely
57− <link xlink:href="https://matomo.org/docs/setup-auto-archiving/#disable-browser-triggers-for-matomo-archiving-and-limit-matomo-reports-to-updating-every-hour">
58− disable browser triggers for Matomo archiving </link> at
59− <literal>Administration > System > General Settings</literal>.
42+ This module comes with the systemd service <literal>matomo-archive-processing.service</literal> and a timer that automatically triggers archive processing every hour. This means that you can safely <link xlink:href="https://matomo.org/docs/setup-auto-archiving/#disable-browser-triggers-for-matomo-archiving-and-limit-matomo-reports-to-updating-every-hour"> disable browser triggers for Matomo archiving </link> at <literal>Administration > System > General Settings</literal>.
6043 </para>
6144
6245 <para>
63− With automatic archive processing, you can now also enable to
64− <link xlink:href="https://matomo.org/docs/privacy/#step-2-delete-old-visitors-logs">
65− delete old visitor logs </link> at <literal>Administration > System >
66− Privacy</literal>, but make sure that you run <literal>systemctl start
67− matomo-archive-processing.service</literal> at least once without errors if
68− you have already collected data before, so that the reports get archived
69− before the source data gets deleted.
46+ With automatic archive processing, you can now also enable to <link xlink:href="https://matomo.org/docs/privacy/#step-2-delete-old-visitors-logs"> delete old visitor logs </link> at <literal>Administration > System > Privacy</literal>, but make sure that you run <literal>systemctl start matomo-archive-processing.service</literal> at least once without errors if you have already collected data before, so that the reports get archived before the source data gets deleted.
7047 </para>
7148 </section>
7249 <section xml:id="module-services-matomo-backups">
7350 <title>Backup</title>
7451
7552 <para>
76− You only need to take backups of your MySQL database and the
77− <filename>/var/lib/matomo/config/config.ini.php</filename> file. Use a user
78− in the <literal>matomo</literal> group or root to access the file. For more
79− information, see
80− <link xlink:href="https://matomo.org/faq/how-to-install/faq_138/" />.
53+ You only need to take backups of your MySQL database and the <filename>/var/lib/matomo/config/config.ini.php</filename> file. Use a user in the <literal>matomo</literal> group or root to access the file. For more information, see <link xlink:href="https://matomo.org/faq/how-to-install/faq_138/" />.
8154 </para>
8255 </section>
8356 <section xml:id="module-services-matomo-issues">
@@ -86,15 +59,12 @@ GRANT ALL PRIVILEGES ON matomo.* TO 'matomo'@'localhost';
8659 <itemizedlist>
8760 <listitem>
8861 <para>
89− Matomo's file integrity check will warn you. This is due to the patches
90− necessary for NixOS, you can safely ignore this.
62+ Matomo's file integrity check will warn you. This is due to the patches necessary for NixOS, you can safely ignore this.
9163 </para>
9264 </listitem>
9365 <listitem>
9466 <para>
95− Matomo will warn you that the JavaScript tracker is not writable. This is
96− because it's located in the read-only nix store. You can safely ignore
97− this, unless you need a plugin that needs JavaScript tracker access.
67+ Matomo will warn you that the JavaScript tracker is not writable. This is because it's located in the read-only nix store. You can safely ignore this, unless you need a plugin that needs JavaScript tracker access.
9868 </para>
9969 </listitem>
10070 </itemizedlist>
@@ -103,11 +73,7 @@ GRANT ALL PRIVILEGES ON matomo.* TO 'matomo'@'localhost';
10373 <title>Using other Web Servers than nginx</title>
10474
10575 <para>
106− You can use other web servers by forwarding calls for
107− <filename>index.php</filename> and <filename>piwik.php</filename> to the
108− <literal>/run/phpfpm-matomo.sock</literal> fastcgi unix socket. You can use
109− the nginx configuration in the module code as a reference to what else
110− should be configured.
76+ You can use other web servers by forwarding calls for <filename>index.php</filename> and <filename>piwik.php</filename> to the <literal>/run/phpfpm-matomo.sock</literal> fastcgi unix socket. You can use the nginx configuration in the module code as a reference to what else should be configured.
11177 </para>
11278 </section>
11379</chapter>
nixos/modules/services/web-apps/nextcloud.xml+14−41
@@ -5,21 +5,13 @@
55 xml:id="module-services-nextcloud">
66 <title>Nextcloud</title>
77 <para>
8− <link xlink:href="https://nextcloud.com/">Nextcloud</link> is an open-source,
9− self-hostable cloud platform. The server setup can be automated using
10− <link linkend="opt-services.nextcloud.enable">services.nextcloud</link>. A
11− desktop client is packaged at <literal>pkgs.nextcloud-client</literal>.
8+ <link xlink:href="https://nextcloud.com/">Nextcloud</link> is an open-source, self-hostable cloud platform. The server setup can be automated using <link linkend="opt-services.nextcloud.enable">services.nextcloud</link>. A desktop client is packaged at <literal>pkgs.nextcloud-client</literal>.
129 </para>
1310 <section xml:id="module-services-nextcloud-basic-usage">
1411 <title>Basic usage</title>
1512
1613 <para>
17− Nextcloud is a PHP-based application which requires an HTTP server
18− (<literal><link linkend="opt-services.nextcloud.enable">services.nextcloud</link></literal>
19− optionally supports
20− <literal><link linkend="opt-services.nginx.enable">services.nginx</link></literal>)
21− and a database (it's recommended to use
22− <literal><link linkend="opt-services.postgresql.enable">services.postgresql</link></literal>).
14+ Nextcloud is a PHP-based application which requires an HTTP server (<literal><link linkend="opt-services.nextcloud.enable">services.nextcloud</link></literal> optionally supports <literal><link linkend="opt-services.nginx.enable">services.nginx</link></literal>) and a database (it's recommended to use <literal><link linkend="opt-services.postgresql.enable">services.postgresql</link></literal>).
2315 </para>
2416
2517 <para>
@@ -61,57 +53,38 @@
6153 </para>
6254
6355 <para>
64− The options <literal>hostName</literal> and <literal>nginx.enable</literal>
65− are used internally to configure an HTTP server using
66− <literal><link xlink:href="https://php-fpm.org/">PHP-FPM</link></literal>
67− and <literal>nginx</literal>. The <literal>config</literal> attribute set is
68− used by the imperative installer and all values are written to an additional file
69− to ensure that changes can be applied by changing the module's options.
56+ The options <literal>hostName</literal> and <literal>nginx.enable</literal> are used internally to configure an HTTP server using <literal><link xlink:href="https://php-fpm.org/">PHP-FPM</link></literal> and <literal>nginx</literal>. The <literal>config</literal> attribute set is used by the imperative installer and all values are written to an additional file to ensure that changes can be applied by changing the module's options.
7057 </para>
7158
7259 <para>
73− In case the application serves multiple domains (those are checked with
74− <literal><link xlink:href="http://php.net/manual/en/reserved.variables.server.php">$_SERVER['HTTP_HOST']</link></literal>)
75− it's needed to add them to
76− <literal><link linkend="opt-services.nextcloud.config.extraTrustedDomains">services.nextcloud.config.extraTrustedDomains</link></literal>.
60+ In case the application serves multiple domains (those are checked with <literal><link xlink:href="http://php.net/manual/en/reserved.variables.server.php">$_SERVER['HTTP_HOST']</link></literal>) it's needed to add them to <literal><link linkend="opt-services.nextcloud.config.extraTrustedDomains">services.nextcloud.config.extraTrustedDomains</link></literal>.
7761 </para>
7862
7963 <para>
80− Auto updates for Nextcloud apps can be enabled using
81− <literal><link linkend="opt-services.nextcloud.autoUpdateApps.enable">services.nextcloud.autoUpdateApps</link></literal>.
82−</para>
83−
64+ Auto updates for Nextcloud apps can be enabled using <literal><link linkend="opt-services.nextcloud.autoUpdateApps.enable">services.nextcloud.autoUpdateApps</link></literal>.
65+ </para>
8466 </section>
8567 <section xml:id="module-services-nextcloud-pitfalls-during-upgrade">
8668 <title>Pitfalls</title>
8769
8870 <para>
89− Unfortunately Nextcloud appears to be very stateful when it comes to
90− managing its own configuration. The config file lives in the home directory
91− of the <literal>nextcloud</literal> user (by default
92− <literal>/var/lib/nextcloud/config/config.php</literal>) and is also used to
93− track several states of the application (e.g. whether installed or not).
71+ Unfortunately Nextcloud appears to be very stateful when it comes to managing its own configuration. The config file lives in the home directory of the <literal>nextcloud</literal> user (by default <literal>/var/lib/nextcloud/config/config.php</literal>) and is also used to track several states of the application (e.g. whether installed or not).
9472 </para>
9573
9674 <para>
97− All configuration parameters are also stored in
98− <literal>/var/lib/nextcloud/config/override.config.php</literal> which is generated by
99− the module and linked from the store to ensure that all values from <literal>config.php</literal>
100− can be modified by the module.
101− However <literal>config.php</literal> manages the application's state and shouldn't be touched
102− manually because of that.
75+ All configuration parameters are also stored in <literal>/var/lib/nextcloud/config/override.config.php</literal> which is generated by the module and linked from the store to ensure that all values from <literal>config.php</literal> can be modified by the module. However <literal>config.php</literal> manages the application's state and shouldn't be touched manually because of that.
10376 </para>
10477
10578 <warning>
106− <para>Don't delete <literal>config.php</literal>! This file
107− tracks the application's state and a deletion can cause unwanted
108− side-effects!</para>
79+ <para>
80+ Don't delete <literal>config.php</literal>! This file tracks the application's state and a deletion can cause unwanted side-effects!
81+ </para>
10982 </warning>
11083
11184 <warning>
112− <para>Don't rerun <literal>nextcloud-occ
113− maintenance:install</literal>! This command tries to install the application
114− and can cause unwanted side-effects!</para>
85+ <para>
86+ Don't rerun <literal>nextcloud-occ maintenance:install</literal>! This command tries to install the application and can cause unwanted side-effects!
87+ </para>
11588 </warning>
11689 </section>
11790</chapter>