diff options
211 files changed, 6609 insertions, 2845 deletions
diff --git a/maintainers/maintainer-list.nix b/maintainers/maintainer-list.nix index 058561eb624..3cb0cd3fa99 100644 --- a/maintainers/maintainer-list.nix +++ b/maintainers/maintainer-list.nix @@ -693,7 +693,7 @@ name = "Aycan iRiCAN"; }; babariviere = { - email = "babariviere@protonmail.com"; + email = "babathriviere@gmail.com"; github = "babariviere"; githubId = 12128029; name = "babariviere"; diff --git a/nixos/doc/manual/administration/boot-problems.xml b/nixos/doc/manual/administration/boot-problems.xml index d6f9cb190fb..de3d8ac21ae 100644 --- a/nixos/doc/manual/administration/boot-problems.xml +++ b/nixos/doc/manual/administration/boot-problems.xml @@ -6,7 +6,12 @@ <title>Boot Problems</title> <para> - 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: + 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: <variablelist> <varlistentry> <term> @@ -14,7 +19,9 @@ </term> <listitem> <para> - 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. + 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. </para> </listitem> </varlistentry> @@ -24,7 +31,10 @@ </term> <listitem> <para> - 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>. + 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>. </para> </listitem> </varlistentry> @@ -44,7 +54,11 @@ </term> <listitem> <para> - 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. + 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. </para> </listitem> </varlistentry> @@ -54,7 +68,8 @@ </term> <listitem> <para> - Make systemd very verbose and send log messages to the console instead of the journal. + Make systemd very verbose and send log messages to the console instead of + the journal. </para> </listitem> </varlistentry> @@ -65,6 +80,11 @@ </para> <para> - 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.) + 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.) </para> </section> diff --git a/nixos/doc/manual/administration/cleaning-store.xml b/nixos/doc/manual/administration/cleaning-store.xml index 3cbc022cd33..526803e429b 100644 --- a/nixos/doc/manual/administration/cleaning-store.xml +++ b/nixos/doc/manual/administration/cleaning-store.xml @@ -5,22 +5,31 @@ xml:id="sec-nix-gc"> <title>Cleaning the Nix Store</title> <para> - 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: + 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: <screen> <prompt>$ </prompt>nix-collect-garbage </screen> - Alternatively, you can use a systemd unit that does the same in the background: + Alternatively, you can use a systemd unit that does the same in the + background: <screen> <prompt># </prompt>systemctl start nix-gc.service </screen> - 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: + 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: <programlisting> <xref linkend="opt-nix.gc.automatic"/> = true; <xref linkend="opt-nix.gc.dates"/> = "03:15"; </programlisting> </para> <para> - 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: + 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: <screen> <prompt>$ </prompt>nix-collect-garbage -d </screen> @@ -28,20 +37,27 @@ <screen> <prompt>$ </prompt>nix-env -p /nix/var/nix/profiles/per-user/eelco/profile --delete-generations old </screen> - Note that NixOS system configurations are stored in the profile <filename>/nix/var/nix/profiles/system</filename>. + Note that NixOS system configurations are stored in the profile + <filename>/nix/var/nix/profiles/system</filename>. </para> <para> - 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. + 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. <screen> <prompt>$ </prompt>nix-store --optimise </screen> - Since this command needs to read the entire Nix store, it can take quite a while to finish. + Since this command needs to read the entire Nix store, it can take quite a + while to finish. </para> <section xml:id="sect-nixos-gc-boot-entries"> <title>NixOS Boot Entries</title> <para> - 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. + 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. </para> </section> </chapter> diff --git a/nixos/doc/manual/administration/container-networking.xml b/nixos/doc/manual/administration/container-networking.xml index 745fa524916..42486f01fe8 100644 --- a/nixos/doc/manual/administration/container-networking.xml +++ b/nixos/doc/manual/administration/container-networking.xml @@ -6,7 +6,10 @@ <title>Container Networking</title> <para> - 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: + 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: <screen> <prompt># </prompt>nixos-container show-ip foo 10.233.4.2 @@ -17,21 +20,34 @@ </para> <para> - 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. + 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. </para> <para> - 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: + 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: <programlisting> <xref linkend="opt-networking.nat.enable"/> = true; <xref linkend="opt-networking.nat.internalInterfaces"/> = ["ve-+"]; <xref linkend="opt-networking.nat.externalInterface"/> = "eth0"; </programlisting> - 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. + 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. </para> <para> - If you are using Network Manager, you need to explicitly prevent it from managing container interfaces: + If you are using Network Manager, you need to explicitly prevent it from + managing container interfaces: <programlisting> networking.networkmanager.unmanaged = [ "interface-name:ve-*" ]; </programlisting> diff --git a/nixos/doc/manual/administration/containers.xml b/nixos/doc/manual/administration/containers.xml index 2d5a6dd46a3..0d3355e56a5 100644 --- a/nixos/doc/manual/administration/containers.xml +++ b/nixos/doc/manual/administration/containers.xml @@ -5,15 +5,28 @@ xml:id="ch-containers"> <title>Container Management</title> <para> - 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. + 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. </para> <warning> <para> - 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. + 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. </para> </warning> <para> - 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. + 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. </para> <xi:include href="imperative-containers.xml" /> <xi:include href="declarative-containers.xml" /> diff --git a/nixos/doc/manual/administration/control-groups.xml b/nixos/doc/manual/administration/control-groups.xml index d6ae89da30c..16d03cc0d1a 100644 --- a/nixos/doc/manual/administration/control-groups.xml +++ b/nixos/doc/manual/administration/control-groups.xml @@ -5,10 +5,16 @@ xml:id="sec-cgroups"> <title>Control Groups</title> <para> - 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. + 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. </para> <para> - 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: + 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: <screen> <prompt>$ </prompt>systemd-cgls ├─user @@ -26,19 +32,34 @@ │ └─2376 dhcpcd --config /nix/store/f8dif8dsi2yaa70n03xir8r653776ka6-dhcpcd.conf └─ <replaceable>...</replaceable> </screen> - 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>: + 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>: <programlisting> <link linkend="opt-systemd.services._name_.serviceConfig">systemd.services.httpd.serviceConfig</link>.CPUShares = 512; </programlisting> - By default, every cgroup has 1024 CPU shares, so this will halve the CPU allocation of the <literal>httpd.service</literal> cgroup. + By default, every cgroup has 1024 CPU shares, so this will halve the CPU + allocation of the <literal>httpd.service</literal> cgroup. </para> <para> - 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): + 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): <programlisting> <link linkend="opt-systemd.services._name_.serviceConfig">systemd.services.httpd.serviceConfig</link>.MemoryLimit = "512M"; </programlisting> </para> <para> - The command <command>systemd-cgtop</command> shows a continuously updated list of all cgroups with their CPU and memory usage. + The command <command>systemd-cgtop</command> shows a continuously updated + list of all cgroups with their CPU and memory usage. </para> </chapter> diff --git a/nixos/doc/manual/administration/declarative-containers.xml b/nixos/doc/manual/administration/declarative-containers.xml index a463d201478..d03dbc4d705 100644 --- a/nixos/doc/manual/administration/declarative-containers.xml +++ b/nixos/doc/manual/administration/declarative-containers.xml @@ -6,7 +6,10 @@ <title>Declarative Container Specification</title> <para> - 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: + 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: <programlisting> containers.database = { config = @@ -16,11 +19,18 @@ containers.database = }; }; </programlisting> - 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. + 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. </para> <para> - 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: + 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: <programlisting> containers.database = { <link linkend="opt-containers._name_.privateNetwork">privateNetwork</link> = true; @@ -28,14 +38,23 @@ containers.database = { <link linkend="opt-containers._name_.localAddress">localAddress</link> = "192.168.100.11"; }; </programlisting> - 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.) + 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.) </para> <para> - 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>. + 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>. </para> <para> - Declarative containers can be started and stopped using the corresponding systemd service, e.g. <literal>systemctl start container@database</literal>. + Declarative containers can be started and stopped using the corresponding + systemd service, e.g. <literal>systemctl start container@database</literal>. </para> </section> diff --git a/nixos/doc/manual/administration/imperative-containers.xml b/nixos/doc/manual/administration/imperative-containers.xml index d5da6bf2017..7ded0c11786 100644 --- a/nixos/doc/manual/administration/imperative-containers.xml +++ b/nixos/doc/manual/administration/imperative-containers.xml @@ -6,7 +6,9 @@ <title>Imperative Container Management</title> <para> - 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>. + 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>. </para> <para> @@ -14,14 +16,23 @@ <screen> # nixos-container create foo </screen> - 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>: + 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>: <screen> # nixos-container create foo --config ' <xref linkend="opt-services.openssh.enable"/> = true; <link linkend="opt-users.users._name__.openssh.authorizedKeys.keys">users.users.root.openssh.authorizedKeys.keys</link> = ["ssh-dss AAAAB3N…"]; ' </screen> - 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>: + 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>: <screen> # nixos-container create test --config-file test-container.nix \ --local-address 10.235.1.2 --host-address 10.235.1.1 @@ -33,25 +44,35 @@ <screen> # nixos-container start foo </screen> - 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>: + 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>: <screen> # systemctl status container@foo </screen> </para> <para> - If the container has started successfully, you can log in as root using the <command>root-login</command> operation: + If the container has started successfully, you can log in as root using the + <command>root-login</command> operation: <screen> # nixos-container root-login foo [root@foo:~]# </screen> - 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: + 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: <screen> # nixos-container login foo foo login: alice Password: *** </screen> - With <command>nixos-container run</command>, you can execute arbitrary commands in the container: + With <command>nixos-container run</command>, you can execute arbitrary + commands in the container: <screen> # nixos-container run foo -- uname -a Linux foo 3.4.82 #1-NixOS SMP Thu Mar 20 14:44:05 UTC 2014 x86_64 GNU/Linux @@ -59,11 +80,15 @@ Linux foo 3.4.82 #1-NixOS SMP Thu Mar 20 14:44:05 UTC 2014 x86_64 GNU/Linux </para> <para> - 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 + 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 <screen> # nixos-container update foo </screen> - This will build and activate the new configuration. You can also specify a new configuration on the command line: + This will build and activate the new configuration. You can also specify a + new configuration on the command line: <screen> # nixos-container update foo --config ' <xref linkend="opt-services.httpd.enable"/> = true; @@ -74,15 +99,23 @@ Linux foo 3.4.82 #1-NixOS SMP Thu Mar 20 14:44:05 UTC 2014 x86_64 GNU/Linux # curl http://$(nixos-container show-ip foo)/ <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 3.2 Final//EN">… </screen> - However, note that this will overwrite the container’s <filename>/etc/nixos/configuration.nix</filename>. + However, note that this will overwrite the container’s + <filename>/etc/nixos/configuration.nix</filename>. </para> <para> - 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. + 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. </para> <para> - 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 + 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 <screen> # nixos-container destroy foo </screen> diff --git a/nixos/doc/manual/administration/logging.xml b/nixos/doc/manual/administration/logging.xml index 8089b457786..da4877fcdf0 100644 --- a/nixos/doc/manual/administration/logging.xml +++ b/nixos/doc/manual/administration/logging.xml @@ -5,11 +5,18 @@ xml:id="sec-logging"> <title>Logging</title> <para> - 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, + 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, <screen> <prompt>$ </prompt>journalctl -b </screen> - 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: + 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: <screen> <prompt>$ </prompt>journalctl -u postgresql.service -- Logs begin at Mon, 2013-01-07 13:28:01 CET, end at Tue, 2013-01-08 01:09:57 CET. -- @@ -19,7 +26,8 @@ Jan 07 15:44:14 hagbard postgres[2681]: [2-1] LOG: database system is shut down Jan 07 15:45:10 hagbard postgres[2532]: [1-1] LOG: database system was shut down at 2013-01-07 15:44:14 CET Jan 07 15:45:13 hagbard postgres[2500]: [1-1] LOG: database system is ready to accept connections </screen> - Or to get all messages since the last reboot that have at least a “critical” severity level: + Or to get all messages since the last reboot that have at least a + “critical” severity level: <screen> <prompt>$ </prompt>journalctl -b -p crit Dec 17 21:08:06 mandark sudo[3673]: pam_unix(sudo:auth): auth could not identify password for [alice] @@ -27,6 +35,9 @@ Dec 29 01:30:22 mandark kernel[6131]: [1053513.909444] CPU6: Core temperature ab </screen> </para> <para> - 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>. + 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>. </para> </chapter> diff --git a/nixos/doc/manual/administration/maintenance-mode.xml b/nixos/doc/manual/administration/maintenance-mode.xml index dc11316dc1a..71e3f9ea665 100644 --- a/nixos/doc/manual/administration/maintenance-mode.xml +++ b/nixos/doc/manual/administration/maintenance-mode.xml @@ -9,6 +9,8 @@ You can enter rescue mode by running: <screen> # systemctl rescue</screen> - 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. + 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. </para> </section> diff --git a/nixos/doc/manual/administration/network-problems.xml b/nixos/doc/manual/administration/network-problems.xml index 1d41e5c2995..570f5835884 100644 --- a/nixos/doc/manual/administration/network-problems.xml +++ b/nixos/doc/manual/administration/network-problems.xml @@ -6,11 +6,20 @@ <title>Network Problems</title> <para> - 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. + 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. <screen> # nixos-rebuild switch --option use-binary-caches false </screen> - If you have an alternative binary cache at your disposal, you can use it instead: + If you have an alternative binary cache at your disposal, you can use it + instead: <screen> # nixos-rebuild switch --option binary-caches http://my-cache.example.org/ </screen> diff --git a/nixos/doc/manual/administration/rebooting.xml b/nixos/doc/manual/administration/rebooting.xml index 989712b20fa..a5abd6f0258 100644 --- a/nixos/doc/manual/administration/rebooting.xml +++ b/nixos/doc/manual/administration/rebooting.xml @@ -16,15 +16,20 @@ <screen> # reboot </screen> - 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: + 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: <screen> # systemctl kexec </screen> </para> <para> - The machine can be suspended to RAM (if supported) using <command>systemctl suspend</command>, and suspended to disk using <command>systemctl hibernate</command>. + The machine can be suspended to RAM (if supported) using <command>systemctl + suspend</command>, and suspended to disk using <command>systemctl + hibernate</command>. </para> <para> - 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. + 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. </para> </chapter> diff --git a/nixos/doc/manual/administration/rollback.xml b/nixos/doc/manual/administration/rollback.xml index aa6d3c95676..fb87810ba46 100644 --- a/nixos/doc/manual/administration/rollback.xml +++ b/nixos/doc/manual/administration/rollback.xml @@ -6,11 +6,19 @@ <title>Rolling Back Configuration Changes</title> <para> - 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. + 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. </para> <para> - 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: + 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: <screen> # /run/current-system/bin/switch-to-configuration boot</screen> </para> @@ -22,7 +30,8 @@ This is equivalent to running: <screen> # /nix/var/nix/profiles/system-<replaceable>N</replaceable>-link/bin/switch-to-configuration switch</screen> - where <replaceable>N</replaceable> is the number of the NixOS system configuration. To get a list of the available configurations, do: + where <replaceable>N</replaceable> is the number of the NixOS system + configuration. To get a list of the available configurations, do: <screen> <prompt>$ </prompt>ls -l /nix/var/nix/profiles/system-*-link <replaceable>...</replaceable> diff --git a/nixos/doc/manual/administration/running.xml b/nixos/doc/manual/administration/running.xml index 12512a003c8..19bec1f7794 100644 --- a/nixos/doc/manual/administration/running.xml +++ b/nixos/doc/manual/administration/running.xml @@ -6,7 +6,8 @@ <title>Administration</title> <partintro xml:id="ch-running-intro"> <para> - This chapter describes various aspects of managing a running NixOS system, such as how to use the <command>systemd</command> service manager. + This chapter describes various aspects of managing a running NixOS system, + such as how to use the <command>systemd</command> service manager. </para> </partintro> <xi:include href="service-mgmt.xml" /> diff --git a/nixos/doc/manual/administration/service-mgmt.xml b/nixos/doc/manual/administration/service-mgmt.xml index 4ad30ce55a8..1b9c745eb59 100644 --- a/nixos/doc/manual/administration/service-mgmt.xml +++ b/nixos/doc/manual/administration/service-mgmt.xml @@ -5,10 +5,21 @@ xml:id="sec-systemctl"> <title>Service Management</title> <para> - 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. + 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. </para> <para> - 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: + 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: <screen> <prompt>$ </prompt>systemctl -.mount loaded active mounted / @@ -19,7 +30,8 @@ graphical.target loaded active active Graphical Interface </screen> </para> <para> - You can ask for detailed status information about a unit, for instance, the PostgreSQL database service: + You can ask for detailed status information about a unit, for instance, the + PostgreSQL database service: <screen> <prompt>$ </prompt>systemctl status postgresql.service postgresql.service - PostgreSQL Server @@ -39,7 +51,9 @@ Jan 07 15:55:57 hagbard postgres[2390]: [1-1] LOG: database system is ready to Jan 07 15:55:57 hagbard postgres[2420]: [1-1] LOG: autovacuum launcher started Jan 07 15:55:57 hagbard systemd[1]: Started PostgreSQL Server. </screen> - 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. + 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. </para> <para> Units can be stopped, started or restarted: @@ -48,7 +62,9 @@ Jan 07 15:55:57 hagbard systemd[1]: Started PostgreSQL Server. # systemctl start postgresql.service # systemctl restart postgresql.service </screen> - 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). + 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). </para> <!-- - cgroups: each service and user session is a cgroup diff --git a/nixos/doc/manual/administration/store-corruption.xml b/nixos/doc/manual/administration/store-corruption.xml index dc0a672d5bd..b9d11152d5e 100644 --- a/nixos/doc/manual/administration/store-corruption.xml +++ b/nixos/doc/manual/administration/store-corruption.xml @@ -6,15 +6,23 @@ <title>Nix Store Corruption</title> <para> - 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. + 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. </para> <para> - If the corruption is in a path in the closure of the NixOS system configuration, you can fix it by doing + If the corruption is in a path in the closure of the NixOS system + configuration, you can fix it by doing <screen> <prompt># </prompt>nixos-rebuild switch --repair </screen> - 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. + 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. </para> <para> @@ -22,6 +30,7 @@ <screen> <prompt># </prompt>nix-store --verify --check-contents --repair </screen> - Any corrupt paths will be redownloaded if they’re available in a binary cache; otherwise, they cannot be repaired. + Any corrupt paths will be redownloaded if they’re available in a binary + cache; otherwise, they cannot be repaired. </para> </section> diff --git a/nixos/doc/manual/administration/troubleshooting.xml b/nixos/doc/manual/administration/troubleshooting.xml index 923b1e96c7c..6496e7bde38 100644 --- a/nixos/doc/manual/administration/troubleshooting.xml +++ b/nixos/doc/manual/administration/troubleshooting.xml @@ -5,7 +5,8 @@ xml:id="ch-troubleshooting"> <title>Troubleshooting</title> <para> - This chapter describes solutions to common problems you might encounter when you manage your NixOS system. + This chapter describes solutions to common problems you might encounter when + you manage your NixOS system. </para> <xi:include href="boot-problems.xml" /> <xi:include href="maintenance-mode.xml" /> diff --git a/nixos/doc/manual/administration/user-sessions.xml b/nixos/doc/manual/administration/user-sessions.xml index c7969f4f0d6..80daf6bdbff 100644 --- a/nixos/doc/manual/administration/user-sessions.xml +++ b/nixos/doc/manual/administration/user-sessions.xml @@ -5,7 +5,10 @@ xml:id="sec-user-sessions"> <title>User Sessions</title> <para> - 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: + 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: <screen> <prompt>$ </prompt>loginctl SESSION UID USER SEAT @@ -13,7 +16,10 @@ c3 0 root seat0 c4 500 alice </screen> - 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: + 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: <screen> <prompt>$ </prompt>loginctl session-status c3 c3 - root (0) @@ -28,7 +34,10 @@ c3 - root (0) ├─10339 -bash └─10355 w3m nixos.org </screen> - 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: + 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: <screen> # loginctl terminate-session c3 </screen> diff --git a/nixos/doc/manual/configuration/abstractions.xml b/nixos/doc/manual/configuration/abstractions.xml index 6e6850769f5..5bf0635cc1a 100644 --- a/nixos/doc/manual/configuration/abstractions.xml +++ b/nixos/doc/manual/configuration/abstractions.xml @@ -6,7 +6,8 @@ <title>Abstractions</title> <para> - If you find yourself repeating yourself over and over, it’s time to abstract. Take, for instance, this Apache HTTP Server configuration: + If you find yourself repeating yourself over and over, it’s time to + abstract. Take, for instance, this Apache HTTP Server configuration: <programlisting> { <xref linkend="opt-services.httpd.virtualHosts"/> = @@ -26,7 +27,9 @@ ]; } </programlisting> - 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>: + 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>: <programlisting> let exampleOrgCommon = @@ -47,11 +50,16 @@ in ]; } </programlisting> - 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. + 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. </para> <para> - You can write a <literal>let</literal> wherever an expression is allowed. Thus, you also could have written: + You can write a <literal>let</literal> wherever an expression is allowed. + Thus, you also could have written: <programlisting> { <xref linkend="opt-services.httpd.virtualHosts"/> = @@ -61,11 +69,16 @@ in ]; } </programlisting> - but not <literal>{ let exampleOrgCommon = <replaceable>...</replaceable>; in <replaceable>...</replaceable>; }</literal> since attributes (as opposed to attribute values) are not expressions. + but not <literal>{ let exampleOrgCommon = <replaceable>...</replaceable>; in + <replaceable>...</replaceable>; }</literal> since attributes (as opposed to + attribute values) are not expressions. </para> <para> - <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: + <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: <programlisting> { <xref linkend="opt-services.httpd.virtualHosts"/> = @@ -83,11 +96,15 @@ in ]; } </programlisting> - 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. + 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. </para> <para> - We can further improve on this by using the function <varname>map</varname>, which applies another function to every element in a list: + We can further improve on this by using the function <varname>map</varname>, + which applies another function to every element in a list: <programlisting> { <xref linkend="opt-services.httpd.virtualHosts"/> = @@ -97,11 +114,15 @@ in [ "example.org" "example.com" "example.gov" "example.nl" ]; } </programlisting> - (The function <literal>map</literal> is called a <emphasis>higher-order function</emphasis> because it takes another function as an argument.) + (The function <literal>map</literal> is called a <emphasis>higher-order + function</emphasis> because it takes another function as an argument.) </para> <para> - 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: + 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: <programlisting> { <xref linkend="opt-services.httpd.virtualHosts"/> = @@ -119,7 +140,9 @@ in ]; } </programlisting> - 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 + 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 <programlisting> makeVirtualHost = name: { hostName = name; @@ -127,6 +150,7 @@ makeVirtualHost = name: adminAddr = "alice@example.org"; }; </programlisting> - Here, the construct <literal>${<replaceable>...</replaceable>}</literal> allows the result of an expression to be spliced into a string. + Here, the construct <literal>${<replaceable>...</replaceable>}</literal> + allows the result of an expression to be spliced into a string. </para> </section> diff --git a/nixos/doc/manual/configuration/ad-hoc-network-config.xml b/nixos/doc/manual/configuration/ad-hoc-network-config.xml index 97276e8a177..00e595c7cb7 100644 --- a/nixos/doc/manual/configuration/ad-hoc-network-config.xml +++ b/nixos/doc/manual/configuration/ad-hoc-network-config.xml @@ -6,7 +6,10 @@ <title>Ad-Hoc Configuration</title> <para> - 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: + 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: <programlisting> <xref linkend="opt-networking.localCommands"/> = '' diff --git a/nixos/doc/manual/configuration/ad-hoc-packages.xml b/nixos/doc/manual/configuration/ad-hoc-packages.xml index f15a22469a0..c7e882d846f 100644 --- a/nixos/doc/manual/configuration/ad-hoc-packages.xml +++ b/nixos/doc/manual/configuration/ad-hoc-packages.xml @@ -6,18 +6,33 @@ <title>Ad-Hoc Package Management</title> <para> - With the command <command>nix-env</command>, you can install and uninstall packages from the command line. For instance, to install Mozilla Thunderbird: + With the command <command>nix-env</command>, you can install and uninstall + packages from the command line. For instance, to install Mozilla Thunderbird: <screen> <prompt>$ </prompt>nix-env -iA nixos.thunderbird</screen> - 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. + 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. </para> <para> - Packages come from the NixOS channel. You typically upgrade a package by updating to the latest version of the NixOS channel: + Packages come from the NixOS channel. You typically upgrade a package by + updating to the latest version of the NixOS channel: <screen> <prompt>$ </prompt>nix-channel --update nixos </screen> - 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: + 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: <screen> <prompt>$ </prompt>nix-env -u '*' </screen> @@ -38,7 +53,8 @@ </para> <para> - <command>nix-env</command> has many more flags. For details, see the <citerefentry> + <command>nix-env</command> has many more flags. For details, see the + <citerefentry> <refentrytitle>nix-env</refentrytitle> <manvolnum>1</manvolnum></citerefentry> manpage or the Nix manual. </para> diff --git a/nixos/doc/manual/configuration/adding-custom-packages.xml b/nixos/doc/manual/configuration/adding-custom-packages.xml index 210a2aef37b..182641055e4 100644 --- a/nixos/doc/manual/configuration/adding-custom-packages.xml +++ b/nixos/doc/manual/configuration/adding-custom-packages.xml @@ -6,23 +6,33 @@ <title>Adding Custom Packages</title> <para> - 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 -xlink:href="http://nixos.org/nixpkgs/manual">Nixpkgs manual</link>. In short, you clone Nixpkgs: + 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 +xlink:href="http://nixos.org/nixpkgs/manual">Nixpkgs + manual</link>. In short, you clone Nixpkgs: <screen> <prompt>$ </prompt>git clone https://github.com/NixOS/nixpkgs <prompt>$ </prompt>cd nixpkgs </screen> - Then you write and test the package as described in the Nixpkgs manual. Finally, you add it to <literal>environment.systemPackages</literal>, e.g. + Then you write and test the package as described in the Nixpkgs manual. + Finally, you add it to <literal>environment.systemPackages</literal>, e.g. <programlisting> <xref linkend="opt-environment.systemPackages"/> = [ pkgs.my-package ]; </programlisting> - and you run <command>nixos-rebuild</command>, specifying your own Nixpkgs tree: + and you run <command>nixos-rebuild</command>, specifying your own Nixpkgs + tree: <screen> # nixos-rebuild switch -I nixpkgs=/path/to/my/nixpkgs</screen> </para> <para> - 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>: + 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>: <programlisting> <xref linkend="opt-environment.systemPackages"/> = let @@ -36,7 +46,8 @@ xlink:href="http://nixos.org/nixpkgs/manual">Nixpkgs manual</link>. In short, yo in [ my-hello ]; </programlisting> - Of course, you can also move the definition of <literal>my-hello</literal> into a separate Nix expression, e.g. + Of course, you can also move the definition of <literal>my-hello</literal> + into a separate Nix expression, e.g. <programlisting> <xref linkend="opt-environment.systemPackages"/> = [ (import ./my-hello.nix) ]; </programlisting> diff --git a/nixos/doc/manual/configuration/config-file.xml b/nixos/doc/manual/configuration/config-file.xml index 38296caaa9a..eadafb94b8f 100644 --- a/nixos/doc/manual/configuration/config-file.xml +++ b/nixos/doc/manual/configuration/config-file.xml @@ -13,7 +13,15 @@ { <replaceable>option definitions</replaceable> } </programlisting> - 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, + 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, <programlisting> { config, pkgs, ... }: @@ -22,11 +30,19 @@ <xref linkend="opt-services.httpd.documentRoot"/> = "/webroot"; } </programlisting> - defines a configuration with three option definitions that together enable the Apache HTTP Server with <filename>/webroot</filename> as the document root. + defines a configuration with three option definitions that together enable + the Apache HTTP Server with <filename>/webroot</filename> as the document + root. </para> <para> - 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: + 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: <programlisting> { config, pkgs, ... }: @@ -39,15 +55,22 @@ }; } </programlisting> - which may be more convenient if you have lots of option definitions that share the same prefix (such as <literal>services.httpd</literal>). + which may be more convenient if you have lots of option definitions that + share the same prefix (such as <literal>services.httpd</literal>). </para> <para> - 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: + 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: <screen> The option `services.httpd.enable' defined in `/etc/nixos/configuration.nix' does not exist. </screen> - 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: + 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: <screen> The option value `services.httpd.enable' in `/etc/nixos/configuration.nix' is not a boolean. </screen> @@ -66,10 +89,12 @@ The option value `services.httpd.enable' in `/etc/nixos/configuration.nix' is no <programlisting> <xref linkend="opt-networking.hostName"/> = "dexter"; </programlisting> - Special characters can be escaped by prefixing them with a backslash (e.g. <literal>\"</literal>). + Special characters can be escaped by prefixing them with a backslash + (e.g. <literal>\"</literal>). </para> <para> - Multi-line strings can be enclosed in <emphasis>double single quotes</emphasis>, e.g. + Multi-line strings can be enclosed in <emphasis>double single + quotes</emphasis>, e.g. <programlisting> <xref linkend="opt-networking.extraHosts"/> = '' @@ -77,7 +102,13 @@ The option value `services.httpd.enable' in `/etc/nixos/configuration.nix' is no 10.0.0.1 server ''; </programlisting> - 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 + 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 xlink:href="https://nixos.org/nix/manual/#ssec-values">here</link>. </para> </listitem> @@ -106,7 +137,12 @@ The option value `services.httpd.enable' in `/etc/nixos/configuration.nix' is no <programlisting> <xref linkend="opt-boot.kernel.sysctl"/>."net.ipv4.tcp_keepalive_time" = 60; </programlisting> - (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.) + (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.) </para> </listitem> </varlistentry> @@ -116,7 +152,8 @@ The option value `services.httpd.enable' in `/etc/nixos/configuration.nix' is no </term> <listitem> <para> - Sets were introduced above. They are name/value pairs enclosed in braces, as in the option definition + Sets were introduced above. They are name/value pairs enclosed in braces, + as in the option definition <programlisting> <xref linkend="opt-fileSystems"/>."/boot" = { device = "/dev/sda1"; @@ -133,7 +170,8 @@ The option value `services.httpd.enable' in `/etc/nixos/configuration.nix' is no </term> <listitem> <para> - The important thing to note about lists is that list elements are separated by whitespace, like this: + The important thing to note about lists is that list elements are + separated by whitespace, like this: <programlisting> <xref linkend="opt-boot.kernelModules"/> = [ "fuse" "kvm-intel" "coretemp" ]; </programlisting> @@ -150,7 +188,9 @@ swapDevices = [ { device = "/dev/disk/by-label/swap"; } ]; </term> <listitem> <para> - 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: + 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: <programlisting> <xref linkend="opt-environment.systemPackages"/> = [ pkgs.thunderbird @@ -159,7 +199,10 @@ swapDevices = [ { device = "/dev/disk/by-label/swap"; } ]; <xref linkend="opt-services.postgresql.package"/> = pkgs.postgresql_10; </programlisting> - 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"/>. + 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"/>. </para> </listitem> </varlistentry> diff --git a/nixos/doc/manual/configuration/config-syntax.xml b/nixos/doc/manual/configuration/config-syntax.xml index 9de5c6f477b..5ef498cf9ae 100644 --- a/nixos/doc/manual/configuration/config-syntax.xml +++ b/nixos/doc/manual/configuration/config-syntax.xml @@ -5,8 +5,18 @@ xml:id="sec-configuration-syntax"> <title>Configuration Syntax</title> <para> - 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 -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. + 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 +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. </para> <xi:include href="config-file.xml" /> <xi:include href="abstractions.xml" /> diff --git a/nixos/doc/manual/configuration/configuration.xml b/nixos/doc/manual/configuration/configuration.xml index 0197eb9b3a2..5961209bc13 100644 --- a/nixos/doc/manual/configuration/configuration.xml +++ b/nixos/doc/manual/configuration/configuration.xml @@ -6,7 +6,11 @@ <title>Configuration</title> <partintro xml:id="ch-configuration-intro"> <para> - 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>. + 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>. </para> </partintro> <xi:include href="config-syntax.xml" /> diff --git a/nixos/doc/manual/configuration/customizing-packages.xml b/nixos/doc/manual/configuration/customizing-packages.xml index 589db91e9b0..34e6ab4b24d 100644 --- a/nixos/doc/manual/configuration/customizing-packages.xml +++ b/nixos/doc/manual/configuration/customizing-packages.xml @@ -6,25 +6,47 @@ <title>Customising Packages</title> <para> - 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> + 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> </para> <warning> <para> - Unfortunately, Nixpkgs currently lacks a way to query available configuration options. + Unfortunately, Nixpkgs currently lacks a way to query available + configuration options. </para> </warning> <para> - 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: + 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: <programlisting> <xref linkend="opt-environment.systemPackages"/> = [ (pkgs.emacs.override { gtk = pkgs.gtk3; }) ]; </programlisting> - 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.) + 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.) </para> <para> - 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: + 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: <programlisting> <xref linkend="opt-environment.systemPackages"/> = [ (pkgs.emacs.overrideAttrs (oldAttrs: { @@ -33,16 +55,32 @@ })) ]; </programlisting> - 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>. + 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>. </para> <para> - 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: + 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: <screen> nixpkgs.config.packageOverrides = pkgs: { emacs = pkgs.emacs.override { gtk = pkgs.gtk3; }; }; </screen> - 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.) + 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.) </para> </section> diff --git a/nixos/doc/manual/configuration/declarative-packages.xml b/nixos/doc/manual/configuration/declarative-packages.xml index 4b15e1ca42e..5fb3bcb9f8f 100644 --- a/nixos/doc/manual/configuration/declarative-packages.xml +++ b/nixos/doc/manual/configuration/declarative-packages.xml @@ -6,11 +6,17 @@ <title>Declarative Package Management</title> <para> - 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: + 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: <programlisting> <xref linkend="opt-environment.systemPackages"/> = [ pkgs.thunderbird ]; </programlisting> - 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>. + 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>. </para> <para> @@ -20,15 +26,20 @@ nixos.firefox firefox-23.0 Mozilla Firefox - the browser, reloaded <replaceable>...</replaceable> </screen> - The first column in the output is the <emphasis>attribute name</emphasis>, such as <literal>nixos.thunderbird</literal>. + The first column in the output is the <emphasis>attribute name</emphasis>, + such as <literal>nixos.thunderbird</literal>. </para> - <para> - 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). + 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). </para> <para> - To “uninstall” a package, simply remove it from <xref linkend="opt-environment.systemPackages"/> and run <command>nixos-rebuild switch</command>. + To “uninstall” a package, simply remove it from + <xref linkend="opt-environment.systemPackages"/> and run + <command>nixos-rebuild switch</command>. </para> <xi:include href="customizing-packages.xml" /> diff --git a/nixos/doc/manual/configuration/file-systems.xml b/nixos/doc/manual/configuration/file-systems.xml index 1f762b2b00e..e4c03de71b7 100644 --- a/nixos/doc/manual/configuration/file-systems.xml +++ b/nixos/doc/manual/configuration/file-systems.xml @@ -5,21 +5,41 @@ xml:id="ch-file-systems"> <title>File Systems</title> <para> - 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>: + 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>: <programlisting> <xref linkend="opt-fileSystems"/>."/data" = { device = "/dev/disk/by-label/data"; fsType = "ext4"; }; </programlisting> - 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). + 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). </para> <para> - 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. + 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. </para> <note> <para> - 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>. + 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>. </para> </note> <xi:include href="luks-file-systems.xml" /> diff --git a/nixos/doc/manual/configuration/firewall.xml b/nixos/doc/manual/configuration/firewall.xml index fbed9ac7c95..47a19ac82c0 100644 --- a/nixos/doc/manual/configuration/firewall.xml +++ b/nixos/doc/manual/configuration/firewall.xml @@ -6,15 +6,21 @@ <title>Firewall</title> <para> - 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: + 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: <programlisting> <xref linkend="opt-networking.firewall.enable"/> = false; </programlisting> - If the firewall is enabled, you can open specific TCP ports to the outside world: + If the firewall is enabled, you can open specific TCP ports to the outside + world: <programlisting> <xref linkend="opt-networking.firewall.allowedTCPPorts"/> = [ 80 443 ]; </programlisting> - 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"/>. + 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"/>. </para> <para> @@ -25,6 +31,7 @@ { from = 8000; to = 8010; } ]; </programlisting> - Similarly, UDP port ranges can be opened through <xref linkend="opt-networking.firewall.allowedUDPPortRanges"/>. + Similarly, UDP port ranges can be opened through + <xref linkend="opt-networking.firewall.allowedUDPPortRanges"/>. </para> </section> diff --git a/nixos/doc/manual/configuration/ipv4-config.xml b/nixos/doc/manual/configuration/ipv4-config.xml index 3ebde2193cb..71ddf41491b 100644 --- a/nixos/doc/manual/configuration/ipv4-config.xml +++ b/nixos/doc/manual/configuration/ipv4-config.xml @@ -6,14 +6,17 @@ <title>IPv4 Configuration</title> <para> - By default, NixOS uses DHCP (specifically, <command>dhcpcd</command>) to automatically configure network interfaces. However, you can configure an interface manually as follows: + By default, NixOS uses DHCP (specifically, <command>dhcpcd</command>) to + automatically configure network interfaces. However, you can configure an + interface manually as follows: <programlisting> <link linkend="opt-networking.interfaces._name__.ipv4.addresses">networking.interfaces.eth0.ipv4.addresses</link> = [ { address = "192.168.1.2"; prefixLength = 24; } ]; </programlisting> - Typically you’ll also want to set a default gateway and set of name servers: + Typically you’ll also want to set a default gateway and set of name + servers: <programlisting> <xref linkend="opt-networking.defaultGateway"/> = "192.168.1.1"; <xref linkend="opt-networking.nameservers"/> = [ "8.8.8.8" ]; @@ -22,7 +25,10 @@ <note> <para> - 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>. + 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>. </para> </note> @@ -31,6 +37,7 @@ <programlisting> <xref linkend="opt-networking.hostName"/> = "cartman"; </programlisting> - 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. + 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. </para> </section> diff --git a/nixos/doc/manual/configuration/ipv6-config.xml b/nixos/doc/manual/configuration/ipv6-config.xml index 690cfcca015..675a5d9a260 100644 --- a/nixos/doc/manual/configuration/ipv6-config.xml +++ b/nixos/doc/manual/configuration/ipv6-config.xml @@ -6,21 +6,25 @@ <title>IPv6 Configuration</title> <para> - 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: + 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: <programlisting> <xref linkend="opt-networking.enableIPv6"/> = false; </programlisting> </para> <para> - You can disable IPv6 on a single interface using a normal sysctl (in this example, we use interface <varname>eth0</varname>): + You can disable IPv6 on a single interface using a normal sysctl (in this + example, we use interface <varname>eth0</varname>): <programlisting> <xref linkend="opt-boot.kernel.sysctl"/>."net.ipv6.conf.eth0.disable_ipv6" = true; </programlisting> </para> <para> - As with IPv4 networking interfaces are automatically configured via DHCPv6. You can configure an interface manually: + As with IPv4 networking interfaces are automatically configured via DHCPv6. + You can configure an interface manually: <programlisting> <link linkend="opt-networking.interfaces._name__.ipv6.addresses">networking.interfaces.eth0.ipv6.addresses</link> = [ { address = "fe00:aa:bb:cc::2"; @@ -40,6 +44,7 @@ </para> <para> - See <xref linkend='sec-ipv4' /> for similar examples and additional information. + See <xref linkend='sec-ipv4' /> for similar examples and additional + information. </para> </section> diff --git a/nixos/doc/manual/configuration/kubernetes.xml b/nixos/doc/manual/configuration/kubernetes.xml index de5ceb83e77..54a100e4479 100644 --- a/nixos/doc/manual/configuration/kubernetes.xml +++ b/nixos/doc/manual/configuration/kubernetes.xml @@ -5,10 +5,12 @@ xml:id="sec-kubernetes"> <title>Kubernetes</title> <para> - The NixOS Kubernetes module is a collective term for a handful of individual submodules implementing the Kubernetes cluster components. + The NixOS Kubernetes module is a collective term for a handful of individual + submodules implementing the Kubernetes cluster components. </para> <para> - There are generally two ways of enabling Kubernetes on NixOS. One way is to enable and configure cluster components appropriately by hand: + There are generally two ways of enabling Kubernetes on NixOS. One way is to + enable and configure cluster components appropriately by hand: <programlisting> services.kubernetes = { apiserver.enable = true; @@ -19,7 +21,9 @@ services.kubernetes = { flannel.enable = true; }; </programlisting> - Another way is to assign cluster roles ("master" and/or "node") to the host. This enables apiserver, controllerManager, scheduler, addonManager, kube-proxy and etcd: + Another way is to assign cluster roles ("master" and/or "node") to the host. + This enables apiserver, controllerManager, scheduler, addonManager, + kube-proxy and etcd: <programlisting> <xref linkend="opt-services.kubernetes.roles"/> = [ "master" ]; </programlisting> @@ -27,29 +31,66 @@ services.kubernetes = { <programlisting> <xref linkend="opt-services.kubernetes.roles"/> = [ "node" ]; </programlisting> - Assigning both the master and node roles is usable if you want a single node Kubernetes cluster for dev or testing purposes: + Assigning both the master and node roles is usable if you want a single node + Kubernetes cluster for dev or testing purposes: <programlisting> <xref linkend="opt-services.kubernetes.roles"/> = [ "master" "node" ]; </programlisting> - 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. + 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. </para> <para> - 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"/> + 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"/> </para> <note> <para> - 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>. + 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>. </para> </note> <para> - 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 - xlink:href="https://kubernetes.io/docs/reference/access-authn-authz/rbac/"> Using RBAC Authorization</link>. + 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 + xlink:href="https://kubernetes.io/docs/reference/access-authn-authz/rbac/"> + Using RBAC Authorization</link>. </para> <para> - 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. + 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. </para> <para> - 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. + 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. </para> <note> <para> @@ -57,6 +98,15 @@ services.kubernetes = { </para> </note> <para> - 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. + 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. </para> </chapter> diff --git a/nixos/doc/manual/configuration/linux-kernel.xml b/nixos/doc/manual/configuration/linux-kernel.xml index 7f757f287ce..644d3a33ffd 100644 --- a/nixos/doc/manual/configuration/linux-kernel.xml +++ b/nixos/doc/manual/configuration/linux-kernel.xml @@ -5,19 +5,27 @@ xml:id="sec-kernel-config"> <title>Linux Kernel</title> <para> - 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: + 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: <programlisting> <xref linkend="opt-boot.kernelPackages"/> = pkgs.linuxPackages_3_10; </programlisting> - 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. + 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. </para> <para> - The default Linux kernel configuration should be fine for most users. You can see the configuration of your current kernel with the following command: + The default Linux kernel configuration should be fine for most users. You can + see the configuration of your current kernel with the following command: <programlisting> zcat /proc/config.gz </programlisting> - If you want to change the kernel configuration, you can use the <option>packageOverrides</option> feature (see <xref -linkend="sec-customising-packages" />). For instance, to enable support for the kernel debugger KGDB: + If you want to change the kernel configuration, you can use the + <option>packageOverrides</option> feature (see + <xref +linkend="sec-customising-packages" />). For instance, to enable support + for the kernel debugger KGDB: <programlisting> nixpkgs.config.packageOverrides = pkgs: { linux_3_4 = pkgs.linux_3_4.override { @@ -28,31 +36,44 @@ nixpkgs.config.packageOverrides = pkgs: }; }; </programlisting> - <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). + <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). </para> <para> - 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. + 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. <programlisting> <xref linkend="opt-boot.kernelModules"/> = [ "fuse" "kvm-intel" "coretemp" ]; </programlisting> - 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"/>: + 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"/>: <programlisting> <xref linkend="opt-boot.initrd.kernelModules"/> = [ "cifs" ]; </programlisting> - This causes the specified modules and their dependencies to be added to the initial ramdisk. + This causes the specified modules and their dependencies to be added to the + initial ramdisk. </para> <para> - Kernel runtime parameters can be set through <xref linkend="opt-boot.kernel.sysctl"/>, e.g. + Kernel runtime parameters can be set through + <xref linkend="opt-boot.kernel.sysctl"/>, e.g. <programlisting> <xref linkend="opt-boot.kernel.sysctl"/>."net.ipv4.tcp_keepalive_time" = 120; </programlisting> - sets the kernel’s TCP keepalive time to 120 seconds. To see the available parameters, run <command>sysctl -a</command>. + sets the kernel’s TCP keepalive time to 120 seconds. To see the available + parameters, run <command>sysctl -a</command>. </para> <section xml:id="sec-linux-config-customizing"> <title>Customize your kernel</title> <para> - 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>: + 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>: <screen><![CDATA[ custom-kernel = super.linuxManualConfig { inherit (super) stdenv hostPlatform; @@ -63,11 +84,17 @@ nixpkgs.config.packageOverrides = pkgs: allowImportFromDerivation = true; }; ]]></screen> - You can edit the config with this snippet (by default <command>make menuconfig</command> won't work out of the box on nixos): + You can edit the config with this snippet (by default <command>make + menuconfig</command> won't work out of the box on nixos): <screen><![CDATA[ nix-shell -E 'with import <nixpkgs> {}; kernelToOverride.overrideAttrs (o: {nativeBuildInputs=o.nativeBuildInputs ++ [ pkgconfig ncurses ];})' ]]></screen> - 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>). + 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>). <screen><![CDATA[ mptcp93.override ({ @@ -94,7 +121,9 @@ nixpkgs.config.packageOverrides = pkgs: <title>Developing kernel modules</title> <para> - 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. + 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. </para> <screen><![CDATA[ diff --git a/nixos/doc/manual/configuration/luks-file-systems.xml b/nixos/doc/manual/configuration/luks-file-systems.xml index d57fd256b2e..8a2b107e0ee 100644 --- a/nixos/doc/manual/configuration/luks-file-systems.xml +++ b/nixos/doc/manual/configuration/luks-file-systems.xml @@ -6,7 +6,10 @@ <title>LUKS-Encrypted File Systems</title> <para> - 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>: + 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>: <screen> # cryptsetup luksFormat /dev/disk/by-uuid/3f6b0024-3a44-4fde-a43a-767b872abe5d @@ -23,12 +26,15 @@ Enter passphrase for /dev/disk/by-uuid/3f6b0024-3a44-4fde-a43a-767b872abe5d: *** # mkfs.ext4 /dev/mapper/crypted </screen> - To ensure that this file system is automatically mounted at boot time as <filename>/</filename>, add the following to <filename>configuration.nix</filename>: + To ensure that this file system is automatically mounted at boot time as + <filename>/</filename>, add the following to + <filename>configuration.nix</filename>: <programlisting> <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"; <xref linkend="opt-fileSystems"/>."/".device = "/dev/mapper/crypted"; </programlisting> - 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: + 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: <programlisting><xref linkend="opt-boot.loader.grub.enableCryptodisk"/> = true;</programlisting> </para> </section> diff --git a/nixos/doc/manual/configuration/matrix.xml b/nixos/doc/manual/configuration/matrix.xml index c7c7e4e5491..ef8d5cbda88 100644 --- a/nixos/doc/manual/configuration/matrix.xml +++ b/nixos/doc/manual/configuration/matrix.xml @@ -5,16 +5,33 @@ xml:id="module-services-matrix"> <title>Matrix</title> <para> - <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. + <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. </para> <para> - 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. + 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. </para> <section xml:id="module-services-matrix-synapse"> <title>Synapse Homeserver</title> <para> - <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>. + <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>. <programlisting> let fqdn = @@ -104,11 +121,26 @@ in { </para> <para> - 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. + 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. </para> <para> - 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: + 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: <screen> <prompt>$ </prompt>nix run nixpkgs.matrix-synapse <prompt>$ </prompt>register_new_matrix_user -k <replaceable>your-registration-shared-secret</replaceable> http://localhost:8008 @@ -118,14 +150,32 @@ in { <prompt>Make admin [no]:</prompt> Success! </screen> - 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. + 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. </para> </section> <section xml:id="module-services-matrix-riot-web"> <title>Riot Web Client</title> <para> - <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. + <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. <programlisting> services.nginx.virtualHosts."riot.${fqdn}" = { enableACME = true; @@ -140,7 +190,14 @@ services.nginx.virtualHosts."riot.${fqdn}" = { </para> <para> - 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. + 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. </para> </section> </chapter> diff --git a/nixos/doc/manual/configuration/modularity.xml b/nixos/doc/manual/configuration/modularity.xml index b485ff1ebf6..7ad0ae80a48 100644 --- a/nixos/doc/manual/configuration/modularity.xml +++ b/nixos/doc/manual/configuration/modularity.xml @@ -6,11 +6,18 @@ <title>Modularity</title> <para> - 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. + 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. </para> <para> - 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.: + 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.: <programlisting> { config, pkgs, ... }: @@ -20,7 +27,9 @@ <replaceable>...</replaceable> } </programlisting> - Here, we include two modules from the same directory, <filename>vpn.nix</filename> and <filename>kde.nix</filename>. The latter might look like this: + Here, we include two modules from the same directory, + <filename>vpn.nix</filename> and <filename>kde.nix</filename>. The latter + might look like this: <programlisting> { config, pkgs, ... }: @@ -29,32 +38,55 @@ <xref linkend="opt-services.xserver.desktopManager.plasma5.enable"/> = true; } </programlisting> - 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>: + 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>: <programlisting> <xref linkend="opt-boot.kernelModules"/> = mkBefore [ "kvm-intel" ]; </programlisting> - This causes the <literal>kvm-intel</literal> kernel module to be loaded before any other kernel modules. + This causes the <literal>kvm-intel</literal> kernel module to be loaded + before any other kernel modules. </para> <para> - 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: + 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: <screen> The unique option `services.httpd.adminAddr' is defined multiple times, in `/etc/nixos/httpd.nix' and `/etc/nixos/configuration.nix'. </screen> - When that happens, it’s possible to force one definition take precedence over the others: + When that happens, it’s possible to force one definition take precedence + over the others: <programlisting> <xref linkend="opt-services.httpd.adminAddr"/> = pkgs.lib.mkForce "bob@example.org"; </programlisting> </para> <para> - 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 + 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 <footnote xml:id="footnote-nix-is-lazy"> <para> - 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. + 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. </para> </footnote> - . 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: + . 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: <programlisting> { config, pkgs, ... }: @@ -70,7 +102,9 @@ The unique option `services.httpd.adminAddr' is defined multiple times, in `/etc </para> <para> - 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: + 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: <screen> <prompt>$ </prompt>nixos-option <xref linkend="opt-services.xserver.enable"/> true @@ -78,7 +112,8 @@ true <prompt>$ </prompt>nixos-option <xref linkend="opt-boot.kernelModules"/> [ "tun" "ipv6" "loop" <replaceable>...</replaceable> ] </screen> - Interactive exploration of the configuration is possible using <command>nix repl</command>, a read-eval-print loop for Nix expressions. A typical use: + Interactive exploration of the configuration is possible using <command>nix + repl</command>, a read-eval-print loop for Nix expressions. A typical use: <screen> <prompt>$ </prompt>nix repl '<nixpkgs/nixos>' @@ -91,7 +126,9 @@ true </para> <para> - 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. + 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. <programlisting> { config, pkgs, ... }: diff --git a/nixos/doc/manual/configuration/network-manager.xml b/nixos/doc/manual/configuration/network-manager.xml index fb06d60b487..d103ee24978 100644 --- a/nixos/doc/manual/configuration/network-manager.xml +++ b/nixos/doc/manual/configuration/network-manager.xml @@ -6,27 +6,39 @@ <title>NetworkManager</title> <para> - To facilitate network configuration, some desktop environments use NetworkManager. You can enable NetworkManager by setting: + To facilitate network configuration, some desktop environments use + NetworkManager. You can enable NetworkManager by setting: <programlisting> <xref linkend="opt-networking.networkmanager.enable"/> = true; </programlisting> - some desktop managers (e.g., GNOME) enable NetworkManager automatically for you. + some desktop managers (e.g., GNOME) enable NetworkManager automatically for + you. </para> <para> - All users that should have permission to change network settings must belong to the <code>networkmanager</code> group: + All users that should have permission to change network settings must belong + to the <code>networkmanager</code> group: <programlisting> <link linkend="opt-users.users._name__.extraGroups">users.users.alice.extraGroups</link> = [ "networkmanager" ]; </programlisting> </para> <para> - 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). + 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). </para> <note> <para> - <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. + <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. </para> </note> </section> diff --git a/nixos/doc/manual/configuration/networking.xml b/nixos/doc/manual/configuration/networking.xml index 10eeebadb62..02cf811e0bd 100644 --- a/nixos/doc/manual/configuration/networking.xml +++ b/nixos/doc/manual/configuration/networking.xml @@ -5,7 +5,8 @@ xml:id="sec-networking"> <title>Networking</title> <para> - This section describes how to configure networking components on your NixOS machine. + This section describes how to configure networking components on your NixOS + machine. </para> <xi:include href="network-manager.xml" /> <xi:include href="ssh.xml" /> diff --git a/nixos/doc/manual/configuration/package-mgmt.xml b/nixos/doc/manual/configuration/package-mgmt.xml index 6abb83fedcc..e8ac5d0681a 100644 --- a/nixos/doc/manual/configuration/package-mgmt.xml +++ b/nixos/doc/manual/configuration/package-mgmt.xml @@ -5,16 +5,23 @@ xml:id="sec-package-management"> <title>Package Management</title> <para> - This section describes how to add additional packages to your system. NixOS has two distinct styles of package management: + This section describes how to add additional packages to your system. NixOS + has two distinct styles of package management: <itemizedlist> <listitem> <para> - <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. + <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. </para> </listitem> <listitem> <para> - <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. + <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. </para> </listitem> </itemizedlist> diff --git a/nixos/doc/manual/configuration/profiles.xml b/nixos/doc/manual/configuration/profiles.xml index 94a61229398..9d08f7f7bed 100644 --- a/nixos/doc/manual/configuration/profiles.xml +++ b/nixos/doc/manual/configuration/profiles.xml @@ -5,7 +5,12 @@ xml:id="ch-profiles"> <title>Profiles</title> <para> - 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><nixpkgs/nixos/modules/profiles></filename>. That is to say, expected usage is to add them to the imports list of your <filename>/etc/configuration.nix</filename> as such: + 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><nixpkgs/nixos/modules/profiles></filename>. + That is to say, expected usage is to add them to the imports list of your + <filename>/etc/configuration.nix</filename> as such: </para> <programlisting> imports = [ @@ -13,10 +18,12 @@ ]; </programlisting> <para> - 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. + 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. </para> <para> - 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. + 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. </para> <xi:include href="profiles/all-hardware.xml" /> <xi:include href="profiles/base.xml" /> diff --git a/nixos/doc/manual/configuration/profiles/all-hardware.xml b/nixos/doc/manual/configuration/profiles/all-hardware.xml index 41593432d81..2936f71069d 100644 --- a/nixos/doc/manual/configuration/profiles/all-hardware.xml +++ b/nixos/doc/manual/configuration/profiles/all-hardware.xml @@ -6,10 +6,16 @@ <title>All Hardware</title> <para> - 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. + 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. </para> <para> - 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. + 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. </para> </section> diff --git a/nixos/doc/manual/configuration/profiles/base.xml b/nixos/doc/manual/configuration/profiles/base.xml index 31e10ebca55..b75f6ba25b4 100644 --- a/nixos/doc/manual/configuration/profiles/base.xml +++ b/nixos/doc/manual/configuration/profiles/base.xml @@ -6,6 +6,10 @@ <title>Base</title> <para> - 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). + 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). </para> </section> diff --git a/nixos/doc/manual/configuration/profiles/clone-config.xml b/nixos/doc/manual/configuration/profiles/clone-config.xml index 95a4d292c40..04fa1643d0f 100644 --- a/nixos/doc/manual/configuration/profiles/clone-config.xml +++ b/nixos/doc/manual/configuration/profiles/clone-config.xml @@ -6,10 +6,16 @@ <title>Clone Config</title> <para> - 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. + 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. </para> <para> - 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>. + 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>. </para> </section> diff --git a/nixos/doc/manual/configuration/profiles/demo.xml b/nixos/doc/manual/configuration/profiles/demo.xml index 9e9694c19ab..395a5ec357c 100644 --- a/nixos/doc/manual/configuration/profiles/demo.xml +++ b/nixos/doc/manual/configuration/profiles/demo.xml @@ -6,6 +6,10 @@ <title>Demo</title> <para> - 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>. + 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>. </para> </section> diff --git a/nixos/doc/manual/configuration/profiles/docker-container.xml b/nixos/doc/manual/configuration/profiles/docker-container.xml index b57020ebb78..efa7b8f24c4 100644 --- a/nixos/doc/manual/configuration/profiles/docker-container.xml +++ b/nixos/doc/manual/configuration/profiles/docker-container.xml @@ -6,6 +6,11 @@ <title>Docker Container</title> <para> - 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"/>. + 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"/>. </para> </section> diff --git a/nixos/doc/manual/configuration/profiles/graphical.xml b/nixos/doc/manual/configuration/profiles/graphical.xml index 1dfd9d642e2..73e3abc59d0 100644 --- a/nixos/doc/manual/configuration/profiles/graphical.xml +++ b/nixos/doc/manual/configuration/profiles/graphical.xml @@ -6,10 +6,17 @@ <title>Graphical</title> <para> - Defines a NixOS configuration with the Plasma 5 desktop. It's used by the graphical installation CD. + Defines a NixOS configuration with the Plasma 5 desktop. It's used by the + graphical installation CD. </para> <para> - 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. + 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. </para> </section> diff --git a/nixos/doc/manual/configuration/profiles/hardened.xml b/nixos/doc/manual/configuration/profiles/hardened.xml index 2cb23f6d5d0..dc83fc837e2 100644 --- a/nixos/doc/manual/configuration/profiles/hardened.xml +++ b/nixos/doc/manual/configuration/profiles/hardened.xml @@ -6,11 +6,19 @@ <title>Hardened</title> <para> - A profile with most (vanilla) hardening options enabled by default, potentially at the cost of features and performance. + A profile with most (vanilla) hardening options enabled by default, + potentially at the cost of features and performance. </para> <para> - 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 - 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. + 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 + 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. </para> </section> diff --git a/nixos/doc/manual/configuration/profiles/headless.xml b/nixos/doc/manual/configuration/profiles/headless.xml index 3fceb6f912b..1b64497ebf7 100644 --- a/nixos/doc/manual/configuration/profiles/headless.xml +++ b/nixos/doc/manual/configuration/profiles/headless.xml @@ -10,6 +10,10 @@ </para> <para> - 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. + 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. </para> </section> diff --git a/nixos/doc/manual/configuration/profiles/installation-device.xml b/nixos/doc/manual/configuration/profiles/installation-device.xml index af9f551fa98..192ae955b68 100644 --- a/nixos/doc/manual/configuration/profiles/installation-device.xml +++ b/nixos/doc/manual/configuration/profiles/installation-device.xml @@ -6,18 +6,31 @@ <title>Installation Device</title> <para> - 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. + 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. </para> - <para> - 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. + 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. </para> - <para> - It is explained how to login, start the ssh server, and if available, how to start the display manager. + It is explained how to login, start the ssh server, and if available, + how to start the display manager. </para> <para> - Several settings are tweaked so that the installer has a better chance of succeeding under low-memory environments. + Several settings are tweaked so that the installer has a better chance of + succeeding under low-memory environments. </para> </section> diff --git a/nixos/doc/manual/configuration/profiles/minimal.xml b/nixos/doc/manual/configuration/profiles/minimal.xml index 82aa15c174a..179f2d0be64 100644 --- a/nixos/doc/manual/configuration/profiles/minimal.xml +++ b/nixos/doc/manual/configuration/profiles/minimal.xml @@ -6,6 +6,12 @@ <title>Minimal</title> <para> - 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>. + 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>. </para> </section> diff --git a/nixos/doc/manual/configuration/profiles/qemu-guest.xml b/nixos/doc/manual/configuration/profiles/qemu-guest.xml index 265f2746f3c..5d055c45d2d 100644 --- a/nixos/doc/manual/configuration/profiles/qemu-guest.xml +++ b/nixos/doc/manual/configuration/profiles/qemu-guest.xml @@ -6,10 +6,13 @@ <title>QEMU Guest</title> <para> - This profile contains common configuration for virtual machines running under QEMU (using virtio). + This profile contains common configuration for virtual machines running under + QEMU (using virtio). </para> <para> - 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>. + 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>. </para> </section> diff --git a/nixos/doc/manual/configuration/ssh.xml b/nixos/doc/manual/configuration/ssh.xml index 9e5c0c1dbdb..a4af1b96583 100644 --- a/nixos/doc/manual/configuration/ssh.xml +++ b/nixos/doc/manual/configuration/ssh.xml @@ -10,11 +10,14 @@ <programlisting> <xref linkend="opt-services.openssh.enable"/> = true; </programlisting> - 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>. + 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>. </para> <para> - You can declaratively specify authorised RSA/DSA public keys for a user as follows: + You can declaratively specify authorised RSA/DSA public keys for a user as + follows: <!-- FIXME: this might not work if the user is unmanaged. --> <programlisting> <link linkend="opt-users.users._name__.openssh.authorizedKeys.keys">users.users.alice.openssh.authorizedKeys.keys</link> = diff --git a/nixos/doc/manual/configuration/summary.xml b/nixos/doc/manual/configuration/summary.xml index c9c8b67b0cf..ea980254a8f 100644 --- a/nixos/doc/manual/configuration/summary.xml +++ b/nixos/doc/manual/configuration/summary.xml @@ -6,8 +6,12 @@ <title>Syntax Summary</title> <para> - 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 -xlink:href="http://nixos.org/nix/manual/#chap-writing-nix-expressions">Nix manual</link> for the rest. + 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 +xlink:href="http://nixos.org/nix/manual/#chap-writing-nix-expressions">Nix + manual</link> for the rest. </para> <informaltable frame='none'> diff --git a/nixos/doc/manual/configuration/user-mgmt.xml b/nixos/doc/manual/configuration/user-mgmt.xml index db8323ec4d4..4b1710f3a2b 100644 --- a/nixos/doc/manual/configuration/user-mgmt.xml +++ b/nixos/doc/manual/configuration/user-mgmt.xml @@ -5,7 +5,10 @@ xml:id="sec-user-management"> <title>User Management</title> <para> - 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: + 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: <programlisting> <xref linkend="opt-users.users"/>.alice = { <link linkend="opt-users.users._name__.isNormalUser">isNormalUser</link> = true; @@ -15,33 +18,60 @@ <link linkend="opt-users.users._name__.openssh.authorizedKeys.keys">openssh.authorizedKeys.keys</link> = [ "ssh-dss AAAAB3Nza... alice@foobar" ]; }; </programlisting> - 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>. + 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>. </para> <para> - 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. + 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. </para> <para> - A user ID (uid) is assigned automatically. You can also specify a uid manually by adding + A user ID (uid) is assigned automatically. You can also specify a uid + manually by adding <programlisting> uid = 1000; </programlisting> to the user specification. </para> <para> - Groups can be specified similarly. The following states that a group named <literal>students</literal> shall exist: + Groups can be specified similarly. The following states that a group named + <literal>students</literal> shall exist: <programlisting> <xref linkend="opt-users.groups"/>.students.gid = 1000; </programlisting> - As with users, the group ID (gid) is optional and will be assigned automatically if it’s missing. + As with users, the group ID (gid) is optional and will be assigned + automatically if it’s missing. </para> <para> - 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>: + 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>: <screen> # useradd -m alice</screen> - 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: + 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: <screen> # su - alice -c "true"</screen> - 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: + 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: <screen> # passwd alice Enter new UNIX password: *** @@ -50,6 +80,9 @@ Retype new UNIX password: *** A user can be deleted using <command>userdel</command>: <screen> # userdel -r alice</screen> - 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>. + 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>. </para> </chapter> diff --git a/nixos/doc/manual/configuration/wireless.xml b/nixos/doc/manual/configuration/wireless.xml index 5c203423997..9c0e3a8d7aa 100644 --- a/nixos/doc/manual/configuration/wireless.xml +++ b/nixos/doc/manual/configuration/wireless.xml @@ -6,7 +6,9 @@ <title>Wireless Networks</title> <para> - 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. + 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. </para> <para> @@ -23,13 +25,17 @@ "free.wifi" = {}; }; </programlisting> - 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> + 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> <refentrytitle>wpa_supplicant.conf</refentrytitle> <manvolnum>5</manvolnum> </citerefentry>). </para> <para> - If you are using WPA2 you can generate pskRaw key using <command>wpa_passphrase</command>: + If you are using WPA2 you can generate pskRaw key using + <command>wpa_passphrase</command>: <screen> <prompt>$ </prompt>wpa_passphrase ESSID PSK network={ @@ -45,10 +51,12 @@ network={ }; } </programlisting> - or you can use it to directly generate the <literal>wpa_supplicant.conf</literal>: + or you can use it to directly generate the + <literal>wpa_supplicant.conf</literal>: <screen> <prompt># </prompt>wpa_passphrase ESSID PSK > /etc/wpa_supplicant.conf</screen> - After you have edited the <literal>wpa_supplicant.conf</literal>, you need to restart the wpa_supplicant service. + After you have edited the <literal>wpa_supplicant.conf</literal>, you need to + restart the wpa_supplicant service. <screen> <prompt># </prompt>systemctl restart wpa_supplicant.service</screen> </para> diff --git a/nixos/doc/manual/configuration/x-windows.xml b/nixos/doc/manual/configuration/x-windows.xml index 2d65ba479aa..f6f659b02af 100644 --- a/nixos/doc/manual/configuration/x-windows.xml +++ b/nixos/doc/manual/configuration/x-windows.xml @@ -5,18 +5,23 @@ xml:id="sec-x11"> <title>X Window System</title> <para> - The X Window System (X11) provides the basis of NixOS’ graphical user interface. It can be enabled as follows: + The X Window System (X11) provides the basis of NixOS’ graphical user + interface. It can be enabled as follows: <programlisting> <xref linkend="opt-services.xserver.enable"/> = true; </programlisting> - 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. + 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. <programlisting> <xref linkend="opt-services.xserver.videoDrivers"/> = [ "r128" ]; </programlisting> to enable X.org’s <literal>xf86-video-r128</literal> driver. </para> <para> - 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: + 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: <programlisting> <xref linkend="opt-services.xserver.desktopManager.plasma5.enable"/> = true; <xref linkend="opt-services.xserver.desktopManager.xfce.enable"/> = true; @@ -29,7 +34,9 @@ </programlisting> </para> <para> - 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: + 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: <programlisting> <xref linkend="opt-services.xserver.displayManager.sddm.enable"/> = true; <xref linkend="opt-services.xserver.displayManager.slim.enable"/> = true; @@ -43,7 +50,8 @@ </programlisting> </para> <para> - The X server is started automatically at boot time. If you don’t want this to happen, you can set: + The X server is started automatically at boot time. If you don’t want this + to happen, you can set: <programlisting> <xref linkend="opt-services.xserver.autorun"/> = false; </programlisting> @@ -53,7 +61,8 @@ </screen> </para> <para> - On 64-bit systems, if you want OpenGL for 32-bit programs such as in Wine, you should also set the following: + On 64-bit systems, if you want OpenGL for 32-bit programs such as in Wine, + you should also set the following: <programlisting> <xref linkend="opt-hardware.opengl.driSupport32Bit"/> = true; </programlisting> @@ -61,18 +70,23 @@ <simplesect xml:id="sec-x11-auto-login"> <title>Auto-login</title> <para> - The x11 login screen can be skipped entirely, automatically logging you into your window manager and desktop environment when you boot your computer. + The x11 login screen can be skipped entirely, automatically logging you into + your window manager and desktop environment when you boot your computer. </para> <para> - 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. + 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. </para> <para> - 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: + 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: <programlisting> <xref linkend="opt-services.xserver.desktopManager.default"/> = "none"; <xref linkend="opt-services.xserver.windowManager.default"/> = "i3"; </programlisting> - And, finally, to enable auto-login for a user <literal>johndoe</literal>: + And, finally, to enable auto-login for a user <literal>johndoe</literal>: <programlisting> <xref linkend="opt-services.xserver.displayManager.auto.enable"/> = true; <xref linkend="opt-services.xserver.displayManager.auto.user"/> = "johndoe"; @@ -82,7 +96,9 @@ <simplesect xml:id="sec-x11-graphics-cards-nvidia"> <title>Proprietary NVIDIA drivers</title> <para> - 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: + 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: <programlisting> <xref linkend="opt-services.xserver.videoDrivers"/> = [ "nvidia" ]; </programlisting> @@ -93,51 +109,76 @@ <xref linkend="opt-services.xserver.videoDrivers"/> = [ "nvidiaLegacy304" ]; <xref linkend="opt-services.xserver.videoDrivers"/> = [ "nvidiaLegacy173" ]; </programlisting> - You may need to reboot after enabling this driver to prevent a clash with other kernel modules. + You may need to reboot after enabling this driver to prevent a clash with + other kernel modules. </para> </simplesect> <simplesect xml:id="sec-x11--graphics-cards-amd"> <title>Proprietary AMD drivers</title> <para> - 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: + 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: <programlisting> <xref linkend="opt-services.xserver.videoDrivers"/> = [ "ati_unfree" ]; </programlisting> - You will need to reboot after enabling this driver to prevent a clash with other kernel modules. + You will need to reboot after enabling this driver to prevent a clash with + other kernel modules. </para> <note> - <para> - For recent AMD GPUs you most likely want to keep either the defaults or <literal>"amdgpu"</literal> (both free). - </para> + <para> + For recent AMD GPUs you most likely want to keep either the defaults + or <literal>"amdgpu"</literal> (both free). + </para> </note> </simplesect> <simplesect xml:id="sec-x11-touchpads"> <title>Touchpads</title> <para> - Support for Synaptics touchpads (found in many laptops such as the Dell Latitude series) can be enabled as follows: + Support for Synaptics touchpads (found in many laptops such as the Dell + Latitude series) can be enabled as follows: <programlisting> <xref linkend="opt-services.xserver.libinput.enable"/> = true; </programlisting> - The driver has many options (see <xref linkend="ch-options"/>). For instance, the following disables tap-to-click behavior: + The driver has many options (see <xref linkend="ch-options"/>). For + instance, the following disables tap-to-click behavior: <programlisting> <xref linkend="opt-services.xserver.libinput.tapping"/> = false; </programlisting> - Note: the use of <literal>services.xserver.synaptics</literal> is deprecated since NixOS 17.09. + Note: the use of <literal>services.xserver.synaptics</literal> is deprecated + since NixOS 17.09. </para> </simplesect> <simplesect xml:id="sec-x11-gtk-and-qt-themes"> <title>GTK/Qt themes</title> <para> - 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. + 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. </para> </simplesect> <simplesect xml:id="custom-xkb-layouts"> <title>Custom XKB layouts</title> <para> - 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. + 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. </para> <para> - To do this we are going to create a <literal>us-greek</literal> file with a <literal>xkb_symbols</literal> section. + To do this we are going to create a <literal>us-greek</literal> file + with a <literal>xkb_symbols</literal> section. </para> <programlisting> xkb_symbols "us-greek" @@ -153,7 +194,8 @@ xkb_symbols "us-greek" }; </programlisting> <para> - To install the layout, the filepath, a description and the list of languages must be given: + To install the layout, the filepath, a description and the list of + languages must be given: </para> <programlisting> <xref linkend="opt-services.xserver.extraLayouts"/>.us-greek = { @@ -163,18 +205,32 @@ xkb_symbols "us-greek" } </programlisting> <note> - <para> - The name should match the one given to the <literal>xkb_symbols</literal> block. - </para> + <para> + The name should match the one given to the + <literal>xkb_symbols</literal> block. + </para> </note> <para> - The layout should now be installed and ready to use: try it by running <literal>setxkbmap us-greek</literal> and type <literal><alt>+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. + The layout should now be installed and ready to use: try it by + running <literal>setxkbmap us-greek</literal> and type + <literal><alt>+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. </para> <para> - 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. + 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. </para> <para> - 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 + 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 </para> <programlisting> xkb_keycodes "media" @@ -184,7 +240,7 @@ xkb_keycodes "media" } </programlisting> <para> - Now use the newly define keycodes in <literal>media-sym</literal>: + Now use the newly define keycodes in <literal>media-sym</literal>: </para> <programlisting> xkb_symbols "media" @@ -195,7 +251,7 @@ xkb_symbols "media" } </programlisting> <para> - As before, to install the layout do + As before, to install the layout do </para> <programlisting> <xref linkend="opt-services.xserver.extraLayouts"/>.media = { @@ -206,22 +262,37 @@ xkb_symbols "media" }; </programlisting> <note> - <para> - The function <literal>pkgs.writeText <filename> <content> </literal> can be useful if you prefer to keep the layout definitions inside the NixOS configuration. - </para> + <para> + The function <literal>pkgs.writeText <filename> <content> + </literal> can be useful if you prefer to keep the layout definitions + inside the NixOS configuration. + </para> </note> <para> - 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: + 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: </para> <programlisting> <xref linkend="opt-services.xserver.displayManager.sessionCommands"/> = "setxkbmap -keycodes media"; </programlisting> <para> - 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 -<screen><prompt>$ </prompt>xinit -- -xkbdir /etc/X11/xkb</screen> + 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 + <screen><prompt>$ </prompt>xinit -- -xkbdir /etc/X11/xkb</screen> </para> <para> - 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>. + 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>. </para> - </simplesect> +</simplesect> </chapter> diff --git a/nixos/doc/manual/configuration/xfce.xml b/nixos/doc/manual/configuration/xfce.xml index 7a93a452fd9..6ac99c6b2be 100644 --- a/nixos/doc/manual/configuration/xfce.xml +++ b/nixos/doc/manual/configuration/xfce.xml @@ -14,7 +14,8 @@ </programlisting> </para> <para> - Optionally, <emphasis>compton</emphasis> can be enabled for nice graphical effects, some example settings: + Optionally, <emphasis>compton</emphasis> can be enabled for nice graphical + effects, some example settings: <programlisting> <link linkend="opt-services.compton.enable">services.compton</link> = { <link linkend="opt-services.compton.enable">enable</link> = true; @@ -26,7 +27,9 @@ </programlisting> </para> <para> - Some Xfce programs are not installed automatically. To install them manually (system wide), put them into your <xref linkend="opt-environment.systemPackages"/>. + Some Xfce programs are not installed automatically. To install them manually + (system wide), put them into your + <xref linkend="opt-environment.systemPackages"/>. </para> <simplesect xml:id="sec-xfce-thunar-volumes"> <title>Thunar Volume Support</title> @@ -41,17 +44,25 @@ <simplesect xml:id="sec-xfce-polkit"> <title>Polkit Authentication Agent</title> <para> - 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. + 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. </para> </simplesect> <simplesect xml:id="sec-xfce-troubleshooting"> <title>Troubleshooting</title> <para> - 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>). + 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>). <programlisting> Thunar:2410): GVFS-RemoteVolumeMonitor-WARNING **: remote volume monitor with dbus name org.gtk.Private.UDisks2VolumeMonitor is not supported </programlisting> - 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. + 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. <programlisting> <prompt>$ </prompt>xfconf-query -c xfce4-session -p /compat/LaunchGNOME -s true </programlisting> diff --git a/nixos/doc/manual/development/assertions.xml b/nixos/doc/manual/development/assertions.xml index c7d5b960aa6..32f90cf2e7c 100644 --- a/nixos/doc/manual/development/assertions.xml +++ b/nixos/doc/manual/development/assertions.xml @@ -6,11 +6,18 @@ <title>Warnings and Assertions</title> <para> - 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. + 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. </para> <para> - 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. + 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. </para> <section xml:id="sec-assertions-warnings"> @@ -41,7 +48,12 @@ <title>Assertions</title> <para> - 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. + 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. </para> <programlisting> diff --git a/nixos/doc/manual/development/building-nixos.xml b/nixos/doc/manual/development/building-nixos.xml index a4bb18656e0..56a596baed0 100644 --- a/nixos/doc/manual/development/building-nixos.xml +++ b/nixos/doc/manual/development/building-nixos.xml @@ -5,17 +5,22 @@ xml:id="sec-building-cd"> <title>Building Your Own NixOS CD</title> <para> - 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. + 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. </para> <para> - Default CD/DVD configurations are available inside <filename>nixos/modules/installer/cd-dvd</filename>. + Default CD/DVD configurations are available inside + <filename>nixos/modules/installer/cd-dvd</filename>. <screen> <prompt>$ </prompt>git clone https://github.com/NixOS/nixpkgs.git <prompt>$ </prompt>cd nixpkgs/nixos <prompt>$ </prompt>nix-build -A config.system.build.isoImage -I nixos-config=modules/installer/cd-dvd/installation-cd-minimal.nix default.nix</screen> </para> <para> - Before burning your CD/DVD, you can check the content of the image by mounting anywhere like suggested by the following command: + Before burning your CD/DVD, you can check the content of the image by + mounting anywhere like suggested by the following command: <screen> <prompt># </prompt>mount -o loop -t iso9660 ./result/iso/cd.iso /mnt/iso</screen> </para> diff --git a/nixos/doc/manual/development/building-parts.xml b/nixos/doc/manual/development/building-parts.xml index e05a1342b7a..88369fb891b 100644 --- a/nixos/doc/manual/development/building-parts.xml +++ b/nixos/doc/manual/development/building-parts.xml @@ -5,11 +5,14 @@ xml:id="sec-building-parts"> <title>Building Specific Parts of NixOS</title> <para> - With the command <command>nix-build</command>, you can build specific parts of your NixOS configuration. This is done as follows: + With the command <command>nix-build</command>, you can build specific parts + of your NixOS configuration. This is done as follows: <screen> <prompt>$ </prompt>cd <replaceable>/path/to/nixpkgs/nixos</replaceable> <prompt>$ </prompt>nix-build -A config.<replaceable>option</replaceable></screen> - where <replaceable>option</replaceable> is a NixOS option with type “derivation” (i.e. something that can be built). Attributes of interest include: + where <replaceable>option</replaceable> is a NixOS option with type + “derivation” (i.e. something that can be built). Attributes of interest + include: <variablelist> <varlistentry> <term> @@ -17,7 +20,10 @@ </term> <listitem> <para> - 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. + 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. </para> <para> A shortcut to build this is: @@ -42,7 +48,8 @@ </term> <listitem> <para> - A tree of symlinks that form the static parts of <filename>/etc</filename>. + A tree of symlinks that form the static parts of + <filename>/etc</filename>. </para> </listitem> </varlistentry> @@ -55,7 +62,9 @@ </term> <listitem> <para> - 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: + 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: <screen> <prompt>$ </prompt>nix-build -A config.system.build.initialRamdisk -o initrd <prompt>$ </prompt>nix-build -A config.system.build.kernel -o kernel @@ -86,18 +95,24 @@ </term> <listitem> <para> - 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: + 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: <screen> <prompt>$ </prompt>nix-build -A 'config.systemd.units."httpd.service".unit' </screen> - You can also test individual units, without rebuilding the whole system, by putting them in <filename>/run/systemd/system</filename>: + You can also test individual units, without rebuilding the whole system, + by putting them in <filename>/run/systemd/system</filename>: <screen> <prompt>$ </prompt>cp $(nix-build -A 'config.systemd.units."httpd.service".unit')/httpd.service \ /run/systemd/system/tmp-httpd.service <prompt># </prompt>systemctl daemon-reload <prompt># </prompt>systemctl start tmp-httpd.service </screen> - 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. + 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. </para> </listitem> </varlistentry> diff --git a/nixos/doc/manual/development/importing-modules.xml b/nixos/doc/manual/development/importing-modules.xml index 0d57681783e..1c6a5671eda 100644 --- a/nixos/doc/manual/development/importing-modules.xml +++ b/nixos/doc/manual/development/importing-modules.xml @@ -6,7 +6,8 @@ <title>Importing Modules</title> <para> - Sometimes NixOS modules need to be used in configuration but exist outside of Nixpkgs. These modules can be imported: + Sometimes NixOS modules need to be used in configuration but exist outside of + Nixpkgs. These modules can be imported: </para> <programlisting> @@ -24,7 +25,9 @@ </programlisting> <para> - 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: + 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: </para> <programlisting> diff --git a/nixos/doc/manual/development/meta-attributes.xml b/nixos/doc/manual/development/meta-attributes.xml index fd15bd3638f..3d019a4987e 100644 --- a/nixos/doc/manual/development/meta-attributes.xml +++ b/nixos/doc/manual/development/meta-attributes.xml @@ -6,12 +6,18 @@ <title>Meta Attributes</title> <para> - Like Nix packages, NixOS modules can declare meta-attributes to provide extra information. Module meta attributes are defined in the <filename - xlink:href="https://github.com/NixOS/nixpkgs/blob/master/nixos/modules/misc/meta.nix">meta.nix</filename> special module. + Like Nix packages, NixOS modules can declare meta-attributes to provide extra + information. Module meta attributes are defined in the + <filename + xlink:href="https://github.com/NixOS/nixpkgs/blob/master/nixos/modules/misc/meta.nix">meta.nix</filename> + special module. </para> <para> - <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>. + <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>. </para> <para> @@ -45,8 +51,11 @@ </callout> <callout arearefs='modules-meta-2'> <para> - <varname>doc</varname> points to a valid DocBook file containing the module documentation. Its contents is automatically added to <xref - linkend="ch-configuration"/>. Changes to a module documentation have to be checked to not break building the NixOS manual: + <varname>doc</varname> points to a valid DocBook file containing the module + documentation. Its contents is automatically added to + <xref + linkend="ch-configuration"/>. Changes to a module documentation + have to be checked to not break building the NixOS manual: </para> <programlisting>$ nix-build nixos/release.nix -A manual</programlisting> </callout> diff --git a/nixos/doc/manual/development/nixos-tests.xml b/nixos/doc/manual/development/nixos-tests.xml index aedc40e93a6..2695082e386 100644 --- a/nixos/doc/manual/development/nixos-tests.xml +++ b/nixos/doc/manual/development/nixos-tests.xml @@ -5,8 +5,13 @@ xml:id="sec-nixos-tests"> <title>NixOS Tests</title> <para> - When you add some feature to NixOS, you should write a test for it. NixOS tests are kept in the directory <filename -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. + When you add some feature to NixOS, you should write a test for it. NixOS + tests are kept in the directory + <filename +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. </para> <xi:include href="writing-nixos-tests.xml" /> <xi:include href="running-nixos-tests.xml" /> diff --git a/nixos/doc/manual/development/option-declarations.xml b/nixos/doc/manual/development/option-declarations.xml index d6fb3f8f687..eee81bf6426 100644 --- a/nixos/doc/manual/development/option-declarations.xml +++ b/nixos/doc/manual/development/option-declarations.xml @@ -6,7 +6,9 @@ <title>Option Declarations</title> <para> - 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: + 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: <programlisting> options = { <replaceable>name</replaceable> = mkOption { @@ -17,8 +19,13 @@ options = { }; }; </programlisting> - The attribute names within the <replaceable>name</replaceable> attribute path must be camel cased in general but should, as an exception, match the <link -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. + The attribute names within the <replaceable>name</replaceable> attribute path + must be camel cased in general but should, as an exception, match the + <link +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. </para> <para> @@ -30,7 +37,9 @@ xlink:href="https://nixos.org/nixpkgs/manual/#sec-package-naming"> package attri </term> <listitem> <para> - 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. + 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. </para> </listitem> </varlistentry> @@ -40,7 +49,10 @@ xlink:href="https://nixos.org/nixpkgs/manual/#sec-package-naming"> package attri </term> <listitem> <para> - 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. + 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. </para> </listitem> </varlistentry> @@ -60,7 +72,8 @@ xlink:href="https://nixos.org/nixpkgs/manual/#sec-package-naming"> package attri </term> <listitem> <para> - A textual description of the option, in DocBook format, that will be included in the NixOS manual. + A textual description of the option, in DocBook format, that will be + included in the NixOS manual. </para> </listitem> </varlistentry> @@ -71,15 +84,22 @@ xlink:href="https://nixos.org/nixpkgs/manual/#sec-package-naming"> package attri <title>Extensible Option Types</title> <para> - 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. + 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. </para> <para> - 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. + 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. </para> <para> - 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 ...). + 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 ...). </para> <para> @@ -87,12 +107,14 @@ xlink:href="https://nixos.org/nixpkgs/manual/#sec-package-naming"> package attri <itemizedlist> <listitem> <para> - Managing the display managers independently by adding an enable option to every display manager module backend. (NixOS) + Managing the display managers independently by adding an enable option to + every display manager module backend. (NixOS) </para> </listitem> <listitem> <para> - Managing the display managers in the central module by adding an option to select which display manager backend to use. + Managing the display managers in the central module by adding an option + to select which display manager backend to use. </para> </listitem> </itemizedlist> @@ -103,22 +125,37 @@ xlink:href="https://nixos.org/nixpkgs/manual/#sec-package-naming"> package attri </para> <para> - 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. + 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. </para> <para> - 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. + 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. </para> <para> - By using extensible option types, it is possible to create a placeholder option in the central module (<xref linkend='ex-option-declaration-eot-service' - />), and to extend it in each backend module (<xref - linkend='ex-option-declaration-eot-backend-slim' />, <xref + By using extensible option types, it is possible to create a placeholder + option in the central module + (<xref linkend='ex-option-declaration-eot-service' + />), and to extend + it in each backend module + (<xref + linkend='ex-option-declaration-eot-backend-slim' />, + <xref linkend='ex-option-declaration-eot-backend-sddm' />). </para> <para> - 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. + 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. </para> <example xml:id='ex-option-declaration-eot-service'> @@ -147,11 +184,16 @@ services.xserver.displayManager.enable = mkOption { </example> <para> - 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. + 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. </para> <para> - 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>. + 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>. </para> </section> </section> diff --git a/nixos/doc/manual/development/option-def.xml b/nixos/doc/manual/development/option-def.xml index 883778c7eb9..50a705d0cb8 100644 --- a/nixos/doc/manual/development/option-def.xml +++ b/nixos/doc/manual/development/option-def.xml @@ -6,26 +6,33 @@ <title>Option Definitions</title> <para> - Option definitions are generally straight-forward bindings of values to option names, like + Option definitions are generally straight-forward bindings of values to + option names, like <programlisting> config = { services.httpd.enable = true; }; </programlisting> - However, sometimes you need to wrap an option definition or set of option definitions in a <emphasis>property</emphasis> to achieve certain effects: + However, sometimes you need to wrap an option definition or set of option + definitions in a <emphasis>property</emphasis> to achieve certain effects: </para> <simplesect xml:id="sec-option-definitions-delaying-conditionals"> <title>Delaying Conditionals</title> <para> - 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: + 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: <programlisting> config = if config.services.httpd.enable then { environment.systemPackages = [ <replaceable>...</replaceable> ]; <replaceable>...</replaceable> } else {}; </programlisting> - 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: + 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: <programlisting> config = if config.services.httpd.enable then { services.httpd.enable = false; @@ -40,7 +47,9 @@ config = mkIf config.services.httpd.enable { <replaceable>...</replaceable> }; </programlisting> - 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: + 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: <programlisting> config = { environment.systemPackages = if config.services.httpd.enable then [ <replaceable>...</replaceable> ] else []; @@ -53,18 +62,27 @@ config = { <simplesect xml:id="sec-option-definitions-setting-priorities"> <title>Setting Priorities</title> <para> - 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. + 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. <programlisting> services.openssh.enable = mkOverride 10 false; </programlisting> - 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>. + 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>. </para> </simplesect> <simplesect xml:id="sec-option-definitions-merging"> <title>Merging Configurations</title> <para> - 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>: + 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>: <programlisting> config = mkMerge [ # Unconditional stuff. diff --git a/nixos/doc/manual/development/option-types.xml b/nixos/doc/manual/development/option-types.xml index 7cd26e4c937..8fcbb627342 100644 --- a/nixos/doc/manual/development/option-types.xml +++ b/nixos/doc/manual/development/option-types.xml @@ -6,14 +6,18 @@ <title>Options Types</title> <para> - 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. + 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. </para> <section xml:id="sec-option-types-basic"> <title>Basic Types</title> <para> - 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. + 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. </para> <variablelist> @@ -33,7 +37,8 @@ </term> <listitem> <para> - A boolean, its values can be <literal>true</literal> or <literal>false</literal>. + A boolean, its values can be <literal>true</literal> or + <literal>false</literal>. </para> </listitem> </varlistentry> @@ -43,7 +48,9 @@ </term> <listitem> <para> - 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. + 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. </para> </listitem> </varlistentry> @@ -80,7 +87,12 @@ </term> <listitem> <para> - 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). + 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). </para> </listitem> </varlistentry> @@ -100,7 +112,12 @@ </term> <listitem> <para> - 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). + 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). </para> </listitem> </varlistentry> @@ -120,7 +137,8 @@ </term> <listitem> <para> - A port number. This type is an alias to <link linkend='types.ints.ux'><varname>types.ints.u16</varname></link>. + A port number. This type is an alias to + <link linkend='types.ints.ux'><varname>types.ints.u16</varname></link>. </para> </listitem> </varlistentry> @@ -147,7 +165,8 @@ </term> <listitem> <para> - A string. Multiple definitions are concatenated with a new line <literal>"\n"</literal>. + A string. Multiple definitions are concatenated with a new line + <literal>"\n"</literal>. </para> </listitem> </varlistentry> @@ -157,7 +176,8 @@ </term> <listitem> <para> - A string. Multiple definitions are concatenated with a comma <literal>","</literal>. + A string. Multiple definitions are concatenated with a comma + <literal>","</literal>. </para> </listitem> </varlistentry> @@ -167,7 +187,8 @@ </term> <listitem> <para> - A string. Multiple definitions are concatenated with a collon <literal>":"</literal>. + A string. Multiple definitions are concatenated with a collon + <literal>":"</literal>. </para> </listitem> </varlistentry> @@ -177,7 +198,9 @@ </term> <listitem> <para> - A string matching a specific regular expression. Multiple definitions cannot be merged. The regular expression is processed using <literal>builtins.match</literal>. + A string matching a specific regular expression. Multiple definitions + cannot be merged. The regular expression is processed using + <literal>builtins.match</literal>. </para> </listitem> </varlistentry> @@ -198,7 +221,9 @@ </term> <listitem> <para> - One element of the list <replaceable>l</replaceable>, e.g. <literal>types.enum [ "left" "right" ]</literal>. Multiple definitions cannot be merged. + One element of the list <replaceable>l</replaceable>, e.g. + <literal>types.enum [ "left" "right" ]</literal>. Multiple definitions + cannot be merged. </para> </listitem> </varlistentry> @@ -208,7 +233,8 @@ </term> <listitem> <para> - A string with a custom separator <replaceable>sep</replaceable>, e.g. <literal>types.separatedString "|"</literal>. + A string with a custom separator <replaceable>sep</replaceable>, e.g. + <literal>types.separatedString "|"</literal>. </para> </listitem> </varlistentry> @@ -218,7 +244,9 @@ </term> <listitem> <para> - An integer between <replaceable>lowest</replaceable> and <replaceable>highest</replaceable> (both inclusive). Useful for creating types like <literal>types.port</literal>. + An integer between <replaceable>lowest</replaceable> and + <replaceable>highest</replaceable> (both inclusive). Useful for creating + types like <literal>types.port</literal>. </para> </listitem> </varlistentry> @@ -228,7 +256,11 @@ </term> <listitem> <para> - 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 + 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 linkend='section-option-types-submodule' />. </para> </listitem> @@ -240,7 +272,9 @@ <title>Composed Types</title> <para> - 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. + 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. </para> <variablelist> @@ -250,7 +284,8 @@ </term> <listitem> <para> - A list of <replaceable>t</replaceable> type, e.g. <literal>types.listOf int</literal>. Multiple definitions are merged with list concatenation. + A list of <replaceable>t</replaceable> type, e.g. <literal>types.listOf + int</literal>. Multiple definitions are merged with list concatenation. </para> </listitem> </varlistentry> @@ -260,7 +295,9 @@ </term> <listitem> <para> - An attribute set of where all the values are of <replaceable>t</replaceable> type. Multiple definitions result in the joined attribute set. + An attribute set of where all the values are of + <replaceable>t</replaceable> type. Multiple definitions result in the + joined attribute set. </para> </listitem> </varlistentry> @@ -270,7 +307,8 @@ </term> <listitem> <para> - An attribute set or a list of <replaceable>t</replaceable> type. Multiple definitions are merged according to the value. + An attribute set or a list of <replaceable>t</replaceable> type. Multiple + definitions are merged according to the value. </para> </listitem> </varlistentry> @@ -280,7 +318,8 @@ </term> <listitem> <para> - <literal>null</literal> or type <replaceable>t</replaceable>. Multiple definitions are merged according to type <replaceable>t</replaceable>. + <literal>null</literal> or type <replaceable>t</replaceable>. Multiple + definitions are merged according to type <replaceable>t</replaceable>. </para> </listitem> </varlistentry> @@ -290,7 +329,8 @@ </term> <listitem> <para> - Ensures that type <replaceable>t</replaceable> cannot be merged. It is used to ensure option definitions are declared only once. + Ensures that type <replaceable>t</replaceable> cannot be merged. It is + used to ensure option definitions are declared only once. </para> </listitem> </varlistentry> @@ -300,7 +340,9 @@ </term> <listitem> <para> - Type <replaceable>t1</replaceable> or type <replaceable>t2</replaceable>, e.g. <literal>with types; either int str</literal>. Multiple definitions cannot be merged. + Type <replaceable>t1</replaceable> or type <replaceable>t2</replaceable>, + e.g. <literal>with types; either int str</literal>. Multiple definitions + cannot be merged. </para> </listitem> </varlistentry> @@ -310,7 +352,9 @@ </term> <listitem> <para> - 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. + 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. </para> </listitem> </varlistentry> @@ -320,7 +364,12 @@ </term> <listitem> <para> - 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. + 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. </para> </listitem> </varlistentry> @@ -331,15 +380,22 @@ <title>Submodule</title> <para> - <literal>submodule</literal> is a very powerful type that defines a set of sub-options that are handled like a separate module. + <literal>submodule</literal> is a very powerful type that defines a set of + sub-options that are handled like a separate module. </para> <para> - 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. + 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. </para> <para> - The option set can be defined directly (<xref linkend='ex-submodule-direct' />) or as reference (<xref linkend='ex-submodule-reference' />). + The option set can be defined directly + (<xref linkend='ex-submodule-direct' />) or as reference + (<xref linkend='ex-submodule-reference' />). </para> <example xml:id='ex-submodule-direct'> @@ -382,7 +438,12 @@ options.mod = mkOption { </example> <para> - 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' />). + 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' />). </para> <example xml:id='ex-submodule-listof-declaration'> @@ -413,7 +474,10 @@ config.mod = [ </example> <para> - 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' />). + 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' />). </para> <example xml:id='ex-submodule-attrsof-declaration'> @@ -446,7 +510,8 @@ config.mod.two = { foo = 2; bar = "two"; };</screen> <title>Extending types</title> <para> - Types are mainly characterized by their <literal>check</literal> and <literal>merge</literal> functions. + Types are mainly characterized by their <literal>check</literal> and + <literal>merge</literal> functions. </para> <variablelist> @@ -456,8 +521,13 @@ config.mod.two = { foo = 2; bar = "two"; };</screen> </term> <listitem> <para> - 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 - linkend='ex-extending-type-check-1' />), or to fully override the check function (<xref linkend='ex-extending-type-check-2' />). + 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 + linkend='ex-extending-type-check-1' />), or to fully + override the check function + (<xref linkend='ex-extending-type-check-2' />). </para> <example xml:id='ex-extending-type-check-1'> <title>Adding a type check</title> @@ -485,7 +555,11 @@ nixThings = mkOption { </term> <listitem> <para> - 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. + 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. </para> </listitem> </varlistentry> @@ -496,8 +570,12 @@ nixThings = mkOption { <title>Custom Types</title> <para> - 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 - xlink:href="https://github.com/NixOS/nixpkgs/blob/master/lib/types.nix">types.nix</filename> code before creating a new type. + 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 + xlink:href="https://github.com/NixOS/nixpkgs/blob/master/lib/types.nix">types.nix</filename> + code before creating a new type. </para> <para> @@ -521,7 +599,8 @@ nixThings = mkOption { </term> <listitem> <para> - Description of the type used in documentation. Give information of the type and any of its arguments. + Description of the type used in documentation. Give information of the + type and any of its arguments. </para> </listitem> </varlistentry> @@ -531,7 +610,10 @@ nixThings = mkOption { </term> <listitem> <para> - 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. + 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. </para> </listitem> </varlistentry> @@ -550,7 +632,8 @@ nixThings = mkOption { </term> <listitem> <para> - The option path as a list of strings, e.g. <literal>["boot" "loader "grub" "enable"]</literal>. + The option path as a list of strings, e.g. <literal>["boot" "loader + "grub" "enable"]</literal>. </para> </listitem> </varlistentry> @@ -560,7 +643,12 @@ nixThings = mkOption { </term> <listitem> <para> - 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. + 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. </para> </listitem> </varlistentry> @@ -573,7 +661,13 @@ nixThings = mkOption { </term> <listitem> <para> - 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. + 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. </para> </listitem> </varlistentry> @@ -583,7 +677,11 @@ nixThings = mkOption { </term> <listitem> <para> - 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>. + 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>. </para> </listitem> </varlistentry> @@ -593,7 +691,14 @@ nixThings = mkOption { </term> <listitem> <para> - 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>. + 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>. </para> </listitem> </varlistentry> @@ -603,7 +708,9 @@ nixThings = mkOption { </term> <listitem> <para> - 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. + 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. </para> <variablelist> <varlistentry> @@ -618,7 +725,8 @@ nixThings = mkOption { </varlistentry> </variablelist> <para> - Note: There is a generic <literal>defaultTypeMerge</literal> that work with most of value and composed types. + Note: There is a generic <literal>defaultTypeMerge</literal> that work + with most of value and composed types. </para> </listitem> </varlistentry> @@ -628,7 +736,8 @@ nixThings = mkOption { </term> <listitem> <para> - An attribute set representing the type. It is used for type operations and has the following keys: + An attribute set representing the type. It is used for type operations + and has the following keys: </para> <variablelist> <varlistentry> @@ -657,7 +766,10 @@ nixThings = mkOption { </term> <listitem> <para> - 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. + 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. </para> </listitem> </varlistentry> @@ -667,7 +779,9 @@ nixThings = mkOption { </term> <listitem> <para> - 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. + 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. </para> </listitem> </varlistentry> diff --git a/nixos/doc/manual/development/releases.xml b/nixos/doc/manual/development/releases.xml index 8cc4490ff54..1cdec64f69b 100755 --- a/nixos/doc/manual/development/releases.xml +++ b/nixos/doc/manual/development/releases.xml @@ -17,12 +17,15 @@ <itemizedlist spacing="compact"> <listitem> <para> - Send an email to the nix-devel mailinglist as a warning about upcoming beta "feature freeze" in a month. + Send an email to the nix-devel mailinglist as a warning about upcoming + beta "feature freeze" in a month. </para> </listitem> <listitem> <para> - 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. + 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. </para> </listitem> </itemizedlist> @@ -34,32 +37,42 @@ <itemizedlist spacing="compact"> <listitem> <para> - <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> + <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> </para> </listitem> <listitem> <para> - <literal>git tag -a -s -m "Release 17.09-beta" 17.09-beta && git push --tags</literal> + <literal>git tag -a -s -m "Release 17.09-beta" 17.09-beta + && git push --tags</literal> </para> </listitem> <listitem> <para> - From the master branch run <literal>git checkout -B release-17.09</literal>. + From the master branch run <literal>git checkout -B + release-17.09</literal>. </para> </listitem> <listitem> <para> - <link xlink:href="https://github.com/NixOS/nixos-org-configurations/pull/18"> Make sure a channel is created at http://nixos.org/channels/. </link> + <link xlink:href="https://github.com/NixOS/nixos-org-configurations/pull/18"> + Make sure a channel is created at http://nixos.org/channels/. </link> </para> </listitem> <listitem> <para> - <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> + <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> </para> </listitem> <listitem> <para> - <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 + <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 </para> </listitem> <listitem> @@ -69,32 +82,44 @@ </listitem> <listitem> <para> - <link xlink:href="https://github.com/NixOS/nixpkgs/commit/b8a4095003e27659092892a4708bb3698231a842"> Pick a new name for the unstable branch. </link> + <link xlink:href="https://github.com/NixOS/nixpkgs/commit/b8a4095003e27659092892a4708bb3698231a842"> + Pick a new name for the unstable branch. </link> </para> </listitem> <listitem> <para> - Create a new release notes file for the upcoming release + 1, in this case <literal>rl-1803.xml</literal>. + Create a new release notes file for the upcoming release + 1, in this + case <literal>rl-1803.xml</literal>. </para> </listitem> <listitem> <para> - Create two Hydra jobsets: release-17.09 and release-17.09-small with <literal>stableBranch</literal> set to false. + Create two Hydra jobsets: release-17.09 and release-17.09-small with + <literal>stableBranch</literal> set to false. </para> </listitem> <listitem> <para> - 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 + 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 </para> </listitem> <listitem> <para> - Edit changelog at <literal>nixos/doc/manual/release-notes/rl-1709.xml</literal> (double check desktop versions are noted) + Edit changelog at + <literal>nixos/doc/manual/release-notes/rl-1709.xml</literal> (double + check desktop versions are noted) </para> <itemizedlist spacing="compact"> <listitem> <para> - Get all new NixOS modules <literal>git diff release-17.03..release-17.09 nixos/modules/module-list.nix|grep ^+</literal> + Get all new NixOS modules <literal>git diff + release-17.03..release-17.09 nixos/modules/module-list.nix|grep + ^+</literal> </para> </listitem> <listitem> @@ -113,7 +138,8 @@ <itemizedlist spacing="compact"> <listitem> <para> - Monitor the master branch for bugfixes and minor updates and cherry-pick them to the release branch. + Monitor the master branch for bugfixes and minor updates and cherry-pick + them to the release branch. </para> </listitem> </itemizedlist> @@ -130,17 +156,21 @@ </listitem> <listitem> <para> - 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> + 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> </para> </listitem> <listitem> <para> - <link xlink:href="https://github.com/NixOS/nixpkgs/commit/40fd9ae3ac8048758abdcfc7d28a78b5f22fe97e"> Update README.md with new stable NixOS version information. </link> + <link xlink:href="https://github.com/NixOS/nixpkgs/commit/40fd9ae3ac8048758abdcfc7d28a78b5f22fe97e"> + Update README.md with new stable NixOS version information. </link> </para> </listitem> <listitem> <para> - Change <literal>stableBranch</literal> to true and wait for channel to update. + Change <literal>stableBranch</literal> to true and wait for channel to + update. </para> </listitem> </itemizedlist> @@ -157,27 +187,34 @@ </listitem> <listitem> <para> - Update "Chapter 4. Upgrading NixOS" section of the manual to match new stable release version. + Update "Chapter 4. Upgrading NixOS" section of the manual to match + new stable release version. </para> </listitem> <listitem> <para> - Update http://nixos.org/nixos/download.html and http://nixos.org/nixos/manual in https://github.com/NixOS/nixos-org-configurations + Update http://nixos.org/nixos/download.html and + http://nixos.org/nixos/manual in + https://github.com/NixOS/nixos-org-configurations </para> </listitem> <listitem> <para> - Get number of commits for the release: <literal>git log release-14.04..release-14.12 --format=%an|wc -l</literal> + Get number of commits for the release: <literal>git log + release-14.04..release-14.12 --format=%an|wc -l</literal> </para> </listitem> <listitem> <para> - Commits by contributor: <literal>git log release-14.04..release-14.12 --format=%an|sort|uniq -c|sort -rn</literal> + Commits by contributor: <literal>git log release-14.04..release-14.12 + --format=%an|sort|uniq -c|sort -rn</literal> </para> </listitem> <listitem> <para> - 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. + 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. </para> </listitem> </itemizedlist> @@ -185,45 +222,26 @@ </section> <section xml:id="release-managers"> <title>Release Management Team</title> - <para> - 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. + 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. </para> - <para> - 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. + 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. </para> - <para> A release manager's role and responsibilities are: </para> - <itemizedlist> - <listitem> - <para> - manage the release process - </para> - </listitem> - <listitem> - <para> - start discussions about features and changes for a given release - </para> - </listitem> - <listitem> - <para> - create a roadmap - </para> - </listitem> - <listitem> - <para> - release in cooperation with Eelco Dolstra - </para> - </listitem> - <listitem> - <para> - decide which bug fixes, features, etc... get backported after a release - </para> - </listitem> + <listitem><para>manage the release process</para></listitem> + <listitem><para>start discussions about features and changes for a given release</para></listitem> + <listitem><para>create a roadmap</para></listitem> + <listitem><para>release in cooperation with Eelco Dolstra</para></listitem> + <listitem><para>decide which bug fixes, features, etc... get backported after a release</para></listitem> </itemizedlist> </section> <section xml:id="release-schedule"> diff --git a/nixos/doc/manual/development/replace-modules.xml b/nixos/doc/manual/development/replace-modules.xml index 9940143de8e..7b103c36d90 100644 --- a/nixos/doc/manual/development/replace-modules.xml +++ b/nixos/doc/manual/development/replace-modules.xml @@ -6,15 +6,27 @@ <title>Replace Modules</title> <para> - 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. + 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. </para> <para> - <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. <nixpkgs/nixos/modules> for nixos). + <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. <nixpkgs/nixos/modules> for + nixos). </para> <para> - 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. + 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. </para> <programlisting> @@ -34,7 +46,9 @@ </programlisting> <para> - 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. + 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. </para> <programlisting> diff --git a/nixos/doc/manual/development/running-nixos-tests-interactively.xml b/nixos/doc/manual/development/running-nixos-tests-interactively.xml index e4ded136ca6..e390d62fde2 100644 --- a/nixos/doc/manual/development/running-nixos-tests-interactively.xml +++ b/nixos/doc/manual/development/running-nixos-tests-interactively.xml @@ -6,7 +6,8 @@ <title>Running Tests interactively</title> <para> - The test itself can be run interactively. This is particularly useful when developing or debugging a test: + The test itself can be run interactively. This is particularly useful when + developing or debugging a test: <screen> <prompt>$ </prompt>nix-build nixos/tests/login.nix -A driver <prompt>$ </prompt>./result/bin/nixos-test-driver @@ -20,7 +21,10 @@ starting VDE switch for network 1 <prompt>></prompt> $machine->succeed("touch /tmp/foo") <prompt>></prompt> print($machine->succeed("pwd")) # Show stdout of command </screen> - 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). + 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). </para> <para> @@ -29,10 +33,12 @@ starting VDE switch for network 1 <prompt>$ </prompt>nix-build nixos/tests/login.nix -A driver <prompt>$ </prompt>./result/bin/nixos-run-vms </screen> - The script <command>nixos-run-vms</command> starts the virtual machines defined by test. + The script <command>nixos-run-vms</command> starts the virtual machines + defined by test. </para> <para> - The machine state is kept across VM restarts in <filename>/tmp/vm-state-</filename><varname>machinename</varname>. + The machine state is kept across VM restarts in + <filename>/tmp/vm-state-</filename><varname>machinename</varname>. </para> </section> diff --git a/nixos/doc/manual/development/running-nixos-tests.xml b/nixos/doc/manual/development/running-nixos-tests.xml index 7d81be9b1c6..13ae1ed9369 100644 --- a/nixos/doc/manual/development/running-nixos-tests.xml +++ b/nixos/doc/manual/development/running-nixos-tests.xml @@ -6,8 +6,11 @@ <title>Running Tests</title> <para> - You can run tests using <command>nix-build</command>. For example, to run the test <filename -xlink:href="https://github.com/NixOS/nixpkgs/blob/master/nixos/tests/login.nix">login.nix</filename>, you just do: + You can run tests using <command>nix-build</command>. For example, to run the + test + <filename +xlink:href="https://github.com/NixOS/nixpkgs/blob/master/nixos/tests/login.nix">login.nix</filename>, + you just do: <screen> <prompt>$ </prompt>nix-build '<nixpkgs/nixos/tests/login.nix>' </screen> @@ -21,7 +24,11 @@ machine: QEMU running (pid 8841) … 6 out of 6 tests succeeded </screen> - 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: + 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: <screen> <prompt>$ </prompt>firefox result/log.html </screen> diff --git a/nixos/doc/manual/development/sources.xml b/nixos/doc/manual/development/sources.xml index 71441feb1ff..3c30c782746 100644 --- a/nixos/doc/manual/development/sources.xml +++ b/nixos/doc/manual/development/sources.xml @@ -5,47 +5,77 @@ xml:id="sec-getting-sources"> <title>Getting the Sources</title> <para> - 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: + 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: <screen> <prompt>$ </prompt>git clone https://github.com/NixOS/nixpkgs <prompt>$ </prompt>cd nixpkgs <prompt>$ </prompt>git remote add channels https://github.com/NixOS/nixpkgs-channels <prompt>$ </prompt>git remote update channels </screen> - 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. + 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. </para> <para> - 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: + 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: <screen> <prompt>$ </prompt>nixos-version 17.09pre104379.6e0b727 (Hummingbird) <prompt>$ </prompt>git checkout -b local 6e0b727 </screen> - Or, to base your local branch on the latest version available in a NixOS channel: + Or, to base your local branch on the latest version available in a NixOS + channel: <screen> <prompt>$ </prompt>git remote update channels <prompt>$ </prompt>git checkout -b local channels/nixos-17.03 </screen> - (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. + (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. <screen> <prompt>$ </prompt>git remote update channels <prompt>$ </prompt>git merge channels/nixos-17.03 </screen> - You can use <command>git cherry-pick</command> to copy commits from your local branch to the upstream branch. + You can use <command>git cherry-pick</command> to copy commits from your + local branch to the upstream branch. </para> <para> - 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: + 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: <screen> <prompt># </prompt>nixos-rebuild switch -I nixpkgs=<replaceable>/my/sources</replaceable>/nixpkgs </screen> </para> <para> - 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>: + 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>: <screen> <prompt>$ </prompt>ln -s <replaceable>/my/sources</replaceable>/nixpkgs ~/.nix-defexpr/nixpkgs </screen> - 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. + 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. </para> <!-- FIXME: not sure what this means. <para>You should not pass the base directory diff --git a/nixos/doc/manual/development/testing-installer.xml b/nixos/doc/manual/development/testing-installer.xml index e1185e0926a..902f995fbc1 100644 --- a/nixos/doc/manual/development/testing-installer.xml +++ b/nixos/doc/manual/development/testing-installer.xml @@ -5,13 +5,15 @@ xml:id="ch-testing-installer"> <title>Testing the Installer</title> <para> - Building, burning, and booting from an installation CD is rather tedious, so here is a quick way to see if the installer works properly: + Building, burning, and booting from an installation CD is rather tedious, so + here is a quick way to see if the installer works properly: <screen> <prompt># </prompt>mount -t tmpfs none /mnt <prompt># </prompt>nixos-generate-config --root /mnt <prompt>$ </prompt>nix-build '<nixpkgs/nixos>' -A config.system.build.nixos-install <prompt># </prompt>./result/bin/nixos-install</screen> - To start a login shell in the new NixOS installation in <filename>/mnt</filename>: + To start a login shell in the new NixOS installation in + <filename>/mnt</filename>: <screen> <prompt>$ </prompt>nix-build '<nixpkgs/nixos>' -A config.system.build.nixos-enter <prompt># </prompt>./result/bin/nixos-enter diff --git a/nixos/doc/manual/development/writing-documentation.xml b/nixos/doc/manual/development/writing-documentation.xml index ffefa208f66..2183937ad0d 100644 --- a/nixos/doc/manual/development/writing-documentation.xml +++ b/nixos/doc/manual/development/writing-documentation.xml @@ -5,13 +5,18 @@ xml:id="sec-writing-documentation"> <title>Writing NixOS Documentation</title> <para> - 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. + 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. </para> <section xml:id="sec-writing-docs-building-the-manual"> <title>Building the Manual</title> <para> - 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. + 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. </para> <para> @@ -24,45 +29,59 @@ </screen> <para> - Once you are done making modifications to the manual, it's important to build it before committing. You can do that as follows: + Once you are done making modifications to the manual, it's important to + build it before committing. You can do that as follows: </para> <screen>nix-build nixos/release.nix -A manual.x86_64-linux</screen> <para> - 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>. + 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>. </para> </section> <section xml:id="sec-writing-docs-editing-docbook-xml"> <title>Editing DocBook XML</title> <para> - 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>. + 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>. </para> <para> - 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"/>. + 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"/>. </para> <para> - <link xlink:href="http://pandoc.org">Pandoc</link> can generate DocBook XML from a multitude of formats, which makes a good starting point. + <link xlink:href="http://pandoc.org">Pandoc</link> can generate DocBook XML + from a multitude of formats, which makes a good starting point. <example xml:id="ex-pandoc-xml-conv"> <title>Pandoc invocation to convert GitHub-Flavoured MarkDown to DocBook 5 XML</title> <screen>pandoc -f markdown_github -t docbook5 docs.md -o my-section.md</screen> </example> - Pandoc can also quickly convert a single <filename>section.xml</filename> to HTML, which is helpful when drafting. + Pandoc can also quickly convert a single <filename>section.xml</filename> to + HTML, which is helpful when drafting. </para> <para> - Sometimes writing valid DocBook is simply too difficult. In this case, submit your documentation updates in a <link - xlink:href="https://github.com/NixOS/nixpkgs/issues/new">GitHub Issue</link> and someone will handle the conversion to XML for you. + Sometimes writing valid DocBook is simply too difficult. In this case, + submit your documentation updates in a + <link + xlink:href="https://github.com/NixOS/nixpkgs/issues/new">GitHub + Issue</link> and someone will handle the conversion to XML for you. </para> </section> <section xml:id="sec-writing-docs-creating-a-topic"> <title>Creating a Topic</title> <para> - You can use an existing topic as a basis for the new topic or create a topic from scratch. + You can use an existing topic as a basis for the new topic or create a topic + from scratch. </para> <para> @@ -70,27 +89,40 @@ <itemizedlist> <listitem> <para> - 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. + 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. </para> </listitem> <listitem> <para> - 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. + 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. </para> </listitem> <listitem> <para> - If you include multiple words in the file name, separate the words with a dash. For example: <filename>ipv6-config.xml</filename>. + If you include multiple words in the file name, separate the words with a + dash. For example: <filename>ipv6-config.xml</filename>. </para> </listitem> <listitem> <para> - 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>. + 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>. </para> </listitem> <listitem> <para> - 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. + 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. </para> </listitem> </itemizedlist> @@ -100,11 +132,17 @@ <title>Adding a Topic to the Book</title> <para> - 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. + 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. </para> <para> - 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 + 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 linkend="sec-meta-attributes"/> for an explanation. </para> </section> diff --git a/nixos/doc/manual/development/writing-modules.xml b/nixos/doc/manual/development/writing-modules.xml index 18088040bd6..bbf793bb0be 100644 --- a/nixos/doc/manual/development/writing-modules.xml +++ b/nixos/doc/manual/development/writing-modules.xml @@ -5,25 +5,49 @@ xml:id="sec-writing-modules"> <title>Writing NixOS Modules</title> <para> - 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 -xlink:href="https://github.com/NixOS/nixpkgs/tree/master/nixos/modules"><filename>nixos/modules</filename></link> subdirectory of the Nixpkgs tree. + 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 +xlink:href="https://github.com/NixOS/nixpkgs/tree/master/nixos/modules"><filename>nixos/modules</filename></link> + subdirectory of the Nixpkgs tree. </para> <para> - 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 -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 -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 -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>. + 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 +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 +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 +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>. </para> <para xml:id="para-module-syn"> In <xref -linkend="sec-configuration-syntax"/>, we saw the following structure of NixOS modules: +linkend="sec-configuration-syntax"/>, we saw the following structure + of NixOS modules: <programlisting> { config, pkgs, ... }: { <replaceable>option definitions</replaceable> } </programlisting> - 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' />. + 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' />. </para> <example xml:id='ex-module-syntax'> <title>Structure of NixOS Modules</title> @@ -49,28 +73,47 @@ linkend="sec-configuration-syntax"/>, we saw the following structure of NixOS mo <calloutlist> <callout arearefs='module-syntax-1'> <para> - 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. + 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. </para> </callout> <callout arearefs='module-syntax-2'> <para> - 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. + 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. </para> </callout> <callout arearefs='module-syntax-3'> <para> - The attribute <varname>options</varname> is a nested set of <emphasis>option declarations</emphasis> (described below). + The attribute <varname>options</varname> is a nested set of + <emphasis>option declarations</emphasis> (described below). </para> </callout> <callout arearefs='module-syntax-4'> <para> - The attribute <varname>config</varname> is a nested set of <emphasis>option definitions</emphasis> (also described below). + The attribute <varname>config</varname> is a nested set of + <emphasis>option definitions</emphasis> (also described below). </para> </callout> </calloutlist> </para> <para> - <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>). + <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>). </para> <example xml:id='locate-example'> <title>NixOS Module for the “locate” Service</title> diff --git a/nixos/doc/manual/development/writing-nixos-tests.xml b/nixos/doc/manual/development/writing-nixos-tests.xml index 5df60e2ec82..6be2d0a4d23 100644 --- a/nixos/doc/manual/development/writing-nixos-tests.xml +++ b/nixos/doc/manual/development/writing-nixos-tests.xml @@ -31,9 +31,22 @@ import ./make-test.nix { ''; } </programlisting> - 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 -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 -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. + 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 +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 +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. </para> <para> @@ -56,8 +69,10 @@ xlink:href="https://github.com/NixOS/nixpkgs/blob/master/nixos/tests/nfs.nix">nf </term> <listitem> <para> - The virtual networks to which the VM is connected. See <filename - xlink:href="https://github.com/NixOS/nixpkgs/blob/master/nixos/tests/nat.nix">nat.nix</filename> for an example. + The virtual networks to which the VM is connected. See + <filename + xlink:href="https://github.com/NixOS/nixpkgs/blob/master/nixos/tests/nat.nix">nat.nix</filename> + for an example. </para> </listitem> </varlistentry> @@ -67,23 +82,38 @@ xlink:href="https://github.com/NixOS/nixpkgs/blob/master/nixos/tests/nfs.nix">nf </term> <listitem> <para> - 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. + 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. </para> </listitem> </varlistentry> </variablelist> - For more options, see the module <filename + For more options, see the module + <filename xlink:href="https://github.com/NixOS/nixpkgs/blob/master/nixos/modules/virtualisation/qemu-vm.nix">qemu-vm.nix</filename>. </para> <para> - 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: + 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: <programlisting> $machine->start; $machine->waitForUnit("default.target"); $machine->succeed("uname") =~ /Linux/ or die; </programlisting> - 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: + 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: <programlisting> startAll; </programlisting> @@ -98,7 +128,8 @@ startAll; </term> <listitem> <para> - Start the virtual machine. This method is asynchronous — it does not wait for the machine to finish booting. + Start the virtual machine. This method is asynchronous — it does not + wait for the machine to finish booting. </para> </listitem> </varlistentry> @@ -128,7 +159,8 @@ startAll; </term> <listitem> <para> - Simulate unplugging the Ethernet cable that connects the machine to the other machines. + Simulate unplugging the Ethernet cable that connects the machine to the + other machines. </para> </listitem> </varlistentry> @@ -148,7 +180,8 @@ startAll; </term> <listitem> <para> - Take a picture of the display of the virtual machine, in PNG format. The screenshot is linked from the HTML log. + Take a picture of the display of the virtual machine, in PNG format. The + screenshot is linked from the HTML log. </para> </listitem> </varlistentry> @@ -158,11 +191,13 @@ startAll; </term> <listitem> <para> - Return a textual representation of what is currently visible on the machine's screen using optical character recognition. + Return a textual representation of what is currently visible on the + machine's screen using optical character recognition. </para> <note> <para> - This requires passing <option>enableOCR</option> to the test attribute set. + This requires passing <option>enableOCR</option> to the test attribute + set. </para> </note> </listitem> @@ -173,7 +208,8 @@ startAll; </term> <listitem> <para> - 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. + 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. </para> </listitem> </varlistentry> @@ -183,7 +219,8 @@ startAll; </term> <listitem> <para> - Simulate pressing keys on the virtual keyboard, e.g., <literal>sendKeys("ctrl-alt-delete")</literal>. + Simulate pressing keys on the virtual keyboard, e.g., + <literal>sendKeys("ctrl-alt-delete")</literal>. </para> </listitem> </varlistentry> @@ -193,7 +230,9 @@ startAll; </term> <listitem> <para> - 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. + 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. </para> </listitem> </varlistentry> @@ -203,7 +242,9 @@ startAll; </term> <listitem> <para> - Execute a shell command, returning a list <literal>(<replaceable>status</replaceable>, <replaceable>stdout</replaceable>)</literal>. + Execute a shell command, returning a list + <literal>(<replaceable>status</replaceable>, + <replaceable>stdout</replaceable>)</literal>. </para> </listitem> </varlistentry> @@ -213,7 +254,8 @@ startAll; </term> <listitem> <para> - Execute a shell command, raising an exception if the exit status is not zero, otherwise returning the standard output. + Execute a shell command, raising an exception if the exit status is not + zero, otherwise returning the standard output. </para> </listitem> </varlistentry> @@ -223,7 +265,8 @@ startAll; </term> <listitem> <para> - Like <methodname>succeed</methodname>, but raising an exception if the command returns a zero status. + Like <methodname>succeed</methodname>, but raising an exception if the + command returns a zero status. </para> </listitem> </varlistentry> @@ -273,7 +316,8 @@ startAll; </term> <listitem> <para> - Wait until a process is listening on the given TCP port (on <literal>localhost</literal>, at least). + Wait until a process is listening on the given TCP port (on + <literal>localhost</literal>, at least). </para> </listitem> </varlistentry> @@ -303,11 +347,14 @@ startAll; </term> <listitem> <para> - Wait until the supplied regular expressions matches the textual contents of the screen by using optical character recognition (see <methodname>getScreenText</methodname>). + Wait until the supplied regular expressions matches the textual contents + of the screen by using optical character recognition (see + <methodname>getScreenText</methodname>). </para> <note> <para> - This requires passing <option>enableOCR</option> to the test attribute set. + This requires passing <option>enableOCR</option> to the test attribute + set. </para> </note> </listitem> @@ -318,7 +365,8 @@ startAll; </term> <listitem> <para> - Wait until an X11 window has appeared whose name matches the given regular expression, e.g., <literal>waitForWindow(qr/Terminal/)</literal>. + Wait until an X11 window has appeared whose name matches the given + regular expression, e.g., <literal>waitForWindow(qr/Terminal/)</literal>. </para> </listitem> </varlistentry> @@ -328,10 +376,13 @@ startAll; </term> <listitem> <para> - Copies a file from host to machine, e.g., <literal>copyFileFromHost("myfile", "/etc/my/important/file")</literal>. + Copies a file from host to machine, e.g., + <literal>copyFileFromHost("myfile", "/etc/my/important/file")</literal>. </para> <para> - 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. + 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. </para> </listitem> </varlistentry> @@ -341,7 +392,8 @@ startAll; </term> <listitem> <para> - Runs <literal>systemctl</literal> commands with optional support for <literal>systemctl --user</literal> + Runs <literal>systemctl</literal> commands with optional support for + <literal>systemctl --user</literal> </para> <para> <programlisting> @@ -355,12 +407,15 @@ $machine->systemctl("list-jobs --no-pager", "any-user"); // spawns a shell for ` </para> <para> - To test user units declared by <literal>systemd.user.services</literal> the optional <literal>$user</literal> argument can be used: + To test user units declared by <literal>systemd.user.services</literal> the + optional <literal>$user</literal> argument can be used: <programlisting> $machine->start; $machine->waitForX; $machine->waitForUnit("xautolock.service", "x-session-user"); </programlisting> - This applies to <literal>systemctl</literal>, <literal>getUnitInfo</literal>, <literal>waitForUnit</literal>, <literal>startJob</literal> and <literal>stopJob</literal>. + This applies to <literal>systemctl</literal>, <literal>getUnitInfo</literal>, + <literal>waitForUnit</literal>, <literal>startJob</literal> and + <literal>stopJob</literal>. </para> </section> diff --git a/nixos/doc/manual/installation/changing-config.xml b/nixos/doc/manual/installation/changing-config.xml index 65b384dd596..48193d986ab 100644 --- a/nixos/doc/manual/installation/changing-config.xml +++ b/nixos/doc/manual/installation/changing-config.xml @@ -4,20 +4,28 @@ xml:id="sec-changing-config"> <title>Changing the Configuration</title> <para> - 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 + 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 <screen> <prompt># </prompt>nixos-rebuild switch </screen> - 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). + 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). <warning> <para> - 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. + 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. </para> </warning> </para> <warning> <para> - 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>. + 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>. </para> </warning> <para> @@ -25,44 +33,63 @@ <screen> <prompt># </prompt>nixos-rebuild test </screen> - 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. + 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. </para> <para> There is also <screen> <prompt># </prompt>nixos-rebuild boot </screen> - 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). + 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). </para> <para> - 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. + 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. <screen> <prompt># </prompt>nixos-rebuild switch -p test </screen> - 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. + 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. </para> <para> Finally, you can do <screen> <prompt>$ </prompt>nixos-rebuild build </screen> - to build the configuration but nothing more. This is useful to see whether everything compiles cleanly. + to build the configuration but nothing more. This is useful to see whether + everything compiles cleanly. </para> <para> - 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 + 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 <screen> <prompt>$ </prompt>nixos-rebuild build-vm <prompt>$ </prompt>./result/bin/run-*-vm </screen> - 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: + 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: <screen> <link linkend="opt-users.users._name__.initialHashedPassword">users.users.your-user.initialHashedPassword</link> = "test"; </screen> - <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): + <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): <screen> <prompt>$ </prompt>QEMU_NET_OPTS="hostfwd=tcp::2222-:22" ./result/bin/run-*-vm </screen> - allowing you to log in via SSH (assuming you have set the appropriate passwords or SSH authorized keys): + allowing you to log in via SSH (assuming you have set the appropriate + passwords or SSH authorized keys): <screen> <prompt>$ </prompt>ssh -p 2222 localhost </screen> diff --git a/nixos/doc/manual/installation/installation.xml b/nixos/doc/manual/installation/installation.xml index a9d2c74d115..2901f462dee 100644 --- a/nixos/doc/manual/installation/installation.xml +++ b/nixos/doc/manual/installation/installation.xml @@ -6,7 +6,8 @@ <title>Installation</title> <partintro xml:id="ch-installation-intro"> <para> - This section describes how to obtain, install, and configure NixOS for first-time use. + This section describes how to obtain, install, and configure NixOS for + first-time use. </para> </partintro> <xi:include href="obtaining.xml" /> diff --git a/nixos/doc/manual/installation/installing-behind-a-proxy.xml b/nixos/doc/manual/installation/installing-behind-a-proxy.xml index 4f74f0b3029..8f9baff44b5 100644 --- a/nixos/doc/manual/installation/installing-behind-a-proxy.xml +++ b/nixos/doc/manual/installation/installing-behind-a-proxy.xml @@ -6,13 +6,16 @@ <title>Installing behind a proxy</title> <para> - To install NixOS behind a proxy, do the following before running <literal>nixos-install</literal>. + To install NixOS behind a proxy, do the following before running + <literal>nixos-install</literal>. </para> <orderedlist numeration="arabic"> <listitem> <para> - Update proxy configuration in <literal>/mnt/etc/nixos/configuration.nix</literal> to keep the internet accessible after reboot. + Update proxy configuration in + <literal>/mnt/etc/nixos/configuration.nix</literal> to keep the internet + accessible after reboot. </para> <programlisting> networking.proxy.default = "http://user:password@proxy:port/"; @@ -21,7 +24,8 @@ networking.proxy.noProxy = "127.0.0.1,localhost,internal.domain"; </listitem> <listitem> <para> - Setup the proxy environment variables in the shell where you are running <literal>nixos-install</literal>. + Setup the proxy environment variables in the shell where you are running + <literal>nixos-install</literal>. </para> <programlisting> # proxy_url="http://user:password@proxy:port/" @@ -35,7 +39,10 @@ networking.proxy.noProxy = "127.0.0.1,localhost,internal.domain"; <note> <para> - 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. + 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. </para> </note> </section> diff --git a/nixos/doc/manual/installation/installing-from-other-distro.xml b/nixos/doc/manual/installation/installing-from-other-distro.xml index 468757ed60b..8ed45899fd7 100644 --- a/nixos/doc/manual/installation/installing-from-other-distro.xml +++ b/nixos/doc/manual/installation/installing-from-other-distro.xml @@ -8,23 +8,28 @@ <title>Installing from another Linux distribution</title> <para> - Because Nix (the package manager) & 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: + Because Nix (the package manager) & 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: </para> <orderedlist> <listitem> <para> - Install NixOS on another partition, from your existing Linux distribution (without the use of a USB or optical device!) + Install NixOS on another partition, from your existing Linux distribution + (without the use of a USB or optical device!) </para> </listitem> <listitem> <para> - Install NixOS on the same partition (in place!), from your existing non-NixOS Linux distribution using <literal>NIXOS_LUSTRATE</literal>. + Install NixOS on the same partition (in place!), from your existing + non-NixOS Linux distribution using <literal>NIXOS_LUSTRATE</literal>. </para> </listitem> <listitem> <para> - Install NixOS on your hard drive from the Live CD of any Linux distribution. + Install NixOS on your hard drive from the Live CD of any Linux + distribution. </para> </listitem> </orderedlist> @@ -45,8 +50,10 @@ <prompt>$ </prompt>curl https://nixos.org/nix/install | sh <prompt>$ </prompt>. $HOME/.nix-profile/etc/profile.d/nix.sh # …or open a fresh shell</screen> <para> - More details in the <link - xlink:href="https://nixos.org/nix/manual/#chap-quick-start"> Nix manual</link> + More details in the + <link + xlink:href="https://nixos.org/nix/manual/#chap-quick-start"> + Nix manual</link> </para> </listitem> <listitem> @@ -54,18 +61,21 @@ Switch to the NixOS channel: </para> <para> - If you've just installed Nix on a non-NixOS distribution, you will be on the <literal>nixpkgs</literal> channel by default. + If you've just installed Nix on a non-NixOS distribution, you will be on + the <literal>nixpkgs</literal> channel by default. </para> <screen> <prompt>$ </prompt>nix-channel --list nixpkgs https://nixos.org/channels/nixpkgs-unstable</screen> <para> - As that channel gets released without running the NixOS tests, it will be safer to use the <literal>nixos-*</literal> channels instead: + As that channel gets released without running the NixOS tests, it will be + safer to use the <literal>nixos-*</literal> channels instead: </para> <screen> <prompt>$ </prompt>nix-channel --add https://nixos.org/channels/nixos-<replaceable>version</replaceable> nixpkgs</screen> <para> - You may want to throw in a <literal>nix-channel --update</literal> for good measure. + You may want to throw in a <literal>nix-channel --update</literal> for good + measure. </para> </listitem> <listitem> @@ -73,24 +83,33 @@ nixpkgs https://nixos.org/channels/nixpkgs-unstable</screen> Install the NixOS installation tools: </para> <para> - 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.. + 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.. </para> <screen><prompt>$ </prompt>nix-env -iE "_: with import <nixpkgs/nixos> { configuration = {}; }; with config.system.build; [ nixos-generate-config nixos-install nixos-enter manual.manpages ]"</screen> </listitem> <listitem> <note> <para> - The following 5 steps are only for installing NixOS to another partition. For installing NixOS in place using <literal>NIXOS_LUSTRATE</literal>, skip ahead. + The following 5 steps are only for installing NixOS to another partition. + For installing NixOS in place using <literal>NIXOS_LUSTRATE</literal>, + skip ahead. </para> </note> <para> Prepare your target partition: </para> <para> - 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" /> + 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" /> </para> <para> - If you're about to install NixOS in place using <literal>NIXOS_LUSTRATE</literal> there is nothing to do for this step. + If you're about to install NixOS in place using + <literal>NIXOS_LUSTRATE</literal> there is nothing to do for this step. </para> </listitem> <listitem> @@ -99,11 +118,17 @@ nixpkgs https://nixos.org/channels/nixpkgs-unstable</screen> </para> <screen><prompt>$ </prompt>sudo `which nixos-generate-config` --root /mnt</screen> <para> - You'll probably want to edit the configuration files. Refer to the <literal>nixos-generate-config</literal> step in <xref - linkend="sec-installation" /> for more information. + You'll probably want to edit the configuration files. Refer to the + <literal>nixos-generate-config</literal> step in + <xref + linkend="sec-installation" /> for more + information. </para> <para> - 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>: + 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>: </para> <programlisting> <xref linkend="opt-boot.loader.grub.extraEntries"/> = '' @@ -113,12 +138,14 @@ nixpkgs https://nixos.org/channels/nixpkgs-unstable</screen> } '';</programlisting> <para> - (You can find the appropriate UUID for your partition in <literal>/dev/disk/by-uuid</literal>) + (You can find the appropriate UUID for your partition in + <literal>/dev/disk/by-uuid</literal>) </para> </listitem> <listitem> <para> - Create the <literal>nixbld</literal> group and user on your original distribution: + Create the <literal>nixbld</literal> group and user on your original + distribution: </para> <screen> <prompt>$ </prompt>sudo groupadd -g 30000 nixbld @@ -130,12 +157,14 @@ nixpkgs https://nixos.org/channels/nixpkgs-unstable</screen> </para> <warning> <para> - 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. + 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. </para> </warning> <screen><prompt>$ </prompt>sudo PATH="$PATH" NIX_PATH="$NIX_PATH" `which nixos-install` --root /mnt</screen> <para> - Again, please refer to the <literal>nixos-install</literal> step in <xref linkend="sec-installation" /> for more information. + Again, please refer to the <literal>nixos-install</literal> step in + <xref linkend="sec-installation" /> for more information. </para> <para> That should be it for installation to another partition! @@ -149,13 +178,16 @@ nixpkgs https://nixos.org/channels/nixpkgs-unstable</screen> <prompt>$ </prompt>sudo userdel nixbld <prompt>$ </prompt>sudo groupdel nixbld</screen> <para> - 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>. + 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>. </para> </listitem> <listitem> <note> <para> - The following steps are only for installing NixOS in place using <literal>NIXOS_LUSTRATE</literal>: + The following steps are only for installing NixOS in place using + <literal>NIXOS_LUSTRATE</literal>: </para> </note> <para> @@ -163,11 +195,20 @@ nixpkgs https://nixos.org/channels/nixpkgs-unstable</screen> </para> <screen><prompt>$ </prompt>sudo `which nixos-generate-config` --root /</screen> <para> - 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 - linkend="sec-installation" /> for more information. + 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 + linkend="sec-installation" /> for more + information. </para> <para> - 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>) + 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>) </para> <programlisting> <link linkend="opt-users.users._name__.initialHashedPassword">users.users.root.initialHashedPassword</link> = ""; @@ -175,25 +216,34 @@ nixpkgs https://nixos.org/channels/nixpkgs-unstable</screen> </listitem> <listitem> <para> - Build the NixOS closure and install it in the <literal>system</literal> profile: + Build the NixOS closure and install it in the <literal>system</literal> + profile: </para> <screen><prompt>$ </prompt>nix-env -p /nix/var/nix/profiles/system -f '<nixpkgs/nixos>' -I nixos-config=/etc/nixos/configuration.nix -iA system</screen> </listitem> <listitem> <para> - Change ownership of the <literal>/nix</literal> tree to root (since your Nix install was probably single user): + Change ownership of the <literal>/nix</literal> tree to root (since your + Nix install was probably single user): </para> <screen><prompt>$ </prompt>sudo chown -R 0.0 /nix</screen> </listitem> <listitem> <para> - Set up the <literal>/etc/NIXOS</literal> and <literal>/etc/NIXOS_LUSTRATE</literal> files: + Set up the <literal>/etc/NIXOS</literal> and + <literal>/etc/NIXOS_LUSTRATE</literal> files: </para> <para> - <literal>/etc/NIXOS</literal> officializes that this is now a NixOS partition (the bootup scripts require its presence). + <literal>/etc/NIXOS</literal> officializes that this is now a NixOS + partition (the bootup scripts require its presence). </para> <para> - <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: + <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: </para> <itemizedlist> <listitem> @@ -208,19 +258,26 @@ nixpkgs https://nixos.org/channels/nixpkgs-unstable</screen> </listitem> <listitem> <para> - Any file or directory listed in <literal>/etc/NIXOS_LUSTRATE</literal> (one per line) + Any file or directory listed in <literal>/etc/NIXOS_LUSTRATE</literal> + (one per line) </para> </listitem> </itemizedlist> <note> <para> - 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. + 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. </para> <para> lustrate /ˈlʌstreɪt/ verb. </para> <para> - purify by expiatory sacrifice, ceremonial washing, or some other ritual action. + purify by expiatory sacrifice, ceremonial washing, or some other ritual + action. </para> </note> <para> @@ -231,7 +288,8 @@ nixpkgs https://nixos.org/channels/nixpkgs-unstable</screen> <prompt>$ </prompt>sudo touch /etc/NIXOS_LUSTRATE </screen> <para> - Let's also make sure the NixOS configuration files are kept once we reboot on NixOS: + Let's also make sure the NixOS configuration files are kept once we reboot + on NixOS: </para> <screen> <prompt>$ </prompt>echo etc/nixos | sudo tee -a /etc/NIXOS_LUSTRATE @@ -239,11 +297,18 @@ nixpkgs https://nixos.org/channels/nixpkgs-unstable</screen> </listitem> <listitem> <para> - 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: + 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: </para> <warning> <para> - 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. + 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. </para> </warning> <screen> @@ -256,7 +321,8 @@ sudo /nix/var/nix/profiles/system/bin/switch-to-configuration boot </listitem> <listitem> <para> - 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: + 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: </para> <screen> # mkdir root @@ -271,14 +337,20 @@ sudo /nix/var/nix/profiles/system/bin/switch-to-configuration boot This may work as is or you might also need to reinstall the boot loader </para> <para> - And of course, if you're happy with NixOS and no longer need the old distribution: + And of course, if you're happy with NixOS and no longer need the old + distribution: </para> <screen>sudo rm -rf /old-root</screen> </listitem> <listitem> <para> - 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 - 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. + 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 + 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. </para> </listitem> </orderedlist> diff --git a/nixos/doc/manual/installation/installing-pxe.xml b/nixos/doc/manual/installation/installing-pxe.xml index 5ca320b5bb1..94199e5e028 100644 --- a/nixos/doc/manual/installation/installing-pxe.xml +++ b/nixos/doc/manual/installation/installing-pxe.xml @@ -10,7 +10,9 @@ </para> <para> - 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: + 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: </para> <programlisting> @@ -18,18 +20,31 @@ nix-build -A netboot nixos/release.nix </programlisting> <para> - 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 + 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 </para> <para> - 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>. + 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>. </para> <para> - 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 + 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 </para> <para> - 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. + 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. </para> </section> diff --git a/nixos/doc/manual/installation/installing-usb.xml b/nixos/doc/manual/installation/installing-usb.xml index 99c61511a59..83598635acc 100644 --- a/nixos/doc/manual/installation/installing-usb.xml +++ b/nixos/doc/manual/installation/installing-usb.xml @@ -6,7 +6,12 @@ <title>Booting from a USB Drive</title> <para> - 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. + 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. <note> <title>On macOS</title> <para> @@ -20,12 +25,16 @@ Unmount of all volumes on diskN was successful <prompt>$ </prompt>sudo dd if=nix.iso of=/dev/rdiskN </screen> - 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. + 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. </para> </note> </para> <para> - 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. + 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. </para> </section> diff --git a/nixos/doc/manual/installation/installing-virtualbox-guest.xml b/nixos/doc/manual/installation/installing-virtualbox-guest.xml index f75a1cf0a9c..5c86eacfbf4 100644 --- a/nixos/doc/manual/installation/installing-virtualbox-guest.xml +++ b/nixos/doc/manual/installation/installing-virtualbox-guest.xml @@ -6,8 +6,13 @@ <title>Installing in a VirtualBox guest</title> <para> - 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 - 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: + 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 + 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: </para> <orderedlist> @@ -38,18 +43,21 @@ </listitem> <listitem> <para> - Click on Settings / System / Acceleration and enable "VT-x/AMD-V" acceleration + Click on Settings / System / Acceleration and enable "VT-x/AMD-V" + acceleration </para> </listitem> <listitem> <para> - Save the settings, start the virtual machine, and continue installation like normal + Save the settings, start the virtual machine, and continue installation + like normal </para> </listitem> </orderedlist> <para> - There are a few modifications you should make in configuration.nix. Enable booting: + There are a few modifications you should make in configuration.nix. Enable + booting: </para> <programlisting> @@ -57,7 +65,8 @@ </programlisting> <para> - Also remove the fsck that runs at startup. It will always fail to run, stopping your boot until you press <literal>*</literal>. + Also remove the fsck that runs at startup. It will always fail to run, + stopping your boot until you press <literal>*</literal>. </para> <programlisting> @@ -65,7 +74,13 @@ </programlisting> <para> - 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. + 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. </para> <programlisting> diff --git a/nixos/doc/manual/installation/installing.xml b/nixos/doc/manual/installation/installing.xml index 8049450c684..f1e1568c034 100644 --- a/nixos/doc/manual/installation/installing.xml +++ b/nixos/doc/manual/installation/installing.xml @@ -8,46 +8,67 @@ <title>Booting the system</title> <para> - 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. + 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. </para> <para> - 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"/>). + 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"/>). </para> <para> - The installation media contains a basic NixOS installation. When it’s finished booting, it should have detected most of your hardware. + The installation media contains a basic NixOS installation. When it’s + finished booting, it should have detected most of your hardware. </para> <para> - The NixOS manual is available on virtual console 8 (press Alt+F8 to access) or by running <command>nixos-help</command>. + The NixOS manual is available on virtual console 8 (press Alt+F8 to access) + or by running <command>nixos-help</command>. </para> <para> - 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. + 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. </para> <para> - 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>!) + 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>!) </para> <section xml:id="sec-installation-booting-networking"> <title>Networking in the installer</title> <para> - 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>. + 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>. </para> <para> - To manually configure the network on the graphical installer, first disable network-manager with <command>systemctl stop NetworkManager</command>. + To manually configure the network on the graphical installer, first disable + network-manager with <command>systemctl stop NetworkManager</command>. </para> <para> - To manually configure the wifi on the minimal installer, run <command>wpa_supplicant -B -i interface -c <(wpa_passphrase 'SSID' 'key')</command>. + To manually configure the wifi on the minimal installer, run + <command>wpa_supplicant -B -i interface -c <(wpa_passphrase 'SSID' + 'key')</command>. </para> <para> - 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. + 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. </para> </section> </section> @@ -55,25 +76,32 @@ <title>Partitioning and formatting</title> <para> - The NixOS installer doesn’t do any partitioning or formatting, so you need to do that yourself. + The NixOS installer doesn’t do any partitioning or formatting, so you need + to do that yourself. </para> <para> - 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>. + 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>. </para> <para> - The recommended partition scheme differs depending if the computer uses <emphasis>Legacy Boot</emphasis> or <emphasis>UEFI</emphasis>. + The recommended partition scheme differs depending if the computer uses + <emphasis>Legacy Boot</emphasis> or <emphasis>UEFI</emphasis>. </para> <section xml:id="sec-installation-partitioning-UEFI"> <title>UEFI (GPT)</title> <para> - Here's an example partition scheme for UEFI, using <filename>/dev/sda</filename> as the device. + Here's an example partition scheme for UEFI, using + <filename>/dev/sda</filename> as the device. <note> <para> - You can safely ignore <command>parted</command>'s informational message about needing to update /etc/fstab. + You can safely ignore <command>parted</command>'s informational message + about needing to update /etc/fstab. </para> </note> </para> @@ -88,24 +116,31 @@ </listitem> <listitem> <para> - 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. + 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. <screen language="commands"><prompt># </prompt>parted /dev/sda -- mkpart primary 512MiB -8GiB</screen> </para> </listitem> <listitem> <para> - Next, add a <emphasis>swap</emphasis> partition. The size required will vary according to needs, here a 8GiB one is created. + Next, add a <emphasis>swap</emphasis> partition. The size required will + vary according to needs, here a 8GiB one is created. <screen language="commands"><prompt># </prompt>parted /dev/sda -- mkpart primary linux-swap -8GiB 100%</screen> <note> <para> - The swap partition size rules are no different than for other Linux distributions. + The swap partition size rules are no different than for other Linux + distributions. </para> </note> </para> </listitem> <listitem> <para> - 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. + 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. <screen language="commands"><prompt># </prompt>parted /dev/sda -- mkpart ESP fat32 1MiB 512MiB <prompt># </prompt>parted /dev/sda -- set 3 boot on</screen> </para> @@ -114,7 +149,8 @@ </para> <para> - Once complete, you can follow with <xref linkend="sec-installation-partitioning-formatting"/>. + Once complete, you can follow with + <xref linkend="sec-installation-partitioning-formatting"/>. </para> </section> @@ -122,10 +158,12 @@ <title>Legacy Boot (MBR)</title> <para> - Here's an example partition scheme for Legacy Boot, using <filename>/dev/sda</filename> as the device. + Here's an example partition scheme for Legacy Boot, using + <filename>/dev/sda</filename> as the device. <note> <para> - You can safely ignore <command>parted</command>'s informational message about needing to update /etc/fstab. + You can safely ignore <command>parted</command>'s informational message + about needing to update /etc/fstab. </para> </note> </para> @@ -140,17 +178,20 @@ </listitem> <listitem> <para> - Add the <emphasis>root</emphasis> partition. This will fill the the disk except for the end part, where the swap will live. + Add the <emphasis>root</emphasis> partition. This will fill the the disk + except for the end part, where the swap will live. <screen language="commands"><prompt># </prompt>parted /dev/sda -- mkpart primary 1MiB -8GiB</screen> </para> </listitem> <listitem> <para> - Finally, add a <emphasis>swap</emphasis> partition. The size required will vary according to needs, here a 8GiB one is created. + Finally, add a <emphasis>swap</emphasis> partition. The size required + will vary according to needs, here a 8GiB one is created. <screen language="commands"><prompt># </prompt>parted /dev/sda -- mkpart primary linux-swap -8GiB 100%</screen> <note> <para> - The swap partition size rules are no different than for other Linux distributions. + The swap partition size rules are no different than for other Linux + distributions. </para> </note> </para> @@ -159,7 +200,8 @@ </para> <para> - Once complete, you can follow with <xref linkend="sec-installation-partitioning-formatting"/>. + Once complete, you can follow with + <xref linkend="sec-installation-partitioning-formatting"/>. </para> </section> @@ -171,14 +213,20 @@ <itemizedlist> <listitem> <para> - 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: + 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: <screen> <prompt># </prompt>mkfs.ext4 -L nixos /dev/sda1</screen> </para> </listitem> <listitem> <para> - 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: + 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: <screen> <prompt># </prompt>mkswap -L swap /dev/sda2</screen> </para> @@ -191,7 +239,9 @@ </term> <listitem> <para> - 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: + 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: <screen> <prompt># </prompt>mkfs.fat -F 32 -n boot /dev/sda3</screen> </para> @@ -201,7 +251,9 @@ </listitem> <listitem> <para> - For creating LVM volumes, the LVM commands, e.g., <command>pvcreate</command>, <command>vgcreate</command>, and <command>lvcreate</command>. + For creating LVM volumes, the LVM commands, e.g., + <command>pvcreate</command>, <command>vgcreate</command>, and + <command>lvcreate</command>. </para> </listitem> <listitem> @@ -219,7 +271,8 @@ <orderedlist> <listitem> <para> - Mount the target file system on which NixOS should be installed on <filename>/mnt</filename>, e.g. + Mount the target file system on which NixOS should be installed on + <filename>/mnt</filename>, e.g. <screen> <prompt># </prompt>mount /dev/disk/by-label/nixos /mnt </screen> @@ -245,26 +298,44 @@ </listitem> <listitem> <para> - 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. + 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. <screen> <prompt># </prompt>swapon /dev/sda2</screen> </para> </listitem> <listitem> <para> - 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 - linkend="ch-options"/>. A minimal example is shown in <xref + 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 + linkend="ch-options"/>. A minimal example is shown in + <xref linkend="ex-config"/>. </para> <para> - The command <command>nixos-generate-config</command> can generate an initial configuration file for you: + The command <command>nixos-generate-config</command> can generate an + initial configuration file for you: <screen> <prompt># </prompt>nixos-generate-config --root /mnt</screen> - You should then edit <filename>/mnt/etc/nixos/configuration.nix</filename> to suit your needs: + You should then edit <filename>/mnt/etc/nixos/configuration.nix</filename> + to suit your needs: <screen> <prompt># </prompt>nano /mnt/etc/nixos/configuration.nix </screen> - 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 '<nixpkgs>' -iA emacs</literal>. + 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 '<nixpkgs>' -iA emacs</literal>. </para> <variablelist> <varlistentry> @@ -273,7 +344,9 @@ </term> <listitem> <para> - 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. + 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. </para> </listitem> </varlistentry> @@ -283,26 +356,60 @@ </term> <listitem> <para> - 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. + 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. </para> <para> - 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. + 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. </para> </listitem> </varlistentry> </variablelist> <para> - 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. + 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. </para> <para> - If you need to configure networking for your machine the configuration options are described in <xref linkend="sec-networking"/>. + If you need to configure networking for your machine the configuration + options are described in <xref linkend="sec-networking"/>. </para> <para> - 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. + 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. + </para> <note> <para> - 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. + 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. </para> </note> </listitem> @@ -311,17 +418,24 @@ Do the installation: <screen> <prompt># </prompt>nixos-install</screen> - 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>. + 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>. </para> <para> - As the last step, <command>nixos-install</command> will ask you to set the password for the <literal>root</literal> user, e.g. + As the last step, <command>nixos-install</command> will ask you to set the + password for the <literal>root</literal> user, e.g. <screen> setting root password... Enter new UNIX password: *** Retype new UNIX password: ***</screen> <note> <para> - For unattended installations, it is possible to use <command>nixos-install --no-root-passwd</command> in order to disable the password prompt entirely. + For unattended installations, it is possible to use + <command>nixos-install --no-root-passwd</command> in order to disable + the password prompt entirely. </para> </note> </para> @@ -335,14 +449,21 @@ Retype new UNIX password: ***</screen> </listitem> <listitem> <para> - 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 - 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. + 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 + 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. </para> <para> - You should log in and change the <literal>root</literal> password with <command>passwd</command>. + You should log in and change the <literal>root</literal> password with + <command>passwd</command>. </para> <para> - You’ll probably want to create some user accounts as well, which can be done with <command>useradd</command>: + You’ll probably want to create some user accounts as well, which can be + done with <command>useradd</command>: <screen> <prompt>$ </prompt>useradd -c 'Eelco Dolstra' -m eelco <prompt>$ </prompt>passwd eelco</screen> @@ -363,8 +484,11 @@ Retype new UNIX password: ***</screen> <title>Installation summary</title> <para> - 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" -/> shows a corresponding configuration Nix expression. + 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" +/> shows a + corresponding configuration Nix expression. </para> <example xml:id="ex-partition-scheme-MBR"> diff --git a/nixos/doc/manual/installation/obtaining.xml b/nixos/doc/manual/installation/obtaining.xml index 902f99e1e25..56af5c0e25a 100644 --- a/nixos/doc/manual/installation/obtaining.xml +++ b/nixos/doc/manual/installation/obtaining.xml @@ -5,28 +5,48 @@ xml:id="sec-obtaining"> <title>Obtaining NixOS</title> <para> - NixOS ISO images can be downloaded from the <link -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 -xlink:href="https://nixos.wiki/wiki/NixOS_Installation_Guide#Making_the_installation_media">NixOS Wiki</link>. + NixOS ISO images can be downloaded from the + <link +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 +xlink:href="https://nixos.wiki/wiki/NixOS_Installation_Guide#Making_the_installation_media">NixOS + Wiki</link>. </para> <para> - As an alternative to installing NixOS yourself, you can get a running NixOS system through several other means: + As an alternative to installing NixOS yourself, you can get a running NixOS + system through several other means: <itemizedlist> <listitem> <para> - 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>. + 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>. </para> </listitem> <listitem> <para> - Using AMIs for Amazon’s EC2. To find one for your region and instance type, please refer to the <link - xlink:href="https://github.com/NixOS/nixpkgs/blob/master/nixos/modules/virtualisation/ec2-amis.nix">list of most recent AMIs</link>. + Using AMIs for Amazon’s EC2. To find one for your region and instance + type, please refer to the + <link + xlink:href="https://github.com/NixOS/nixpkgs/blob/master/nixos/modules/virtualisation/ec2-amis.nix">list + of most recent AMIs</link>. </para> </listitem> <listitem> <para> - 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 - xlink:href="https://nixos.org/nixops">NixOps homepage</link> for details. + 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 + xlink:href="https://nixos.org/nixops">NixOps homepage</link> for + details. </para> </listitem> </itemizedlist> diff --git a/nixos/doc/manual/installation/upgrading.xml b/nixos/doc/manual/installation/upgrading.xml index d8b6cda2f2d..35b4d266e12 100644 --- a/nixos/doc/manual/installation/upgrading.xml +++ b/nixos/doc/manual/installation/upgrading.xml @@ -4,33 +4,68 @@ xml:id="sec-upgrading"> <title>Upgrading NixOS</title> <para> - 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: + 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: <itemizedlist> <listitem> <para> - <emphasis>Stable channels</emphasis>, such as <literal - 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. + <emphasis>Stable channels</emphasis>, such as + <literal + 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. </para> <para></para> </listitem> <listitem> <para> - The <emphasis>unstable channel</emphasis>, <literal - 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. + The <emphasis>unstable channel</emphasis>, + <literal + 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. </para> </listitem> <listitem> <para> - <emphasis>Small channels</emphasis>, such as <literal - xlink:href="https://nixos.org/channels/nixos-19.03-small">nixos-19.03-small</literal> or <literal - 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. + <emphasis>Small channels</emphasis>, such as + <literal + xlink:href="https://nixos.org/channels/nixos-19.03-small">nixos-19.03-small</literal> + or + <literal + 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. </para> </listitem> </itemizedlist> - 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. + 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. </para> <para> - 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: + 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: <screen> # nix-channel --list | grep nixos nixos https://nixos.org/channels/nixos-unstable @@ -39,7 +74,8 @@ nixos https://nixos.org/channels/nixos-unstable <screen> # nix-channel --add https://nixos.org/channels/<replaceable>channel-name</replaceable> nixos </screen> - (Be sure to include the <literal>nixos</literal> parameter at the end.) For instance, to use the NixOS 19.03 stable channel: + (Be sure to include the <literal>nixos</literal> parameter at the end.) For + instance, to use the NixOS 19.03 stable channel: <screen> # nix-channel --add https://nixos.org/channels/nixos-19.03 nixos </screen> @@ -53,31 +89,43 @@ nixos https://nixos.org/channels/nixos-unstable </screen> </para> <para> - You can then upgrade NixOS to the latest version in your chosen channel by running + You can then upgrade NixOS to the latest version in your chosen channel by + running <screen> # nixos-rebuild switch --upgrade </screen> - which is equivalent to the more verbose <literal>nix-channel --update nixos; nixos-rebuild switch</literal>. + which is equivalent to the more verbose <literal>nix-channel --update nixos; + nixos-rebuild switch</literal>. </para> <note> <para> - 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> + 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> </para> </note> <warning> <para> - 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. + 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. </para> </warning> <section xml:id="sec-upgrading-automatic"> <title>Automatic Upgrades</title> <para> - You can keep a NixOS system up-to-date automatically by adding the following to <filename>configuration.nix</filename>: + You can keep a NixOS system up-to-date automatically by adding the following + to <filename>configuration.nix</filename>: <programlisting> <xref linkend="opt-system.autoUpgrade.enable"/> = true; </programlisting> - 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. + 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. <programlisting> <xref linkend="opt-system.autoUpgrade.channel"/> = https://nixos.org/channels/nixos-19.03; </programlisting> diff --git a/nixos/doc/manual/man-configuration.xml b/nixos/doc/manual/man-configuration.xml index c6cbaaee541..9f30b792510 100644 --- a/nixos/doc/manual/man-configuration.xml +++ b/nixos/doc/manual/man-configuration.xml @@ -14,7 +14,10 @@ <refsection> <title>Description</title> <para> - 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. + 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. </para> </refsection> <refsection> diff --git a/nixos/doc/manual/man-nixos-build-vms.xml b/nixos/doc/manual/man-nixos-build-vms.xml index 98f29436b2d..7d6e04e0dd9 100644 --- a/nixos/doc/manual/man-nixos-build-vms.xml +++ b/nixos/doc/manual/man-nixos-build-vms.xml @@ -24,12 +24,14 @@ <arg> <option>--help</option> - </arg> - - <arg> - <option>--option</option> <replaceable>name</replaceable> <replaceable>value</replaceable> - </arg> - + </arg> + + <arg> + <option>--option</option> + <replaceable>name</replaceable> + <replaceable>value</replaceable> + </arg> + <arg choice="plain"> <replaceable>network.nix</replaceable> </arg> @@ -38,7 +40,11 @@ <refsection> <title>Description</title> <para> - 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. + 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. </para> <para> A network Nix expression has the following structure: @@ -65,7 +71,18 @@ }; } </screen> - 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. + 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. </para> </refsection> <refsection> @@ -109,10 +126,10 @@ <option>--option</option> <replaceable>name</replaceable> <replaceable>value</replaceable> </term> <listitem> - <para> - Set the Nix configuration option <replaceable>name</replaceable> to <replaceable>value</replaceable>. This overrides settings in the Nix configuration file (see <citerefentry> - <refentrytitle>nix.conf</refentrytitle> - <manvolnum>5</manvolnum></citerefentry>). + <para>Set the Nix configuration option + <replaceable>name</replaceable> to <replaceable>value</replaceable>. + This overrides settings in the Nix configuration file (see + <citerefentry><refentrytitle>nix.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry>). </para> </listitem> </varlistentry> diff --git a/nixos/doc/manual/man-nixos-enter.xml b/nixos/doc/manual/man-nixos-enter.xml index 8cea628a694..1481db46712 100644 --- a/nixos/doc/manual/man-nixos-enter.xml +++ b/nixos/doc/manual/man-nixos-enter.xml @@ -34,7 +34,7 @@ </arg> <replaceable>shell-command</replaceable> </arg> - + <arg> <arg choice='plain'> <option>--silent</option> @@ -58,7 +58,9 @@ <refsection> <title>Description</title> <para> - This command runs a command in a NixOS chroot environment, that is, in a filesystem hierarchy previously prepared using <command>nixos-install</command>. + This command runs a command in a NixOS chroot environment, that is, in a + filesystem hierarchy previously prepared using + <command>nixos-install</command>. </para> </refsection> <refsection> @@ -73,7 +75,8 @@ </term> <listitem> <para> - The path to the NixOS system you want to enter. It defaults to <filename>/mnt</filename>. + The path to the NixOS system you want to enter. It defaults to + <filename>/mnt</filename>. </para> </listitem> </varlistentry> @@ -83,7 +86,10 @@ </term> <listitem> <para> - 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>. + 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>. </para> </listitem> </varlistentry> @@ -106,7 +112,7 @@ </term> <listitem> <para> - Suppresses all output from the activation script of the target system. + Suppresses all output from the activation script of the target system. </para> </listitem> </varlistentry> @@ -116,7 +122,8 @@ </term> <listitem> <para> - Interpret the remaining arguments as the program name and arguments to be invoked. The program is not executed in a shell. + Interpret the remaining arguments as the program name and arguments to be + invoked. The program is not executed in a shell. </para> </listitem> </varlistentry> @@ -125,7 +132,8 @@ <refsection> <title>Examples</title> <para> - Start an interactive shell in the NixOS installation in <filename>/mnt</filename>: + Start an interactive shell in the NixOS installation in + <filename>/mnt</filename>: </para> <screen> # nixos-enter /mnt diff --git a/nixos/doc/manual/man-nixos-generate-config.xml b/nixos/doc/manual/man-nixos-generate-config.xml index 3ebfd50f036..61531a8f01c 100644 --- a/nixos/doc/manual/man-nixos-generate-config.xml +++ b/nixos/doc/manual/man-nixos-generate-config.xml @@ -13,18 +13,18 @@ </refnamediv> <refsynopsisdiv> <cmdsynopsis> - <command>nixos-generate-config</command> + <command>nixos-generate-config</command> <arg> <option>--force</option> </arg> - + <arg> <arg choice='plain'> <option>--root</option> </arg> <replaceable>root</replaceable> </arg> - + <arg> <arg choice='plain'> <option>--dir</option> @@ -44,10 +44,20 @@ </term> <listitem> <para> - 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. + 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. </para> <para> - 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. + 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. </para> </listitem> </varlistentry> @@ -57,7 +67,10 @@ </term> <listitem> <para> - 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. + 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. </para> </listitem> </varlistentry> @@ -76,7 +89,12 @@ </term> <listitem> <para> - 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. + 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. </para> </listitem> </varlistentry> @@ -86,7 +104,9 @@ </term> <listitem> <para> - If this option is given, write the configuration files to the directory <replaceable>dir</replaceable> instead of <filename>/etc/nixos</filename>. + If this option is given, write the configuration files to the directory + <replaceable>dir</replaceable> instead of + <filename>/etc/nixos</filename>. </para> </listitem> </varlistentry> @@ -96,7 +116,8 @@ </term> <listitem> <para> - Overwrite <filename>/etc/nixos/configuration.nix</filename> if it already exists. + Overwrite <filename>/etc/nixos/configuration.nix</filename> if it already + exists. </para> </listitem> </varlistentry> @@ -106,7 +127,8 @@ </term> <listitem> <para> - Omit everything concerning file systems and swap devices from the hardware configuration. + Omit everything concerning file systems and swap devices from the + hardware configuration. </para> </listitem> </varlistentry> @@ -116,7 +138,9 @@ </term> <listitem> <para> - Don't generate <filename>configuration.nix</filename> or <filename>hardware-configuration.nix</filename> and print the hardware configuration to stdout only. + Don't generate <filename>configuration.nix</filename> or + <filename>hardware-configuration.nix</filename> and print the hardware + configuration to stdout only. </para> </listitem> </varlistentry> @@ -125,11 +149,16 @@ <refsection> <title>Examples</title> <para> - 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: + 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: <screen> <prompt>$ </prompt>nixos-generate-config --root /mnt </screen> - The resulting file <filename>/mnt/etc/nixos/hardware-configuration.nix</filename> might look like this: + The resulting file + <filename>/mnt/etc/nixos/hardware-configuration.nix</filename> might look + like this: <programlisting> # Do not modify this file! It was generated by ‘nixos-generate-config’ # and may be overwritten by future invocations. Please make changes @@ -164,7 +193,10 @@ nix.maxJobs = 8; } </programlisting> - 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: + 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: <programlisting> imports = [ ./hardware-configuration.nix ]; </programlisting> @@ -174,7 +206,9 @@ <screen> <prompt>$ </prompt>nixos-generate-config </screen> - to update <filename>/etc/nixos/hardware-configuration.nix</filename>. Your <filename>/etc/nixos/configuration.nix</filename> will <emphasis>not</emphasis> be overwritten. + to update <filename>/etc/nixos/hardware-configuration.nix</filename>. Your + <filename>/etc/nixos/configuration.nix</filename> will + <emphasis>not</emphasis> be overwritten. </para> </refsection> </refentry> diff --git a/nixos/doc/manual/man-nixos-install.xml b/nixos/doc/manual/man-nixos-install.xml index aec01b0ee3b..4fb94ee7494 100644 --- a/nixos/doc/manual/man-nixos-install.xml +++ b/nixos/doc/manual/man-nixos-install.xml @@ -13,72 +13,72 @@ </refnamediv> <refsynopsisdiv> <cmdsynopsis> - <command>nixos-install</command> + <command>nixos-install</command> <arg> <arg choice='plain'> <option>-I</option> </arg> <replaceable>path</replaceable> </arg> - + <arg> <arg choice='plain'> <option>--root</option> </arg> <replaceable>root</replaceable> </arg> - + <arg> <arg choice='plain'> <option>--system</option> </arg> <replaceable>path</replaceable> </arg> - + <arg> <arg choice='plain'> <option>--no-channel-copy</option> </arg> </arg> - + <arg> <arg choice='plain'> <option>--no-root-passwd</option> </arg> </arg> - + <arg> <arg choice='plain'> <option>--no-bootloader</option> </arg> </arg> - + <arg> - <group choice='req'> + <group choice='req'> <arg choice='plain'> <option>--max-jobs</option> </arg> - + <arg choice='plain'> <option>-j</option> </arg> </group> <replaceable>number</replaceable> </arg> - + <arg> <option>--cores</option> <replaceable>number</replaceable> </arg> - + <arg> <option>--option</option> <replaceable>name</replaceable> <replaceable>value</replaceable> </arg> - + <arg> <arg choice='plain'> <option>--show-trace</option> </arg> </arg> - + <arg> <arg choice='plain'> <option>--help</option> @@ -89,32 +89,43 @@ <refsection> <title>Description</title> <para> - 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: + 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: <itemizedlist> <listitem> <para> - It copies Nix and its dependencies to <filename>/mnt/nix/store</filename>. + It copies Nix and its dependencies to + <filename>/mnt/nix/store</filename>. </para> </listitem> <listitem> <para> - It runs Nix in <filename>/mnt</filename> to build the NixOS configuration specified in <filename>/mnt/etc/nixos/configuration.nix</filename>. + It runs Nix in <filename>/mnt</filename> to build the NixOS configuration + specified in <filename>/mnt/etc/nixos/configuration.nix</filename>. </para> </listitem> <listitem> <para> - 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. + 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. </para> </listitem> <listitem> <para> - It prompts you for a password for the root account (unless <option>--no-root-passwd</option> is specified). + It prompts you for a password for the root account (unless + <option>--no-root-passwd</option> is specified). </para> </listitem> </itemizedlist> </para> <para> - 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. + 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. </para> </refsection> <refsection> @@ -129,7 +140,9 @@ </term> <listitem> <para> - Defaults to <filename>/mnt</filename>. If this option is given, treat the directory <replaceable>root</replaceable> as the root of the NixOS installation. + Defaults to <filename>/mnt</filename>. If this option is given, treat the + directory <replaceable>root</replaceable> as the root of the NixOS + installation. </para> </listitem> </varlistentry> @@ -139,10 +152,16 @@ </term> <listitem> <para> - 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>. + 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>. </para> <para> - 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 '<nixos>' -A system --no-out-link</command> + 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 '<nixos>' -A system + --no-out-link</command> </para> </listitem> </varlistentry> @@ -152,7 +171,10 @@ </term> <listitem> <para> - 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. + 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. </para> </listitem> </varlistentry> @@ -165,7 +187,9 @@ </term> <listitem> <para> - 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. + 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. </para> </listitem> </varlistentry> @@ -175,7 +199,15 @@ </term> <listitem> <para> - 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. + 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. </para> </listitem> </varlistentry> @@ -185,7 +217,8 @@ </term> <listitem> <para> - Set the Nix configuration option <replaceable>name</replaceable> to <replaceable>value</replaceable>. + Set the Nix configuration option <replaceable>name</replaceable> to + <replaceable>value</replaceable>. </para> </listitem> </varlistentry> @@ -195,7 +228,8 @@ </term> <listitem> <para> - Causes Nix to print out a stack trace in case of Nix expression evaluation errors. + Causes Nix to print out a stack trace in case of Nix expression + evaluation errors. </para> </listitem> </varlistentry> @@ -214,7 +248,12 @@ <refsection> <title>Examples</title> <para> - 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>: + 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>: <screen> <prompt>$ </prompt>mkfs.ext4 /dev/sda1 <prompt>$ </prompt>mount /dev/sda1 /mnt diff --git a/nixos/doc/manual/man-nixos-option.xml b/nixos/doc/manual/man-nixos-option.xml index 29a6ca08205..3e316e10d4e 100644 --- a/nixos/doc/manual/man-nixos-option.xml +++ b/nixos/doc/manual/man-nixos-option.xml @@ -13,19 +13,19 @@ </refnamediv> <refsynopsisdiv> <cmdsynopsis> - <command>nixos-option</command> + <command>nixos-option</command> <arg> <option>-I</option> <replaceable>path</replaceable> </arg> - + <arg> <option>--verbose</option> </arg> - + <arg> <option>--xml</option> </arg> - + <arg choice="plain"> <replaceable>option.name</replaceable> </arg> @@ -34,10 +34,13 @@ <refsection> <title>Description</title> <para> - This command evaluates the configuration specified in <filename>/etc/nixos/configuration.nix</filename> and returns the properties of the option name given as argument. + This command evaluates the configuration specified in + <filename>/etc/nixos/configuration.nix</filename> and returns the properties + of the option name given as argument. </para> <para> - When the option name is not an option, the command prints the list of attributes contained in the attribute set. + When the option name is not an option, the command prints the list of + attributes contained in the attribute set. </para> </refsection> <refsection> @@ -52,7 +55,8 @@ </term> <listitem> <para> - This option is passed to the underlying <command>nix-instantiate</command> invocation. + This option is passed to the underlying + <command>nix-instantiate</command> invocation. </para> </listitem> </varlistentry> @@ -62,7 +66,8 @@ </term> <listitem> <para> - This option enables verbose mode, which currently is just the Bash <command>set</command> <option>-x</option> debug mode. + This option enables verbose mode, which currently is just the Bash + <command>set</command> <option>-x</option> debug mode. </para> </listitem> </varlistentry> @@ -87,7 +92,8 @@ </term> <listitem> <para> - Path to the main NixOS configuration module. Defaults to <filename>/etc/nixos/configuration.nix</filename>. + Path to the main NixOS configuration module. Defaults to + <filename>/etc/nixos/configuration.nix</filename>. </para> </listitem> </varlistentry> @@ -124,7 +130,8 @@ Defined by: <refsection> <title>Bugs</title> <para> - The author listed in the following section is wrong. If there is any other bug, please report to Nicolas Pierron. + The author listed in the following section is wrong. If there is any other + bug, please report to Nicolas Pierron. </para> </refsection> </refentry> diff --git a/nixos/doc/manual/man-nixos-rebuild.xml b/nixos/doc/manual/man-nixos-rebuild.xml index 85929bf1b15..a83c4fb965e 100644 --- a/nixos/doc/manual/man-nixos-rebuild.xml +++ b/nixos/doc/manual/man-nixos-rebuild.xml @@ -7,45 +7,47 @@ <refmiscinfo class="source">NixOS</refmiscinfo> <!-- <refmiscinfo class="version"><xi:include href="version.txt" parse="text"/></refmiscinfo> --> </refmeta> + <refnamediv> <refname><command>nixos-rebuild</command> </refname><refpurpose>reconfigure a NixOS machine</refpurpose> </refnamediv> + <refsynopsisdiv> <cmdsynopsis> - <command>nixos-rebuild</command><group choice='req'> + <command>nixos-rebuild</command><group choice='req'> <arg choice='plain'> <option>switch</option> </arg> - + <arg choice='plain'> <option>boot</option> </arg> - + <arg choice='plain'> <option>test</option> </arg> - + <arg choice='plain'> <option>build</option> </arg> - + <arg choice='plain'> <option>dry-build</option> </arg> - + <arg choice='plain'> <option>dry-activate</option> </arg> - + <arg choice='plain'> <option>edit</option> </arg> - + <arg choice='plain'> <option>build-vm</option> </arg> - + <arg choice='plain'> <option>build-vm-with-bootloader</option> </arg> @@ -54,33 +56,34 @@ <arg> <option>--upgrade</option> </arg> - + <arg> <option>--install-bootloader</option> </arg> - + <arg> <option>--no-build-nix</option> </arg> - + <arg> <option>--fast</option> </arg> - + <arg> <option>--rollback</option> </arg> - + <arg> <option>--builders</option> <replaceable>builder-spec</replaceable> </arg> + <sbr /> <arg> - <group choice='req'> + <group choice='req'> <arg choice='plain'> <option>--profile-name</option> </arg> - + <arg choice='plain'> <option>-p</option> </arg> @@ -90,67 +93,56 @@ <arg> <option>--show-trace</option> </arg> - <arg> - <option>-I</option> <replaceable>path</replaceable> + <option>-I</option> + <replaceable>path</replaceable> </arg> - <arg> - <group choice='req'> - <arg choice='plain'> - <option>--verbose</option> - </arg> - - <arg choice='plain'> - <option>-v</option> - </arg> - </group> + <group choice='req'> + <arg choice='plain'><option>--verbose</option></arg> + <arg choice='plain'><option>-v</option></arg> + </group> </arg> - <arg> - <group choice='req'> - <arg choice='plain'> - <option>--max-jobs</option> - </arg> - - <arg choice='plain'> - <option>-j</option> - </arg> - </group> <replaceable>number</replaceable> + <group choice='req'> + <arg choice='plain'><option>--max-jobs</option></arg> + <arg choice='plain'><option>-j</option></arg> + </group> + <replaceable>number</replaceable> </arg> - <arg> - <group choice='req'> - <arg choice='plain'> - <option>--keep-failed</option> - </arg> - - <arg choice='plain'> - <option>-K</option> - </arg> - </group> + <group choice='req'> + <arg choice='plain'><option>--keep-failed</option></arg> + <arg choice='plain'><option>-K</option></arg> + </group> </arg> - <arg> - <group choice='req'> - <arg choice='plain'> - <option>--keep-going</option> - </arg> - - <arg choice='plain'> - <option>-k</option> - </arg> - </group> + <group choice='req'> + <arg choice='plain'><option>--keep-going</option></arg> + <arg choice='plain'><option>-k</option></arg> + </group> </arg> </cmdsynopsis> </refsynopsisdiv> + <refsection> <title>Description</title> + <para> - 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. + 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. </para> + <para> - This command has one required argument, which specifies the desired operation. It must be one of the following: + This command has one required argument, which specifies the desired + operation. It must be one of the following: + <variablelist> <varlistentry> <term> @@ -158,64 +150,91 @@ </term> <listitem> <para> - 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. + 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. </para> </listitem> </varlistentry> + <varlistentry> <term> <option>boot</option> </term> <listitem> <para> - 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. + 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. </para> </listitem> </varlistentry> + <varlistentry> <term> <option>test</option> </term> <listitem> <para> - 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>). + 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>). </para> </listitem> </varlistentry> + <varlistentry> <term> <option>build</option> </term> <listitem> <para> - 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 + 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 <screen> <prompt>$ </prompt>nix-build /path/to/nixpkgs/nixos -A system </screen> - Note that you do not need to be <literal>root</literal> to run <command>nixos-rebuild build</command>. + Note that you do not need to be <literal>root</literal> to run + <command>nixos-rebuild build</command>. </para> </listitem> </varlistentry> + <varlistentry> <term> <option>dry-build</option> </term> <listitem> <para> - Show what store paths would be built or downloaded by any of the operations above, but otherwise do nothing. + Show what store paths would be built or downloaded by any of the + operations above, but otherwise do nothing. </para> </listitem> </varlistentry> + <varlistentry> <term> <option>dry-activate</option> </term> <listitem> <para> - 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. + 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. </para> </listitem> </varlistentry> + <varlistentry> <term> <option>edit</option> @@ -226,49 +245,80 @@ </para> </listitem> </varlistentry> + <varlistentry> <term> <option>build-vm</option> </term> <listitem> <para> - 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: + 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: <screen> <prompt>$ </prompt>nixos-rebuild build-vm <prompt>$ </prompt>./result/bin/run-*-vm </screen> </para> + <para> - 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. + 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. </para> + <para> - 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. + 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. </para> + <para> - 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>. + 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>. <!-- The entire file system hierarchy of the host is available in the VM under <filename>/hostfs</filename>.--> </para> </listitem> </varlistentry> + <varlistentry> <term> <option>build-vm-with-bootloader</option> </term> <listitem> <para> - 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. + 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. </para> </listitem> </varlistentry> </variablelist> </para> </refsection> + <refsection> <title>Options</title> <para> This command accepts the following options: </para> + <variablelist> <varlistentry> <term> @@ -280,56 +330,84 @@ </para> </listitem> </varlistentry> + <varlistentry> <term> <option>--install-bootloader</option> </term> <listitem> <para> - Causes the boot loader to be (re)installed on the device specified by the relevant configuration options. + Causes the boot loader to be (re)installed on the device specified by the + relevant configuration options. </para> </listitem> </varlistentry> + <varlistentry> <term> <option>--no-build-nix</option> </term> <listitem> <para> - 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. + 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. </para> </listitem> </varlistentry> + <varlistentry> <term> <option>--fast</option> </term> <listitem> <para> - 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). + 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). </para> </listitem> </varlistentry> + <varlistentry> <term> <option>--rollback</option> </term> <listitem> <para> - 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>.) + 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>.) </para> </listitem> </varlistentry> + <varlistentry> <term> <option>--builders</option> <replaceable>builder-spec</replaceable> </term> <listitem> <para> - 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. + 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. </para> </listitem> </varlistentry> + <varlistentry> <term> <option>--profile-name</option> @@ -339,56 +417,97 @@ </term> <listitem> <para> - 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. + 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. </para> <para> - For instance, if you want to test a configuration file named <filename>test.nix</filename> without affecting the default system profile, you would do: + For instance, if you want to test a configuration file named + <filename>test.nix</filename> without affecting the default system + profile, you would do: <screen> <prompt>$ </prompt>nixos-rebuild switch -p test -I nixos-config=./test.nix </screen> - The new configuration will appear in the GRUB 2 submenu “NixOS - Profile 'test'”. + The new configuration will appear in the GRUB 2 submenu “NixOS - + Profile 'test'”. </para> </listitem> </varlistentry> + <varlistentry> <term> <option>--build-host</option> </term> <listitem> <para> - 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. + 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. </para> <para> - 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. + 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. </para> <para> - 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. + 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. </para> </listitem> </varlistentry> + <varlistentry> <term> <option>--target-host</option> </term> <listitem> <para> - 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. + 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. </para> + <para> - 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). + 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). </para> + <para> - 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. + 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. </para> </listitem> </varlistentry> </variablelist> + <para> - 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. + 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. </para> </refsection> + <refsection> <title>Environment</title> + <variablelist> <varlistentry> <term> @@ -396,25 +515,31 @@ </term> <listitem> <para> - Path to the main NixOS configuration module. Defaults to <filename>/etc/nixos/configuration.nix</filename>. + Path to the main NixOS configuration module. Defaults to + <filename>/etc/nixos/configuration.nix</filename>. </para> </listitem> </varlistentry> + <varlistentry> <term> <envar>NIX_SSHOPTS</envar> </term> <listitem> <para> - Additional options to be passed to <command>ssh</command> on the command line. + Additional options to be passed to <command>ssh</command> on the command + line. </para> </listitem> </varlistentry> </variablelist> </refsection> + <refsection> <title>Files</title> + <variablelist> + <varlistentry> <term> <filename>/run/current-system</filename> @@ -425,18 +550,22 @@ </para> </listitem> </varlistentry> + <varlistentry> <term> <filename>/nix/var/nix/profiles/system</filename> </term> <listitem> <para> - The Nix profile that contains the current and previous system configurations. Used to generate the GRUB boot menu. + The Nix profile that contains the current and previous system + configurations. Used to generate the GRUB boot menu. </para> </listitem> </varlistentry> + </variablelist> </refsection> + <refsection> <title>Bugs</title> <para> diff --git a/nixos/doc/manual/man-nixos-version.xml b/nixos/doc/manual/man-nixos-version.xml index cb844da10f0..931c4a5ad02 100644 --- a/nixos/doc/manual/man-nixos-version.xml +++ b/nixos/doc/manual/man-nixos-version.xml @@ -25,7 +25,8 @@ <refsection> <title>Description</title> <para> - This command shows the version of the currently active NixOS configuration. For example: + This command shows the version of the currently active NixOS configuration. + For example: <screen>$ nixos-version 16.03.1011.6317da4 (Emu) </screen> @@ -37,7 +38,8 @@ </term> <listitem> <para> - The NixOS release, indicating the year and month in which it was released (e.g. March 2016). + The NixOS release, indicating the year and month in which it was + released (e.g. March 2016). </para> </listitem> </varlistentry> @@ -47,7 +49,12 @@ </term> <listitem> <para> - 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. + 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. </para> </listitem> </varlistentry> @@ -57,7 +64,8 @@ </term> <listitem> <para> - The first 7 characters of the commit in the Nixpkgs Git repository from which this version was built. + The first 7 characters of the commit in the Nixpkgs Git repository from + which this version was built. </para> </listitem> </varlistentry> @@ -67,7 +75,9 @@ </term> <listitem> <para> - 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. + 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. </para> </listitem> </varlistentry> @@ -89,7 +99,8 @@ </term> <listitem> <para> - Show the full SHA1 hash of the Git commit from which this configuration was built, e.g. + Show the full SHA1 hash of the Git commit from which this configuration + was built, e.g. <screen>$ nixos-version --hash 6317da40006f6bc2480c6781999c52d88dde2acf </screen> diff --git a/nixos/doc/manual/manual.xml b/nixos/doc/manual/manual.xml index 9f7260b2495..12f52e1997c 100644 --- a/nixos/doc/manual/manual.xml +++ b/nixos/doc/manual/manual.xml @@ -11,17 +11,26 @@ <preface xml:id="preface"> <title>Preface</title> <para> - This manual describes how to install, use and extend NixOS, a Linux distribution based on the purely functional package management system Nix. + This manual describes how to install, use and extend NixOS, a Linux + distribution based on the purely functional package management system Nix. </para> <para> - If you encounter problems, please report them on the <literal - xlink:href="https://discourse.nixos.org">Discourse</literal> or on the <link - xlink:href="irc://irc.freenode.net/#nixos"> <literal>#nixos</literal> channel on Freenode</link>. Bugs should be reported in <link - xlink:href="https://github.com/NixOS/nixpkgs/issues">NixOS’ GitHub issue tracker</link>. + If you encounter problems, please report them on the + <literal + xlink:href="https://discourse.nixos.org">Discourse</literal> or + on the <link + xlink:href="irc://irc.freenode.net/#nixos"> + <literal>#nixos</literal> channel on Freenode</link>. Bugs should be + reported in + <link + xlink:href="https://github.com/NixOS/nixpkgs/issues">NixOS’ + GitHub issue tracker</link>. </para> <note> <para> - 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. + 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. </para> </note> </preface> diff --git a/nixos/doc/manual/release-notes/release-notes.xml b/nixos/doc/manual/release-notes/release-notes.xml index 198f8eb3481..444862c5739 100644 --- a/nixos/doc/manual/release-notes/release-notes.xml +++ b/nixos/doc/manual/release-notes/release-notes.xml @@ -5,7 +5,8 @@ xml:id="ch-release-notes"> <title>Release Notes</title> <para> - This section lists the release notes for each stable version of NixOS and current unstable revision. + This section lists the release notes for each stable version of NixOS and + current unstable revision. </para> <xi:include href="rl-2003.xml" /> <xi:include href="rl-1909.xml" /> diff --git a/nixos/doc/manual/release-notes/rl-1404.xml b/nixos/doc/manual/release-notes/rl-1404.xml index 26dc5bb252e..8d8cea4303a 100644 --- a/nixos/doc/manual/release-notes/rl-1404.xml +++ b/nixos/doc/manual/release-notes/rl-1404.xml @@ -6,16 +6,23 @@ <title>Release 14.04 (“Baboon”, 2014/04/30)</title> <para> - 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: + 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: <itemizedlist> <listitem> <para> - Installation on UEFI systems is now supported. See <xref linkend="sec-installation"/> for details. + Installation on UEFI systems is now supported. See + <xref linkend="sec-installation"/> for details. </para> </listitem> <listitem> <para> - 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. + 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. </para> </listitem> <listitem> @@ -40,28 +47,47 @@ </listitem> <listitem> <para> - Nix has been updated to 1.7 (<link + Nix has been updated to 1.7 + (<link xlink:href="http://nixos.org/nix/manual/#ssec-relnotes-1.7">details</link>). </para> </listitem> <listitem> <para> - 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 - 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. + 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 + 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. </para> </listitem> <listitem> <para> - 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. + 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. </para> </listitem> <listitem> <para> - 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: + 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: <programlisting> systemd.packages = [ pkgs.foo ]; </programlisting> - to enable those units. You can then set or override unit options in the usual way, e.g. + to enable those units. You can then set or override unit options in the + usual way, e.g. <programlisting> systemd.services.foo.wantedBy = [ "multi-user.target" ]; systemd.services.foo.serviceConfig.MemoryLimit = "512M"; @@ -72,11 +98,14 @@ systemd.services.foo.serviceConfig.MemoryLimit = "512M"; </para> <para> - When upgrading from a previous release, please be aware of the following incompatible changes: + When upgrading from a previous release, please be aware of the following + incompatible changes: <itemizedlist> <listitem> <para> - 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: + 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: <programlisting> nixpkgs.config.allowUnfree = true; </programlisting> @@ -89,7 +118,8 @@ error: package ‘nvidia-x11-331.49-3.12.17’ in ‘…/nvidia-x11/default.nix: </listitem> <listitem> <para> - The Adobe Flash player is no longer enabled by default in the Firefox and Chromium wrappers. To enable it, you must set: + The Adobe Flash player is no longer enabled by default in the Firefox and + Chromium wrappers. To enable it, you must set: <programlisting> nixpkgs.config.allowUnfree = true; nixpkgs.config.firefox.enableAdobeFlash = true; # for Firefox @@ -99,7 +129,8 @@ nixpkgs.config.chromium.enableAdobeFlash = true; # for Chromium </listitem> <listitem> <para> - The firewall is now enabled by default. If you don’t want this, you need to disable it explicitly: + The firewall is now enabled by default. If you don’t want this, you need + to disable it explicitly: <programlisting> networking.firewall.enable = false; </programlisting> @@ -107,22 +138,40 @@ networking.firewall.enable = false; </listitem> <listitem> <para> - The option <option>boot.loader.grub.memtest86</option> has been renamed to <option>boot.loader.grub.memtest86.enable</option>. + The option <option>boot.loader.grub.memtest86</option> has been renamed to + <option>boot.loader.grub.memtest86.enable</option>. </para> </listitem> <listitem> <para> - 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>. + 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>. </para> </listitem> <listitem> <para> - 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. + 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. </para> </listitem> <listitem> <para> - 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>). + 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>). </para> </listitem> </itemizedlist> diff --git a/nixos/doc/manual/release-notes/rl-1412.xml b/nixos/doc/manual/release-notes/rl-1412.xml index af17e166322..139f61c2a55 100644 --- a/nixos/doc/manual/release-notes/rl-1412.xml +++ b/nixos/doc/manual/release-notes/rl-1412.xml @@ -6,16 +6,19 @@ <title>Release 14.12 (“Caterpillar”, 2014/12/30)</title> <para> - In addition to numerous new and upgraded packages, this release has the following highlights: + In addition to numerous new and upgraded packages, this release has the + following highlights: <itemizedlist> <listitem> <para> - 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> + 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> </para> </listitem> <listitem> <para> - <link xlink:href="https://www.mail-archive.com/nix-dev@lists.science.uu.nl/msg13957.html"> Nix has been updated to 1.8.</link> + <link xlink:href="https://www.mail-archive.com/nix-dev@lists.science.uu.nl/msg13957.html"> + Nix has been updated to 1.8.</link> </para> </listitem> <listitem> @@ -35,7 +38,13 @@ </listitem> <listitem> <para> - 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. + 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. </para> </listitem> </itemizedlist> @@ -353,12 +362,18 @@ </para> <para> - When upgrading from a previous release, please be aware of the following incompatible changes: + When upgrading from a previous release, please be aware of the following + incompatible changes: <itemizedlist> <listitem> <para> - 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 -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: + 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 +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: <programlisting> services.httpd.package = pkgs.apacheHttpd_2_2; </programlisting> @@ -366,57 +381,85 @@ services.httpd.package = pkgs.apacheHttpd_2_2; </listitem> <listitem> <para> - PHP 5.3 has been removed because it is no longer supported by the PHP project. A <link -xlink:href="http://php.net/migration54">migration guide</link> is available. + PHP 5.3 has been removed because it is no longer supported by the PHP + project. A <link +xlink:href="http://php.net/migration54">migration + guide</link> is available. </para> </listitem> <listitem> <para> - 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>. + 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>. </para> </listitem> <listitem> <para> - GNOME 3.10 support has been dropped. The default GNOME version is now 3.12. + GNOME 3.10 support has been dropped. The default GNOME version is now + 3.12. </para> </listitem> <listitem> <para> - 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 = [ <nixpkgs/nixos/modules/programs/virtualbox.nix> ]</literal> is no longer necessary, use <literal>services.virtualboxHost.enable = true</literal> instead. + 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 = [ + <nixpkgs/nixos/modules/programs/virtualbox.nix> ]</literal> is no + longer necessary, use <literal>services.virtualboxHost.enable = + true</literal> instead. </para> <para> - 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. + 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. </para> </listitem> <listitem> <para> - 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>. + 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>. </para> </listitem> <listitem> <para> - 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>. + 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>. </para> </listitem> <listitem> <para> - <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. + <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. </para> </listitem> <listitem> <para> - 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 + 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 xlink:href="https://en.wikipedia.org/wiki/List_of_tz_database_time_zones"/>. </para> </listitem> <listitem> <para> - GNU screen has been updated to 4.2.1, which breaks the ability to connect to sessions created by older versions of screen. + GNU screen has been updated to 4.2.1, which breaks the ability to connect + to sessions created by older versions of screen. </para> </listitem> <listitem> <para> - The Intel GPU driver was updated to the 3.x prerelease version (used by most distributions) and supports DRI3 now. + The Intel GPU driver was updated to the 3.x prerelease version (used by + most distributions) and supports DRI3 now. </para> </listitem> </itemizedlist> diff --git a/nixos/doc/manual/release-notes/rl-1509.xml b/nixos/doc/manual/release-notes/rl-1509.xml index 5e162c3f0f7..5c4d9970178 100644 --- a/nixos/doc/manual/release-notes/rl-1509.xml +++ b/nixos/doc/manual/release-notes/rl-1509.xml @@ -6,23 +6,42 @@ <title>Release 15.09 (“Dingo”, 2015/09/30)</title> <para> - In addition to numerous new and upgraded packages, this release has the following highlights: + In addition to numerous new and upgraded packages, this release has the + following highlights: </para> <itemizedlist> <listitem> <para> - The <link xlink:href="http://haskell.org/">Haskell</link> packages infrastructure has been re-designed from the ground up ("Haskell NG"). NixOS now distributes the latest version of every single package registered on <link - 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 - 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 - xlink:href="http://www.stackage.org/">LTS Haskell</link> release since version 0.0 as well as the most recent <link - xlink:href="http://www.stackage.org/">Stackage Nightly</link> snapshot. The announcement <link - xlink:href="https://nixos.org/nix-dev/2015-September/018138.html">"Full Stackage Support in Nixpkgs"</link> gives additional details. + The <link xlink:href="http://haskell.org/">Haskell</link> packages + infrastructure has been re-designed from the ground up ("Haskell + NG"). NixOS now distributes the latest version of every single package + registered on + <link + 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 + 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 + xlink:href="http://www.stackage.org/">LTS Haskell</link> release + since version 0.0 as well as the most recent + <link + xlink:href="http://www.stackage.org/">Stackage Nightly</link> + snapshot. The announcement + <link + xlink:href="https://nixos.org/nix-dev/2015-September/018138.html">"Full + Stackage Support in Nixpkgs"</link> gives additional details. </para> </listitem> <listitem> <para> - Nix has been updated to version 1.10, which among other improvements enables cryptographic signatures on binary caches for improved security. + Nix has been updated to version 1.10, which among other improvements + enables cryptographic signatures on binary caches for improved security. </para> </listitem> <listitem> @@ -31,7 +50,8 @@ <programlisting> system.autoUpgrade.enable = true; </programlisting> - This will cause the system to periodically check for updates in your current channel and run <command>nixos-rebuild</command>. + This will cause the system to periodically check for updates in your + current channel and run <command>nixos-rebuild</command>. </para> </listitem> <listitem> @@ -51,7 +71,8 @@ system.autoUpgrade.enable = true; </listitem> <listitem> <para> - 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. + 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. </para> </listitem> <listitem> @@ -403,61 +424,93 @@ system.autoUpgrade.enable = true; </para> <para> - When upgrading from a previous release, please be aware of the following incompatible changes: + When upgrading from a previous release, please be aware of the following + incompatible changes: <itemizedlist> <listitem> <para> - <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 + <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 <programlisting> system.stateVersion = "14.12"; </programlisting> - 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. + 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. </para> </listitem> <listitem> <para> - <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>. + <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>. </para> </listitem> <listitem> <para> - 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>. + 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>. </para> </listitem> <listitem> <para> - 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>. + 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>. </para> </listitem> <listitem> <para> - CMPlayer has been renamed to bomi upstream. Package <literal>cmplayer</literal> was accordingly renamed to <literal>bomi</literal> + CMPlayer has been renamed to bomi upstream. Package + <literal>cmplayer</literal> was accordingly renamed to + <literal>bomi</literal> </para> </listitem> <listitem> <para> - Atom Shell has been renamed to Electron upstream. Package <literal>atom-shell</literal> was accordingly renamed to <literal>electron</literal> + Atom Shell has been renamed to Electron upstream. Package + <literal>atom-shell</literal> was accordingly renamed to + <literal>electron</literal> </para> </listitem> <listitem> <para> - Elm is not released on Hackage anymore. You should now use <literal>elmPackages.elm</literal> which contains the latest Elm platform. + Elm is not released on Hackage anymore. You should now use + <literal>elmPackages.elm</literal> which contains the latest Elm platform. </para> </listitem> <listitem> <para> - 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>. + 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>. </para> <para> - 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. + 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. </para> </listitem> <listitem> <para> - 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>. + 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>. </para> <para> - 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: + 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: <programlisting> fileSystems."/shiny" = { device = "myshinysharedfolder"; @@ -468,7 +521,15 @@ fileSystems."/shiny" = { </listitem> <listitem> <para> - "<literal>nix-env -qa</literal>" 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: + "<literal>nix-env -qa</literal>" 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: </para> <programlisting> nix-env -f "<nixpkgs>" -qaP -A haskellPackages @@ -480,56 +541,91 @@ nix-env -f "<nixpkgs>" -qaP -A haskellPackages nix-env -f "<nixpkgs>" -iA haskellPackages.pandoc </programlisting> <para> - Installing Haskell <emphasis>libraries</emphasis> this way, however, is no longer supported. See the next item for more details. + Installing Haskell <emphasis>libraries</emphasis> this way, however, is no + longer supported. See the next item for more details. </para> </listitem> <listitem> <para> - 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 - 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. + 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 + 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. </para> </listitem> <listitem> <para> - 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>. + 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>. </para> </listitem> <listitem> <para> - 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>. + 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>. </para> </listitem> <listitem> <para> - 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. + 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. </para> </listitem> <listitem> <para> - The <literal>phpfpm</literal> is now using the default PHP version (<literal>pkgs.php</literal>) instead of PHP 5.4 (<literal>pkgs.php54</literal>). + The <literal>phpfpm</literal> is now using the default PHP version + (<literal>pkgs.php</literal>) instead of PHP 5.4 + (<literal>pkgs.php54</literal>). </para> </listitem> <listitem> <para> - 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>. + 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>. </para> </listitem> <listitem> <para> - 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>. + 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>. </para> </listitem> <listitem> <para> - Python 2.6 has been marked as broken (as it no longer receives security updates from upstream). + Python 2.6 has been marked as broken (as it no longer receives security + updates from upstream). </para> </listitem> <listitem> <para> - 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. + 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. </para> <para> - In case of an infinite loop, use the <command>--show-trace</command> command line argument and read the line just above the error message. + In case of an infinite loop, use the <command>--show-trace</command> + command line argument and read the line just above the error message. <screen> <prompt>$ </prompt>nixos-rebuild build --show-trace … @@ -538,7 +634,9 @@ infinite recursion encountered </screen> </para> <para> - 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 + 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 <programlisting> { config, pkgs, ... }: @@ -566,7 +664,9 @@ with lib; </programlisting> </para> <para> - 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 <nixpkgs> {})</literal>. The following module + 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 <nixpkgs> {})</literal>. The following module <programlisting> { config, pkgs, ... }: @@ -606,25 +706,43 @@ in <itemizedlist> <listitem> <para> - 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. + 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. </para> </listitem> <listitem> <para> - Users running an SSH server who worry about the quality of their <literal>/etc/ssh/moduli</literal> file with respect to the <link - 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. + Users running an SSH server who worry about the quality of their + <literal>/etc/ssh/moduli</literal> file with respect to the + <link + 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. </para> </listitem> <listitem> <para> - 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" - >the source</link>. Beware of <link xlink:href="https://github.com/NixOS/nixpkgs/issues/9757" - >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. + 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" + >the + source</link>. Beware of + <link xlink:href="https://github.com/NixOS/nixpkgs/issues/9757" + >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. </para> </listitem> <listitem> <para> - <option>buildEnv.env</option> on all Python interpreters is now available for nix-shell interoperability. + <option>buildEnv.env</option> on all Python interpreters is now available + for nix-shell interoperability. </para> </listitem> </itemizedlist> diff --git a/nixos/doc/manual/release-notes/rl-1603.xml b/nixos/doc/manual/release-notes/rl-1603.xml index 94808b36076..9b512c4b1e5 100644 --- a/nixos/doc/manual/release-notes/rl-1603.xml +++ b/nixos/doc/manual/release-notes/rl-1603.xml @@ -6,14 +6,17 @@ <title>Release 16.03 (“Emu”, 2016/03/31)</title> <para> - In addition to numerous new and upgraded packages, this release has the following highlights: + In addition to numerous new and upgraded packages, this release has the + following highlights: </para> <itemizedlist> <listitem> <para> - Systemd 229, bringing <link - xlink:href="https://github.com/systemd/systemd/blob/v229/NEWS">numerous improvements</link> over 217. + Systemd 229, bringing + <link + xlink:href="https://github.com/systemd/systemd/blob/v229/NEWS">numerous + improvements</link> over 217. </para> </listitem> <listitem> @@ -23,8 +26,11 @@ </listitem> <listitem> <para> - GCC 5.3 (was 4.9). Note that GCC 5 <link - 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. + GCC 5.3 (was 4.9). Note that GCC 5 + <link + 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. </para> </listitem> <listitem> @@ -39,10 +45,20 @@ </listitem> <listitem> <para> - Improved support for ensuring <link - xlink:href="https://reproducible-builds.org/">bitwise reproducible builds</link>. For example, <literal>stdenv</literal> now sets the environment variable <envar - xlink:href="https://reproducible-builds.org/specs/source-date-epoch/">SOURCE_DATE_EPOCH</envar> to a deterministic value, and Nix has <link - 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). + Improved support for ensuring + <link + xlink:href="https://reproducible-builds.org/">bitwise + reproducible builds</link>. For example, <literal>stdenv</literal> now sets + the environment variable + <envar + xlink:href="https://reproducible-builds.org/specs/source-date-epoch/">SOURCE_DATE_EPOCH</envar> + to a deterministic value, and Nix has + <link + 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). </para> </listitem> <listitem> @@ -319,38 +335,56 @@ </para> <para> - When upgrading from a previous release, please be aware of the following incompatible changes: + When upgrading from a previous release, please be aware of the following + incompatible changes: </para> <itemizedlist> <listitem> <para> - We no longer produce graphical ISO images and VirtualBox images for <literal>i686-linux</literal>. A minimal ISO image is still provided. + We no longer produce graphical ISO images and VirtualBox images for + <literal>i686-linux</literal>. A minimal ISO image is still provided. </para> </listitem> <listitem> <para> - 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. + 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. </para> </listitem> <listitem> <para> - <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>. + <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>. </para> </listitem> <listitem> <para> - <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> + <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> </para> </listitem> <listitem> <para> - <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. + <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. </para> </listitem> <listitem> <para> - 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. + 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. <programlisting><![CDATA[ { imports = [ <nixpkgs/nixos/modules/services/misc/gitit.nix> ]; @@ -361,7 +395,10 @@ </listitem> <listitem> <para> - <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: + <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: <programlisting><![CDATA[ nginx.override { modules = [ nginxModules.rtmp nginxModules.dav nginxModules.moreheaders ]; @@ -371,42 +408,66 @@ nginx.override { </listitem> <listitem> <para> - <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. + <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. </para> </listitem> <listitem> <para> - <command>ruby_1_8</command> has been removed as it's not supported from upstream anymore and probably contains security issues. + <command>ruby_1_8</command> has been removed as it's not supported from + upstream anymore and probably contains security issues. </para> </listitem> <listitem> <para> - <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. + <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. </para> </listitem> <listitem> <para> - <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. + <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. </para> </listitem> <listitem> <para> - 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. + 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. </para> </listitem> <listitem> <para> - <literal>emacsPackagesNg</literal> now contains all packages from the ELPA, MELPA, and MELPA Stable repositories. + <literal>emacsPackagesNg</literal> now contains all packages from the ELPA, + MELPA, and MELPA Stable repositories. </para> </listitem> <listitem> <para> - 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. + 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. </para> </listitem> <listitem> <para> - 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: + 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: <programlisting> fileSystems."/example" = { device = "/dev/sdc"; @@ -418,20 +479,44 @@ fileSystems."/example" = { </listitem> <listitem> <para> - 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. + 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. </para> <para> - 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. + 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. </para> </listitem> <listitem> <para> - <literal>services.xserver.vaapiDrivers</literal> has been removed. Use <literal>hardware.opengl.extraPackages{,32}</literal> instead. You can also specify VDPAU drivers there. + <literal>services.xserver.vaapiDrivers</literal> has been removed. Use + <literal>hardware.opengl.extraPackages{,32}</literal> instead. You can also + specify VDPAU drivers there. </para> </listitem> <listitem> <para> - <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: + <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: <programlisting> i18n.inputMethod.enabled = "ibus"; i18n.inputMethod.ibus.engines = with pkgs.ibus-engines; [ anthy mozc ]; @@ -445,17 +530,26 @@ programs.ibus.plugins = with pkgs; [ ibus-anthy mozc ]; </listitem> <listitem> <para> - <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. + <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. </para> </listitem> <listitem> <para> - 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. + 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. </para> </listitem> <listitem> <para> - The option <option>services.nsd.zones.<name>.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: + The option <option>services.nsd.zones.<name>.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: </para> <programlisting> \$ORIGIN example.com. @@ -473,7 +567,9 @@ $TTL 1800 </listitem> <listitem> <para> - <literal>service.syncthing.dataDir</literal> options now has to point to exact folder where syncthing is writing to. Example configuration should look something like: + <literal>service.syncthing.dataDir</literal> options now has to point to + exact folder where syncthing is writing to. Example configuration should + look something like: </para> <programlisting> services.syncthing = { @@ -485,24 +581,45 @@ services.syncthing = { </listitem> <listitem> <para> - <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>. + <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>. </para> </listitem> <listitem> <para> - Systems with some broadcom cards used to result into a generated config that is no longer accepted. If you get errors like + Systems with some broadcom cards used to result into a generated config + that is no longer accepted. If you get errors like <screen>error: path ‘/nix/store/*-broadcom-sta-*’ does not exist and cannot be created</screen> - 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>. + 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>. </para> </listitem> <listitem> <para> - 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: + 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: <programlisting> GPG_TTY=$(tty) export GPG_TTY </programlisting> - If you want to use gpg-agent for SSH, too, add the following to your session initialization (e.g. <literal>displayManager.sessionCommands</literal>) + If you want to use gpg-agent for SSH, too, add the following to your + session initialization (e.g. + <literal>displayManager.sessionCommands</literal>) <programlisting> gpg-connect-agent /bye unset SSH_AGENT_PID @@ -512,11 +629,15 @@ export SSH_AUTH_SOCK="''${HOME}/.gnupg/S.gpg-agent.ssh" <programlisting> enable-ssh-support </programlisting> - 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: + 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: <programlisting> gpg --import ~/.gnupg/secring.gpg </programlisting> - The <command>gpg-agent(1)</command> man page has more details about this subject, i.e. in the "EXAMPLES" section. + The <command>gpg-agent(1)</command> man page has more details about this + subject, i.e. in the "EXAMPLES" section. </para> </listitem> </itemizedlist> @@ -540,7 +661,9 @@ gpg --import ~/.gnupg/secring.gpg </listitem> <listitem> <para> - 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. + 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. </para> </listitem> </itemizedlist> diff --git a/nixos/doc/manual/release-notes/rl-1609.xml b/nixos/doc/manual/release-notes/rl-1609.xml index 95e8fe3abcb..4a2343edc97 100644 --- a/nixos/doc/manual/release-notes/rl-1609.xml +++ b/nixos/doc/manual/release-notes/rl-1609.xml @@ -6,36 +6,48 @@ <title>Release 16.09 (“Flounder”, 2016/09/30)</title> <para> - In addition to numerous new and upgraded packages, this release has the following highlights: + In addition to numerous new and upgraded packages, this release has the + following highlights: </para> <itemizedlist> <listitem> <para> - Many NixOS configurations and Nix packages now use significantly less disk space, thanks to the <link - 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. + Many NixOS configurations and Nix packages now use significantly less disk + space, thanks to the + <link + 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. </para> </listitem> <listitem> <para> - To improve security, packages are now <link - xlink:href="https://github.com/NixOS/nixpkgs/pull/12895">built using various hardening features</link>. See the Nixpkgs manual for more information. + To improve security, packages are now + <link + xlink:href="https://github.com/NixOS/nixpkgs/pull/12895">built + using various hardening features</link>. See the Nixpkgs manual for more + information. </para> </listitem> <listitem> <para> Support for PXE netboot. See <xref - linkend="sec-booting-from-pxe" /> for documentation. + linkend="sec-booting-from-pxe" /> + for documentation. </para> </listitem> <listitem> <para> - X.org server 1.18. If you use the <literal>ati_unfree</literal> driver, 1.17 is still used due to an ABI incompatibility. + X.org server 1.18. If you use the <literal>ati_unfree</literal> driver, + 1.17 is still used due to an ABI incompatibility. </para> </listitem> <listitem> <para> - This release is based on Glibc 2.24, GCC 5.4.0 and systemd 231. The default Linux kernel remains 4.4. + This release is based on Glibc 2.24, GCC 5.4.0 and systemd 231. The default + Linux kernel remains 4.4. </para> </listitem> </itemizedlist> @@ -53,71 +65,122 @@ </itemizedlist> <para> - When upgrading from a previous release, please be aware of the following incompatible changes: + When upgrading from a previous release, please be aware of the following + incompatible changes: </para> <itemizedlist> <listitem> <para> - 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.) + 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.) </para> </listitem> <listitem> <para> - 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 - 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 - 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 - xlink:href="https://nixos.org/nix-dev/2016-June/020642.html">another nix-dev article</link>. + 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 + 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 + 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 + xlink:href="https://nixos.org/nix-dev/2016-June/020642.html">another + nix-dev article</link>. </para> </listitem> <listitem> <para> - 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>. + 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>. </para> </listitem> <listitem> <para> - 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 + 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 </para> </listitem> <listitem> <para> - <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. + <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. </para> </listitem> <listitem> <para> - 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. + 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. </para> </listitem> <listitem> <para> - <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>. + <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>. </para> </listitem> <listitem> <para> - <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>. + <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>. </para> </listitem> <listitem> <para> - The <literal>audit</literal> service is no longer enabled by default. Use <literal>security.audit.enable = true</literal> to explicitly enable it. + The <literal>audit</literal> service is no longer enabled by default. Use + <literal>security.audit.enable = true</literal> to explicitly enable it. </para> </listitem> <listitem> <para> - <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. + <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. </para> </listitem> <listitem> <para> - <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. + <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. </para> </listitem> <listitem> <para> - <literal>services.mongodb.extraConfig</literal> configuration format was changed to YAML. + <literal>services.mongodb.extraConfig</literal> configuration format was + changed to YAML. </para> </listitem> <listitem> @@ -134,42 +197,70 @@ <itemizedlist> <listitem> <para> - 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 + 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 <programlisting>security.grsecurity.enable = true</programlisting> - to get a reasonably secure system without having to sacrifice too much functionality. + to get a reasonably secure system without having to sacrifice too much + functionality. </para> </listitem> <listitem> <para> - 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. + 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. </para> </listitem> <listitem> <para> - 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. + 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. </para> </listitem> <listitem> <para> - Containers configuration within <literal>containers.<name>.config</literal> is <link - xlink:href="https://github.com/NixOS/nixpkgs/pull/17365">now properly typed and checked</link>. In particular, partial configurations are merged correctly. + Containers configuration within + <literal>containers.<name>.config</literal> is + <link + xlink:href="https://github.com/NixOS/nixpkgs/pull/17365">now + properly typed and checked</link>. In particular, partial configurations + are merged correctly. </para> </listitem> <listitem> <para> - The directory container setuid wrapper programs, <filename>/var/setuid-wrappers</filename>, <link - 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> + The directory container setuid wrapper programs, + <filename>/var/setuid-wrappers</filename>, + <link + 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> </para> </listitem> <listitem> <para> - <literal>services.xserver.startGnuPGAgent</literal> has been removed due to GnuPG 2.1.x bump. See <link - 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. + <literal>services.xserver.startGnuPGAgent</literal> has been removed due to + GnuPG 2.1.x bump. See + <link + 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. </para> </listitem> <listitem> <para> - <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> + <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> </para> </listitem> <listitem> diff --git a/nixos/doc/manual/release-notes/rl-1703.xml b/nixos/doc/manual/release-notes/rl-1703.xml index 49c364a103a..14b31b232e9 100644 --- a/nixos/doc/manual/release-notes/rl-1703.xml +++ b/nixos/doc/manual/release-notes/rl-1703.xml @@ -13,24 +13,29 @@ <title>Highlights</title> <para> - In addition to numerous new and upgraded packages, this release has the following highlights: + In addition to numerous new and upgraded packages, this release has the + following highlights: </para> <itemizedlist> <listitem> <para> - Nixpkgs is now extensible through overlays. See the <link - xlink:href="https://nixos.org/nixpkgs/manual/#sec-overlays-install">Nixpkgs manual</link> for more information. + Nixpkgs is now extensible through overlays. See the + <link + xlink:href="https://nixos.org/nixpkgs/manual/#sec-overlays-install">Nixpkgs + manual</link> for more information. </para> </listitem> <listitem> <para> - 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. + 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. </para> </listitem> <listitem> <para> - The default desktop environment now is KDE's Plasma 5. KDE 4 has been removed + The default desktop environment now is KDE's Plasma 5. KDE 4 has been + removed </para> </listitem> <listitem> @@ -40,24 +45,35 @@ </listitem> <listitem> <para> - 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. + 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. </para> </listitem> <listitem> <para> - 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. + 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. </para> </listitem> <listitem> <para> - The <literal>overridePackages</literal> function has been rewritten to be replaced by <link - xlink:href="https://nixos.org/nixpkgs/manual/#sec-overlays-install"> overlays</link> + The <literal>overridePackages</literal> function has been rewritten to be + replaced by + <link + xlink:href="https://nixos.org/nixpkgs/manual/#sec-overlays-install"> + overlays</link> </para> </listitem> <listitem> <para> - Packages in nixpkgs can be marked as insecure through listed vulnerabilities. See the <link - xlink:href="https://nixos.org/nixpkgs/manual/#sec-allow-insecure">Nixpkgs manual</link> for more information. + Packages in nixpkgs can be marked as insecure through listed + vulnerabilities. See the + <link + xlink:href="https://nixos.org/nixpkgs/manual/#sec-allow-insecure">Nixpkgs + manual</link> for more information. </para> </listitem> <listitem> @@ -496,64 +512,92 @@ <title>Backward Incompatibilities</title> <para> - When upgrading from a previous release, please be aware of the following incompatible changes: + When upgrading from a previous release, please be aware of the following + incompatible changes: </para> <itemizedlist> <listitem> <para> - Derivations have no <literal>.nativeDrv</literal> nor <literal>.crossDrv</literal> and are now cross by default, not native. + Derivations have no <literal>.nativeDrv</literal> nor + <literal>.crossDrv</literal> and are now cross by default, not native. </para> </listitem> <listitem> <para> - <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. + <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. </para> </listitem> <listitem> <para> - <literal>ansible</literal> now defaults to ansible version 2 as version 1 has been removed due to a serious <link - xlink:href="https://www.computest.nl/advisories/CT-2017-0109_Ansible.txt"> vulnerability</link> unpatched by upstream. + <literal>ansible</literal> now defaults to ansible version 2 as version 1 + has been removed due to a serious + <link + xlink:href="https://www.computest.nl/advisories/CT-2017-0109_Ansible.txt"> + vulnerability</link> unpatched by upstream. </para> </listitem> <listitem> <para> - <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>. + <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>. </para> </listitem> <listitem> <para> - The attribute name of the Radicale daemon has been changed from <literal>pythonPackages.radicale</literal> to <literal>radicale</literal>. + The attribute name of the Radicale daemon has been changed from + <literal>pythonPackages.radicale</literal> to <literal>radicale</literal>. </para> </listitem> <listitem> <para> - 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>. + 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>. </para> </listitem> <listitem> <para> - 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. + 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. </para> </listitem> <listitem> <para> - 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> + 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> </para> </listitem> <listitem> <para> - 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. + 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. </para> </listitem> <listitem> <para> - <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>. + <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>. </para> </listitem> <listitem> <para> - <literal>service.nylon</literal> is now declared using named instances. As an example: + <literal>service.nylon</literal> is now declared using named instances. As + an example: <programlisting> services.nylon = { enable = true; @@ -576,8 +620,11 @@ </listitem> <listitem> <para> - <literal>overridePackages</literal> function no longer exists. It is replaced by <link - xlink:href="https://nixos.org/nixpkgs/manual/#sec-overlays-install"> overlays</link>. For example, the following code: + <literal>overridePackages</literal> function no longer exists. It is + replaced by + <link + xlink:href="https://nixos.org/nixpkgs/manual/#sec-overlays-install"> + overlays</link>. For example, the following code: <programlisting> let pkgs = import <nixpkgs> {}; @@ -595,42 +642,72 @@ in </listitem> <listitem> <para> - 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. + 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. </para> </listitem> <listitem> <para> - <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>. + <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>. </para> </listitem> <listitem> <para> - 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>). + 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>). </para> </listitem> <listitem> <para> - 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. + 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. </para> </listitem> <listitem> <para> - The <literal>fetch*</literal> functions no longer support md5, please use sha256 instead. + The <literal>fetch*</literal> functions no longer support md5, please use + sha256 instead. </para> </listitem> <listitem> <para> - 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. + 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. </para> </listitem> <listitem> <para> - 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. + 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. </para> </listitem> <listitem> <para> - The ihaskell, monetdb, offlineimap and sitecopy services have been removed. + The ihaskell, monetdb, offlineimap and sitecopy services have been + removed. </para> </listitem> </itemizedlist> @@ -646,12 +723,18 @@ in <itemizedlist> <listitem> <para> - 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. + 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. </para> </listitem> <listitem> <para> - <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>. + <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>. </para> </listitem> <listitem> @@ -661,37 +744,53 @@ in </listitem> <listitem> <para> - 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. + 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. </para> </listitem> <listitem> <para> - 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. + 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. </para> </listitem> <listitem> <para> - The Python package sets now use a fixed-point combinator and the sets are available as attributes of the interpreters. + The Python package sets now use a fixed-point combinator and the sets are + available as attributes of the interpreters. </para> </listitem> <listitem> <para> - The Python function <literal>buildPythonPackage</literal> has been improved and can be used to build from Setuptools source, Flit source, and precompiled Wheels. + The Python function <literal>buildPythonPackage</literal> has been + improved and can be used to build from Setuptools source, Flit source, and + precompiled Wheels. </para> </listitem> <listitem> <para> - 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>. + 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>. </para> </listitem> <listitem> <para> - 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. + 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. </para> </listitem> <listitem> <para> - Containers using bridged networking no longer lose their connection after changes to the host networking. + Containers using bridged networking no longer lose their connection after + changes to the host networking. </para> </listitem> <listitem> @@ -701,12 +800,16 @@ in </listitem> <listitem> <para> - 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. + 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. </para> </listitem> <listitem> <para> - 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. + 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. </para> </listitem> </itemizedlist> diff --git a/nixos/doc/manual/release-notes/rl-1709.xml b/nixos/doc/manual/release-notes/rl-1709.xml index ff70bb663a0..795c51d2923 100644 --- a/nixos/doc/manual/release-notes/rl-1709.xml +++ b/nixos/doc/manual/release-notes/rl-1709.xml @@ -13,23 +13,30 @@ <title>Highlights</title> <para> - In addition to numerous new and upgraded packages, this release has the following highlights: + In addition to numerous new and upgraded packages, this release has the + following highlights: </para> <itemizedlist> <listitem> <para> - 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. + 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. </para> </listitem> <listitem> <para> - 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. + 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. </para> </listitem> <listitem> <para> - 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: + 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: <programlisting> { services.xserver.xrandrHeads = [ "HDMI-0" @@ -43,21 +50,36 @@ ]; } </programlisting> - 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. + 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. </para> </listitem> <listitem> <para> - 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. + 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. </para> <para> - 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. + 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. </para> <para> - Options to configure <literal>resolver</literal> options and <literal>upstream</literal> blocks have been introduced. See their information for further details. + Options to configure <literal>resolver</literal> options and + <literal>upstream</literal> blocks have been introduced. See their + information for further details. </para> <para> - 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. + 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. </para> </listitem> </itemizedlist> @@ -446,31 +468,47 @@ <title>Backward Incompatibilities</title> <para> - When upgrading from a previous release, please be aware of the following incompatible changes: + When upgrading from a previous release, please be aware of the following + incompatible changes: </para> <itemizedlist> <listitem> <para> - <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> + <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> </para> <para> - 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. + 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. </para> <para> - 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. + 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. </para> <para> Before rebooting affected machines, please ensure: <itemizedlist> <listitem> <para> - 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. + 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. </para> </listitem> <listitem> <para> - 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>. + 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>. </para> </listitem> </itemizedlist> @@ -478,59 +516,88 @@ </listitem> <listitem> <para> - 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. + 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. </para> <itemizedlist> <listitem> <para> - The <literal>postgres</literal> default version was changed from 9.5 to 9.6. + The <literal>postgres</literal> default version was changed from 9.5 to + 9.6. </para> </listitem> <listitem> <para> - 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. + 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. </para> </listitem> <listitem> <para> - 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. + 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. </para> </listitem> <listitem> <para> - The <literal>mysql</literal> default <literal>dataDir</literal> has changed from <literal>/var/mysql</literal> to <literal>/var/lib/mysql</literal>. + The <literal>mysql</literal> default <literal>dataDir</literal> has + changed from <literal>/var/mysql</literal> to + <literal>/var/lib/mysql</literal>. </para> </listitem> <listitem> <para> - 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. + 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. </para> </listitem> </itemizedlist> </listitem> <listitem> <para> - 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. + 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. </para> </listitem> <listitem> <para> - 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. + 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. </para> </listitem> <listitem> <para> - Top-level <literal>idea</literal> package collection was renamed. All JetBrains IDEs are now at <literal>jetbrains</literal>. + Top-level <literal>idea</literal> package collection was renamed. All + JetBrains IDEs are now at <literal>jetbrains</literal>. </para> </listitem> <listitem> <para> - <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. + <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. </para> </listitem> <listitem> <para> - 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 + 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 <programlisting> dataDir=<valueOfDataDir> mv /var/lib/ipfs/.ipfs/* $dataDir @@ -540,66 +607,107 @@ rmdir /var/lib/ipfs/.ipfs </listitem> <listitem> <para> - 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>. + 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>. </para> </listitem> <listitem> <para> - 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. + 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. </para> </listitem> <listitem> <para> - The <literal>services.tinc.networks.<name>.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.<name>.bindToAddress</literal> instead. Refer to the description of the options for more details. + The <literal>services.tinc.networks.<name>.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.<name>.bindToAddress</literal> + instead. Refer to the description of the options for more details. </para> </listitem> <listitem> <para> - <literal>tlsdate</literal> package and module were removed. This is due to the project being dead and not building with openssl 1.1. + <literal>tlsdate</literal> package and module were removed. This is due to + the project being dead and not building with openssl 1.1. </para> </listitem> <listitem> <para> - <literal>wvdial</literal> package and module were removed. This is due to the project being dead and not building with openssl 1.1. + <literal>wvdial</literal> package and module were removed. This is due to + the project being dead and not building with openssl 1.1. </para> </listitem> <listitem> <para> - <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. + <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. </para> </listitem> <listitem> <para> - <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. + <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. </para> </listitem> <listitem> <para> - The <literal>compiz</literal> window manager and package was removed. The system support had been broken for several years. + The <literal>compiz</literal> window manager and package was removed. The + system support had been broken for several years. </para> </listitem> <listitem> <para> - 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>. + 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>. </para> </listitem> <listitem> <para> - 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. + 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. </para> </listitem> <listitem> <para> - <literal>services.mysql</literal> now has declarative configuration of databases and users with the <literal>ensureDatabases</literal> and <literal>ensureUsers</literal> options. + <literal>services.mysql</literal> now has declarative configuration of + databases and users with the <literal>ensureDatabases</literal> and + <literal>ensureUsers</literal> options. </para> <para> - These options will never delete existing databases and users, especially not when the value of the options are changed. + These options will never delete existing databases and users, especially + not when the value of the options are changed. </para> <para> - 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. + 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. </para> <para> - 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: + 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: <programlisting language="sql"> CREATE USER 'root'@'%' IDENTIFIED BY ''; GRANT ALL PRIVILEGES ON *.* TO 'root'@'%' WITH GRANT OPTION; @@ -612,38 +720,55 @@ FLUSH PRIVILEGES; </listitem> <listitem> <para> - <literal>services.mysqlBackup</literal> now works by default without any user setup, including for users other than <literal>mysql</literal>. + <literal>services.mysqlBackup</literal> now works by default without any + user setup, including for users other than <literal>mysql</literal>. </para> <para> - 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. + 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. </para> <para> - The <literal>mysqlBackup</literal> service is also now using systemd timers instead of <literal>cron</literal>. + The <literal>mysqlBackup</literal> service is also now using systemd + timers instead of <literal>cron</literal>. </para> <para> - 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 + 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 xlink:href="https://www.freedesktop.org/software/systemd/man/systemd.time.html#Calendar%20Events">systemd.time(7)</link>. </para> <para> - 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. + 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. </para> <para> - You can check that backups still work by running <command>systemctl start mysql-backup</command> then <command>systemctl status mysql-backup</command>. + You can check that backups still work by running <command>systemctl start + mysql-backup</command> then <command>systemctl status + mysql-backup</command>. </para> </listitem> <listitem> <para> - Templated systemd services e.g <literal>container@name</literal> are now handled currectly when switching to a new configuration, resulting in them being reloaded. + Templated systemd services e.g <literal>container@name</literal> are now + handled currectly when switching to a new configuration, resulting in them + being reloaded. </para> </listitem> <listitem> <para> - Steam: the <literal>newStdcpp</literal> parameter was removed and should not be needed anymore. + Steam: the <literal>newStdcpp</literal> parameter was removed and should + not be needed anymore. </para> </listitem> <listitem> <para> - 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. + 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. </para> </listitem> </itemizedlist> @@ -659,28 +784,46 @@ FLUSH PRIVILEGES; <itemizedlist> <listitem> <para> - Modules can now be disabled by using <link - 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. + Modules can now be disabled by using + <link + 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. </para> </listitem> <listitem> <para> - 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. + 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. </para> </listitem> <listitem> <para> - ZFS/SPL have been updated to 0.7.0, <literal>zfsUnstable, splUnstable</literal> have therefore been removed. + ZFS/SPL have been updated to 0.7.0, <literal>zfsUnstable, + splUnstable</literal> have therefore been removed. </para> </listitem> <listitem> <para> - 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. + 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. </para> </listitem> <listitem> <para> - Nixpkgs overlays may now be specified with a file as well as a directory. The value of <literal><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. + Nixpkgs overlays may now be specified with a file as well as a directory. + The value of <literal><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. </para> <para> See the overlays chapter of the Nixpkgs manual for more details. @@ -688,48 +831,67 @@ FLUSH PRIVILEGES; </listitem> <listitem> <para> - Definitions for <filename>/etc/hosts</filename> can now be specified declaratively with <literal>networking.hosts</literal>. + Definitions for <filename>/etc/hosts</filename> can now be specified + declaratively with <literal>networking.hosts</literal>. </para> </listitem> <listitem> <para> - 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. + 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. </para> <para> - 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. + 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. </para> <para> - 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. + 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. </para> </listitem> <listitem> <para> - <literal>services.gitlab-runner.configOptions</literal> has been added to specify the configuration of gitlab-runners declaratively. + <literal>services.gitlab-runner.configOptions</literal> has been added to + specify the configuration of gitlab-runners declaratively. </para> </listitem> <listitem> <para> - <literal>services.jenkins.plugins</literal> has been added to install plugins easily, this can be generated with jenkinsPlugins2nix. + <literal>services.jenkins.plugins</literal> has been added to install + plugins easily, this can be generated with jenkinsPlugins2nix. </para> </listitem> <listitem> <para> - <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. + <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. </para> </listitem> <listitem> <para> - The GitLab package and module have been updated to the latest 10.0 release. + The GitLab package and module have been updated to the latest 10.0 + release. </para> </listitem> <listitem> <para> - The <literal>systemd-boot</literal> boot loader now lists the NixOS version, kernel version and build date of all bootable generations. + The <literal>systemd-boot</literal> boot loader now lists the NixOS + version, kernel version and build date of all bootable generations. </para> </listitem> <listitem> <para> - 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>. + 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>. </para> </listitem> </itemizedlist> diff --git a/nixos/doc/manual/release-notes/rl-1803.xml b/nixos/doc/manual/release-notes/rl-1803.xml index 2e39b990d9e..c14679eea07 100644 --- a/nixos/doc/manual/release-notes/rl-1803.xml +++ b/nixos/doc/manual/release-notes/rl-1803.xml @@ -13,7 +13,8 @@ <title>Highlights</title> <para> - In addition to numerous new and upgraded packages, this release has the following highlights: + In addition to numerous new and upgraded packages, this release has the + following highlights: </para> <itemizedlist> @@ -24,36 +25,48 @@ </listitem> <listitem> <para> - 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. + 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. </para> </listitem> <listitem> <para> - Nix now defaults to 2.0; see its <link xlink:href="https://nixos.org/nix/manual/#ssec-relnotes-2.0">release notes</link>. + Nix now defaults to 2.0; see its + <link xlink:href="https://nixos.org/nix/manual/#ssec-relnotes-2.0">release + notes</link>. </para> </listitem> <listitem> <para> - Core version changes: linux: 4.9 -> 4.14, glibc: 2.25 -> 2.26, gcc: 6 -> 7, systemd: 234 -> 237. + Core version changes: linux: 4.9 -> 4.14, glibc: 2.25 -> 2.26, gcc: 6 -> + 7, systemd: 234 -> 237. </para> </listitem> <listitem> <para> - Desktop version changes: gnome: 3.24 -> 3.26, (KDE) plasma-desktop: 5.10 -> 5.12. + Desktop version changes: gnome: 3.24 -> 3.26, (KDE) plasma-desktop: 5.10 + -> 5.12. </para> </listitem> <listitem> <para> - 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: + 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: <itemizedlist> <listitem> <para> - <literal>libmysql</literal> has been deprecated, please use <literal>mysql.connector-c</literal> instead, a compatibility passthru has been added to the MySQL packages. + <literal>libmysql</literal> has been deprecated, please use + <literal>mysql.connector-c</literal> instead, a compatibility passthru + has been added to the MySQL packages. </para> </listitem> <listitem> <para> - The <literal>mysql57</literal> package has a new <literal>static</literal> output containing the static libraries including <literal>libmysqld.a</literal> + The <literal>mysql57</literal> package has a new + <literal>static</literal> output containing the static libraries + including <literal>libmysqld.a</literal> </para> </listitem> </itemizedlist> @@ -390,7 +403,8 @@ <title>Backward Incompatibilities</title> <para> - When upgrading from a previous release, please be aware of the following incompatible changes: + When upgrading from a previous release, please be aware of the following + incompatible changes: </para> <itemizedlist> @@ -401,26 +415,39 @@ </listitem> <listitem> <para> - 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. + 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. </para> </listitem> <listitem> <para> - 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>. + 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>. </para> </listitem> <listitem> <para> - 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: + 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: <itemizedlist> <listitem> <para> - <literal>2048-in-terminal</literal> → <literal>_2048-in-terminal</literal> + <literal>2048-in-terminal</literal> → + <literal>_2048-in-terminal</literal> </para> </listitem> <listitem> <para> - <literal>90secondportraits</literal> → <literal>_90secondportraits</literal> + <literal>90secondportraits</literal> → + <literal>_90secondportraits</literal> </para> </listitem> <listitem> @@ -438,77 +465,134 @@ </listitem> <listitem> <para> - <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> + <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> </para> <para> - 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>. + 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>. </para> <para> - 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>. + 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>. </para> </listitem> <listitem> <para> - 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. + 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. </para> </listitem> <listitem> <para> - <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. + <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. </para> </listitem> <listitem> <para> - 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. + 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. <!-- That's <xref linkend="ssec-stdenv-attributes"> were we to merge the manuals. --> - 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. + 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. </para> </listitem> <listitem> <para> - <literal>lib.addPassthru drv passthru</literal> is removed. Use <literal>lib.extendDerivation true passthru drv</literal> instead. + <literal>lib.addPassthru drv passthru</literal> is removed. Use + <literal>lib.extendDerivation true passthru drv</literal> instead. </para> </listitem> <listitem> <para> - 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>. + 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>. </para> </listitem> <listitem> <para> - 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. + 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. </para> </listitem> <listitem> <para> - 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. + 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. </para> </listitem> <listitem> <para> - 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. + 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. </para> <itemizedlist> <listitem> <para> - <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>. + <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>. </para> </listitem> </itemizedlist> </listitem> <listitem> <para> - The <literal>jid</literal> package has been removed, due to maintenance overhead of a go package having non-versioned dependencies. + The <literal>jid</literal> package has been removed, due to maintenance + overhead of a go package having non-versioned dependencies. </para> </listitem> <listitem> <para> - 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. + 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. </para> </listitem> <listitem> <para> - 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>. + 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>. </para> </listitem> <listitem> @@ -517,32 +601,52 @@ <itemizedlist> <listitem> <para> - The package <literal>pkgs.piwik</literal> was renamed to <literal>pkgs.matomo</literal>. + The package <literal>pkgs.piwik</literal> was renamed to + <literal>pkgs.matomo</literal>. </para> </listitem> <listitem> <para> - The service <literal>services.piwik</literal> was renamed to <literal>services.matomo</literal>. + The service <literal>services.piwik</literal> was renamed to + <literal>services.matomo</literal>. </para> </listitem> <listitem> <para> - 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. + 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. </para> </listitem> <listitem> <para> - 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. + 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. </para> </listitem> <listitem> <para> - 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>. + 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>. </para> </listitem> <listitem> <para> - 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. + 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. </para> </listitem> </itemizedlist> @@ -550,43 +654,59 @@ </listitem> <listitem> <para> - <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. + <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. </para> </listitem> <listitem> <para> - 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>. + 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>. </para> </listitem> <listitem> <para> - The Prosody XMPP server has received a major update. The following modules were renamed: + The Prosody XMPP server has received a major update. The following modules + were renamed: <itemizedlist> <listitem> <para> - <option>services.prosody.modules.httpserver</option> is now <option>services.prosody.modules.http_files</option> + <option>services.prosody.modules.httpserver</option> is now + <option>services.prosody.modules.http_files</option> </para> </listitem> <listitem> <para> - <option>services.prosody.modules.console</option> is now <option>services.prosody.modules.admin_telnet</option> + <option>services.prosody.modules.console</option> is now + <option>services.prosody.modules.admin_telnet</option> </para> </listitem> </itemizedlist> </para> <para> - Many new modules are now core modules, most notably <option>services.prosody.modules.carbons</option> and <option>services.prosody.modules.mam</option>. + Many new modules are now core modules, most notably + <option>services.prosody.modules.carbons</option> and + <option>services.prosody.modules.mam</option>. </para> <para> - The better-performing <literal>libevent</literal> backend is now enabled by default. + The better-performing <literal>libevent</literal> backend is now enabled + by default. </para> <para> - <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>. + <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>. </para> </listitem> <listitem> <para> - All prometheus exporter modules are now defined as submodules. The exporters are configured using <literal>services.prometheus.exporters</literal>. + All prometheus exporter modules are now defined as submodules. The + exporters are configured using + <literal>services.prometheus.exporters</literal>. </para> </listitem> </itemizedlist> @@ -602,17 +722,24 @@ <itemizedlist> <listitem> <para> - 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. + 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. </para> </listitem> <listitem> <para> - The option <option>networking.wireless.networks.<name>.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. + The option <option>networking.wireless.networks.<name>.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. </para> </listitem> <listitem> <para> - In the module <option>networking.interfaces.<name></option> the following options have been removed: + In the module <option>networking.interfaces.<name></option> the + following options have been removed: <itemizedlist> <listitem> <para> @@ -640,22 +767,34 @@ </para> </listitem> </itemizedlist> - 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. + 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. </para> </listitem> <listitem> <para> - 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. + 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. </para> </listitem> <listitem> <para> - <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. + <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. </para> </listitem> <listitem> <para> - <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. + <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. </para> <para> If set to null the default clock format is used. @@ -663,10 +802,17 @@ </listitem> <listitem> <para> - <literal>displayManager.lightdm.greeters.gtk.indicators</literal> has been added, a list of allowed indicator modules to use with the lightdm gtk greeter panel. + <literal>displayManager.lightdm.greeters.gtk.indicators</literal> has been + added, a list of allowed indicator modules to use with the lightdm gtk + greeter panel. </para> <para> - 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. + 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. </para> <para> If set to <literal>null</literal> the default indicators are used. @@ -688,12 +834,20 @@ </listitem> <listitem> <para> - 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. + 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. </para> </listitem> <listitem> <para> - 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. + 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. </para> </listitem> </itemizedlist> diff --git a/nixos/doc/manual/release-notes/rl-1809.xml b/nixos/doc/manual/release-notes/rl-1809.xml index df53c6f9dd9..3f10b26223d 100644 --- a/nixos/doc/manual/release-notes/rl-1809.xml +++ b/nixos/doc/manual/release-notes/rl-1809.xml @@ -13,7 +13,8 @@ <title>Highlights</title> <para> - In addition to numerous new and upgraded packages, this release has the following notable updates: + In addition to numerous new and upgraded packages, this release has the + following notable updates: </para> <itemizedlist> @@ -24,22 +25,28 @@ </listitem> <listitem> <para> - 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. + 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. </para> </listitem> <listitem> <para> - Nix has been updated to 2.1; see its <link xlink:href="https://nixos.org/nix/manual/#ssec-relnotes-2.1">release notes</link>. + Nix has been updated to 2.1; see its + <link xlink:href="https://nixos.org/nix/manual/#ssec-relnotes-2.1">release + notes</link>. </para> </listitem> <listitem> <para> - Core versions: linux: 4.14 LTS (unchanged), glibc: 2.26 → 2.27, gcc: 7 (unchanged), systemd: 237 → 239. + Core versions: linux: 4.14 LTS (unchanged), glibc: 2.26 → 2.27, gcc: 7 + (unchanged), systemd: 237 → 239. </para> </listitem> <listitem> <para> - Desktop version changes: gnome: 3.26 → 3.28, (KDE) plasma-desktop: 5.12 → 5.13. + Desktop version changes: gnome: 3.26 → 3.28, (KDE) plasma-desktop: 5.12 + → 5.13. </para> </listitem> </itemizedlist> @@ -51,7 +58,8 @@ <itemizedlist> <listitem> <para> - Support for wrapping binaries using <literal>firejail</literal> has been added through <varname>programs.firejail.wrappedBinaries</varname>. + Support for wrapping binaries using <literal>firejail</literal> has been + added through <varname>programs.firejail.wrappedBinaries</varname>. </para> <para> For example @@ -66,12 +74,17 @@ programs.firejail = { }; </programlisting> <para> - This will place <literal>firefox</literal> and <literal>mpv</literal> binaries in the global path wrapped by firejail. + This will place <literal>firefox</literal> and <literal>mpv</literal> + binaries in the global path wrapped by firejail. </para> </listitem> <listitem> <para> - 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 <mychannel></code>. + 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 + <mychannel></code>. </para> <para> For example @@ -101,31 +114,52 @@ $ nix-instantiate -E '(import <nixpkgsunstable> {}).gitFull' <itemizedlist> <listitem> <para> - 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 - xlink:href="https://cassandra.apache.org/">Apache Cassandra</link>. + 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 + xlink:href="https://cassandra.apache.org/">Apache + Cassandra</link>. </para> </listitem> <listitem> <para> - There is a new <varname>services.foundationdb</varname> module for deploying <link xlink:href="https://www.foundationdb.org">FoundationDB</link> clusters. + There is a new <varname>services.foundationdb</varname> module for + deploying + <link xlink:href="https://www.foundationdb.org">FoundationDB</link> + clusters. </para> </listitem> <listitem> <para> - 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. + 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. </para> </listitem> <listitem> <para> - <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. + <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. </para> <para> - <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>. + <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>. </para> </listitem> <listitem> <para> - The new <varname>services.elasticsearch-curator</varname> service periodically curates or manages, your Elasticsearch indices and snapshots. + The new <varname>services.elasticsearch-curator</varname> service + periodically curates or manages, your Elasticsearch indices and snapshots. </para> </listitem> </itemizedlist> @@ -436,32 +470,38 @@ $ nix-instantiate -E '(import <nixpkgsunstable> {}).gitFull' <title>Backward Incompatibilities</title> <para> - When upgrading from a previous release, please be aware of the following incompatible changes: + When upgrading from a previous release, please be aware of the following + incompatible changes: </para> <itemizedlist> <listitem> <para> - Some licenses that were incorrectly not marked as unfree now are. This is the case for: + Some licenses that were incorrectly not marked as unfree now are. This is + the case for: <itemizedlist> <listitem> <para> - cc-by-nc-sa-20: Creative Commons Attribution Non Commercial Share Alike 2.0 + cc-by-nc-sa-20: Creative Commons Attribution Non Commercial Share Alike + 2.0 </para> </listitem> <listitem> <para> - cc-by-nc-sa-25: Creative Commons Attribution Non Commercial Share Alike 2.5 + cc-by-nc-sa-25: Creative Commons Attribution Non Commercial Share Alike + 2.5 </para> </listitem> <listitem> <para> - cc-by-nc-sa-30: Creative Commons Attribution Non Commercial Share Alike 3.0 + cc-by-nc-sa-30: Creative Commons Attribution Non Commercial Share Alike + 3.0 </para> </listitem> <listitem> <para> - cc-by-nc-sa-40: Creative Commons Attribution Non Commercial Share Alike 4.0 + cc-by-nc-sa-40: Creative Commons Attribution Non Commercial Share Alike + 4.0 </para> </listitem> <listitem> @@ -479,71 +519,128 @@ $ nix-instantiate -E '(import <nixpkgsunstable> {}).gitFull' </listitem> <listitem> <para> - The deprecated <varname>services.cassandra</varname> module has seen a complete rewrite. (See above.) + The deprecated <varname>services.cassandra</varname> module has seen a + complete rewrite. (See above.) </para> </listitem> <listitem> <para> - <literal>lib.strict</literal> is removed. Use <literal>builtins.seq</literal> instead. + <literal>lib.strict</literal> is removed. Use + <literal>builtins.seq</literal> instead. </para> </listitem> <listitem> <para> - 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. + 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. </para> </listitem> <listitem> <para> - 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. + 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. </para> </listitem> <listitem> <para> - 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>. + 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>. </para> </listitem> <listitem> <para> - <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>. + <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>. </para> </listitem> <listitem> <para> - <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. + <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. </para> </listitem> <listitem> <para> - <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. + <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. </para> </listitem> <listitem> <para> - 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>. + 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>. </para> <para> - 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> + 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> </para> <para> - 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. + 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. </para> <para> - 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>. + 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>. </para> </listitem> <listitem> <para> - 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. + 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. </para> </listitem> <listitem> <para> - <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. + <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. </para> </listitem> <listitem> <para> - Groups <literal>kvm</literal> and <literal>render</literal> are introduced now, as systemd requires them. + Groups <literal>kvm</literal> and <literal>render</literal> are introduced + now, as systemd requires them. </para> </listitem> </itemizedlist> @@ -559,69 +656,92 @@ $ nix-instantiate -E '(import <nixpkgsunstable> {}).gitFull' <itemizedlist> <listitem> <para> - <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. + <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. </para> </listitem> <listitem> <para> - <literal>lib.attrNamesToStr</literal> has been deprecated. Use more specific concatenation (<literal>lib.concat(Map)StringsSep</literal>) instead. + <literal>lib.attrNamesToStr</literal> has been deprecated. Use more + specific concatenation (<literal>lib.concat(Map)StringsSep</literal>) + instead. </para> </listitem> <listitem> <para> - <literal>lib.addErrorContextToAttrs</literal> has been deprecated. Use <literal>builtins.addErrorContext</literal> directly. + <literal>lib.addErrorContextToAttrs</literal> has been deprecated. Use + <literal>builtins.addErrorContext</literal> directly. </para> </listitem> <listitem> <para> - <literal>lib.showVal</literal> has been deprecated. Use <literal>lib.traceSeqN</literal> instead. + <literal>lib.showVal</literal> has been deprecated. Use + <literal>lib.traceSeqN</literal> instead. </para> </listitem> <listitem> <para> - <literal>lib.traceXMLVal</literal> has been deprecated. Use <literal>lib.traceValFn builtins.toXml</literal> instead. + <literal>lib.traceXMLVal</literal> has been deprecated. Use + <literal>lib.traceValFn builtins.toXml</literal> instead. </para> </listitem> <listitem> <para> - <literal>lib.traceXMLValMarked</literal> has been deprecated. Use <literal>lib.traceValFn (x: str + builtins.toXML x)</literal> instead. + <literal>lib.traceXMLValMarked</literal> has been deprecated. Use + <literal>lib.traceValFn (x: str + builtins.toXML x)</literal> instead. </para> </listitem> <listitem> <para> - 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>. + 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>. </para> </listitem> <listitem> <para> - A NixOS system can now be constructed more easily based on a preexisting invocation of Nixpkgs. For example: + A NixOS system can now be constructed more easily based on a preexisting + invocation of Nixpkgs. For example: <programlisting> inherit (pkgs.nixos { boot.loader.grub.enable = false; fileSystems."/".device = "/dev/xvda1"; }) toplevel kernel initialRamdisk manual; </programlisting> - 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. + 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. </para> </listitem> <listitem> <para> - <literal>lib.traceValIfNot</literal> has been deprecated. Use <literal>if/then/else</literal> and <literal>lib.traceValSeq</literal> instead. + <literal>lib.traceValIfNot</literal> has been deprecated. Use + <literal>if/then/else</literal> and <literal>lib.traceValSeq</literal> + instead. </para> </listitem> <listitem> <para> - <literal>lib.traceCallXml</literal> has been deprecated. Please complain if you use the function regularly. + <literal>lib.traceCallXml</literal> has been deprecated. Please complain + if you use the function regularly. </para> </listitem> <listitem> <para> - 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. + 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. </para> </listitem> <listitem> <para> - <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. + <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. </para> </listitem> <listitem> @@ -635,7 +755,9 @@ inherit (pkgs.nixos { </term> <listitem> <para> - 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>. + 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>. </para> </listitem> </varlistentry> @@ -645,20 +767,27 @@ inherit (pkgs.nixos { </term> <listitem> <para> - The default bit size to use for the generated Diffie-Hellman parameters. + The default bit size to use for the generated Diffie-Hellman + parameters. </para> </listitem> </varlistentry> </variablelist> <note> <para> - 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>. + 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>. </para> </note> <note> <title>For developers:</title> <para> - 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). + 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). </para> <para> An example usage of this would be: @@ -677,82 +806,126 @@ inherit (pkgs.nixos { </listitem> <listitem> <para> - <literal>networking.networkmanager.useDnsmasq</literal> has been deprecated. Use <literal>networking.networkmanager.dns</literal> instead. + <literal>networking.networkmanager.useDnsmasq</literal> has been + deprecated. Use <literal>networking.networkmanager.dns</literal> instead. </para> </listitem> <listitem> <para> - 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. + 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. </para> </listitem> <listitem> <para> - The option <varname>services.kubernetes.apiserver.admissionControl</varname> was renamed to <varname>services.kubernetes.apiserver.enableAdmissionPlugins</varname>. + The option + <varname>services.kubernetes.apiserver.admissionControl</varname> was + renamed to + <varname>services.kubernetes.apiserver.enableAdmissionPlugins</varname>. </para> </listitem> <listitem> <para> - 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. + 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. </para> </listitem> <listitem> <para> - 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. + 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. </para> </listitem> <listitem> <para> - The option <varname>services.kubernetes.apiserver.publicAddress</varname> was not used and thus has been removed. + The option <varname>services.kubernetes.apiserver.publicAddress</varname> + was not used and thus has been removed. </para> </listitem> <listitem> <para> - The option <varname>services.kubernetes.addons.dashboard.enableRBAC</varname> was renamed to <varname>services.kubernetes.addons.dashboard.rbac.enable</varname>. + The option + <varname>services.kubernetes.addons.dashboard.enableRBAC</varname> was + renamed to + <varname>services.kubernetes.addons.dashboard.rbac.enable</varname>. </para> </listitem> <listitem> <para> - 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> + 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> </para> </listitem> <listitem> <para> - 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>. + 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>. </para> </listitem> <listitem> <para> - The module <option>services.networking.hostapd</option> now uses WPA2 by default. + The module <option>services.networking.hostapd</option> now uses WPA2 by + default. </para> </listitem> <listitem> <para> - <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. + <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. </para> </listitem> <listitem> <para> - The module option <option>nix.useSandbox</option> is now defaulted to <literal>true</literal>. + The module option <option>nix.useSandbox</option> is now defaulted to + <literal>true</literal>. </para> </listitem> <listitem> <para> - 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. + 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. </para> </listitem> <listitem> <para> - The default display manager is now LightDM. To use SLiM set <literal>services.xserver.displayManager.slim.enable</literal> to <literal>true</literal>. + The default display manager is now LightDM. To use SLiM set + <literal>services.xserver.displayManager.slim.enable</literal> to + <literal>true</literal>. </para> </listitem> <listitem> <para> - 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></para><para></code> to start a new paragraph. + 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></para><para></code> to start a + new paragraph. </para> </listitem> <listitem> <para> - 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>. + 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>. </para> </listitem> </itemizedlist> diff --git a/nixos/doc/manual/release-notes/rl-1903.xml b/nixos/doc/manual/release-notes/rl-1903.xml index e270519932b..8ff1681d3b4 100644 --- a/nixos/doc/manual/release-notes/rl-1903.xml +++ b/nixos/doc/manual/release-notes/rl-1903.xml @@ -13,7 +13,8 @@ <title>Highlights</title> <para> - In addition to numerous new and upgraded packages, this release has the following highlights: + In addition to numerous new and upgraded packages, this release has the + following highlights: </para> <itemizedlist> @@ -24,36 +25,53 @@ </listitem> <listitem> <para> - The default Python 3 interpreter is now CPython 3.7 instead of CPython 3.6. + The default Python 3 interpreter is now CPython 3.7 instead of CPython + 3.6. </para> </listitem> <listitem> <para> - Added the Pantheon desktop environment. It can be enabled through <varname>services.xserver.desktopManager.pantheon.enable</varname>. + Added the Pantheon desktop environment. It can be enabled through + <varname>services.xserver.desktopManager.pantheon.enable</varname>. </para> <note> <para> - By default, <varname>services.xserver.desktopManager.pantheon</varname> enables LightDM as a display manager, as pantheon's screen locking implementation relies on it. + By default, <varname>services.xserver.desktopManager.pantheon</varname> + enables LightDM as a display manager, as pantheon's screen locking + implementation relies on it. </para> <para> - 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. + 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. </para> </note> <para> - 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. + 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. </para> </listitem> <listitem> <para> - 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. + 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. </para> </listitem> <listitem> - <para> - There is now a set of <option>confinement</option> options for <option>systemd.services</option>, which allows to restrict services into a <citerefentry> - <refentrytitle>chroot</refentrytitle> - <manvolnum>2</manvolnum> </citerefentry>ed environment that only contains the store paths from the runtime closure of the service. - </para> + <para> + There is now a set of <option>confinement</option> options for + <option>systemd.services</option>, which allows to restrict services + into a <citerefentry> + <refentrytitle>chroot</refentrytitle> + <manvolnum>2</manvolnum> + </citerefentry>ed environment that only contains the store paths from + the runtime closure of the service. + </para> </listitem> </itemizedlist> </section> @@ -77,7 +95,12 @@ </listitem> <listitem> <para> - 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>. + 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>. </para> </listitem> <listitem> @@ -87,7 +110,10 @@ </listitem> <listitem> <para> - 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>. + 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>. </para> </listitem> </itemizedlist> @@ -100,7 +126,11 @@ </listitem> <listitem> <para> - 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.<name?>.duoSecurity.enable</option>. + 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.<name?>.duoSecurity.enable</option>. </para> </listitem> </itemizedlist> @@ -114,7 +144,8 @@ <title>Backward Incompatibilities</title> <para> - When upgrading from a previous release, please be aware of the following incompatible changes: + When upgrading from a previous release, please be aware of the following + incompatible changes: </para> <itemizedlist> @@ -125,131 +156,233 @@ <itemizedlist> <listitem> <para> - 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. + 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. </para> </listitem> <listitem> <para> - 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. + 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. </para> </listitem> <listitem> <para> - 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>. + 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>. </para> <para> - 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. + 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. </para> </listitem> <listitem> <para> - For users of the Nix daemon on macOS, you can upgrade Nix by running <command>sudo -i sh -c 'nix-channel --update && nix-env -iA nixpkgs.nix'; sudo launchctl stop org.nixos.nix-daemon; sudo launchctl start org.nixos.nix-daemon</command>. + For users of the Nix daemon on macOS, you can upgrade Nix by running + <command>sudo -i sh -c 'nix-channel --update && nix-env -iA + nixpkgs.nix'; sudo launchctl stop org.nixos.nix-daemon; sudo launchctl + start org.nixos.nix-daemon</command>. </para> </listitem> </itemizedlist> </listitem> <listitem> <para> - 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. + 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. </para> </listitem> <listitem> <para> - 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. + 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. </para> </listitem> <listitem> <para> - 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. + 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. </para> </listitem> <listitem> <para> - 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>. + 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>. </para> </listitem> <listitem> <para> - Package <varname>rabbitmq_server</varname> is renamed to <varname>rabbitmq-server</varname>. + Package <varname>rabbitmq_server</varname> is renamed to + <varname>rabbitmq-server</varname>. </para> </listitem> <listitem> <para> - 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>). + 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>). </para> </listitem> <listitem> <para> - 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. + 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. </para> </listitem> <listitem> <para> - 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. + 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. </para> </listitem> <listitem> <para> - 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> + 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> </para> </listitem> <listitem> <para> - 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>. + 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>. </para> </listitem> <listitem> <para> - 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. + 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. </para> </listitem> <listitem> <para> - 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>. + 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>. </para> </listitem> <listitem> <para> - 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. + 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. </para> </listitem> <listitem> <para> - 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. + 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. </para> <para> - 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>. + 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>. </para> <para> - 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. + 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. </para> </listitem> <listitem> <para> - 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. + 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. </para> </listitem> <listitem> <para> - 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>. + 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>. </para> </listitem> <listitem> <para> - 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>). + 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>). </para> </listitem> <listitem> <para> - 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. + 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. </para> </listitem> <listitem> <para> - 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. + 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. </para> <para> - If the old behaviour is desired, this can be restored by setting the <literal>services.nscd.config</literal> option with the desired caching parameters. + If the old behaviour is desired, this can be restored by setting the + <literal>services.nscd.config</literal> option with the desired caching + parameters. <programlisting> services.nscd.config = '' @@ -283,65 +416,124 @@ shared hosts yes ''; </programlisting> - See <link xlink:href="https://github.com/NixOS/nixpkgs/pull/50316">#50316</link> for details. + See + <link xlink:href="https://github.com/NixOS/nixpkgs/pull/50316">#50316</link> + for details. </para> </listitem> <listitem> <para> - 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. + 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. </para> </listitem> <listitem> <para> - 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> + 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> <![CDATA[security.pam.services.<name?>.text]]> </literal>. </para> </listitem> <listitem> <para> - 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. + 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. </para> </listitem> <listitem> <para> - <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. + <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. </para> </listitem> <listitem> <para> - 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. + 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. </para> </listitem> <listitem> <para> - 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>) + 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>) </para> </listitem> <listitem> <para> - <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. + <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. </para> </listitem> <listitem> <para> - <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. + <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. </para> </listitem> <listitem> <para> - <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. + <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. </para> </listitem> <listitem> <para> - 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. + 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. </para> </listitem> <listitem> - <para> - <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. - </para> + <para> + <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. + </para> </listitem> </itemizedlist> </section> @@ -356,122 +548,214 @@ <itemizedlist> <listitem> <para> - The <option>services.matomo</option> module gained the option <option>services.matomo.package</option> which determines the used Matomo version. + The <option>services.matomo</option> module gained the option + <option>services.matomo.package</option> which determines the used Matomo + version. </para> <para> - 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>. + 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>. </para> <para> - 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. + 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. </para> </listitem> <listitem> <para> - <literal>composableDerivation</literal> along with supporting library functions has been removed. + <literal>composableDerivation</literal> along with supporting library + functions has been removed. </para> </listitem> <listitem> <para> - 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. + 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. </para> </listitem> <listitem> <para> - 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>. + 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>. </para> </listitem> <listitem> <para> - The quassel-webserver package and module was removed from nixpkgs due to the lack of maintainers. + The quassel-webserver package and module was removed from nixpkgs due to + the lack of maintainers. </para> </listitem> <listitem> <para> - 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. + 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. </para> </listitem> <listitem> <para> - The astah-community package was removed from nixpkgs due to it being discontinued and the downloads not being available anymore. + The astah-community package was removed from nixpkgs due to it being + discontinued and the downloads not being available anymore. </para> </listitem> <listitem> <para> - The httpd service now saves log files with a .log file extension by default for easier integration with the logrotate service. + The httpd service now saves log files with a .log file extension by + default for easier integration with the logrotate service. </para> </listitem> <listitem> <para> - The owncloud server packages and httpd subservice module were removed from nixpkgs due to the lack of maintainers. + The owncloud server packages and httpd subservice module were removed from + nixpkgs due to the lack of maintainers. </para> </listitem> <listitem> <para> - 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. + 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. </para> <para> ZRAM algorithm can be changed now. </para> <para> - 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>. + 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>. </para> </listitem> <listitem> <para> - 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. + 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. </para> <note> <para> - 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. + 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. </para> </note> </listitem> <listitem> <para> - 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. + 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. </para> </listitem> <listitem> <para> - 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. + 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. </para> </listitem> <listitem> <para> - 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. + 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. </para> </listitem> <listitem> <para> - 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). + 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). </para> </listitem> <listitem> <para> - 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>. + 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>. </para> </listitem> <listitem> <para> - 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. + 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. </para> </listitem> <listitem> <para> - The kubernetes module does no longer add the kubernetes package to <varname>environment.systemPackages</varname> implicitly. + The kubernetes module does no longer add the kubernetes package to + <varname>environment.systemPackages</varname> implicitly. </para> </listitem> <listitem> <para> - 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) + 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) </para> </listitem> <listitem> <para> - 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>. + 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>. </para> <para> - 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"/>. + 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"/>. </para> </listitem> <listitem> diff --git a/nixos/doc/manual/release-notes/rl-1909.xml b/nixos/doc/manual/release-notes/rl-1909.xml index 92eae453924..58ab7207f53 100644 --- a/nixos/doc/manual/release-notes/rl-1909.xml +++ b/nixos/doc/manual/release-notes/rl-1909.xml @@ -13,7 +13,8 @@ <title>Highlights</title> <para> - In addition to numerous new and upgraded packages, this release has the following highlights: + In addition to numerous new and upgraded packages, this release has the + following highlights: </para> <itemizedlist> @@ -33,155 +34,85 @@ </para> </listitem> <listitem> - <para> - 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. - </para> + <para> + 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. + </para> </listitem> <listitem> - <para> - 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. + <para> + 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. </para> </listitem> <listitem> <para> - 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. + 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. </para> </listitem> <listitem> <para> - The GNOME 3 desktop manager module sports an interface to enable/disable core services, applications, and optional GNOME packages like games. - <itemizedlist> - <para> - This can be achieved with the following options which the desktop manager default enables, excluding <literal>games</literal>. - </para> - <listitem> - <para> - <xref linkend="opt-services.gnome3.core-os-services.enable"/> - </para> - </listitem> - <listitem> - <para> - <xref linkend="opt-services.gnome3.core-shell.enable"/> - </para> - </listitem> - <listitem> - <para> - <xref linkend="opt-services.gnome3.core-utilities.enable"/> - </para> - </listitem> - <listitem> - <para> - <xref linkend="opt-services.gnome3.games.enable"/> - </para> - </listitem> - </itemizedlist> - 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. + The GNOME 3 desktop manager module sports an interface to enable/disable core services, applications, and optional GNOME packages + like games. + <itemizedlist> + <para>This can be achieved with the following options which the desktop manager default enables, excluding <literal>games</literal>.</para> + <listitem><para><xref linkend="opt-services.gnome3.core-os-services.enable"/></para></listitem> + <listitem><para><xref linkend="opt-services.gnome3.core-shell.enable"/></para></listitem> + <listitem><para><xref linkend="opt-services.gnome3.core-utilities.enable"/></para></listitem> + <listitem><para><xref linkend="opt-services.gnome3.games.enable"/></para></listitem> + </itemizedlist> + 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. </para> </listitem> <listitem> <para> - 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. + 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. </para> - <bridgehead>The following changes were enacted in <option>services.gnome3.core-utilities.enable</option> - </bridgehead> + + <bridgehead>The following changes were enacted in <option>services.gnome3.core-utilities.enable</option></bridgehead> + <itemizedlist> <title>Applications removed from defaults:</title> - <listitem> - <para> - <literal>accerciser</literal> - </para> - </listitem> - <listitem> - <para> - <literal>dconf-editor</literal> - </para> - </listitem> - <listitem> - <para> - <literal>evolution</literal> - </para> - </listitem> - <listitem> - <para> - <literal>gnome-documents</literal> - </para> - </listitem> - <listitem> - <para> - <literal>gnome-nettool</literal> - </para> - </listitem> - <listitem> - <para> - <literal>gnome-power-manager</literal> - </para> - </listitem> - <listitem> - <para> - <literal>gnome-todo</literal> - </para> - </listitem> - <listitem> - <para> - <literal>gnome-tweaks</literal> - </para> - </listitem> - <listitem> - <para> - <literal>gnome-usage</literal> - </para> - </listitem> - <listitem> - <para> - <literal>gucharmap</literal> - </para> - </listitem> - <listitem> - <para> - <literal>nautilus-sendto</literal> - </para> - </listitem> - <listitem> - <para> - <literal>vinagre</literal> - </para> - </listitem> + <listitem><para><literal>accerciser</literal></para></listitem> + <listitem><para><literal>dconf-editor</literal></para></listitem> + <listitem><para><literal>evolution</literal></para></listitem> + <listitem><para><literal>gnome-documents</literal></para></listitem> + <listitem><para><literal>gnome-nettool</literal></para></listitem> + <listitem><para><literal>gnome-power-manager</literal></para></listitem> + <listitem><para><literal>gnome-todo</literal></para></listitem> + <listitem><para><literal>gnome-tweaks</literal></para></listitem> + <listitem><para><literal>gnome-usage</literal></para></listitem> + <listitem><para><literal>gucharmap</literal></para></listitem> + <listitem><para><literal>nautilus-sendto</literal></para></listitem> + <listitem><para><literal>vinagre</literal></para></listitem> </itemizedlist> <itemizedlist> <title>Applications added to defaults:</title> - <listitem> - <para> - <literal>cheese</literal> - </para> - </listitem> - <listitem> - <para> - <literal>geary</literal> - </para> - </listitem> + <listitem><para><literal>cheese</literal></para></listitem> + <listitem><para><literal>geary</literal></para></listitem> </itemizedlist> - <bridgehead>The following changes were enacted in <option>services.gnome3.core-shell.enable</option> - </bridgehead> + + <bridgehead>The following changes were enacted in <option>services.gnome3.core-shell.enable</option></bridgehead> + <itemizedlist> <title>Applications added to defaults:</title> - <listitem> - <para> - <literal>gnome-color-manager</literal> - </para> - </listitem> - <listitem> - <para> - <literal>orca</literal> - </para> - </listitem> + <listitem><para><literal>gnome-color-manager</literal></para></listitem> + <listitem><para><literal>orca</literal></para></listitem> </itemizedlist> <itemizedlist> <title>Services enabled:</title> - <listitem> - <para> - <option>services.avahi.enable</option> - </para> - </listitem> + <listitem><para><option>services.avahi.enable</option></para></listitem> </itemizedlist> </listitem> </itemizedlist> @@ -206,43 +137,41 @@ </listitem> <listitem> <para> - 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. + 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. </para> </listitem> <listitem> <para> - 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. + 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. </para> <itemizedlist> - <para> - If you're a user of the following desktopManager modules no action is needed: - </para> + <para>If you're a user of the following desktopManager modules no action is needed:</para> <listitem> - <para> - <option>services.xserver.desktopManager.plasma5</option> - </para> + <para><option>services.xserver.desktopManager.plasma5</option></para> </listitem> <listitem> - <para> - <option>services.xserver.desktopManager.gnome3</option> - </para> + <para><option>services.xserver.desktopManager.gnome3</option></para> </listitem> <listitem> - <para> - <option>services.xserver.desktopManager.pantheon</option> - </para> + <para><option>services.xserver.desktopManager.pantheon</option></para> </listitem> <listitem> + <para><option>services.xserver.desktopManager.mate</option></para> <para> - <option>services.xserver.desktopManager.mate</option> - </para> - <para> - Note Mate uses <literal>programs.system-config-printer</literal> as it doesn't use it as a service, but its graphical interface directly. + Note Mate uses <literal>programs.system-config-printer</literal> as it doesn't + use it as a service, but its graphical interface directly. </para> </listitem> </itemizedlist> </listitem> </itemizedlist> + </section> <section xmlns="http://docbook.org/ns/docbook" @@ -253,18 +182,26 @@ <title>Backward Incompatibilities</title> <para> - When upgrading from a previous release, please be aware of the following incompatible changes: + When upgrading from a previous release, please be aware of the following + incompatible changes: </para> <itemizedlist> <listitem> <para> - 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. + 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. </para> </listitem> <listitem> <para> - 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. + 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. </para> </listitem> <listitem> @@ -274,212 +211,278 @@ </listitem> <listitem> <para> - 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 - xlink:href="http://0pointer.net/blog/dynamic-users-with-systemd.html"> DynamicUser mechanism</link> which obviates these options. + 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 + xlink:href="http://0pointer.net/blog/dynamic-users-with-systemd.html"> + DynamicUser mechanism</link> which obviates these options. </para> </listitem> <listitem> <para> - 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. + 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. </para> </listitem> <listitem> <para> - 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. + 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. </para> </listitem> <listitem> <para> - 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. + 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. </para> </listitem> <listitem> <para> - 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> + 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> </para> </listitem> <listitem> - <para> - 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. + <para> + 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. </para> </listitem> <listitem> <para> - 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>. + 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>. </para> <para> - The corresponding module, <option>services.btsync</option> has been replaced by the <option>services.resilio</option> module. + The corresponding module, <option>services.btsync</option> has been + replaced by the <option>services.resilio</option> module. </para> </listitem> <listitem> <para> - 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> + 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> </para> <para> - 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. + 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. </para> <para> - 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. + 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. </para> </listitem> <listitem> <para> - The option <option>systemd.network.networks.<name>.routes.*.routeConfig.GatewayOnlink</option> was renamed to <option>systemd.network.networks.<name>.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. + The option <option>systemd.network.networks.<name>.routes.*.routeConfig.GatewayOnlink</option> + was renamed to <option>systemd.network.networks.<name>.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. </para> </listitem> <listitem> <para> - As of this release the NixOps feature <literal>autoLuks</literal> is deprecated. It no longer works with our systemd version without manual intervention. + As of this release the NixOps feature <literal>autoLuks</literal> is deprecated. It no longer works + with our systemd version without manual intervention. </para> <para> - Whenever the usage of the module is detected the evaluation will fail with a message explaining why and how to deal with the situation. + Whenever the usage of the module is detected the evaluation will fail with a message + explaining why and how to deal with the situation. </para> <para> - 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. + 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. </para> <para> - 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. + 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. </para> <para> - 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>. + 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>. </para> </listitem> <listitem> <para> - 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. + 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. </para> </listitem> <listitem> <para> - 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>. + 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>. </para> </listitem> <listitem> <para> - 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>. - </para> - <para> - Nodejs 8 is scheduled EOL under the lifetime of 19.09 and has been dropped. + 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>. </para> + <para> + Nodejs 8 is scheduled EOL under the lifetime of 19.09 and has been dropped. + </para> </listitem> <listitem> - <para> - 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><exporter-name>-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>. - </para> + <para> + 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><exporter-name>-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>. + </para> </listitem> <listitem> - <para> - 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. - </para> + <para> + 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. + </para> </listitem> <listitem> - <para> - 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>. - </para> + <para> + 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>. + </para> </listitem> <listitem> - <para> - The <option>services.systemhealth</option> module has been removed from nixpkgs due to lack of maintainer. - </para> + <para> + The <option>services.systemhealth</option> module has been removed from nixpkgs due to lack of maintainer. + </para> </listitem> <listitem> - <para> - The <option>services.mantisbt</option> module has been removed from nixpkgs due to lack of maintainer. - </para> + <para> + The <option>services.mantisbt</option> module has been removed from nixpkgs due to lack of maintainer. + </para> </listitem> <listitem> - <para> - Squid 3 has been removed and the <option>squid</option> derivation now refers to Squid 4. - </para> + <para> + Squid 3 has been removed and the <option>squid</option> derivation now refers to Squid 4. + </para> </listitem> <listitem> - <para> - 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. - </para> + <para> + 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. + </para> </listitem> <listitem> <para> - 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><key-name>-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>. + 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><key-name>-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>. </para> <para> The following services are affected by this: <itemizedlist> - <listitem> - <para> - <link linkend="opt-services.dovecot2.enable"><literal>services.dovecot2</literal></link> - </para> - </listitem> - <listitem> - <para> - <link linkend="opt-services.nsd.enable"><literal>services.nsd</literal></link> - </para> - </listitem> - <listitem> - <para> - <link linkend="opt-services.softether.enable"><literal>services.softether</literal></link> - </para> - </listitem> - <listitem> - <para> - <link linkend="opt-services.strongswan.enable"><literal>services.strongswan</literal></link> - </para> - </listitem> - <listitem> - <para> - <link linkend="opt-services.strongswan-swanctl.enable"><literal>services.strongswan-swanctl</literal></link> - </para> - </listitem> - <listitem> - <para> - <link linkend="opt-services.httpd.enable"><literal>services.httpd</literal></link> - </para> - </listitem> + <listitem><para><link linkend="opt-services.dovecot2.enable"><literal>services.dovecot2</literal></link></para></listitem> + <listitem><para><link linkend="opt-services.nsd.enable"><literal>services.nsd</literal></link></para></listitem> + <listitem><para><link linkend="opt-services.softether.enable"><literal>services.softether</literal></link></para></listitem> + <listitem><para><link linkend="opt-services.strongswan.enable"><literal>services.strongswan</literal></link></para></listitem> + <listitem><para><link linkend="opt-services.strongswan-swanctl.enable"><literal>services.strongswan-swanctl</literal></link></para></listitem> + <listitem><para><link linkend="opt-services.httpd.enable"><literal>services.httpd</literal></link></para></listitem> </itemizedlist> </para> </listitem> <listitem> - <para> - The <option>security.acme.directory</option> option has been replaced by a read-only <option>security.acme.certs.<cert>.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.<name>.enableACME</option> option will use this directory option to find the certs for the virtual host. - </para> - <para> - <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. - </para> - <para> - 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. - </para> - <para> - For nginx, the dependencies are still automatically managed when <option>services.nginx.virtualhosts.<name>.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>. - </para> + <para> + The <option>security.acme.directory</option> option has been replaced by a read-only <option>security.acme.certs.<cert>.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.<name>.enableACME</option> option will use this directory option to find the certs for the virtual host. + </para> + <para> + <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. + </para> + <para> + 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. + </para> + <para> + For nginx, the dependencies are still automatically managed when <option>services.nginx.virtualhosts.<name>.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>. + </para> </listitem> <listitem> - <para> - 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>. - </para> + <para> + 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>. + </para> </listitem> <listitem> - <para> - <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. - </para> + <para> + <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. + </para> </listitem> <listitem> <para> - 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. + 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. </para> </listitem> <listitem> <para> - 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. + 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. </para> </listitem> <listitem> <para> - 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>. + 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>. </para> </listitem> <listitem> - <para> - Citrix Receiver (<literal>citrix_receiver</literal>) has been dropped in favor of Citrix Workspace (<literal>citrix_workspace</literal>). - </para> + <para> + Citrix Receiver (<literal>citrix_receiver</literal>) has been dropped in favor of Citrix Workspace + (<literal>citrix_workspace</literal>). + </para> </listitem> </itemizedlist> </section> @@ -494,74 +497,122 @@ <itemizedlist> <listitem> <para> - The <option>documentation</option> module gained an option named <option>documentation.nixos.includeAllModules</option> which makes the generated <citerefentry> + The <option>documentation</option> module gained an option named + <option>documentation.nixos.includeAllModules</option> which makes the + generated <citerefentry> <refentrytitle>configuration.nix</refentrytitle> - <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. + <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. </para> </listitem> <listitem> <para> - 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. + 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. </para> </listitem> <listitem> <para> - 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. + 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. </para> <itemizedlist> <listitem> <para> - <literal>solr.package</literal> defaults to <literal>pkgs.solr_8</literal>. + <literal>solr.package</literal> defaults to + <literal>pkgs.solr_8</literal>. </para> </listitem> </itemizedlist> </listitem> <listitem> <para> - 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>. + 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>. </para> </listitem> <listitem> <para> - 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. + 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. </para> </listitem> <listitem> <para> - 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>. + 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>. </para> <para> - 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. + 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. </para> </listitem> <listitem> <para> - 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> - <refentrytitle>avahi.service</refentrytitle> - <manvolnum>5</manvolnum> </citerefentry> for more information on custom service definitions. + 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> + <refentrytitle>avahi.service</refentrytitle><manvolnum>5</manvolnum> + </citerefentry> for more information on custom service definitions. </para> </listitem> <listitem> <para> - 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. + 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. </para> <para> - 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. + 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. </para> </listitem> <listitem> <para> - The <literal>consul</literal> package was upgraded past version <literal>1.5</literal>, so its deprecated legacy UI is no longer available. + The <literal>consul</literal> package was upgraded past version <literal>1.5</literal>, + so its deprecated legacy UI is no longer available. </para> </listitem> <listitem> <para> - 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>. + 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>. </para> </listitem> <listitem> <para> - 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. + 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. </para> </listitem> <listitem> @@ -576,7 +627,8 @@ </listitem> <listitem> <para> - The <literal>foswiki</literal> package and associated <literal>httpd.extraSubservice</literal> have been removed from nixpkgs due to lack of maintainer. + The <literal>foswiki</literal> package and associated <literal>httpd.extraSubservice</literal> have been removed + from nixpkgs due to lack of maintainer. </para> </listitem> <listitem> @@ -586,126 +638,155 @@ </listitem> <listitem> <para> - 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>. + 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>. </para> </listitem> <listitem> <para> - 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. + 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. </para> <para> - 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>. + 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>. </para> <para> - 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> - <refentrytitle>sysctl.d</refentrytitle> - <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. + 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><refentrytitle>sysctl.d</refentrytitle><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. </para> </listitem> <listitem> <para> - We now install the sysctl snippets shipped with systemd. - <itemizedlist> + We now install the sysctl snippets shipped with systemd. + <itemizedlist> + <para>This enables:</para> + <listitem> + <para>Loose reverse path filtering</para> + </listitem> + <listitem> + <para>Source route filtering</para> + </listitem> + <listitem> <para> - This enables: + <literal>fq_codel</literal> as a packet scheduler (this helps to fight bufferbloat) </para> - <listitem> - <para> - Loose reverse path filtering - </para> - </listitem> - <listitem> - <para> - Source route filtering - </para> - </listitem> - <listitem> - <para> - <literal>fq_codel</literal> as a packet scheduler (this helps to fight bufferbloat) - </para> - </listitem> - </itemizedlist> - 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>). - </para> + </listitem> + </itemizedlist> + 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>). + </para> </listitem> <listitem> <para> - 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>. + 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>. </para> </listitem> <listitem> <para> - <literal>systemd.packages</literal> option now also supports generators and shutdown scripts. Old <literal>systemd.generator-packages</literal> option has been removed. + <literal>systemd.packages</literal> option now also supports generators and + shutdown scripts. Old <literal>systemd.generator-packages</literal> option has + been removed. </para> </listitem> <listitem> <para> - 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. + 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. </para> </listitem> <listitem> <para> - 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. + 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. </para> </listitem> <listitem> <para> - We no longer enable custom font rendering settings with <option>fonts.fontconfig.penultimate.enable</option> by default. The defaults from fontconfig are sufficient. + We no longer enable custom font rendering settings with <option>fonts.fontconfig.penultimate.enable</option> by default. + The defaults from fontconfig are sufficient. </para> </listitem> <listitem> <para> - 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. + 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. </para> <para> - 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). + 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). </para> </listitem> <listitem> <para> Using <option>fonts.enableDefaultFonts</option> adds a default emoji font <literal>noto-fonts-emoji</literal>. <itemizedlist> - <para> - Users of the following options will have this enabled by default: - </para> + <para>Users of the following options will have this enabled by default:</para> <listitem> - <para> - <option>services.xserver.enable</option> - </para> + <para><option>services.xserver.enable</option></para> </listitem> <listitem> - <para> - <option>programs.sway.enable</option> - </para> + <para><option>programs.sway.enable</option></para> </listitem> <listitem> - <para> - <option>programs.way-cooler.enable</option> - </para> + <para><option>programs.way-cooler.enable</option></para> </listitem> <listitem> - <para> - <option>services.xrdp.enable</option> - </para> + <para><option>services.xrdp.enable</option></para> </listitem> </itemizedlist> </para> </listitem> <listitem> - <para> - 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. - </para> - </listitem> - <listitem> - <para> - 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. - </para> + <para> + 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. + </para> </listitem> <listitem> - <para> - <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> - </para> - </listitem> + <para> + 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. + </para> + </listitem> + <listitem> + <para> + <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> + </para> + </listitem> </itemizedlist> </section> </section> diff --git a/nixos/doc/manual/release-notes/rl-2003.xml b/nixos/doc/manual/release-notes/rl-2003.xml index f10c0afd1db..c84bc8dbb37 100644 --- a/nixos/doc/manual/release-notes/rl-2003.xml +++ b/nixos/doc/manual/release-notes/rl-2003.xml @@ -13,7 +13,8 @@ <title>Highlights</title> <para> - In addition to numerous new and upgraded packages, this release has the following highlights: + In addition to numerous new and upgraded packages, this release has the + following highlights: </para> <itemizedlist> @@ -41,6 +42,7 @@ <para /> </listitem> </itemizedlist> + </section> <section xmlns="http://docbook.org/ns/docbook" @@ -51,7 +53,8 @@ <title>Backward Incompatibilities</title> <para> - When upgrading from a previous release, please be aware of the following incompatible changes: + When upgrading from a previous release, please be aware of the following + incompatible changes: </para> <itemizedlist> diff --git a/nixos/modules/i18n/input-method/default.xml b/nixos/modules/i18n/input-method/default.xml index 830ef88d6d9..117482fb0d5 100644 --- a/nixos/modules/i18n/input-method/default.xml +++ b/nixos/modules/i18n/input-method/default.xml @@ -5,7 +5,11 @@ xml:id="module-services-input-methods"> <title>Input Methods</title> <para> - 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. + 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. </para> <para> The following input methods are available in NixOS: @@ -36,7 +40,8 @@ <title>IBus</title> <para> - IBus is an Intelligent Input Bus. It provides full featured and user friendly input method user interface. + IBus is an Intelligent Input Bus. It provides full featured and user + friendly input method user interface. </para> <para> @@ -51,7 +56,8 @@ i18n.inputMethod = { </programlisting> <para> - <literal>i18n.inputMethod.ibus.engines</literal> is optional and can be used to add extra IBus engines. + <literal>i18n.inputMethod.ibus.engines</literal> is optional and can be used + to add extra IBus engines. </para> <para> @@ -61,7 +67,8 @@ i18n.inputMethod = { <itemizedlist> <listitem> <para> - Anthy (<literal>ibus-engines.anthy</literal>): Anthy is a system for Japanese input method. It converts Hiragana text to Kana Kanji mixed text. + Anthy (<literal>ibus-engines.anthy</literal>): Anthy is a system for + Japanese input method. It converts Hiragana text to Kana Kanji mixed text. </para> </listitem> <listitem> @@ -71,22 +78,28 @@ i18n.inputMethod = { </listitem> <listitem> <para> - m17n (<literal>ibus-engines.m17n</literal>): m17n is an input method that uses input methods and corresponding icons in the m17n database. + m17n (<literal>ibus-engines.m17n</literal>): m17n is an input method that + uses input methods and corresponding icons in the m17n database. </para> </listitem> <listitem> <para> - mozc (<literal>ibus-engines.mozc</literal>): A Japanese input method from Google. + mozc (<literal>ibus-engines.mozc</literal>): A Japanese input method from + Google. </para> </listitem> <listitem> <para> - Table (<literal>ibus-engines.table</literal>): An input method that load tables of input methods. + Table (<literal>ibus-engines.table</literal>): An input method that load + tables of input methods. </para> </listitem> <listitem> <para> - 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: + 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: <programlisting> ibus.engines = with pkgs.ibus-engines; [ table table-others ]; </programlisting> @@ -95,13 +108,22 @@ ibus.engines = with pkgs.ibus-engines; [ table table-others ]; </itemizedlist> <para> - 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. + 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. </para> <simplesect xml:id="module-services-input-methods-troubleshooting"> <title>Troubleshooting</title> <para> - 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 <path> | grep glib</literal>, where <literal><path></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. + 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 <path> | grep glib</literal>, + where <literal><path></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. </para> </simplesect> </section> @@ -109,7 +131,8 @@ ibus.engines = with pkgs.ibus-engines; [ table table-others ]; <title>Fcitx</title> <para> - Fcitx is an input method framework with extension support. It has three built-in Input Method Engine, Pinyin, QuWei and Table-based input methods. + Fcitx is an input method framework with extension support. It has three + built-in Input Method Engine, Pinyin, QuWei and Table-based input methods. </para> <para> @@ -124,7 +147,8 @@ i18n.inputMethod = { </programlisting> <para> - <literal>i18n.inputMethod.fcitx.engines</literal> is optional and can be used to add extra Fcitx engines. + <literal>i18n.inputMethod.fcitx.engines</literal> is optional and can be + used to add extra Fcitx engines. </para> <para> @@ -134,12 +158,15 @@ i18n.inputMethod = { <itemizedlist> <listitem> <para> - Anthy (<literal>fcitx-engines.anthy</literal>): Anthy is a system for Japanese input method. It converts Hiragana text to Kana Kanji mixed text. + Anthy (<literal>fcitx-engines.anthy</literal>): Anthy is a system for + Japanese input method. It converts Hiragana text to Kana Kanji mixed text. </para> </listitem> <listitem> <para> - 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. + 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. </para> </listitem> <listitem> @@ -154,17 +181,20 @@ i18n.inputMethod = { </listitem> <listitem> <para> - m17n (<literal>fcitx-engines.m17n</literal>): m17n is an input method that uses input methods and corresponding icons in the m17n database. + m17n (<literal>fcitx-engines.m17n</literal>): m17n is an input method that + uses input methods and corresponding icons in the m17n database. </para> </listitem> <listitem> <para> - mozc (<literal>fcitx-engines.mozc</literal>): A Japanese input method from Google. + mozc (<literal>fcitx-engines.mozc</literal>): A Japanese input method from + Google. </para> </listitem> <listitem> <para> - table-others (<literal>fcitx-engines.table-others</literal>): Various table-based input methods. + table-others (<literal>fcitx-engines.table-others</literal>): Various + table-based input methods. </para> </listitem> </itemizedlist> @@ -173,7 +203,9 @@ i18n.inputMethod = { <title>Nabi</title> <para> - Nabi is an easy to use Korean X input method. It allows you to enter phonetic Korean characters (hangul) and pictographic Korean characters (hanja). + Nabi is an easy to use Korean X input method. It allows you to enter + phonetic Korean characters (hangul) and pictographic Korean characters + (hanja). </para> <para> @@ -190,7 +222,8 @@ i18n.inputMethod = { <title>Uim</title> <para> - Uim (short for "universal input method") is a multilingual input method framework. Applications can use it through so-called bridges. + Uim (short for "universal input method") is a multilingual input method + framework. Applications can use it through so-called bridges. </para> <para> @@ -204,7 +237,8 @@ i18n.inputMethod = { </programlisting> <para> - Note: The <xref linkend="opt-i18n.inputMethod.uim.toolbar"/> option can be used to choose uim toolbar. + Note: The <xref linkend="opt-i18n.inputMethod.uim.toolbar"/> option can be + used to choose uim toolbar. </para> </section> </chapter> diff --git a/nixos/modules/installer/cd-dvd/sd-image.nix b/nixos/modules/installer/cd-dvd/sd-image.nix index 0a015044155..a2a8e8ef752 100644 --- a/nixos/modules/installer/cd-dvd/sd-image.nix +++ b/nixos/modules/installer/cd-dvd/sd-image.nix @@ -174,8 +174,10 @@ in boot.postBootCommands = '' # On the first boot do some maintenance tasks if [ -f /nix-path-registration ]; then + set -euo pipefail + set -x # Figure out device names for the boot device and root filesystem. - rootPart=$(readlink -f /dev/disk/by-label/NIXOS_SD) + rootPart=$(${pkgs.utillinux}/bin/findmnt -n -o SOURCE /) bootDevice=$(lsblk -npo PKNAME $rootPart) # Resize the root partition and the filesystem to fit the disk diff --git a/nixos/modules/programs/digitalbitbox/doc.xml b/nixos/modules/programs/digitalbitbox/doc.xml index 871abddca4c..c63201628db 100644 --- a/nixos/modules/programs/digitalbitbox/doc.xml +++ b/nixos/modules/programs/digitalbitbox/doc.xml @@ -8,25 +8,37 @@ Digital Bitbox is a hardware wallet and second-factor authenticator. </para> <para> - The <literal>digitalbitbox</literal> programs module may be installed by setting <literal>programs.digitalbitbox</literal> to <literal>true</literal> in a manner similar to + The <literal>digitalbitbox</literal> programs module may be installed by + setting <literal>programs.digitalbitbox</literal> to <literal>true</literal> + in a manner similar to <programlisting> <xref linkend="opt-programs.digitalbitbox.enable"/> = true; </programlisting> - and bundles the <literal>digitalbitbox</literal> package (see <xref - linkend="sec-digitalbitbox-package" />), which contains the <literal>dbb-app</literal> and <literal>dbb-cli</literal> binaries, along with the hardware module (see <xref - linkend="sec-digitalbitbox-hardware-module" />) which sets up the necessary udev rules to access the device. + and bundles the <literal>digitalbitbox</literal> package (see + <xref + linkend="sec-digitalbitbox-package" />), which contains the + <literal>dbb-app</literal> and <literal>dbb-cli</literal> binaries, along + with the hardware module (see + <xref + linkend="sec-digitalbitbox-hardware-module" />) which sets up the + necessary udev rules to access the device. </para> <para> - Enabling the digitalbitbox module is pretty much the easiest way to get a Digital Bitbox device working on your system. + Enabling the digitalbitbox module is pretty much the easiest way to get a + Digital Bitbox device working on your system. </para> <para> - For more information, see <link xlink:href="https://digitalbitbox.com/start_linux" />. + For more information, see + <link xlink:href="https://digitalbitbox.com/start_linux" />. </para> <section xml:id="sec-digitalbitbox-package"> <title>Package</title> <para> - 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: + 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: <programlisting> <xref linkend="opt-environment.systemPackages"/> = [ pkgs.digitalbitbox @@ -38,14 +50,17 @@ <title>Hardware</title> <para> - The digitalbitbox hardware package enables the udev rules for Digital Bitbox devices and may be installed as follows: + The digitalbitbox hardware package enables the udev rules for Digital Bitbox + devices and may be installed as follows: <programlisting> <xref linkend="opt-hardware.digitalbitbox.enable"/> = true; </programlisting> </para> <para> - 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: + 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: <programlisting> programs.digitalbitbox = { <link linkend="opt-programs.digitalbitbox.enable">enable</link> = true; diff --git a/nixos/modules/programs/plotinus.xml b/nixos/modules/programs/plotinus.xml index a0370f90a41..8fc8c22c6d7 100644 --- a/nixos/modules/programs/plotinus.xml +++ b/nixos/modules/programs/plotinus.xml @@ -5,19 +5,24 @@ xml:id="module-program-plotinus"> <title>Plotinus</title> <para> - <emphasis>Source:</emphasis> <filename>modules/programs/plotinus.nix</filename> + <emphasis>Source:</emphasis> + <filename>modules/programs/plotinus.nix</filename> </para> <para> - <emphasis>Upstream documentation:</emphasis> <link xlink:href="https://github.com/p-e-w/plotinus"/> + <emphasis>Upstream documentation:</emphasis> + <link xlink:href="https://github.com/p-e-w/plotinus"/> </para> <para> Plotinus is a searchable command palette in every modern GTK application. </para> <para> - 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. + 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. </para> <para> - To enable Plotinus, add the following to your <filename>configuration.nix</filename>: + To enable Plotinus, add the following to your + <filename>configuration.nix</filename>: <programlisting> <xref linkend="opt-programs.plotinus.enable"/> = true; </programlisting> diff --git a/nixos/modules/programs/zsh/oh-my-zsh.xml b/nixos/modules/programs/zsh/oh-my-zsh.xml index c5202d818c9..568c2de6557 100644 --- a/nixos/modules/programs/zsh/oh-my-zsh.xml +++ b/nixos/modules/programs/zsh/oh-my-zsh.xml @@ -5,13 +5,18 @@ xml:id="module-programs-zsh-ohmyzsh"> <title>Oh my ZSH</title> <para> - <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. + <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. </para> <section xml:id="module-programs-oh-my-zsh-usage"> <title>Basic usage</title> <para> - 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>. + 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>. <programlisting> { programs.zsh.ohMyZsh = { @@ -21,18 +26,25 @@ }; } </programlisting> - 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>. + 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>. </para> <para> - The expression generates the needed configuration and writes it into your <literal>/etc/zshrc</literal>. + The expression generates the needed configuration and writes it into your + <literal>/etc/zshrc</literal>. </para> </section> <section xml:id="module-programs-oh-my-zsh-additions"> <title>Custom additions</title> <para> - 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. + 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. </para> <para> @@ -48,11 +60,16 @@ <title>Custom environments</title> <para> - 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>. + 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>. </para> <para> - 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: + 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: <programlisting> { pkgs, ... }: { @@ -62,34 +79,53 @@ ]; } </programlisting> - 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. + 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. </para> <para> - <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> + <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> </para> </section> <section xml:id="module-programs-oh-my-zsh-packaging-customizations"> <title>Package your own customizations</title> <para> - 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: + 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: </para> <itemizedlist> <listitem> <para> - To comply with the default structure of <literal>ZSH</literal> the entire output needs to be written to <literal>$out/share/zsh.</literal> + To comply with the default structure of <literal>ZSH</literal> the entire + output needs to be written to <literal>$out/share/zsh.</literal> </para> </listitem> <listitem> <para> - 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. + 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. </para> </listitem> <listitem> <para> - 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> + 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> </para> </listitem> </itemizedlist> diff --git a/nixos/modules/security/acme.xml b/nixos/modules/security/acme.xml index 182d6e0cd51..9d0a1995e0f 100644 --- a/nixos/modules/security/acme.xml +++ b/nixos/modules/security/acme.xml @@ -5,13 +5,19 @@ xml:id="module-security-acme"> <title>SSL/TLS Certificates with ACME</title> <para> - NixOS supports automatic domain validation & 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. + NixOS supports automatic domain validation & 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. </para> <section xml:id="module-security-acme-prerequisites"> <title>Prerequisites</title> <para> - 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. + 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. </para> <para> @@ -39,7 +45,9 @@ http { <title>Configuring</title> <para> - To enable ACME certificate retrieval & renewal for a certificate for <literal>foo.example.com</literal>, add the following in your <filename>configuration.nix</filename>: + To enable ACME certificate retrieval & renewal for a certificate for + <literal>foo.example.com</literal>, add the following in your + <filename>configuration.nix</filename>: <programlisting> <xref linkend="opt-security.acme.certs"/>."foo.example.com" = { <link linkend="opt-security.acme.certs._name_.webroot">webroot</link> = "/var/www/challenges"; @@ -49,18 +57,26 @@ http { </para> <para> - 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>. + 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>. </para> - <para> - Refer to <xref linkend="ch-options" /> for all available configuration options for the <link linkend="opt-security.acme.certs">security.acme</link> module. + Refer to <xref linkend="ch-options" /> for all available configuration + options for the <link linkend="opt-security.acme.certs">security.acme</link> + module. </para> </section> <section xml:id="module-security-acme-nginx"> <title>Using ACME certificates in Nginx</title> <para> - 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. + 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. </para> <programlisting> diff --git a/nixos/modules/security/hidepid.xml b/nixos/modules/security/hidepid.xml index 979d0215ab3..5a17cb1da41 100644 --- a/nixos/modules/security/hidepid.xml +++ b/nixos/modules/security/hidepid.xml @@ -9,13 +9,18 @@ <programlisting> <xref linkend="opt-security.hideProcessInformation"/> = true; </programlisting> - 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. + 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. </para> <para> - Members of the <literal>proc</literal> group are exempt from process information hiding. + Members of the <literal>proc</literal> group are exempt from process + information hiding. </para> <para> - To allow a service <replaceable>foo</replaceable> to run without process information hiding, set + To allow a service <replaceable>foo</replaceable> to run without process + information hiding, set <programlisting> <link linkend="opt-systemd.services._name_.serviceConfig">systemd.services.<replaceable>foo</replaceable>.serviceConfig</link>.SupplementaryGroups = [ "proc" ]; </programlisting> diff --git a/nixos/modules/services/databases/foundationdb.xml b/nixos/modules/services/databases/foundationdb.xml index 33adfee3526..b0b1ebeab45 100644 --- a/nixos/modules/services/databases/foundationdb.xml +++ b/nixos/modules/services/databases/foundationdb.xml @@ -5,10 +5,12 @@ xml:id="module-services-foundationdb"> <title>FoundationDB</title> <para> - <emphasis>Source:</emphasis> <filename>modules/services/databases/foundationdb.nix</filename> + <emphasis>Source:</emphasis> + <filename>modules/services/databases/foundationdb.nix</filename> </para> <para> - <emphasis>Upstream documentation:</emphasis> <link xlink:href="https://apple.github.io/foundationdb/"/> + <emphasis>Upstream documentation:</emphasis> + <link xlink:href="https://apple.github.io/foundationdb/"/> </para> <para> <emphasis>Maintainer:</emphasis> Austin Seipp @@ -17,13 +19,15 @@ <emphasis>Available version(s):</emphasis> 5.1.x, 5.2.x, 6.0.x </para> <para> - FoundationDB (or "FDB") is an open source, distributed, transactional key-value store. + FoundationDB (or "FDB") is an open source, distributed, transactional + key-value store. </para> <section xml:id="module-services-foundationdb-configuring"> <title>Configuring and basic setup</title> <para> - To enable FoundationDB, add the following to your <filename>configuration.nix</filename>: + To enable FoundationDB, add the following to your + <filename>configuration.nix</filename>: <programlisting> services.foundationdb.enable = true; services.foundationdb.package = pkgs.foundationdb52; # FoundationDB 5.2.x @@ -31,11 +35,18 @@ services.foundationdb.package = pkgs.foundationdb52; # FoundationDB 5.2.x </para> <para> - 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. + 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. </para> <para> - 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>): + 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>): <screen> <prompt>$ </prompt>sudo -u foundationdb fdbcli Using cluster file `/etc/foundationdb/fdb.cluster'. @@ -66,7 +77,11 @@ Cluster: </para> <para> - 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). + 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). <screen> <prompt>a@link> </prompt>cat fdb-status.py #! /usr/bin/env nix-shell @@ -96,56 +111,91 @@ FoundationDB available: True </para> <para> - 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. + 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. </para> <para> - 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>.) + 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>.) </para> <para> - Furthermore, only 1 server process and 1 backup agent are started in the default configuration. See below for more on scaling to increase this. + Furthermore, only 1 server process and 1 backup agent are started in the + default configuration. See below for more on scaling to increase this. </para> <para> - 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. + 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. <programlisting> services.foundationdb.dataDir = "/data/fdb"; </programlisting> </para> <para> - Similarly, logs are stored under <filename>/var/log/foundationdb</filename> by default, and there is a corresponding <option>services.foundationdb.logDir</option> as well. + Similarly, logs are stored under <filename>/var/log/foundationdb</filename> + by default, and there is a corresponding + <option>services.foundationdb.logDir</option> as well. </para> </section> <section xml:id="module-services-foundationdb-scaling"> <title>Scaling processes and backup agents</title> <para> - 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. + 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. </para> <para> - 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. + 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. </para> <para> - 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. + 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. </para> </section> <section xml:id="module-services-foundationdb-clustering"> <title>Clustering</title> <para> - 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. + 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. </para> <para> - 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>. + 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>. </para> <para> - 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. + 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. </para> <para> @@ -166,7 +216,9 @@ services.foundationdb.dataDir = "/data/fdb"; </itemizedlist> <para> - 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. + 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. </para> <para> @@ -181,26 +233,37 @@ services.foundationdb.dataDir = "/data/fdb"; </listitem> <listitem> <para> - 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. + 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. </para> </listitem> <listitem> <para> - All of these servers are now connected and working together in the cluster, under the chosen coordinator. + All of these servers are now connected and working together in the + cluster, under the chosen coordinator. </para> </listitem> </itemizedlist> <para> - 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. + 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. </para> <para> - 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 + 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 </para> <para> - 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: + 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: </para> <screen> @@ -209,33 +272,58 @@ services.foundationdb.dataDir = "/data/fdb"; </screen> <para> - 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. + 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. </para> </section> <section xml:id="module-services-foundationdb-connectivity"> <title>Client connectivity</title> <para> - 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. + 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. </para> </section> <section xml:id="module-services-foundationdb-authorization"> <title>Client authorization and TLS</title> <para> - 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. + 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. </para> <para> - 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. + 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. </para> <para> - 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. + 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. </para> <para> - 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: + 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: </para> <programlisting> @@ -250,19 +338,36 @@ XXXXXX:XXXXXX@127.0.0.1:4500:tls <title>Backups and Disaster Recovery</title> <para> - 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. + 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. </para> <para> - 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. + 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. </para> <para> - 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. + 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. </para> <para> - For example, to create backups in <command>/opt/fdb-backups</command>, first set up the paths in the module options: + For example, to create backups in <command>/opt/fdb-backups</command>, first + set up the paths in the module options: </para> <programlisting> @@ -270,7 +375,11 @@ services.foundationdb.extraReadWritePaths = [ "/opt/fdb-backups" ]; </programlisting> <para> - 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). + 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). </para> <para> @@ -286,13 +395,17 @@ services.foundationdb.extraReadWritePaths = [ "/opt/fdb-backups" ]; <title>Known limitations</title> <para> - 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. + 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. </para> <itemizedlist> <listitem> <para> - 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. + 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. </para> </listitem> <listitem> @@ -311,14 +424,20 @@ services.foundationdb.extraReadWritePaths = [ "/opt/fdb-backups" ]; <title>Options</title> <para> - 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. + 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. </para> </section> <section xml:id="module-services-foundationdb-full-docs"> <title>Full documentation</title> <para> - 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/"/>. + 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/"/>. </para> </section> </chapter> diff --git a/nixos/modules/services/databases/postgresql.xml b/nixos/modules/services/databases/postgresql.xml index dc1bfb125a7..72d4a8249a3 100644 --- a/nixos/modules/services/databases/postgresql.xml +++ b/nixos/modules/services/databases/postgresql.xml @@ -7,10 +7,12 @@ <!-- FIXME: render nicely --> <!-- FIXME: source can be added automatically --> <para> - <emphasis>Source:</emphasis> <filename>modules/services/databases/postgresql.nix</filename> + <emphasis>Source:</emphasis> + <filename>modules/services/databases/postgresql.nix</filename> </para> <para> - <emphasis>Upstream documentation:</emphasis> <link xlink:href="http://www.postgresql.org/docs/"/> + <emphasis>Upstream documentation:</emphasis> + <link xlink:href="http://www.postgresql.org/docs/"/> </para> <!-- FIXME: more stuff, like maintainer? --> <para> @@ -21,12 +23,18 @@ <title>Configuring</title> <para> - To enable PostgreSQL, add the following to your <filename>configuration.nix</filename>: + To enable PostgreSQL, add the following to your + <filename>configuration.nix</filename>: <programlisting> <xref linkend="opt-services.postgresql.enable"/> = true; <xref linkend="opt-services.postgresql.package"/> = pkgs.postgresql_11; </programlisting> - 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. + 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. </para> <!-- @@ -43,7 +51,9 @@ Type "help" for help. --> <para> - 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. + 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. <programlisting> <xref linkend="opt-services.postgresql.dataDir"/> = "/data/postgresql"; </programlisting> @@ -60,14 +70,18 @@ Type "help" for help. <title>Options</title> <para> - A complete list of options for the PostgreSQL module may be found <link linkend="opt-services.postgresql.enable">here</link>. + A complete list of options for the PostgreSQL module may be found + <link linkend="opt-services.postgresql.enable">here</link>. </para> </section> <section xml:id="module-services-postgres-plugins"> <title>Plugins</title> <para> - 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>: + 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>: <screen> <prompt>$ </prompt>nix repl '<nixpkgs>' @@ -84,9 +98,8 @@ postgresql_11.pkgs.pg_partman postgresql_11.pkgs.pgroonga ... </screen> </para> - <para> - To add plugins via NixOS configuration, set <literal>services.postgresql.extraPlugins</literal>: + To add plugins via NixOS configuration, set <literal>services.postgresql.extraPlugins</literal>: <programlisting> <xref linkend="opt-services.postgresql.package"/> = pkgs.postgresql_11; <xref linkend="opt-services.postgresql.extraPlugins"/> = with pkgs.postgresql_11.pkgs; [ @@ -95,9 +108,10 @@ postgresql_11.pkgs.pg_partman postgresql_11.pkgs.pgroonga ]; </programlisting> </para> - <para> - 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: + 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: <programlisting> self: super: { postgresql_custom = self.postgresql_11.withPackages (ps: [ @@ -107,9 +121,8 @@ self: super: { } </programlisting> </para> - <para> - Here's a recipe on how to override a particular plugin through an overlay: + Here's a recipe on how to override a particular plugin through an overlay: <programlisting> self: super: { postgresql_11 = super.postgresql_11.override { this = self.postgresql_11; } // { diff --git a/nixos/modules/services/desktops/flatpak.xml b/nixos/modules/services/desktops/flatpak.xml index 3b2ccd12cf5..8f080b25022 100644 --- a/nixos/modules/services/desktops/flatpak.xml +++ b/nixos/modules/services/desktops/flatpak.xml @@ -5,33 +5,44 @@ xml:id="module-services-flatpak"> <title>Flatpak</title> <para> - <emphasis>Source:</emphasis> <filename>modules/services/desktop/flatpak.nix</filename> + <emphasis>Source:</emphasis> + <filename>modules/services/desktop/flatpak.nix</filename> </para> <para> - <emphasis>Upstream documentation:</emphasis> <link xlink:href="https://github.com/flatpak/flatpak/wiki"/> + <emphasis>Upstream documentation:</emphasis> + <link xlink:href="https://github.com/flatpak/flatpak/wiki"/> </para> <para> - Flatpak is a system for building, distributing, and running sandboxed desktop applications on Linux. + Flatpak is a system for building, distributing, and running sandboxed desktop + applications on Linux. </para> <para> - To enable Flatpak, add the following to your <filename>configuration.nix</filename>: + To enable Flatpak, add the following to your + <filename>configuration.nix</filename>: <programlisting> <xref linkend="opt-services.flatpak.enable"/> = true; </programlisting> </para> <para> - 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>: + 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>: <programlisting> <xref linkend="opt-xdg.portal.extraPortals"/> = [ pkgs.xdg-desktop-portal-gtk ]; </programlisting> </para> <para> - 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: + 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: <screen> <prompt>$ </prompt>flatpak remote-add --if-not-exists flathub https://flathub.org/repo/flathub.flatpakrepo <prompt>$ </prompt>flatpak update </screen> - or by opening the <link xlink:href="https://flathub.org/repo/flathub.flatpakrepo">repository file</link> in GNOME Software. + or by opening the + <link xlink:href="https://flathub.org/repo/flathub.flatpakrepo">repository + file</link> in GNOME Software. </para> <para> Finally, you can search and install programs: diff --git a/nixos/modules/services/editors/emacs.xml b/nixos/modules/services/editors/emacs.xml index 0213b8971c2..03483f69fa2 100644 --- a/nixos/modules/services/editors/emacs.xml +++ b/nixos/modules/services/editors/emacs.xml @@ -12,26 +12,41 @@ Adam Hoese @adisbladis --> <para> - <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. + <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. </para> <para> - 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. + 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. </para> <para> - <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. + <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. </para> <section xml:id="module-services-emacs-installing"> <title>Installing <application>Emacs</application></title> <para> - 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. + 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. </para> <section xml:id="module-services-emacs-releases"> <title>The Different Releases of Emacs</title> <para> - <productname>Nixpkgs</productname> defines several basic Emacs packages. The following are attributes belonging to the <varname>pkgs</varname> set: + <productname>Nixpkgs</productname> defines several basic Emacs packages. + The following are attributes belonging to the <varname>pkgs</varname> set: <variablelist> <varlistentry> <term> @@ -42,8 +57,10 @@ </term> <listitem> <para> - The latest stable version of Emacs 25 using the <link - xlink:href="http://www.gtk.org">GTK 2</link> widget toolkit. + The latest stable version of Emacs 25 using the + <link + xlink:href="http://www.gtk.org">GTK 2</link> + widget toolkit. </para> </listitem> </varlistentry> @@ -66,7 +83,8 @@ </term> <listitem> <para> - Emacs 25 with the "Mac port" patches, providing a more native look and feel under macOS. + Emacs 25 with the "Mac port" patches, providing a more native look and + feel under macOS. </para> </listitem> </varlistentry> @@ -74,7 +92,12 @@ </para> <para> - 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>. + 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>. </para> </section> @@ -82,20 +105,36 @@ <title>Adding Packages to Emacs</title> <para> - Emacs includes an entire ecosystem of functionality beyond text editing, including a project planner, mail and news reader, debugger interface, calendar, and more. + Emacs includes an entire ecosystem of functionality beyond text editing, + including a project planner, mail and news reader, debugger interface, + calendar, and more. </para> <para> - Most extensions are gotten with the Emacs packaging system (<filename>package.el</filename>) from <link - 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. + Most extensions are gotten with the Emacs packaging system + (<filename>package.el</filename>) from + <link + 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. </para> <para> - 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. + 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. </para> <para> - 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: + 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: <example xml:id="ex-emacsNix"> <title>Nix expression to build Emacs with packages (<filename>emacs.nix</filename>)</title> <programlisting language="nix"> @@ -137,27 +176,36 @@ in <calloutlist> <callout arearefs="ex-emacsNix-1"> <para> - The first non-comment line in this file (<literal>{ pkgs ? ... }</literal>) indicates that the whole file represents a function. + The first non-comment line in this file (<literal>{ pkgs ? ... + }</literal>) indicates that the whole file represents a function. </para> </callout> <callout arearefs="ex-emacsNix-2"> <para> - 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. + 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. </para> </callout> <callout arearefs="ex-emacsNix-3"> <para> - 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). + 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). </para> </callout> <callout arearefs="ex-emacsNix-4"> <para> - 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. + 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. </para> </callout> <callout arearefs="ex-emacsNix-5"> <para> - Two packages (<varname>undo-tree</varname> and <varname>zoom-frm</varname>) are taken from MELPA. + Two packages (<varname>undo-tree</varname> and + <varname>zoom-frm</varname>) are taken from MELPA. </para> </callout> <callout arearefs="ex-emacsNix-6"> @@ -167,14 +215,17 @@ in </callout> <callout arearefs="ex-emacsNix-7"> <para> - <varname>notmuch</varname> is taken from a nixpkgs derivation which contains an Emacs mode. + <varname>notmuch</varname> is taken from a nixpkgs derivation which + contains an Emacs mode. </para> </callout> </calloutlist> </para> <para> - 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>. + 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>. </para> <para> @@ -183,17 +234,23 @@ in <prompt>$ </prompt>nix-build emacs.nix <prompt>$ </prompt>./result/bin/emacs -q </screen> - 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 <RET> zerodark <RET> y</literal>. + 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 <RET> + zerodark <RET> y</literal>. </para> <tip> <para> - A few popular extensions worth checking out are: auctex, company, edit-server, flycheck, helm, iedit, magit, multiple-cursors, projectile, and yasnippet. + A few popular extensions worth checking out are: auctex, company, + edit-server, flycheck, helm, iedit, magit, multiple-cursors, projectile, + and yasnippet. </para> </tip> <para> - The list of available packages in the various ELPA repositories can be seen with the following commands: + The list of available packages in the various ELPA repositories can be seen + with the following commands: <example xml:id="module-services-emacs-querying-packages"> <title>Querying Emacs packages</title> <programlisting><![CDATA[ @@ -206,7 +263,10 @@ nix-env -f "<nixpkgs>" -qaP -A emacsPackages.orgPackages </para> <para> - 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: + 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: <example xml:id="module-services-emacs-configuration-nix"> <title>Custom Emacs in <filename>configuration.nix</filename></title> <programlisting><![CDATA[ @@ -221,7 +281,9 @@ nix-env -f "<nixpkgs>" -qaP -A emacsPackages.orgPackages </para> <para> - 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" />). + 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" />). </para> <!-- fixme: i think the following is better done with config.nix @@ -229,7 +291,11 @@ https://nixos.org/nixpkgs/manual/#sec-modify-via-packageOverrides --> <para> - 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>): + 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>): <example xml:id="module-services-emacs-config-nix"> <title>Custom Emacs in <filename>~/.config/nixpkgs/config.nix</filename></title> <programlisting><![CDATA[ @@ -243,7 +309,9 @@ https://nixos.org/nixpkgs/manual/#sec-modify-via-packageOverrides </para> <para> - In this case, the next <literal>nix-env -f '<nixpkgs>' -iA myemacs</literal> will take care of adding your emacs to the <varname>PATH</varname> environment variable. + In this case, the next <literal>nix-env -f '<nixpkgs>' -iA + myemacs</literal> will take care of adding your emacs to the + <varname>PATH</varname> environment variable. </para> </section> @@ -251,7 +319,12 @@ https://nixos.org/nixpkgs/manual/#sec-modify-via-packageOverrides <title>Advanced Emacs Configuration</title> <para> - 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: + 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: </para> <example xml:id="ex-emacsGtk3Nix"> @@ -275,7 +348,8 @@ in [...] </example> <para> - 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. + 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. </para> </section> </section> @@ -283,18 +357,23 @@ in [...] <title>Running Emacs as a Service</title> <para> - <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. + <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. </para> <para> - <emphasis>Source:</emphasis> <filename>modules/services/editors/emacs.nix</filename> + <emphasis>Source:</emphasis> + <filename>modules/services/editors/emacs.nix</filename> </para> <section xml:id="module-services-emacs-enabling"> <title>Enabling the Service</title> <para> - To install and enable the <command>systemd</command> user service for Emacs daemon, add the following to your <filename>configuration.nix</filename>: + To install and enable the <command>systemd</command> user service for Emacs + daemon, add the following to your <filename>configuration.nix</filename>: <programlisting> <xref linkend="opt-services.emacs.enable"/> = true; <xref linkend="opt-services.emacs.package"/> = import /home/cassou/.emacs.d { pkgs = pkgs; }; @@ -302,11 +381,16 @@ in [...] </para> <para> - The <varname>services.emacs.package</varname> option allows a custom derivation to be used, for example, one created by <function>emacsWithPackages</function>. + The <varname>services.emacs.package</varname> option allows a custom + derivation to be used, for example, one created by + <function>emacsWithPackages</function>. </para> <para> - 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>. + 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>. </para> <para> @@ -324,7 +408,9 @@ in [...] <title>Starting the client</title> <para> - 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>. + 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>. </para> <para> @@ -343,15 +429,23 @@ emacsclient --create-frame --tty # opens a new frame on the current terminal <!--<title><command>emacsclient</command> as the Default Editor</title>--> <para> - 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>. + 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>. </para> <para> - 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. + 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. </para> <para> - If you have formed certain bad habits when editing files, these can be corrected with a shell alias to the wrapper script: + If you have formed certain bad habits when editing files, these can be + corrected with a shell alias to the wrapper script: <programlisting>alias vi=$EDITOR</programlisting> </para> </section> @@ -360,7 +454,10 @@ emacsclient --create-frame --tty # opens a new frame on the current terminal <title>Per-User Enabling of the Service</title> <para> - 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: + 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: <programlisting> <xref linkend="opt-services.emacs.enable"/> = false; <xref linkend="opt-services.emacs.install"/> = true; @@ -368,9 +465,11 @@ emacsclient --create-frame --tty # opens a new frame on the current terminal </para> <para> - To enable the <command>systemd</command> user service for just the currently logged in user, run: + To enable the <command>systemd</command> user service for just the + currently logged in user, run: <programlisting>systemctl --user enable emacs</programlisting> - This will add the symlink <filename>~/.config/systemd/user/emacs.service</filename>. + This will add the symlink + <filename>~/.config/systemd/user/emacs.service</filename>. </para> </section> </section> @@ -378,7 +477,8 @@ emacsclient --create-frame --tty # opens a new frame on the current terminal <title>Configuring Emacs</title> <para> - The Emacs init file should be changed to load the extension packages at startup: + The Emacs init file should be changed to load the extension packages at + startup: <example xml:id="module-services-emacs-package-initialisation"> <title>Package initialization in <filename>.emacs</filename></title> <programlisting><![CDATA[ @@ -394,7 +494,10 @@ emacsclient --create-frame --tty # opens a new frame on the current terminal </para> <para> - 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). + 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). </para> <!-- @@ -406,7 +509,9 @@ emacsclient --create-frame --tty # opens a new frame on the current terminal <title>A Major Mode for Nix Expressions</title> <para> - 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. + 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. </para> </section> @@ -414,7 +519,9 @@ emacsclient --create-frame --tty # opens a new frame on the current terminal <title>Accessing man pages</title> <para> - You can use <function>woman</function> to get completion of all available man pages. For example, type <literal>M-x woman <RET> nixos-rebuild <RET>.</literal> + You can use <function>woman</function> to get completion of all available + man pages. For example, type <literal>M-x woman <RET> nixos-rebuild + <RET>.</literal> </para> </section> @@ -422,17 +529,29 @@ emacsclient --create-frame --tty # opens a new frame on the current terminal <title>Editing DocBook 5 XML Documents</title> <para> - Emacs includes <link - 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. + Emacs includes + <link + 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. </para> <para> - To install the DocBook 5.0 schemas, either add <varname>pkgs.docbook5</varname> to <xref linkend="opt-environment.systemPackages"/> (<link - linkend="sec-declarative-package-mgmt">NixOS</link>), or run <literal>nix-env -f '<nixpkgs>' -iA docbook5</literal> (<link linkend="sec-ad-hoc-packages">Nix</link>). + To install the DocBook 5.0 schemas, either add + <varname>pkgs.docbook5</varname> to + <xref linkend="opt-environment.systemPackages"/> + (<link + linkend="sec-declarative-package-mgmt">NixOS</link>), or run + <literal>nix-env -f '<nixpkgs>' -iA docbook5</literal> + (<link linkend="sec-ad-hoc-packages">Nix</link>). </para> <para> - 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: + 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: <example xml:id="ex-emacs-docbook-xml"> <title>nXML Schema Configuration (<filename>~/.emacs.d/schemas.xml</filename>)</title> <programlisting language="xml"><![CDATA[ diff --git a/nixos/modules/services/hardware/trezord.xml b/nixos/modules/services/hardware/trezord.xml index 4af6e1ad7cc..972d409d9d0 100644 --- a/nixos/modules/services/hardware/trezord.xml +++ b/nixos/modules/services/hardware/trezord.xml @@ -5,10 +5,16 @@ xml:id="trezor"> <title>Trezor</title> <para> - Trezor is an open-source cryptocurrency hardware wallet and security token allowing secure storage of private keys. + Trezor is an open-source cryptocurrency hardware wallet and security token + allowing secure storage of private keys. </para> <para> - 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"/>. + 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"/>. </para> <para> To enable Trezor support, add the following to your <filename>configuration.nix</filename>: diff --git a/nixos/modules/services/misc/gitlab.xml b/nixos/modules/services/misc/gitlab.xml index a59f8919a47..b6171a9a194 100644 --- a/nixos/modules/services/misc/gitlab.xml +++ b/nixos/modules/services/misc/gitlab.xml @@ -11,11 +11,14 @@ <title>Prerequisites</title> <para> - 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. + 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. </para> <para> - For instance, the following configuration could be used to use nginx as frontend proxy: + For instance, the following configuration could be used to use nginx as + frontend proxy: <programlisting> <link linkend="opt-services.nginx.enable">services.nginx</link> = { <link linkend="opt-services.nginx.enable">enable</link> = true; @@ -36,11 +39,14 @@ <title>Configuring</title> <para> - 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. + 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. </para> <para> - The default state dir is <literal>/var/gitlab/state</literal>. This is where all data like the repositories and uploads will be stored. + The default state dir is <literal>/var/gitlab/state</literal>. This is where + all data like the repositories and uploads will be stored. </para> <para> @@ -79,19 +85,31 @@ services.gitlab = { </para> <para> - If you're setting up a new Gitlab instance, generate new secrets. You for instance use <literal>tr -dc A-Za-z0-9 < /dev/urandom | head -c 128 > /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 - 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. + If you're setting up a new Gitlab instance, generate new + secrets. You for instance use <literal>tr -dc A-Za-z0-9 < + /dev/urandom | head -c 128 > /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 + 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. </para> <para> - Refer to <xref linkend="ch-options" /> for all available configuration options for the <link linkend="opt-services.gitlab.enable">services.gitlab</link> module. + Refer to <xref linkend="ch-options" /> for all available configuration + options for the + <link linkend="opt-services.gitlab.enable">services.gitlab</link> module. </para> </section> <section xml:id="module-services-gitlab-maintenance"> <title>Maintenance</title> <para> - 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. + 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. </para> <para> diff --git a/nixos/modules/services/misc/taskserver/doc.xml b/nixos/modules/services/misc/taskserver/doc.xml index 902ed14940e..5656bb85b37 100644 --- a/nixos/modules/services/misc/taskserver/doc.xml +++ b/nixos/modules/services/misc/taskserver/doc.xml @@ -4,58 +4,87 @@ xml:id="module-taskserver"> <title>Taskserver</title> <para> - Taskserver is the server component of <link xlink:href="https://taskwarrior.org/">Taskwarrior</link>, a free and open source todo list application. + Taskserver is the server component of + <link xlink:href="https://taskwarrior.org/">Taskwarrior</link>, a free and + open source todo list application. </para> <para> - <emphasis>Upstream documentation:</emphasis> <link xlink:href="https://taskwarrior.org/docs/#taskd"/> + <emphasis>Upstream documentation:</emphasis> + <link xlink:href="https://taskwarrior.org/docs/#taskd"/> </para> <section xml:id="module-services-taskserver-configuration"> <title>Configuration</title> <para> - 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>. + 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>. </para> <para> - 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. + 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. </para> <para> - 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. + 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. </para> <para> - 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. + 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. </para> </section> <section xml:id="module-services-taskserver-nixos-taskserver-tool"> <title>The nixos-taskserver tool</title> <para> - 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. + 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. </para> <para> - The tool is designed to not interfere if the command is used to manually set up some organisations, users or groups. + The tool is designed to not interfere if the command is used to manually set + up some organisations, users or groups. </para> <para> - 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. + 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. </para> <para> - 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. + 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. </para> </section> <section xml:id="module-services-taskserver-declarative-ca-management"> <title>Declarative/automatic CA management</title> <para> - 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. + 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. </para> <para> - 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. + 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. </para> <para> @@ -68,30 +97,39 @@ <link linkend="opt-services.taskserver.organisations._name_.users">services.taskserver.organisations.my-company.users</link> = [ "alice" ]; } </screen> - This creates an organisation called <literal>my-company</literal> with the user <literal>alice</literal>. + This creates an organisation called <literal>my-company</literal> with the + user <literal>alice</literal>. </para> <para> - 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: + 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: <screen> <prompt>$ </prompt>ssh server nixos-taskserver user export my-company alice | sh </screen> - Of course, if no SSH daemon is available on the server you can also copy & paste it directly into a shell. + Of course, if no SSH daemon is available on the server you can also copy + & paste it directly into a shell. </para> <para> - 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>. + 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>. </para> <para> - Subsequent synchronisation requests merely require the command <command>task sync</command> after that stage. + Subsequent synchronisation requests merely require the command <command>task + sync</command> after that stage. </para> </section> <section xml:id="module-services-taskserver-manual-ca-management"> <title>Manual CA management</title> <para> - 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. + 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. </para> </section> </chapter> diff --git a/nixos/modules/services/misc/weechat.xml b/nixos/modules/services/misc/weechat.xml index 34bfffe15d8..7255edfb9da 100644 --- a/nixos/modules/services/misc/weechat.xml +++ b/nixos/modules/services/misc/weechat.xml @@ -5,13 +5,18 @@ xml:id="module-services-weechat"> <title>WeeChat</title> <para> - <link xlink:href="https://weechat.org/">WeeChat</link> is a fast and extensible IRC client. + <link xlink:href="https://weechat.org/">WeeChat</link> is a fast and + extensible IRC client. </para> <section xml:id="module-services-weechat-basic-usage"> <title>Basic Usage</title> <para> - 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. + 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. </para> <para> @@ -26,14 +31,19 @@ </para> <para> - The service is managed by a dedicated user named <literal>weechat</literal> in the state directory <literal>/var/lib/weechat</literal>. + The service is managed by a dedicated user named <literal>weechat</literal> + in the state directory <literal>/var/lib/weechat</literal>. </para> </section> <section xml:id="module-services-weechat-reattach"> <title>Re-attaching to WeeChat</title> <para> - 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: + 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: <programlisting> { <link linkend="opt-programs.screen.screenrc">programs.screen.screenrc</link> = '' @@ -49,7 +59,8 @@ screen -x weechat/weechat-screen </para> <para> - <emphasis>The session name can be changed using <link linkend="opt-services.weechat.sessionName">services.weechat.sessionName.</link></emphasis> + <emphasis>The session name can be changed using + <link linkend="opt-services.weechat.sessionName">services.weechat.sessionName.</link></emphasis> </para> </section> </chapter> diff --git a/nixos/modules/services/monitoring/prometheus/exporters.xml b/nixos/modules/services/monitoring/prometheus/exporters.xml index 814e7365584..c2d4b05996a 100644 --- a/nixos/modules/services/monitoring/prometheus/exporters.xml +++ b/nixos/modules/services/monitoring/prometheus/exporters.xml @@ -5,13 +5,17 @@ xml:id="module-services-prometheus-exporters"> <title>Prometheus exporters</title> <para> - Prometheus exporters provide metrics for the <link xlink:href="https://prometheus.io">prometheus monitoring system</link>. + Prometheus exporters provide metrics for the + <link xlink:href="https://prometheus.io">prometheus monitoring system</link>. </para> <section xml:id="module-services-prometheus-exporters-configuration"> <title>Configuration</title> <para> - 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: + 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: <programlisting> services.prometheus.exporters.node = { enable = true; @@ -26,20 +30,34 @@ firewallFilter = "-i br0 -p tcp -m tcp --dport 9100"; }; </programlisting> - 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>. + 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>. </para> </section> <section xml:id="module-services-prometheus-exporters-new-exporter"> <title>Adding a new exporter</title> <para> - 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: + 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: </para> <itemizedlist> <listitem> <para> - Some default options for all exporters are provided by <literal>nixpkgs/nixos/modules/services/monitoring/prometheus/exporters.nix</literal>: + Some default options for all exporters are provided by + <literal>nixpkgs/nixos/modules/services/monitoring/prometheus/exporters.nix</literal>: </para> </listitem> <listitem override='none'> @@ -88,7 +106,11 @@ </listitem> <listitem> <para> - 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: + 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: <programlisting> # nixpgs/nixos/modules/services/prometheus/exporters/postfix.nix { config, lib, pkgs, options }: @@ -155,16 +177,21 @@ in </listitem> <listitem> <para> - 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> + 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> </para> </listitem> </itemizedlist> </section> <section xml:id="module-services-prometheus-exporters-update-exporter-module"> <title>Updating an exporter module</title> - - <para> - 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>: + <para> + 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>: <programlisting> { config, lib, pkgs, options }: @@ -195,6 +222,6 @@ in ]; } </programlisting> - </para> - </section> + </para> + </section> </chapter> diff --git a/nixos/modules/services/networking/dnscrypt-proxy.xml b/nixos/modules/services/networking/dnscrypt-proxy.xml index 04e2654d3cc..afc7880392a 100644 --- a/nixos/modules/services/networking/dnscrypt-proxy.xml +++ b/nixos/modules/services/networking/dnscrypt-proxy.xml @@ -5,7 +5,11 @@ xml:id="sec-dnscrypt-proxy"> <title>DNSCrypt client proxy</title> <para> - 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). + 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). </para> <sect1 xml:id="sec-dnscrypt-proxy-configuration"> <title>Basic configuration</title> @@ -18,14 +22,18 @@ </para> <para> - 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>. + 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>. </para> </sect1> <sect1 xml:id="sec-dnscrypt-proxy-forwarder"> <title>As a forwarder for another DNS client</title> <para> - 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: + 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: <programlisting> <xref linkend="opt-services.dnscrypt-proxy.localPort"/> = 43; </programlisting> diff --git a/nixos/modules/services/web-apps/matomo-doc.xml b/nixos/modules/services/web-apps/matomo-doc.xml index 2ab476f892c..8485492c51c 100644 --- a/nixos/modules/services/web-apps/matomo-doc.xml +++ b/nixos/modules/services/web-apps/matomo-doc.xml @@ -5,16 +5,21 @@ xml:id="module-services-matomo"> <title>Matomo</title> <para> - Matomo is a real-time web analytics application. This module configures php-fpm as backend for Matomo, optionally configuring an nginx vhost as well. + Matomo is a real-time web analytics application. This module configures + php-fpm as backend for Matomo, optionally configuring an nginx vhost as well. </para> <para> - An automatic setup is not suported by Matomo, so you need to configure Matomo itself in the browser-based Matomo setup. + An automatic setup is not suported by Matomo, so you need to configure Matomo + itself in the browser-based Matomo setup. </para> <section xml:id="module-services-matomo-database-setup"> <title>Database Setup</title> <para> - 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: + 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: <programlisting> # For MariaDB INSTALL PLUGIN unix_socket SONAME 'auth_socket'; @@ -28,29 +33,51 @@ CREATE DATABASE matomo; CREATE USER 'matomo'@'localhost' IDENTIFIED WITH auth_socket; GRANT ALL PRIVILEGES ON matomo.* TO 'matomo'@'localhost'; </programlisting> - 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/" />. + 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/" />. </para> <para> - Of course, you can use password based authentication as well, e.g. when the database is not on the same host. + Of course, you can use password based authentication as well, e.g. when the + database is not on the same host. </para> </section> <section xml:id="module-services-matomo-archive-processing"> <title>Archive Processing</title> <para> - 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>. + 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>. </para> <para> - 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. + 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. </para> </section> <section xml:id="module-services-matomo-backups"> <title>Backup</title> <para> - 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/" />. + 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/" />. </para> </section> <section xml:id="module-services-matomo-issues"> @@ -59,12 +86,15 @@ GRANT ALL PRIVILEGES ON matomo.* TO 'matomo'@'localhost'; <itemizedlist> <listitem> <para> - Matomo's file integrity check will warn you. This is due to the patches necessary for NixOS, you can safely ignore this. + Matomo's file integrity check will warn you. This is due to the patches + necessary for NixOS, you can safely ignore this. </para> </listitem> <listitem> <para> - 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. + 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. </para> </listitem> </itemizedlist> @@ -73,7 +103,11 @@ GRANT ALL PRIVILEGES ON matomo.* TO 'matomo'@'localhost'; <title>Using other Web Servers than nginx</title> <para> - 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. + 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. </para> </section> </chapter> diff --git a/nixos/modules/services/web-apps/nextcloud.xml b/nixos/modules/services/web-apps/nextcloud.xml index 4345c2b9810..d66e0f0c299 100644 --- a/nixos/modules/services/web-apps/nextcloud.xml +++ b/nixos/modules/services/web-apps/nextcloud.xml @@ -5,13 +5,21 @@ xml:id="module-services-nextcloud"> <title>Nextcloud</title> <para> - <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>. + <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>. </para> <section xml:id="module-services-nextcloud-basic-usage"> <title>Basic usage</title> <para> - 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>). + 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>). </para> <para> @@ -53,38 +61,57 @@ </para> <para> - 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. + 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. </para> <para> - 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>. + 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>. </para> <para> - Auto updates for Nextcloud apps can be enabled using <literal><link linkend="opt-services.nextcloud.autoUpdateApps.enable">services.nextcloud.autoUpdateApps</link></literal>. - </para> + Auto updates for Nextcloud apps can be enabled using + <literal><link linkend="opt-services.nextcloud.autoUpdateApps.enable">services.nextcloud.autoUpdateApps</link></literal>. +</para> + </section> <section xml:id="module-services-nextcloud-pitfalls-during-upgrade"> <title>Pitfalls</title> <para> - 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). + 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). </para> <para> - 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. + 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. </para> <warning> - <para> - Don't delete <literal>config.php</literal>! This file tracks the application's state and a deletion can cause unwanted side-effects! - </para> + <para>Don't delete <literal>config.php</literal>! This file + tracks the application's state and a deletion can cause unwanted + side-effects!</para> </warning> <warning> - <para> - Don't rerun <literal>nextcloud-occ maintenance:install</literal>! This command tries to install the application and can cause unwanted side-effects! - </para> + <para>Don't rerun <literal>nextcloud-occ + maintenance:install</literal>! This command tries to install the application + and can cause unwanted side-effects!</para> </warning> </section> </chapter> diff --git a/nixos/modules/services/x11/desktop-managers/xfce4-14.nix b/nixos/modules/services/x11/desktop-managers/xfce4-14.nix index 458d4a2f422..130e865a1fb 100644 --- a/nixos/modules/services/x11/desktop-managers/xfce4-14.nix +++ b/nixos/modules/services/x11/desktop-managers/xfce4-14.nix @@ -53,6 +53,7 @@ in glib # for gsettings gtk3.out # gtk-update-icon-cache + gnome3.gnome-themes-extra gnome3.adwaita-icon-theme hicolor-icon-theme tango-icon-theme @@ -69,16 +70,17 @@ in exo garcon - gtk-xfce-engine libxfce4ui xfconf mousepad + parole ristretto xfce4-appfinder xfce4-screenshooter xfce4-session xfce4-settings + xfce4-taskmanager xfce4-terminal # TODO: resync patch for plugins @@ -86,12 +88,16 @@ in thunar ] # TODO: NetworkManager doesn't belong here ++ optional config.networking.networkmanager.enable networkmanagerapplet - ++ optional config.hardware.pulseaudio.enable xfce4-pulseaudio-plugin ++ optional config.powerManagement.enable xfce4-power-manager - ++ optional cfg.enableXfwm xfwm4 - ++ optionals (!cfg.noDesktop) [ - xfce4-panel + ++ optionals config.hardware.pulseaudio.enable [ + pavucontrol + xfce4-pulseaudio-plugin + ] ++ optionals cfg.enableXfwm [ + xfwm4 + xfwm4-themes + ] ++ optionals (!cfg.noDesktop) [ xfce4-notifyd + xfce4-panel xfdesktop ]; diff --git a/nixos/modules/services/x11/desktop-managers/xterm.nix b/nixos/modules/services/x11/desktop-managers/xterm.nix index 1408df31295..f76db278a92 100644 --- a/nixos/modules/services/x11/desktop-managers/xterm.nix +++ b/nixos/modules/services/x11/desktop-managers/xterm.nix @@ -5,6 +5,7 @@ with lib; let cfg = config.services.xserver.desktopManager.xterm; + xSessionEnabled = config.services.xserver.enable; in @@ -13,7 +14,8 @@ in services.xserver.desktopManager.xterm.enable = mkOption { type = types.bool; - default = (versionOlder config.system.stateVersion "19.09"); + default = (versionOlder config.system.stateVersion "19.09") && xSessionEnabled; + defaultText = if versionOlder config.system.stateVersion "19.09" then "config.services.xserver.enable" else "false"; description = "Enable a xterm terminal as a desktop manager."; }; diff --git a/pkgs/applications/audio/osmid/default.nix b/pkgs/applications/audio/osmid/default.nix new file mode 100644 index 00000000000..7e49b872a6a --- /dev/null +++ b/pkgs/applications/audio/osmid/default.nix @@ -0,0 +1,37 @@ +{ stdenv +, fetchFromGitHub +, cmake +, alsaLib +, libX11 +}: + +stdenv.mkDerivation rec { + pname = "osmid"; + version = "0.6.8"; + + src = fetchFromGitHub { + owner = "llloret"; + repo = "osmid"; + rev = "v${version}"; + sha256 = "1yl25abf343yvd49nfsgxsz7jf956zrsi5n4xyqb5ldlp2hifk15"; + }; + + nativeBuildInputs = [ cmake ]; + + buildInputs = [ alsaLib libX11 ]; + + installPhase = '' + runHook preInstall + mkdir -p $out/bin + cp {m2o,o2m} $out/bin/ + runHook postInstall + ''; + + meta = with stdenv.lib; { + homepage = "https://github.com/llloret/osmid"; + description = "A lightweight, portable, easy to use tool to convert MIDI to OSC and OSC to MIDI"; + license = licenses.mit; + maintainers = with maintainers; [ c0deaddict ]; + platforms = platforms.linux; + }; +} diff --git a/pkgs/applications/blockchains/jormungandr/default.nix b/pkgs/applications/blockchains/jormungandr/default.nix index 541ef49ef5a..0bc766a43bb 100644 --- a/pkgs/applications/blockchains/jormungandr/default.nix +++ b/pkgs/applications/blockchains/jormungandr/default.nix @@ -10,12 +10,12 @@ rustPlatform.buildRustPackage rec { pname = "jormungandr"; - version = "0.3.1415"; + version = "0.3.9999"; src = fetchgit { url = "https://github.com/input-output-hk/${pname}"; rev = "v${version}"; - sha256 = "1kg20570ri3bj99gicpp2z272igj9s7m2qw0z1ndk60bxcyghi2x"; + sha256 = "11lr533fpispwbk4vsq9bnv40gkpybvpa7ajwczv9ky6afh8np5b"; fetchSubmodules = true; }; diff --git a/pkgs/applications/editors/jetbrains/common.nix b/pkgs/applications/editors/jetbrains/common.nix index be20800cde2..f535d7bff47 100644 --- a/pkgs/applications/editors/jetbrains/common.nix +++ b/pkgs/applications/editors/jetbrains/common.nix @@ -77,4 +77,6 @@ with stdenv; lib.makeOverridable mkDerivation rec { ln -s "$item/share/applications" $out/share ''; +} // stdenv.lib.optionalAttrs (!(meta.license.free or true)) { + preferLocalBuild = true; } diff --git a/pkgs/applications/editors/jetbrains/default.nix b/pkgs/applications/editors/jetbrains/default.nix index a33b9531730..a302be304e5 100644 --- a/pkgs/applications/editors/jetbrains/default.nix +++ b/pkgs/applications/editors/jetbrains/default.nix @@ -1,6 +1,6 @@ { lib, stdenv, callPackage, fetchurl , python -, jdk, cmake, libxml2, zlib, python3, ncurses +, jdk, cmake, libxml2, zlib, python3, ncurses5 }: with stdenv.lib; @@ -34,7 +34,7 @@ let lldbLibPath=$out/clion-${version}/bin/lldb/linux/lib interp="$(cat $NIX_CC/nix-support/dynamic-linker)" - ln -s ${ncurses.out}/lib/libncurses.so $lldbLibPath/libtinfo.so.5 + ln -s ${ncurses5.out}/lib/libtinfo.so.5 $lldbLibPath/libtinfo.so.5 patchelf --set-interpreter $interp \ --set-rpath "${lib.makeLibraryPath [ libxml2 zlib stdenv.cc.cc.lib ]}:$lldbLibPath" \ diff --git a/pkgs/applications/editors/neovim/neovim-remote.nix b/pkgs/applications/editors/neovim/neovim-remote.nix index 92ff745d1a6..6ad3983a531 100644 --- a/pkgs/applications/editors/neovim/neovim-remote.nix +++ b/pkgs/applications/editors/neovim/neovim-remote.nix @@ -4,14 +4,14 @@ with stdenv.lib; pythonPackages.buildPythonApplication rec { pname = "neovim-remote"; - version = "2.2.0"; + version = "2.2.1"; disabled = !pythonPackages.isPy3k; src = fetchFromGitHub { owner = "mhinz"; repo = "neovim-remote"; rev = "v${version}"; - sha256 = "0vvwygyar835z947d5zgjywyhl7ajj63z0l8sb7w9kj1w5snb43x"; + sha256 = "0f9x053yr8wq35l2s2dsnb0iygd4g4yya2h3iv0yh3440jjj5vfj"; }; propagatedBuildInputs = with pythonPackages; [ pynvim psutil ]; diff --git a/pkgs/applications/misc/pdfsam-basic/default.nix b/pkgs/applications/misc/pdfsam-basic/default.nix new file mode 100644 index 00000000000..30e68a89a1c --- /dev/null +++ b/pkgs/applications/misc/pdfsam-basic/default.nix @@ -0,0 +1,49 @@ +{ stdenv, makeDesktopItem, fetchurl, jdk11, wrapGAppsHook, glib }: + +stdenv.mkDerivation rec { + pname = "pdfsam-basic"; + version = "4.0.4"; + + src = fetchurl { + url = "https://github.com/torakiki/pdfsam/releases/download/v${version}/pdfsam_${version}-1_amd64.deb"; + sha256 = "17lhzxlgr4l4dljy0b0avfrgbj9rsfzk1dzg0abqvld4w4igkqbq"; + }; + + unpackPhase = '' + ar vx ${src} + tar xvf data.tar.gz + ''; + + nativeBuildInputs = [ wrapGAppsHook ]; + buildInputs = [ glib ]; + + preFixup = '' + gappsWrapperArgs+=(--set JAVA_HOME "${jdk11}" --set PDFSAM_JAVA_PATH "${jdk11}") + ''; + + installPhase = '' + cp -R opt/pdfsam-basic/ $out/ + mkdir -p "$out"/share/icons + cp --recursive ${desktopItem}/share/applications $out/share + cp $out/icon.svg "$out"/share/icons/pdfsam-basic.svg + ''; + + desktopItem = makeDesktopItem { + name = pname; + exec = pname; + icon = pname; + comment = meta.description; + desktopName = "PDFsam Basic"; + genericName = "PDF Split and Merge"; + mimeType = "application/pdf;"; + categories = "Office;Application;"; + }; + + meta = with stdenv.lib; { + homepage = "https://github.com/torakiki/pdfsam"; + description = "Multi-platform software designed to extract pages, split, merge, mix and rotate PDF files"; + license = licenses.agpl3; + platforms = platforms.all; + maintainers = with maintainers; [ maintainers."1000101" ]; + }; +} \ No newline at end of file diff --git a/pkgs/applications/misc/xmind/default.nix b/pkgs/applications/misc/xmind/default.nix index 0332de0195c..f65f5bc26e8 100644 --- a/pkgs/applications/misc/xmind/default.nix +++ b/pkgs/applications/misc/xmind/default.nix @@ -15,6 +15,8 @@ stdenv.mkDerivation rec { sha256 = "0jxq2fiq69q9ly0m6hx2qfybqad22sl42ciw636071khpqgc885f"; }; + preferLocalBuild = true; + patches = [ ./java-env-config-fixes.patch ]; nativeBuildInputs = [ makeWrapper ]; diff --git a/pkgs/applications/networking/browsers/chromium/common.nix b/pkgs/applications/networking/browsers/chromium/common.nix index 6d43c313cc0..4353d2958f5 100644 --- a/pkgs/applications/networking/browsers/chromium/common.nix +++ b/pkgs/applications/networking/browsers/chromium/common.nix @@ -138,6 +138,13 @@ let ./patches/jumbo-sorted.patch ./patches/no-build-timestamps.patch ./patches/widevine.patch + # Revert "Implement GetFallbackFont on Linux" to fix a performance regression + # Remove after https://bugs.chromium.org/p/chromium/issues/detail?id=1003997 is fixed + (fetchpatch { + url = "https://github.com/chromium/chromium/commit/5a32abe4247f80fdb55c55a289b906b0e42faa5f.patch"; + sha256 = "1a4jqmki6cyi2dwvaszh01db2diqnz1d50mhpdpby3dd1cw0xmfy"; + revert = true; + }) # Unfortunately, chromium regularly breaks on major updates and # then needs various patches backported in order to be compiled with GCC. @@ -227,8 +234,9 @@ let use_gold = true; gold_path = "${stdenv.cc}/bin"; is_debug = false; - # at least 2X compilation speedup - use_jumbo_build = true; + # Use jumbo for a 2x (at least) compilation speedup, except where it is currently broken: + # https://gist.github.com/ivan/6fe7014c1b1cc35dec133fa6de0549d9 + use_jumbo_build = (version != "78.0.3904.17"); proprietary_codecs = false; use_sysroot = false; diff --git a/pkgs/applications/networking/browsers/chromium/default.nix b/pkgs/applications/networking/browsers/chromium/default.nix index f099ddbff73..5fb0d67a480 100644 --- a/pkgs/applications/networking/browsers/chromium/default.nix +++ b/pkgs/applications/networking/browsers/chromium/default.nix @@ -50,6 +50,7 @@ in let widevine = let upstream-info = chromium.upstream-info; in stdenv.mkDerivation { name = "chromium-binary-plugin-widevine"; + # The .deb file for Google Chrome src = upstream-info.binary; nativeBuildInputs = [ patchelfUnstable ]; @@ -57,14 +58,21 @@ in let phases = [ "unpackPhase" "patchPhase" "installPhase" "checkPhase" ]; unpackCmd = let - chan = if upstream-info.channel == "dev" then "chrome-unstable" - else if upstream-info.channel == "stable" then "chrome" - else if upstream-info.channel == "beta" then "chrome-beta" - else throw "Unknown chromium channel."; + soPath = + if upstream-info.channel == "stable" then + "./opt/google/chrome/libwidevinecdm.so" + else if upstream-info.channel == "beta" then + "./opt/google/chrome-beta/libwidevinecdm.so" + else if upstream-info.channel == "dev" then + "./opt/google/chrome-unstable/WidevineCdm/_platform_specific/linux_x64/libwidevinecdm.so" + else + throw "Unknown chromium channel."; in '' mkdir -p plugins - ar p "$src" data.tar.xz | tar xJ -C plugins --strip-components=4 \ - ./opt/google/${chan}/libwidevinecdm.so + # Extract just libwidevinecdm.so from upstream's .deb file + ar p "$src" data.tar.xz | tar xJ -C plugins ${soPath} + mv plugins/${soPath} plugins/ + rm -rf plugins/opt ''; doCheck = true; @@ -83,7 +91,10 @@ in let "$out/lib/libwidevinecdm.so" ''; - meta.platforms = lib.platforms.x86_64; + meta = { + platforms = [ "x86_64-linux" ]; + license = lib.licenses.unfree; + }; }; suffix = if channel != "stable" then "-" + channel else ""; @@ -92,18 +103,21 @@ in let version = chromium.browser.version; - # This is here because we want to add the widevine shared object at the last - # minute in order to avoid a full rebuild of chromium. Additionally, this - # isn't in `browser.nix` so we can avoid having to re-expose attributes of - # the chromium derivation (see above: we introspect `sandboxExecutableName`). + # We want users to be able to enableWideVine without rebuilding all of + # chromium, so we have a separate derivation here that copies chromium + # and adds the unfree libwidevinecdm.so. chromiumWV = let browser = chromium.browser; in if enableWideVine then runCommand (browser.name + "-wv") { version = browser.version; } '' mkdir -p $out - cp -R ${browser}/* $out/ - chmod u+w $out/libexec/chromium* - cp ${widevine}/lib/libwidevinecdm.so $out/libexec/chromium/ - # patchelf? + cp -a ${browser}/* $out/ + chmod u+w $out/libexec/chromium + if [[ ${channel} != "dev" ]]; then + cp ${widevine}/lib/libwidevinecdm.so $out/libexec/chromium/ + else + mkdir -p $out/libexec/chromium/WidevineCdm/_platform_specific/linux_x64 + cp ${widevine}/lib/libwidevinecdm.so $out/libexec/chromium/WidevineCdm/_platform_specific/linux_x64/ + fi '' else browser; in stdenv.mkDerivation { diff --git a/pkgs/applications/networking/browsers/chromium/upstream-info.nix b/pkgs/applications/networking/browsers/chromium/upstream-info.nix index df2ce798f1f..b641d1163bc 100644 --- a/pkgs/applications/networking/browsers/chromium/upstream-info.nix +++ b/pkgs/applications/networking/browsers/chromium/upstream-info.nix @@ -1,18 +1,18 @@ # This file is autogenerated from update.sh in the same directory. { beta = { - sha256 = "12cp24h93b48pwfywf5b6qvjdlhxrhp87qdaqbfcn6g787r2z5gb"; - sha256bin64 = "0d9w869qqwbmw3qjvxkfm37i7dvrgmrwm5y96sm1dg2jnxqj4bdz"; - version = "77.0.3865.75"; + sha256 = "1hzgzmrn0d6cqvqnqayl048zwlcx0f7azg2rhvm7p13lvyqzsk00"; + sha256bin64 = "0p3275ii8800swlfmljbdrvyqjd5nlw0vgv2my4r8ccszgbhidbd"; + version = "77.0.3865.90"; }; dev = { - sha256 = "0x5r6xqwiggwyzbinm252xc1n3f9r7cmmzj6assi4v1nsispdh2k"; - sha256bin64 = "03yymhbpd1snycmcv7wkg5j6zbydvyc365gy5myp7wgas7cd0mb6"; - version = "78.0.3887.7"; + sha256 = "0zka01ml3hbximswzkkqbqq8wpiz8f4fq4wx5fys002hi69l296l"; + sha256bin64 = "0nrip45s0ylri34vlpf16xlwv3ybmy2jg7dz8l9rvgbdwwdzdb75"; + version = "78.0.3904.17"; }; stable = { - sha256 = "12cp24h93b48pwfywf5b6qvjdlhxrhp87qdaqbfcn6g787r2z5gb"; - sha256bin64 = "1wp5g09czyslkkhw3nhbp39fxfcz0pprsgj8h0aggghpdbvzph3d"; - version = "77.0.3865.75"; + sha256 = "1hzgzmrn0d6cqvqnqayl048zwlcx0f7azg2rhvm7p13lvyqzsk00"; + sha256bin64 = "1npx867j39mdyivf8nlkcfwgq7j34hl7s948vf6h2kqni0y50hzl"; + version = "77.0.3865.90"; }; } diff --git a/pkgs/applications/networking/browsers/firefox/packages.nix b/pkgs/applications/networking/browsers/firefox/packages.nix index 3e8cf4d66b9..51ad984f88e 100644 --- a/pkgs/applications/networking/browsers/firefox/packages.nix +++ b/pkgs/applications/networking/browsers/firefox/packages.nix @@ -32,6 +32,7 @@ rec { homepage = http://www.mozilla.com/en-US/firefox/; maintainers = with lib.maintainers; [ eelco andir ]; platforms = lib.platforms.unix; + badPlatforms = lib.platforms.darwin; license = lib.licenses.mpl20; }; updateScript = callPackage ./update.nix { diff --git a/pkgs/applications/networking/cluster/terraform/default.nix b/pkgs/applications/networking/cluster/terraform/default.nix index 9c07760355c..ec452a312e4 100644 --- a/pkgs/applications/networking/cluster/terraform/default.nix +++ b/pkgs/applications/networking/cluster/terraform/default.nix @@ -97,8 +97,8 @@ in rec { terraform_0_11-full = terraform_0_11.full; terraform_0_12 = pluggable (generic { - version = "0.12.8"; - sha256 = "1qlhbn6xj2nd8gwr6aiyjsb62qmj4j9jnxab006xgdr1avvl2p67"; + version = "0.12.9"; + sha256 = "14js4n08rg30y0jrm0na79syglpb64cb7cxys0x3w47pcbgymrka"; patches = [ ./provider-path.patch ]; passthru = { inherit plugins; }; }); diff --git a/pkgs/applications/networking/instant-messengers/pidgin-plugins/purple-slack/default.nix b/pkgs/applications/networking/instant-messengers/pidgin-plugins/purple-slack/default.nix new file mode 100644 index 00000000000..10973345dec --- /dev/null +++ b/pkgs/applications/networking/instant-messengers/pidgin-plugins/purple-slack/default.nix @@ -0,0 +1,28 @@ +{ stdenv, fetchFromGitHub, pidgin, pkgconfig }: + +stdenv.mkDerivation { + pname = "purple-slack-unstable"; + version = "2019-08-18"; + + src = fetchFromGitHub { + owner = "dylex"; + repo = "slack-libpurple"; + rev = "be97802c7fd0b611722d2f551756e2a2672f6084"; + sha256 = "0l6hwnnv6zzszxkk0a3nli88w5gijvlc9qgkkai0sb4v4c504y5v"; + }; + + nativeBuildInputs = [ pkgconfig ]; + buildInputs = [ pidgin ]; + + PKG_CONFIG_PURPLE_PLUGINDIR = "${placeholder "out"}/lib/purple-2"; + PKG_CONFIG_PURPLE_DATAROOTDIR = "${placeholder "out"}/share"; + + meta = with stdenv.lib; { + homepage = https://github.com/dylex/slack-libpurple; + description = "Slack plugin for Pidgin"; + license = licenses.gpl2; + platforms = platforms.linux; + maintainers = with maintainers; [ eyjhb ]; + }; +} + diff --git a/pkgs/applications/networking/remote/teamviewer/default.nix b/pkgs/applications/networking/remote/teamviewer/default.nix index f9b17b42bde..d9a3d4aefcd 100644 --- a/pkgs/applications/networking/remote/teamviewer/default.nix +++ b/pkgs/applications/networking/remote/teamviewer/default.nix @@ -54,6 +54,7 @@ mkDerivation rec { ''; dontStrip = true; + preferLocalBuild = true; meta = with lib; { homepage = http://www.teamviewer.com; diff --git a/pkgs/applications/radio/tlf/default.nix b/pkgs/applications/radio/tlf/default.nix index 92183306038..f45e695486d 100644 --- a/pkgs/applications/radio/tlf/default.nix +++ b/pkgs/applications/radio/tlf/default.nix @@ -1,5 +1,5 @@ { stdenv, fetchFromGitHub, autoreconfHook, autoconf, automake, pkgconfig, glib -, perl, ncurses, hamlib, xmlrpc_c }: +, perl, ncurses5, hamlib, xmlrpc_c }: stdenv.mkDerivation rec { pname = "tlf"; @@ -13,15 +13,13 @@ stdenv.mkDerivation rec { }; nativeBuildInputs = [ autoreconfHook autoconf automake pkgconfig perl ]; - buildInputs = [ glib ncurses hamlib xmlrpc_c ]; + buildInputs = [ glib ncurses5 hamlib xmlrpc_c ]; configureFlags = [ "--enable-hamlib" "--enable-fldigi-xmlrpc" ]; postInstall = '' mkdir -p $out/lib - - # Hack around lack of libtinfo in NixOS - ln -s ${ncurses.out}/lib/libncursesw.so.6 $out/lib/libtinfo.so.5 + ln -s ${ncurses5.out}/lib/libtinfo.so.5 $out/lib/libtinfo.so.5 ''; meta = with stdenv.lib; { diff --git a/pkgs/applications/science/electronics/kicad/default.nix b/pkgs/applications/science/electronics/kicad/default.nix index ac9362990a8..bd57e355c75 100644 --- a/pkgs/applications/science/electronics/kicad/default.nix +++ b/pkgs/applications/science/electronics/kicad/default.nix @@ -65,7 +65,7 @@ in stdenv.mkDerivation rec { buildInputs = [ libGLU_combined zlib libX11 wxGTK pcre libXdmcp glew glm libpthreadstubs cairo curl openssl boost - swig python + swig (python.withPackages (ps: with ps; [ wxPython ])) ] ++ optional (oceSupport) opencascade ++ optional (ngspiceSupport) libngspice; diff --git a/pkgs/applications/science/logic/saw-tools/default.nix b/pkgs/applications/science/logic/saw-tools/default.nix index d357bef2c7a..c4041281054 100644 --- a/pkgs/applications/science/logic/saw-tools/default.nix +++ b/pkgs/applications/science/logic/saw-tools/default.nix @@ -34,8 +34,7 @@ stdenv.mkDerivation { mv bin $out/bin mv doc $out/share - # Hack around lack of libtinfo in NixOS - ln -s ${ncurses.out}/lib/libncursesw.so.5 $out/lib/libtinfo.so.5 + ln -s ${ncurses.out}/lib/libtinfo.so.5 $out/lib/libtinfo.so.5 ln -s ${stdenv.cc.libc}/lib/libpthread.so.0 $out/lib/libpthread.so.0 # Add a clang symlink for easy building with a suitable compiler. diff --git a/pkgs/applications/science/math/qalculate-gtk/default.nix b/pkgs/applications/science/math/qalculate-gtk/default.nix index b4d82b9583c..d0625201a37 100644 --- a/pkgs/applications/science/math/qalculate-gtk/default.nix +++ b/pkgs/applications/science/math/qalculate-gtk/default.nix @@ -2,13 +2,13 @@ stdenv.mkDerivation rec { pname = "qalculate-gtk"; - version = "3.3.0"; + version = "3.4.0"; src = fetchFromGitHub { owner = "qalculate"; repo = "qalculate-gtk"; rev = "v${version}"; - sha256 = "1z2d32dcvdd66114j3km58xfk80hc5rd0zrh2fgz1azv8r4cqq1b"; + sha256 = "11q9f4p67ckbxd962jchgmwqnbp7v9ghix88c5hn3vaxvgwiw5hl"; }; patchPhase = '' diff --git a/pkgs/applications/science/programming/fdr/default.nix b/pkgs/applications/science/programming/fdr/default.nix index 3bfb70f5ce8..2c0bb84c801 100644 --- a/pkgs/applications/science/programming/fdr/default.nix +++ b/pkgs/applications/science/programming/fdr/default.nix @@ -1,4 +1,4 @@ -{stdenv, fetchurl, qtbase, qtx11extras, ncurses, xorg, zlib, python27Packages}: +{stdenv, fetchurl, qtbase, qtx11extras, ncurses5, xorg, zlib, python27Packages}: stdenv.mkDerivation { name = "fdr-4.2.3"; src = fetchurl { @@ -11,7 +11,7 @@ stdenv.mkDerivation { python27Packages.python qtbase qtx11extras - ncurses + ncurses5 xorg.libX11 xorg.libXft zlib @@ -26,8 +26,7 @@ stdenv.mkDerivation { rm -r lib/qt_plugins cp -r * "$out" - # Hack around lack of libtinfo in NixOS - ln -s ${ncurses.out}/lib/libncursesw.so.6 $out/lib/libtinfo.so.5 + ln -s ${ncurses5.out}/lib/libtinfo.so.5 $out/lib/libtinfo.so.5 ln -s ${qtbase.bin}/${qtbase.qtPluginPrefix} $out/lib/qt_plugins ln -s ${zlib.out}/lib/libz.so.1 $out/lib/libz.so.1 diff --git a/pkgs/data/fonts/vista-fonts/default.nix b/pkgs/data/fonts/vista-fonts/default.nix index e8784d90e7f..59cff1b0f47 100644 --- a/pkgs/data/fonts/vista-fonts/default.nix +++ b/pkgs/data/fonts/vista-fonts/default.nix @@ -3,7 +3,7 @@ fetchzip { name = "vista-fonts-1"; - url = http://download.microsoft.com/download/f/5/a/f5a3df76-d856-4a61-a6bd-722f52a5be26/PowerPointViewer.exe; + url = https://web.archive.org/web/20171225132744/http://download.microsoft.com/download/E/6/7/E675FFFC-2A6D-4AB0-B3EB-27C9F8C8F696/PowerPointViewer.exe; postFetch = '' ${cabextract}/bin/cabextract --lowercase --filter ppviewer.cab $downloadedFile @@ -21,7 +21,7 @@ fetchzip { done ''; - sha256 = "1q2d24c203vkl6pwk86frmaj6jra49hr9mydq7cnlx4hilqslw3g"; + sha256 = "1l27zg5jraa16zm11d3qz1w7m6f1ih3xy5avww454ylm50fw6z11"; meta = { description = "Some TrueType fonts from Microsoft Windows Vista (Calibri, Cambria, Candara, Consolas, Constantia, Corbel)"; @@ -31,6 +31,5 @@ fetchzip { # Set a non-zero priority to allow easy overriding of the # fontconfig configuration files. priority = 5; - broken = true; # source url is 404 }; } diff --git a/pkgs/data/icons/papirus-maia-icon-theme/default.nix b/pkgs/data/icons/papirus-maia-icon-theme/default.nix new file mode 100644 index 00000000000..e15e64c2101 --- /dev/null +++ b/pkgs/data/icons/papirus-maia-icon-theme/default.nix @@ -0,0 +1,36 @@ +{ stdenv, fetchFromGitHub, cmake, gtk3 }: + +stdenv.mkDerivation rec { + pname = "papirus-maia-icon-theme"; + version = "2019-07-26"; + + src = fetchFromGitHub { + owner = "Ste74"; + repo = pname; + rev = "90d47c817cc0edeed8b5a90335e669948ff4a116"; + sha256 = "0d6lvdg5nw5wfaq8lxszcws174vg12ywkrqzn6czimhmhp48jf5p"; + }; + + nativeBuildInputs = [ + cmake + gtk3 + ]; + + postPatch = '' + substituteInPlace CMakeLists.txt --replace /usr "$out" + ''; + + postFixup = '' + for theme in $out/share/icons/*; do + gtk-update-icon-cache $theme + done + ''; + + meta = with stdenv.lib; { + description = "Manjaro variation of Papirus icon theme"; + homepage = https://github.com/Ste74/papirus-maia-icon-theme; + license = licenses.lgpl3; + platforms = platforms.linux; + maintainers = with maintainers; [ romildo ]; + }; +} diff --git a/pkgs/data/themes/arc/default.nix b/pkgs/data/themes/arc/default.nix index dc54c1499fb..8dcfacadb49 100644 --- a/pkgs/data/themes/arc/default.nix +++ b/pkgs/data/themes/arc/default.nix @@ -3,13 +3,13 @@ stdenv.mkDerivation rec { pname = "arc-theme"; - version = "20190910"; + version = "20190917"; src = fetchFromGitHub { owner = "arc-design"; repo = pname; rev = version; - sha256 = "161kx9ii5ij1503nvhgn3pyqfj7cj03l1di2yf8kwwfczbi4mq3j"; + sha256 = "1qgpk4p2hi5hd4yy0hj93kq1vs0b32wb8qkaj1wi90c8gwddq5wa"; }; nativeBuildInputs = [ diff --git a/pkgs/desktops/enlightenment/enlightenment.nix b/pkgs/desktops/enlightenment/enlightenment.nix index b2a9d398709..a5724385e41 100644 --- a/pkgs/desktops/enlightenment/enlightenment.nix +++ b/pkgs/desktops/enlightenment/enlightenment.nix @@ -1,7 +1,7 @@ -{ stdenv, fetchurl, meson, ninja, pkgconfig, gettext, efl, - xcbutilkeysyms, libXrandr, libXdmcp, libxcb, libffi, pam, alsaLib, - luajit, bzip2, libpthreadstubs, gdbm, libcap, mesa, - xkeyboard_config, pcre, +{ stdenv, fetchurl, meson, ninja, pkgconfig, gettext, alsaLib, bc, + bzip2, efl, gdbm, libXdmcp, libXrandr, libcap, libffi, + libpthreadstubs, libxcb, luajit, mesa, pam, pcre, xcbutilkeysyms, + xkeyboard_config, bluetoothSupport ? true, bluez5, pulseSupport ? !stdenv.isDarwin, libpulseaudio, @@ -17,27 +17,28 @@ stdenv.mkDerivation rec { }; nativeBuildInputs = [ - meson - ninja (pkgconfig.override { vanilla = true; }) gettext + meson + ninja ]; buildInputs = [ + alsaLib + bc # for the Everything module calculator mode + bzip2 efl + gdbm libXdmcp - libxcb - xcbutilkeysyms libXrandr libffi - pam - alsaLib - luajit - bzip2 libpthreadstubs - gdbm - pcre + libxcb + luajit mesa + pam + pcre + xcbutilkeysyms xkeyboard_config ] ++ stdenv.lib.optional stdenv.isLinux libcap @@ -68,6 +69,9 @@ stdenv.mkDerivation rec { substituteInPlace src/bin/e_import_config_dialog.c \ --replace "e_prefix_bin_get()" "\"${efl}/bin\"" + + substituteInPlace src/modules/everything/evry_plug_calc.c \ + --replace "ecore_exe_pipe_run(\"bc -l\"" "ecore_exe_pipe_run(\"${bc}/bin/bc -l\"" ''; mesonFlags = [ "-Dsystemdunitdir=lib/systemd/user" ]; diff --git a/pkgs/desktops/xfce4-14/default.nix b/pkgs/desktops/xfce4-14/default.nix index 294dfa92c79..0e2c8c1696b 100644 --- a/pkgs/desktops/xfce4-14/default.nix +++ b/pkgs/desktops/xfce4-14/default.nix @@ -93,8 +93,6 @@ makeScope newScope (self: with self; { ## COMMON PARTS WITH XFCE 4.12 - gtk-xfce-engine = callPackage ../xfce/core/gtk-xfce-engine.nix { withGtk3 = false; }; - xfce4-icon-theme = callPackage ../xfce/art/xfce4-icon-theme.nix { }; xfwm4-themes = callPackage ../xfce/art/xfwm4-themes.nix { }; @@ -113,7 +111,6 @@ makeScope newScope (self: with self; { ## ALIASES - - # added 2019-08-18 - xfce4-mixer = throw "deprecated 2019-08-18: obsoleted by xfce4-pulseaudio-plugin"; + xfce4-mixer = throw "deprecated 2019-08-18: obsoleted by xfce4-pulseaudio-plugin"; # added 2019-08-18 + gtk-xfce-engine = throw "deprecated 2019-09-17: Xfce 4.14 deprecated gtk-xfce-engine"; # added 2019-09-17 }) diff --git a/pkgs/development/arduino/arduino-core/default.nix b/pkgs/development/arduino/arduino-core/default.nix index 2897bac0614..840fbff60eb 100644 --- a/pkgs/development/arduino/arduino-core/default.nix +++ b/pkgs/development/arduino/arduino-core/default.nix @@ -200,7 +200,7 @@ stdenv.mkDerivation rec { # avrdude_bin is linked against libtinfo.so.5 mkdir $out/lib/ - ln -s ${lib.makeLibraryPath [ncurses5]}/libncursesw.so.5 $out/lib/libtinfo.so.5 + ln -s ${lib.makeLibraryPath [ncurses5]}/libtinfo.so.5 $out/lib/libtinfo.so.5 ${stdenv.lib.optionalString withTeensyduino '' # Patch the Teensy loader binary diff --git a/pkgs/development/libraries/cpp-utilities/default.nix b/pkgs/development/libraries/cpp-utilities/default.nix index cd16dea56b1..c7f94945570 100644 --- a/pkgs/development/libraries/cpp-utilities/default.nix +++ b/pkgs/development/libraries/cpp-utilities/default.nix @@ -2,13 +2,13 @@ stdenv.mkDerivation rec { pname = "cpp-utilities"; - version = "4.17.1"; + version = "5.0.0"; src = fetchFromGitHub { owner = "Martchus"; repo = pname; rev = "v${version}"; - sha256 = "12088cwg3jbqipmbn4843w1cgxi1q6vwx47gy042rkfvbk6azhxl"; + sha256 = "031kiawmrp40sqgd9g5qd82ljglcm9xvynicsn4n8n4ngfgbnc0m"; }; nativeBuildInputs = [ cmake ]; diff --git a/pkgs/development/libraries/gstreamer/legacy/qt-gstreamer/boost1.48.patch b/pkgs/development/libraries/gstreamer/legacy/qt-gstreamer/boost1.48.patch deleted file mode 100644 index c48eec68a64..00000000000 --- a/pkgs/development/libraries/gstreamer/legacy/qt-gstreamer/boost1.48.patch +++ /dev/null @@ -1,49 +0,0 @@ -Description: Work around moc limitations - Some parts of Boost, introduced in Boost 1.48 are not - understood by the limited C++ parser of moc. This - patch defines header guards that prevent the troublesome boost - headers from being processed. -Bug-Debian: #653796 -Author: Tobias Frost <tobi@coldtobi.de> -Reviewed-By: Steve Robbins <smr@debian.org> - ---- a/src/QGlib/connect.h -+++ b/src/QGlib/connect.h -@@ -19,6 +19,11 @@ - #ifndef QGLIB_CONNECT_H - #define QGLIB_CONNECT_H - -+#ifdef Q_MOC_RUN -+#define BOOST_TT_HAS_OPERATOR_HPP_INCLUDED -+#endif -+ -+ - #include "global.h" - #include "quark.h" - #include <QtCore/QObject> ---- a/src/QGst/bin.h -+++ b/src/QGst/bin.h -@@ -19,6 +19,10 @@ - #ifndef QGST_BIN_H - #define QGST_BIN_H - -+#ifdef Q_MOC_RUN -+#define BOOST_TT_HAS_OPERATOR_HPP_INCLUDED -+#endif -+ - #include "element.h" - #include "childproxy.h" - ---- a/src/QGst/Ui/videowidget.h -+++ b/src/QGst/Ui/videowidget.h -@@ -19,6 +19,10 @@ - #ifndef QGST_UI_VIDEOWIDGET_H - #define QGST_UI_VIDEOWIDGET_H - -+#ifdef Q_MOC_RUN -+#define BOOST_TT_HAS_OPERATOR_HPP_INCLUDED -+#endif -+ - #include "global.h" - #include "../element.h" - #include <QtGui/QWidget> diff --git a/pkgs/development/libraries/gstreamer/legacy/qt-gstreamer/default.nix b/pkgs/development/libraries/gstreamer/legacy/qt-gstreamer/default.nix deleted file mode 100644 index 9797f21c168..00000000000 --- a/pkgs/development/libraries/gstreamer/legacy/qt-gstreamer/default.nix +++ /dev/null @@ -1,20 +0,0 @@ -{ stdenv, fetchurl, gstreamer, gst-plugins-base, boost155, glib, qt4, cmake -, automoc4, flex, bison, pkgconfig }: - -stdenv.mkDerivation rec { - name = "${pname}-0.10.3"; - pname = "qt-gstreamer"; - - src = fetchurl { - url = "https://gstreamer.freedesktop.org/src/${pname}/${name}.tar.bz2"; - sha256 = "1pqg9sxzk8sdrf7pazb5v21hasqai9i4l203gbdqz29w2ll1ybsl"; - }; - - buildInputs = [ gstreamer gst-plugins-base glib qt4 ]; - propagatedBuildInputs = [ boost155 ]; - nativeBuildInputs = [ cmake automoc4 flex bison pkgconfig ]; - - cmakeFlags = "-DUSE_QT_PLUGIN_DIR=OFF -DUSE_GST_PLUGIN_DIR=OFF"; - - patches = [ ./boost1.48.patch ]; -} diff --git a/pkgs/development/libraries/gstreamer/qt-gstreamer/default.nix b/pkgs/development/libraries/gstreamer/qt-gstreamer/default.nix deleted file mode 100644 index a099643061a..00000000000 --- a/pkgs/development/libraries/gstreamer/qt-gstreamer/default.nix +++ /dev/null @@ -1,32 +0,0 @@ -{ stdenv, fetchurl, fetchpatch, gst_all_1, boost, glib, qt4, cmake -, automoc4, flex, bison, pkgconfig }: - -stdenv.mkDerivation rec { - name = "${pname}-1.2.0"; - pname = "qt-gstreamer"; - - src = fetchurl { - url = "https://gstreamer.freedesktop.org/src/${pname}/${name}.tar.xz"; - sha256 = "9f3b492b74cad9be918e4c4db96df48dab9c012f2ae5667f438b64a4d92e8fd4"; - }; - - patches = [ - (fetchpatch { - url = "https://cgit.freedesktop.org/gstreamer/qt-gstreamer/patch/?id=e2ca8094aa8d0eac1c3a98df66fe94ce0c754088"; - sha256 = "1qps0nlc26d74wk8h96xl5s3d9qrdx6c0ph0zpl1dnc691lgyf6s"; - }) - ]; - - outputs = [ "out" "dev" ]; - - buildInputs = [ gst_all_1.gstreamer gst_all_1.gst-plugins-base glib qt4 ]; - propagatedBuildInputs = [ boost ]; - nativeBuildInputs = [ cmake automoc4 flex bison pkgconfig ]; - - cmakeFlags = "-DUSE_QT_PLUGIN_DIR=OFF -DUSE_GST_PLUGIN_DIR=OFF"; - - meta = with stdenv.lib; { - platforms = platforms.linux; - license = licenses.lgpl21; - }; -} diff --git a/pkgs/development/libraries/libfido2/default.nix b/pkgs/development/libraries/libfido2/default.nix index b670172ce1e..5fefdad08e7 100644 --- a/pkgs/development/libraries/libfido2/default.nix +++ b/pkgs/development/libraries/libfido2/default.nix @@ -2,10 +2,10 @@ stdenv.mkDerivation rec { pname = "libfido2"; - version = "1.1.0"; + version = "1.2.0"; src = fetchurl { url = "https://developers.yubico.com/libfido2/Releases/libfido2-${version}.tar.gz"; - sha256 = "1h51q9pgv54czf7k6v90b02gnvqw4dlxmz6vi0n06shpkdzv5jh1"; + sha256 = "1pbllhzcrzkgxad00bai7lna8dpkwiv8khx8p20miy661abv956v"; }; nativeBuildInputs = [ cmake pkgconfig ]; diff --git a/pkgs/development/libraries/libqalculate/default.nix b/pkgs/development/libraries/libqalculate/default.nix index 1b73af7037b..894907c23fc 100644 --- a/pkgs/development/libraries/libqalculate/default.nix +++ b/pkgs/development/libraries/libqalculate/default.nix @@ -3,13 +3,13 @@ stdenv.mkDerivation rec { pname = "libqalculate"; - version = "3.3.0"; + version = "3.4.0"; src = fetchFromGitHub { owner = "qalculate"; repo = "libqalculate"; rev = "v${version}"; - sha256 = "1qgsngi9z1sr6pzgcq6kgng62arpc5xn2ai1ks69myzzmgwk8adp"; + sha256 = "046fi8cqfqh0ila3kc4sg75yvg24wmghlja2fmhkj96fjjfkzsss"; }; outputs = [ "out" "dev" "doc" ]; diff --git a/pkgs/development/libraries/mono-zeroconf/default.nix b/pkgs/development/libraries/mono-zeroconf/default.nix deleted file mode 100644 index 89db7344f99..00000000000 --- a/pkgs/development/libraries/mono-zeroconf/default.nix +++ /dev/null @@ -1,25 +0,0 @@ -{ stdenv, fetchurl, which, pkgconfig, mono }: - -stdenv.mkDerivation rec { - pname = "mono-zeroconf"; - version = "0.9.0"; - - src = fetchurl { - url = "http://download.banshee-project.org/mono-zeroconf/mono-zeroconf-${version}.tar.bz2"; - sha256 = "1qfp4qvsx7rc2shj1chi2y7fxn10rwi70rw2y54b2i8a4jq7gpkb"; - }; - - nativeBuildInputs = [ pkgconfig ]; - buildInputs = [ which mono ]; - - dontStrip = true; - - configureFlags = [ "--disable-docs" ]; - - meta = with stdenv.lib; { - description = "A cross platform Zero Configuration Networking library for Mono and .NET"; - homepage = https://www.mono-project.com/archived/monozeroconf/; - platforms = platforms.linux; - license = licenses.mit; - }; -} diff --git a/pkgs/development/ocaml-modules/ocaml-protoc/default.nix b/pkgs/development/ocaml-modules/ocaml-protoc/default.nix new file mode 100644 index 00000000000..1ef7b6c2d40 --- /dev/null +++ b/pkgs/development/ocaml-modules/ocaml-protoc/default.nix @@ -0,0 +1,38 @@ +{ stdenv, ocaml, fetchFromGitHub, ocamlbuild, findlib, ppx_deriving_protobuf }: + +stdenv.mkDerivation rec { + name = "ocaml${ocaml.version}-ocaml-protoc-${version}"; + version = "1.2.0"; + + minimumOCamlVersion = "4.02"; + + src = fetchFromGitHub { + owner = "mransan"; + repo = "ocaml-protoc"; + rev = "60d2d4dd55f73830e1bed603cc44d3420430632c"; + sha256 = "1d1p8ch723z2qa9azmmnhbcpwxbpzk3imh1cgkjjq4p5jwzj8amj"; + }; + + installPhase = '' + mkdir -p tmp/bin + export PREFIX=`pwd`/tmp + make all.install.build + make check_install + make lib.install + make bin.install + ''; + + buildInputs = [ ocaml findlib ocamlbuild ]; + propagatedBuildInputs = [ ppx_deriving_protobuf ]; + + createFindlibDestdir = true; + + doCheck = true; + + meta = with stdenv.lib; { + homepage = "https://github.com/mransan/ocaml-protoc"; + description = "A Protobuf Compiler for OCaml"; + license = licenses.mit; + maintainers = [ maintainers.vyorkin ]; + }; +} diff --git a/pkgs/development/ocaml-modules/optint/default.nix b/pkgs/development/ocaml-modules/optint/default.nix index 613973200d2..508bbfba605 100644 --- a/pkgs/development/ocaml-modules/optint/default.nix +++ b/pkgs/development/ocaml-modules/optint/default.nix @@ -1,28 +1,18 @@ -{ stdenv, fetchurl, ocaml, findlib, dune }: +{ lib, buildDunePackage, fetchurl }: -if !stdenv.lib.versionAtLeast ocaml.version "4.02" -then throw "optint is not available for OCaml ${ocaml.version}" -else - -stdenv.mkDerivation rec { - version = "0.0.2"; - name = "ocaml${ocaml.version}-optint-${version}"; +buildDunePackage rec { + minimumOCamlVersion = "4.03"; + version = "0.0.3"; + pname = "optint"; src = fetchurl { - url = "https://github.com/mirage/optint/releases/download/v0.0.2/optint-v0.0.2.tbz"; - sha256 = "1lmb7nycmkr05y93slqi98i1lcs1w4kcngjzjwz7i230qqjpw9w1"; + url = "https://github.com/mirage/optint/releases/download/v${version}/optint-v${version}.tbz"; + sha256 = "0c7r3s6lal9xkixngkj25nqncj4s33ka40bjdi7fz7mly08djycj"; }; - buildInputs = [ ocaml findlib dune ]; - - buildPhase = "dune build"; - - inherit (dune) installPhase; - meta = { homepage = "https://github.com/mirage/optint"; description = "Abstract type of integer between x64 and x86 architecture"; - license = stdenv.lib.licenses.mit; - maintainers = [ stdenv.lib.maintainers.vbgl ]; - inherit (ocaml.meta) platforms; + license = lib.licenses.mit; + maintainers = [ lib.maintainers.vbgl ]; }; } diff --git a/pkgs/development/ocaml-modules/ppx_deriving_rpc/default.nix b/pkgs/development/ocaml-modules/ppx_deriving_rpc/default.nix new file mode 100644 index 00000000000..7746200d4ff --- /dev/null +++ b/pkgs/development/ocaml-modules/ppx_deriving_rpc/default.nix @@ -0,0 +1,18 @@ +{ lib, buildDunePackage, rpclib, ppxfind, ppx_deriving, cppo }: + +buildDunePackage rec { + pname = "ppx_deriving_rpc"; + + inherit (rpclib) version src; + + buildInputs = [ ppxfind cppo ]; + + propagatedBuildInputs = [ rpclib ppx_deriving ]; + + meta = with lib; { + homepage = "https://github.com/mirage/ocaml-rpc"; + description = "Ppx deriver for ocaml-rpc"; + license = licenses.isc; + maintainers = [ maintainers.vyorkin ]; + }; +} diff --git a/pkgs/development/python-modules/Logbook/default.nix b/pkgs/development/python-modules/Logbook/default.nix index 866c0410929..503fefc0013 100644 --- a/pkgs/development/python-modules/Logbook/default.nix +++ b/pkgs/development/python-modules/Logbook/default.nix @@ -18,6 +18,9 @@ buildPythonPackage rec { py.test tests ''; + # Some of the tests use localhost networking. + __darwinAllowLocalNetworking = true; + meta = { homepage = https://pythonhosted.org/Logbook/; description = "A logging replacement for Python"; diff --git a/pkgs/development/python-modules/cheroot/default.nix b/pkgs/development/python-modules/cheroot/default.nix index 591bb0fbe37..9b3050942a8 100644 --- a/pkgs/development/python-modules/cheroot/default.nix +++ b/pkgs/development/python-modules/cheroot/default.nix @@ -34,6 +34,9 @@ buildPythonPackage rec { pytest -k 'not tls' ${lib.optionalString stdenv.isDarwin "--deselect=cheroot/test/test_ssl.py::test_http_over_https_error --deselect=cheroot/test/test_server.py::test_bind_addr_unix"} ''; + # Some of the tests use localhost networking. + __darwinAllowLocalNetworking = true; + meta = with lib; { description = "High-performance, pure-Python HTTP"; homepage = https://github.com/cherrypy/cheroot; diff --git a/pkgs/development/python-modules/csvs-to-sqlite/default.nix b/pkgs/development/python-modules/csvs-to-sqlite/default.nix index ab9ca982718..0e5e902be2e 100644 --- a/pkgs/development/python-modules/csvs-to-sqlite/default.nix +++ b/pkgs/development/python-modules/csvs-to-sqlite/default.nix @@ -1,6 +1,7 @@ { lib , buildPythonPackage , fetchFromGitHub +, isPy3k , pytestrunner , click , dateparser @@ -12,17 +13,16 @@ buildPythonPackage rec { pname = "csvs-to-sqlite"; - version = "0.9"; + version = "1.0"; + disabled = !isPy3k; src = fetchFromGitHub { owner = "simonw"; repo = pname; rev = version; - sha256 = "0js86m4kj70g9n9gagr8l6kgswqllg6hn1xa3yvxwv95i59ihpz5"; + sha256 = "0n80y9a6qhbhhbz64jdpscx0nha9jn9nygp9nkgszmw04ri5j5hm"; }; - buildInputs = [ pytestrunner ]; - propagatedBuildInputs = [ click dateparser diff --git a/pkgs/development/python-modules/h11/default.nix b/pkgs/development/python-modules/h11/default.nix index f77c267d792..361ac0c59d1 100644 --- a/pkgs/development/python-modules/h11/default.nix +++ b/pkgs/development/python-modules/h11/default.nix @@ -23,6 +23,9 @@ buildPythonPackage rec { py.test ''; + # Some of the tests use localhost networking. + __darwinAllowLocalNetworking = true; + meta = with lib; { description = "Pure-Python, bring-your-own-I/O implementation of HTTP/1.1"; license = licenses.mit; diff --git a/pkgs/development/python-modules/ipykernel/default.nix b/pkgs/development/python-modules/ipykernel/default.nix index 5203047b77f..4bdd9011d1e 100644 --- a/pkgs/development/python-modules/ipykernel/default.nix +++ b/pkgs/development/python-modules/ipykernel/default.nix @@ -37,6 +37,9 @@ buildPythonPackage rec { HOME=$(mktemp -d) pytest ipykernel -k "not (test_sys_path or test_sys_path_profile_dir or test_complete)" ''; + # Some of the tests use localhost networking. + __darwinAllowLocalNetworking = true; + meta = { description = "IPython Kernel for Jupyter"; homepage = http://ipython.org/; diff --git a/pkgs/development/python-modules/nbconvert/default.nix b/pkgs/development/python-modules/nbconvert/default.nix index 69828b2b18f..2f0090b5967 100644 --- a/pkgs/development/python-modules/nbconvert/default.nix +++ b/pkgs/development/python-modules/nbconvert/default.nix @@ -44,6 +44,9 @@ buildPythonPackage rec { HOME=$(mktemp -d) py.test -v --ignore="nbconvert/preprocessors/tests/test_execute.py" ''; + # Some of the tests use localhost networking. + __darwinAllowLocalNetworking = true; + meta = { description = "Converting Jupyter Notebooks"; homepage = https://jupyter.org/; diff --git a/pkgs/development/python-modules/nbformat/default.nix b/pkgs/development/python-modules/nbformat/default.nix index 8b16ffb7e32..fbc71202d28 100644 --- a/pkgs/development/python-modules/nbformat/default.nix +++ b/pkgs/development/python-modules/nbformat/default.nix @@ -29,6 +29,9 @@ buildPythonPackage rec { export HOME=tmp ''; + # Some of the tests use localhost networking. + __darwinAllowLocalNetworking = true; + meta = { description = "The Jupyter Notebook format"; homepage = https://jupyter.org/; diff --git a/pkgs/development/python-modules/nbval/default.nix b/pkgs/development/python-modules/nbval/default.nix index 60aa4806e2f..860142f1e94 100644 --- a/pkgs/development/python-modules/nbval/default.nix +++ b/pkgs/development/python-modules/nbval/default.nix @@ -45,6 +45,9 @@ buildPythonPackage rec { pytest tests --ignore tests/test_timeouts.py ''; + # Some of the tests use localhost networking. + __darwinAllowLocalNetworking = true; + meta = with lib; { description = "A py.test plugin to validate Jupyter notebooks"; homepage = https://github.com/computationalmodelling/nbval; diff --git a/pkgs/development/python-modules/notebook/default.nix b/pkgs/development/python-modules/notebook/default.nix index 431d4bb4d56..d081a5a92fb 100644 --- a/pkgs/development/python-modules/notebook/default.nix +++ b/pkgs/development/python-modules/notebook/default.nix @@ -64,6 +64,9 @@ buildPythonPackage rec { else ""} ''; + # Some of the tests use localhost networking. + __darwinAllowLocalNetworking = true; + meta = { description = "The Jupyter HTML notebook is a web-based notebook environment for interactive computing"; homepage = https://jupyter.org/; diff --git a/pkgs/development/python-modules/portend/default.nix b/pkgs/development/python-modules/portend/default.nix index 5da7a7941c0..7aa66c2a309 100644 --- a/pkgs/development/python-modules/portend/default.nix +++ b/pkgs/development/python-modules/portend/default.nix @@ -24,6 +24,9 @@ buildPythonPackage rec { py.test --deselect=test_portend.py::TestChecker::test_check_port_listening ''; + # Some of the tests use localhost networking. + __darwinAllowLocalNetworking = true; + meta = with stdenv.lib; { description = "Monitor TCP ports for bound or unbound states"; homepage = https://github.com/jaraco/portend; diff --git a/pkgs/development/python-modules/python-engineio/default.nix b/pkgs/development/python-modules/python-engineio/default.nix index 93dd9fb654f..bf6d4cd2381 100644 --- a/pkgs/development/python-modules/python-engineio/default.nix +++ b/pkgs/development/python-modules/python-engineio/default.nix @@ -1,27 +1,25 @@ -{ stdenv -, buildPythonPackage -, fetchFromGitHub -, six +{ stdenv, buildPythonPackage, fetchFromGitHub +, aiohttp , eventlet -, mock , iana-etc , libredirect -, aiohttp -, websockets -, websocket_client +, mock , requests +, six , tornado +, websocket_client +, websockets }: buildPythonPackage rec { pname = "python-engineio"; - version = "3.4.3"; + version = "3.9.3"; src = fetchFromGitHub { owner = "miguelgrinberg"; repo = "python-engineio"; rev = "v${version}"; - sha256 = "0wk81rqigw47z087f5kc7b9iwqggypxc62q8q818qyzqwb93ysxf"; + sha256 = "0rwlj12d37dpw6y3bdn6rxv68xnd9ykj4fr3ly0fa143xci35d9y"; }; propagatedBuildInputs = [ @@ -29,13 +27,13 @@ buildPythonPackage rec { ]; checkInputs = [ + aiohttp eventlet mock - aiohttp - websockets - websocket_client - tornado requests + tornado + websocket_client + websockets ]; # make /etc/protocols accessible to fix socket.getprotobyname('tcp') in sandbox diff --git a/pkgs/development/python-modules/pyzmq/default.nix b/pkgs/development/python-modules/pyzmq/default.nix index dcab96d12a6..40273cce888 100644 --- a/pkgs/development/python-modules/pyzmq/default.nix +++ b/pkgs/development/python-modules/pyzmq/default.nix @@ -32,4 +32,7 @@ buildPythonPackage rec { and not test_on_recv_wake \ and not test_monitor" ''; + + # Some of the tests use localhost networking. + __darwinAllowLocalNetworking = true; } diff --git a/pkgs/development/python-modules/trustme/default.nix b/pkgs/development/python-modules/trustme/default.nix index e2ba008d3a0..601e49759fd 100644 --- a/pkgs/development/python-modules/trustme/default.nix +++ b/pkgs/development/python-modules/trustme/default.nix @@ -36,6 +36,9 @@ buildPythonPackage rec { pytest ''; + # Some of the tests use localhost networking. + __darwinAllowLocalNetworking = true; + meta = { description = "High quality TLS certs while you wait, for the discerning tester"; homepage = https://github.com/python-trio/trustme; diff --git a/pkgs/development/python-modules/uvicorn/default.nix b/pkgs/development/python-modules/uvicorn/default.nix index 1bf0d1c54f0..9f7efef1e84 100644 --- a/pkgs/development/python-modules/uvicorn/default.nix +++ b/pkgs/development/python-modules/uvicorn/default.nix @@ -1,23 +1,27 @@ { lib , buildPythonPackage -, fetchPypi +, fetchFromGitHub , click , h11 , httptools , uvloop , websockets , wsproto +, pytest +, requests , isPy27 }: buildPythonPackage rec { pname = "uvicorn"; - version = "0.8.4"; + version = "0.9.0"; disabled = isPy27; - src = fetchPypi { - inherit pname version; - sha256 = "1l8rfm30inx9pma893i7sby9h7y910k58841zqaajksn563b882k"; + src = fetchFromGitHub { + owner = "encode"; + repo = pname; + rev = version; + sha256 = "0z4h04mbkzqgpk698bac6f50jxkf02ils6khzl7zbw7yvi6gkkc8"; }; propagatedBuildInputs = [ @@ -29,11 +33,15 @@ buildPythonPackage rec { wsproto ]; - checkPhase = '' - $out/bin/uvicorn --help + postPatch = '' + substituteInPlace setup.py \ + --replace "h11==0.8.*" "h11" ''; - patches = [ ./setup.patch ]; + checkInputs = [ pytest requests ]; + checkPhase = '' + pytest + ''; meta = with lib; { homepage = https://www.uvicorn.org/; diff --git a/pkgs/development/python-modules/uvicorn/setup.patch b/pkgs/development/python-modules/uvicorn/setup.patch deleted file mode 100644 index f1d974b42d9..00000000000 --- a/pkgs/development/python-modules/uvicorn/setup.patch +++ /dev/null @@ -1,13 +0,0 @@ -diff --git a/setup.py b/setup.py -index 802cda4..561abf4 100755 ---- a/setup.py -+++ b/setup.py -@@ -42,7 +42,7 @@ env_marker = ( - - requirements = [ - "click==7.*", -- "h11==0.8.*", -+ "h11", - "websockets==7.*", - "httptools==0.0.13 ;" + env_marker, - "uvloop==0.12.* ;" + env_marker, diff --git a/pkgs/development/python-modules/uvloop/darwin_sandbox.patch b/pkgs/development/python-modules/uvloop/darwin_sandbox.patch new file mode 100644 index 00000000000..bd4e5e48b14 --- /dev/null +++ b/pkgs/development/python-modules/uvloop/darwin_sandbox.patch @@ -0,0 +1,28 @@ +diff --git a/tests/test_pipes.py b/tests/test_pipes.py +index d883abf..2e74d7a 100644 +--- a/tests/test_pipes.py ++++ b/tests/test_pipes.py +@@ -2,6 +2,7 @@ import asyncio + import io + import os + import socket ++import unittest + + from uvloop import _testbase as tb + +@@ -96,6 +97,7 @@ class _BasePipeTest: + # extra info is available + self.assertIsNotNone(proto.transport.get_extra_info('pipe')) + ++ @unittest.skip("darwin sandbox") + def test_read_pty_output(self): + proto = MyReadPipeProto(loop=self.loop) + +@@ -198,6 +200,7 @@ class _BasePipeTest: + self.loop.run_until_complete(proto.done) + self.assertEqual('CLOSED', proto.state) + ++ @unittest.skip("darwin sandbox") + def test_write_pty(self): + master, slave = os.openpty() + os.set_blocking(master, False) diff --git a/pkgs/development/python-modules/uvloop/default.nix b/pkgs/development/python-modules/uvloop/default.nix index 2093f4d7053..171f6d6ed32 100644 --- a/pkgs/development/python-modules/uvloop/default.nix +++ b/pkgs/development/python-modules/uvloop/default.nix @@ -20,6 +20,8 @@ buildPythonPackage rec { sha256 = "0blcnrd5vky2k1m1p1skx4516dr1jx76yyb0c6fi82si6mqd0b4l"; }; + patches = lib.optional stdenv.isDarwin ./darwin_sandbox.patch; + buildInputs = [ libuv ] ++ lib.optionals stdenv.isDarwin [ CoreServices ApplicationServices ]; @@ -31,6 +33,9 @@ buildPythonPackage rec { checkInputs = [ pyopenssl psutil ]; + # Some of the tests use localhost networking. + __darwinAllowLocalNetworking = true; + meta = with lib; { description = "Fast implementation of asyncio event loop on top of libuv"; homepage = http://github.com/MagicStack/uvloop; diff --git a/pkgs/development/python-modules/websockets/default.nix b/pkgs/development/python-modules/websockets/default.nix index 2e0caae4b46..589a8089fca 100644 --- a/pkgs/development/python-modules/websockets/default.nix +++ b/pkgs/development/python-modules/websockets/default.nix @@ -1,24 +1,26 @@ { lib -, fetchPypi +, fetchFromGitHub , buildPythonPackage , pythonOlder +, pytest }: buildPythonPackage rec { pname = "websockets"; - version = "7.0"; + version = "8.0.2"; - src = fetchPypi { - inherit pname version; - sha256 = "17vwr6sa1y3lb24wzfyyc98c5v03di4j8f24qkqa9vsvaghc7qq8"; + src = fetchFromGitHub { + owner = "aaugustin"; + repo = pname; + rev = version; + sha256 = "02fgb8gib4z5fqv30brz3mhxmblw9bw0978fhpjdrkj7wvqrz5h8"; }; disabled = pythonOlder "3.3"; - doCheck = false; # protocol tests fail - meta = { + meta = with lib; { description = "WebSocket implementation in Python 3"; - homepage = https://github.com/aaugustin/websockets; - license = lib.licenses.bsd3; + homepage = "https://github.com/aaugustin/websockets"; + license = licenses.bsd3; }; } diff --git a/pkgs/development/tools/build-managers/redo-apenwarr/default.nix b/pkgs/development/tools/build-managers/redo-apenwarr/default.nix index d25367c3e57..f08a2e56342 100644 --- a/pkgs/development/tools/build-managers/redo-apenwarr/default.nix +++ b/pkgs/development/tools/build-managers/redo-apenwarr/default.nix @@ -17,10 +17,10 @@ in stdenv.mkDerivation rec { pname = "redo-apenwarr"; version = "0.42"; - src = fetchFromGitHub { + src = fetchFromGitHub rec { owner = "apenwarr"; - repo = pname; - rev = "${pname}-${version}"; + repo = "redo"; + rev = "${repo}-${version}"; sha256 = "1060yb7hrxm8c7bfvb0y4j0acpxsj6hbykw1d9549zpkxxr9nsgm"; }; diff --git a/pkgs/games/minecraft/default.nix b/pkgs/games/minecraft/default.nix index 32830d6f3d0..7abd6c162e0 100644 --- a/pkgs/games/minecraft/default.nix +++ b/pkgs/games/minecraft/default.nix @@ -1,51 +1,137 @@ -{ stdenv, fetchurl, makeDesktopItem, makeWrapper -, jdk, jre, libpulseaudio, libXxf86vm +{ stdenv +, fetchurl +, makeDesktopItem +, makeWrapper +, jre # old or modded versions of the game may require Java 8 (https://aur.archlinux.org/packages/minecraft-launcher/#pinned-674960) +, xorg +, zlib +, nss +, nspr +, fontconfig +, gnome2 +, cairo +, expat +, alsaLib +, cups +, dbus +, atk +, gtk2-x11 +, gdk-pixbuf +, glib +, curl +, freetype +, libpulseaudio +, systemd +, flite ? null +, libXxf86vm ? null }: let desktopItem = makeDesktopItem { - name = "minecraft"; - exec = "minecraft"; - icon = "minecraft"; - comment = "A sandbox-building game"; - desktopName = "Minecraft"; - genericName = "minecraft"; - categories = "Game;"; + name = "minecraft-launcher"; + exec = "minecraft-launcher"; + icon = "minecraft-launcher"; + comment = "Official launcher for Minecraft, a sandbox-building game"; + desktopName = "Minecraft Launcher"; + categories = "Game;Application;"; }; - libPath = stdenv.lib.makeLibraryPath [ - libpulseaudio - libXxf86vm # Needed only for versions <1.13 - ]; + envLibPath = stdenv.lib.makeLibraryPath [ + curl + libpulseaudio + systemd + alsaLib # needed for narrator + flite # needed for narrator + libXxf86vm # needed only for versions <1.13 + ]; -in stdenv.mkDerivation { - name = "minecraft-2015-07-24"; + libPath = stdenv.lib.makeLibraryPath ([ + alsaLib + atk + cairo + cups + dbus + expat + fontconfig + freetype + gdk-pixbuf + glib + gnome2.GConf + gnome2.pango + gtk2-x11 + nspr + nss + stdenv.cc.cc + zlib + ] ++ + (with xorg; [ + libX11 + libxcb + libXcomposite + libXcursor + libXdamage + libXext + libXfixes + libXi + libXrandr + libXrender + libXtst + libXScrnSaver + ])); +in + stdenv.mkDerivation rec { + pname = "minecraft-launcher"; + + version = "2.1.5965"; src = fetchurl { - url = "https://s3.amazonaws.com/Minecraft.Download/launcher/Minecraft.jar"; - sha256 = "04pj4l5q0a64jncm2kk45r7nxnxa2z9n110dcxbbahdi6wk0png8"; + url = "https://launcher.mojang.com/download/linux/x86_64/minecraft-launcher_${version}.tar.gz"; + sha256 = "0wlc49s541li4cbxdmlw8fp34hp1q9m6ngr7l5hfdhv1i13s5845"; + }; + + icon = fetchurl { + url = "https://launcher.mojang.com/download/minecraft-launcher.svg"; + sha256 = "0w8z21ml79kblv20wh5lz037g130pxkgs8ll9s3bi94zn2pbrhim"; }; nativeBuildInputs = [ makeWrapper ]; - unpackPhase = "${jdk}/bin/jar xf $src favicon.png"; + sourceRoot = "."; + + dontConfigure = true; + dontBuild = true; installPhase = '' - mkdir -p $out/bin $out/share/minecraft + mkdir -p $out/opt + mv minecraft-launcher $out/opt - makeWrapper ${jre}/bin/java $out/bin/minecraft \ - --add-flags "-jar $out/share/minecraft/minecraft.jar" \ - --suffix LD_LIBRARY_PATH : ${libPath} + ${desktopItem.buildCommand} + install -D $icon $out/share/icons/hicolor/symbolic/apps/minecraft-launcher.svg - cp $src $out/share/minecraft/minecraft.jar - cp -r ${desktopItem}/share/applications $out/share - install -D favicon.png $out/share/icons/hicolor/32x32/apps/minecraft.png + makeWrapper $out/opt/minecraft-launcher/minecraft-launcher $out/bin/minecraft-launcher \ + --prefix LD_LIBRARY_PATH : ${envLibPath} \ + --prefix PATH : ${stdenv.lib.makeBinPath [ jre ]} + ''; + + preFixup = '' + patchelf \ + --set-interpreter ${stdenv.cc.bintools.dynamicLinker} \ + --set-rpath '$ORIGIN/'":${libPath}" \ + $out/opt/minecraft-launcher/minecraft-launcher + patchelf \ + --set-rpath '$ORIGIN/'":${libPath}" \ + $out/opt/minecraft-launcher/libcef.so + patchelf \ + --set-rpath '$ORIGIN/'":${libPath}" \ + $out/opt/minecraft-launcher/liblauncher.so ''; meta = with stdenv.lib; { - description = "A sandbox-building game"; - homepage = https://minecraft.net; + description = "Official launcher for Minecraft, a sandbox-building game"; + homepage = "https://minecraft.net"; maintainers = with maintainers; [ cpages ryantm infinisil ]; - license = licenses.unfreeRedistributable; + license = licenses.unfree; }; + + passthru.updateScript = ./update.sh; } diff --git a/pkgs/games/minecraft/update.sh b/pkgs/games/minecraft/update.sh new file mode 100755 index 00000000000..02b362e839b --- /dev/null +++ b/pkgs/games/minecraft/update.sh @@ -0,0 +1,7 @@ +#!/usr/bin/env nix-shell +#!nix-shell -i bash -p curl jq gnugrep common-updater-scripts + +set -eu -o pipefail + +version=$(curl -s 'https://aur.archlinux.org/rpc/?v=5&type=info&arg[]=minecraft-launcher' | jq '.results[0].Version' | grep -Po '[.\d]*(?=-)') +update-source-version minecraft "$version" diff --git a/pkgs/misc/emulators/wine/sources.nix b/pkgs/misc/emulators/wine/sources.nix index 023e48fc991..7b26bf44cdc 100644 --- a/pkgs/misc/emulators/wine/sources.nix +++ b/pkgs/misc/emulators/wine/sources.nix @@ -39,16 +39,16 @@ in rec { unstable = fetchurl rec { # NOTE: Don't forget to change the SHA256 for staging as well. - version = "4.14"; + version = "4.16"; url = "https://dl.winehq.org/wine/source/4.x/wine-${version}.tar.xz"; - sha256 = "1rl1a3k5sr0hyxc61d68kwandhxcnxwv6b77vh7x2rkl1h4nxmfs"; + sha256 = "17qxbddv23ibbayw1ai984m0dlq63cgplms2jhsc09incjhafywd"; inherit (stable) mono gecko32 gecko64; }; staging = fetchFromGitHub rec { # https://github.com/wine-staging/wine-staging/releases inherit (unstable) version; - sha256 = "1s17hcrp1aa0v99y5iav2s0lxdx2rzgm7z0c4zhxyydqxj399f5j"; + sha256 = "0zkvwl6rxr6xcqk4a3h43cak67w6bcyqqnajz6azif07ir3z1c61"; owner = "wine-staging"; repo = "wine-staging"; rev = "v${version}"; @@ -56,8 +56,8 @@ in rec { winetricks = fetchFromGitHub rec { # https://github.com/Winetricks/winetricks/releases - version = "20190615"; - sha256 = "1bdvj363yjn7agqq1fxdfz31j1rrs2wc02v874jjx5sw1bfq5qsa"; + version = "20190912"; + sha256 = "08my9crgpj5ai77bm64v99x4kmdb9dl8fw14581n69id449v7gzv"; owner = "Winetricks"; repo = "winetricks"; rev = version; diff --git a/pkgs/misc/vim-plugins/overrides.nix b/pkgs/misc/vim-plugins/overrides.nix index d5a1ed67665..5fff24e9e5f 100644 --- a/pkgs/misc/vim-plugins/overrides.nix +++ b/pkgs/misc/vim-plugins/overrides.nix @@ -49,16 +49,16 @@ self: super: { }; LanguageClient-neovim = let - version = "0.1.146"; + version = "0.1.154"; LanguageClient-neovim-src = fetchurl { url = "https://github.com/autozimu/LanguageClient-neovim/archive/${version}.tar.gz"; - sha256 = "1xm98pyzf2dlh04ijjf3nkh37lyqspbbjddkjny1g06xxb4kfxnk"; + sha256 = "03sp643nihj9p2s9cx2dcazhz68s30qx7igqprgsmr1040rhg2py"; }; LanguageClient-neovim-bin = rustPlatform.buildRustPackage { name = "LanguageClient-neovim-bin"; src = LanguageClient-neovim-src; - cargoSha256 = "0dixvmwq611wg2g3rp1n1gqali46904fnhb90gcpl9a1diqb34sh"; + cargoSha256 = "1bvbls2l1xa0s3k11crvd98il4i20z5sn0hqmsc1b915k03qq4zj"; buildInputs = stdenv.lib.optionals stdenv.isDarwin [ CoreServices ]; # FIXME: Use impure version of CoreFoundation because of missing symbols. diff --git a/pkgs/os-specific/linux/zfs/default.nix b/pkgs/os-specific/linux/zfs/default.nix index 1b9b5a3ba51..d02a01fc93f 100644 --- a/pkgs/os-specific/linux/zfs/default.nix +++ b/pkgs/os-specific/linux/zfs/default.nix @@ -151,7 +151,7 @@ in { # to be adapted zfsStable = common { # comment/uncomment if breaking kernel versions are known - # incompatibleKernelVersion = "4.20"; + incompatibleKernelVersion = "5.3"; # this package should point to the latest release. version = "0.8.1"; @@ -165,7 +165,7 @@ in { zfsUnstable = common { # comment/uncomment if breaking kernel versions are known - # incompatibleKernelVersion = "4.19"; + incompatibleKernelVersion = "5.3"; # this package should point to a version / git revision compatible with the latest kernel release version = "0.8.1"; diff --git a/pkgs/servers/http/h2o/default.nix b/pkgs/servers/http/h2o/default.nix index 26c320499e5..a8de0d7e084 100644 --- a/pkgs/servers/http/h2o/default.nix +++ b/pkgs/servers/http/h2o/default.nix @@ -1,39 +1,30 @@ { stdenv, fetchFromGitHub -, pkgconfig, cmake +, pkgconfig, cmake, ninja , libressl, libuv, zlib }: -with builtins; - stdenv.mkDerivation rec { - pname = "h2o"; - version = "2.2.6"; + pname = "h2o"; + version = "2.3.0-beta2"; src = fetchFromGitHub { owner = "h2o"; repo = "h2o"; rev = "refs/tags/v${version}"; - sha256 = "0qni676wqvxx0sl0pw9j0ph7zf2krrzqc1zwj73mgpdnsr8rsib7"; + sha256 = "0lwg5sfsr7fw7cfy0hrhadgixm35b5cgcvlhwhbk89j72y1bqi6n"; }; - # We have to fix up some function prototypes, because despite upstream h2o - # issue #1705 (https://github.com/h2o/h2o/issues/1706), libressl 2.7+ doesn't - # seem to work - patchPhase = '' - substituteInPlace ./deps/neverbleed/neverbleed.c \ - --replace 'static void RSA_' 'void RSA_' \ - --replace 'static int RSA_' 'int RSA_' - ''; + outputs = [ "out" "man" "dev" "lib" ]; - nativeBuildInputs = [ pkgconfig cmake ]; - buildInputs = [ libressl libuv zlib ]; enableParallelBuilding = true; + nativeBuildInputs = [ pkgconfig cmake ninja ]; + buildInputs = [ libressl libuv zlib ]; - meta = { + meta = with stdenv.lib; { description = "Optimized HTTP/1 and HTTP/2 server"; homepage = https://h2o.examp1e.net; - license = stdenv.lib.licenses.mit; - maintainers = [ stdenv.lib.maintainers.thoughtpolice ]; - platforms = stdenv.lib.platforms.linux; + license = licenses.mit; + maintainers = with maintainers; [ thoughtpolice ]; + platforms = platforms.linux; }; } diff --git a/pkgs/servers/mautrix-telegram/default.nix b/pkgs/servers/mautrix-telegram/default.nix index 5ee491a0b8a..2908c14b4e0 100644 --- a/pkgs/servers/mautrix-telegram/default.nix +++ b/pkgs/servers/mautrix-telegram/default.nix @@ -4,11 +4,11 @@ with python3.pkgs; buildPythonPackage rec { pname = "mautrix-telegram"; - version = "0.6.0"; + version = "0.6.1"; src = fetchPypi { inherit pname version; - sha256 = "fbed41838e1ef7e43f6e47ff38f9906cb311cfc5b3b6bc6f704babd7c83b193d"; + sha256 = "1lsi6x5yr8f9yjxsh1rmcd6wnxr6s6rpr720lg7sq629m42d9p1d"; }; postPatch = '' diff --git a/pkgs/servers/monitoring/prometheus/apcupsd-exporter.nix b/pkgs/servers/monitoring/prometheus/apcupsd-exporter.nix new file mode 100644 index 00000000000..c1d7f792830 --- /dev/null +++ b/pkgs/servers/monitoring/prometheus/apcupsd-exporter.nix @@ -0,0 +1,27 @@ +{ stdenv, buildGoPackage, fetchFromGitHub }: + +buildGoPackage rec { + pname = "apcupsd-exporter"; + version = "unstable-2019-03-14"; + + goPackagePath = "github.com/mdlayher/apcupsd_exporter"; + + goDeps = ./apcupsd-exporter_deps.nix; + + src = fetchFromGitHub { + owner = "mdlayher"; + repo = "apcupsd_exporter"; + rev = "cbd49be"; + sha256 = "1h5z295m9bddch5bc8fppn02b31h370yns6026a1d4ygfy3w46y0"; + }; + + doCheck = true; + + meta = with stdenv.lib; { + description = "Provides a Prometheus exporter for the apcupsd Network Information Server (NIS)"; + homepage = "https://github.com/mdlayher/apcupsd_exporter"; + license = licenses.mit; + maintainers = with maintainers; [ maintainers."1000101" ]; + platforms = platforms.all; + }; +} diff --git a/pkgs/servers/monitoring/prometheus/apcupsd-exporter_deps.nix b/pkgs/servers/monitoring/prometheus/apcupsd-exporter_deps.nix new file mode 100644 index 00000000000..3950ae89bf2 --- /dev/null +++ b/pkgs/servers/monitoring/prometheus/apcupsd-exporter_deps.nix @@ -0,0 +1,93 @@ +# file generated from go.mod using vgo2nix (https://github.com/adisbladis/vgo2nix) +[ + { + goPackagePath = "github.com/beorn7/perks"; + fetch = { + type = "git"; + url = "https://github.com/beorn7/perks"; + rev = "3a771d992973"; + sha256 = "1l2lns4f5jabp61201sh88zf3b0q793w4zdgp9nll7mmfcxxjif3"; + }; + } + { + goPackagePath = "github.com/golang/protobuf"; + fetch = { + type = "git"; + url = "https://github.com/golang/protobuf"; + rev = "v1.2.0"; + sha256 = "0kf4b59rcbb1cchfny2dm9jyznp8ri2hsb14n8iak1q8986xa0ab"; + }; + } + { + goPackagePath = "github.com/matttproud/golang_protobuf_extensions"; + fetch = { + type = "git"; + url = "https://github.com/matttproud/golang_protobuf_extensions"; + rev = "v1.0.1"; + sha256 = "1d0c1isd2lk9pnfq2nk0aih356j30k3h1gi2w0ixsivi5csl7jya"; + }; + } + { + goPackagePath = "github.com/mdlayher/apcupsd"; + fetch = { + type = "git"; + url = "https://github.com/mdlayher/apcupsd"; + rev = "eb3dd99a75fe"; + sha256 = "0s1m6l4pnazqiymb8y89ajbxfl2cn0ahvhws10nvxvc4jjivlbbq"; + }; + } + { + goPackagePath = "github.com/prometheus/client_golang"; + fetch = { + type = "git"; + url = "https://github.com/prometheus/client_golang"; + rev = "v0.9.2"; + sha256 = "02b4yg6rfag0m3j0i39sillcm5xczwv8h133vn12yr8qw04cnigs"; + }; + } + { + goPackagePath = "github.com/prometheus/client_model"; + fetch = { + type = "git"; + url = "https://github.com/prometheus/client_model"; + rev = "5c3871d89910"; + sha256 = "04psf81l9fjcwascsys428v03fx4fi894h7fhrj2vvcz723q57k0"; + }; + } + { + goPackagePath = "github.com/prometheus/common"; + fetch = { + type = "git"; + url = "https://github.com/prometheus/common"; + rev = "4724e9255275"; + sha256 = "0pcx8hlnrxx5nnmpk786cn99rsgqk1jrd3c9f6fsx8qd8y5iwjy6"; + }; + } + { + goPackagePath = "github.com/prometheus/procfs"; + fetch = { + type = "git"; + url = "https://github.com/prometheus/procfs"; + rev = "1dc9a6cbc91a"; + sha256 = "1zlv1x30xp7z5c3vn5vp870v4bjim0zcidzc3mr2l3xhazc0svab"; + }; + } + { + goPackagePath = "golang.org/x/net"; + fetch = { + type = "git"; + url = "https://go.googlesource.com/net"; + rev = "351d144fa1fc"; + sha256 = "1c5x25qjyz83y92bq0lll5kmznyi3m02wd4c54scgf0866gy938k"; + }; + } + { + goPackagePath = "golang.org/x/sync"; + fetch = { + type = "git"; + url = "https://go.googlesource.com/sync"; + rev = "42b317875d0f"; + sha256 = "0mrjhk7al7yyh76x9flvxy4jm5jyqh2fxbxagpaazxn1xdgkaif3"; + }; + } +] diff --git a/pkgs/servers/openafs/1.8/module.nix b/pkgs/servers/openafs/1.8/module.nix index 95084458f47..d58d2bff813 100644 --- a/pkgs/servers/openafs/1.8/module.nix +++ b/pkgs/servers/openafs/1.8/module.nix @@ -1,5 +1,5 @@ { stdenv, fetchurl, which, autoconf, automake, flex, yacc -, kernel, glibc, perl, libtool_2, kerberos }: +, kernel, glibc, perl, libtool_2, kerberos, fetchpatch }: with (import ./srcs.nix { inherit fetchurl; }); @@ -11,6 +11,20 @@ in stdenv.mkDerivation { name = "openafs-${version}-${kernel.modDirVersion}"; inherit version src; + patches = [ + # Linux 5.3 + (fetchpatch { + name = "openafs_1_8-recurse-keyring_search.patch"; + url = "http://git.openafs.org/?p=openafs.git;a=patch;h=02d82275c17284d04629282aa374bb39f511c989"; + sha256 = "03pkldwf6i67yf6i1705qp18rx5b0b342ryda8vfjw9lnvpinygs"; + }) + (fetchpatch { + name = "openafs_1_8-send-sig.patch"; + url = "http://git.openafs.org/?p=openafs.git;a=patch;h=2b7af1243f46496c0b5973b3fa2a6396243f7613"; + sha256 = "13gyh5ncpp15dl7056gdzl5xhp2bmafc557bd2a4bwx9nyj53bag"; + }) + ]; + nativeBuildInputs = [ autoconf automake flex libtool_2 perl which yacc ] ++ kernel.moduleBuildDependencies; diff --git a/pkgs/servers/plex/raw.nix b/pkgs/servers/plex/raw.nix index cbe0dae3e14..b617fe6fa0e 100644 --- a/pkgs/servers/plex/raw.nix +++ b/pkgs/servers/plex/raw.nix @@ -8,13 +8,13 @@ # server, and the FHS userenv and corresponding NixOS module should # automatically pick up the changes. stdenv.mkDerivation rec { - version = "1.16.5.1554-1e5ff713d"; + version = "1.16.6.1592-b9d49bdb7"; pname = "plexmediaserver"; # Fetch the source src = fetchurl { url = "https://downloads.plex.tv/plex-media-server-new/${version}/redhat/plexmediaserver-${version}.x86_64.rpm"; - sha256 = "1h2f8dgwz9bnvj7h4nk61a5rpl62918nwq6v85d97miwjfc1mv6n"; + sha256 = "12wff06nlvcssa6sf6vhxajfd1dnr9870xn9fac4q7gf0yayj27j"; }; outputs = [ "out" "basedb" ]; diff --git a/pkgs/shells/liquidprompt/default.nix b/pkgs/shells/liquidprompt/default.nix new file mode 100644 index 00000000000..62efabb022c --- /dev/null +++ b/pkgs/shells/liquidprompt/default.nix @@ -0,0 +1,32 @@ +{ stdenv, fetchFromGitHub }: + +stdenv.mkDerivation rec { + pname = "liquidprompt"; + version = "unstable-2018-05-21"; + + src = fetchFromGitHub { + owner = "nojhan"; + repo = pname; + rev = "eda83efe4e0044f880370ed5e92aa7e3fdbef971"; + sha256 = "1p7ah3x850ajpq07xvxxd7fx2i67cf0n71ww085g32k9fwij4rd4"; + }; + + installPhase = '' + install -D -m 0444 liquidprompt $out/bin/liquidprompt + install -D -m 0444 liquidpromptrc-dist $out/share/doc/liquidprompt/liquidpromptrc-dist + install -D -m 0444 liquid.theme $out/share/doc/liquidprompt/liquid.theme + + install -D -m 0444 liquidprompt.plugin.zsh \ + $out/share/zsh/plugins/liquidprompt/liquidprompt.plugin.zsh + install -D -m 0444 liquidprompt \ + $out/share/zsh/plugins/liquidprompt/liquidprompt + ''; + + meta = with stdenv.lib; { + description = "A full-featured & carefully designed adaptive prompt for Bash & Zsh"; + homepage = https://github.com/nojhan/liquidprompt; + license = licenses.agpl3; + platforms = platforms.all; + maintainers = with maintainers; [ gerschtli ]; + }; +} diff --git a/pkgs/shells/zsh/oh-my-zsh/default.nix b/pkgs/shells/zsh/oh-my-zsh/default.nix index eea0c818920..7df43f7dab4 100644 --- a/pkgs/shells/zsh/oh-my-zsh/default.nix +++ b/pkgs/shells/zsh/oh-my-zsh/default.nix @@ -4,13 +4,13 @@ { stdenv, fetchgit }: stdenv.mkDerivation rec { - version = "2019-09-13"; + version = "2019-09-20"; pname = "oh-my-zsh"; - rev = "32338fd40cae45c775dadc34ae05476811a3834b"; + rev = "6cfaa076272e08b6a81b6358b78d020e48f8a4a6"; src = fetchgit { inherit rev; url = "https://github.com/robbyrussell/oh-my-zsh"; - sha256 = "0fp1hzxmml14ds12751icbsm2v3rhwm2vf5qzc65722fvvb98p0p"; + sha256 = "0i1mlw42g2w5pbg6zsl48pdwv1hy5zrwx9kq4w04mynwg7mc9hs5"; }; pathsToLink = [ "/share/oh-my-zsh" ]; diff --git a/pkgs/stdenv/adapters.nix b/pkgs/stdenv/adapters.nix index 8f62bd24dda..041964bcacc 100644 --- a/pkgs/stdenv/adapters.nix +++ b/pkgs/stdenv/adapters.nix @@ -62,7 +62,6 @@ rec { ]; mesonFlags = (args.mesonFlags or []) ++ [ "-Ddefault_library=static" ]; }); - static = true; }; diff --git a/pkgs/tools/filesystems/squashfs/0001-If-SOURCE_DATE_EPOCH-is-set-override-timestamps-with.patch b/pkgs/tools/filesystems/squashfs/0001-If-SOURCE_DATE_EPOCH-is-set-override-timestamps-with.patch deleted file mode 100644 index 5626800e723..00000000000 --- a/pkgs/tools/filesystems/squashfs/0001-If-SOURCE_DATE_EPOCH-is-set-override-timestamps-with.patch +++ /dev/null @@ -1,90 +0,0 @@ -From 0ab12a8585373be2de5129e14d979c62e7a90d82 Mon Sep 17 00:00:00 2001 -From: Chris Lamb <lamby@debian.org> -Date: Mon, 21 Nov 2016 09:33:05 +0100 -Subject: [PATCH] If SOURCE_DATE_EPOCH is set, override timestamps with that - value. - -See https://reproducible-builds.org/specs/source-date-epoch/ for more -information about this environment variable. - -Based on a patch by Alexander Couzens <lynxis@fe...> posted on -https://sourceforge.net/p/squashfs/mailman/message/34673610/ - -Signed-off-by: Chris Lamb <lamby@debian.org> ---- - squashfs-tools/mksquashfs.c | 38 ++++++++++++++++++++++++++++++++++++- - 1 file changed, 37 insertions(+), 1 deletion(-) - -diff --git a/squashfs-tools/mksquashfs.c b/squashfs-tools/mksquashfs.c -index c2098bd..b49e956 100644 ---- a/squashfs-tools/mksquashfs.c -+++ b/squashfs-tools/mksquashfs.c -@@ -137,6 +137,9 @@ unsigned int cache_bytes = 0, cache_size = 0, inode_count = 0; - /* inode lookup table */ - squashfs_inode *inode_lookup_table = NULL; - -+/* override filesystem creation time */ -+time_t mkfs_fixed_time = -1; -+ - /* in memory directory data */ - #define I_COUNT_SIZE 128 - #define DIR_ENTRIES 32 -@@ -5104,6 +5107,9 @@ int main(int argc, char *argv[]) - int total_mem = get_default_phys_mem(); - int progress = TRUE; - int force_progress = FALSE; -+ char *source_date_epoch, *endptr; -+ unsigned long long epoch; -+ - struct file_buffer **fragment = NULL; - - if(argc > 1 && strcmp(argv[1], "-version") == 0) { -@@ -5641,6 +5647,36 @@ printOptions: - } - } - -+ /* if SOURCE_DATE_EPOCH is set, use that timestamp for the mkfs time */ -+ source_date_epoch = getenv("SOURCE_DATE_EPOCH"); -+ if(source_date_epoch) { -+ errno = 0; -+ epoch = strtoull(source_date_epoch, &endptr, 10); -+ if((errno == ERANGE && (epoch == ULLONG_MAX || epoch == 0)) -+ || (errno != 0 && epoch == 0)) { -+ ERROR("Environment variable $SOURCE_DATE_EPOCH: " -+ "strtoull: %s\n", strerror(errno)); -+ EXIT_MKSQUASHFS(); -+ } -+ if(endptr == source_date_epoch) { -+ ERROR("Environment variable $SOURCE_DATE_EPOCH: " -+ "No digits were found: %s\n", endptr); -+ EXIT_MKSQUASHFS(); -+ } -+ if(*endptr != '\0') { -+ ERROR("Environment variable $SOURCE_DATE_EPOCH: " -+ "Trailing garbage: %s\n", endptr); -+ EXIT_MKSQUASHFS(); -+ } -+ if(epoch > ULONG_MAX) { -+ ERROR("Environment variable $SOURCE_DATE_EPOCH: " -+ "value must be smaller than or equal to " -+ "%lu but was found to be: %llu \n", ULONG_MAX, epoch); -+ EXIT_MKSQUASHFS(); -+ } -+ mkfs_fixed_time = (time_t)epoch; -+ } -+ - /* - * Some compressors may need the options to be checked for validity - * once all the options have been processed -@@ -5993,7 +6029,7 @@ printOptions: - sBlk.flags = SQUASHFS_MKFLAGS(noI, noD, noF, noX, no_fragments, - always_use_fragments, duplicate_checking, exportable, - no_xattrs, comp_opts); -- sBlk.mkfs_time = time(NULL); -+ sBlk.mkfs_time = mkfs_fixed_time != -1 ? mkfs_fixed_time : time(NULL); - - disable_info(); - --- -2.17.0 - diff --git a/pkgs/tools/filesystems/squashfs/0002-If-SOURCE_DATE_EPOCH-is-set-also-clamp-content-times.patch b/pkgs/tools/filesystems/squashfs/0002-If-SOURCE_DATE_EPOCH-is-set-also-clamp-content-times.patch deleted file mode 100644 index 5002375887f..00000000000 --- a/pkgs/tools/filesystems/squashfs/0002-If-SOURCE_DATE_EPOCH-is-set-also-clamp-content-times.patch +++ /dev/null @@ -1,83 +0,0 @@ -From 32a07d4156a281084c90a4b78affc8b0b32a26fc Mon Sep 17 00:00:00 2001 -From: intrigeri <intrigeri@boum.org> -Date: Mon, 21 Nov 2016 11:41:28 +0000 -Subject: [PATCH] If SOURCE_DATE_EPOCH is set, also clamp content timestamps - with that value. - -Based on a patch by Alexander Couzens <lynxis@fe...> posted on -https://sourceforge.net/p/squashfs/mailman/message/34673610/ ---- - squashfs-tools/mksquashfs.c | 15 ++++++++++++--- - 1 file changed, 12 insertions(+), 3 deletions(-) - -diff --git a/squashfs-tools/mksquashfs.c b/squashfs-tools/mksquashfs.c -index b49e956..9f020bf 100644 ---- a/squashfs-tools/mksquashfs.c -+++ b/squashfs-tools/mksquashfs.c -@@ -137,6 +137,9 @@ unsigned int cache_bytes = 0, cache_size = 0, inode_count = 0; - /* inode lookup table */ - squashfs_inode *inode_lookup_table = NULL; - -+/* clamp all timestamps to SOURCE_DATE_EPOCH */ -+time_t content_clamp_time = -1; -+ - /* override filesystem creation time */ - time_t mkfs_fixed_time = -1; - -@@ -2246,6 +2249,8 @@ restat: - pathname_reader(dir_ent), strerror(errno)); - goto read_err; - } -+ if(content_clamp_time != -1 && buf2.st_mtime >= content_clamp_time) -+ buf2.st_mtime = content_clamp_time; - - if(read_size != buf2.st_size) { - close(file); -@@ -3101,7 +3106,7 @@ void dir_scan(squashfs_inode *inode, char *pathname, - buf.st_mode = S_IRWXU | S_IRWXG | S_IRWXO | S_IFDIR; - buf.st_uid = getuid(); - buf.st_gid = getgid(); -- buf.st_mtime = time(NULL); -+ buf.st_mtime = content_clamp_time != -1 ? content_clamp_time : time(NULL); - buf.st_dev = 0; - buf.st_ino = 0; - dir_ent->inode = lookup_inode2(&buf, PSEUDO_FILE_OTHER, 0); -@@ -3127,6 +3115,8 @@ void dir_scan(squashfs_inode *inode, char *pathname, - /* source directory has disappeared? */ - BAD_ERROR("Cannot stat source directory %s because %s\n", - pathname, strerror(errno)); -+ if(content_clamp_time != -1 && buf.st_mtime >= content_clamp_time) -+ buf.st_mtime = content_clamp_time; - dir_ent->inode = lookup_inode(&buf); - } - -@@ -3365,6 +3372,8 @@ struct dir_info *dir_scan1(char *filename, char *subpath, - free_dir_entry(dir_ent); - continue; - } -+ if(content_clamp_time != -1 && buf.st_mtime >= content_clamp_time) -+ buf.st_mtime = content_clamp_time; - - if((buf.st_mode & S_IFMT) != S_IFREG && - (buf.st_mode & S_IFMT) != S_IFDIR && -@@ -3544,7 +3553,7 @@ void dir_scan2(struct dir_info *dir, struct pseudo *pseudo) - buf.st_gid = pseudo_ent->dev->gid; - buf.st_rdev = makedev(pseudo_ent->dev->major, - pseudo_ent->dev->minor); -- buf.st_mtime = time(NULL); -+ buf.st_mtime = content_clamp_time != -1 ? content_clamp_time : time(NULL); - buf.st_ino = pseudo_ino ++; - - if(pseudo_ent->dev->type == 'd') { -@@ -5674,7 +5683,7 @@ printOptions: - "%lu but was found to be: %llu \n", ULONG_MAX, epoch); - EXIT_MKSQUASHFS(); - } -- mkfs_fixed_time = (time_t)epoch; -+ mkfs_fixed_time = content_clamp_time = (time_t)epoch; - } - - /* --- -2.17.0 - diff --git a/pkgs/tools/filesystems/squashfs/0003-remove-frag-deflator-thread.patch b/pkgs/tools/filesystems/squashfs/0003-remove-frag-deflator-thread.patch deleted file mode 100644 index 4be4b96369a..00000000000 --- a/pkgs/tools/filesystems/squashfs/0003-remove-frag-deflator-thread.patch +++ /dev/null @@ -1,220 +0,0 @@ -From afc0c76a170bd17cbd29bbec6ae6d2227e398570 Mon Sep 17 00:00:00 2001 -From: Alexander Couzens <lynxis@fe80.eu> -Date: Fri, 13 Jan 2017 22:00:37 +0100 -Subject: [PATCH] remove frag_deflator_thread - -frag_deflator_thread compress fragments. -Replace the deflator_thread with a function and -use the function instead of the to_frag queue. ---- - squashfs-tools/info.c | 5 --- - squashfs-tools/mksquashfs.c | 76 +++++++++++++------------------------ - squashfs-tools/mksquashfs.h | 2 +- - squashfs-tools/restore.c | 15 +------- - 4 files changed, 30 insertions(+), 68 deletions(-) - -diff --git a/squashfs-tools/info.c b/squashfs-tools/info.c -index 7968c77..028d578 100644 ---- a/squashfs-tools/info.c -+++ b/squashfs-tools/info.c -@@ -96,11 +96,6 @@ void dump_state() - printf("compressed block queue (deflate thread(s) -> main thread)\n"); - dump_seq_queue(to_main, 0); - -- printf("uncompressed packed fragment queue (main thread -> fragment" -- " deflate thread(s))\n"); -- dump_queue(to_frag); -- -- - printf("locked frag queue (compressed frags waiting while multi-block" - " file is written)\n"); - dump_queue(locked_fragment); -diff --git a/squashfs-tools/mksquashfs.c b/squashfs-tools/mksquashfs.c -index cf48e40..cacf14c 100644 ---- a/squashfs-tools/mksquashfs.c -+++ b/squashfs-tools/mksquashfs.c -@@ -270,10 +270,10 @@ unsigned int sid_count = 0, suid_count = 0, sguid_count = 0; - struct cache *reader_buffer, *fragment_buffer, *reserve_cache; - struct cache *bwriter_buffer, *fwriter_buffer; - struct queue *to_reader, *to_deflate, *to_writer, *from_writer, -- *to_frag, *locked_fragment, *to_process_frag; -+ *locked_fragment, *to_process_frag; - struct seq_queue *to_main; - pthread_t reader_thread, writer_thread, main_thread; --pthread_t *deflator_thread, *frag_deflator_thread, *frag_thread; -+pthread_t *deflator_thread, *frag_thread; - pthread_t *restore_thread = NULL; - pthread_mutex_t fragment_mutex = PTHREAD_MUTEX_INITIALIZER; - pthread_mutex_t pos_mutex = PTHREAD_MUTEX_INITIALIZER; -@@ -323,7 +323,7 @@ struct dir_info *scan1_opendir(char *pathname, char *subpath, int depth); - void write_filesystem_tables(struct squashfs_super_block *sBlk, int nopad); - unsigned short get_checksum_mem(char *buff, int bytes); - void check_usable_phys_mem(int total_mem); -- -+void frag_deflator(struct file_buffer *file_buffer); - - void prep_exit() - { -@@ -1540,7 +1540,7 @@ void write_fragment(struct file_buffer *fragment) - pthread_mutex_lock(&fragment_mutex); - fragment_table[fragment->block].unused = 0; - fragments_outstanding ++; -- queue_put(to_frag, fragment); -+ frag_deflator(fragment); - pthread_cleanup_pop(1); - } - -@@ -2412,51 +2412,34 @@ void *deflator(void *arg) - } - - --void *frag_deflator(void *arg) -+void frag_deflator(struct file_buffer *file_buffer) - { -- void *stream = NULL; -- int res; - -- res = compressor_init(comp, &stream, block_size, 1); -- if(res) -- BAD_ERROR("frag_deflator:: compressor_init failed\n"); -- -- pthread_cleanup_push((void *) pthread_mutex_unlock, &fragment_mutex); -- -- while(1) { -- int c_byte, compressed_size; -- struct file_buffer *file_buffer = queue_get(to_frag); -- struct file_buffer *write_buffer = -+ int c_byte, compressed_size; -+ struct file_buffer *write_buffer = - cache_get(fwriter_buffer, file_buffer->block); - -- c_byte = mangle2(stream, write_buffer->data, file_buffer->data, -- file_buffer->size, block_size, noF, 1); -- compressed_size = SQUASHFS_COMPRESSED_SIZE_BLOCK(c_byte); -- write_buffer->size = compressed_size; -- pthread_mutex_lock(&fragment_mutex); -- if(fragments_locked == FALSE) { -- fragment_table[file_buffer->block].size = c_byte; -- fragment_table[file_buffer->block].start_block = bytes; -- write_buffer->block = bytes; -- bytes += compressed_size; -- fragments_outstanding --; -- queue_put(to_writer, write_buffer); -- pthread_mutex_unlock(&fragment_mutex); -- TRACE("Writing fragment %lld, uncompressed size %d, " -- "compressed size %d\n", file_buffer->block, -- file_buffer->size, compressed_size); -- } else { -- add_pending_fragment(write_buffer, c_byte, -- file_buffer->block); -- pthread_mutex_unlock(&fragment_mutex); -- } -- cache_block_put(file_buffer); -+ c_byte = mangle2(stream, write_buffer->data, file_buffer->data, -+ file_buffer->size, block_size, noF, 1); -+ compressed_size = SQUASHFS_COMPRESSED_SIZE_BLOCK(c_byte); -+ write_buffer->size = compressed_size; -+ if(fragments_locked == FALSE) { -+ fragment_table[file_buffer->block].size = c_byte; -+ fragment_table[file_buffer->block].start_block = bytes; -+ write_buffer->block = bytes; -+ bytes += compressed_size; -+ fragments_outstanding --; -+ queue_put(to_writer, write_buffer); -+ TRACE("Writing fragment %lld, uncompressed size %d, " -+ "compressed size %d\n", file_buffer->block, -+ file_buffer->size, compressed_size); -+ } else { -+ add_pending_fragment(write_buffer, c_byte, -+ file_buffer->block); - } -- -- pthread_cleanup_pop(0); -+ cache_block_put(file_buffer); - } - -- - struct file_buffer *get_file_buffer() - { - struct file_buffer *file_buffer = seq_queue_get(to_main); -@@ -4257,19 +4240,17 @@ void initialise_threads(int readq, int fragq, int bwriteq, int fwriteq, - multiply_overflow(processors * 3, sizeof(pthread_t))) - BAD_ERROR("Processors too large\n"); - -- deflator_thread = malloc(processors * 3 * sizeof(pthread_t)); -+ deflator_thread = malloc(processors * 2 * sizeof(pthread_t)); - if(deflator_thread == NULL) - MEM_ERROR(); - -- frag_deflator_thread = &deflator_thread[processors]; -- frag_thread = &frag_deflator_thread[processors]; -+ frag_thread = &deflator_thread[processors]; - - to_reader = queue_init(1); - to_deflate = queue_init(reader_size); - to_process_frag = queue_init(reader_size); - to_writer = queue_init(bwriter_size + fwriter_size); - from_writer = queue_init(1); -- to_frag = queue_init(fragment_size); - locked_fragment = queue_init(fragment_size); - to_main = seq_queue_init(); - reader_buffer = cache_init(block_size, reader_size, 0, 0); -@@ -4285,9 +4266,6 @@ void initialise_threads(int readq, int fragq, int bwriteq, int fwriteq, - for(i = 0; i < processors; i++) { - if(pthread_create(&deflator_thread[i], NULL, deflator, NULL)) - BAD_ERROR("Failed to create thread\n"); -- if(pthread_create(&frag_deflator_thread[i], NULL, frag_deflator, -- NULL) != 0) -- BAD_ERROR("Failed to create thread\n"); - if(pthread_create(&frag_thread[i], NULL, frag_thrd, - (void *) destination_file) != 0) - BAD_ERROR("Failed to create thread\n"); -diff --git a/squashfs-tools/mksquashfs.h b/squashfs-tools/mksquashfs.h -index 55708a3..dc5bde4 100644 ---- a/squashfs-tools/mksquashfs.h -+++ b/squashfs-tools/mksquashfs.h -@@ -135,7 +135,7 @@ struct append_file { - extern struct cache *reader_buffer, *fragment_buffer, *reserve_cache; - struct cache *bwriter_buffer, *fwriter_buffer; - extern struct queue *to_reader, *to_deflate, *to_writer, *from_writer, -- *to_frag, *locked_fragment, *to_process_frag; -+ *locked_fragment, *to_process_frag; - extern struct append_file **file_mapping; - extern struct seq_queue *to_main; - extern pthread_mutex_t fragment_mutex, dup_mutex; -diff --git a/squashfs-tools/restore.c b/squashfs-tools/restore.c -index 5e336b3..a7aaf2e 100644 ---- a/squashfs-tools/restore.c -+++ b/squashfs-tools/restore.c -@@ -47,8 +47,8 @@ - #define TRUE 1 - - extern pthread_t reader_thread, writer_thread, main_thread; --extern pthread_t *deflator_thread, *frag_deflator_thread, *frag_thread; --extern struct queue *to_deflate, *to_writer, *to_frag, *to_process_frag; -+extern pthread_t *deflator_thread, *frag_thread; -+extern struct queue *to_deflate, *to_writer, *to_process_frag; - extern struct seq_queue *to_main; - extern void restorefs(); - extern int processors; -@@ -120,17 +120,6 @@ void *restore_thrd(void *arg) - pthread_cancel(main_thread); - pthread_join(main_thread, NULL); - -- /* then flush the main thread to fragment deflator thread(s) -- * queue. The fragment deflator thread(s) will idle -- */ -- queue_flush(to_frag); -- -- /* now kill the fragment deflator thread(s) */ -- for(i = 0; i < processors; i++) -- pthread_cancel(frag_deflator_thread[i]); -- for(i = 0; i < processors; i++) -- pthread_join(frag_deflator_thread[i], NULL); -- - /* - * then flush the main thread/fragment deflator thread(s) - * to writer thread queue. The writer thread will idle --- -2.17.0 - diff --git a/pkgs/tools/filesystems/squashfs/squashfs-tools-4.4-4k-align.patch b/pkgs/tools/filesystems/squashfs/4k-align.patch index c9c3dd3d760..e73c0678875 100644 --- a/pkgs/tools/filesystems/squashfs/squashfs-tools-4.4-4k-align.patch +++ b/pkgs/tools/filesystems/squashfs/4k-align.patch @@ -1,3 +1,7 @@ +This patch has been edited to apply to squashfs 4.4, commit +52eb4c279cd283ed9802dd1ceb686560b22ffb67. Below is the original +message body of the patch. + From 7bda7c75748f36b0a50f93e46144d5a4de4974ad Mon Sep 17 00:00:00 2001 From: Amin Hassani <ahassani@google.com> Date: Thu, 15 Dec 2016 10:43:15 -0800 @@ -16,20 +20,24 @@ increased_size = (number_of_unfragmented_files_in_image + number of fragments) * The 4k alignment can be enabled by flag '-4k-align' --- -diff -u a/squashfs-tools/mksquashfs.c b/squashfs-tools/mksquashfs.c ---- a/squashfs-tools/mksquashfs.c 2019-07-06 15:50:22.214873176 +0000 -+++ b/squashfs-tools/mksquashfs.c 2019-07-06 15:51:22.244802582 +0000 -@@ -100,7 +100,9 @@ + squashfs-tools/mksquashfs.c | 16 ++++++++++++++++ + 1 file changed, 16 insertions(+) + +diff --git a/squashfs-tools/mksquashfs.c b/squashfs-tools/mksquashfs.c +index a45b77f..07b1c06 100644 +--- a/squashfs-tools/mksquashfs.c ++++ b/squashfs-tools/mksquashfs.c +@@ -102,7 +102,9 @@ int old_exclude = TRUE; int use_regex = FALSE; int nopad = FALSE; int exit_on_error = FALSE; +int do_4k_align = FALSE; - static off_t squashfs_start_offset = 0; + long long start_offset = 0; +#define ALIGN_UP(bytes, size) (bytes = (bytes + size - 1) & ~(size - 1)) long long global_uid = -1, global_gid = -1; -@@ -1495,6 +1497,9 @@ +@@ -1546,6 +1548,9 @@ void unlock_fragments() * queue at this time. */ while(!queue_empty(locked_fragment)) { @@ -39,17 +47,17 @@ diff -u a/squashfs-tools/mksquashfs.c b/squashfs-tools/mksquashfs.c write_buffer = queue_get(locked_fragment); frg = write_buffer->block; size = SQUASHFS_COMPRESSED_SIZE_BLOCK(fragment_table[frg].size); -@@ -2414,6 +2419,9 @@ - compressed_size = SQUASHFS_COMPRESSED_SIZE_BLOCK(c_byte); - write_buffer->size = compressed_size; - if(fragments_locked == FALSE) { -+ // 4k align the start of each fragment. -+ if(do_4k_align) -+ ALIGN_UP(bytes, 4096); - fragment_table[file_buffer->block].size = c_byte; - fragment_table[file_buffer->block].start_block = bytes; - write_buffer->block = bytes; -@@ -2728,6 +2736,10 @@ +@@ -2478,6 +2483,9 @@ void *frag_deflator(void *arg) + write_buffer->size = compressed_size; + pthread_mutex_lock(&fragment_mutex); + if(fragments_locked == FALSE) { ++ // 4k align the start of each fragment. ++ if(do_4k_align) ++ ALIGN_UP(bytes, 4096); + fragment_table[file_buffer->block].size = c_byte; + fragment_table[file_buffer->block].start_block = bytes; + write_buffer->block = bytes; +@@ -2877,6 +2885,10 @@ int write_file_blocks(squashfs_inode *inode, struct dir_ent *dir_ent, long long sparse = 0; struct file_buffer *fragment_buffer = NULL; @@ -60,7 +68,7 @@ diff -u a/squashfs-tools/mksquashfs.c b/squashfs-tools/mksquashfs.c if(pre_duplicate(read_size)) return write_file_blocks_dup(inode, dir_ent, read_buffer, dup); -@@ -4808,6 +4820,7 @@ +@@ -4972,6 +4984,7 @@ void write_filesystem_tables(struct squashfs_super_block *sBlk, int nopad) "compressed", no_fragments ? "no" : noF ? "uncompressed" : "compressed", no_xattrs ? "no" : noX ? "uncompressed" : "compressed", noI || noId ? "uncompressed" : "compressed"); @@ -68,7 +76,7 @@ diff -u a/squashfs-tools/mksquashfs.c b/squashfs-tools/mksquashfs.c printf("\tduplicates are %sremoved\n", duplicate_checking ? "" : "not "); printf("Filesystem size %.2f Kbytes (%.2f Mbytes)\n", bytes / 1024.0, -@@ -5570,6 +5583,8 @@ +@@ -5853,6 +5866,8 @@ print_compressor_options: root_name = argv[i]; } else if(strcmp(argv[i], "-version") == 0) { VERSION(); @@ -77,7 +85,7 @@ diff -u a/squashfs-tools/mksquashfs.c b/squashfs-tools/mksquashfs.c } else { ERROR("%s: invalid option\n\n", argv[0]); printOptions: -@@ -5613,6 +5628,7 @@ +@@ -5904,6 +5919,7 @@ printOptions: ERROR("\t\t\tdirectory containing that directory, " "rather than the\n"); ERROR("\t\t\tcontents of the directory\n"); @@ -85,3 +93,6 @@ diff -u a/squashfs-tools/mksquashfs.c b/squashfs-tools/mksquashfs.c ERROR("\nFilesystem filter options:\n"); ERROR("-p <pseudo-definition>\tAdd pseudo file " "definition\n"); +-- +2.23.0 + diff --git a/pkgs/tools/filesystems/squashfs/darwin.patch b/pkgs/tools/filesystems/squashfs/darwin.patch index 6022e65be47..eb2dc24ec1a 100644 --- a/pkgs/tools/filesystems/squashfs/darwin.patch +++ b/pkgs/tools/filesystems/squashfs/darwin.patch @@ -1,5 +1,11 @@ +Patch based on commits by Dave Vasilevsky <dave@vasilevsky.ca> and +Blake Riley <blake.riley@gmail.com>, squashed into a single patch, +with BSD-specific changes omitted. + +See also https://github.com/plougher/squashfs-tools/pull/69. + diff --git a/squashfs-tools/action.c b/squashfs-tools/action.c -index 4b06ccb..26365e7 100644 +index 4b06ccb..3cad2ab 100644 --- a/squashfs-tools/action.c +++ b/squashfs-tools/action.c @@ -38,6 +38,10 @@ @@ -7,7 +13,7 @@ index 4b06ccb..26365e7 100644 #include <errno.h> +#ifndef FNM_EXTMATCH /* glibc extension */ -+ #define FNM_EXTMATCH 0 ++ #define FNM_EXTMATCH 0 +#endif + #include "squashfs_fs.h" @@ -28,21 +34,21 @@ index 4b06ccb..26365e7 100644 /* diff --git a/squashfs-tools/info.c b/squashfs-tools/info.c -index 7968c77..c8e4c52 100644 +index fe23d78..5c2f835 100644 --- a/squashfs-tools/info.c +++ b/squashfs-tools/info.c -@@ -134,31 +134,22 @@ void dump_state() +@@ -144,31 +144,22 @@ void dump_state() void *info_thrd(void *arg) { sigset_t sigmask; - struct timespec timespec = { .tv_sec = 1, .tv_nsec = 0 }; - int sig, waiting = 0; -+ int sig, err, waiting = 0; ++ int sig, err, waiting = 0; sigemptyset(&sigmask); sigaddset(&sigmask, SIGQUIT); sigaddset(&sigmask, SIGHUP); -+ sigaddset(&sigmask, SIGALRM); ++ sigaddset(&sigmask, SIGALRM); while(1) { - if(waiting) @@ -64,11 +70,11 @@ index 7968c77..c8e4c52 100644 continue; default: - BAD_ERROR("sigtimedwait/sigwaitinfo failed " -+ BAD_ERROR("sigwaitfailed " ++ BAD_ERROR("sigwait failed " "because %s\n", strerror(errno)); } } -@@ -169,8 +160,12 @@ void *info_thrd(void *arg) +@@ -179,8 +170,12 @@ void *info_thrd(void *arg) /* set one second interval period, if ^\ received within then, dump queue and cache status */ waiting = 1; @@ -83,119 +89,46 @@ index 7968c77..c8e4c52 100644 } diff --git a/squashfs-tools/mksquashfs.c b/squashfs-tools/mksquashfs.c -index d696a51..c86d1b3 100644 +index a45b77f..3607448 100644 --- a/squashfs-tools/mksquashfs.c +++ b/squashfs-tools/mksquashfs.c -@@ -50,6 +50,10 @@ +@@ -35,7 +35,12 @@ + #include <stddef.h> + #include <sys/types.h> + #include <sys/stat.h> ++#ifndef linux ++#include <sys/sysctl.h> ++#else ++#include <sys/sysinfo.h> + #include <sys/sysmacros.h> ++#endif + #include <fcntl.h> + #include <errno.h> + #include <dirent.h> +@@ -50,7 +55,10 @@ + #include <sys/wait.h> #include <limits.h> #include <ctype.h> - +-#include <sys/sysinfo.h> ++ +#ifndef FNM_EXTMATCH /* glibc extension */ -+ #define FNM_EXTMATCH 0 ++ #define FNM_EXTMATCH 0 +#endif -+ + #ifndef linux #define __BYTE_ORDER BYTE_ORDER - #define __BIG_ENDIAN BIG_ENDIAN -@@ -831,13 +835,13 @@ char *subpathname(struct dir_ent *dir_ent) - } - - --inline unsigned int get_inode_no(struct inode_info *inode) -+static inline unsigned int get_inode_no(struct inode_info *inode) - { - return inode->inode_number; - } - - --inline unsigned int get_parent_no(struct dir_info *dir) -+static inline unsigned int get_parent_no(struct dir_info *dir) - { - return dir->depth ? get_inode_no(dir->dir_ent->inode) : inode_no; - } -@@ -2030,7 +2034,7 @@ struct file_info *duplicate(long long file_size, long long bytes, - } - - --inline int is_fragment(struct inode_info *inode) -+static inline int is_fragment(struct inode_info *inode) - { - off_t file_size = inode->buf.st_size; - -@@ -2999,13 +3003,13 @@ struct inode_info *lookup_inode2(struct stat *buf, int pseudo, int id) - } - - --inline struct inode_info *lookup_inode(struct stat *buf) -+static inline struct inode_info *lookup_inode(struct stat *buf) - { - return lookup_inode2(buf, 0, 0); - } - - --inline void alloc_inode_no(struct inode_info *inode, unsigned int use_this) -+static inline void alloc_inode_no(struct inode_info *inode, unsigned int use_this) - { - if (inode->inode_number == 0) { - inode->inode_number = use_this ? : inode_no ++; -@@ -3016,7 +3020,7 @@ inline void alloc_inode_no(struct inode_info *inode, unsigned int use_this) - } - - --inline struct dir_ent *create_dir_entry(char *name, char *source_name, -+static inline struct dir_ent *create_dir_entry(char *name, char *source_name, - char *nonstandard_pathname, struct dir_info *dir) - { - struct dir_ent *dir_ent = malloc(sizeof(struct dir_ent)); -@@ -3034,7 +3038,7 @@ inline struct dir_ent *create_dir_entry(char *name, char *source_name, - } - - --inline void add_dir_entry(struct dir_ent *dir_ent, struct dir_info *sub_dir, -+static inline void add_dir_entry(struct dir_ent *dir_ent, struct dir_info *sub_dir, - struct inode_info *inode_info) - { - struct dir_info *dir = dir_ent->our_dir; -@@ -3050,7 +3054,7 @@ inline void add_dir_entry(struct dir_ent *dir_ent, struct dir_info *sub_dir, - } - - --inline void add_dir_entry2(char *name, char *source_name, -+static inline void add_dir_entry2(char *name, char *source_name, - char *nonstandard_pathname, struct dir_info *sub_dir, - struct inode_info *inode_info, struct dir_info *dir) - { -@@ -3062,7 +3066,7 @@ inline void add_dir_entry2(char *name, char *source_name, - } - - --inline void free_dir_entry(struct dir_ent *dir_ent) -+static inline void free_dir_entry(struct dir_ent *dir_ent) - { - if(dir_ent->name) - free(dir_ent->name); -@@ -3083,7 +3087,7 @@ inline void free_dir_entry(struct dir_ent *dir_ent) - } - - --inline void add_excluded(struct dir_info *dir) -+static inline void add_excluded(struct dir_info *dir) - { - dir->excluded ++; - } -@@ -4200,6 +4204,7 @@ void initialise_threads(int readq, int fragq, int bwriteq, int fwriteq, +@@ -4348,6 +4356,7 @@ void initialise_threads(int readq, int fragq, int bwriteq, int fwriteq, sigemptyset(&sigmask); sigaddset(&sigmask, SIGQUIT); sigaddset(&sigmask, SIGHUP); + sigaddset(&sigmask, SIGALRM); - if(pthread_sigmask(SIG_BLOCK, &sigmask, NULL) == -1) + if(pthread_sigmask(SIG_BLOCK, &sigmask, NULL) != 0) BAD_ERROR("Failed to set signal mask in intialise_threads\n"); -@@ -4987,6 +4992,36 @@ int parse_num(char *arg, int *res) +@@ -5195,6 +5204,35 @@ int get_physical_memory() + long long page_size = sysconf(_SC_PAGESIZE); + int phys_mem; - int get_physical_memory() - { -+ int phys_mem; +#ifndef linux + #ifdef HW_MEMSIZE + #define SYSCTL_PHYSMEM HW_MEMSIZE @@ -223,50 +156,21 @@ index d696a51..c86d1b3 100644 + ERROR_EXIT(" Defaulting to least viable amount\n"); + phys_mem = SQUASHFS_LOWMEM; + } -+ #undef SYSCTL_PHYSMEM ++ #undef SYSCTL_PHYSMEM +#else - /* - * Long longs are used here because with PAE, a 32-bit - * machine can have more than 4GB of physical memory -@@ -4996,10 +5031,11 @@ int get_physical_memory() - */ - long long num_pages = sysconf(_SC_PHYS_PAGES); - long long page_size = sysconf(_SC_PAGESIZE); -- int phys_mem = num_pages * page_size >> 20; -+ phys_mem = num_pages * page_size >> 20; + if(num_pages == -1 || page_size == -1) { + struct sysinfo sys; + int res = sysinfo(&sys); +@@ -5207,6 +5245,7 @@ int get_physical_memory() + } - if(num_pages == -1 || page_size == -1) - return 0; + phys_mem = num_pages * page_size >> 20; +#endif if(phys_mem < SQUASHFS_LOWMEM) BAD_ERROR("Mksquashfs requires more physical memory than is " -diff --git a/squashfs-tools/mksquashfs.h b/squashfs-tools/mksquashfs.h -index 55708a3..d44d1fd 100644 ---- a/squashfs-tools/mksquashfs.h -+++ b/squashfs-tools/mksquashfs.h -@@ -24,6 +24,7 @@ - * mksquashfs.h - * - */ -+#include <pthread.h> - - struct dir_info { - char *pathname; -diff --git a/squashfs-tools/pseudo.c b/squashfs-tools/pseudo.c -index cb74cf6..fe2b4bc 100644 ---- a/squashfs-tools/pseudo.c -+++ b/squashfs-tools/pseudo.c -@@ -30,6 +30,7 @@ - #include <errno.h> - #include <string.h> - #include <stdlib.h> -+#include <sys/stat.h> - #include <sys/types.h> - #include <sys/wait.h> - #include <sys/stat.h> diff --git a/squashfs-tools/read_xattrs.c b/squashfs-tools/read_xattrs.c -index 42106f5..837d3fb 100644 +index 4debedf..3257c30 100644 --- a/squashfs-tools/read_xattrs.c +++ b/squashfs-tools/read_xattrs.c @@ -39,13 +39,13 @@ @@ -286,10 +190,10 @@ index 42106f5..837d3fb 100644 extern int read_block(int, long long, long long *, int, void *); diff --git a/squashfs-tools/unsquashfs.c b/squashfs-tools/unsquashfs.c -index f190e96..927e441 100644 +index 727f1d5..c1a6183 100644 --- a/squashfs-tools/unsquashfs.c +++ b/squashfs-tools/unsquashfs.c -@@ -32,7 +32,12 @@ +@@ -32,8 +32,12 @@ #include "stdarg.h" #include "fnmatch_compat.h" @@ -297,21 +201,40 @@ index f190e96..927e441 100644 +#include <sys/sysctl.h> +#else #include <sys/sysinfo.h> + #include <sys/sysmacros.h> +#endif -+ #include <sys/types.h> #include <sys/time.h> #include <sys/resource.h> -@@ -2185,6 +2190,7 @@ void initialise_threads(int fragment_buffer_size, int data_buffer_size) +@@ -1080,7 +1084,7 @@ int create_inode(char *pathname, struct inode *i) + break; + case SQUASHFS_SYMLINK_TYPE: + case SQUASHFS_LSYMLINK_TYPE: { +- struct timespec times[2] = { ++ struct timeval times[2] = { + { i->time, 0 }, + { i->time, 0 } + }; +@@ -1099,8 +1103,7 @@ int create_inode(char *pathname, struct inode *i) + goto failed; + } + +- res = utimensat(AT_FDCWD, pathname, times, +- AT_SYMLINK_NOFOLLOW); ++ res = lutimes(pathname, times); + if(res == -1) { + EXIT_UNSQUASH_STRICT("create_inode: failed to set time on " + "%s, because %s\n", pathname, +@@ -2235,6 +2238,7 @@ void initialise_threads(int fragment_buffer_size, int data_buffer_size) sigemptyset(&sigmask); sigaddset(&sigmask, SIGQUIT); sigaddset(&sigmask, SIGHUP); + sigaddset(&sigmask, SIGALRM); - if(pthread_sigmask(SIG_BLOCK, &sigmask, NULL) == -1) + if(pthread_sigmask(SIG_BLOCK, &sigmask, NULL) != 0) EXIT_UNSQUASH("Failed to set signal mask in initialise_threads" "\n"); diff --git a/squashfs-tools/unsquashfs.h b/squashfs-tools/unsquashfs.h -index 0edbd25..cea9caa 100644 +index 934618b..0e680ab 100644 --- a/squashfs-tools/unsquashfs.h +++ b/squashfs-tools/unsquashfs.h @@ -46,6 +46,10 @@ @@ -319,7 +242,7 @@ index 0edbd25..cea9caa 100644 #include <sys/time.h> +#ifndef FNM_EXTMATCH /* glibc extension */ -+ #define FNM_EXTMATCH 0 ++ #define FNM_EXTMATCH 0 +#endif + #ifndef linux @@ -381,7 +304,7 @@ index c8e2b9b..7d4f7af 100644 } diff --git a/squashfs-tools/unsquashfs_xattr.c b/squashfs-tools/unsquashfs_xattr.c -index 59f4aae..13f0e35 100644 +index 7742dfe..f8cd3b6 100644 --- a/squashfs-tools/unsquashfs_xattr.c +++ b/squashfs-tools/unsquashfs_xattr.c @@ -27,6 +27,11 @@ @@ -389,15 +312,15 @@ index 59f4aae..13f0e35 100644 #include <sys/xattr.h> +#ifdef XATTR_NOFOLLOW /* Apple's xattrs */ -+ #define lsetxattr(path_, name_, val_, sz_, flags_) \ -+ setxattr(path_, name_, val_, sz_, 0, flags_ | XATTR_NOFOLLOW) ++ #define lsetxattr(path_, name_, val_, sz_, flags_) \ ++ setxattr(path_, name_, val_, sz_, 0, flags_ | XATTR_NOFOLLOW) +#endif + #define NOSPACE_MAX 10 extern int root_process; diff --git a/squashfs-tools/xattr.c b/squashfs-tools/xattr.c -index b46550c..5b32eca 100644 +index 64dfd82..d82d186 100644 --- a/squashfs-tools/xattr.c +++ b/squashfs-tools/xattr.c @@ -22,6 +22,14 @@ @@ -420,12 +343,15 @@ index b46550c..5b32eca 100644 #include <sys/xattr.h> +#ifdef XATTR_NOFOLLOW /* Apple's xattrs */ -+ #define llistxattr(path_, buf_, sz_) \ -+ listxattr(path_, buf_, sz_, XATTR_NOFOLLOW) -+ #define lgetxattr(path_, name_, val_, sz_) \ -+ getxattr(path_, name_, val_, sz_, 0, XATTR_NOFOLLOW) ++ #define llistxattr(path_, buf_, sz_) \ ++ listxattr(path_, buf_, sz_, XATTR_NOFOLLOW) ++ #define lgetxattr(path_, name_, val_, sz_) \ ++ getxattr(path_, name_, val_, sz_, 0, XATTR_NOFOLLOW) +#endif + #include "squashfs_fs.h" #include "squashfs_swap.h" #include "mksquashfs.h" +-- +2.23.0 + diff --git a/pkgs/tools/filesystems/squashfs/default.nix b/pkgs/tools/filesystems/squashfs/default.nix index 5bd3b27eded..15a535eed3b 100644 --- a/pkgs/tools/filesystems/squashfs/default.nix +++ b/pkgs/tools/filesystems/squashfs/default.nix @@ -8,26 +8,20 @@ assert lz4Support -> (lz4 != null); stdenv.mkDerivation { pname = "squashfs"; - version = "4.4dev_20180612"; + version = "4.4"; src = fetchFromGitHub { owner = "plougher"; repo = "squashfs-tools"; - sha256 = "1y53z8dkph3khdyhkmkmy0sg9p1n8czv3vj4l324nj8kxyih3l2c"; - rev = "6e242dc95485ada8d1d0b3dd9346c5243d4a517f"; + sha256 = "0697fv8n6739mcyn57jclzwwbbqwpvjdfkv1qh9s56lvyqnplwaw"; + # Tag "4.4" points to this commit. + rev = "52eb4c279cd283ed9802dd1ceb686560b22ffb67"; }; patches = [ - # These patches ensures that mksquashfs output is reproducible. - # See also https://reproducible-builds.org/docs/system-images/ - # and https://github.com/NixOS/nixpkgs/issues/40144. - ./0001-If-SOURCE_DATE_EPOCH-is-set-override-timestamps-with.patch - ./0002-If-SOURCE_DATE_EPOCH-is-set-also-clamp-content-times.patch - ./0003-remove-frag-deflator-thread.patch - # This patch adds an option to pad filesystems (increasing size) in # exchange for better chunking / binary diff calculation. - ./squashfs-tools-4.4-4k-align.patch + ./4k-align.patch ] ++ stdenv.lib.optional stdenv.isDarwin ./darwin.patch; buildInputs = [ zlib xz zstd ] diff --git a/pkgs/tools/misc/shunit2/default.nix b/pkgs/tools/misc/shunit2/default.nix new file mode 100644 index 00000000000..acfbd48c606 --- /dev/null +++ b/pkgs/tools/misc/shunit2/default.nix @@ -0,0 +1,32 @@ +{ stdenv, fetchFromGitHub }: + +stdenv.mkDerivation { + pname = "shunit2"; + version = "2019-08-10"; + + src = fetchFromGitHub { + owner = "kward"; + repo = "shunit2"; + rev = "ba130d69bbff304c0c6a9c5e8ab549ae140d6225"; + sha256 = "1bsn8dhxbjfmh01lq80yhnld3w3fw1flh7nwx12csrp58zsvlmgk"; + }; + + installPhase = '' + mkdir -p $out/bin/ + cp ./shunit2 $out/bin/shunit2 + chmod +x $out/bin/shunit2 + ''; + + doInstallCheck = true; + installCheckPhase = '' + $out/bin/shunit2 + ''; + + meta = with stdenv.lib; { + homepage = https://github.com/kward/shunit2; + description = "A xUnit based unit test framework for Bourne based shell scripts."; + maintainers = with maintainers; [ cdepillabout utdemir ]; + license = licenses.asl20; + platforms = platforms.unix; + }; +} diff --git a/pkgs/tools/networking/httpie/default.nix b/pkgs/tools/networking/httpie/default.nix index 6395fcf09eb..cf3c173e1b2 100644 --- a/pkgs/tools/networking/httpie/default.nix +++ b/pkgs/tools/networking/httpie/default.nix @@ -1,15 +1,15 @@ -{ stdenv, fetchurl, pythonPackages }: +{ stdenv, fetchurl, python3Packages }: -pythonPackages.buildPythonApplication rec { +python3Packages.buildPythonApplication rec { pname = "httpie"; version = "1.0.3"; - src = pythonPackages.fetchPypi { + src = python3Packages.fetchPypi { inherit pname version; sha256 = "103fcigpxf4nqmrdqjnyz7d9n4n16906slwmmqqc0gkxv8hnw6vd"; }; - propagatedBuildInputs = with pythonPackages; [ pygments requests ]; + propagatedBuildInputs = with python3Packages; [ pygments requests setuptools ]; doCheck = false; diff --git a/pkgs/tools/networking/ip2unix/default.nix b/pkgs/tools/networking/ip2unix/default.nix index ab09399cd8e..d2dbd235e11 100644 --- a/pkgs/tools/networking/ip2unix/default.nix +++ b/pkgs/tools/networking/ip2unix/default.nix @@ -5,13 +5,13 @@ stdenv.mkDerivation rec { pname = "ip2unix"; - version = "2.1.0"; + version = "2.1.1"; src = fetchFromGitHub { owner = "nixcloud"; repo = "ip2unix"; rev = "v${version}"; - sha256 = "1hbc7csicgza1w43aq1q189w8gzwkc2v5mxpnhaiwggwsa5vvkl0"; + sha256 = "121ygj50i7ja9bv76y51qsjbjmmydhpi0sd3xb6pysmlzv0bxn17"; }; nativeBuildInputs = [ diff --git a/pkgs/tools/security/tor/default.nix b/pkgs/tools/security/tor/default.nix index 249ff435c5f..527c8064bac 100644 --- a/pkgs/tools/security/tor/default.nix +++ b/pkgs/tools/security/tor/default.nix @@ -15,11 +15,11 @@ stdenv.mkDerivation rec { pname = "tor"; - version = "0.4.1.5"; + version = "0.4.1.6"; src = fetchurl { url = "https://dist.torproject.org/${pname}-${version}.tar.gz"; - sha256 = "0984jb6hdcc10f7aq8xzl7l4jf93skp45wkv2v63z4zv0nvf0r58"; + sha256 = "0wgdid8w7srd218hh4rwslzdx2ickxw1pg18p2wry1r6wi65521a"; }; outputs = [ "out" "geoip" ]; diff --git a/pkgs/tools/system/plan9port/builder.sh b/pkgs/tools/system/plan9port/builder.sh index 77f6632ff53..f5c447ea0a5 100644 --- a/pkgs/tools/system/plan9port/builder.sh +++ b/pkgs/tools/system/plan9port/builder.sh @@ -22,7 +22,7 @@ plan9portLinkFlags() configurePhase() { ( - echo CC9=\"$(which $CC)\" + echo CC9=\"$(command -v $CC)\" echo CFLAGS=\"$NIX_CFLAGS_COMPILE\" echo LDFLAGS=\"$(plan9portLinkFlags)\" echo X11=\"${libXt_dev}/include\" diff --git a/pkgs/top-level/aliases.nix b/pkgs/top-level/aliases.nix index f27ec1a35bf..38ca7129645 100644 --- a/pkgs/top-level/aliases.nix +++ b/pkgs/top-level/aliases.nix @@ -216,6 +216,7 @@ mapAliases ({ mlt-qt5 = libsForQt5.mlt; # added 2015-12-19 mobile_broadband_provider_info = mobile-broadband-provider-info; # added 2018-02-25 module_init_tools = kmod; # added 2016-04-22 + mono-zeroconf = throw "deprecated 2019-09-20: abandoned by upstream."; mpich2 = mpich; # added 2018-08-06 msf = metasploit; # added 2018-04-25 libmsgpack = msgpack; # added 2018-08-17 @@ -290,8 +291,6 @@ mapAliases ({ pyo3-pack = maturin; pulseaudioLight = pulseaudio; # added 2018-04-25 qca-qt5 = libsForQt5.qca-qt5; # added 2015-12-19 - qt_gstreamer = qt-gstreamer; # added 2017-02 - qt_gstreamer1 = qt-gstreamer1; # added 2017-02 quake3game = ioquake3; # added 2016-01-14 qwt6 = libsForQt5.qwt; # added 2015-12-19 qtpfsgui = throw "Is now luminanceHDR"; # added 2019-06-26 @@ -389,6 +388,7 @@ mapAliases ({ winusb = woeusb; # added 2017-12-22 wireguard = wireguard-tools; # added 2018-05-19 morituri = whipper; # added 2018-09-13 + xfceUnstable = xfce4-14; # added 2019-09-17 x11 = xlibsWrapper; # added 2015-09 xbmc = kodi; # added 2018-04-25 xbmcPlain = kodiPlain; # added 2018-04-25 @@ -425,7 +425,7 @@ mapAliases ({ ocamlPackages_latest; gst_all = { # added 2018-04-25 - inherit (pkgs) gstreamer gnonlin gst-python qt-gstreamer; + inherit (pkgs) gstreamer gnonlin gst-python; gstPluginsBase = pkgs.gst-plugins-base; gstPluginsBad = pkgs.gst-plugins-bad; gstPluginsGood = pkgs.gst-plugins-good; diff --git a/pkgs/top-level/all-packages.nix b/pkgs/top-level/all-packages.nix index 8d419026a90..0a132a044e0 100644 --- a/pkgs/top-level/all-packages.nix +++ b/pkgs/top-level/all-packages.nix @@ -6070,6 +6070,8 @@ in shrikhand = callPackage ../data/fonts/shrikhand { }; + shunit2 = callPackage ../tools/misc/shunit2 { }; + sic = callPackage ../applications/networking/irc/sic { }; siege = callPackage ../tools/networking/siege {}; @@ -7275,6 +7277,8 @@ in ksh = callPackage ../shells/ksh { }; + liquidprompt = callPackage ../shells/liquidprompt { }; + mksh = callPackage ../shells/mksh { }; oh = callPackage ../shells/oh { }; @@ -11082,9 +11086,6 @@ in qt-mobility = callPackage ../development/libraries/qt-mobility {}; - qt-gstreamer = callPackage ../development/libraries/gstreamer/legacy/qt-gstreamer {}; - - qt-gstreamer1 = callPackage ../development/libraries/gstreamer/qt-gstreamer { boost = boost155; }; qtstyleplugin-kvantum-qt4 = callPackage ../development/libraries/qtstyleplugin-kvantum-qt4 { }; @@ -12693,8 +12694,6 @@ in mono-addins = callPackage ../development/libraries/mono-addins { }; - mono-zeroconf = callPackage ../development/libraries/mono-zeroconf { }; - movit = callPackage ../development/libraries/movit { }; mosquitto = callPackage ../servers/mqtt/mosquitto { }; @@ -12966,6 +12965,8 @@ in osm-gps-map = callPackage ../development/libraries/osm-gps-map { }; + osmid = callPackage ../applications/audio/osmid {}; + osinfo-db = callPackage ../data/misc/osinfo-db { }; osinfo-db-tools = callPackage ../tools/misc/osinfo-db-tools { }; @@ -15014,6 +15015,7 @@ in prom2json = callPackage ../servers/monitoring/prometheus/prom2json.nix { }; prometheus = callPackage ../servers/monitoring/prometheus { }; prometheus-alertmanager = callPackage ../servers/monitoring/prometheus/alertmanager.nix { }; + prometheus-apcupsd-exporter = callPackage ../servers/monitoring/prometheus/apcupsd-exporter.nix { }; prometheus-aws-s3-exporter = callPackage ../servers/monitoring/prometheus/aws-s3-exporter.nix { }; prometheus-bind-exporter = callPackage ../servers/monitoring/prometheus/bind-exporter.nix { }; prometheus-blackbox-exporter = callPackage ../servers/monitoring/prometheus/blackbox-exporter.nix { }; @@ -16965,6 +16967,8 @@ in papirus-icon-theme = callPackage ../data/icons/papirus-icon-theme { }; + papirus-maia-icon-theme = callPackage ../data/icons/papirus-maia-icon-theme { }; + papis = with python3Packages; toPythonApplication papis; paps = callPackage ../tools/misc/paps { }; @@ -19700,6 +19704,8 @@ in pdfdiff = callPackage ../applications/misc/pdfdiff { }; + pdfsam-basic = callPackage ../applications/misc/pdfsam-basic { }; + mupdf = callPackage ../applications/misc/mupdf { }; mystem = callPackage ../applications/misc/mystem { }; @@ -19986,6 +19992,8 @@ in purple-plugin-pack = callPackage ../applications/networking/instant-messengers/pidgin-plugins/purple-plugin-pack { }; + purple-slack = callPackage ../applications/networking/instant-messengers/pidgin-plugins/purple-slack { }; + purple-vk-plugin = callPackage ../applications/networking/instant-messengers/pidgin-plugins/purple-vk-plugin { }; purple-xmpp-http-upload = callPackage ../applications/networking/instant-messengers/pidgin-plugins/purple-xmpp-http-upload { }; @@ -22720,7 +22728,6 @@ in solarc-gtk-theme = callPackage ../misc/themes/solarc { }; xfce = xfce4-12; - xfceUnstable = xfce4-14; xfce4-12 = recurseIntoAttrs (callPackage ../desktops/xfce { }); xfce4-14 = recurseIntoAttrs (callPackage ../desktops/xfce4-14 { }); diff --git a/pkgs/top-level/ocaml-packages.nix b/pkgs/top-level/ocaml-packages.nix index 728f6f7712d..ba3f37cd428 100644 --- a/pkgs/top-level/ocaml-packages.nix +++ b/pkgs/top-level/ocaml-packages.nix @@ -664,6 +664,8 @@ let then sexplib_108_08_00 else null; + ocaml-protoc = callPackage ../development/ocaml-modules/ocaml-protoc { }; + ocaml_extlib = callPackage ../development/ocaml-modules/extlib { }; ocb-stubblr = callPackage ../development/ocaml-modules/ocb-stubblr { }; @@ -696,6 +698,8 @@ let ppx_deriving_protobuf = callPackage ../development/ocaml-modules/ppx_deriving_protobuf {}; + ppx_deriving_rpc = callPackage ../development/ocaml-modules/ppx_deriving_rpc {}; + ppx_deriving_yojson = callPackage ../development/ocaml-modules/ppx_deriving_yojson {}; ppx_gen_rec = callPackage ../development/ocaml-modules/ppx_gen_rec {}; diff --git a/pkgs/top-level/release.nix b/pkgs/top-level/release.nix index da81a696337..f832268899d 100644 --- a/pkgs/top-level/release.nix +++ b/pkgs/top-level/release.nix @@ -62,7 +62,7 @@ let jobs.vim.x86_64-darwin # UI apps - jobs.firefox-unwrapped.x86_64-darwin + # jobs.firefox-unwrapped.x86_64-darwin jobs.qt5.qtmultimedia.x86_64-darwin jobs.inkscape.x86_64-darwin jobs.gimp.x86_64-darwin |