diff options
Diffstat (limited to 'nixos')
390 files changed, 29844 insertions, 15310 deletions
diff --git a/nixos/doc/manual/README b/nixos/doc/manual/README deleted file mode 100644 index 120c127d7af..00000000000 --- a/nixos/doc/manual/README +++ /dev/null @@ -1,3 +0,0 @@ -Moved to: ./contributing-to-this-manual.xml. Link: - -https://nixos.org/manual/nixos/unstable/#chap-contributing diff --git a/nixos/doc/manual/README.md b/nixos/doc/manual/README.md new file mode 100644 index 00000000000..bc649761df6 --- /dev/null +++ b/nixos/doc/manual/README.md @@ -0,0 +1,3 @@ +[Moved to ./contributing-to-this-manual.chapter.md](./contributing-to-this-manual.chapter.md). Link: + +https://nixos.org/manual/nixos/unstable/#chap-contributing diff --git a/nixos/doc/manual/administration/boot-problems.section.md b/nixos/doc/manual/administration/boot-problems.section.md new file mode 100644 index 00000000000..dee83e7ec22 --- /dev/null +++ b/nixos/doc/manual/administration/boot-problems.section.md @@ -0,0 +1,41 @@ +# Boot Problems {#sec-boot-problems} + +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 `linux`. The following are some useful kernel command line parameters that are recognised by the NixOS boot scripts or by systemd: + +`boot.shell_on_fail` + +: Allows the user to 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. + +`boot.debug1` + +: 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 `/proc` and `/sys`. + +`boot.debug1devices` + +: Like `boot.debug1`, but runs stage1 until kernel modules are loaded and device nodes are created. This may help with e.g. making the keyboard work. + +`boot.debug1mounts` + +: Like `boot.debug1` or `boot.debug1devices`, but runs stage1 until all filesystems that are mounted during initrd are mounted (see [neededForBoot](#opt-fileSystems._name_.neededForBoot)). As a motivating example, this could be useful if you've forgotten to set [neededForBoot](options.html#opt-fileSystems._name_.neededForBoot) on a file system. + +`boot.trace` + +: Print every shell command executed by the stage 1 and 2 boot scripts. + +`single` + +: Boot into rescue mode (a.k.a. single user mode). This will cause systemd to start nothing but the unit `rescue.target`, which runs `sulogin` 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. + +`systemd.log_level=debug` `systemd.log_target=console` + +: Make systemd very verbose and send log messages to the console instead of the journal. For more parameters recognised by systemd, see systemd(1). + +In addition, these arguments are recognised by the live image only: + +`live.nixos.passwd=password` + +: Set the password for the `nixos` live user. This can be used for SSH access if there are issues using the terminal. + +Notice that for `boot.shell_on_fail`, `boot.debug1`, `boot.debug1devices`, and `boot.debug1mounts`, if you did **not** select "start the new shell as pid 1", and you `exit` from the new shell, boot will proceed normally from the point where it failed, as if you'd chosen "ignore the error and continue". + +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 `agetty` login prompts should appear eventually unless something is very wrong.) diff --git a/nixos/doc/manual/administration/boot-problems.xml b/nixos/doc/manual/administration/boot-problems.xml deleted file mode 100644 index e0f66284010..00000000000 --- a/nixos/doc/manual/administration/boot-problems.xml +++ /dev/null @@ -1,126 +0,0 @@ -<section xmlns="http://docbook.org/ns/docbook" - xmlns:xlink="http://www.w3.org/1999/xlink" - xmlns:xi="http://www.w3.org/2001/XInclude" - version="5.0" - xml:id="sec-boot-problems"> - <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: - <variablelist> - <varlistentry> - <term> - <literal>boot.shell_on_fail</literal> - </term> - <listitem> - <para> - Allows the user to 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> - <varlistentry> - <term> - <literal>boot.debug1</literal> - </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>. - </para> - </listitem> - </varlistentry> - <varlistentry> - <term> - <literal>boot.debug1devices</literal> - </term> - <listitem> - <para> - Like <literal>boot.debug1</literal>, but runs stage1 until kernel modules are loaded and device nodes are created. - This may help with e.g. making the keyboard work. - </para> - </listitem> - </varlistentry> - <varlistentry> - <term> - <literal>boot.debug1mounts</literal> - </term> - <listitem> - <para> - Like <literal>boot.debug1</literal> or - <literal>boot.debug1devices</literal>, but runs stage1 until all - filesystems that are mounted during initrd are mounted (see - <option><link linkend="opt-fileSystems._name_.neededForBoot">neededForBoot</link></option> - ). As a motivating example, this could be useful if you've forgotten to set - <option><link linkend="opt-fileSystems._name_.neededForBoot">neededForBoot</link></option> - on a file system. - </para> - </listitem> - </varlistentry> - <varlistentry> - <term> - <literal>boot.trace</literal> - </term> - <listitem> - <para> - Print every shell command executed by the stage 1 and 2 boot scripts. - </para> - </listitem> - </varlistentry> - <varlistentry> - <term> - <literal>single</literal> - </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. - </para> - </listitem> - </varlistentry> - <varlistentry> - <term> - <literal>systemd.log_level=debug systemd.log_target=console</literal> - </term> - <listitem> - <para> - Make systemd very verbose and send log messages to the console instead of - the journal. - </para> - </listitem> - </varlistentry> - </variablelist> - For more parameters recognised by systemd, see <citerefentry> - <refentrytitle>systemd</refentrytitle> - <manvolnum>1</manvolnum></citerefentry>. - </para> - - <para> - Notice that for <literal>boot.shell_on_fail</literal>, - <literal>boot.debug1</literal>, <literal>boot.debug1devices</literal>, and - <literal>boot.debug1mounts</literal>, if you did <emphasis>not</emphasis> - select "start the new shell as pid 1", and you <literal>exit</literal> from - the new shell, boot will proceed normally from the point where it failed, as - if you'd chosen "ignore the error and continue". - </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.) - </para> -</section> diff --git a/nixos/doc/manual/administration/troubleshooting.xml b/nixos/doc/manual/administration/troubleshooting.xml index 6496e7bde38..b055acadacf 100644 --- a/nixos/doc/manual/administration/troubleshooting.xml +++ b/nixos/doc/manual/administration/troubleshooting.xml @@ -8,7 +8,7 @@ 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="../from_md/administration/boot-problems.section.xml" /> <xi:include href="maintenance-mode.xml" /> <xi:include href="rollback.xml" /> <xi:include href="store-corruption.xml" /> diff --git a/nixos/doc/manual/configuration/abstractions.section.md b/nixos/doc/manual/configuration/abstractions.section.md new file mode 100644 index 00000000000..bf26e4c51ed --- /dev/null +++ b/nixos/doc/manual/configuration/abstractions.section.md @@ -0,0 +1,80 @@ +# Abstractions {#sec-module-abstractions} + +If you find yourself repeating yourself over and over, it’s time to abstract. Take, for instance, this Apache HTTP Server configuration: + +```nix +{ + services.httpd.virtualHosts = + { "blog.example.org" = { + documentRoot = "/webroot/blog.example.org"; + adminAddr = "alice@example.org"; + forceSSL = true; + enableACME = true; + enablePHP = true; + }; + "wiki.example.org" = { + documentRoot = "/webroot/wiki.example.org"; + adminAddr = "alice@example.org"; + forceSSL = true; + enableACME = true; + enablePHP = true; + }; + }; +} +``` + +It defines two virtual hosts with nearly identical configuration; the only difference is the document root directories. To prevent this duplication, we can use a `let`: +```nix +let + commonConfig = + { adminAddr = "alice@example.org"; + forceSSL = true; + enableACME = true; + }; +in +{ + services.httpd.virtualHosts = + { "blog.example.org" = (commonConfig // { documentRoot = "/webroot/blog.example.org"; }); + "wiki.example.org" = (commonConfig // { documentRoot = "/webroot/wiki.example.com"; }); + }; +} +``` + +The `let commonConfig = ...` defines a variable named `commonConfig`. The `//` operator merges two attribute sets, so the configuration of the second virtual host is the set `commonConfig` extended with the document root option. + +You can write a `let` wherever an expression is allowed. Thus, you also could have written: + +```nix +{ + services.httpd.virtualHosts = + let commonConfig = ...; in + { "blog.example.org" = (commonConfig // { ... }) + "wiki.example.org" = (commonConfig // { ... }) + }; +} +``` + +but not `{ let commonConfig = ...; in ...; }` since attributes (as opposed to attribute values) are not expressions. + +**Functions** 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 document root. This can be done as follows: + +```nix +{ + services.httpd.virtualHosts = + let + makeVirtualHost = webroot: + { documentRoot = webroot; + adminAddr = "alice@example.org"; + forceSSL = true; + enableACME = true; + }; + in + { "example.org" = (makeVirtualHost "/webroot/example.org"); + "example.com" = (makeVirtualHost "/webroot/example.com"); + "example.gov" = (makeVirtualHost "/webroot/example.gov"); + "example.nl" = (makeVirtualHost "/webroot/example.nl"); + }; +} +``` + +Here, `makeVirtualHost` is a function that takes a single argument `webroot` and returns the configuration for a virtual host. That function is then called for several names to produce the list of virtual host configurations. diff --git a/nixos/doc/manual/configuration/abstractions.xml b/nixos/doc/manual/configuration/abstractions.xml deleted file mode 100644 index df9ff2615e1..00000000000 --- a/nixos/doc/manual/configuration/abstractions.xml +++ /dev/null @@ -1,101 +0,0 @@ -<section xmlns="http://docbook.org/ns/docbook" - xmlns:xlink="http://www.w3.org/1999/xlink" - xmlns:xi="http://www.w3.org/2001/XInclude" - version="5.0" - xml:id="sec-module-abstractions"> - <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: -<programlisting> -{ - <xref linkend="opt-services.httpd.virtualHosts"/> = - { "blog.example.org" = { - documentRoot = "/webroot/blog.example.org"; - adminAddr = "alice@example.org"; - forceSSL = true; - enableACME = true; - enablePHP = true; - }; - "wiki.example.org" = { - documentRoot = "/webroot/wiki.example.org"; - adminAddr = "alice@example.org"; - forceSSL = true; - enableACME = true; - enablePHP = true; - }; - }; -} -</programlisting> - It defines two virtual hosts with nearly identical configuration; the only - difference is the document root directories. To prevent this - duplication, we can use a <literal>let</literal>: -<programlisting> -let - commonConfig = - { adminAddr = "alice@example.org"; - forceSSL = true; - enableACME = true; - }; -in -{ - <xref linkend="opt-services.httpd.virtualHosts"/> = - { "blog.example.org" = (commonConfig // { documentRoot = "/webroot/blog.example.org"; }); - "wiki.example.org" = (commonConfig // { documentRoot = "/webroot/wiki.example.com"; }); - }; -} -</programlisting> - The <literal>let commonConfig = <replaceable>...</replaceable></literal> - defines a variable named <literal>commonConfig</literal>. The - <literal>//</literal> operator merges two attribute sets, so the - configuration of the second virtual host is the set - <literal>commonConfig</literal> extended with the document root option. - </para> - - <para> - 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"/> = - let commonConfig = <replaceable>...</replaceable>; in - { "blog.example.org" = (commonConfig // { <replaceable>...</replaceable> }) - "wiki.example.org" = (commonConfig // { <replaceable>...</replaceable> }) - }; -} -</programlisting> - but not <literal>{ let commonConfig = <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 document root. This can be done - as follows: -<programlisting> -{ - <xref linkend="opt-services.httpd.virtualHosts"/> = - let - makeVirtualHost = webroot: - { documentRoot = webroot; - adminAddr = "alice@example.org"; - forceSSL = true; - enableACME = true; - }; - in - { "example.org" = (makeVirtualHost "/webroot/example.org"); - "example.com" = (makeVirtualHost "/webroot/example.com"); - "example.gov" = (makeVirtualHost "/webroot/example.gov"); - "example.nl" = (makeVirtualHost "/webroot/example.nl"); - }; -} -</programlisting> - Here, <varname>makeVirtualHost</varname> is a function that takes a single - argument <literal>webroot</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> -</section> diff --git a/nixos/doc/manual/configuration/config-syntax.xml b/nixos/doc/manual/configuration/config-syntax.xml index 5526dea247c..a374c6a8707 100644 --- a/nixos/doc/manual/configuration/config-syntax.xml +++ b/nixos/doc/manual/configuration/config-syntax.xml @@ -19,7 +19,7 @@ xlink:href="https://nixos.org/nix/manual/#chap-writing-nix-expressions">Nix constructs useful in NixOS configuration files. </para> <xi:include href="config-file.xml" /> - <xi:include href="abstractions.xml" /> + <xi:include href="../from_md/configuration/abstractions.section.xml" /> <xi:include href="modularity.xml" /> <xi:include href="summary.xml" /> </chapter> diff --git a/nixos/doc/manual/configuration/file-systems.xml b/nixos/doc/manual/configuration/file-systems.xml index 9747433375f..42c59844ff4 100644 --- a/nixos/doc/manual/configuration/file-systems.xml +++ b/nixos/doc/manual/configuration/file-systems.xml @@ -54,4 +54,5 @@ </para> </note> <xi:include href="luks-file-systems.xml" /> + <xi:include href="../from_md/configuration/sshfs-file-systems.section.xml" /> </chapter> diff --git a/nixos/doc/manual/configuration/gpu-accel.xml b/nixos/doc/manual/configuration/gpu-accel.xml index 3695a5ff445..9aa9be86a06 100644 --- a/nixos/doc/manual/configuration/gpu-accel.xml +++ b/nixos/doc/manual/configuration/gpu-accel.xml @@ -178,9 +178,9 @@ GPU1: Core Next</link> (GCN) GPUs are supported through either radv, which is part of <package>mesa</package>, or the <package>amdvlk</package> package. Adding the <package>amdvlk</package> package to - <xref linkend="opt-hardware.opengl.extraPackages"/> makes both drivers - available for applications and lets them choose. A specific driver can - be forced as follows: + <xref linkend="opt-hardware.opengl.extraPackages"/> makes amdvlk the + default driver and hides radv and lavapipe from the device list. A + specific driver can be forced as follows: <programlisting><xref linkend="opt-hardware.opengl.extraPackages"/> = [ pkgs.<package>amdvlk</package> @@ -191,10 +191,9 @@ GPU1: pkgs.driversi686Linux.<package>amdvlk</package> ]; - # For amdvlk - <xref linkend="opt-environment.variables"/>.VK_ICD_FILENAMES = - "/run/opengl-driver/share/vulkan/icd.d/amd_icd64.json"; - # For radv + # Force radv + <xref linkend="opt-environment.variables"/>.AMD_VULKAN_ICD = "RADV"; + # Or <xref linkend="opt-environment.variables"/>.VK_ICD_FILENAMES = "/run/opengl-driver/share/vulkan/icd.d/radeon_icd.x86_64.json"; </programlisting> diff --git a/nixos/doc/manual/configuration/sshfs-file-systems.section.md b/nixos/doc/manual/configuration/sshfs-file-systems.section.md new file mode 100644 index 00000000000..4625fce03d5 --- /dev/null +++ b/nixos/doc/manual/configuration/sshfs-file-systems.section.md @@ -0,0 +1,104 @@ +# SSHFS File Systems {#sec-sshfs-file-systems} + +[SSHFS][sshfs] is a [FUSE][fuse] filesystem that allows easy access to directories on a remote machine using the SSH File Transfer Protocol (SFTP). +It means that if you have SSH access to a machine, no additional setup is needed to mount a directory. + +[sshfs]: https://github.com/libfuse/sshfs +[fuse]: https://en.wikipedia.org/wiki/Filesystem_in_Userspace + +## Interactive mounting {#sec-sshfs-interactive} + +In NixOS, SSHFS is packaged as <package>sshfs</package>. +Once installed, mounting a directory interactively is simple as running: +```ShellSession +$ sshfs my-user@example.com:/my-dir /mnt/my-dir +``` +Like any other FUSE file system, the directory is unmounted using: +```ShellSession +$ fusermount -u /mnt/my-dir +``` + +## Non-interactive mounting {#sec-sshfs-non-interactive} + +Mounting non-interactively requires some precautions because `sshfs` will run at boot and under a different user (root). +For obvious reason, you can't input a password, so public key authentication using an unencrypted key is needed. +To create a new key without a passphrase you can do: +```ShellSession +$ ssh-keygen -t ed25519 -P '' -f example-key +Generating public/private ed25519 key pair. +Your identification has been saved in test-key +Your public key has been saved in test-key.pub +The key fingerprint is: +SHA256:yjxl3UbTn31fLWeyLYTAKYJPRmzknjQZoyG8gSNEoIE my-user@workstation +``` +To keep the key safe, change the ownership to `root:root` and make sure the permissions are `600`: +OpenSSH normally refuses to use the key if it's not well-protected. + +The file system can be configured in NixOS via the usual [fileSystems](options.html#opt-fileSystems) option. +Here's a typical setup: +```nix +{ + system.fsPackages = [ pkgs.sshfs ]; + + fileSystems."/mnt/my-dir" = { + device = "my-user@example.com:/my-dir/"; + fsType = "sshfs"; + options = + [ # Filesystem options + "allow_other" # for non-root access + "_netdev" # this is a network fs + "x-systemd.automount" # mount on demand + + # SSH options + "reconnect" # handle connection drops + "ServerAliveInterval=15" # keep connections alive + "IdentityFile=/var/secrets/example-key" + ]; + }; +} +``` +More options from `ssh_config(5)` can be given as well, for example you can change the default SSH port or specify a jump proxy: +```nix +{ + options = + [ "ProxyJump=bastion@example.com" + "Port=22" + ]; +} +``` +It's also possible to change the `ssh` command used by SSHFS to connect to the server. +For example: +```nix +{ + options = + [ (builtins.replaceStrings [" "] ["\\040"] + "ssh_command=${pkgs.openssh}/bin/ssh -v -L 8080:localhost:80") + ]; + +} +``` + +::: {.note} +The escaping of spaces is needed because every option is written to the `/etc/fstab` file, which is a space-separated table. +::: + +### Troubleshooting {#sec-sshfs-troubleshooting} + +If you're having a hard time figuring out why mounting is failing, you can add the option `"debug"`. +This enables a verbose log in SSHFS that you can access via: +```ShellSession +$ journalctl -u $(systemd-escape -p /mnt/my-dir/).mount +Jun 22 11:41:18 workstation mount[87790]: SSHFS version 3.7.1 +Jun 22 11:41:18 workstation mount[87793]: executing <ssh> <-x> <-a> <-oClearAllForwardings=yes> <-oServerAliveInterval=15> <-oIdentityFile=/var/secrets/wrong-key> <-2> <my-user@example.com> <-s> <sftp> +Jun 22 11:41:19 workstation mount[87793]: my-user@example.com: Permission denied (publickey). +Jun 22 11:41:19 workstation mount[87790]: read: Connection reset by peer +Jun 22 11:41:19 workstation systemd[1]: mnt-my\x2ddir.mount: Mount process exited, code=exited, status=1/FAILURE +Jun 22 11:41:19 workstation systemd[1]: mnt-my\x2ddir.mount: Failed with result 'exit-code'. +Jun 22 11:41:19 workstation systemd[1]: Failed to mount /mnt/my-dir. +Jun 22 11:41:19 workstation systemd[1]: mnt-my\x2ddir.mount: Consumed 54ms CPU time, received 2.3K IP traffic, sent 2.7K IP traffic. +``` + +::: {.note} +If the mount point contains special characters it needs to be escaped using `systemd-escape`. +This is due to the way systemd converts paths into unit names. +::: diff --git a/nixos/doc/manual/configuration/wayland.xml b/nixos/doc/manual/configuration/wayland.xml index 231c219cf08..2aefda3e22c 100644 --- a/nixos/doc/manual/configuration/wayland.xml +++ b/nixos/doc/manual/configuration/wayland.xml @@ -20,4 +20,14 @@ essential utilities. Now you can start <package>sway</package> from the TTY console. </para> + + <para> + If you are using a wlroots-based compositor, like sway, and want to be able to + share your screen, you might want to activate this option: +<programlisting> +<xref linkend="opt-xdg.portal.wlr.enable"/> = true; +</programlisting> + and configure Pipewire using <xref linkend="opt-services.pipewire.enable"/> + and related options. + </para> </chapter> diff --git a/nixos/doc/manual/configuration/x-windows.xml b/nixos/doc/manual/configuration/x-windows.xml index e7219389706..f9121508d7d 100644 --- a/nixos/doc/manual/configuration/x-windows.xml +++ b/nixos/doc/manual/configuration/x-windows.xml @@ -191,9 +191,12 @@ <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. + look similar to GTK ones, you can use the following configuration: +<programlisting> +<xref linkend="opt-qt5.enable"/> = true; +<xref linkend="opt-qt5.platformTheme"/> = "gtk2"; +<xref linkend="opt-qt5.style"/> = "gtk2"; +</programlisting> </para> </simplesect> <simplesect xml:id="custom-xkb-layouts"> @@ -238,11 +241,11 @@ xkb_symbols "us-greek" description = "US layout with alt-gr greek"; languages = [ "eng" ]; symbolsFile = /yourpath/symbols/us-greek; -} +}; </programlisting> <note> <para> - The name should match the one given to the + The name (after <literal>extraLayouts.</literal>) should match the one given to the <literal>xkb_symbols</literal> block. </para> </note> diff --git a/nixos/doc/manual/development/assertions.section.md b/nixos/doc/manual/development/assertions.section.md new file mode 100644 index 00000000000..cc6d81e5699 --- /dev/null +++ b/nixos/doc/manual/development/assertions.section.md @@ -0,0 +1,40 @@ +# Warnings and Assertions {#sec-assertions} + +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. + +Although Nix has the `abort` and `builtins.trace` [functions](https://nixos.org/nix/manual/#ssec-builtins) 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. + +## Warnings {#sec-assertions-warnings} + +This is an example of using `warnings`. + +```nix +{ config, lib, ... }: +{ + config = lib.mkIf config.services.foo.enable { + warnings = + if config.services.foo.bar + then [ ''You have enabled the bar feature of the foo service. + This is known to cause some specific problems in certain situations. + '' ] + else []; + } +} +``` + +## Assertions {#sec-assertions-assetions} + +This example, extracted from the [`syslogd` module](https://github.com/NixOS/nixpkgs/blob/release-17.09/nixos/modules/services/logging/syslogd.nix) shows how to use `assertions`. 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. + +```nix +{ config, lib, ... }: +{ + config = lib.mkIf config.services.syslogd.enable { + assertions = + [ { assertion = !config.services.rsyslogd.enable; + message = "rsyslogd conflicts with syslogd"; + } + ]; + } +} +``` diff --git a/nixos/doc/manual/development/assertions.xml b/nixos/doc/manual/development/assertions.xml deleted file mode 100644 index 32f90cf2e7c..00000000000 --- a/nixos/doc/manual/development/assertions.xml +++ /dev/null @@ -1,74 +0,0 @@ -<section xmlns="http://docbook.org/ns/docbook" - xmlns:xlink="http://www.w3.org/1999/xlink" - xmlns:xi="http://www.w3.org/2001/XInclude" - version="5.0" - xml:id="sec-assertions"> - <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. - </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. - </para> - - <section xml:id="sec-assertions-warnings"> - <title>Warnings</title> - - <para> - This is an example of using <literal>warnings</literal>. - </para> - -<programlisting> -<![CDATA[ -{ config, lib, ... }: -{ - config = lib.mkIf config.services.foo.enable { - warnings = - if config.services.foo.bar - then [ ''You have enabled the bar feature of the foo service. - This is known to cause some specific problems in certain situations. - '' ] - else []; - } -} -]]> -</programlisting> - </section> - - <section xml:id="sec-assertions-assertions"> - <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. - </para> - -<programlisting> -<![CDATA[ -{ config, lib, ... }: -{ - config = lib.mkIf config.services.syslogd.enable { - assertions = - [ { assertion = !config.services.rsyslogd.enable; - message = "rsyslogd conflicts with syslogd"; - } - ]; - } -} -]]> -</programlisting> - </section> -</section> diff --git a/nixos/doc/manual/development/nixos-tests.xml b/nixos/doc/manual/development/nixos-tests.xml index 2695082e386..702fc03f668 100644 --- a/nixos/doc/manual/development/nixos-tests.xml +++ b/nixos/doc/manual/development/nixos-tests.xml @@ -13,7 +13,7 @@ xlink:href="https://github.com/NixOS/nixpkgs/tree/master/nixos/tests">nixos/test 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" /> - <xi:include href="running-nixos-tests-interactively.xml" /> + <xi:include href="../from_md/development/writing-nixos-tests.section.xml" /> + <xi:include href="../from_md/development/running-nixos-tests.section.xml" /> + <xi:include href="../from_md/development/running-nixos-tests-interactively.section.xml" /> </chapter> diff --git a/nixos/doc/manual/development/running-nixos-tests-interactively.section.md b/nixos/doc/manual/development/running-nixos-tests-interactively.section.md new file mode 100644 index 00000000000..3ba4e16e77f --- /dev/null +++ b/nixos/doc/manual/development/running-nixos-tests-interactively.section.md @@ -0,0 +1,44 @@ +# Running Tests interactively {#sec-running-nixos-tests-interactively} + +The test itself can be run interactively. This is particularly useful +when developing or debugging a test: + +```ShellSession +$ nix-build nixos/tests/login.nix -A driverInteractive +$ ./result/bin/nixos-test-driver +starting VDE switch for network 1 +> +``` + +You can then take any Python statement, e.g. + +```py +> start_all() +> test_script() +> machine.succeed("touch /tmp/foo") +> print(machine.succeed("pwd")) # Show stdout of command +``` + +The function `test_script` 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). + +To just start and experiment with the VMs, run: + +```ShellSession +$ nix-build nixos/tests/login.nix -A driverInteractive +$ ./result/bin/nixos-run-vms +``` + +The script `nixos-run-vms` starts the virtual machines defined by test. + +You can re-use the VM states coming from a previous run by setting the +`--keep-vm-state` flag. + +```ShellSession +$ ./result/bin/nixos-run-vms --keep-vm-state +``` + +The machine state is stored in the `$TMPDIR/vm-state-machinename` +directory. diff --git a/nixos/doc/manual/development/running-nixos-tests-interactively.xml b/nixos/doc/manual/development/running-nixos-tests-interactively.xml deleted file mode 100644 index a6044d5f89e..00000000000 --- a/nixos/doc/manual/development/running-nixos-tests-interactively.xml +++ /dev/null @@ -1,49 +0,0 @@ -<section xmlns="http://docbook.org/ns/docbook" - xmlns:xlink="http://www.w3.org/1999/xlink" - xmlns:xi="http://www.w3.org/2001/XInclude" - version="5.0" - xml:id="sec-running-nixos-tests-interactively"> - <title>Running Tests interactively</title> - - <para> - 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 driverInteractive -<prompt>$ </prompt>./result/bin/nixos-test-driver -starting VDE switch for network 1 -<prompt>></prompt> -</screen> - You can then take any Python statement, e.g. -<screen> -<prompt>></prompt> start_all() -<prompt>></prompt> test_script() -<prompt>></prompt> machine.succeed("touch /tmp/foo") -<prompt>></prompt> print(machine.succeed("pwd")) # Show stdout of command -</screen> - The function <command>test_script</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> - To just start and experiment with the VMs, run: -<screen> -<prompt>$ </prompt>nix-build nixos/tests/login.nix -A driverInteractive -<prompt>$ </prompt>./result/bin/nixos-run-vms -</screen> - The script <command>nixos-run-vms</command> starts the virtual machines - defined by test. - </para> - - <para> - You can re-use the VM states coming from a previous run - by setting the <command>--keep-vm-state</command> flag. -<screen> -<prompt>$ </prompt>./result/bin/nixos-run-vms --keep-vm-state -</screen> - The machine state is stored in the - <filename>$TMPDIR/vm-state-</filename><varname>machinename</varname> directory. - </para> -</section> diff --git a/nixos/doc/manual/development/running-nixos-tests.section.md b/nixos/doc/manual/development/running-nixos-tests.section.md new file mode 100644 index 00000000000..d6a456f0188 --- /dev/null +++ b/nixos/doc/manual/development/running-nixos-tests.section.md @@ -0,0 +1,31 @@ +# Running Tests {#sec-running-nixos-tests} + +You can run tests using `nix-build`. For example, to run the test +[`login.nix`](https://github.com/NixOS/nixpkgs/blob/master/nixos/tests/login.nix), +you just do: + +```ShellSession +$ nix-build '<nixpkgs/nixos/tests/login.nix>' +``` + +or, if you don't want to rely on `NIX_PATH`: + +```ShellSession +$ cd /my/nixpkgs/nixos/tests +$ nix-build login.nix +… +running the VM test script +machine: QEMU running (pid 8841) +… +6 out of 6 tests succeeded +``` + +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: + +```ShellSession +$ firefox result/log.html +``` diff --git a/nixos/doc/manual/development/running-nixos-tests.xml b/nixos/doc/manual/development/running-nixos-tests.xml deleted file mode 100644 index e9257c907da..00000000000 --- a/nixos/doc/manual/development/running-nixos-tests.xml +++ /dev/null @@ -1,36 +0,0 @@ -<section xmlns="http://docbook.org/ns/docbook" - xmlns:xlink="http://www.w3.org/1999/xlink" - xmlns:xi="http://www.w3.org/2001/XInclude" - version="5.0" - xml:id="sec-running-nixos-tests"> - <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: -<screen> -<prompt>$ </prompt>nix-build '<nixpkgs/nixos/tests/login.nix>' -</screen> - or, if you don’t want to rely on <envar>NIX_PATH</envar>: -<screen> -<prompt>$ </prompt>cd /my/nixpkgs/nixos/tests -<prompt>$ </prompt>nix-build login.nix -… -running the VM test script -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: -<screen> -<prompt>$ </prompt>firefox result/log.html -</screen> - </para> -</section> diff --git a/nixos/doc/manual/development/writing-modules.xml b/nixos/doc/manual/development/writing-modules.xml index fad4637f51f..04497db77b8 100644 --- a/nixos/doc/manual/development/writing-modules.xml +++ b/nixos/doc/manual/development/writing-modules.xml @@ -182,7 +182,7 @@ in { <xi:include href="option-declarations.xml" /> <xi:include href="option-types.xml" /> <xi:include href="option-def.xml" /> - <xi:include href="assertions.xml" /> + <xi:include href="../from_md/development/assertions.section.xml" /> <xi:include href="meta-attributes.xml" /> <xi:include href="importing-modules.xml" /> <xi:include href="replace-modules.xml" /> diff --git a/nixos/doc/manual/development/writing-nixos-tests.section.md b/nixos/doc/manual/development/writing-nixos-tests.section.md new file mode 100644 index 00000000000..8471e7608af --- /dev/null +++ b/nixos/doc/manual/development/writing-nixos-tests.section.md @@ -0,0 +1,301 @@ +# Writing Tests {#sec-writing-nixos-tests} + +A NixOS test is a Nix expression that has the following structure: + +```nix +import ./make-test-python.nix { + + # Either the configuration of a single machine: + machine = + { config, pkgs, ... }: + { configuration… + }; + + # Or a set of machines: + nodes = + { machine1 = + { config, pkgs, ... }: { … }; + machine2 = + { config, pkgs, ... }: { … }; + … + }; + + testScript = + '' + Python code… + ''; +} +``` + +The attribute `testScript` is a bit of Python 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 `machine` (if you need only one machine in your test) or by +the attribute `nodes` (if you need multiple machines). For instance, +[`login.nix`](https://github.com/NixOS/nixpkgs/blob/master/nixos/tests/login.nix) +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, +[`nfs/simple.nix`](https://github.com/NixOS/nixpkgs/blob/master/nixos/tests/nfs/simple.nix), +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. + +There are a few special NixOS configuration options for test VMs: + +`virtualisation.memorySize` + +: The memory of the VM in megabytes. + +`virtualisation.vlans` + +: The virtual networks to which the VM is connected. See + [`nat.nix`](https://github.com/NixOS/nixpkgs/blob/master/nixos/tests/nat.nix) + for an example. + +`virtualisation.writableStore` + +: 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. + +For more options, see the module +[`qemu-vm.nix`](https://github.com/NixOS/nixpkgs/blob/master/nixos/modules/virtualisation/qemu-vm.nix). + +The test script is a sequence of Python 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 +`name` if this is also the identifier of the machine in the declarative +config. If you didn\'t specify multiple machines using the `nodes` +attribute, it is just `machine`. The following example starts the +machine, waits until it has finished booting, then executes a command +and checks that the output is more-or-less correct: + +```py +machine.start() +machine.wait_for_unit("default.target") +if not "Linux" in machine.succeed("uname"): + raise Exception("Wrong OS") +``` + +The first line is actually unnecessary; machines are implicitly started +when you first execute an action on them (such as `wait_for_unit` or +`succeed`). If you have multiple machines, you can speed up the test by +starting them in parallel: + +```py +start_all() +``` + +The following methods are available on machine objects: + +`start` + +: Start the virtual machine. This method is asynchronous --- it does + not wait for the machine to finish booting. + +`shutdown` + +: Shut down the machine, waiting for the VM to exit. + +`crash` + +: Simulate a sudden power failure, by telling the VM to exit + immediately. + +`block` + +: Simulate unplugging the Ethernet cable that connects the machine to + the other machines. + +`unblock` + +: Undo the effect of `block`. + +`screenshot` + +: Take a picture of the display of the virtual machine, in PNG format. + The screenshot is linked from the HTML log. + +`get_screen_text_variants` + +: Return a list of different interpretations of what is currently + visible on the machine\'s screen using optical character + recognition. The number and order of the interpretations is not + specified and is subject to change, but if no exception is raised at + least one will be returned. + + ::: {.note} + This requires passing `enableOCR` to the test attribute set. + ::: + +`get_screen_text` + +: Return a textual representation of what is currently visible on the + machine\'s screen using optical character recognition. + + ::: {.note} + This requires passing `enableOCR` to the test attribute set. + ::: + +`send_monitor_command` + +: 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_key` + +: Simulate pressing keys on the virtual keyboard, e.g., + `send_key("ctrl-alt-delete")`. + +`send_chars` + +: Simulate typing a sequence of characters on the virtual keyboard, + e.g., `send_chars("foobar\n")` will type the string `foobar` + followed by the Enter key. + +`execute` + +: Execute a shell command, returning a list `(status, stdout)`. + +`succeed` + +: Execute a shell command, raising an exception if the exit status is + not zero, otherwise returning the standard output. Commands are run + with `set -euo pipefail` set: + + - If several commands are separated by `;` and one fails, the + command as a whole will fail. + + - For pipelines, the last non-zero exit status will be returned + (if there is one, zero will be returned otherwise). + + - Dereferencing unset variables fail the command. + +`fail` + +: Like `succeed`, but raising an exception if the command returns a zero + status. + +`wait_until_succeeds` + +: Repeat a shell command with 1-second intervals until it succeeds. + +`wait_until_fails` + +: Repeat a shell command with 1-second intervals until it fails. + +`wait_for_unit` + +: Wait until the specified systemd unit has reached the "active" + state. + +`wait_for_file` + +: Wait until the specified file exists. + +`wait_for_open_port` + +: Wait until a process is listening on the given TCP port (on + `localhost`, at least). + +`wait_for_closed_port` + +: Wait until nobody is listening on the given TCP port. + +`wait_for_x` + +: Wait until the X11 server is accepting connections. + +`wait_for_text` + +: Wait until the supplied regular expressions matches the textual + contents of the screen by using optical character recognition (see + `get_screen_text` and `get_screen_text_variants`). + + ::: {.note} + This requires passing `enableOCR` to the test attribute set. + ::: + +`wait_for_console_text` + +: Wait until the supplied regular expressions match a line of the + serial console output. This method is useful when OCR is not + possibile or accurate enough. + +`wait_for_window` + +: Wait until an X11 window has appeared whose name matches the given + regular expression, e.g., `wait_for_window("Terminal")`. + +`copy_from_host` + +: Copies a file from host to machine, e.g., + `copy_from_host("myfile", "/etc/my/important/file")`. + + 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. + +`systemctl` + +: Runs `systemctl` commands with optional support for + `systemctl --user` + + ```py + machine.systemctl("list-jobs --no-pager") # runs `systemctl list-jobs --no-pager` + machine.systemctl("list-jobs --no-pager", "any-user") # spawns a shell for `any-user` and runs `systemctl --user list-jobs --no-pager` + ``` + +`shell_interact` + +: Allows you to directly interact with the guest shell. This should + only be used during test development, not in production tests. + Killing the interactive session with `Ctrl-d` or `Ctrl-c` also ends + the guest session. + +To test user units declared by `systemd.user.services` the optional +`user` argument can be used: + +```py +machine.start() +machine.wait_for_x() +machine.wait_for_unit("xautolock.service", "x-session-user") +``` + +This applies to `systemctl`, `get_unit_info`, `wait_for_unit`, +`start_job` and `stop_job`. + +For faster dev cycles it\'s also possible to disable the code-linters +(this shouldn\'t be commited though): + +```nix +import ./make-test-python.nix { + skipLint = true; + machine = + { config, pkgs, ... }: + { configuration… + }; + + testScript = + '' + Python code… + ''; +} +``` + +This will produce a Nix warning at evaluation time. To fully disable the +linter, wrap the test script in comment directives to disable the Black +linter directly (again, don\'t commit this within the Nixpkgs +repository): + +```nix + testScript = + '' + # fmt: off + Python code… + # fmt: on + ''; +``` diff --git a/nixos/doc/manual/development/writing-nixos-tests.xml b/nixos/doc/manual/development/writing-nixos-tests.xml deleted file mode 100644 index 5a95436915f..00000000000 --- a/nixos/doc/manual/development/writing-nixos-tests.xml +++ /dev/null @@ -1,484 +0,0 @@ -<section xmlns="http://docbook.org/ns/docbook" - xmlns:xlink="http://www.w3.org/1999/xlink" - xmlns:xi="http://www.w3.org/2001/XInclude" - version="5.0" - xml:id="sec-writing-nixos-tests"> - <title>Writing Tests</title> - - <para> - A NixOS test is a Nix expression that has the following structure: -<programlisting> -import ./make-test-python.nix { - - # Either the configuration of a single machine: - machine = - { config, pkgs, ... }: - { <replaceable>configuration…</replaceable> - }; - - # Or a set of machines: - nodes = - { <replaceable>machine1</replaceable> = - { config, pkgs, ... }: { <replaceable>…</replaceable> }; - <replaceable>machine2</replaceable> = - { config, pkgs, ... }: { <replaceable>…</replaceable> }; - … - }; - - testScript = - '' - <replaceable>Python code…</replaceable> - ''; -} -</programlisting> - The attribute <literal>testScript</literal> is a bit of Python 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/simple.nix">nfs/simple.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> - There are a few special NixOS configuration options for test VMs: -<!-- FIXME: would be nice to generate this automatically. --> - <variablelist> - <varlistentry> - <term> - <option>virtualisation.memorySize</option> - </term> - <listitem> - <para> - The memory of the VM in megabytes. - </para> - </listitem> - </varlistentry> - <varlistentry> - <term> - <option>virtualisation.vlans</option> - </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. - </para> - </listitem> - </varlistentry> - <varlistentry> - <term> - <option>virtualisation.writableStore</option> - </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. - </para> - </listitem> - </varlistentry> - </variablelist> - 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 Python 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> if this is also the - identifier of the machine in the declarative config. - If you didn't specify multiple machines using the <literal>nodes</literal> - attribute, it is just <literal>machine</literal>. - The following example 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.wait_for_unit("default.target") -if not "Linux" in machine.succeed("uname"): - raise Exception("Wrong OS") -</programlisting> - The first line is actually unnecessary; machines are implicitly started when - you first execute an action on them (such as <literal>wait_for_unit</literal> - or <literal>succeed</literal>). If you have multiple machines, you can speed - up the test by starting them in parallel: -<programlisting> -start_all() -</programlisting> - </para> - - <para> - The following methods are available on machine objects: - <variablelist> - <varlistentry> - <term> - <methodname>start</methodname> - </term> - <listitem> - <para> - Start the virtual machine. This method is asynchronous — it does not - wait for the machine to finish booting. - </para> - </listitem> - </varlistentry> - <varlistentry> - <term> - <methodname>shutdown</methodname> - </term> - <listitem> - <para> - Shut down the machine, waiting for the VM to exit. - </para> - </listitem> - </varlistentry> - <varlistentry> - <term> - <methodname>crash</methodname> - </term> - <listitem> - <para> - Simulate a sudden power failure, by telling the VM to exit immediately. - </para> - </listitem> - </varlistentry> - <varlistentry> - <term> - <methodname>block</methodname> - </term> - <listitem> - <para> - Simulate unplugging the Ethernet cable that connects the machine to the - other machines. - </para> - </listitem> - </varlistentry> - <varlistentry> - <term> - <methodname>unblock</methodname> - </term> - <listitem> - <para> - Undo the effect of <methodname>block</methodname>. - </para> - </listitem> - </varlistentry> - <varlistentry> - <term> - <methodname>screenshot</methodname> - </term> - <listitem> - <para> - Take a picture of the display of the virtual machine, in PNG format. The - screenshot is linked from the HTML log. - </para> - </listitem> - </varlistentry> - <varlistentry> - <term> - <methodname>get_screen_text_variants</methodname> - </term> - <listitem> - <para> - Return a list of different interpretations of what is currently visible - on the machine's screen using optical character recognition. The number - and order of the interpretations is not specified and is subject to - change, but if no exception is raised at least one will be returned. - </para> - <note> - <para> - This requires passing <option>enableOCR</option> to the test attribute - set. - </para> - </note> - </listitem> - </varlistentry> - <varlistentry> - <term> - <methodname>get_screen_text</methodname> - </term> - <listitem> - <para> - 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. - </para> - </note> - </listitem> - </varlistentry> - <varlistentry> - <term> - <methodname>send_monitor_command</methodname> - </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. - </para> - </listitem> - </varlistentry> - <varlistentry> - <term> - <methodname>send_key</methodname> - </term> - <listitem> - <para> - Simulate pressing keys on the virtual keyboard, e.g., - <literal>send_key("ctrl-alt-delete")</literal>. - </para> - </listitem> - </varlistentry> - <varlistentry> - <term> - <methodname>send_chars</methodname> - </term> - <listitem> - <para> - Simulate typing a sequence of characters on the virtual keyboard, e.g., - <literal>send_chars("foobar\n")</literal> will type the string - <literal>foobar</literal> followed by the Enter key. - </para> - </listitem> - </varlistentry> - <varlistentry> - <term> - <methodname>execute</methodname> - </term> - <listitem> - <para> - Execute a shell command, returning a list - <literal>(<replaceable>status</replaceable>, - <replaceable>stdout</replaceable>)</literal>. - </para> - </listitem> - </varlistentry> - <varlistentry> - <term> - <methodname>succeed</methodname> - </term> - <listitem> - <para> - Execute a shell command, raising an exception if the exit status is not - zero, otherwise returning the standard output. - </para> - </listitem> - </varlistentry> - <varlistentry> - <term> - <methodname>fail</methodname> - </term> - <listitem> - <para> - Like <methodname>succeed</methodname>, but raising an exception if the - command returns a zero status. - </para> - </listitem> - </varlistentry> - <varlistentry> - <term> - <methodname>wait_until_succeeds</methodname> - </term> - <listitem> - <para> - Repeat a shell command with 1-second intervals until it succeeds. - </para> - </listitem> - </varlistentry> - <varlistentry> - <term> - <methodname>wait_until_fails</methodname> - </term> - <listitem> - <para> - Repeat a shell command with 1-second intervals until it fails. - </para> - </listitem> - </varlistentry> - <varlistentry> - <term> - <methodname>wait_for_unit</methodname> - </term> - <listitem> - <para> - Wait until the specified systemd unit has reached the “active” state. - </para> - </listitem> - </varlistentry> - <varlistentry> - <term> - <methodname>wait_for_file</methodname> - </term> - <listitem> - <para> - Wait until the specified file exists. - </para> - </listitem> - </varlistentry> - <varlistentry> - <term> - <methodname>wait_for_open_port</methodname> - </term> - <listitem> - <para> - Wait until a process is listening on the given TCP port (on - <literal>localhost</literal>, at least). - </para> - </listitem> - </varlistentry> - <varlistentry> - <term> - <methodname>wait_for_closed_port</methodname> - </term> - <listitem> - <para> - Wait until nobody is listening on the given TCP port. - </para> - </listitem> - </varlistentry> - <varlistentry> - <term> - <methodname>wait_for_x</methodname> - </term> - <listitem> - <para> - Wait until the X11 server is accepting connections. - </para> - </listitem> - </varlistentry> - <varlistentry> - <term> - <methodname>wait_for_text</methodname> - </term> - <listitem> - <para> - Wait until the supplied regular expressions matches the textual contents - of the screen by using optical character recognition (see - <methodname>get_screen_text</methodname> and - <methodname>get_screen_text_variants</methodname>). - </para> - <note> - <para> - This requires passing <option>enableOCR</option> to the test attribute - set. - </para> - </note> - </listitem> - </varlistentry> - <varlistentry> - <term> - <methodname>wait_for_console_text</methodname> - </term> - <listitem> - <para> - Wait until the supplied regular expressions match a line of the serial - console output. This method is useful when OCR is not possibile or - accurate enough. - </para> - </listitem> - </varlistentry> - <varlistentry> - <term> - <methodname>wait_for_window</methodname> - </term> - <listitem> - <para> - Wait until an X11 window has appeared whose name matches the given - regular expression, e.g., <literal>wait_for_window("Terminal")</literal>. - </para> - </listitem> - </varlistentry> - <varlistentry> - <term> - <methodname>copy_from_host</methodname> - </term> - <listitem> - <para> - Copies a file from host to machine, e.g., - <literal>copy_from_host("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. - </para> - </listitem> - </varlistentry> - <varlistentry> - <term> - <methodname>systemctl</methodname> - </term> - <listitem> - <para> - Runs <literal>systemctl</literal> commands with optional support for - <literal>systemctl --user</literal> - </para> - <para> -<programlisting> -machine.systemctl("list-jobs --no-pager") # runs `systemctl list-jobs --no-pager` -machine.systemctl("list-jobs --no-pager", "any-user") # spawns a shell for `any-user` and runs `systemctl --user list-jobs --no-pager` -</programlisting> - </para> - </listitem> - </varlistentry> - </variablelist> - </para> - - <para> - To test user units declared by <literal>systemd.user.services</literal> the - optional <literal>user</literal> argument can be used: -<programlisting> -machine.start() -machine.wait_for_x() -machine.wait_for_unit("xautolock.service", "x-session-user") -</programlisting> - This applies to <literal>systemctl</literal>, <literal>get_unit_info</literal>, - <literal>wait_for_unit</literal>, <literal>start_job</literal> and - <literal>stop_job</literal>. - </para> - - <para> - For faster dev cycles it's also possible to disable the code-linters (this shouldn't - be commited though): -<programlisting> -import ./make-test-python.nix { - skipLint = true; - machine = - { config, pkgs, ... }: - { <replaceable>configuration…</replaceable> - }; - - testScript = - '' - <replaceable>Python code…</replaceable> - ''; -} -</programlisting> - This will produce a Nix warning at evaluation time. To fully disable the - linter, wrap the test script in comment directives to disable the Black linter - directly (again, don't commit this within the Nixpkgs repository): -<programlisting> - testScript = - '' - # fmt: off - <replaceable>Python code…</replaceable> - # fmt: on - ''; -</programlisting> - </para> -</section> diff --git a/nixos/doc/manual/from_md/administration/boot-problems.section.xml b/nixos/doc/manual/from_md/administration/boot-problems.section.xml new file mode 100644 index 00000000000..4ea01e78f32 --- /dev/null +++ b/nixos/doc/manual/from_md/administration/boot-problems.section.xml @@ -0,0 +1,144 @@ +<section xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="sec-boot-problems"> + <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: + </para> + <variablelist> + <varlistentry> + <term> + <literal>boot.shell_on_fail</literal> + </term> + <listitem> + <para> + Allows the user to 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> + <varlistentry> + <term> + <literal>boot.debug1</literal> + </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 + <literal>/proc</literal> and <literal>/sys</literal>. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term> + <literal>boot.debug1devices</literal> + </term> + <listitem> + <para> + Like <literal>boot.debug1</literal>, but runs stage1 until + kernel modules are loaded and device nodes are created. This + may help with e.g. making the keyboard work. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term> + <literal>boot.debug1mounts</literal> + </term> + <listitem> + <para> + Like <literal>boot.debug1</literal> or + <literal>boot.debug1devices</literal>, but runs stage1 until + all filesystems that are mounted during initrd are mounted + (see + <link linkend="opt-fileSystems._name_.neededForBoot">neededForBoot</link>). + As a motivating example, this could be useful if you’ve + forgotten to set + <link xlink:href="options.html#opt-fileSystems._name_.neededForBoot">neededForBoot</link> + on a file system. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term> + <literal>boot.trace</literal> + </term> + <listitem> + <para> + Print every shell command executed by the stage 1 and 2 boot + scripts. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term> + <literal>single</literal> + </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 + <literal>sulogin</literal> 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> + <varlistentry> + <term> + <literal>systemd.log_level=debug</literal> + <literal>systemd.log_target=console</literal> + </term> + <listitem> + <para> + Make systemd very verbose and send log messages to the console + instead of the journal. For more parameters recognised by + systemd, see systemd(1). + </para> + </listitem> + </varlistentry> + </variablelist> + <para> + In addition, these arguments are recognised by the live image only: + </para> + <variablelist> + <varlistentry> + <term> + <literal>live.nixos.passwd=password</literal> + </term> + <listitem> + <para> + Set the password for the <literal>nixos</literal> live user. + This can be used for SSH access if there are issues using the + terminal. + </para> + </listitem> + </varlistentry> + </variablelist> + <para> + Notice that for <literal>boot.shell_on_fail</literal>, + <literal>boot.debug1</literal>, + <literal>boot.debug1devices</literal>, and + <literal>boot.debug1mounts</literal>, if you did + <emphasis role="strong">not</emphasis> select <quote>start the new + shell as pid 1</quote>, and you <literal>exit</literal> from the new + shell, boot will proceed normally from the point where it failed, as + if you’d chosen <quote>ignore the error and continue</quote>. + </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 + <literal>agetty</literal> login prompts should appear eventually + unless something is very wrong.) + </para> +</section> diff --git a/nixos/doc/manual/from_md/configuration/abstractions.section.xml b/nixos/doc/manual/from_md/configuration/abstractions.section.xml new file mode 100644 index 00000000000..c71e23e34ad --- /dev/null +++ b/nixos/doc/manual/from_md/configuration/abstractions.section.xml @@ -0,0 +1,101 @@ +<section xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="sec-module-abstractions"> + <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: + </para> + <programlisting language="bash"> +{ + services.httpd.virtualHosts = + { "blog.example.org" = { + documentRoot = "/webroot/blog.example.org"; + adminAddr = "alice@example.org"; + forceSSL = true; + enableACME = true; + enablePHP = true; + }; + "wiki.example.org" = { + documentRoot = "/webroot/wiki.example.org"; + adminAddr = "alice@example.org"; + forceSSL = true; + enableACME = true; + enablePHP = true; + }; + }; +} +</programlisting> + <para> + It defines two virtual hosts with nearly identical configuration; + the only difference is the document root directories. To prevent + this duplication, we can use a <literal>let</literal>: + </para> + <programlisting language="bash"> +let + commonConfig = + { adminAddr = "alice@example.org"; + forceSSL = true; + enableACME = true; + }; +in +{ + services.httpd.virtualHosts = + { "blog.example.org" = (commonConfig // { documentRoot = "/webroot/blog.example.org"; }); + "wiki.example.org" = (commonConfig // { documentRoot = "/webroot/wiki.example.com"; }); + }; +} +</programlisting> + <para> + The <literal>let commonConfig = ...</literal> defines a variable + named <literal>commonConfig</literal>. The <literal>//</literal> + operator merges two attribute sets, so the configuration of the + second virtual host is the set <literal>commonConfig</literal> + extended with the document root option. + </para> + <para> + You can write a <literal>let</literal> wherever an expression is + allowed. Thus, you also could have written: + </para> + <programlisting language="bash"> +{ + services.httpd.virtualHosts = + let commonConfig = ...; in + { "blog.example.org" = (commonConfig // { ... }) + "wiki.example.org" = (commonConfig // { ... }) + }; +} +</programlisting> + <para> + but not <literal>{ let commonConfig = ...; in ...; }</literal> since + attributes (as opposed to attribute values) are not expressions. + </para> + <para> + <emphasis role="strong">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 document root. This can be done as follows: + </para> + <programlisting language="bash"> +{ + services.httpd.virtualHosts = + let + makeVirtualHost = webroot: + { documentRoot = webroot; + adminAddr = "alice@example.org"; + forceSSL = true; + enableACME = true; + }; + in + { "example.org" = (makeVirtualHost "/webroot/example.org"); + "example.com" = (makeVirtualHost "/webroot/example.com"); + "example.gov" = (makeVirtualHost "/webroot/example.gov"); + "example.nl" = (makeVirtualHost "/webroot/example.nl"); + }; +} +</programlisting> + <para> + Here, <literal>makeVirtualHost</literal> is a function that takes a + single argument <literal>webroot</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> +</section> diff --git a/nixos/doc/manual/from_md/configuration/sshfs-file-systems.section.xml b/nixos/doc/manual/from_md/configuration/sshfs-file-systems.section.xml new file mode 100644 index 00000000000..6b317aa63e9 --- /dev/null +++ b/nixos/doc/manual/from_md/configuration/sshfs-file-systems.section.xml @@ -0,0 +1,139 @@ +<section xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="sec-sshfs-file-systems"> + <title>SSHFS File Systems</title> + <para> + <link xlink:href="https://github.com/libfuse/sshfs">SSHFS</link> is + a + <link xlink:href="https://en.wikipedia.org/wiki/Filesystem_in_Userspace">FUSE</link> + filesystem that allows easy access to directories on a remote + machine using the SSH File Transfer Protocol (SFTP). It means that + if you have SSH access to a machine, no additional setup is needed + to mount a directory. + </para> + <section xml:id="sec-sshfs-interactive"> + <title>Interactive mounting</title> + <para> + In NixOS, SSHFS is packaged as <package>sshfs</package>. Once + installed, mounting a directory interactively is simple as + running: + </para> + <programlisting> +$ sshfs my-user@example.com:/my-dir /mnt/my-dir +</programlisting> + <para> + Like any other FUSE file system, the directory is unmounted using: + </para> + <programlisting> +$ fusermount -u /mnt/my-dir +</programlisting> + </section> + <section xml:id="sec-sshfs-non-interactive"> + <title>Non-interactive mounting</title> + <para> + Mounting non-interactively requires some precautions because + <literal>sshfs</literal> will run at boot and under a different + user (root). For obvious reason, you can’t input a password, so + public key authentication using an unencrypted key is needed. To + create a new key without a passphrase you can do: + </para> + <programlisting> +$ ssh-keygen -t ed25519 -P '' -f example-key +Generating public/private ed25519 key pair. +Your identification has been saved in test-key +Your public key has been saved in test-key.pub +The key fingerprint is: +SHA256:yjxl3UbTn31fLWeyLYTAKYJPRmzknjQZoyG8gSNEoIE my-user@workstation +</programlisting> + <para> + To keep the key safe, change the ownership to + <literal>root:root</literal> and make sure the permissions are + <literal>600</literal>: OpenSSH normally refuses to use the key if + it’s not well-protected. + </para> + <para> + The file system can be configured in NixOS via the usual + <link xlink:href="options.html#opt-fileSystems">fileSystems</link> + option. Here’s a typical setup: + </para> + <programlisting language="bash"> +{ + system.fsPackages = [ pkgs.sshfs ]; + + fileSystems."/mnt/my-dir" = { + device = "my-user@example.com:/my-dir/"; + fsType = "sshfs"; + options = + [ # Filesystem options + "allow_other" # for non-root access + "_netdev" # this is a network fs + "x-systemd.automount" # mount on demand + + # SSH options + "reconnect" # handle connection drops + "ServerAliveInterval=15" # keep connections alive + "IdentityFile=/var/secrets/example-key" + ]; + }; +} +</programlisting> + <para> + More options from <literal>ssh_config(5)</literal> can be given as + well, for example you can change the default SSH port or specify a + jump proxy: + </para> + <programlisting language="bash"> +{ + options = + [ "ProxyJump=bastion@example.com" + "Port=22" + ]; +} +</programlisting> + <para> + It’s also possible to change the <literal>ssh</literal> command + used by SSHFS to connect to the server. For example: + </para> + <programlisting language="bash"> +{ + options = + [ (builtins.replaceStrings [" "] ["\\040"] + "ssh_command=${pkgs.openssh}/bin/ssh -v -L 8080:localhost:80") + ]; + +} +</programlisting> + <note> + <para> + The escaping of spaces is needed because every option is written + to the <literal>/etc/fstab</literal> file, which is a + space-separated table. + </para> + </note> + <section xml:id="sec-sshfs-troubleshooting"> + <title>Troubleshooting</title> + <para> + If you’re having a hard time figuring out why mounting is + failing, you can add the option + <literal>"debug"</literal>. This enables a verbose log + in SSHFS that you can access via: + </para> + <programlisting> +$ journalctl -u $(systemd-escape -p /mnt/my-dir/).mount +Jun 22 11:41:18 workstation mount[87790]: SSHFS version 3.7.1 +Jun 22 11:41:18 workstation mount[87793]: executing <ssh> <-x> <-a> <-oClearAllForwardings=yes> <-oServerAliveInterval=15> <-oIdentityFile=/var/secrets/wrong-key> <-2> <my-user@example.com> <-s> <sftp> +Jun 22 11:41:19 workstation mount[87793]: my-user@example.com: Permission denied (publickey). +Jun 22 11:41:19 workstation mount[87790]: read: Connection reset by peer +Jun 22 11:41:19 workstation systemd[1]: mnt-my\x2ddir.mount: Mount process exited, code=exited, status=1/FAILURE +Jun 22 11:41:19 workstation systemd[1]: mnt-my\x2ddir.mount: Failed with result 'exit-code'. +Jun 22 11:41:19 workstation systemd[1]: Failed to mount /mnt/my-dir. +Jun 22 11:41:19 workstation systemd[1]: mnt-my\x2ddir.mount: Consumed 54ms CPU time, received 2.3K IP traffic, sent 2.7K IP traffic. +</programlisting> + <note> + <para> + If the mount point contains special characters it needs to be + escaped using <literal>systemd-escape</literal>. This is due + to the way systemd converts paths into unit names. + </para> + </note> + </section> + </section> +</section> diff --git a/nixos/doc/manual/from_md/development/assertions.section.xml b/nixos/doc/manual/from_md/development/assertions.section.xml new file mode 100644 index 00000000000..0844d484d60 --- /dev/null +++ b/nixos/doc/manual/from_md/development/assertions.section.xml @@ -0,0 +1,58 @@ +<section xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="sec-assertions"> + <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. + </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. + </para> + <section xml:id="sec-assertions-warnings"> + <title>Warnings</title> + <para> + This is an example of using <literal>warnings</literal>. + </para> + <programlisting language="bash"> +{ config, lib, ... }: +{ + config = lib.mkIf config.services.foo.enable { + warnings = + if config.services.foo.bar + then [ ''You have enabled the bar feature of the foo service. + This is known to cause some specific problems in certain situations. + '' ] + else []; + } +} +</programlisting> + </section> + <section xml:id="sec-assertions-assetions"> + <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. + </para> + <programlisting language="bash"> +{ config, lib, ... }: +{ + config = lib.mkIf config.services.syslogd.enable { + assertions = + [ { assertion = !config.services.rsyslogd.enable; + message = "rsyslogd conflicts with syslogd"; + } + ]; + } +} +</programlisting> + </section> +</section> diff --git a/nixos/doc/manual/from_md/development/running-nixos-tests-interactively.section.xml b/nixos/doc/manual/from_md/development/running-nixos-tests-interactively.section.xml new file mode 100644 index 00000000000..a2030e9c073 --- /dev/null +++ b/nixos/doc/manual/from_md/development/running-nixos-tests-interactively.section.xml @@ -0,0 +1,50 @@ +<section xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="sec-running-nixos-tests-interactively"> + <title>Running Tests interactively</title> + <para> + The test itself can be run interactively. This is particularly + useful when developing or debugging a test: + </para> + <programlisting> +$ nix-build nixos/tests/login.nix -A driverInteractive +$ ./result/bin/nixos-test-driver +starting VDE switch for network 1 +> +</programlisting> + <para> + You can then take any Python statement, e.g. + </para> + <programlisting language="python"> +> start_all() +> test_script() +> machine.succeed("touch /tmp/foo") +> print(machine.succeed("pwd")) # Show stdout of command +</programlisting> + <para> + The function <literal>test_script</literal> 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> + To just start and experiment with the VMs, run: + </para> + <programlisting> +$ nix-build nixos/tests/login.nix -A driverInteractive +$ ./result/bin/nixos-run-vms +</programlisting> + <para> + The script <literal>nixos-run-vms</literal> starts the virtual + machines defined by test. + </para> + <para> + You can re-use the VM states coming from a previous run by setting + the <literal>--keep-vm-state</literal> flag. + </para> + <programlisting> +$ ./result/bin/nixos-run-vms --keep-vm-state +</programlisting> + <para> + The machine state is stored in the + <literal>$TMPDIR/vm-state-machinename</literal> directory. + </para> +</section> diff --git a/nixos/doc/manual/from_md/development/running-nixos-tests.section.xml b/nixos/doc/manual/from_md/development/running-nixos-tests.section.xml new file mode 100644 index 00000000000..7159b95b22b --- /dev/null +++ b/nixos/doc/manual/from_md/development/running-nixos-tests.section.xml @@ -0,0 +1,34 @@ +<section xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="sec-running-nixos-tests"> + <title>Running Tests</title> + <para> + You can run tests using <literal>nix-build</literal>. For example, + to run the test + <link xlink:href="https://github.com/NixOS/nixpkgs/blob/master/nixos/tests/login.nix"><literal>login.nix</literal></link>, + you just do: + </para> + <programlisting> +$ nix-build '<nixpkgs/nixos/tests/login.nix>' +</programlisting> + <para> + or, if you don’t want to rely on <literal>NIX_PATH</literal>: + </para> + <programlisting> +$ cd /my/nixpkgs/nixos/tests +$ nix-build login.nix +… +running the VM test script +machine: QEMU running (pid 8841) +… +6 out of 6 tests succeeded +</programlisting> + <para> + 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: + </para> + <programlisting> +$ firefox result/log.html +</programlisting> +</section> diff --git a/nixos/doc/manual/from_md/development/writing-nixos-tests.section.xml b/nixos/doc/manual/from_md/development/writing-nixos-tests.section.xml new file mode 100644 index 00000000000..83a96d5bb22 --- /dev/null +++ b/nixos/doc/manual/from_md/development/writing-nixos-tests.section.xml @@ -0,0 +1,526 @@ +<section xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="sec-writing-nixos-tests"> + <title>Writing Tests</title> + <para> + A NixOS test is a Nix expression that has the following structure: + </para> + <programlisting language="bash"> +import ./make-test-python.nix { + + # Either the configuration of a single machine: + machine = + { config, pkgs, ... }: + { configuration… + }; + + # Or a set of machines: + nodes = + { machine1 = + { config, pkgs, ... }: { … }; + machine2 = + { config, pkgs, ... }: { … }; + … + }; + + testScript = + '' + Python code… + ''; +} +</programlisting> + <para> + The attribute <literal>testScript</literal> is a bit of Python 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, + <link xlink:href="https://github.com/NixOS/nixpkgs/blob/master/nixos/tests/login.nix"><literal>login.nix</literal></link> + 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, + <link xlink:href="https://github.com/NixOS/nixpkgs/blob/master/nixos/tests/nfs/simple.nix"><literal>nfs/simple.nix</literal></link>, + 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> + There are a few special NixOS configuration options for test VMs: + </para> + <variablelist> + <varlistentry> + <term> + <literal>virtualisation.memorySize</literal> + </term> + <listitem> + <para> + The memory of the VM in megabytes. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term> + <literal>virtualisation.vlans</literal> + </term> + <listitem> + <para> + The virtual networks to which the VM is connected. See + <link xlink:href="https://github.com/NixOS/nixpkgs/blob/master/nixos/tests/nat.nix"><literal>nat.nix</literal></link> + for an example. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term> + <literal>virtualisation.writableStore</literal> + </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. + </para> + </listitem> + </varlistentry> + </variablelist> + <para> + For more options, see the module + <link xlink:href="https://github.com/NixOS/nixpkgs/blob/master/nixos/modules/virtualisation/qemu-vm.nix"><literal>qemu-vm.nix</literal></link>. + </para> + <para> + The test script is a sequence of Python 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>name</literal> if this is also the + identifier of the machine in the declarative config. If you didn't + specify multiple machines using the <literal>nodes</literal> + attribute, it is just <literal>machine</literal>. The following + example starts the machine, waits until it has finished booting, + then executes a command and checks that the output is more-or-less + correct: + </para> + <programlisting language="python"> +machine.start() +machine.wait_for_unit("default.target") +if not "Linux" in machine.succeed("uname"): + raise Exception("Wrong OS") +</programlisting> + <para> + The first line is actually unnecessary; machines are implicitly + started when you first execute an action on them (such as + <literal>wait_for_unit</literal> or <literal>succeed</literal>). If + you have multiple machines, you can speed up the test by starting + them in parallel: + </para> + <programlisting language="python"> +start_all() +</programlisting> + <para> + The following methods are available on machine objects: + </para> + <variablelist> + <varlistentry> + <term> + <literal>start</literal> + </term> + <listitem> + <para> + Start the virtual machine. This method is asynchronous — it + does not wait for the machine to finish booting. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term> + <literal>shutdown</literal> + </term> + <listitem> + <para> + Shut down the machine, waiting for the VM to exit. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term> + <literal>crash</literal> + </term> + <listitem> + <para> + Simulate a sudden power failure, by telling the VM to exit + immediately. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term> + <literal>block</literal> + </term> + <listitem> + <para> + Simulate unplugging the Ethernet cable that connects the + machine to the other machines. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term> + <literal>unblock</literal> + </term> + <listitem> + <para> + Undo the effect of <literal>block</literal>. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term> + <literal>screenshot</literal> + </term> + <listitem> + <para> + Take a picture of the display of the virtual machine, in PNG + format. The screenshot is linked from the HTML log. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term> + <literal>get_screen_text_variants</literal> + </term> + <listitem> + <para> + Return a list of different interpretations of what is + currently visible on the machine's screen using optical + character recognition. The number and order of the + interpretations is not specified and is subject to change, but + if no exception is raised at least one will be returned. + </para> + <note> + <para> + This requires passing <literal>enableOCR</literal> to the + test attribute set. + </para> + </note> + </listitem> + </varlistentry> + <varlistentry> + <term> + <literal>get_screen_text</literal> + </term> + <listitem> + <para> + Return a textual representation of what is currently visible + on the machine's screen using optical character recognition. + </para> + <note> + <para> + This requires passing <literal>enableOCR</literal> to the + test attribute set. + </para> + </note> + </listitem> + </varlistentry> + <varlistentry> + <term> + <literal>send_monitor_command</literal> + </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. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term> + <literal>send_key</literal> + </term> + <listitem> + <para> + Simulate pressing keys on the virtual keyboard, e.g., + <literal>send_key("ctrl-alt-delete")</literal>. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term> + <literal>send_chars</literal> + </term> + <listitem> + <para> + Simulate typing a sequence of characters on the virtual + keyboard, e.g., + <literal>send_chars("foobar\n")</literal> will type + the string <literal>foobar</literal> followed by the Enter + key. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term> + <literal>execute</literal> + </term> + <listitem> + <para> + Execute a shell command, returning a list + <literal>(status, stdout)</literal>. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term> + <literal>succeed</literal> + </term> + <listitem> + <para> + Execute a shell command, raising an exception if the exit + status is not zero, otherwise returning the standard output. + Commands are run with <literal>set -euo pipefail</literal> + set: + </para> + <itemizedlist> + <listitem> + <para> + If several commands are separated by <literal>;</literal> + and one fails, the command as a whole will fail. + </para> + </listitem> + <listitem> + <para> + For pipelines, the last non-zero exit status will be + returned (if there is one, zero will be returned + otherwise). + </para> + </listitem> + <listitem> + <para> + Dereferencing unset variables fail the command. + </para> + </listitem> + </itemizedlist> + </listitem> + </varlistentry> + <varlistentry> + <term> + <literal>fail</literal> + </term> + <listitem> + <para> + Like <literal>succeed</literal>, but raising an exception if + the command returns a zero status. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term> + <literal>wait_until_succeeds</literal> + </term> + <listitem> + <para> + Repeat a shell command with 1-second intervals until it + succeeds. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term> + <literal>wait_until_fails</literal> + </term> + <listitem> + <para> + Repeat a shell command with 1-second intervals until it fails. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term> + <literal>wait_for_unit</literal> + </term> + <listitem> + <para> + Wait until the specified systemd unit has reached the + <quote>active</quote> state. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term> + <literal>wait_for_file</literal> + </term> + <listitem> + <para> + Wait until the specified file exists. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term> + <literal>wait_for_open_port</literal> + </term> + <listitem> + <para> + Wait until a process is listening on the given TCP port (on + <literal>localhost</literal>, at least). + </para> + </listitem> + </varlistentry> + <varlistentry> + <term> + <literal>wait_for_closed_port</literal> + </term> + <listitem> + <para> + Wait until nobody is listening on the given TCP port. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term> + <literal>wait_for_x</literal> + </term> + <listitem> + <para> + Wait until the X11 server is accepting connections. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term> + <literal>wait_for_text</literal> + </term> + <listitem> + <para> + Wait until the supplied regular expressions matches the + textual contents of the screen by using optical character + recognition (see <literal>get_screen_text</literal> and + <literal>get_screen_text_variants</literal>). + </para> + <note> + <para> + This requires passing <literal>enableOCR</literal> to the + test attribute set. + </para> + </note> + </listitem> + </varlistentry> + <varlistentry> + <term> + <literal>wait_for_console_text</literal> + </term> + <listitem> + <para> + Wait until the supplied regular expressions match a line of + the serial console output. This method is useful when OCR is + not possibile or accurate enough. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term> + <literal>wait_for_window</literal> + </term> + <listitem> + <para> + Wait until an X11 window has appeared whose name matches the + given regular expression, e.g., + <literal>wait_for_window("Terminal")</literal>. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term> + <literal>copy_from_host</literal> + </term> + <listitem> + <para> + Copies a file from host to machine, e.g., + <literal>copy_from_host("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. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term> + <literal>systemctl</literal> + </term> + <listitem> + <para> + Runs <literal>systemctl</literal> commands with optional + support for <literal>systemctl --user</literal> + </para> + <programlisting language="python"> +machine.systemctl("list-jobs --no-pager") # runs `systemctl list-jobs --no-pager` +machine.systemctl("list-jobs --no-pager", "any-user") # spawns a shell for `any-user` and runs `systemctl --user list-jobs --no-pager` +</programlisting> + </listitem> + </varlistentry> + <varlistentry> + <term> + <literal>shell_interact</literal> + </term> + <listitem> + <para> + Allows you to directly interact with the guest shell. This + should only be used during test development, not in production + tests. Killing the interactive session with + <literal>Ctrl-d</literal> or <literal>Ctrl-c</literal> also + ends the guest session. + </para> + </listitem> + </varlistentry> + </variablelist> + <para> + To test user units declared by + <literal>systemd.user.services</literal> the optional + <literal>user</literal> argument can be used: + </para> + <programlisting language="python"> +machine.start() +machine.wait_for_x() +machine.wait_for_unit("xautolock.service", "x-session-user") +</programlisting> + <para> + This applies to <literal>systemctl</literal>, + <literal>get_unit_info</literal>, <literal>wait_for_unit</literal>, + <literal>start_job</literal> and <literal>stop_job</literal>. + </para> + <para> + For faster dev cycles it's also possible to disable the code-linters + (this shouldn't be commited though): + </para> + <programlisting language="bash"> +import ./make-test-python.nix { + skipLint = true; + machine = + { config, pkgs, ... }: + { configuration… + }; + + testScript = + '' + Python code… + ''; +} +</programlisting> + <para> + This will produce a Nix warning at evaluation time. To fully disable + the linter, wrap the test script in comment directives to disable + the Black linter directly (again, don't commit this within the + Nixpkgs repository): + </para> + <programlisting language="bash"> + testScript = + '' + # fmt: off + Python code… + # fmt: on + ''; +</programlisting> +</section> diff --git a/nixos/doc/manual/from_md/release-notes/rl-1310.section.xml b/nixos/doc/manual/from_md/release-notes/rl-1310.section.xml new file mode 100644 index 00000000000..b4f3657b4b8 --- /dev/null +++ b/nixos/doc/manual/from_md/release-notes/rl-1310.section.xml @@ -0,0 +1,6 @@ +<section xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="sec-release-13.10"> + <title>Release 13.10 (<quote>Aardvark</quote>, 2013/10/31)</title> + <para> + This is the first stable release branch of NixOS. + </para> +</section> diff --git a/nixos/doc/manual/from_md/release-notes/rl-1404.section.xml b/nixos/doc/manual/from_md/release-notes/rl-1404.section.xml new file mode 100644 index 00000000000..8771623b468 --- /dev/null +++ b/nixos/doc/manual/from_md/release-notes/rl-1404.section.xml @@ -0,0 +1,189 @@ +<section xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="sec-release-14.04"> + <title>Release 14.04 (<quote>Baboon</quote>, 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: + </para> + <itemizedlist> + <listitem> + <para> + 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 <literal>systemd.unit.*</literal> options. + </para> + </listitem> + <listitem> + <para> + NixOS is now based on Glibc 2.19 and GCC 4.8. + </para> + </listitem> + <listitem> + <para> + The default Linux kernel has been updated to 3.12. + </para> + </listitem> + <listitem> + <para> + KDE has been updated to 4.12. + </para> + </listitem> + <listitem> + <para> + GNOME 3.10 experimental support has been added. + </para> + </listitem> + <listitem> + <para> + Nix has been updated to 1.7 + (<link xlink:href="https://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 <literal>users.mutableUsers</literal> to + <literal>false</literal>, then the contents of + <literal>/etc/passwd</literal> and <literal>/etc/group</literal> + 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 <literal>users.extraUsers</literal> and run + <literal>nixos-rebuild</literal>, the user account will cease to + exist. Also, imperative commands for managing users and groups, + such as <literal>useradd</literal>, are no longer available. If + <literal>users.mutableUsers</literal> 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. + </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: + </para> + <programlisting language="bash"> +{ + systemd.packages = [ pkgs.foo ]; +} +</programlisting> + <para> + to enable those units. You can then set or override unit options + in the usual way, e.g. + </para> + <programlisting language="bash"> +{ + systemd.services.foo.wantedBy = [ "multi-user.target" ]; + systemd.services.foo.serviceConfig.MemoryLimit = "512M"; +} +</programlisting> + <para> + When upgrading from a previous release, please be aware of the + following incompatible changes: + </para> + </listitem> + <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: + </para> + <programlisting language="bash"> +{ + nixpkgs.config.allowUnfree = true; +} +</programlisting> + <para> + Otherwise, you get an error message such as: + </para> + <programlisting> + error: package ‘nvidia-x11-331.49-3.12.17’ in ‘…/nvidia-x11/default.nix:56’ + has an unfree license, refusing to evaluate +</programlisting> + </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: + </para> + <programlisting language="bash"> +{ + nixpkgs.config.allowUnfree = true; + nixpkgs.config.firefox.enableAdobeFlash = true; # for Firefox + nixpkgs.config.chromium.enableAdobeFlash = true; # for Chromium +} +</programlisting> + </listitem> + <listitem> + <para> + The firewall is now enabled by default. If you don’t want this, + you need to disable it explicitly: + </para> + <programlisting language="bash"> +{ + networking.firewall.enable = false; +} +</programlisting> + </listitem> + <listitem> + <para> + The option <literal>boot.loader.grub.memtest86</literal> has + been renamed to + <literal>boot.loader.grub.memtest86.enable</literal>. + </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 <literal>services.mysql.package</literal>. + </para> + </listitem> + <listitem> + <para> + Package variants are now differentiated by suffixing the name, + rather than the version. For instance, + <literal>sqlite-3.8.4.3-interactive</literal> is now called + <literal>sqlite-interactive-3.8.4.3</literal>. This ensures that + <literal>nix-env -i sqlite</literal> is unambiguous, and that + <literal>nix-env -u</literal> won’t <quote>upgrade</quote> + <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 + <literal>nix-env</literal>, 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 <literal>/etc/ca-bundle.crt</literal> is gone. + Programs should instead use the environment variable + <literal>OPENSSL_X509_CERT_FILE</literal> (which points to + <literal>/etc/ssl/certs/ca-bundle.crt</literal>). + </para> + </listitem> + </itemizedlist> +</section> diff --git a/nixos/doc/manual/from_md/release-notes/rl-1412.section.xml b/nixos/doc/manual/from_md/release-notes/rl-1412.section.xml new file mode 100644 index 00000000000..3b6af73359d --- /dev/null +++ b/nixos/doc/manual/from_md/release-notes/rl-1412.section.xml @@ -0,0 +1,466 @@ +<section xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="sec-release-14.12"> + <title>Release 14.12 (<quote>Caterpillar</quote>, 2014/12/30)</title> + <para> + In addition to numerous new and upgraded packages, this release has + the following highlights: + </para> + <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> + </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> + </para> + </listitem> + <listitem> + <para> + NixOS is now based on Glibc 2.20. + </para> + </listitem> + <listitem> + <para> + KDE has been updated to 4.14. + </para> + </listitem> + <listitem> + <para> + The default Linux kernel has been updated to 3.14. + </para> + </listitem> + <listitem> + <para> + If <literal>users.mutableUsers</literal> is enabled (the + default), changes made to the declaration of a user or group + will be correctly realised when running + <literal>nixos-rebuild</literal>. For instance, removing a user + specification from <literal>configuration.nix</literal> will + cause the actual user account to be deleted. If + <literal>users.mutableUsers</literal> is disabled, it is no + longer necessary to specify UIDs or GIDs; if omitted, they are + allocated dynamically. + </para> + </listitem> + </itemizedlist> + <para> + Following new services were added since the last release: + </para> + <itemizedlist> + <listitem> + <para> + <literal>atftpd</literal> + </para> + </listitem> + <listitem> + <para> + <literal>bosun</literal> + </para> + </listitem> + <listitem> + <para> + <literal>bspwm</literal> + </para> + </listitem> + <listitem> + <para> + <literal>chronos</literal> + </para> + </listitem> + <listitem> + <para> + <literal>collectd</literal> + </para> + </listitem> + <listitem> + <para> + <literal>consul</literal> + </para> + </listitem> + <listitem> + <para> + <literal>cpuminer-cryptonight</literal> + </para> + </listitem> + <listitem> + <para> + <literal>crashplan</literal> + </para> + </listitem> + <listitem> + <para> + <literal>dnscrypt-proxy</literal> + </para> + </listitem> + <listitem> + <para> + <literal>docker-registry</literal> + </para> + </listitem> + <listitem> + <para> + <literal>docker</literal> + </para> + </listitem> + <listitem> + <para> + <literal>etcd</literal> + </para> + </listitem> + <listitem> + <para> + <literal>fail2ban</literal> + </para> + </listitem> + <listitem> + <para> + <literal>fcgiwrap</literal> + </para> + </listitem> + <listitem> + <para> + <literal>fleet</literal> + </para> + </listitem> + <listitem> + <para> + <literal>fluxbox</literal> + </para> + </listitem> + <listitem> + <para> + <literal>gdm</literal> + </para> + </listitem> + <listitem> + <para> + <literal>geoclue2</literal> + </para> + </listitem> + <listitem> + <para> + <literal>gitlab</literal> + </para> + </listitem> + <listitem> + <para> + <literal>gitolite</literal> + </para> + </listitem> + <listitem> + <para> + <literal>gnome3.gnome-documents</literal> + </para> + </listitem> + <listitem> + <para> + <literal>gnome3.gnome-online-miners</literal> + </para> + </listitem> + <listitem> + <para> + <literal>gnome3.gvfs</literal> + </para> + </listitem> + <listitem> + <para> + <literal>gnome3.seahorse</literal> + </para> + </listitem> + <listitem> + <para> + <literal>hbase</literal> + </para> + </listitem> + <listitem> + <para> + <literal>i2pd</literal> + </para> + </listitem> + <listitem> + <para> + <literal>influxdb</literal> + </para> + </listitem> + <listitem> + <para> + <literal>kubernetes</literal> + </para> + </listitem> + <listitem> + <para> + <literal>liquidsoap</literal> + </para> + </listitem> + <listitem> + <para> + <literal>lxc</literal> + </para> + </listitem> + <listitem> + <para> + <literal>mailpile</literal> + </para> + </listitem> + <listitem> + <para> + <literal>mesos</literal> + </para> + </listitem> + <listitem> + <para> + <literal>mlmmj</literal> + </para> + </listitem> + <listitem> + <para> + <literal>monetdb</literal> + </para> + </listitem> + <listitem> + <para> + <literal>mopidy</literal> + </para> + </listitem> + <listitem> + <para> + <literal>neo4j</literal> + </para> + </listitem> + <listitem> + <para> + <literal>nsd</literal> + </para> + </listitem> + <listitem> + <para> + <literal>openntpd</literal> + </para> + </listitem> + <listitem> + <para> + <literal>opentsdb</literal> + </para> + </listitem> + <listitem> + <para> + <literal>openvswitch</literal> + </para> + </listitem> + <listitem> + <para> + <literal>parallels-guest</literal> + </para> + </listitem> + <listitem> + <para> + <literal>peerflix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>phd</literal> + </para> + </listitem> + <listitem> + <para> + <literal>polipo</literal> + </para> + </listitem> + <listitem> + <para> + <literal>prosody</literal> + </para> + </listitem> + <listitem> + <para> + <literal>radicale</literal> + </para> + </listitem> + <listitem> + <para> + <literal>redmine</literal> + </para> + </listitem> + <listitem> + <para> + <literal>riemann</literal> + </para> + </listitem> + <listitem> + <para> + <literal>scollector</literal> + </para> + </listitem> + <listitem> + <para> + <literal>seeks</literal> + </para> + </listitem> + <listitem> + <para> + <literal>siproxd</literal> + </para> + </listitem> + <listitem> + <para> + <literal>strongswan</literal> + </para> + </listitem> + <listitem> + <para> + <literal>tcsd</literal> + </para> + </listitem> + <listitem> + <para> + <literal>teamspeak3</literal> + </para> + </listitem> + <listitem> + <para> + <literal>thermald</literal> + </para> + </listitem> + <listitem> + <para> + <literal>torque/mrom</literal> + </para> + </listitem> + <listitem> + <para> + <literal>torque/server</literal> + </para> + </listitem> + <listitem> + <para> + <literal>uhub</literal> + </para> + </listitem> + <listitem> + <para> + <literal>unifi</literal> + </para> + </listitem> + <listitem> + <para> + <literal>znc</literal> + </para> + </listitem> + <listitem> + <para> + <literal>zookeeper</literal> + </para> + </listitem> + </itemizedlist> + <para> + When upgrading from a previous release, please be aware of the + following incompatible changes: + </para> + <itemizedlist> + <listitem> + <para> + The default version of Apache httpd is now 2.4. If you use the + <literal>extraConfig</literal> 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: + </para> + <programlisting language="bash"> +{ + services.httpd.package = pkgs.apacheHttpd_2_2; +} +</programlisting> + </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. + </para> + </listitem> + <listitem> + <para> + The host side of a container virtual Ethernet pair is now called + <literal>ve-container-name</literal> rather than + <literal>c-container-name</literal>. + </para> + </listitem> + <listitem> + <para> + 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 <literal>rm -rf /tmp/.vbox*</literal>. 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. + </para> + </listitem> + <listitem> + <para> + Chromium has been updated to 39.0.2171.65. + <literal>enablePepperPDF</literal> 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>. + </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. + </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 xlink:href="https://en.wikipedia.org/wiki/List_of_tz_database_time_zones">https://en.wikipedia.org/wiki/List_of_tz_database_time_zones</link>. + </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. + </para> + </listitem> + <listitem> + <para> + The Intel GPU driver was updated to the 3.x prerelease version + (used by most distributions) and supports DRI3 now. + </para> + </listitem> + </itemizedlist> +</section> diff --git a/nixos/doc/manual/from_md/release-notes/rl-1509.section.xml b/nixos/doc/manual/from_md/release-notes/rl-1509.section.xml new file mode 100644 index 00000000000..68d2ab389e8 --- /dev/null +++ b/nixos/doc/manual/from_md/release-notes/rl-1509.section.xml @@ -0,0 +1,776 @@ +<section xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="sec-release-15.09"> + <title>Release 15.09 (<quote>Dingo</quote>, 2015/09/30)</title> + <para> + 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="https://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. + </para> + </listitem> + <listitem> + <para> + You can now keep your NixOS system up to date automatically by + setting + </para> + </listitem> + </itemizedlist> + <programlisting language="bash"> +{ + system.autoUpgrade.enable = true; +} +</programlisting> + <para> + This will cause the system to periodically check for updates in your + current channel and run <literal>nixos-rebuild</literal>. + </para> + <itemizedlist> + <listitem> + <para> + This release is based on Glibc 2.21, GCC 4.9 and Linux 3.18. + </para> + </listitem> + <listitem> + <para> + GNOME has been upgraded to 3.16. + </para> + </listitem> + <listitem> + <para> + Xfce has been upgraded to 4.12. + </para> + </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. + </para> + </listitem> + <listitem> + <para> + E19 has been upgraded to 0.16.8.15. + </para> + </listitem> + </itemizedlist> + <para> + The following new services were added since the last release: + </para> + <itemizedlist> + <listitem> + <para> + <literal>services/mail/exim.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>services/misc/apache-kafka.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>services/misc/canto-daemon.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>services/misc/confd.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>services/misc/devmon.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>services/misc/gitit.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>services/misc/ihaskell.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>services/misc/mbpfan.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>services/misc/mediatomb.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>services/misc/mwlib.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>services/misc/parsoid.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>services/misc/plex.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>services/misc/ripple-rest.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>services/misc/ripple-data-api.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>services/misc/subsonic.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>services/misc/sundtek.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>services/monitoring/cadvisor.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>services/monitoring/das_watchdog.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>services/monitoring/grafana.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>services/monitoring/riemann-tools.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>services/monitoring/teamviewer.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>services/network-filesystems/u9fs.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>services/networking/aiccu.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>services/networking/asterisk.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>services/networking/bird.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>services/networking/charybdis.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>services/networking/docker-registry-server.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>services/networking/fan.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>services/networking/firefox/sync-server.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>services/networking/gateone.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>services/networking/heyefi.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>services/networking/i2p.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>services/networking/lambdabot.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>services/networking/mstpd.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>services/networking/nix-serve.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>services/networking/nylon.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>services/networking/racoon.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>services/networking/skydns.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>services/networking/shout.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>services/networking/softether.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>services/networking/sslh.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>services/networking/tinc.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>services/networking/tlsdated.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>services/networking/tox-bootstrapd.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>services/networking/tvheadend.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>services/networking/zerotierone.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>services/scheduling/marathon.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>services/security/fprintd.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>services/security/hologram.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>services/security/munge.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>services/system/cloud-init.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>services/web-servers/shellinabox.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>services/web-servers/uwsgi.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>services/x11/unclutter.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>services/x11/display-managers/sddm.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>system/boot/coredump.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>system/boot/loader/loader.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>system/boot/loader/generic-extlinux-compatible</literal> + </para> + </listitem> + <listitem> + <para> + <literal>system/boot/networkd.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>system/boot/resolved.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>system/boot/timesyncd.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>tasks/filesystems/exfat.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>tasks/filesystems/ntfs.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>tasks/filesystems/vboxsf.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>virtualisation/virtualbox-host.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>virtualisation/vmware-guest.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>virtualisation/xen-dom0.nix</literal> + </para> + </listitem> + </itemizedlist> + <para> + When upgrading from a previous release, please be aware of the + following incompatible changes: + </para> + <itemizedlist spacing="compact"> + <listitem> + <para> + <literal>sshd</literal> 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 + </para> + </listitem> + </itemizedlist> + <programlisting language="bash"> +{ + system.stateVersion = "14.12"; +} +</programlisting> + <para> + The new option <literal>system.stateVersion</literal> ensures that + certain configuration changes that could break existing systems + (such as the <literal>sshd</literal> host key setting) will maintain + compatibility with the specified NixOS release. NixOps sets the + state version of existing deployments automatically. + </para> + <itemizedlist> + <listitem> + <para> + <literal>cron</literal> is no longer enabled by default, unless + you have a non-empty + <literal>services.cron.systemCronJobs</literal>. To force + <literal>cron</literal> to be enabled, set + <literal>services.cron.enable = true</literal>. + </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 + <literal>nix.requireSignedBinaryCaches = false</literal>. + </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>. + </para> + </listitem> + <listitem> + <para> + 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> + </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. + </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>. + </para> + <para> + Local printers are no longer shared or advertised by default. + This behavior can be changed by enabling + <literal>services.printing.defaultShared</literal> or + <literal>services.printing.browsing</literal> respectively. + </para> + </listitem> + <listitem> + <para> + The VirtualBox host and guest options have been named more + consistently. They can now found in + <literal>virtualisation.virtualbox.host.*</literal> instead of + <literal>services.virtualboxHost.*</literal> and + <literal>virtualisation.virtualbox.guest.*</literal> instead of + <literal>services.virtualboxGuest.*</literal>. + </para> + <para> + Also, there now is support for the <literal>vboxsf</literal> + file system using the <literal>fileSystems</literal> + configuration attribute. An example of how this can be used in a + configuration: + </para> + </listitem> + </itemizedlist> + <programlisting language="bash"> +{ + fileSystems."/shiny" = { + device = "myshinysharedfolder"; + fsType = "vboxsf"; + }; +} +</programlisting> + <itemizedlist spacing="compact"> + <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: + </para> + </listitem> + </itemizedlist> + <programlisting> +nix-env -f "<nixpkgs>" -qaP -A haskellPackages +</programlisting> + <para> + Executable programs written in Haskell can be installed with: + </para> + <programlisting> +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. + </para> + <itemizedlist> + <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="https://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>. + </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>. + </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. + </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>). + </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 + <literal>services.locate.includeStore = true</literal>. + </para> + </listitem> + <listitem> + <para> + The Nix expression search path (<literal>NIX_PATH</literal>) no + longer contains <literal>/etc/nixos/nixpkgs</literal> by + default. You can override <literal>NIX_PATH</literal> by setting + <literal>nix.nixPath</literal>. + </para> + </listitem> + <listitem> + <para> + 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 <literal>pkgs</literal> 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 + <literal>--show-trace</literal> command line argument and read + the line just above the error message. + </para> + <programlisting> +$ nixos-rebuild build --show-trace +… +while evaluating the module argument `pkgs' in "/etc/nixos/my-module.nix": +infinite recursion encountered +</programlisting> + <para> + Any use of <literal>pkgs.lib</literal>, should be replaced by + <literal>lib</literal>, after adding it as argument of the + module. The following module + </para> + <programlisting language="bash"> +{ config, pkgs, ... }: + +with pkgs.lib; + +{ + options = { + foo = mkOption { … }; + }; + config = mkIf config.foo { … }; +} +</programlisting> + <para> + should be modified to look like: + </para> + <programlisting language="bash"> +{ config, pkgs, lib, ... }: + +with lib; + +{ + options = { + foo = mkOption { option declaration }; + }; + config = mkIf config.foo { option definition }; +} +</programlisting> + <para> + When <literal>pkgs</literal> 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 + </para> + <programlisting language="bash"> +{ config, pkgs, ... }: + +let + myProject = pkgs.fetchurl { + src = url; + sha256 = hash; + }; +in + +{ + imports = [ "${myProject}/module.nix" ]; +} +</programlisting> + <para> + should be modified to look like: + </para> + <programlisting language="bash"> +{ config, pkgs, ... }: + +let + myProject = (import <nixpkgs> {}).fetchurl { + src = url; + sha256 = hash; + }; +in + +{ + imports = [ "${myProject}/module.nix" ]; +} +</programlisting> + </listitem> + </itemizedlist> + <para> + Other notable improvements: + </para> + <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. + </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 + <literal>services.openssh.moduliFile</literal> 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. + </para> + </listitem> + <listitem> + <para> + <literal>buildEnv.env</literal> on all Python interpreters is + now available for nix-shell interoperability. + </para> + </listitem> + </itemizedlist> +</section> diff --git a/nixos/doc/manual/from_md/release-notes/rl-1603.section.xml b/nixos/doc/manual/from_md/release-notes/rl-1603.section.xml new file mode 100644 index 00000000000..172b800b599 --- /dev/null +++ b/nixos/doc/manual/from_md/release-notes/rl-1603.section.xml @@ -0,0 +1,695 @@ +<section xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="sec-release-16.03"> + <title>Release 16.03 (<quote>Emu</quote>, 2016/03/31)</title> + <para> + 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. + </para> + </listitem> + <listitem> + <para> + Linux 4.4 (was 3.18). + </para> + </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. + </para> + </listitem> + <listitem> + <para> + Glibc 2.23 (was 2.21). + </para> + </listitem> + <listitem> + <para> + Binutils 2.26 (was 2.23.1). See #909 + </para> + </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 + <literal>SOURCE_DATE_EPOCH</literal> to a deterministic value, + and Nix has + <link xlink:href="https://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> + <para> + Perl 5.22. + </para> + </listitem> + </itemizedlist> + <para> + The following new services were added since the last release: + </para> + <itemizedlist> + <listitem> + <para> + <literal>services/monitoring/longview.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>hardware/video/webcam/facetimehd.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>i18n/input-method/default.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>i18n/input-method/fcitx.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>i18n/input-method/ibus.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>i18n/input-method/nabi.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>i18n/input-method/uim.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>programs/fish.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>security/acme.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>security/audit.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>security/oath.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>services/hardware/irqbalance.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>services/mail/dspam.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>services/mail/opendkim.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>services/mail/postsrsd.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>services/mail/rspamd.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>services/mail/rmilter.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>services/misc/autofs.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>services/misc/bepasty.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>services/misc/calibre-server.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>services/misc/cfdyndns.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>services/misc/gammu-smsd.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>services/misc/mathics.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>services/misc/matrix-synapse.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>services/misc/octoprint.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>services/monitoring/hdaps.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>services/monitoring/heapster.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>services/monitoring/longview.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>services/network-filesystems/netatalk.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>services/network-filesystems/xtreemfs.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>services/networking/autossh.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>services/networking/dnschain.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>services/networking/gale.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>services/networking/miniupnpd.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>services/networking/namecoind.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>services/networking/ostinato.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>services/networking/pdnsd.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>services/networking/shairport-sync.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>services/networking/supplicant.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>services/search/kibana.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>services/security/haka.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>services/security/physlock.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>services/web-apps/pump.io.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>services/x11/hardware/libinput.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>services/x11/window-managers/windowlab.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>system/boot/initrd-network.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>system/boot/initrd-ssh.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>system/boot/loader/loader.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>system/boot/networkd.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>system/boot/resolved.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>virtualisation/lxd.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>virtualisation/rkt.nix</literal> + </para> + </listitem> + </itemizedlist> + <para> + 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. + </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 + <literal>nix-env -u</literal> 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> + <literal>wmiiSnap</literal> has been replaced with + <literal>wmii_hg</literal>, but + <literal>services.xserver.windowManager.wmii.enable</literal> + has been updated respectively so this only affects you if you + have explicitly installed <literal>wmiiSnap</literal>. + </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> + </para> + </listitem> + <listitem> + <para> + <literal>wmiimenu</literal> is removed, as it has been removed + by the developers upstream. Use <literal>wimenu</literal> from + the <literal>wmii-hg</literal> 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. + </para> + <programlisting language="bash"> +{ + imports = [ <nixpkgs/nixos/modules/services/misc/gitit.nix> ]; +} +</programlisting> + <para> + will include the Gitit service configuration options. + </para> + </listitem> + <listitem> + <para> + <literal>nginx</literal> 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: + </para> + <programlisting language="bash"> +nginx.override { + modules = [ nginxModules.rtmp nginxModules.dav nginxModules.moreheaders ]; +} +</programlisting> + </listitem> + <listitem> + <para> + <literal>s3sync</literal> 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 + <literal>tarsnap</literal> and others. + </para> + </listitem> + <listitem> + <para> + <literal>ruby_1_8</literal> 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. + </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. + </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 + <literal>services.xserver.enableCtrlAltBackspace</literal> + 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. + </para> + </listitem> + <listitem> + <para> + Data directory for Postfix MTA server is moved from + <literal>/var/postfix</literal> to + <literal>/var/lib/postfix</literal>. 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: + </para> + <programlisting language="bash"> +{ + fileSystems."/example" = { + device = "/dev/sdc"; + fsType = "btrfs"; + options = [ "noatime" "compress=lzo" "space_cache" "autodefrag" ]; + }; +} +</programlisting> + </listitem> + <listitem> + <para> + CUPS, installed by <literal>services.printing</literal> module, + now has its data directory in <literal>/var/lib/cups</literal>. + Old configurations from <literal>/etc/cups</literal> 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. + </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. + </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: + </para> + <programlisting language="bash"> +{ + i18n.inputMethod.enabled = "ibus"; + i18n.inputMethod.ibus.engines = with pkgs.ibus-engines; [ anthy mozc ]; +} +</programlisting> + <para> + That is equivalent to the old version: + </para> + <programlisting language="bash"> +{ + programs.ibus.enable = true; + programs.ibus.plugins = with pkgs; [ ibus-anthy mozc ]; +} +</programlisting> + </listitem> + <listitem> + <para> + <literal>services.udev.extraRules</literal> option now writes + rules to <literal>99-local.rules</literal> instead of + <literal>10-local.rules</literal>. 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. + </para> + </listitem> + <listitem> + <para> + The option + <literal>services.nsd.zones.<name>.data</literal> 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. +$TTL 1800 +@ IN SOA ns1.vpn.nbp.name. admin.example.com. ( +</programlisting> + <para> + Should modified to look like the actual file expected by nsd: + </para> + <programlisting> +$ORIGIN example.com. +$TTL 1800 +@ IN SOA ns1.vpn.nbp.name. admin.example.com. ( +</programlisting> + </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: + </para> + <programlisting language="bash"> +{ + services.syncthing = { + enable = true; + dataDir = "/home/somebody/.syncthing"; + user = "somebody"; + }; +} +</programlisting> + </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 + <literal>/proc/sys/net/ipv4/icmp_ratelimit</literal> and + <literal>/proc/sys/net/ipv6/icmp/ratelimit</literal> 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 + </para> + <programlisting> +error: path ‘/nix/store/*-broadcom-sta-*’ does not exist and cannot be created +</programlisting> + <para> + you should either re-run + <literal>nixos-generate-config</literal> or manually replace + <literal>"${config.boot.kernelPackages.broadcom_sta}"</literal> + by <literal>config.boot.kernelPackages.broadcom_sta</literal> in + your <literal>/etc/nixos/hardware-configuration.nix</literal>. + 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 <literal>~/.bashrc</literal> or some file + that’s sourced when your shell is started: + </para> + <programlisting> +GPG_TTY=$(tty) +export GPG_TTY +</programlisting> + <para> + If you want to use gpg-agent for SSH, too, add the following to + your session initialization (e.g. + <literal>displayManager.sessionCommands</literal>) + </para> + <programlisting> + gpg-connect-agent /bye + unset SSH_AGENT_PID + export SSH_AUTH_SOCK="''${HOME}/.gnupg/S.gpg-agent.ssh" +</programlisting> + <para> + and make sure that + </para> + <programlisting> + enable-ssh-support +</programlisting> + <para> + is included in your <literal>~/.gnupg/gpg-agent.conf</literal>. + You will need to use <literal>ssh-add</literal> 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: + </para> + <programlisting> + gpg --import ~/.gnupg/secring.gpg +</programlisting> + <para> + The <literal>gpg-agent(1)</literal> man page has more details + about this subject, i.e. in the "EXAMPLES" section. + </para> + </listitem> + </itemizedlist> + <para> + Other notable improvements: + </para> + <itemizedlist> + <listitem> + <para> + <literal>ejabberd</literal> module is brought back and now works + on NixOS. + </para> + </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. + </para> + </listitem> + </itemizedlist> +</section> diff --git a/nixos/doc/manual/from_md/release-notes/rl-1609.section.xml b/nixos/doc/manual/from_md/release-notes/rl-1609.section.xml new file mode 100644 index 00000000000..0fba40a0e78 --- /dev/null +++ b/nixos/doc/manual/from_md/release-notes/rl-1609.section.xml @@ -0,0 +1,273 @@ +<section xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="sec-release-16.09"> + <title>Release 16.09 (<quote>Flounder</quote>, 2016/09/30)</title> + <para> + 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. + </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. + </para> + </listitem> + <listitem> + <para> + Support for PXE netboot. See + <xref 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. + </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. + </para> + </listitem> + </itemizedlist> + <para> + The following new services were added since the last release: + </para> + <itemizedlist spacing="compact"> + <listitem> + <para> + <literal>(this will get automatically generated at release time)</literal> + </para> + </listitem> + </itemizedlist> + <para> + 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.) + </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>. + </para> + </listitem> + <listitem> + <para> + Shell aliases for systemd sub-commands + <link xlink:href="https://github.com/NixOS/nixpkgs/pull/15598">were + dropped</link>: <literal>start</literal>, + <literal>stop</literal>, <literal>restart</literal>, + <literal>status</literal>. + </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 + </para> + </listitem> + <listitem> + <para> + <literal>/var/empty</literal> is now immutable. Activation + script runs <literal>chattr +i</literal> 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 <literal>gitlab-runner</literal> + was removed and split up into the more clearer + <literal>gitlab-run</literal> and <literal>gitlab-rake</literal> + scripts, because <literal>gitlab-runner</literal> 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>. + </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>. + </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. + </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. + </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. + </para> + </listitem> + <listitem> + <para> + <literal>services.mongodb.extraConfig</literal> configuration + format was changed to YAML. + </para> + </listitem> + <listitem> + <para> + PHP has been upgraded to 7.0 + </para> + </listitem> + </itemizedlist> + <para> + Other notable improvements: + </para> + <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 + </para> + <programlisting language="bash"> +{ + security.grsecurity.enable = true; +} +</programlisting> + <para> + 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 + <literal>nixos-rebuild switch</literal> 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. + </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. + </para> + </listitem> + <listitem> + <para> + The directory container setuid wrapper programs, + <literal>/var/setuid-wrappers</literal>, + <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. + </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> + </para> + </listitem> + <listitem> + <para> + Gummi boot has been replaced using systemd-boot. + </para> + </listitem> + <listitem> + <para> + Hydra package and NixOS module were added for convenience. + </para> + </listitem> + </itemizedlist> +</section> diff --git a/nixos/doc/manual/from_md/release-notes/rl-1703.section.xml b/nixos/doc/manual/from_md/release-notes/rl-1703.section.xml new file mode 100644 index 00000000000..1119ec53dfc --- /dev/null +++ b/nixos/doc/manual/from_md/release-notes/rl-1703.section.xml @@ -0,0 +1,818 @@ +<section xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="sec-release-17.03"> + <title>Release 17.03 (<quote>Gorilla</quote>, 2017/03/31)</title> + <section xml:id="sec-release-17.03-highlights"> + <title>Highlights</title> + <para> + 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. + </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. + </para> + </listitem> + <listitem> + <para> + The default desktop environment now is KDE's Plasma 5. KDE 4 + has been removed + </para> + </listitem> + <listitem> + <para> + The setuid wrapper functionality now supports setting + capabilities. + </para> + </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. + </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. + </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> + </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. + </para> + </listitem> + <listitem> + <para> + PHP now defaults to PHP 7.1 + </para> + </listitem> + </itemizedlist> + </section> + <section xml:id="sec-release-17.03-new-services"> + <title>New Services</title> + <para> + The following new services were added since the last release: + </para> + <itemizedlist> + <listitem> + <para> + <literal>hardware/ckb.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>hardware/mcelog.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>hardware/usb-wwan.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>hardware/video/capture/mwprocapture.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>programs/adb.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>programs/chromium.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>programs/gphoto2.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>programs/java.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>programs/mtr.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>programs/oblogout.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>programs/vim.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>programs/wireshark.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>security/dhparams.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>services/audio/ympd.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>services/computing/boinc/client.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>services/continuous-integration/buildbot/master.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>services/continuous-integration/buildbot/worker.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>services/continuous-integration/gitlab-runner.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>services/databases/riak-cs.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>services/databases/stanchion.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>services/desktops/gnome3/gnome-terminal-server.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>services/editors/infinoted.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>services/hardware/illum.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>services/hardware/trezord.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>services/logging/journalbeat.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>services/mail/offlineimap.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>services/mail/postgrey.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>services/misc/couchpotato.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>services/misc/docker-registry.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>services/misc/errbot.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>services/misc/geoip-updater.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>services/misc/gogs.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>services/misc/leaps.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>services/misc/nix-optimise.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>services/misc/ssm-agent.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>services/misc/sssd.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>services/monitoring/arbtt.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>services/monitoring/netdata.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>services/monitoring/prometheus/default.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>services/monitoring/prometheus/alertmanager.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>services/monitoring/prometheus/blackbox-exporter.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>services/monitoring/prometheus/json-exporter.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>services/monitoring/prometheus/nginx-exporter.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>services/monitoring/prometheus/node-exporter.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>services/monitoring/prometheus/snmp-exporter.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>services/monitoring/prometheus/unifi-exporter.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>services/monitoring/prometheus/varnish-exporter.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>services/monitoring/sysstat.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>services/monitoring/telegraf.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>services/monitoring/vnstat.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>services/network-filesystems/cachefilesd.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>services/network-filesystems/glusterfs.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>services/network-filesystems/ipfs.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>services/networking/dante.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>services/networking/dnscrypt-wrapper.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>services/networking/fakeroute.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>services/networking/flannel.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>services/networking/htpdate.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>services/networking/miredo.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>services/networking/nftables.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>services/networking/powerdns.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>services/networking/pdns-recursor.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>services/networking/quagga.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>services/networking/redsocks.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>services/networking/wireguard.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>services/system/cgmanager.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>services/torrent/opentracker.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>services/web-apps/atlassian/confluence.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>services/web-apps/atlassian/crowd.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>services/web-apps/atlassian/jira.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>services/web-apps/frab.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>services/web-apps/nixbot.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>services/web-apps/selfoss.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>services/web-apps/quassel-webserver.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>services/x11/unclutter-xfixes.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>services/x11/urxvtd.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>system/boot/systemd-nspawn.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>virtualisation/ecs-agent.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>virtualisation/lxcfs.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>virtualisation/openstack/keystone.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>virtualisation/openstack/glance.nix</literal> + </para> + </listitem> + </itemizedlist> + </section> + <section xml:id="sec-release-17.03-incompatibilities"> + <title>Backward Incompatibilities</title> + <para> + 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. + </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. + </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. + </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>. + </para> + </listitem> + <listitem> + <para> + 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>. + </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. + </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> + </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. + </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>. + </para> + </listitem> + <listitem> + <para> + <literal>service.nylon</literal> is now declared using named + instances. As an example: + </para> + <programlisting language="bash"> +{ + services.nylon = { + enable = true; + acceptInterface = "br0"; + bindInterface = "tun1"; + port = 5912; + }; +} +</programlisting> + <para> + should be replaced with: + </para> + <programlisting language="bash"> +{ + services.nylon.myvpn = { + enable = true; + acceptInterface = "br0"; + bindInterface = "tun1"; + port = 5912; + }; +} +</programlisting> + <para> + this enables you to declare a SOCKS proxy for each uplink. + </para> + </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: + </para> + <programlisting language="bash"> +let + pkgs = import <nixpkgs> {}; +in + pkgs.overridePackages (self: super: ...) +</programlisting> + <para> + should be replaced by: + </para> + <programlisting language="bash"> +let + pkgs = import <nixpkgs> {}; +in + import pkgs.path { overlays = [(self: super: ...)]; } +</programlisting> + </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. + </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>. + </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>). + </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. + </para> + </listitem> + <listitem> + <para> + 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 <literal>extraArgs</literal> option. Where + possible, legacy option declarations are mapped to + <literal>extraArgs</literal> but will emit warnings. The + <literal>resolverList</literal> has been outright removed: to + use an unlisted resolver, use the + <literal>customResolver</literal> option. + </para> + </listitem> + <listitem> + <para> + torbrowser now stores local state under + <literal>~/.local/share/tor-browser</literal> by default. Any + browser profile data from the old location, + <literal>~/.torbrowser4</literal>, must be migrated manually. + </para> + </listitem> + <listitem> + <para> + The ihaskell, monetdb, offlineimap and sitecopy services have + been removed. + </para> + </listitem> + </itemizedlist> + </section> + <section xml:id="sec-release-17.03-notable-changes"> + <title>Other Notable Changes</title> + <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. + </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>. + </para> + </listitem> + <listitem> + <para> + Python 2.6 interpreter and package set have been removed. + </para> + </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. + </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. + </para> + </listitem> + <listitem> + <para> + 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. + </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>. + </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. + </para> + </listitem> + <listitem> + <para> + Containers using bridged networking no longer lose their + connection after changes to the host networking. + </para> + </listitem> + <listitem> + <para> + ZFS supports pool auto scrubbing. + </para> + </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. + </para> + </listitem> + <listitem> + <para> + Per-user configuration was moved from + <literal>~/.nixpkgs</literal> to + <literal>~/.config/nixpkgs</literal>. The former is still + valid for <literal>config.nix</literal> for backwards + compatibility. + </para> + </listitem> + </itemizedlist> + </section> +</section> diff --git a/nixos/doc/manual/from_md/release-notes/rl-1709.section.xml b/nixos/doc/manual/from_md/release-notes/rl-1709.section.xml new file mode 100644 index 00000000000..8f0efe816e5 --- /dev/null +++ b/nixos/doc/manual/from_md/release-notes/rl-1709.section.xml @@ -0,0 +1,922 @@ +<section xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="sec-release-17.09"> + <title>Release 17.09 (<quote>Hummingbird</quote>, 2017/09/??)</title> + <section xml:id="sec-release-17.09-highlights"> + <title>Highlights</title> + <para> + 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. + </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. + </para> + </listitem> + <listitem> + <para> + The module option + <literal>services.xserver.xrandrHeads</literal> 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: + </para> + <programlisting language="bash"> +{ services.xserver.xrandrHeads = [ + "HDMI-0" + { + output = "DVI-0"; + primary = true; + monitorConfig = '' + Option "Rotate" "right" + ''; + } + ]; +} +</programlisting> + <para> + 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. + </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. + </para> + <para> + 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. + </para> + </listitem> + </itemizedlist> + </section> + <section xml:id="sec-release-17.09-new-services"> + <title>New Services</title> + <para> + The following new services were added since the last release: + </para> + <itemizedlist> + <listitem> + <para> + <literal>config/fonts/fontconfig-penultimate.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>config/fonts/fontconfig-ultimate.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>config/terminfo.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>hardware/sensor/iio.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>hardware/nitrokey.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>hardware/raid/hpsa.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>programs/browserpass.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>programs/gnupg.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>programs/qt5ct.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>programs/slock.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>programs/thefuck.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>security/auditd.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>security/lock-kernel-modules.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>service-managers/docker.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>service-managers/trivial.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>services/admin/salt/master.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>services/admin/salt/minion.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>services/audio/slimserver.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>services/cluster/kubernetes/default.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>services/cluster/kubernetes/dns.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>services/cluster/kubernetes/dashboard.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>services/continuous-integration/hail.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>services/databases/clickhouse.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>services/databases/postage.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>services/desktops/gnome3/gnome-disks.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>services/desktops/gnome3/gpaste.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>services/logging/SystemdJournal2Gelf.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>services/logging/heartbeat.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>services/logging/journalwatch.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>services/logging/syslogd.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>services/mail/mailhog.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>services/mail/nullmailer.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>services/misc/airsonic.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>services/misc/autorandr.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>services/misc/exhibitor.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>services/misc/fstrim.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>services/misc/gollum.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>services/misc/irkerd.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>services/misc/jackett.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>services/misc/radarr.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>services/misc/snapper.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>services/monitoring/osquery.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>services/monitoring/prometheus/collectd-exporter.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>services/monitoring/prometheus/fritzbox-exporter.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>services/network-filesystems/kbfs.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>services/networking/dnscache.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>services/networking/fireqos.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>services/networking/iwd.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>services/networking/keepalived/default.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>services/networking/keybase.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>services/networking/lldpd.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>services/networking/matterbridge.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>services/networking/squid.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>services/networking/tinydns.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>services/networking/xrdp.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>services/security/shibboleth-sp.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>services/security/sks.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>services/security/sshguard.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>services/security/torify.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>services/security/usbguard.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>services/security/vault.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>services/system/earlyoom.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>services/system/saslauthd.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>services/web-apps/nexus.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>services/web-apps/pgpkeyserver-lite.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>services/web-apps/piwik.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>services/web-servers/lighttpd/collectd.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>services/web-servers/minio.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>services/x11/display-managers/xpra.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>services/x11/xautolock.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>tasks/filesystems/bcachefs.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>tasks/powertop.nix</literal> + </para> + </listitem> + </itemizedlist> + </section> + <section xml:id="sec-release-17.09-incompatibilities"> + <title>Backward Incompatibilities</title> + <para> + 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> + </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. + </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. + </para> + <para> + Before rebooting affected machines, please ensure: + </para> + <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. + </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>. + </para> + </listitem> + </itemizedlist> + </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. + </para> + <itemizedlist> + <listitem> + <para> + 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. + </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. + </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>. + </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 <literal>radicale.nix</literal> + 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. + </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. + </para> + </listitem> + <listitem> + <para> + 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. + </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 + </para> + <programlisting> +dataDir=<valueOfDataDir> +mv /var/lib/ipfs/.ipfs/* $dataDir +rmdir /var/lib/ipfs/.ipfs +</programlisting> + </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>. + </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. + </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. + </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. + </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. + </para> + </listitem> + <listitem> + <para> + <literal>cc-wrapper</literal>'s setup-hook now exports a + number of environment variables corresponding to binutils + binaries, (e.g. <literal>LD</literal>, + <literal>STRIP</literal>, <literal>RANLIB</literal>, 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. + </para> + </listitem> + <listitem> + <para> + 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>. + </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. + </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. + </para> + <para> + 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. + </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: + </para> + <programlisting language="SQL"> +CREATE USER 'root'@'%' IDENTIFIED BY ''; +GRANT ALL PRIVILEGES ON *.* TO 'root'@'%' WITH GRANT OPTION; +FLUSH PRIVILEGES; + +-- Optionally, delete the password-authenticated user: +-- DROP USER 'root'@'localhost'; +</programlisting> + </listitem> + <listitem> + <para> + <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. + </para> + <para> + 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 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. + </para> + <para> + You can check that backups still work by running + <literal>systemctl start mysql-backup</literal> then + <literal>systemctl status mysql-backup</literal>. + </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. + </para> + </listitem> + <listitem> + <para> + 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. + </para> + </listitem> + </itemizedlist> + </section> + <section xml:id="sec-release-17.09-notable-changes"> + <title>Other Notable Changes</title> + <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. + </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. + </para> + </listitem> + <listitem> + <para> + ZFS/SPL have been updated to 0.7.0, + <literal>zfsUnstable, splUnstable</literal> have therefore + been removed. + </para> + </listitem> + <listitem> + <para> + The <literal>time.timeZone</literal> option now allows the + value <literal>null</literal> in addition to timezone strings. + This value allows changing the timezone of a system + imperatively using + <literal>timedatectl set-timezone</literal>. 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 + <literal>~/.config/nixpkgs/overlays.nix</literal> can be used + instead of the <literal>~/.config/nixpkgs/overlays</literal> + directory. + </para> + <para> + See the overlays chapter of the Nixpkgs manual for more + details. + </para> + </listitem> + <listitem> + <para> + Definitions for <literal>/etc/hosts</literal> 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. + </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. + </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. + </para> + </listitem> + <listitem> + <para> + <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. + </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. + </para> + </listitem> + <listitem> + <para> + 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. + </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 + <literal>services.dnscrypt-proxy.resolverName</literal> option + or setting it to <literal>"random"</literal>. + </para> + </listitem> + </itemizedlist> + </section> +</section> diff --git a/nixos/doc/manual/from_md/release-notes/rl-1803.section.xml b/nixos/doc/manual/from_md/release-notes/rl-1803.section.xml new file mode 100644 index 00000000000..f54f6129e0d --- /dev/null +++ b/nixos/doc/manual/from_md/release-notes/rl-1803.section.xml @@ -0,0 +1,871 @@ +<section xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="sec-release-18.03"> + <title>Release 18.03 (<quote>Impala</quote>, 2018/04/04)</title> + <section xml:id="sec-release-18.03-highlights"> + <title>Highlights</title> + <para> + In addition to numerous new and upgraded packages, this release + has the following highlights: + </para> + <itemizedlist> + <listitem> + <para> + End of support is planned for end of October 2018, handing + over to 18.09. + </para> + </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. + </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>. + </para> + </listitem> + <listitem> + <para> + 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. + </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: + </para> + <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. + </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> + </para> + </listitem> + </itemizedlist> + </listitem> + <listitem> + <para> + PHP now defaults to PHP 7.2, updated from 7.1. + </para> + </listitem> + </itemizedlist> + </section> + <section xml:id="sec-release-18.03-new-services"> + <title>New Services</title> + <para> + The following new services were added since the last release: + </para> + <itemizedlist> + <listitem> + <para> + <literal>./config/krb5/default.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>./hardware/digitalbitbox.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>./misc/label.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>./programs/ccache.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>./programs/criu.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>./programs/digitalbitbox/default.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>./programs/less.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>./programs/npm.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>./programs/plotinus.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>./programs/rootston.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>./programs/systemtap.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>./programs/sway.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>./programs/udevil.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>./programs/way-cooler.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>./programs/yabar.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>./programs/zsh/zsh-autoenv.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>./services/backup/borgbackup.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>./services/backup/crashplan-small-business.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>./services/desktops/dleyna-renderer.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>./services/desktops/dleyna-server.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>./services/desktops/pipewire.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>./services/desktops/gnome3/chrome-gnome-shell.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>./services/desktops/gnome3/tracker-miners.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>./services/hardware/fwupd.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>./services/hardware/interception-tools.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>./services/hardware/u2f.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>./services/hardware/usbmuxd.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>./services/mail/clamsmtp.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>./services/mail/dkimproxy-out.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>./services/mail/pfix-srsd.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>./services/misc/gitea.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>./services/misc/home-assistant.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>./services/misc/ihaskell.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>./services/misc/logkeys.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>./services/misc/novacomd.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>./services/misc/osrm.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>./services/misc/plexpy.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>./services/misc/pykms.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>./services/misc/tzupdate.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>./services/monitoring/fusion-inventory.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>./services/monitoring/prometheus/exporters.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>./services/network-filesystems/beegfs.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>./services/network-filesystems/davfs2.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>./services/network-filesystems/openafs/client.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>./services/network-filesystems/openafs/server.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>./services/network-filesystems/ceph.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>./services/networking/aria2.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>./services/networking/monero.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>./services/networking/nghttpx/default.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>./services/networking/nixops-dns.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>./services/networking/rxe.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>./services/networking/stunnel.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>./services/web-apps/matomo.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>./services/web-apps/restya-board.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>./services/web-servers/mighttpd2.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>./services/x11/fractalart.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>./system/boot/binfmt.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>./system/boot/grow-partition.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>./tasks/filesystems/ecryptfs.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>./virtualisation/hyperv-guest.nix</literal> + </para> + </listitem> + </itemizedlist> + </section> + <section xml:id="sec-release-18.03-incompatibilities"> + <title>Backward Incompatibilities</title> + <para> + When upgrading from a previous release, please be aware of the + following incompatible changes: + </para> + <itemizedlist> + <listitem> + <para> + <literal>sound.enable</literal> now defaults to false. + </para> + </listitem> + <listitem> + <para> + Dollar signs in options under + <literal>services.postfix</literal> 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 + <literal>services.postage</literal> options to + <literal>services.pgmanage</literal>. + </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: + </para> + <itemizedlist> + <listitem> + <para> + <literal>2048-in-terminal</literal> → + <literal>_2048-in-terminal</literal> + </para> + </listitem> + <listitem> + <para> + <literal>90secondportraits</literal> → + <literal>_90secondportraits</literal> + </para> + </listitem> + <listitem> + <para> + <literal>2bwm</literal> → <literal>_2bwm</literal> + </para> + </listitem> + <listitem> + <para> + <literal>389-ds-base</literal> → + <literal>_389-ds-base</literal> + </para> + </listitem> + </itemizedlist> + </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> + </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 <literal>services.openssh.extraConfig</literal>. + </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>. + </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. + </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 <literal>nix-support</literal> are now + split between the two wrappers. Some commonly used ones, like + <literal>nix-support/dynamic-linker</literal>, 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 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 + <literal>propagatedNativeBuildInputs</literal> should instead + be <literal>propagatedBuildInputs</literal>. Thankfully, that + was and is the least used type of dependency. Also, it means + that some <literal>propagatedBuildInputs</literal> should + instead be <literal>depsTargetTargetPropagated</literal>. + 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. + </para> + </listitem> + <listitem> + <para> + The <literal>memcached</literal> service no longer accept + dynamic socket paths via + <literal>services.memcached.socket</literal>. Unix sockets can + be still enabled by + <literal>services.memcached.enableUnixSocket</literal> and + will be accessible at + <literal>/run/memcached/memcached.sock</literal>. + </para> + </listitem> + <listitem> + <para> + The <literal>hardware.amdHybridGraphics.disable</literal> + 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 + <literal>services.postfix.config</literal> was buggy. + Previously, if other options in the Postfix module like + <literal>services.postfix.useSrs</literal> 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. + </para> + <itemizedlist spacing="compact"> + <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>. + </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. + </para> + </listitem> + <listitem> + <para> + When using <literal>services.xserver.libinput</literal> + (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>. + </para> + </listitem> + <listitem> + <para> + The Piwik analytics software was renamed to Matomo: + </para> + <itemizedlist> + <listitem> + <para> + 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>. + </para> + </listitem> + <listitem> + <para> + The data directory <literal>/var/lib/piwik</literal> was + renamed to <literal>/var/lib/matomo</literal>. All files + will be moved automatically on first startup, but you + might need to adjust your backup scripts. + </para> + </listitem> + <listitem> + <para> + The default <literal>serverName</literal> for the nginx + configuration changed from + <literal>piwik.${config.networking.hostName}</literal> to + <literal>matomo.${config.networking.hostName}.${config.networking.domain}</literal> + if <literal>config.networking.domain</literal> is set, + <literal>matomo.${config.networking.hostName}</literal> if + it is not set. If you change your + <literal>serverName</literal>, remember you'll need to + update the <literal>trustedHosts[]</literal> array in + <literal>/var/lib/matomo/config/config.ini.php</literal> + 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 + <literal>/var/lib/matomo/config/config.ini.php</literal>. + </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. + </para> + </listitem> + </itemizedlist> + </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. + </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>. + </para> + </listitem> + <listitem> + <para> + The Prosody XMPP server has received a major update. The + following modules were renamed: + </para> + <itemizedlist> + <listitem> + <para> + <literal>services.prosody.modules.httpserver</literal> is + now <literal>services.prosody.modules.http_files</literal> + </para> + </listitem> + <listitem> + <para> + <literal>services.prosody.modules.console</literal> is now + <literal>services.prosody.modules.admin_telnet</literal> + </para> + </listitem> + </itemizedlist> + <para> + Many new modules are now core modules, most notably + <literal>services.prosody.modules.carbons</literal> and + <literal>services.prosody.modules.mam</literal>. + </para> + <para> + The better-performing <literal>libevent</literal> backend is + now enabled by default. + </para> + <para> + <literal>withCommunityModules</literal> now passes through the + modules to <literal>services.prosody.extraModules</literal>. + 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>. + </para> + </listitem> + </itemizedlist> + </section> + <section xml:id="sec-release-18.03-notable-changes"> + <title>Other Notable Changes</title> + <itemizedlist> + <listitem> + <para> + ZNC option <literal>services.znc.mutable</literal> 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 + <literal>networking.wireless.networks.<name>.auth</literal> + has been added for wireless networks with WPA-Enterprise + authentication. There is also a new + <literal>extraConfig</literal> option to directly configure + <literal>wpa_supplicant</literal> and + <literal>hidden</literal> to connect to hidden networks. + </para> + </listitem> + <listitem> + <para> + In the module + <literal>networking.interfaces.<name></literal> the + following options have been removed: + </para> + <itemizedlist> + <listitem> + <para> + <literal>ipAddress</literal> + </para> + </listitem> + <listitem> + <para> + <literal>ipv6Address</literal> + </para> + </listitem> + <listitem> + <para> + <literal>prefixLength</literal> + </para> + </listitem> + <listitem> + <para> + <literal>ipv6PrefixLength</literal> + </para> + </listitem> + <listitem> + <para> + <literal>subnetMask</literal> + </para> + </listitem> + </itemizedlist> + <para> + To assign static addresses to an interface the options + <literal>ipv4.addresses</literal> and + <literal>ipv6.addresses</literal> should be used instead. The + options <literal>ip4</literal> and <literal>ip6</literal> have + been renamed to <literal>ipv4.addresses</literal> + <literal>ipv6.addresses</literal> respectively. The new + options <literal>ipv4.routes</literal> and + <literal>ipv6.routes</literal> have been added to set up + static routing. + </para> + </listitem> + <listitem> + <para> + The option <literal>services.logstash.listenAddress</literal> + 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. + </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. + </para> + <para> + If set to null the default clock format is used. + </para> + </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. + </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. + </para> + <para> + If set to <literal>null</literal> the default indicators are + used. + </para> + <para> + In order to have the previous default configuration add + </para> + <programlisting language="bash"> +{ + services.xserver.displayManager.lightdm.greeters.gtk.indicators = [ + "~host" "~spacer" + "~clock" "~spacer" + "~session" + "~language" + "~a11y" + "~power" + ]; +} +</programlisting> + <para> + to your <literal>configuration.nix</literal>. + </para> + </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. + </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. + </para> + </listitem> + </itemizedlist> + </section> +</section> diff --git a/nixos/doc/manual/from_md/release-notes/rl-1809.section.xml b/nixos/doc/manual/from_md/release-notes/rl-1809.section.xml new file mode 100644 index 00000000000..aa4637a99b6 --- /dev/null +++ b/nixos/doc/manual/from_md/release-notes/rl-1809.section.xml @@ -0,0 +1,941 @@ +<section xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="sec-release-18.09"> + <title>Release 18.09 (<quote>Jellyfish</quote>, 2018/10/05)</title> + <section xml:id="sec-release-18.09-highlights"> + <title>Highlights</title> + <para> + In addition to numerous new and upgraded packages, this release + has the following notable updates: + </para> + <itemizedlist> + <listitem> + <para> + End of support is planned for end of April 2019, handing over + to 19.03. + </para> + </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. + </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>. + </para> + </listitem> + <listitem> + <para> + 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. + </para> + </listitem> + </itemizedlist> + <para> + Notable changes and additions for 18.09 include: + </para> + <itemizedlist> + <listitem> + <para> + Support for wrapping binaries using + <literal>firejail</literal> has been added through + <literal>programs.firejail.wrappedBinaries</literal>. + </para> + <para> + For example + </para> + <programlisting language="bash"> +{ + programs.firejail = { + enable = true; + wrappedBinaries = { + firefox = "${lib.getBin pkgs.firefox}/bin/firefox"; + mpv = "${lib.getBin pkgs.mpv}/bin/mpv"; + }; + }; +} +</programlisting> + <para> + 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 <literal>nix-channel</literal> defined channels in + <literal>nix-build</literal> and <literal>nix-shell</literal> + commands, as well as in imports like + <literal>import <mychannel></literal>. + </para> + <para> + For example + </para> + <programlisting> +$ nix-channel --add https://nixos.org/channels/nixpkgs-unstable nixpkgsunstable +$ nix-channel --update +$ nix-build '<nixpkgsunstable>' -A gitFull +$ nix run -f '<nixpkgsunstable>' gitFull +$ nix-instantiate -E '(import <nixpkgsunstable> {}).gitFull' +</programlisting> + </listitem> + </itemizedlist> + </section> + <section xml:id="sec-release-18.09-new-services"> + <title>New Services</title> + <para> + A curated selection of new services that were added since the last + release: + </para> + <itemizedlist> + <listitem> + <para> + The <literal>services.cassandra</literal> 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 <literal>services.foundationdb</literal> 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., + <literal>rt_tables</literal>) in + <literal>/etc/iproute2</literal>. This allows to write aliases + for routing tables for instance. + </para> + </listitem> + <listitem> + <para> + <literal>services.strongswan-swanctl</literal> is a modern + replacement for <literal>services.strongswan</literal>. You + can use either one of them to setup IPsec VPNs but not both at + the same time. + </para> + <para> + <literal>services.strongswan-swanctl</literal> 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 + <literal>services.strongswan</literal> 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 <literal>services.elasticsearch-curator</literal> + service periodically curates or manages, your Elasticsearch + indices and snapshots. + </para> + </listitem> + </itemizedlist> + <para> + Every new services: + </para> + <itemizedlist> + <listitem> + <para> + <literal>./config/xdg/autostart.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>./config/xdg/icons.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>./config/xdg/menus.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>./config/xdg/mime.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>./hardware/brightnessctl.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>./hardware/onlykey.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>./hardware/video/uvcvideo/default.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>./misc/documentation.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>./programs/firejail.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>./programs/iftop.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>./programs/sedutil.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>./programs/singularity.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>./programs/xss-lock.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>./programs/zsh/zsh-autosuggestions.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>./services/admin/oxidized.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>./services/backup/duplicati.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>./services/backup/restic.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>./services/backup/restic-rest-server.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>./services/cluster/hadoop/default.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>./services/databases/aerospike.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>./services/databases/monetdb.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>./services/desktops/bamf.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>./services/desktops/flatpak.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>./services/desktops/zeitgeist.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>./services/development/bloop.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>./services/development/jupyter/default.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>./services/hardware/lcd.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>./services/hardware/undervolt.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>./services/misc/clipmenu.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>./services/misc/gitweb.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>./services/misc/serviio.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>./services/misc/safeeyes.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>./services/misc/sysprof.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>./services/misc/weechat.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>./services/monitoring/datadog-agent.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>./services/monitoring/incron.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>./services/networking/dnsdist.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>./services/networking/freeradius.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>./services/networking/hans.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>./services/networking/morty.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>./services/networking/ndppd.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>./services/networking/ocserv.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>./services/networking/owamp.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>./services/networking/quagga.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>./services/networking/shadowsocks.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>./services/networking/stubby.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>./services/networking/zeronet.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>./services/security/certmgr.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>./services/security/cfssl.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>./services/security/oauth2_proxy_nginx.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>./services/web-apps/virtlyst.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>./services/web-apps/youtrack.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>./services/web-servers/hitch/default.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>./services/web-servers/hydron.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>./services/web-servers/meguca.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>./services/web-servers/nginx/gitweb.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>./virtualisation/kvmgt.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>./virtualisation/qemu-guest-agent.nix</literal> + </para> + </listitem> + </itemizedlist> + </section> + <section xml:id="sec-release-18.09-incompatibilities"> + <title>Backward Incompatibilities</title> + <para> + 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: + </para> + <itemizedlist> + <listitem> + <para> + 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 + </para> + </listitem> + <listitem> + <para> + 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 + </para> + </listitem> + <listitem> + <para> + cc-by-nd-30: Creative Commons Attribution-No Derivative + Works v3.00 + </para> + </listitem> + <listitem> + <para> + msrla: Microsoft Research License Agreement + </para> + </listitem> + </itemizedlist> + </listitem> + <listitem> + <para> + The deprecated <literal>services.cassandra</literal> module + has seen a complete rewrite. (See above.) + </para> + </listitem> + <listitem> + <para> + <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. + </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. + </para> + </listitem> + <listitem> + <para> + The <literal>services.docker-registry.extraConfig</literal> + 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 + <literal>docker/distribution</literal> 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>. + </para> + </listitem> + <listitem> + <para> + <literal>services.munge</literal> 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> + <literal>dockerTools.buildImage</literal> now uses + <literal>null</literal> as default value for + <literal>tag</literal>, which indicates that the nix output + hash will be used as tag. + </para> + </listitem> + <listitem> + <para> + The ELK stack: <literal>elasticsearch</literal>, + <literal>logstash</literal> and <literal>kibana</literal> 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 + <literal>elasticsearch5</literal>, + <literal>logstash5</literal> and <literal>kibana5</literal>. + </para> + <para> + The elastic beats: <literal>filebeat</literal>, + <literal>heartbeat</literal>, <literal>metricbeat</literal> + and <literal>packetbeat</literal> have had the same treatment: + they now target 6.3.* as well. The 5.* versions are available + under the names: <literal>filebeat5</literal>, + <literal>heartbeat5</literal>, <literal>metricbeat5</literal> + and <literal>packetbeat5</literal> + </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. + </para> + <para> + Fortunately there is also a free variant of the ELK stack + without X-Pack. The packages are available under the names: + <literal>elasticsearch-oss</literal>, + <literal>logstash-oss</literal> and + <literal>kibana-oss</literal>. + </para> + </listitem> + <listitem> + <para> + Options + <literal>boot.initrd.luks.devices.name.yubikey.ramfsMountPoint</literal> + <literal>boot.initrd.luks.devices.name.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. + </para> + </listitem> + <listitem> + <para> + Groups <literal>kvm</literal> and <literal>render</literal> + are introduced now, as systemd requires them. + </para> + </listitem> + </itemizedlist> + </section> + <section xml:id="sec-release-18.09-notable-changes"> + <title>Other Notable Changes</title> + <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. + </para> + </listitem> + <listitem> + <para> + <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. + </para> + </listitem> + <listitem> + <para> + <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. + </para> + </listitem> + <listitem> + <para> + <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>. + </para> + </listitem> + <listitem> + <para> + A NixOS system can now be constructed more easily based on a + preexisting invocation of Nixpkgs. For example: + </para> + <programlisting language="bash"> +{ + inherit (pkgs.nixos { + boot.loader.grub.enable = false; + fileSystems."/".device = "/dev/xvda1"; + }) toplevel kernel initialRamdisk manual; +} +</programlisting> + <para> + 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. + </para> + </listitem> + <listitem> + <para> + <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. + </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. + </para> + </listitem> + <listitem> + <para> + The module for <literal>security.dhparams</literal> has two + new options now: + </para> + <variablelist> + <varlistentry> + <term> + <literal>security.dhparams.stateless</literal> + </term> + <listitem> + <para> + Puts the generated Diffie-Hellman parameters into the + Nix store instead of managing them in a stateful manner + in <literal>/var/lib/dhparams</literal>. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term> + <literal>security.dhparams.defaultBitSize</literal> + </term> + <listitem> + <para> + 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.name.path</literal> + because it might be either in the Nix store or in a + directory configured by + <literal>security.dhparams.path</literal>. + </para> + </note> + <note> + <para> + <emphasis role="strong">For developers:</emphasis> + </para> + <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). + </para> + <para> + An example usage of this would be: + </para> + <programlisting language="bash"> +{ config, ... }: + +{ + security.dhparams.params.myservice = {}; + environment.etc."myservice.conf".text = '' + dhparams = ${config.security.dhparams.params.myservice.path} + ''; +} +</programlisting> + </note> + </listitem> + <listitem> + <para> + <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. + </para> + </listitem> + <listitem> + <para> + The option + <literal>services.kubernetes.apiserver.admissionControl</literal> + was renamed to + <literal>services.kubernetes.apiserver.enableAdmissionPlugins</literal>. + </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. + </para> + </listitem> + <listitem> + <para> + The option + <literal>services.kubernetes.apiserver.address</literal> was + renamed to + <literal>services.kubernetes.apiserver.bindAddress</literal>. + Note that the default value has changed from 127.0.0.1 to + 0.0.0.0. + </para> + </listitem> + <listitem> + <para> + The option + <literal>services.kubernetes.apiserver.publicAddress</literal> + was not used and thus has been removed. + </para> + </listitem> + <listitem> + <para> + The option + <literal>services.kubernetes.addons.dashboard.enableRBAC</literal> + was renamed to + <literal>services.kubernetes.addons.dashboard.rbac.enable</literal>. + </para> + </listitem> + <listitem> + <para> + The Kubernetes Dashboard now has only minimal RBAC permissions + by default. If dashboard cluster-admin rights are desired, set + <literal>services.kubernetes.addons.dashboard.rbac.clusterAdmin</literal> + 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 <literal>programs.screen</literal> 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 <literal>services.networking.hostapd</literal> now + uses WPA2 by default. + </para> + </listitem> + <listitem> + <para> + <literal>s6Dns</literal>, <literal>s6Networking</literal>, + <literal>s6LinuxUtils</literal> and + <literal>s6PortableUtils</literal> renamed to + <literal>s6-dns</literal>, <literal>s6-networking</literal>, + <literal>s6-linux-utils</literal> and + <literal>s6-portable-utils</literal> respectively. + </para> + </listitem> + <listitem> + <para> + The module option <literal>nix.useSandbox</literal> 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. + </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>. + </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 + <literal></para><para></literal> 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>. + </para> + </listitem> + </itemizedlist> + </section> +</section> diff --git a/nixos/doc/manual/from_md/release-notes/rl-1903.section.xml b/nixos/doc/manual/from_md/release-notes/rl-1903.section.xml new file mode 100644 index 00000000000..f26e68e1320 --- /dev/null +++ b/nixos/doc/manual/from_md/release-notes/rl-1903.section.xml @@ -0,0 +1,790 @@ +<section xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="sec-release-19.03"> + <title>Release 19.03 (<quote>Koi</quote>, 2019/04/11)</title> + <section xml:id="sec-release-19.03-highlights"> + <title>Highlights</title> + <para> + In addition to numerous new and upgraded packages, this release + has the following highlights: + </para> + <itemizedlist> + <listitem> + <para> + End of support is planned for end of October 2019, handing + over to 19.09. + </para> + </listitem> + <listitem> + <para> + 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 + <literal>services.xserver.desktopManager.pantheon.enable</literal>. + </para> + <note> + <para> + By default, + <literal>services.xserver.desktopManager.pantheon</literal> + enables LightDM as a display manager, as pantheon's screen + locking implementation relies on it. Because of that it is + recommended to leave LightDM enabled. If you'd like to + disable it anyway, set + <literal>services.xserver.displayManager.lightdm.enable</literal> + 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. + </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. + </para> + </listitem> + <listitem> + <para> + There is now a set of <literal>confinement</literal> options + for <literal>systemd.services</literal>, which allows to + restrict services into a chroot 2 ed environment that only + contains the store paths from the runtime closure of the + service. + </para> + </listitem> + </itemizedlist> + </section> + <section xml:id="sec-release-19.03-new-services"> + <title>New Services</title> + <para> + The following new services were added since the last release: + </para> + <itemizedlist> + <listitem> + <para> + <literal>./programs/nm-applet.nix</literal> + </para> + </listitem> + <listitem> + <para> + There is a new <literal>security.googleOsLogin</literal> + 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> + <para> + <literal>./services/misc/beanstalkd.nix</literal> + </para> + </listitem> + <listitem> + <para> + There is a new <literal>services.cockroachdb</literal> 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> + <listitem> + <para> + <literal>./security/duosec.nix</literal> + </para> + </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 <literal>security.duosec</literal> + options along with the corresponding PAM option in + <literal>security.pam.services.<name?>.duoSecurity.enable</literal>. + </para> + </listitem> + </itemizedlist> + </section> + <section xml:id="sec-release-19.03-incompatibilities"> + <title>Backward Incompatibilities</title> + <para> + When upgrading from a previous release, please be aware of the + following incompatible changes: + </para> + <itemizedlist> + <listitem> + <para> + The minimum version of Nix required to evaluate Nixpkgs is now + 2.0. + </para> + <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. + </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 + <literal>nixos-rebuild switch</literal> 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 + <literal>curl -L https://nixos.org/nix/install | sh</literal>, + or prior to doing a channel update, running + <literal>nix-env -iA nix</literal>. 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 + <literal>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</literal>. + </para> + </listitem> + </itemizedlist> + </listitem> + <listitem> + <para> + The <literal>buildPythonPackage</literal> function now sets + <literal>strictDeps = true</literal> 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 <literal>buildPythonPackage</literal> function now sets + <literal>LANG = C.UTF-8</literal> to enable Unicode support. + The <literal>glibcLocales</literal> package is no longer + needed as a build input. + </para> + </listitem> + <listitem> + <para> + The Syncthing state and configuration data has been moved from + <literal>services.syncthing.dataDir</literal> to the newly + defined <literal>services.syncthing.configDir</literal>, 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 + <literal>services.ntp.restrictDefault</literal> and + <literal>services.ntp.restrictSource</literal> to + <literal>[]</literal>. + </para> + </listitem> + <listitem> + <para> + Package <literal>rabbitmq_server</literal> is renamed to + <literal>rabbitmq-server</literal>. + </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>). + </para> + </listitem> + <listitem> + <para> + Buildbot now supports Python 3 and its packages have been + moved to <literal>pythonPackages</literal>. The options + <literal>services.buildbot-master.package</literal> and + <literal>services.buildbot-worker.package</literal> can be + used to select the Python 2 or 3 version of the package. + </para> + </listitem> + <listitem> + <para> + Options + <literal>services.znc.confOptions.networks.name.userName</literal> + and + <literal>services.znc.confOptions.networks.name.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> + </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>. + </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 <literal>man smtpd.conf</literal> for more + information on the new file format. + </para> + </listitem> + <listitem> + <para> + The versioned <literal>postgresql</literal> have been renamed + to use underscore number seperators. For example, + <literal>postgresql96</literal> has been renamed to + <literal>postgresql_9_6</literal>. + </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. + </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. + </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>. + </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. + </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. + </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>. + </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>). + </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. + </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. + </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. + </para> + <programlisting language="bash"> +{ + services.nscd.config = + '' + server-user nscd + threads 1 + paranoia no + debug-level 0 + + enable-cache passwd yes + positive-time-to-live passwd 600 + negative-time-to-live passwd 20 + suggested-size passwd 211 + check-files passwd yes + persistent passwd no + shared passwd yes + + enable-cache group yes + positive-time-to-live group 3600 + negative-time-to-live group 60 + suggested-size group 211 + check-files group yes + persistent group no + shared group yes + + enable-cache hosts yes + positive-time-to-live hosts 600 + negative-time-to-live hosts 5 + suggested-size hosts 211 + check-files hosts yes + persistent hosts no + shared hosts yes + ''; +} +</programlisting> + <para> + 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 + <literal>sudo -u git -H gitlab-rake gitlab:shell:setup</literal> + 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>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. + </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. + </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. + </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>) + </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. + </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. + </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. + </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. + </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> + </listitem> + </itemizedlist> + </section> + <section xml:id="sec-release-19.03-notable-changes"> + <title>Other Notable Changes</title> + <itemizedlist> + <listitem> + <para> + The <literal>services.matomo</literal> module gained the + option <literal>services.matomo.package</literal> 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>. + </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. + </para> + </listitem> + <listitem> + <para> + <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. + </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: + <literal>services.kubernetes.addons.dns.replicas</literal>. + </para> + </listitem> + <listitem> + <para> + 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. + </para> + </listitem> + <listitem> + <para> + 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. + </para> + </listitem> + <listitem> + <para> + 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. + </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>. + </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. + </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. + </para> + </note> + </listitem> + <listitem> + <para> + The + <link xlink:href="https://github.com/DanielAdolfsson/ndppd"><literal>ndppd</literal></link> + module now supports + <link xlink:href="options.html#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. + </para> + </listitem> + <listitem> + <para> + The + <link xlink:href="options.html#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: + <literal>services.kubernetes.apiserver.port</literal> and + <literal>services.kubernetes.controllerManager.port</literal> + has been renamed to <literal>.insecurePort</literal>, and + default of both options has changed to 0 (disabled). + </para> + </listitem> + <listitem> + <para> + Note that the default value of + <literal>services.kubernetes.apiserver.bindAddress</literal> + 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: + <literal>services.kubernetes.apiserver.insecurebindAddress</literal>. + </para> + </listitem> + <listitem> + <para> + The option + <literal>services.kubernetes.apiserver.allowPrivileged</literal> + and + <literal>services.kubernetes.kubelet.allowPrivileged</literal> + 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 <literal>environment.systemPackages</literal> + implicitly. + </para> + </listitem> + <listitem> + <para> + The <literal>intel</literal> driver has been removed from the + default list of + <link xlink:href="options.html#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>. + </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 + <link xlink:href="options.html#opt-services.nginx.sslProtocols">services.nginx.sslProtocols</link>. + </para> + </listitem> + <listitem> + <para> + A new subcommand <literal>nixos-rebuild edit</literal> was + added. + </para> + </listitem> + </itemizedlist> + </section> +</section> diff --git a/nixos/doc/manual/from_md/release-notes/rl-1909.section.xml b/nixos/doc/manual/from_md/release-notes/rl-1909.section.xml new file mode 100644 index 00000000000..83cd649f4ea --- /dev/null +++ b/nixos/doc/manual/from_md/release-notes/rl-1909.section.xml @@ -0,0 +1,1197 @@ +<section xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="sec-release-19.09"> + <title>Release 19.09 (<quote>Loris</quote>, 2019/10/09)</title> + <section xml:id="sec-release-19.09-highlights"> + <title>Highlights</title> + <para> + In addition to numerous new and upgraded packages, this release + has the following highlights: + </para> + <itemizedlist> + <listitem> + <para> + End of support is planned for end of April 2020, handing over + to 20.03. + </para> + </listitem> + <listitem> + <para> + Nix has been updated to 2.3; see its + <link xlink:href="https://nixos.org/nix/manual/#ssec-relnotes-2.3">release + notes</link>. + </para> + </listitem> + <listitem> + <para> + Core version changes: + </para> + <para> + systemd: 239 -> 243 + </para> + <para> + gcc: 7 -> 8 + </para> + <para> + glibc: 2.27 (unchanged) + </para> + <para> + linux: 4.19 LTS (unchanged) + </para> + <para> + openssl: 1.0 -> 1.1 + </para> + </listitem> + <listitem> + <para> + Desktop version changes: + </para> + <para> + plasma5: 5.14 -> 5.16 + </para> + <para> + gnome3: 3.30 -> 3.32 + </para> + </listitem> + <listitem> + <para> + PHP now defaults to PHP 7.3, updated from 7.2. + </para> + </listitem> + <listitem> + <para> + PHP 7.1 is no longer supported due to upstream not supporting + this version for the entire lifecycle of the 19.09 release. + </para> + </listitem> + <listitem> + <para> + The binfmt module is now easier to use. Additional systems can + be added through + <literal>boot.binfmt.emulatedSystems</literal>. 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> + </listitem> + <listitem> + <para> + We've updated to Xfce 4.14, which brings a new module + <literal>services.xserver.desktopManager.xfce4-14</literal>. + If you'd like to upgrade, please switch from the + <literal>services.xserver.desktopManager.xfce</literal> module + as it will be deprecated in a future release. They're + incompatibilities with the current Xfce module; it doesn't + support <literal>thunarPlugins</literal> and it isn't + recommended to use + <literal>services.xserver.desktopManager.xfce</literal> and + <literal>services.xserver.desktopManager.xfce4-14</literal> + 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. + </para> + <itemizedlist> + <listitem> + <para> + <literal>services.gnome3.core-os-services.enable</literal> + </para> + </listitem> + <listitem> + <para> + <literal>services.gnome3.core-shell.enable</literal> + </para> + </listitem> + <listitem> + <para> + <literal>services.gnome3.core-utilities.enable</literal> + </para> + </listitem> + <listitem> + <para> + <literal>services.gnome3.games.enable</literal> + </para> + </listitem> + </itemizedlist> + <para> + 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 + <literal>environment.gnome3.excludePackages</literal> which + only excluded the optional applications. + <literal>environment.gnome3.excludePackages</literal> is now + unguarded, it can exclude any package installed with + <literal>environment.systemPackages</literal> 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. + </para> + <para> + <emphasis role="strong">The following changes were enacted in + <literal>services.gnome3.core-utilities.enable</literal></emphasis> + </para> + <itemizedlist> + <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>cheese</literal> + </para> + </listitem> + <listitem> + <para> + <literal>geary</literal> + </para> + </listitem> + </itemizedlist> + <para> + <emphasis role="strong">The following changes were enacted in + <literal>services.gnome3.core-shell.enable</literal></emphasis> + </para> + <itemizedlist> + <listitem> + <para> + <literal>gnome-color-manager</literal> + </para> + </listitem> + <listitem> + <para> + <literal>orca</literal> + </para> + </listitem> + <listitem> + <para> + <literal>services.avahi.enable</literal> + </para> + </listitem> + </itemizedlist> + </listitem> + </itemizedlist> + </section> + <section xml:id="sec-release-19.09-new-services"> + <title>New Services</title> + <para> + The following new services were added since the last release: + </para> + <itemizedlist> + <listitem> + <para> + <literal>./programs/dwm-status.nix</literal> + </para> + </listitem> + <listitem> + <para> + The new <literal>hardware.printers</literal> module allows to + declaratively configure CUPS printers via the + <literal>ensurePrinters</literal> and + <literal>ensureDefaultPrinter</literal> options. + <literal>ensurePrinters</literal> 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 + <link xlink:href="options.html#opt-services.system-config-printer.enable">services.system-config-printer.enable</link> + and + <link xlink:href="options.html#opt-programs.system-config-printer.enable">programs.system-config-printer.enable</link> + 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> + <listitem> + <para> + <literal>services.xserver.desktopManager.plasma5</literal> + </para> + </listitem> + <listitem> + <para> + <literal>services.xserver.desktopManager.gnome3</literal> + </para> + </listitem> + <listitem> + <para> + <literal>services.xserver.desktopManager.pantheon</literal> + </para> + </listitem> + <listitem> + <para> + <literal>services.xserver.desktopManager.mate</literal> + 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> + <listitem> + <para> + <link xlink:href="options.html#opt-services.blueman.enable">services.blueman.enable</link> + has been added. If you previously had blueman installed via + <literal>environment.systemPackages</literal> please migrate + to using the NixOS module, as this would result in an + insufficiently configured blueman. + </para> + </listitem> + </itemizedlist> + </section> + <section xml:id="sec-release-19.09-incompatibilities"> + <title>Backward Incompatibilities</title> + <para> + 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. + </para> + </listitem> + <listitem> + <para> + PostgreSQL now uses <literal>/run/postgresql</literal> as its + socket directory instead of <literal>/tmp</literal>. 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> + <para> + PostgreSQL 9.4 is scheduled EOL during the 19.09 life cycle + and has been removed. + </para> + </listitem> + <listitem> + <para> + The options + <literal>services.prometheus.alertmanager.user</literal> and + <literal>services.prometheus.alertmanager.group</literal> 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. + </para> + </listitem> + <listitem> + <para> + The <literal>services.nzbget.configFile</literal> and + <literal>services.nzbget.openFirewall</literal> options were + removed as they are managed internally by the nzbget. The + <literal>services.nzbget.dataDir</literal> option hadn't + actually been used by the module for some time and so was + removed as cleanup. + </para> + </listitem> + <listitem> + <para> + The <literal>services.mysql.pidDir</literal> 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) + <literal>/run/mysqld/mysql.sock</literal> file to appear. + </para> + </listitem> + <listitem> + <para> + The <literal>services.emby.enable</literal> module has been + removed, see <literal>services.jellyfin.enable</literal> + 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 + <literal>networking.interfaces.*.preferTempAddress</literal> + 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>. + </para> + <para> + The corresponding module, <literal>services.btsync</literal> + has been replaced by the <literal>services.resilio</literal> + 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> + </para> + <para> + The option <literal>services.httpd.extraSubservices</literal> + 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 + <literal>services.limesurvey.enable</literal>, + <literal>services.mediawiki.enable</literal>, + <literal>services.wordpress.enable</literal>, and + <literal>services.zabbixWeb.enable</literal> options. + </para> + </listitem> + <listitem> + <para> + The option + <literal>systemd.network.networks.<name>.routes.*.routeConfig.GatewayOnlink</literal> + was renamed to + <literal>systemd.network.networks.<name>.routes.*.routeConfig.GatewayOnLink</literal> + (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. + </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. + </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. + </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. + </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>. + </para> + </listitem> + <listitem> + <para> + The setopt declarations will be evaluated at the end of + <literal>/etc/zshrc</literal>, so any code in + <link xlink:href="options.html#opt-programs.zsh.interactiveShellInit">programs.zsh.interactiveShellInit</link>, + <link xlink:href="options.html#opt-programs.zsh.loginShellInit">programs.zsh.loginShellInit</link> + and + <link xlink:href="options.html#opt-programs.zsh.promptInit">programs.zsh.promptInit</link> + 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>. + </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. + </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> + </listitem> + <listitem> + <para> + The <literal>ibus-qt</literal> package is not installed by + default anymore when + <link xlink:href="options.html#opt-i18n.inputMethod.enabled">i18n.inputMethod.enabled</link> + 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 + <link xlink:href="options.html#opt-environment.systemPackages">environment.systemPackages</link> + 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 + <literal>services.cups.startWhenNeeded</literal> to + <literal>false</literal>. + </para> + </listitem> + <listitem> + <para> + The <literal>services.systemhealth</literal> module has been + removed from nixpkgs due to lack of maintainer. + </para> + </listitem> + <listitem> + <para> + The <literal>services.mantisbt</literal> module has been + removed from nixpkgs due to lack of maintainer. + </para> + </listitem> + <listitem> + <para> + Squid 3 has been removed and the <literal>squid</literal> + derivation now refers to Squid 4. + </para> + </listitem> + <listitem> + <para> + The <literal>services.pdns-recursor.extraConfig</literal> + option has been replaced by + <literal>services.pdns-recursor.settings</literal>. 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>. + </para> + <para> + The following services are affected by this: + </para> + <itemizedlist> + <listitem> + <para> + <link xlink:href="options.html#opt-services.dovecot2.enable"><literal>services.dovecot2</literal></link> + </para> + </listitem> + <listitem> + <para> + <link xlink:href="options.html#opt-services.nsd.enable"><literal>services.nsd</literal></link> + </para> + </listitem> + <listitem> + <para> + <link xlink:href="options.html#opt-services.softether.enable"><literal>services.softether</literal></link> + </para> + </listitem> + <listitem> + <para> + <link xlink:href="options.html#opt-services.strongswan.enable"><literal>services.strongswan</literal></link> + </para> + </listitem> + <listitem> + <para> + <link xlink:href="options.html#opt-services.strongswan-swanctl.enable"><literal>services.strongswan-swanctl</literal></link> + </para> + </listitem> + <listitem> + <para> + <link xlink:href="options.html#opt-services.httpd.enable"><literal>services.httpd</literal></link> + </para> + </listitem> + </itemizedlist> + </listitem> + <listitem> + <para> + The <literal>security.acme.directory</literal> option has been + replaced by a read-only + <literal>security.acme.certs.<cert>.directory</literal> + 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 + <literal>services.nginx.virtualhosts.<name>.enableACME</literal> + option will use this directory option to find the certs for + the virtual host. + </para> + <para> + <literal>security.acme.preDelay</literal> and + <literal>security.acme.activationDelay</literal> 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 + <literal>services.nginx.virtualhosts.<name>.enableACME</literal> + 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> + </listitem> + <listitem> + <para> + <literal>services.xserver.desktopManager.xterm</literal> 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. + </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. + </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>. + </para> + </listitem> + <listitem> + <para> + Citrix Receiver (<literal>citrix_receiver</literal>) has been + dropped in favor of Citrix Workspace + (<literal>citrix_workspace</literal>). + </para> + </listitem> + <listitem> + <para> + The <literal>services.gitlab</literal> module has had its + literal secret options + (<literal>services.gitlab.smtp.password</literal>, + <literal>services.gitlab.databasePassword</literal>, + <literal>services.gitlab.initialRootPassword</literal>, + <literal>services.gitlab.secrets.secret</literal>, + <literal>services.gitlab.secrets.db</literal>, + <literal>services.gitlab.secrets.otp</literal> and + <literal>services.gitlab.secrets.jws</literal>) replaced by + file-based versions + (<literal>services.gitlab.smtp.passwordFile</literal>, + <literal>services.gitlab.databasePasswordFile</literal>, + <literal>services.gitlab.initialRootPasswordFile</literal>, + <literal>services.gitlab.secrets.secretFile</literal>, + <literal>services.gitlab.secrets.dbFile</literal>, + <literal>services.gitlab.secrets.otpFile</literal> and + <literal>services.gitlab.secrets.jwsFile</literal>). This was + done so that secrets aren't stored in the world-readable nix + store, but means that for each option you'll have to create a + file with the same exact string, add "File" to the + end of the option name, and change the definition to a string + pointing to the corresponding file; e.g. + <literal>services.gitlab.databasePassword = "supersecurepassword"</literal> + becomes + <literal>services.gitlab.databasePasswordFile = "/path/to/secret_file"</literal> + where the file <literal>secret_file</literal> contains the + string <literal>supersecurepassword</literal>. + </para> + <para> + The state path (<literal>services.gitlab.statePath</literal>) + now has the following restriction: no parent directory can be + owned by any other user than <literal>root</literal> or the + user specified in <literal>services.gitlab.user</literal>; + i.e. if <literal>services.gitlab.statePath</literal> is set to + <literal>/var/lib/gitlab/state</literal>, + <literal>gitlab</literal> and all parent directories must be + owned by either <literal>root</literal> or the user specified + in <literal>services.gitlab.user</literal>. + </para> + </listitem> + <listitem> + <para> + The <literal>networking.useDHCP</literal> option is + unsupported in combination with + <literal>networking.useNetworkd</literal> in anticipation of + defaulting to it. It has to be set to <literal>false</literal> + and enabled per interface with + <literal>networking.interfaces.<name>.useDHCP = true;</literal> + </para> + </listitem> + <listitem> + <para> + The Twitter client <literal>corebird</literal> has been + dropped as + <link xlink:href="https://www.patreon.com/posts/corebirds-future-18921328">it + is discontinued and does not work against the new Twitter + API</link>. Please use the fork <literal>cawbird</literal> + instead which has been adapted to the API changes and is still + maintained. + </para> + </listitem> + <listitem> + <para> + The <literal>nodejs-11_x</literal> package has been removed as + it's EOLed by upstream. + </para> + </listitem> + <listitem> + <para> + Because of the systemd upgrade, systemd-timesyncd will no + longer work if <literal>system.stateVersion</literal> is not + set correctly. When upgrading from NixOS 19.03, please make + sure that <literal>system.stateVersion</literal> is set to + <literal>"19.03"</literal>, or lower if the + installation dates back to an earlier version of NixOS. + </para> + </listitem> + <listitem> + <para> + Due to the short lifetime of non-LTS kernel releases package + attributes like <literal>linux_5_1</literal>, + <literal>linux_5_2</literal> and <literal>linux_5_3</literal> + have been removed to discourage dependence on specific non-LTS + kernel versions in stable NixOS releases. Going forward, + versioned attributes like <literal>linux_4_9</literal> will + exist for LTS versions only. Please use + <literal>linux_latest</literal> or + <literal>linux_testing</literal> if you depend on non-LTS + releases. Keep in mind that <literal>linux_latest</literal> + and <literal>linux_testing</literal> will change versions + under the hood during the lifetime of a stable release and + might include breaking changes. + </para> + </listitem> + <listitem> + <para> + Because of the systemd upgrade, some network interfaces might + change their name. For details see + <link xlink:href="https://www.freedesktop.org/software/systemd/man/systemd.net-naming-scheme.html#History"> + upstream docs</link> or + <link xlink:href="https://github.com/NixOS/nixpkgs/issues/71086"> + our ticket</link>. + </para> + </listitem> + </itemizedlist> + </section> + <section xml:id="sec-release-19.09-notable-changes"> + <title>Other Notable Changes</title> + <itemizedlist> + <listitem> + <para> + The <literal>documentation</literal> module gained an option + named <literal>documentation.nixos.includeAllModules</literal> + which makes the generated configuration.nix 5 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. + </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. + </para> + <itemizedlist spacing="compact"> + <listitem> + <para> + <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>. + </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. + </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>. + </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. + </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 + <literal>avahi</literal> now supports custom service + definitions via + <literal>services.avahi.extraServiceFiles</literal>, which are + then placed in the aforementioned directory. See + avahi.service5 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 + <literal>Cargo.toml</literal> 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. + </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. + </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 + <literal>hardware.pulseaudio.daemon.config.resample-method</literal> + 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. + </para> + </listitem> + <listitem> + <para> + The <literal>mercurial</literal> + <literal>httpd.extraSubservice</literal> has been removed from + nixpkgs due to lack of maintainer. + </para> + </listitem> + <listitem> + <para> + The <literal>trac</literal> + <literal>httpd.extraSubservice</literal> has been removed from + nixpkgs because it was unmaintained. + </para> + </listitem> + <listitem> + <para> + The <literal>foswiki</literal> package and associated + <literal>httpd.extraSubservice</literal> have been removed + from nixpkgs due to lack of maintainer. + </para> + </listitem> + <listitem> + <para> + The <literal>tomcat-connector</literal> + <literal>httpd.extraSubservice</literal> has been removed from + nixpkgs. + </para> + </listitem> + <listitem> + <para> + It's now possible to change configuration in + <link xlink:href="options.html#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. + </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>. + </para> + <para> + The <literal>/etc/sysctl.d/nixos.conf</literal> file + containing all the options set via + <link xlink:href="options.html#opt-boot.kernel.sysctl">boot.kernel.sysctl</link> + was moved to <literal>/etc/sysctl.d/60-nixos.conf</literal>, + as sysctl.d5 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. + </para> + <itemizedlist> + <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> + <para> + This also configures the kernel to pass core dumps 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 xlink:href="options.html#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> + Core dumps are now processed by + <literal>systemd-coredump</literal> by default. + <literal>systemd-coredump</literal> behaviour can still be + modified via <literal>systemd.coredump.extraConfig</literal>. + 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 <literal>systemd.coredump.enable</literal> to + <literal>false</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. + </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. + </para> + </listitem> + <listitem> + <para> + systemd cgroup accounting via the + <link xlink:href="options.html#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 + <literal>fonts.fontconfig.penultimate.enable</literal> 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. + </para> + <para> + The + <link xlink:href="options.html#opt-services.redis.enable">redis + module</link> was hardcoded to use the + <literal>redis</literal> user, <literal>/run/redis</literal> + as runtime directory and <literal>/var/lib/redis</literal> 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 <literal>fonts.enableDefaultFonts</literal> adds a + default emoji font <literal>noto-fonts-emoji</literal>. + </para> + <itemizedlist> + <listitem> + <para> + <literal>services.xserver.enable</literal> + </para> + </listitem> + <listitem> + <para> + <literal>programs.sway.enable</literal> + </para> + </listitem> + <listitem> + <para> + <literal>programs.way-cooler.enable</literal> + </para> + </listitem> + <listitem> + <para> + <literal>services.xrdp.enable</literal> + </para> + </listitem> + </itemizedlist> + </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> + </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/from_md/release-notes/rl-2003.section.xml b/nixos/doc/manual/from_md/release-notes/rl-2003.section.xml new file mode 100644 index 00000000000..53e6e1329a9 --- /dev/null +++ b/nixos/doc/manual/from_md/release-notes/rl-2003.section.xml @@ -0,0 +1,1497 @@ +<section xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="sec-release-20.03"> + <title>Release 20.03 (<quote>Markhor</quote>, 2020.04/20)</title> + <section xml:id="sec-release-20.03-highlights"> + <title>Highlights</title> + <para> + In addition to numerous new and upgraded packages, this release + has the following highlights: + </para> + <itemizedlist> + <listitem> + <para> + Support is planned until the end of October 2020, handing over + to 20.09. + </para> + </listitem> + <listitem> + <para> + Core version changes: + </para> + <para> + gcc: 8.3.0 -> 9.2.0 + </para> + <para> + glibc: 2.27 -> 2.30 + </para> + <para> + linux: 4.19 -> 5.4 + </para> + <para> + mesa: 19.1.5 -> 19.3.3 + </para> + <para> + openssl: 1.0.2u -> 1.1.1d + </para> + </listitem> + <listitem> + <para> + Desktop version changes: + </para> + <para> + plasma5: 5.16.5 -> 5.17.5 + </para> + <para> + kdeApplications: 19.08.2 -> 19.12.3 + </para> + <para> + gnome3: 3.32 -> 3.34 + </para> + <para> + pantheon: 5.0 -> 5.1.3 + </para> + </listitem> + <listitem> + <para> + Linux kernel is updated to branch 5.4 by default (from 4.19). + </para> + </listitem> + <listitem> + <para> + Grub is updated to 2.04, adding support for booting from F2FS + filesystems and Btrfs volumes using zstd compression. Note + that some users have been unable to boot after upgrading to + 2.04 - for more information, please see + <link xlink:href="https://github.com/NixOS/nixpkgs/issues/61718#issuecomment-617618503">this + discussion</link>. + </para> + </listitem> + <listitem> + <para> + Postgresql for NixOS service now defaults to v11. + </para> + </listitem> + <listitem> + <para> + The graphical installer image starts the graphical session + automatically. Before you'd be greeted by a tty and asked to + enter <literal>systemctl start display-manager</literal>. It + is now possible to disable the display-manager from running by + selecting the <literal>Disable display-manager</literal> quirk + in the boot menu. + </para> + </listitem> + <listitem> + <para> + GNOME 3 has been upgraded to 3.34. Please take a look at their + <link xlink:href="https://help.gnome.org/misc/release-notes/3.34">Release + Notes</link> for details. + </para> + </listitem> + <listitem> + <para> + If you enable the Pantheon Desktop Manager via + <link xlink:href="options.html#opt-services.xserver.desktopManager.pantheon.enable">services.xserver.desktopManager.pantheon.enable</link>, + we now default to also use + <link xlink:href="https://blog.elementary.io/say-hello-to-the-new-greeter/"> + Pantheon's newly designed greeter </link>. Contrary to NixOS's + usual update policy, Pantheon will receive updates during the + cycle of NixOS 20.03 when backwards compatible. + </para> + </listitem> + <listitem> + <para> + By default zfs pools will now be trimmed on a weekly basis. + Trimming is only done on supported devices (i.e. NVME or SSDs) + and should improve throughput and lifetime of these devices. + It is controlled by the + <literal>services.zfs.trim.enable</literal> varname. The zfs + scrub service + (<literal>services.zfs.autoScrub.enable</literal>) and the zfs + autosnapshot service + (<literal>services.zfs.autoSnapshot.enable</literal>) are now + only enabled if zfs is set in + <literal>config.boot.initrd.supportedFilesystems</literal> or + <literal>config.boot.supportedFilesystems</literal>. These + lists will automatically contain zfs as soon as any zfs + mountpoint is configured in <literal>fileSystems</literal>. + </para> + </listitem> + <listitem> + <para> + <literal>nixos-option</literal> has been rewritten in C++, + speeding it up, improving correctness, and adding a + <literal>-r</literal> option which prints all options and + their values recursively. + </para> + </listitem> + <listitem> + <para> + <literal>services.xserver.desktopManager.default</literal> and + <literal>services.xserver.windowManager.default</literal> + options were replaced by a single + <link xlink:href="options.html#opt-services.xserver.displayManager.defaultSession">services.xserver.displayManager.defaultSession</link> + option to improve support for upstream session files. If you + used something like: + </para> + <programlisting language="bash"> +{ + services.xserver.desktopManager.default = "xfce"; + services.xserver.windowManager.default = "icewm"; +} +</programlisting> + <para> + you should change it to: + </para> + <programlisting language="bash"> +{ + services.xserver.displayManager.defaultSession = "xfce+icewm"; +} +</programlisting> + </listitem> + <listitem> + <para> + The testing driver implementation in NixOS is now in Python + <literal>make-test-python.nix</literal>. This was done by + Jacek Galowicz + (<link xlink:href="https://github.com/tfc">@tfc</link>), and + with the collaboration of Julian Stecklina + (<link xlink:href="https://github.com/blitz">@blitz</link>) + and Jana Traue + (<link xlink:href="https://github.com/jtraue">@jtraue</link>). + All documentation has been updated to use this testing driver, + and a vast majority of the 286 tests in NixOS were ported to + python driver. In 20.09 the Perl driver implementation, + <literal>make-test.nix</literal>, is slated for removal. This + should give users of the NixOS integration framework a + transitory period to rewrite their tests to use the Python + implementation. Users of the Perl driver will see this warning + everytime they use it: + </para> + <programlisting> +$ warning: Perl VM tests are deprecated and will be removed for 20.09. +Please update your tests to use the python test driver. +See https://github.com/NixOS/nixpkgs/pull/71684 for details. +</programlisting> + <para> + API compatibility is planned to be kept for at least the next + release with the perl driver. + </para> + </listitem> + </itemizedlist> + </section> + <section xml:id="sec-release-20.03-new-services"> + <title>New Services</title> + <para> + The following new services were added since the last release: + </para> + <itemizedlist> + <listitem> + <para> + The kubernetes kube-proxy now supports a new hostname + configuration + <literal>services.kubernetes.proxy.hostname</literal> which + has to be set if the hostname of the node should be non + default. + </para> + </listitem> + <listitem> + <para> + UPower's configuration is now managed by NixOS and can be + customized via <literal>services.upower</literal>. + </para> + </listitem> + <listitem> + <para> + To use Geary you should enable + <link xlink:href="options.html#opt-programs.geary.enable">programs.geary.enable</link> + instead of just adding it to + <link xlink:href="options.html#opt-environment.systemPackages">environment.systemPackages</link>. + It was created so Geary could function properly outside of + GNOME. + </para> + </listitem> + <listitem> + <para> + <literal>./config/console.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>./hardware/brillo.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>./hardware/tuxedo-keyboard.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>./programs/bandwhich.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>./programs/bash-my-aws.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>./programs/liboping.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>./programs/traceroute.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>./services/backup/sanoid.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>./services/backup/syncoid.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>./services/backup/zfs-replication.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>./services/continuous-integration/buildkite-agents.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>./services/databases/victoriametrics.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>./services/desktops/gnome3/gnome-initial-setup.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>./services/desktops/neard.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>./services/games/openarena.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>./services/hardware/fancontrol.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>./services/mail/sympa.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>./services/misc/freeswitch.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>./services/misc/mame.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>./services/monitoring/do-agent.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>./services/monitoring/prometheus/xmpp-alerts.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>./services/network-filesystems/orangefs/server.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>./services/network-filesystems/orangefs/client.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>./services/networking/3proxy.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>./services/networking/corerad.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>./services/networking/go-shadowsocks2.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>./services/networking/ntp/openntpd.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>./services/networking/shorewall.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>./services/networking/shorewall6.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>./services/networking/spacecookie.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>./services/networking/trickster.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>./services/networking/v2ray.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>./services/networking/xandikos.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>./services/networking/yggdrasil.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>./services/web-apps/dokuwiki.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>./services/web-apps/gotify-server.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>./services/web-apps/grocy.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>./services/web-apps/ihatemoney</literal> + </para> + </listitem> + <listitem> + <para> + <literal>./services/web-apps/moinmoin.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>./services/web-apps/trac.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>./services/web-apps/trilium.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>./services/web-apps/shiori.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>./services/web-servers/ttyd.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>./services/x11/picom.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>./services/x11/hardware/digimend.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>./services/x11/imwheel.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>./virtualisation/cri-o.nix</literal> + </para> + </listitem> + </itemizedlist> + </section> + <section xml:id="sec-release-20.03-incompatibilities"> + <title>Backward Incompatibilities</title> + <para> + When upgrading from a previous release, please be aware of the + following incompatible changes: + </para> + <itemizedlist> + <listitem> + <para> + The dhcpcd package + <link xlink:href="https://roy.marples.name/archives/dhcpcd-discuss/0002621.html"> + does not request IPv4 addresses for tap and bridge interfaces + anymore by default</link>. In order to still get an address on + a bridge interface, one has to disable + <literal>networking.useDHCP</literal> and explicitly enable + <literal>networking.interfaces.<name>.useDHCP</literal> + on every interface, that should get an address via DHCP. This + way, dhcpcd is configured in an explicit way about which + interface to run on. + </para> + </listitem> + <listitem> + <para> + GnuPG is now built without support for a graphical passphrase + entry by default. Please enable the + <literal>gpg-agent</literal> user service via the NixOS option + <literal>programs.gnupg.agent.enable</literal>. Note that + upstream recommends using <literal>gpg-agent</literal> and + will spawn a <literal>gpg-agent</literal> on the first + invocation of GnuPG anyway. + </para> + </listitem> + <listitem> + <para> + The <literal>dynamicHosts</literal> option has been removed + from the + <link xlink:href="options.html#opt-networking.networkmanager.enable">NetworkManager</link> + module. Allowing (multiple) regular users to override host + entries affecting the whole system opens up a huge attack + vector. There seem to be very rare cases where this might be + useful. Consider setting system-wide host entries using + <link xlink:href="options.html#opt-networking.hosts">networking.hosts</link>, + provide them via the DNS server in your network, or use + <link xlink:href="options.html#opt-environment.etc">environment.etc</link> + to add a file into + <literal>/etc/NetworkManager/dnsmasq.d</literal> reconfiguring + <literal>hostsdir</literal>. + </para> + </listitem> + <listitem> + <para> + The <literal>99-main.network</literal> file was removed. + Matching all network interfaces caused many breakages, see + <link xlink:href="https://github.com/NixOS/nixpkgs/pull/18962">#18962</link> + and + <link xlink:href="https://github.com/NixOS/nixpkgs/pull/71106">#71106</link>. + </para> + <para> + We already don't support the global + <link xlink:href="options.html#opt-networking.useDHCP">networking.useDHCP</link>, + <link xlink:href="options.html#opt-networking.defaultGateway">networking.defaultGateway</link> + and + <link xlink:href="options.html#opt-networking.defaultGateway6">networking.defaultGateway6</link> + options if + <link xlink:href="options.html#opt-networking.useNetworkd">networking.useNetworkd</link> + is enabled, but direct users to configure the per-device + <link xlink:href="options.html#opt-networking.interfaces">networking.interfaces.<name>….</link> + options. + </para> + </listitem> + <listitem> + <para> + The stdenv now runs all bash with <literal>set -u</literal>, + to catch the use of undefined variables. Before, it itself + used <literal>set -u</literal> but was careful to unset it so + other packages' code ran as before. Now, all bash code is held + to the same high standard, and the rather complex stateful + manipulation of the options can be discarded. + </para> + </listitem> + <listitem> + <para> + The SLIM Display Manager has been removed, as it has been + unmaintained since 2013. Consider migrating to a different + display manager such as LightDM (current default in NixOS), + SDDM, GDM, or using the startx module which uses Xinitrc. + </para> + </listitem> + <listitem> + <para> + The Way Cooler wayland compositor has been removed, as the + project has been officially canceled. There are no more + <literal>way-cooler</literal> attribute and + <literal>programs.way-cooler</literal> options. + </para> + </listitem> + <listitem> + <para> + The BEAM package set has been deleted. You will only find + there the different interpreters. You should now use the + different build tools coming with the languages with sandbox + mode disabled. + </para> + </listitem> + <listitem> + <para> + There is now only one Xfce package-set and module. This means + that attributes <literal>xfce4-14</literal> and + <literal>xfceUnstable</literal> all now point to the latest + Xfce 4.14 packages. And in the future NixOS releases will be + the latest released version of Xfce available at the time of + the release's development (if viable). + </para> + </listitem> + <listitem> + <para> + The + <link xlink:href="options.html#opt-services.phpfpm.pools">phpfpm</link> + module now sets <literal>PrivateTmp=true</literal> in its + systemd units for better process isolation. If you rely on + <literal>/tmp</literal> being shared with other services, + explicitly override this by setting + <literal>serviceConfig.PrivateTmp</literal> to + <literal>false</literal> for each phpfpm unit. + </para> + </listitem> + <listitem> + <para> + KDE’s old multimedia framework Phonon no longer supports Qt 4. + For that reason, Plasma desktop also does not have + <literal>enableQt4Support</literal> option any more. + </para> + </listitem> + <listitem> + <para> + The BeeGFS module has been removed. + </para> + </listitem> + <listitem> + <para> + The osquery module has been removed. + </para> + </listitem> + <listitem> + <para> + Going forward, <literal>~/bin</literal> in the users home + directory will no longer be in <literal>PATH</literal> by + default. If you depend on this you should set the option + <literal>environment.homeBinInPath</literal> to + <literal>true</literal>. The aforementioned option was added + this release. + </para> + </listitem> + <listitem> + <para> + The <literal>buildRustCrate</literal> infrastructure now + produces <literal>lib</literal> outputs in addition to the + <literal>out</literal> output. This has led to drastically + reduced closure sizes for some rust crates since development + dependencies are now in the <literal>lib</literal> output. + </para> + </listitem> + <listitem> + <para> + Pango was upgraded to 1.44, which no longer uses freetype for + font loading. This means that type1 and bitmap fonts are no + longer supported in applications relying on Pango for font + rendering (notably, GTK application). See + <link xlink:href="https://gitlab.gnome.org/GNOME/pango/issues/386"> + upstream issue</link> for more information. + </para> + </listitem> + <listitem> + <para> + The <literal>roundcube</literal> module has been hardened. + </para> + <itemizedlist> + <listitem> + <para> + The password of the database is not written world readable + in the store any more. If <literal>database.host</literal> + is set to <literal>localhost</literal>, then a unix user + of the same name as the database will be created and + PostreSQL peer authentication will be used, removing the + need for a password. Otherwise, a password is still needed + and can be provided with the new option + <literal>database.passwordFile</literal>, which should be + set to the path of a file containing the password and + readable by the user <literal>nginx</literal> only. The + <literal>database.password</literal> option is insecure + and deprecated. Usage of this option will print a warning. + </para> + </listitem> + <listitem> + <para> + A random <literal>des_key</literal> is set by default in + the configuration of roundcube, instead of using the + hardcoded and insecure default. To ensure a clean + migration, all users will be logged out when you upgrade + to this release. + </para> + </listitem> + </itemizedlist> + </listitem> + <listitem> + <para> + The packages <literal>openobex</literal> and + <literal>obexftp</literal> are no longer installed when + enabling Bluetooth via + <literal>hardware.bluetooth.enable</literal>. + </para> + </listitem> + <listitem> + <para> + The <literal>dump1090</literal> derivation has been changed to + use FlightAware's dump1090 as its upstream. However, this + version does not have an internal webserver anymore. The + assets in the <literal>share/dump1090</literal> directory of + the derivation can be used in conjunction with an external + webserver to replace this functionality. + </para> + </listitem> + <listitem> + <para> + The fourStore and fourStoreEndpoint modules have been removed. + </para> + </listitem> + <listitem> + <para> + Polkit no longer has the user of uid 0 (root) as an admin + identity. We now follow the upstream default of only having + every member of the wheel group admin privileged. Before it + was root and members of wheel. The positive outcome of this is + pkexec GUI popups or terminal prompts will no longer require + the user to choose between two essentially equivalent choices + (whether to perform the action as themselves with wheel + permissions, or as the root user). + </para> + </listitem> + <listitem> + <para> + NixOS containers no longer build NixOS manual by default. This + saves evaluation time, especially if there are many + declarative containers defined. Note that this is already done + when + <literal><nixos/modules/profiles/minimal.nix></literal> + module is included in container config. + </para> + </listitem> + <listitem> + <para> + The <literal>kresd</literal> services deprecates the + <literal>interfaces</literal> option in favor of the + <literal>listenPlain</literal> option which requires full + <link xlink:href="https://www.freedesktop.org/software/systemd/man/systemd.socket.html#ListenStream=">systemd.socket + compatible</link> declaration which always include a port. + </para> + </listitem> + <listitem> + <para> + Virtual console options have been reorganized and can be found + under a single top-level attribute: + <literal>console</literal>. The full set of changes is as + follows: + </para> + <itemizedlist> + <listitem> + <para> + <literal>i18n.consoleFont</literal> renamed to + <link xlink:href="options.html#opt-console.font">console.font</link> + </para> + </listitem> + <listitem> + <para> + <literal>i18n.consoleKeyMap</literal> renamed to + <link xlink:href="options.html#opt-console.keyMap">console.keyMap</link> + </para> + </listitem> + <listitem> + <para> + <literal>i18n.consoleColors</literal> renamed to + <link xlink:href="options.html#opt-console.colors">console.colors</link> + </para> + </listitem> + <listitem> + <para> + <literal>i18n.consolePackages</literal> renamed to + <link xlink:href="options.html#opt-console.packages">console.packages</link> + </para> + </listitem> + <listitem> + <para> + <literal>i18n.consoleUseXkbConfig</literal> renamed to + <link xlink:href="options.html#opt-console.useXkbConfig">console.useXkbConfig</link> + </para> + </listitem> + <listitem> + <para> + <literal>boot.earlyVconsoleSetup</literal> renamed to + <link xlink:href="options.html#opt-console.earlySetup">console.earlySetup</link> + </para> + </listitem> + <listitem> + <para> + <literal>boot.extraTTYs</literal> renamed to + <literal>console.extraTTYs</literal>. + </para> + </listitem> + </itemizedlist> + </listitem> + <listitem> + <para> + The + <link xlink:href="options.html#opt-services.awstats.enable">awstats</link> + module has been rewritten to serve stats via static html + pages, updated on a timer, over + <link xlink:href="options.html#opt-services.nginx.virtualHosts">nginx</link>, + instead of dynamic cgi pages over + <link xlink:href="options.html#opt-services.httpd.enable">apache</link>. + </para> + <para> + Minor changes will be required to migrate existing + configurations. Details of the required changes can seen by + looking through the + <link xlink:href="options.html#opt-services.awstats.enable">awstats</link> + module. + </para> + </listitem> + <listitem> + <para> + The httpd module no longer provides options to support serving + web content without defining a virtual host. As a result of + this the + <link xlink:href="options.html#opt-services.httpd.logPerVirtualHost">services.httpd.logPerVirtualHost</link> + option now defaults to <literal>true</literal> instead of + <literal>false</literal>. Please update your configuration to + make use of + <link xlink:href="options.html#opt-services.httpd.virtualHosts">services.httpd.virtualHosts</link>. + </para> + <para> + The + <link xlink:href="options.html#opt-services.httpd.virtualHosts">services.httpd.virtualHosts.<name></link> + option has changed type from a list of submodules to an + attribute set of submodules, better matching + <link xlink:href="options.html#opt-services.nginx.virtualHosts">services.nginx.virtualHosts.<name></link>. + </para> + <para> + This change comes with the addition of the following options + which mimic the functionality of their + <literal>nginx</literal> counterparts: + <link xlink:href="options.html#opt-services.httpd.virtualHosts">services.httpd.virtualHosts.<name>.addSSL</link>, + <link xlink:href="options.html#opt-services.httpd.virtualHosts">services.httpd.virtualHosts.<name>.forceSSL</link>, + <link xlink:href="options.html#opt-services.httpd.virtualHosts">services.httpd.virtualHosts.<name>.onlySSL</link>, + <link xlink:href="options.html#opt-services.httpd.virtualHosts">services.httpd.virtualHosts.<name>.enableACME</link>, + <link xlink:href="options.html#opt-services.httpd.virtualHosts">services.httpd.virtualHosts.<name>.acmeRoot</link>, + and + <link xlink:href="options.html#opt-services.httpd.virtualHosts">services.httpd.virtualHosts.<name>.useACMEHost</link>. + </para> + </listitem> + <listitem> + <para> + For NixOS configuration options, the <literal>loaOf</literal> + type has been deprecated and will be removed in a future + release. In nixpkgs, options of this type will be changed to + <literal>attrsOf</literal> instead. If you were using one of + these in your configuration, you will see a warning suggesting + what changes will be required. + </para> + <para> + For example, + <link xlink:href="options.html#opt-users.users">users.users</link> + is a <literal>loaOf</literal> option that is commonly used as + follows: + </para> + <programlisting language="bash"> +{ + users.users = + [ { name = "me"; + description = "My personal user."; + isNormalUser = true; + } + ]; +} +</programlisting> + <para> + This should be rewritten by removing the list and using the + value of <literal>name</literal> as the name of the attribute + set: + </para> + <programlisting language="bash"> +{ + users.users.me = + { description = "My personal user."; + isNormalUser = true; + }; +} +</programlisting> + <para> + For more information on this change have look at these links: + <link xlink:href="https://github.com/NixOS/nixpkgs/issues/1800">issue + #1800</link>, + <link xlink:href="https://github.com/NixOS/nixpkgs/pull/63103">PR + #63103</link>. + </para> + </listitem> + <listitem> + <para> + For NixOS modules, the types + <literal>types.submodule</literal> and + <literal>types.submoduleWith</literal> now support paths as + allowed values, similar to how <literal>imports</literal> + supports paths. Because of this, if you have a module that + defines an option of type + <literal>either (submodule ...) path</literal>, it will break + since a path is now treated as the first type instead of the + second. To fix this, change the type to + <literal>either path (submodule ...)</literal>. + </para> + </listitem> + <listitem> + <para> + The + <link xlink:href="options.html#opt-services.buildkite-agents">Buildkite + Agent</link> module and corresponding packages have been + updated to 3.x, and to support multiple instances of the agent + running at the same time. This means you will have to rename + <literal>services.buildkite-agent</literal> to + <literal>services.buildkite-agents.<name></literal>. + Furthermore, the following options have been changed: + </para> + <itemizedlist> + <listitem> + <para> + <literal>services.buildkite-agent.meta-data</literal> has + been renamed to + <link xlink:href="options.html#opt-services.buildkite-agents">services.buildkite-agents.<name>.tags</link>, + to match upstreams naming for 3.x. Its type has also + changed - it now accepts an attrset of strings. + </para> + </listitem> + <listitem> + <para> + The<literal>services.buildkite-agent.openssh.publicKeyPath</literal> + option has been removed, as it's not necessary to deploy + public keys to clone private repositories. + </para> + </listitem> + <listitem> + <para> + <literal>services.buildkite-agent.openssh.privateKeyPath</literal> + has been renamed to + <link xlink:href="options.html#opt-services.buildkite-agents">buildkite-agents.<name>.privateSshKeyPath</link>, + as the whole <literal>openssh</literal> now only contained + that single option. + </para> + </listitem> + <listitem> + <para> + <link xlink:href="options.html#opt-services.buildkite-agents">services.buildkite-agents.<name>.shell</link> + has been introduced, allowing to specify a custom shell to + be used. + </para> + </listitem> + </itemizedlist> + </listitem> + <listitem> + <para> + The <literal>citrix_workspace_19_3_0</literal> package has + been removed as it will be EOLed within the lifespan of 20.03. + For further information, please refer to the + <link xlink:href="https://www.citrix.com/de-de/support/product-lifecycle/milestones/receiver.html">support + and maintenance information</link> from upstream. + </para> + </listitem> + <listitem> + <para> + The <literal>gcc5</literal> and <literal>gfortran5</literal> + packages have been removed. + </para> + </listitem> + <listitem> + <para> + The <literal>services.xserver.displayManager.auto</literal> + module has been removed. It was only intended for use in + internal NixOS tests, and gave the false impression of it + being a special display manager when it's actually LightDM. + Please use the + <literal>services.xserver.displayManager.lightdm.autoLogin</literal> + options instead, or any other display manager in NixOS as they + all support auto-login. If you used this module specifically + because it permitted root auto-login you can override the + lightdm-autologin pam module like: + </para> + <programlisting language="bash"> +{ + security.pam.services.lightdm-autologin.text = lib.mkForce '' + auth requisite pam_nologin.so + auth required pam_succeed_if.so quiet + auth required pam_permit.so + + account include lightdm + + password include lightdm + + session include lightdm + ''; +} +</programlisting> + <para> + The difference is the: + </para> + <programlisting> +auth required pam_succeed_if.so quiet +</programlisting> + <para> + line, where default it's: + </para> + <programlisting> + auth required pam_succeed_if.so uid >= 1000 quiet +</programlisting> + <para> + not permitting users with uid's below 1000 (like root). All + other display managers in NixOS are configured like this. + </para> + </listitem> + <listitem> + <para> + There have been lots of improvements to the Mailman module. As + a result, + </para> + <itemizedlist> + <listitem> + <para> + The <literal>services.mailman.hyperkittyBaseUrl</literal> + option has been renamed to + <link xlink:href="options.html#opt-services.mailman.hyperkitty.baseUrl">services.mailman.hyperkitty.baseUrl</link>. + </para> + </listitem> + <listitem> + <para> + The <literal>services.mailman.hyperkittyApiKey</literal> + option has been removed. This is because having an option + for the Hyperkitty API key meant that the API key would be + stored in the world-readable Nix store, which was a + security vulnerability. A new Hyperkitty API key will be + generated the first time the new Hyperkitty service is + run, and it will then be persisted outside of the Nix + store. To continue using Hyperkitty, you must set + <link xlink:href="options.html#opt-services.mailman.hyperkitty.enable">services.mailman.hyperkitty.enable</link> + to <literal>true</literal>. + </para> + </listitem> + <listitem> + <para> + Additionally, some Postfix configuration must now be set + manually instead of automatically by the Mailman module: + </para> + <programlisting language="bash"> +{ + services.postfix.relayDomains = [ "hash:/var/lib/mailman/data/postfix_domains" ]; + services.postfix.config.transport_maps = [ "hash:/var/lib/mailman/data/postfix_lmtp" ]; + services.postfix.config.local_recipient_maps = [ "hash:/var/lib/mailman/data/postfix_lmtp" ]; +} +</programlisting> + <para> + This is because some users may want to include other + values in these lists as well, and this was not possible + if they were set automatically by the Mailman module. It + would not have been possible to just concatenate values + from multiple modules each setting the values they needed, + because the order of elements in the list is significant. + </para> + </listitem> + </itemizedlist> + </listitem> + <listitem> + <para> + The LLVM versions 3.5, 3.9 and 4 (including the corresponding + CLang versions) have been dropped. + </para> + </listitem> + <listitem> + <para> + The + <literal>networking.interfaces.*.preferTempAddress</literal> + option has been replaced by + <literal>networking.interfaces.*.tempAddress</literal>. The + new option allows better control of the IPv6 temporary + addresses, including completely disabling them for interfaces + where they are not needed. + </para> + </listitem> + <listitem> + <para> + Rspamd was updated to version 2.2. Read + <link xlink:href="https://rspamd.com/doc/migration.html#migration-to-rspamd-20"> + the upstream migration notes</link> carefully. Please be + especially aware that some modules were removed and the + default Bayes backend is now Redis. + </para> + </listitem> + <listitem> + <para> + The <literal>*psu</literal> versions of oraclejdk8 have been + removed as they aren't provided by upstream anymore. + </para> + </listitem> + <listitem> + <para> + The <literal>services.dnscrypt-proxy</literal> module has been + removed as it used the deprecated version of dnscrypt-proxy. + We've added + <link xlink:href="options.html#opt-services.dnscrypt-proxy2.enable">services.dnscrypt-proxy2.enable</link> + to use the supported version. This module supports + configuration via the Nix attribute set + <link xlink:href="options.html#opt-services.dnscrypt-proxy2.settings">services.dnscrypt-proxy2.settings</link>, + or by passing a TOML configuration file via + <link xlink:href="options.html#opt-services.dnscrypt-proxy2.configFile">services.dnscrypt-proxy2.configFile</link>. + </para> + <programlisting language="bash"> +{ + # Example configuration: + services.dnscrypt-proxy2.enable = true; + services.dnscrypt-proxy2.settings = { + listen_addresses = [ "127.0.0.1:43" ]; + sources.public-resolvers = { + urls = [ "https://download.dnscrypt.info/resolvers-list/v2/public-resolvers.md" ]; + cache_file = "public-resolvers.md"; + minisign_key = "RWQf6LRCGA9i53mlYecO4IzT51TGPpvWucNSCh1CBM0QTaLn73Y7GFO3"; + refresh_delay = 72; + }; + }; + + services.dnsmasq.enable = true; + services.dnsmasq.servers = [ "127.0.0.1#43" ]; +} +</programlisting> + </listitem> + <listitem> + <para> + <literal>qesteidutil</literal> has been deprecated in favor of + <literal>qdigidoc</literal>. + </para> + </listitem> + <listitem> + <para> + sqldeveloper_18 has been removed as it's not maintained + anymore, sqldeveloper has been updated to version + <literal>19.4</literal>. Please note that this means that this + means that the oraclejdk is now required. For further + information please read the + <link xlink:href="https://www.oracle.com/technetwork/developer-tools/sql-developer/downloads/sqldev-relnotes-194-5908846.html">release + notes</link>. + </para> + </listitem> + <listitem> + <para> + Haskell <literal>env</literal> and <literal>shellFor</literal> + dev shell environments now organize dependencies the same way + as regular builds. In particular, rather than receiving all + the different lists of dependencies mashed together as one big + list, and then partitioning into Haskell and non-Hakell + dependencies, they work from the original many different + dependency parameters and don't need to algorithmically + partition anything. + </para> + <para> + This means that if you incorrectly categorize a dependency, + e.g. non-Haskell library dependency as a + <literal>buildDepends</literal> or run-time Haskell dependency + as a <literal>setupDepends</literal>, whereas things would + have worked before they may not work now. + </para> + </listitem> + <listitem> + <para> + The gcc-snapshot-package has been removed. It's marked as + broken for >2 years and used to point to a fairly old + snapshot from the gcc7-branch. + </para> + </listitem> + <listitem> + <para> + The nixos-build-vms8 -script now uses the python test-driver. + </para> + </listitem> + <listitem> + <para> + The riot-web package now accepts configuration overrides as an + attribute set instead of a string. A formerly used JSON + configuration can be converted to an attribute set with + <literal>builtins.fromJSON</literal>. + </para> + <para> + The new default configuration also disables automatic guest + account registration and analytics to improve privacy. The + previous behavior can be restored by setting + <literal>config.riot-web.conf = { disable_guests = false; piwik = true; }</literal>. + </para> + </listitem> + <listitem> + <para> + Stand-alone usage of <literal>Upower</literal> now requires + <literal>services.upower.enable</literal> instead of just + installing into + <link xlink:href="options.html#opt-environment.systemPackages">environment.systemPackages</link>. + </para> + </listitem> + <listitem> + <para> + nextcloud has been updated to <literal>v18.0.2</literal>. This + means that users from NixOS 19.09 can't upgrade directly since + you can only move one version forward and 19.09 uses + <literal>v16.0.8</literal>. + </para> + <para> + To provide a safe upgrade-path and to circumvent similar + issues in the future, the following measures were taken: + </para> + <itemizedlist> + <listitem> + <para> + The pkgs.nextcloud-attribute has been removed and replaced + with versioned attributes (currently pkgs.nextcloud17 and + pkgs.nextcloud18). With this change major-releases can be + backported without breaking stuff and to make + upgrade-paths easier. + </para> + </listitem> + <listitem> + <para> + Existing setups will be detected using + <link xlink:href="options.html#opt-system.stateVersion">system.stateVersion</link>: + by default, nextcloud17 will be used, but will raise a + warning which notes that after that deploy it's + recommended to update to the latest stable version + (nextcloud18) by declaring the newly introduced setting + <link xlink:href="options.html#opt-services.nextcloud.package">services.nextcloud.package</link>. + </para> + </listitem> + <listitem> + <para> + Users with an overlay (e.g. to use nextcloud at version + <literal>v18</literal> on <literal>19.09</literal>) will + get an evaluation error by default. This is done to ensure + that our + <link xlink:href="options.html#opt-services.nextcloud.package">package</link>-option + doesn't select an older version by accident. It's + recommended to use pkgs.nextcloud18 or to set + <link xlink:href="options.html#opt-services.nextcloud.package">package</link> + to pkgs.nextcloud explicitly. + </para> + </listitem> + </itemizedlist> + <warning> + <para> + Please note that if you're coming from + <literal>19.03</literal> or older, you have to manually + upgrade to <literal>19.09</literal> first to upgrade your + server to Nextcloud v16. + </para> + </warning> + </listitem> + <listitem> + <para> + Hydra has gained a massive performance improvement due to + <link xlink:href="https://github.com/NixOS/hydra/pull/710">some + database schema changes</link> by adding several IDs and + better indexing. However, it's necessary to upgrade Hydra in + multiple steps: + </para> + <itemizedlist> + <listitem> + <para> + At first, an older version of Hydra needs to be deployed + which adds those (nullable) columns. When having set + <link xlink:href="options.html#opt-system.stateVersion">stateVersion + </link> to a value older than <literal>20.03</literal>, + this package will be selected by default from the module + when upgrading. Otherwise, the package can be deployed + using the following config: + </para> + <programlisting language="bash"> +{ pkgs, ... }: { + services.hydra.package = pkgs.hydra-migration; +} +</programlisting> + </listitem> + </itemizedlist> + </listitem> + <listitem> + <para> + Automatically fill the newly added ID columns on the server by + running the following command: + </para> + <programlisting> +$ hydra-backfill-ids +</programlisting> + <warning> + <para> + Please note that this process can take a while depending on + your database-size! + </para> + </warning> + </listitem> + <listitem> + <para> + Deploy a newer version of Hydra to activate the DB + optimizations. This can be done by using hydra-unstable. This + package already includes + <link xlink:href="https://github.com/nixos/rfcs/pull/49">flake-support</link> + and is therefore compiled against pkgs.nixFlakes. + </para> + <warning> + <para> + If your + <link xlink:href="options.html#opt-system.stateVersion">stateVersion</link> + is set to <literal>20.03</literal> or greater, + hydra-unstable will be used automatically! This will break + your setup if you didn't run the migration. + </para> + </warning> + <para> + Please note that Hydra is currently not available with + nixStable as this doesn't compile anymore. + </para> + <warning> + <para> + pkgs.hydra has been removed to ensure a graceful + database-migration using the dedicated package-attributes. + If you still have pkgs.hydra defined in e.g. an overlay, an + assertion error will be thrown. To circumvent this, you need + to set + <link xlink:href="options.html#opt-services.hydra.package">services.hydra.package</link> + to pkgs.hydra explicitly and make sure you know what you're + doing! + </para> + </warning> + </listitem> + <listitem> + <para> + The TokuDB storage engine will be disabled in mariadb 10.5. It + is recommended to switch to RocksDB. See also + <link xlink:href="https://mariadb.com/kb/en/tokudb/">TokuDB</link>. + </para> + </listitem> + </itemizedlist> + </section> + <section xml:id="sec-release-20.03-notable-changes"> + <title>Other Notable Changes</title> + <itemizedlist> + <listitem> + <para> + SD images are now compressed by default using + <literal>bzip2</literal>. + </para> + </listitem> + <listitem> + <para> + The nginx web server previously started its master process as + root privileged, then ran worker processes as a less + privileged identity user (the <literal>nginx</literal> user). + This was changed to start all of nginx as a less privileged + user (defined by <literal>services.nginx.user</literal> and + <literal>services.nginx.group</literal>). As a consequence, + all files that are needed for nginx to run (included + configuration fragments, SSL certificates and keys, etc.) must + now be readable by this less privileged user/group. + </para> + <para> + To continue to use the old approach, you can configure: + </para> + <programlisting language="bash"> +{ + services.nginx.appendConfig = let cfg = config.services.nginx; in ''user ${cfg.user} ${cfg.group};''; + systemd.services.nginx.serviceConfig.User = lib.mkForce "root"; +} +</programlisting> + </listitem> + <listitem> + <para> + OpenSSH has been upgraded from 7.9 to 8.1, improving security + and adding features but with potential incompatibilities. + Consult the + <link xlink:href="https://www.openssh.com/txt/release-8.1"> + release announcement</link> for more information. + </para> + </listitem> + <listitem> + <para> + <literal>PRETTY_NAME</literal> in + <literal>/etc/os-release</literal> now uses the short rather + than full version string. + </para> + </listitem> + <listitem> + <para> + The ACME module has switched from simp-le to + <link xlink:href="https://github.com/go-acme/lego">lego</link> + which allows us to support DNS-01 challenges and wildcard + certificates. The following options have been added: + <link xlink:href="options.html#opt-security.acme.acceptTerms">security.acme.acceptTerms</link>, + <link xlink:href="options.html#opt-security.acme.certs">security.acme.certs.<name>.dnsProvider</link>, + <link xlink:href="options.html#opt-security.acme.certs">security.acme.certs.<name>.credentialsFile</link>, + <link xlink:href="options.html#opt-security.acme.certs">security.acme.certs.<name>.dnsPropagationCheck</link>. + As well as this, the options + <literal>security.acme.acceptTerms</literal> and either + <literal>security.acme.email</literal> or + <literal>security.acme.certs.<name>.email</literal> must + be set in order to use the ACME module. Certificates will be + regenerated on activation, no account or certificate will be + migrated from simp-le. In particular private keys will not be + preserved. However, the credentials for simp-le are preserved + and thus it is possible to roll back to previous versions + without breaking certificate generation. Note also that in + contrary to simp-le a new private key is recreated at each + renewal by default, which can have consequences if you embed + your public key in apps. + </para> + </listitem> + <listitem> + <para> + It is now possible to unlock LUKS-Encrypted file systems using + a FIDO2 token via + <literal>boot.initrd.luks.fido2Support</literal>. + </para> + </listitem> + <listitem> + <para> + Predictably named network interfaces get renamed in stage-1. + This means that it is possible to use the proper interface + name for e.g. Dropbear setups. + </para> + <para> + For further reference, please read + <link xlink:href="https://github.com/NixOS/nixpkgs/pull/68953">#68953</link> + or the corresponding + <link xlink:href="https://discourse.nixos.org/t/predictable-network-interface-names-in-initrd/4055">discourse + thread</link>. + </para> + </listitem> + <listitem> + <para> + The matrix-synapse-package has been updated to + <link xlink:href="https://github.com/matrix-org/synapse/releases/tag/v1.11.1">v1.11.1</link>. + Due to + <link xlink:href="https://github.com/matrix-org/synapse/releases/tag/v1.10.0rc1">stricter + requirements</link> for database configuration when using + postgresql, the automated database setup of the module has + been removed to avoid any further edge-cases. + </para> + <para> + matrix-synapse expects <literal>postgresql</literal>-databases + to have the options <literal>LC_COLLATE</literal> and + <literal>LC_CTYPE</literal> set to + <link xlink:href="https://www.postgresql.org/docs/12/locale.html"><literal>'C'</literal></link> + which basically instructs <literal>postgresql</literal> to + ignore any locale-based preferences. + </para> + <para> + Depending on your setup, you need to incorporate one of the + following changes in your setup to upgrade to 20.03: + </para> + <itemizedlist> + <listitem> + <para> + If you use <literal>sqlite3</literal> you don't need to do + anything. + </para> + </listitem> + <listitem> + <para> + If you use <literal>postgresql</literal> on a different + server, you don't need to change anything as well since + this module was never designed to configure remote + databases. + </para> + </listitem> + <listitem> + <para> + If you use <literal>postgresql</literal> and configured + your synapse initially on <literal>19.09</literal> or + older, you simply need to enable postgresql-support + explicitly: + </para> + <programlisting language="bash"> +{ ... }: { + services.matrix-synapse = { + enable = true; + /* and all the other config you've defined here */ + }; + services.postgresql.enable = true; +} +</programlisting> + </listitem> + </itemizedlist> + </listitem> + <listitem> + <para> + If you deploy a fresh matrix-synapse, you need to configure + the database yourself (e.g. by using the + <link xlink:href="options.html#opt-services.postgresql.initialScript">services.postgresql.initialScript</link> + option). An example for this can be found in the + <link linkend="module-services-matrix">documentation of the + Matrix module</link>. + </para> + </listitem> + <listitem> + <para> + If you initially deployed your matrix-synapse on + <literal>nixos-unstable</literal> <emphasis>after</emphasis> + the <literal>19.09</literal>-release, your database is + misconfigured due to a regression in NixOS. For now, + matrix-synapse will startup with a warning, but it's + recommended to reconfigure the database to set the values + <literal>LC_COLLATE</literal> and <literal>LC_CTYPE</literal> + to + <link xlink:href="https://www.postgresql.org/docs/12/locale.html"><literal>'C'</literal></link>. + </para> + </listitem> + <listitem> + <para> + The + <link xlink:href="options.html#opt-systemd.network.links">systemd.network.links</link> + option is now respected even when + <link xlink:href="options.html#opt-systemd.network.enable">systemd-networkd</link> + is disabled. This mirrors the behaviour of systemd - It's udev + that parses <literal>.link</literal> files, not + <literal>systemd-networkd</literal>. + </para> + </listitem> + <listitem> + <para> + mongodb has been updated to version <literal>3.4.24</literal>. + </para> + <warning> + <para> + Please note that mongodb has been relicensed under their own + <link xlink:href="https://www.mongodb.com/licensing/server-side-public-license/faq"><literal> sspl</literal></link>-license. + Since it's not entirely free and not OSI-approved, it's + listed as non-free. This means that Hydra doesn't provide + prebuilt mongodb-packages and needs to be built locally. + </para> + </warning> + </listitem> + </itemizedlist> + </section> +</section> diff --git a/nixos/doc/manual/from_md/release-notes/rl-2009.section.xml b/nixos/doc/manual/from_md/release-notes/rl-2009.section.xml new file mode 100644 index 00000000000..c74d850b2c6 --- /dev/null +++ b/nixos/doc/manual/from_md/release-notes/rl-2009.section.xml @@ -0,0 +1,2206 @@ +<section xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="sec-release-20.09"> + <title>Release 20.09 (<quote>Nightingale</quote>, 2020.10/27)</title> + <para> + Support is planned until the end of June 2021, handing over to + 21.05. (Plans + <link xlink:href="https://github.com/NixOS/rfcs/blob/master/rfcs/0080-nixos-release-schedule.md#core-changes"> + have shifted</link> by two months since release of 20.09.) + </para> + <section xml:id="sec-release-20.09-highlights"> + <title>Highlights</title> + <para> + In addition to 7349 new, 14442 updated, and 8181 removed packages, + this release has the following highlights: + </para> + <itemizedlist> + <listitem> + <para> + Core version changes: + </para> + <itemizedlist> + <listitem> + <para> + gcc: 9.2.0 -> 9.3.0 + </para> + </listitem> + <listitem> + <para> + glibc: 2.30 -> 2.31 + </para> + </listitem> + <listitem> + <para> + linux: still defaults to 5.4.x, all supported kernels + available + </para> + </listitem> + <listitem> + <para> + mesa: 19.3.5 -> 20.1.7 + </para> + </listitem> + </itemizedlist> + </listitem> + <listitem> + <para> + Desktop Environments: + </para> + <itemizedlist> + <listitem> + <para> + plasma5: 5.17.5 -> 5.18.5 + </para> + </listitem> + <listitem> + <para> + kdeApplications: 19.12.3 -> 20.08.1 + </para> + </listitem> + <listitem> + <para> + gnome3: 3.34 -> 3.36, see its + <link xlink:href="https://help.gnome.org/misc/release-notes/3.36/">release + notes</link> + </para> + </listitem> + <listitem> + <para> + cinnamon: added at 4.6 + </para> + </listitem> + <listitem> + <para> + NixOS now distributes an official + <link xlink:href="https://nixos.org/download.html#nixos-iso">GNOME + ISO</link> + </para> + </listitem> + </itemizedlist> + </listitem> + <listitem> + <para> + Programming Languages and Frameworks: + </para> + <itemizedlist> + <listitem> + <para> + Agda ecosystem was heavily reworked (see more details + below) + </para> + </listitem> + <listitem> + <para> + PHP now defaults to PHP 7.4, updated from 7.3 + </para> + </listitem> + <listitem> + <para> + PHP 7.2 is no longer supported due to upstream not + supporting this version for the entire lifecycle of the + 20.09 release + </para> + </listitem> + <listitem> + <para> + Python 3 now defaults to Python 3.8 instead of 3.7 + </para> + </listitem> + <listitem> + <para> + Python 3.5 reached its upstream EOL at the end of + September 2020: it has been removed from the list of + available packages + </para> + </listitem> + </itemizedlist> + </listitem> + <listitem> + <para> + Databases and Service Monitoring: + </para> + <itemizedlist> + <listitem> + <para> + MariaDB has been updated to 10.4, MariaDB Galera to 26.4. + Please read the related upgrade instructions under + <link linkend="sec-release-20.09-incompatibilities">backwards + incompatibilities</link> before upgrading. + </para> + </listitem> + <listitem> + <para> + Zabbix now defaults to 5.0, updated from 4.4. Please read + related sections under + <link linkend="sec-release-20.09-incompatibilities">backwards + compatibilities</link> before upgrading. + </para> + </listitem> + </itemizedlist> + </listitem> + <listitem> + <para> + Major module changes: + </para> + <itemizedlist> + <listitem> + <para> + Quickly configure a complete, private, self-hosted video + conferencing solution with the new Jitsi Meet module. + </para> + </listitem> + <listitem> + <para> + Two new options, + <link xlink:href="options.html#opt-services.openssh.authorizedKeysCommand">authorizedKeysCommand</link> + and + <link xlink:href="options.html#opt-services.openssh.authorizedKeysCommandUser">authorizedKeysCommandUser</link>, + have been added to the <literal>openssh</literal> module. + If you have <literal>AuthorizedKeysCommand</literal> in + your + <link xlink:href="options.html#opt-services.openssh.extraConfig">services.openssh.extraConfig</link> + you should make use of these new options instead. + </para> + </listitem> + <listitem> + <para> + There is a new module for Podman + (<literal>virtualisation.podman</literal>), a drop-in + replacement for the Docker command line. + </para> + </listitem> + <listitem> + <para> + The new <literal>virtualisation.containers</literal> + module manages configuration shared by the CRI-O and + Podman modules. + </para> + </listitem> + <listitem> + <para> + Declarative Docker containers are renamed from + <literal>docker-containers</literal> to + <literal>virtualisation.oci-containers.containers</literal>. + This is to make it possible to use + <literal>podman</literal> instead of + <literal>docker</literal>. + </para> + </listitem> + <listitem> + <para> + The new option + <link xlink:href="options.html#opt-documentation.man.generateCaches">documentation.man.generateCaches</link> + has been added to automatically generate the + <literal>man-db</literal> caches, which are needed by + utilities like <literal>whatis</literal> and + <literal>apropos</literal>. The caches are generated + during the build of the NixOS configuration: since this + can be expensive when a large number of packages are + installed, the feature is disabled by default. + </para> + </listitem> + <listitem> + <para> + <literal>services.postfix.sslCACert</literal> was replaced + by + <literal>services.postfix.tlsTrustedAuthorities</literal> + which now defaults to system certificate authorities. + </para> + </listitem> + <listitem> + <para> + The various documented workarounds to use steam have been + converted to a module. + <literal>programs.steam.enable</literal> enables steam, + controller support and the workarounds. + </para> + </listitem> + <listitem> + <para> + Support for built-in LCDs in various pieces of Logitech + hardware (keyboards and USB speakers). + <literal>hardware.logitech.lcd.enable</literal> enables + support for all hardware supported by the + <link xlink:href="https://sourceforge.net/projects/g15daemon/">g15daemon + project</link>. + </para> + </listitem> + <listitem> + <para> + The GRUB module gained support for basic password + protection, which allows to restrict non-default entries + in the boot menu to one or more users. The users and + passwords are defined via the option + <literal>boot.loader.grub.users</literal>. Note: Password + support is only available in GRUB version 2. + </para> + </listitem> + </itemizedlist> + </listitem> + <listitem> + <para> + NixOS module changes: + </para> + <itemizedlist> + <listitem> + <para> + The NixOS module system now supports freeform modules as a + mix between <literal>types.attrsOf</literal> and + <literal>types.submodule</literal>. These allow you to + explicitly declare a subset of options while still + permitting definitions without an associated option. See + <xref linkend="sec-freeform-modules" /> for how to use + them. + </para> + </listitem> + <listitem> + <para> + Following its deprecation in 20.03, the Perl NixOS test + driver has been removed. All remaining tests have been + ported to the Python test framework. Code outside nixpkgs + using <literal>make-test.nix</literal> or + <literal>testing.nix</literal> needs to be ported to + <literal>make-test-python.nix</literal> and + <literal>testing-python.nix</literal> respectively. + </para> + </listitem> + <listitem> + <para> + Subordinate GID and UID mappings are now set up + automatically for all normal users. This will make + container tools like Podman work as non-root users out of + the box. + </para> + </listitem> + </itemizedlist> + </listitem> + <listitem> + <para> + Starting with this release, the hydra-build-result + <literal>nixos-YY.MM</literal> branches no longer exist in the + <link xlink:href="https://github.com/nixos/nixpkgs-channels">deprecated + nixpkgs-channels repository</link>. These branches are now in + <link xlink:href="https://github.com/nixos/nixpkgs">the main + nixpkgs repository</link>. + </para> + </listitem> + </itemizedlist> + </section> + <section xml:id="sec-release-20.09-new-services"> + <title>New Services</title> + <para> + In addition to 1119 new, 118 updated, and 476 removed options; 61 + new modules were added since the last release: + </para> + <itemizedlist> + <listitem> + <para> + Hardware: + </para> + <itemizedlist> + <listitem> + <para> + <link xlink:href="options.html#opt-hardware.system76.firmware-daemon.enable">hardware.system76.firmware-daemon.enable</link> + adds easy support of system76 firmware + </para> + </listitem> + <listitem> + <para> + <link xlink:href="options.html#opt-hardware.uinput.enable">hardware.uinput.enable</link> + loads uinput kernel module + </para> + </listitem> + <listitem> + <para> + <link xlink:href="options.html#opt-hardware.video.hidpi.enable">hardware.video.hidpi.enable</link> + enable good defaults for HiDPI displays + </para> + </listitem> + <listitem> + <para> + <link xlink:href="options.html#opt-hardware.wooting.enable">hardware.wooting.enable</link> + support for Wooting keyboards + </para> + </listitem> + <listitem> + <para> + <link xlink:href="options.html#opt-hardware.xpadneo.enable">hardware.xpadneo.enable</link> + xpadneo driver for Xbox One wireless controllers + </para> + </listitem> + </itemizedlist> + </listitem> + <listitem> + <para> + Programs: + </para> + <itemizedlist> + <listitem> + <para> + <link xlink:href="options.html#opt-programs.hamster.enable">programs.hamster.enable</link> + enable hamster time tracking + </para> + </listitem> + <listitem> + <para> + <link xlink:href="options.html#opt-programs.steam.enable">programs.steam.enable</link> + adds easy enablement of steam and related system + configuration + </para> + </listitem> + </itemizedlist> + </listitem> + <listitem> + <para> + Security: + </para> + <itemizedlist> + <listitem> + <para> + <link xlink:href="options.html#opt-security.doas.enable">security.doas.enable</link> + alternative to sudo, allows non-root users to execute + commands as root + </para> + </listitem> + <listitem> + <para> + <link xlink:href="options.html#opt-security.tpm2.enable">security.tpm2.enable</link> + add Trusted Platform Module 2 support + </para> + </listitem> + </itemizedlist> + </listitem> + <listitem> + <para> + System: + </para> + <itemizedlist spacing="compact"> + <listitem> + <para> + <link xlink:href="options.html#opt-boot.initrd.network.openvpn.enable">boot.initrd.network.openvpn.enable</link> + start an OpenVPN client during initrd boot + </para> + </listitem> + </itemizedlist> + </listitem> + <listitem> + <para> + Virtualization: + </para> + <itemizedlist> + <listitem> + <para> + <link xlink:href="options.html#opt-boot.enableContainers">boot.enableContainers</link> + use nixos-containers + </para> + </listitem> + <listitem> + <para> + <link xlink:href="options.html#opt-virtualisation.oci-containers.containers">virtualisation.oci-containers.containers</link> + run OCI (Docker) containers + </para> + </listitem> + <listitem> + <para> + <link xlink:href="options.html#opt-virtualisation.podman.enable">virtualisation.podman.enable</link> + daemonless container engine + </para> + </listitem> + </itemizedlist> + </listitem> + <listitem> + <para> + Services: + </para> + <itemizedlist> + <listitem> + <para> + <link xlink:href="options.html#opt-services.ankisyncd.enable">services.ankisyncd.enable</link> + Anki sync server + </para> + </listitem> + <listitem> + <para> + <link xlink:href="options.html#opt-services.bazarr.enable">services.bazarr.enable</link> + Subtitle manager for Sonarr and Radarr + </para> + </listitem> + <listitem> + <para> + <link xlink:href="options.html#opt-services.biboumi.enable">services.biboumi.enable</link> + Biboumi XMPP gateway to IRC + </para> + </listitem> + <listitem> + <para> + <link xlink:href="options.html#opt-services.blockbook-frontend">services.blockbook-frontend</link> + Blockbook-frontend, a service for the Trezor wallet + </para> + </listitem> + <listitem> + <para> + <link xlink:href="options.html#opt-services.cage.enable">services.cage.enable</link> + Wayland cage service + </para> + </listitem> + <listitem> + <para> + <link xlink:href="options.html#opt-services.convos.enable">services.convos.enable</link> + IRC daemon, which can be accessed throught the browser + </para> + </listitem> + <listitem> + <para> + <link xlink:href="options.html#opt-services.engelsystem.enable">services.engelsystem.enable</link> + Tool for coordinating volunteers and shifts on large + events + </para> + </listitem> + <listitem> + <para> + <link xlink:href="options.html#opt-services.espanso.enable">services.espanso.enable</link> + text-expander written in rust + </para> + </listitem> + <listitem> + <para> + <link xlink:href="options.html#opt-services.foldingathome.enable">services.foldingathome.enable</link> + Folding@home client + </para> + </listitem> + <listitem> + <para> + <link xlink:href="options.html#opt-services.gerrit.enable">services.gerrit.enable</link> + Web-based team code collaboration tool + </para> + </listitem> + <listitem> + <para> + <link xlink:href="options.html#opt-services.go-neb.enable">services.go-neb.enable</link> + Matrix bot + </para> + </listitem> + <listitem> + <para> + <link xlink:href="options.html#opt-services.hardware.xow.enable">services.hardware.xow.enable</link> + xow as a systemd service + </para> + </listitem> + <listitem> + <para> + <link xlink:href="options.html#opt-services.hercules-ci-agent.enable">services.hercules-ci-agent.enable</link> + Hercules CI build agent + </para> + </listitem> + <listitem> + <para> + <link xlink:href="options.html#opt-services.jicofo.enable">services.jicofo.enable</link> + Jitsi Conference Focus, component of Jitsi Meet + </para> + </listitem> + <listitem> + <para> + <link xlink:href="options.html#opt-services.jirafeau.enable">services.jirafeau.enable</link> + A web file repository + </para> + </listitem> + <listitem> + <para> + <link xlink:href="options.html#opt-services.jitsi-meet.enable">services.jitsi-meet.enable</link> + Secure, simple and scalable video conferences + </para> + </listitem> + <listitem> + <para> + <link xlink:href="options.html#opt-services.jitsi-videobridge.enable">services.jitsi-videobridge.enable</link> + Jitsi Videobridge, a WebRTC compatible router + </para> + </listitem> + <listitem> + <para> + <link xlink:href="options.html#opt-services.jupyterhub.enable">services.jupyterhub.enable</link> + Jupyterhub development server + </para> + </listitem> + <listitem> + <para> + <link xlink:href="options.html#opt-services.k3s.enable">services.k3s.enable</link> + Lightweight Kubernetes distribution + </para> + </listitem> + <listitem> + <para> + <link xlink:href="options.html#opt-services.magic-wormhole-mailbox-server.enable">services.magic-wormhole-mailbox-server.enable</link> + Magic Wormhole Mailbox Server + </para> + </listitem> + <listitem> + <para> + <link xlink:href="options.html#opt-services.malcontent.enable">services.malcontent.enable</link> + Parental Control support + </para> + </listitem> + <listitem> + <para> + <link xlink:href="options.html#opt-services.matrix-appservice-discord.enable">services.matrix-appservice-discord.enable</link> + Matrix and Discord bridge + </para> + </listitem> + <listitem> + <para> + <link xlink:href="options.html#opt-services.mautrix-telegram.enable">services.mautrix-telegram.enable</link> + Matrix-Telegram puppeting/relaybot bridge + </para> + </listitem> + <listitem> + <para> + <link xlink:href="options.html#opt-services.mirakurun.enable">services.mirakurun.enable</link> + Japanese DTV Tuner Server Service + </para> + </listitem> + <listitem> + <para> + <link xlink:href="options.html#opt-services.molly-brown.enable">services.molly-brown.enable</link> + Molly-Brown Gemini server + </para> + </listitem> + <listitem> + <para> + <link xlink:href="options.html#opt-services.mullvad-vpn.enable">services.mullvad-vpn.enable</link> + Mullvad VPN daemon + </para> + </listitem> + <listitem> + <para> + <link xlink:href="options.html#opt-services.ncdns.enable">services.ncdns.enable</link> + Namecoin to DNS bridge + </para> + </listitem> + <listitem> + <para> + <link xlink:href="options.html#opt-services.nextdns.enable">services.nextdns.enable</link> + NextDNS to DoH Proxy service + </para> + </listitem> + <listitem> + <para> + <link xlink:href="options.html#opt-services.nix-store-gcs-proxy">services.nix-store-gcs-proxy</link> + Google storage bucket to be used as a nix store + </para> + </listitem> + <listitem> + <para> + <link xlink:href="options.html#opt-services.onedrive.enable">services.onedrive.enable</link> + OneDrive sync service + </para> + </listitem> + <listitem> + <para> + <link xlink:href="options.html#opt-services.pinnwand.enable">services.pinnwand.enable</link> + Pastebin-like service + </para> + </listitem> + <listitem> + <para> + <link xlink:href="options.html#opt-services.pixiecore.enable">services.pixiecore.enable</link> + Manage network booting of machines + </para> + </listitem> + <listitem> + <para> + <link xlink:href="options.html#opt-services.privacyidea.enable">services.privacyidea.enable</link> + Privacy authentication server + </para> + </listitem> + <listitem> + <para> + <link xlink:href="options.html#opt-services.quorum.enable">services.quorum.enable</link> + Quorum blockchain daemon + </para> + </listitem> + <listitem> + <para> + <link xlink:href="options.html#opt-services.robustirc-bridge.enable">services.robustirc-bridge.enable</link> + RobustIRC bridge + </para> + </listitem> + <listitem> + <para> + <link xlink:href="options.html#opt-services.rss-bridge.enable">services.rss-bridge.enable</link> + Generate RSS and Atom feeds + </para> + </listitem> + <listitem> + <para> + <link xlink:href="options.html#opt-services.rtorrent.enable">services.rtorrent.enable</link> + rTorrent service + </para> + </listitem> + <listitem> + <para> + <link xlink:href="options.html#opt-services.smartdns.enable">services.smartdns.enable</link> + SmartDNS DNS server + </para> + </listitem> + <listitem> + <para> + <link xlink:href="options.html#opt-services.sogo.enable">services.sogo.enable</link> + SOGo groupware + </para> + </listitem> + <listitem> + <para> + <link xlink:href="options.html#opt-services.teeworlds.enable">services.teeworlds.enable</link> + Teeworlds game server + </para> + </listitem> + <listitem> + <para> + <link xlink:href="options.html#opt-services.torque.mom.enable">services.torque.mom.enable</link> + torque computing node + </para> + </listitem> + <listitem> + <para> + <link xlink:href="options.html#opt-services.torque.server.enable">services.torque.server.enable</link> + torque server + </para> + </listitem> + <listitem> + <para> + <link xlink:href="options.html#opt-services.tuptime.enable">services.tuptime.enable</link> + A total uptime service + </para> + </listitem> + <listitem> + <para> + <link xlink:href="options.html#opt-services.urserver.enable">services.urserver.enable</link> + X11 remote server + </para> + </listitem> + <listitem> + <para> + <link xlink:href="options.html#opt-services.wasabibackend.enable">services.wasabibackend.enable</link> + Wasabi backend service + </para> + </listitem> + <listitem> + <para> + <link xlink:href="options.html#opt-services.yubikey-agent.enable">services.yubikey-agent.enable</link> + Yubikey agent + </para> + </listitem> + <listitem> + <para> + <link xlink:href="options.html#opt-services.zigbee2mqtt.enable">services.zigbee2mqtt.enable</link> + Zigbee to MQTT bridge + </para> + </listitem> + </itemizedlist> + </listitem> + </itemizedlist> + </section> + <section xml:id="sec-release-20.09-incompatibilities"> + <title>Backward Incompatibilities</title> + <para> + When upgrading from a previous release, please be aware of the + following incompatible changes: + </para> + <itemizedlist> + <listitem> + <para> + MariaDB has been updated to 10.4, MariaDB Galera to 26.4. + Before you upgrade, it would be best to take a backup of your + database. For MariaDB Galera Cluster, see + <link xlink:href="https://mariadb.com/kb/en/upgrading-from-mariadb-103-to-mariadb-104-with-galera-cluster/">Upgrading + from MariaDB 10.3 to MariaDB 10.4 with Galera Cluster</link> + instead. Before doing the upgrade read + <link xlink:href="https://mariadb.com/kb/en/upgrading-from-mariadb-103-to-mariadb-104/#incompatible-changes-between-103-and-104">Incompatible + Changes Between 10.3 and 10.4</link>. After the upgrade you + will need to run <literal>mysql_upgrade</literal>. MariaDB + 10.4 introduces a number of changes to the authentication + process, intended to make things easier and more intuitive. + See + <link xlink:href="https://mariadb.com/kb/en/authentication-from-mariadb-104/">Authentication + from MariaDB 10.4</link>. unix_socket auth plugin does not use + a password, and uses the connecting user's UID instead. When a + new MariaDB data directory is initialized, two MariaDB users + are created and can be used with new unix_socket auth plugin, + as well as traditional mysql_native_password plugin: + root@localhost and mysql@localhost. To actually use the + traditional mysql_native_password plugin method, one must run + the following: + </para> + <programlisting language="bash"> +{ +services.mysql.initialScript = pkgs.writeText "mariadb-init.sql" '' + ALTER USER root@localhost IDENTIFIED VIA mysql_native_password USING PASSWORD("verysecret"); +''; +} +</programlisting> + <para> + When MariaDB data directory is just upgraded (not + initialized), the users are not created or modified. + </para> + </listitem> + <listitem> + <para> + MySQL server is now started with additional systemd + sandbox/hardening options for better security. The PrivateTmp, + ProtectHome, and ProtectSystem options may be problematic when + MySQL is attempting to read from or write to your filesystem + anywhere outside of its own state directory, for example when + calling + <literal>LOAD DATA INFILE or SELECT * INTO OUTFILE</literal>. + In this scenario a variant of the following may be required: - + allow MySQL to read from /home and /tmp directories when using + <literal>LOAD DATA INFILE</literal> + </para> + <programlisting language="bash"> +{ + systemd.services.mysql.serviceConfig.ProtectHome = lib.mkForce "read-only"; +} +</programlisting> + <para> + - allow MySQL to write to custom folder + <literal>/var/data</literal> when using + <literal>SELECT * INTO OUTFILE</literal>, assuming the mysql + user has write access to <literal>/var/data</literal> + </para> + <programlisting language="bash"> +{ + systemd.services.mysql.serviceConfig.ReadWritePaths = [ "/var/data" ]; +} +</programlisting> + <para> + The MySQL service no longer runs its + <literal>systemd</literal> service startup script as + <literal>root</literal> anymore. A dedicated non + <literal>root</literal> super user account is required for + operation. This means users with an existing MySQL or MariaDB + database server are required to run the following SQL + statements as a super admin user before upgrading: + </para> + <programlisting language="SQL"> +CREATE USER IF NOT EXISTS 'mysql'@'localhost' identified with unix_socket; +GRANT ALL PRIVILEGES ON *.* TO 'mysql'@'localhost' WITH GRANT OPTION; +</programlisting> + <para> + If you use MySQL instead of MariaDB please replace + <literal>unix_socket</literal> with + <literal>auth_socket</literal>. If you have changed the value + of + <link xlink:href="options.html#opt-services.mysql.user">services.mysql.user</link> + from the default of <literal>mysql</literal> to a different + user please change <literal>'mysql'@'localhost'</literal> to + the corresponding user instead. + </para> + </listitem> + <listitem> + <para> + Zabbix now defaults to 5.0, updated from 4.4. Please carefully + read through + <link xlink:href="https://www.zabbix.com/documentation/current/manual/installation/upgrade/sources">the + upgrade guide</link> and apply any changes required. Be sure + to take special note of the section on + <link xlink:href="https://www.zabbix.com/documentation/current/manual/installation/upgrade_notes_500#enabling_extended_range_of_numeric_float_values">enabling + extended range of numeric (float) values</link> as you will + need to apply this database migration manually. + </para> + <para> + If you are using Zabbix Server with a MySQL or MariaDB + database you should note that using a character set of + <literal>utf8</literal> and a collate of + <literal>utf8_bin</literal> has become mandatory with this + release. See the upstream + <link xlink:href="https://support.zabbix.com/browse/ZBX-17357">issue</link> + for further discussion. Before upgrading you should check the + character set and collation used by your database and ensure + they are correct: + </para> + <programlisting language="SQL"> +SELECT + default_character_set_name, + default_collation_name +FROM + information_schema.schemata +WHERE + schema_name = 'zabbix'; +</programlisting> + <para> + If these values are not correct you should take a backup of + your database and convert the character set and collation as + required. Here is an + <link xlink:href="https://www.zabbix.com/forum/zabbix-help/396573-reinstall-after-upgrade?p=396891#post396891">example</link> + of how to do so, taken from the Zabbix forums: + </para> + <programlisting language="SQL"> +ALTER DATABASE `zabbix` DEFAULT CHARACTER SET utf8 COLLATE utf8_bin; + +-- the following will produce a list of SQL commands you should subsequently execute +SELECT CONCAT("ALTER TABLE ", TABLE_NAME," CONVERT TO CHARACTER SET utf8 COLLATE utf8_bin;") AS ExecuteTheString +FROM information_schema.`COLUMNS` +WHERE table_schema = "zabbix" AND COLLATION_NAME = "utf8_general_ci"; +</programlisting> + </listitem> + <listitem> + <para> + maxx package removed along with + <literal>services.xserver.desktopManager.maxx</literal> + module. Please migrate to cdesktopenv and + <literal>services.xserver.desktopManager.cde</literal> module. + </para> + </listitem> + <listitem> + <para> + The + <link xlink:href="options.html#opt-services.matrix-synapse.enable">matrix-synapse</link> + module no longer includes optional dependencies by default, + they have to be added through the + <link xlink:href="options.html#opt-services.matrix-synapse.plugins">plugins</link> + option. + </para> + </listitem> + <listitem> + <para> + <literal>buildGoModule</literal> now internally creates a + vendor directory in the source tree for downloaded modules + instead of using go's + <link xlink:href="https://golang.org/cmd/go/#hdr-Module_proxy_protocol">module + proxy protocol</link>. This storage format is simpler and + therefore less likely to break with future versions of go. As + a result <literal>buildGoModule</literal> switched from + <literal>modSha256</literal> to the + <literal>vendorSha256</literal> attribute to pin fetched + version data. + </para> + </listitem> + <listitem> + <para> + Grafana is now built without support for phantomjs by default. + Phantomjs support has been + <link xlink:href="https://grafana.com/docs/grafana/latest/guides/whats-new-in-v6-4/">deprecated + in Grafana</link> and the phantomjs project is + <link xlink:href="https://github.com/ariya/phantomjs/issues/15344#issue-302015362">currently + unmaintained</link>. It can still be enabled by providing + <literal>phantomJsSupport = true</literal> to the package + instantiation: + </para> + <programlisting language="bash"> +{ + services.grafana.package = pkgs.grafana.overrideAttrs (oldAttrs: rec { + phantomJsSupport = true; + }); +} +</programlisting> + </listitem> + <listitem> + <para> + The + <link xlink:href="options.html#opt-services.supybot.enable">supybot</link> + module now uses <literal>/var/lib/supybot</literal> as its + default + <link xlink:href="options.html#opt-services.supybot.stateDir">stateDir</link> + path if <literal>stateVersion</literal> is 20.09 or higher. It + also enables a number of + <link xlink:href="https://www.freedesktop.org/software/systemd/man/systemd.exec.html#Sandboxing">systemd + sandboxing options</link> which may possibly interfere with + some plugins. If this is the case you can disable the options + through attributes in + <literal>systemd.services.supybot.serviceConfig</literal>. + </para> + </listitem> + <listitem> + <para> + The <literal>security.duosec.skey</literal> option, which + stored a secret in the nix store, has been replaced by a new + <link xlink:href="options.html#opt-security.duosec.secretKeyFile">security.duosec.secretKeyFile</link> + option for better security. + </para> + <para> + <literal>security.duosec.ikey</literal> has been renamed to + <link xlink:href="options.html#opt-security.duosec.integrationKey">security.duosec.integrationKey</link>. + </para> + </listitem> + <listitem> + <para> + <literal>vmware</literal> has been removed from the + <literal>services.x11.videoDrivers</literal> defaults. For + VMWare guests set + <literal>virtualisation.vmware.guest.enable</literal> to + <literal>true</literal> which will include the appropriate + drivers. + </para> + </listitem> + <listitem> + <para> + The initrd SSH support now uses OpenSSH rather than Dropbear + to allow the use of Ed25519 keys and other OpenSSH-specific + functionality. Host keys must now be in the OpenSSH format, + and at least one pre-generated key must be specified. + </para> + <para> + If you used the + <literal>boot.initrd.network.ssh.host*Key</literal> options, + you'll get an error explaining how to convert your host keys + and migrate to the new + <literal>boot.initrd.network.ssh.hostKeys</literal> option. + Otherwise, if you don't have any host keys set, you'll need to + generate some; see the <literal>hostKeys</literal> option + documentation for instructions. + </para> + </listitem> + <listitem> + <para> + Since this release there's an easy way to customize your PHP + install to get a much smaller base PHP with only wanted + extensions enabled. See the following snippet installing a + smaller PHP with the extensions <literal>imagick</literal>, + <literal>opcache</literal>, <literal>pdo</literal> and + <literal>pdo_mysql</literal> loaded: + </para> + <programlisting language="bash"> +{ + environment.systemPackages = [ + (pkgs.php.withExtensions + ({ all, ... }: with all; [ + imagick + opcache + pdo + pdo_mysql + ]) + ) + ]; +} +</programlisting> + <para> + The default <literal>php</literal> attribute hasn't lost any + extensions. The <literal>opcache</literal> extension has been + added. All upstream PHP extensions are available under + php.extensions.<name?>. + </para> + <para> + All PHP <literal>config</literal> flags have been removed for + the following reasons: + </para> + </listitem> + <listitem> + <para> + The updated <literal>php</literal> attribute is now easily + customizable to your liking by using + <literal>php.withExtensions</literal> or + <literal>php.buildEnv</literal> instead of writing config + files or changing configure flags. + </para> + </listitem> + <listitem> + <para> + The remaining configuration flags can now be set directly on + the <literal>php</literal> attribute. For example, instead of + </para> + <programlisting language="bash"> +{ + php.override { + config.php.embed = true; + config.php.apxs2 = false; + } +} +</programlisting> + <para> + you should now write + </para> + <programlisting language="bash"> +{ + php.override { + embedSupport = true; + apxs2Support = false; + } +} +</programlisting> + </listitem> + <listitem> + <para> + The ACME module has been overhauled for simplicity and + maintainability. Cert generation now implicitly uses the + <literal>acme</literal> user, and the + <literal>security.acme.certs._name_.user</literal> option has + been removed. Instead, certificate access from other services + is now managed through group permissions. The module no longer + runs lego twice under certain conditions, and will correctly + renew certificates if their configuration is changed. Services + which reload nginx and httpd after certificate renewal are now + properly configured too so you no longer have to do this + manually if you are using HTTPS enabled virtual hosts. A + mechanism for regenerating certs on demand has also been added + and documented. + </para> + </listitem> + <listitem> + <para> + Gollum received a major update to version 5.x and you may have + to change some links in your wiki when migrating from gollum + 4.x. More information can be found + <link xlink:href="https://github.com/gollum/gollum/wiki/5.0-release-notes#migrating-your-wiki">here</link>. + </para> + </listitem> + <listitem> + <para> + Deluge 2.x was added and is used as default for new NixOS + installations where stateVersion is >= 20.09. If you are + upgrading from a previous NixOS version, you can set + <literal>service.deluge.package = pkgs.deluge-2_x</literal> to + upgrade to Deluge 2.x and migrate the state to the new format. + Be aware that backwards state migrations are not supported by + Deluge. + </para> + </listitem> + <listitem> + <para> + Nginx web server now starting with additional + sandbox/hardening options. By default, write access to + <literal>/var/log/nginx</literal> and + <literal>/var/cache/nginx</literal> is allowed. To allow + writing to other folders, use + <literal>systemd.services.nginx.serviceConfig.ReadWritePaths</literal> + </para> + <programlisting language="bash"> +{ + systemd.services.nginx.serviceConfig.ReadWritePaths = [ "/var/www" ]; +} +</programlisting> + <para> + Nginx is also started with the systemd option + <literal>ProtectHome = mkDefault true;</literal> which forbids + it to read anything from <literal>/home</literal>, + <literal>/root</literal> and <literal>/run/user</literal> (see + <link xlink:href="https://www.freedesktop.org/software/systemd/man/systemd.exec.html#ProtectHome=">ProtectHome + docs</link> for details). If you require serving files from + home directories, you may choose to set e.g. + </para> + <programlisting language="bash"> +{ + systemd.services.nginx.serviceConfig.ProtectHome = "read-only"; +} +</programlisting> + </listitem> + <listitem> + <para> + The NixOS options <literal>nesting.clone</literal> and + <literal>nesting.children</literal> have been deleted, and + replaced with named + <link xlink:href="options.html#opt-specialisation">specialisation</link> + configurations. + </para> + <para> + Replace a <literal>nesting.clone</literal> entry with: + </para> + <programlisting language="bash"> +{ + specialisation.example-sub-configuration = { + configuration = { + ... + }; +}; +</programlisting> + <para> + Replace a <literal>nesting.children</literal> entry with: + </para> + <programlisting language="bash"> +{ + specialisation.example-sub-configuration = { + inheritParentConfig = false; + configuration = { + ... + }; +}; +</programlisting> + <para> + To switch to a specialised configuration at runtime you need + to run: + </para> + <programlisting> +$ sudo /run/current-system/specialisation/example-sub-configuration/bin/switch-to-configuration test +</programlisting> + <para> + Before you would have used: + </para> + <programlisting> +$ sudo /run/current-system/fine-tune/child-1/bin/switch-to-configuration test +</programlisting> + </listitem> + <listitem> + <para> + The Nginx log directory has been moved to + <literal>/var/log/nginx</literal>, the cache directory to + <literal>/var/cache/nginx</literal>. The option + <literal>services.nginx.stateDir</literal> has been removed. + </para> + </listitem> + <listitem> + <para> + The httpd web server previously started its main process as + root privileged, then ran worker processes as a less + privileged identity user. This was changed to start all of + httpd as a less privileged user (defined by + <link xlink:href="options.html#opt-services.httpd.user">services.httpd.user</link> + and + <link xlink:href="options.html#opt-services.httpd.group">services.httpd.group</link>). + As a consequence, all files that are needed for httpd to run + (included configuration fragments, SSL certificates and keys, + etc.) must now be readable by this less privileged user/group. + </para> + <para> + The default value for + <link xlink:href="options.html#opt-services.httpd.mpm">services.httpd.mpm</link> + has been changed from <literal>prefork</literal> to + <literal>event</literal>. Along with this change the default + value for + <link xlink:href="options.html#opt-services.httpd.virtualHosts">services.httpd.virtualHosts.<name>.http2</link> + has been set to <literal>true</literal>. + </para> + </listitem> + <listitem> + <para> + The <literal>systemd-networkd</literal> option + <literal>systemd.network.networks.<name>.dhcp.CriticalConnection</literal> + has been removed following upstream systemd's deprecation of + the same. It is recommended to use + <literal>systemd.network.networks.<name>.networkConfig.KeepConfiguration</literal> + instead. See systemd.network 5 for details. + </para> + </listitem> + <listitem> + <para> + The <literal>systemd-networkd</literal> option + <literal>systemd.network.networks._name_.dhcpConfig</literal> + has been renamed to + <link xlink:href="options.html#opt-systemd.network.networks._name_.dhcpV4Config">systemd.network.networks.<emphasis>name</emphasis>.dhcpV4Config</link> + following upstream systemd's documentation change. See + systemd.network 5 for details. + </para> + </listitem> + <listitem> + <para> + In the <literal>picom</literal> module, several options that + accepted floating point numbers encoded as strings (for + example + <link xlink:href="options.html#opt-services.picom.activeOpacity">services.picom.activeOpacity</link>) + have been changed to the (relatively) new native + <literal>float</literal> type. To migrate your configuration + simply remove the quotes around the numbers. + </para> + </listitem> + <listitem> + <para> + When using <literal>buildBazelPackage</literal> from Nixpkgs, + <literal>flat</literal> hash mode is now used for dependencies + instead of <literal>recursive</literal>. This is to better + allow using hashed mirrors where needed. As a result, these + hashes will have changed. + </para> + </listitem> + <listitem> + <para> + The syntax of the PostgreSQL configuration file is now checked + at build time. If your configuration includes a file + inaccessible inside the build sandbox, set + <literal>services.postgresql.checkConfig</literal> to + <literal>false</literal>. + </para> + </listitem> + <listitem> + <para> + The rkt module has been removed, it was archived by upstream. + </para> + </listitem> + <listitem> + <para> + The + <link xlink:href="https://bazaar.canonical.com">Bazaar</link> + VCS is unmaintained and, as consequence of the Python 2 EOL, + the packages <literal>bazaar</literal> and + <literal>bazaarTools</literal> were removed. Breezy, the + backward compatible fork of Bazaar (see the + <link xlink:href="https://www.jelmer.uk/breezy-intro.html">announcement</link>), + was packaged as <literal>breezy</literal> and can be used + instead. + </para> + <para> + Regarding Nixpkgs, <literal>fetchbzr</literal>, + <literal>nix-prefetch-bzr</literal> and Bazaar support in + Hydra will continue to work through Breezy. + </para> + </listitem> + <listitem> + <para> + In addition to the hostname, the fully qualified domain name + (FQDN), which consists of + <literal>${networking.hostName}</literal> and + <literal>${networking.domain}</literal> is now added to + <literal>/etc/hosts</literal>, to allow local FQDN resolution, + as used by the <literal>hostname --fqdn</literal> command and + other applications that try to determine the FQDN. These new + entries take precedence over entries from the DNS which could + cause regressions in some very specific setups. Additionally + the hostname is now resolved to <literal>127.0.0.2</literal> + instead of <literal>127.0.1.1</literal> to be consistent with + what <literal>nss-myhostname</literal> (from systemd) returns. + The old behaviour can e.g. be restored by using + <literal>networking.hosts = lib.mkForce { "127.0.1.1" = [ config.networking.hostName ]; };</literal>. + </para> + </listitem> + <listitem> + <para> + The hostname (<literal>networking.hostName</literal>) must now + be a valid DNS label (see RFC 1035, RFC 1123) and as such must + not contain the domain part. This means that the hostname must + start with a letter or digit, end with a letter or digit, and + have as interior characters only letters, digits, and hyphen. + The maximum length is 63 characters. Additionally it is + recommended to only use lower-case characters. If (e.g. for + legacy reasons) a FQDN is required as the Linux kernel network + node hostname (<literal>uname --nodename</literal>) the option + <literal>boot.kernel.sysctl."kernel.hostname"</literal> + can be used as a workaround (but be aware of the 64 character + limit). + </para> + </listitem> + <listitem> + <para> + The GRUB specific option + <literal>boot.loader.grub.extraInitrd</literal> has been + replaced with the generic option + <literal>boot.initrd.secrets</literal>. This option creates a + secondary initrd from the specified files, rather than using a + manually created initrd file. Due to an existing bug with + <literal>boot.loader.grub.extraInitrd</literal>, it is not + possible to directly boot an older generation that used that + option. It is still possible to rollback to that generation if + the required initrd file has not been deleted. + </para> + </listitem> + <listitem> + <para> + The + <link xlink:href="https://github.com/okTurtles/dnschain">DNSChain</link> + package and NixOS module have been removed from Nixpkgs as the + software is unmaintained and can't be built. For more + information see issue + <link xlink:href="https://github.com/NixOS/nixpkgs/issues/89205">#89205</link>. + </para> + </listitem> + <listitem> + <para> + In the <literal>resilio</literal> module, + <link xlink:href="options.html#opt-services.resilio.httpListenAddr">services.resilio.httpListenAddr</link> + has been changed to listen to <literal>[::1]</literal> instead + of <literal>0.0.0.0</literal>. + </para> + </listitem> + <listitem> + <para> + <literal>sslh</literal> has been updated to version + <literal>1.21</literal>. The <literal>ssl</literal> probe must + be renamed to <literal>tls</literal> in + <link xlink:href="options.html#opt-services.sslh.appendConfig">services.sslh.appendConfig</link>. + </para> + </listitem> + <listitem> + <para> + Users of <link xlink:href="http://openafs.org">OpenAFS + 1.6</link> must upgrade their services to OpenAFS 1.8! In this + release, the OpenAFS package version 1.6.24 is marked broken + but can be used during transition to OpenAFS 1.8.x. Use the + options + <literal>services.openafsClient.packages.module</literal>, + <literal>services.openafsClient.packages.programs</literal> + and <literal>services.openafsServer.package</literal> to + select a different OpenAFS package. OpenAFS 1.6 will be + removed in the next release. The package + <literal>openafs</literal> and the service options will then + silently point to the OpenAFS 1.8 release. + </para> + <para> + See also the OpenAFS + <link xlink:href="http://docs.openafs.org/AdminGuide/index.html">Administrator + Guide</link> for instructions. Beware of the following when + updating servers: + </para> + <itemizedlist> + <listitem> + <para> + The storage format of the server key has changed and the + key must be converted before running the new release. + </para> + </listitem> + <listitem> + <para> + When updating multiple database servers, turn off the + database servers from the highest IP down to the lowest + with resting periods in between. Start up in reverse + order. Do not concurrently run database servers working + with different OpenAFS releases! + </para> + </listitem> + <listitem> + <para> + Update servers first, then clients. + </para> + </listitem> + </itemizedlist> + </listitem> + <listitem> + <para> + Radicale's default package has changed from 2.x to 3.x. An + upgrade checklist can be found + <link xlink:href="https://github.com/Kozea/Radicale/blob/3.0.x/NEWS.md#upgrade-checklist">here</link>. + You can use the newer version in the NixOS service by setting + the <literal>package</literal> to + <literal>radicale3</literal>, which is done automatically if + <literal>stateVersion</literal> is 20.09 or higher. + </para> + </listitem> + <listitem> + <para> + <literal>udpt</literal> experienced a complete rewrite from + C++ to rust. The configuration format changed from ini to + toml. The new configuration documentation can be found at + <link xlink:href="https://naim94a.github.io/udpt/config.html">the + official website</link> and example configuration is packaged + in <literal>${udpt}/share/udpt/udpt.toml</literal>. + </para> + </listitem> + <listitem> + <para> + We now have a unified + <link xlink:href="options.html#opt-services.xserver.displayManager.autoLogin">services.xserver.displayManager.autoLogin</link> + option interface to be used for every display-manager in + NixOS. + </para> + </listitem> + <listitem> + <para> + The <literal>bitcoind</literal> module has changed to + multi-instance, using submodules. Therefore, it is now + mandatory to name each instance. To use this new + multi-instance config with an existing bitcoind data directory + and user, you have to adjust the original config, e.g.: + </para> + <programlisting language="bash"> +{ + services.bitcoind = { + enable = true; + extraConfig = "..."; + ... + }; +} +</programlisting> + <para> + To something similar: + </para> + <programlisting language="bash"> +{ + services.bitcoind.mainnet = { + enable = true; + dataDir = "/var/lib/bitcoind"; + user = "bitcoin"; + extraConfig = "..."; + ... + }; +} +</programlisting> + <para> + The key settings are: + </para> + <itemizedlist> + <listitem> + <para> + <literal>dataDir</literal> - to continue using the same + data directory. + </para> + </listitem> + <listitem> + <para> + <literal>user</literal> - to continue using the same user + so that bitcoind maintains access to its files. + </para> + </listitem> + </itemizedlist> + </listitem> + <listitem> + <para> + Graylog introduced a change in the LDAP server certificate + validation behaviour for version 3.3.3 which might break + existing setups. When updating Graylog from a version before + 3.3.3 make sure to check the Graylog + <link xlink:href="https://www.graylog.org/post/announcing-graylog-v3-3-3">release + info</link> for information on how to avoid the issue. + </para> + </listitem> + <listitem> + <para> + The <literal>dokuwiki</literal> module has changed to + multi-instance, using submodules. Therefore, it is now + mandatory to name each instance. Moreover, forcing SSL by + default has been dropped, so <literal>nginx.forceSSL</literal> + and <literal>nginx.enableACME</literal> are no longer set to + <literal>true</literal>. To continue using your service with + the original SSL settings, you have to adjust the original + config, e.g.: + </para> + <programlisting language="bash"> +{ + services.dokuwiki = { + enable = true; + ... + }; +} +</programlisting> + <para> + To something similar: + </para> + <programlisting language="bash"> +{ + services.dokuwiki."mywiki" = { + enable = true; + nginx = { + forceSSL = true; + enableACME = true; + }; + ... + }; +} +</programlisting> + <para> + The base package has also been upgraded to the 2020-07-29 + "Hogfather" release. Plugins might be incompatible + or require upgrading. + </para> + </listitem> + <listitem> + <para> + The + <link xlink:href="options.html#opt-services.postgresql.dataDir">services.postgresql.dataDir</link> + option is now set to + <literal>"/var/lib/postgresql/${cfg.package.psqlSchema}"</literal> + regardless of your + <link xlink:href="options.html#opt-system.stateVersion">system.stateVersion</link>. + Users with an existing postgresql install that have a + <link xlink:href="options.html#opt-system.stateVersion">system.stateVersion</link> + of <literal>17.03</literal> or below should double check what + the value of their + <link xlink:href="options.html#opt-services.postgresql.dataDir">services.postgresql.dataDir</link> + option is (<literal>/var/db/postgresql</literal>) and then + explicitly set this value to maintain compatibility: + </para> + <programlisting language="bash"> +{ + services.postgresql.dataDir = "/var/db/postgresql"; +} +</programlisting> + <para> + The postgresql module now expects there to be a database super + user account called <literal>postgres</literal> regardless of + your + <link xlink:href="options.html#opt-system.stateVersion">system.stateVersion</link>. + Users with an existing postgresql install that have a + <link xlink:href="options.html#opt-system.stateVersion">system.stateVersion</link> + of <literal>17.03</literal> or below should run the following + SQL statements as a database super admin user before + upgrading: + </para> + <programlisting language="SQL"> +CREATE ROLE postgres LOGIN SUPERUSER; +</programlisting> + </listitem> + <listitem> + <para> + The USBGuard module now removes options and instead hardcodes + values for <literal>IPCAccessControlFiles</literal>, + <literal>ruleFiles</literal>, and + <literal>auditFilePath</literal>. Audit logs can be found in + the journal. + </para> + </listitem> + <listitem> + <para> + The NixOS module system now evaluates option definitions more + strictly, allowing it to detect a larger set of problems. As a + result, what previously evaluated may not do so anymore. See + <link xlink:href="https://github.com/NixOS/nixpkgs/pull/82743#issuecomment-674520472">the + PR that changed this</link> for more info. + </para> + </listitem> + <listitem> + <para> + For NixOS configuration options, the type + <literal>loaOf</literal>, after its initial deprecation in + release 20.03, has been removed. In NixOS and Nixpkgs options + using this type have been converted to + <literal>attrsOf</literal>. For more information on this + change have look at these links: + <link xlink:href="https://github.com/NixOS/nixpkgs/issues/1800">issue + #1800</link>, + <link xlink:href="https://github.com/NixOS/nixpkgs/pull/63103">PR + #63103</link>. + </para> + </listitem> + <listitem> + <para> + <literal>config.systemd.services.${name}.path</literal> now + returns a list of paths instead of a colon-separated string. + </para> + </listitem> + <listitem> + <para> + Caddy module now uses Caddy v2 by default. Caddy v1 can still + be used by setting + <link xlink:href="options.html#opt-services.caddy.package">services.caddy.package</link> + to <literal>pkgs.caddy1</literal>. + </para> + <para> + New option + <link xlink:href="options.html#opt-services.caddy.adapter">services.caddy.adapter</link> + has been added. + </para> + </listitem> + <listitem> + <para> + The + <link xlink:href="options.html#opt-services.jellyfin.enable">jellyfin</link> + module will use and stay on the Jellyfin version + <literal>10.5.5</literal> if <literal>stateVersion</literal> + is lower than <literal>20.09</literal>. This is because + significant changes were made to the database schema, and it + is highly recommended to backup your instance before + upgrading. After making your backup, you can upgrade to the + latest version either by setting your + <literal>stateVersion</literal> to <literal>20.09</literal> or + higher, or set the + <literal>services.jellyfin.package</literal> to + <literal>pkgs.jellyfin</literal>. If you do not wish to + upgrade Jellyfin, but want to change your + <literal>stateVersion</literal>, you can set the value of + <literal>services.jellyfin.package</literal> to + <literal>pkgs.jellyfin_10_5</literal>. + </para> + </listitem> + <listitem> + <para> + The <literal>security.rngd</literal> service is now disabled + by default. This choice was made because there's krngd in the + linux kernel space making it (for most usecases) functionally + redundent. + </para> + </listitem> + <listitem> + <para> + The <literal>hardware.nvidia.optimus_prime.enable</literal> + service has been renamed to + <literal>hardware.nvidia.prime.sync.enable</literal> and has + many new enhancements. Related nvidia prime settings may have + also changed. + </para> + </listitem> + <listitem> + <para> + The package nextcloud17 has been removed and nextcloud18 was + marked as insecure since both of them will + <link xlink:href="https://docs.nextcloud.com/server/19/admin_manual/release_schedule.html"> + will be EOL (end of life) within the lifetime of 20.09</link>. + </para> + <para> + It's necessary to upgrade to nextcloud19: + </para> + <itemizedlist> + <listitem> + <para> + From nextcloud17, you have to upgrade to nextcloud18 first + as Nextcloud doesn't allow going multiple major revisions + forward in a single upgrade. This is possible by setting + <link xlink:href="options.html#opt-services.nextcloud.package">services.nextcloud.package</link> + to nextcloud18. + </para> + </listitem> + <listitem> + <para> + From nextcloud18, it's possible to directly upgrade to + nextcloud19 by setting + <link xlink:href="options.html#opt-services.nextcloud.package">services.nextcloud.package</link> + to nextcloud19. + </para> + </listitem> + </itemizedlist> + </listitem> + <listitem> + <para> + The GNOME desktop manager no longer default installs + gnome3.epiphany. It was chosen to do this as it has a + usability breaking issue (see issue + <link xlink:href="https://github.com/NixOS/nixpkgs/issues/98819">#98819</link>) + that makes it unsuitable to be a default app. + </para> + <note> + <para> + Issue + <link xlink:href="https://github.com/NixOS/nixpkgs/issues/98819">#98819</link> + is now fixed and gnome3.epiphany is once again installed by + default. + </para> + </note> + </listitem> + <listitem> + <para> + If you want to manage the configuration of wpa_supplicant + outside of NixOS you must ensure that none of + <link xlink:href="options.html#opt-networking.wireless.networks">networking.wireless.networks</link>, + <link xlink:href="options.html#opt-networking.wireless.extraConfig">networking.wireless.extraConfig</link> + or + <link xlink:href="options.html#opt-networking.wireless.userControlled.enable">networking.wireless.userControlled.enable</link> + is being used or <literal>true</literal>. Using any of those + options will cause wpa_supplicant to be started with a NixOS + generated configuration file instead of your own. + </para> + </listitem> + </itemizedlist> + </section> + <section xml:id="sec-release-20.09-notable-changes"> + <title>Other Notable Changes</title> + <itemizedlist> + <listitem> + <para> + SD images are now compressed by default using + <literal>zstd</literal>. The compression for ISO images has + also been changed to <literal>zstd</literal>, but ISO images + are still not compressed by default. + </para> + </listitem> + <listitem> + <para> + <literal>services.journald.rateLimitBurst</literal> was + updated from <literal>1000</literal> to + <literal>10000</literal> to follow the new upstream systemd + default. + </para> + </listitem> + <listitem> + <para> + The notmuch package move its emacs-related binaries and emacs + lisp files to a separate output. They're not part of the + default <literal>out</literal> output anymore - if you relied + on the <literal>notmuch-emacs-mua</literal> binary or the + emacs lisp files, access them via the + <literal>notmuch.emacs</literal> output. Device tree overlay + support was improved in + <link xlink:href="https://github.com/NixOS/nixpkgs/pull/79370">#79370</link> + and now uses + <link xlink:href="options.html#opt-hardware.deviceTree.kernelPackage">hardware.deviceTree.kernelPackage</link> + instead of <literal>hardware.deviceTree.base</literal>. + <link xlink:href="options.html#opt-hardware.deviceTree.overlays">hardware.deviceTree.overlays</link> + configuration was extended to support <literal>.dts</literal> + files with symbols. Device trees can now be filtered by + setting + <link xlink:href="options.html#opt-hardware.deviceTree.filter">hardware.deviceTree.filter</link> + option. + </para> + </listitem> + <listitem> + <para> + The default output of <literal>buildGoPackage</literal> is now + <literal>$out</literal> instead of <literal>$bin</literal>. + </para> + </listitem> + <listitem> + <para> + <literal>buildGoModule</literal> <literal>doCheck</literal> + now defaults to <literal>true</literal>. + </para> + </listitem> + <listitem> + <para> + Packages built using <literal>buildRustPackage</literal> now + use <literal>release</literal> mode for the + <literal>checkPhase</literal> by default. + </para> + <para> + Please note that Rust packages utilizing a custom + build/install procedure (e.g. by using a + <literal>Makefile</literal>) or test suites that rely on the + structure of the <literal>target/</literal> directory may + break due to those assumptions. For further information, + please read the Rust section in the Nixpkgs manual. + </para> + </listitem> + <listitem> + <para> + The cc- and binutils-wrapper's "infix salt" and + <literal>_BUILD_</literal> and <literal>_TARGET_</literal> + user infixes have been replaced with with a "suffix + salt" and suffixes and <literal>_FOR_BUILD</literal> and + <literal>_FOR_TARGET</literal>. This matches the autotools + convention for env vars which standard for these things, + making interfacing with other tools easier. + </para> + </listitem> + <listitem> + <para> + Additional Git documentation (HTML and text files) is now + available via the <literal>git-doc</literal> package. + </para> + </listitem> + <listitem> + <para> + Default algorithm for ZRAM swap was changed to + <literal>zstd</literal>. + </para> + </listitem> + <listitem> + <para> + The installer now enables sshd by default. This improves + installation on headless machines especially ARM + single-board-computer. To login through ssh, either a password + or an ssh key must be set for the root user or the nixos user. + </para> + </listitem> + <listitem> + <para> + The scripted networking system now uses + <literal>.link</literal> files in + <literal>/etc/systemd/network</literal> to configure mac + address and link MTU, instead of the sometimes buggy + <literal>network-link-*</literal> units, which have been + removed. Bringing the interface up has been moved to the + beginning of the <literal>network-addresses-*</literal> unit. + Note this doesn't require <literal>systemd-networkd</literal> + - it's udev that parses <literal>.link</literal> files. Extra + care needs to be taken in the presence of + <link xlink:href="https://wiki.debian.org/NetworkInterfaceNames#THE_.22PERSISTENT_NAMES.22_SCHEME">legacy + udev rules</link> to rename interfaces, as MAC Address and MTU + defined in these options can only match on the original link + name. In such cases, you most likely want to create a + <literal>10-*.link</literal> file through + <link xlink:href="options.html#opt-systemd.network.links">systemd.network.links</link> + and set both name and MAC Address / MTU there. + </para> + </listitem> + <listitem> + <para> + Grafana received a major update to version 7.x. A plugin is + now needed for image rendering support, and plugins must now + be signed by default. More information can be found + <link xlink:href="https://grafana.com/docs/grafana/latest/installation/upgrading/#upgrading-to-v7-0">in + the Grafana documentation</link>. + </para> + </listitem> + <listitem> + <para> + The <literal>hardware.u2f</literal> module, which was + installing udev rules was removed, as udev gained native + support to handle FIDO security tokens. + </para> + </listitem> + <listitem> + <para> + The <literal>services.transmission</literal> module was + enhanced with the new options: + <link xlink:href="options.html#opt-services.transmission.credentialsFile">services.transmission.credentialsFile</link>, + <link xlink:href="options.html#opt-services.transmission.openFirewall">services.transmission.openFirewall</link>, + and + <link xlink:href="options.html#opt-services.transmission.performanceNetParameters">services.transmission.performanceNetParameters</link>. + </para> + <para> + <literal>transmission-daemon</literal> is now started with + additional systemd sandbox/hardening options for better + security. Please + <link xlink:href="https://github.com/NixOS/nixpkgs/issues">report</link> + any use case where this is not working well. In particular, + the <literal>RootDirectory</literal> option newly set forbids + uploading or downloading a torrent outside of the default + directory configured at + <link xlink:href="options.html#opt-services.transmission.settings">settings.download-dir</link>. + If you really need Transmission to access other directories, + you must include those directories into the + <literal>BindPaths</literal> of the service: + </para> + <programlisting language="bash"> +{ + systemd.services.transmission.serviceConfig.BindPaths = [ "/path/to/alternative/download-dir" ]; +} +</programlisting> + <para> + Also, connection to the RPC (Remote Procedure Call) of + <literal>transmission-daemon</literal> is now only available + on the local network interface by default. Use: + </para> + <programlisting language="bash"> +{ + services.transmission.settings.rpc-bind-address = "0.0.0.0"; +} +</programlisting> + <para> + to get the previous behavior of listening on all network + interfaces. + </para> + </listitem> + <listitem> + <para> + With this release <literal>systemd-networkd</literal> (when + enabled through + <link xlink:href="options.html#opt-networking.useNetworkd">networking.useNetworkd</link>) + has it's netlink socket created through a + <literal>systemd.socket</literal> unit. This gives us control + over socket buffer sizes and other parameters. For larger + setups where networkd has to create a lot of (virtual) devices + the default buffer size (currently 128MB) is not enough. + </para> + <para> + On a machine with >100 virtual interfaces (e.g., wireguard + tunnels, VLANs, …), that all have to be brought up during + system startup, the receive buffer size will spike for a brief + period. Eventually some of the message will be dropped since + there is not enough (permitted) buffer space available. + </para> + <para> + By having <literal>systemd-networkd</literal> start with a + netlink socket created by <literal>systemd</literal> we can + configure the <literal>ReceiveBufferSize=</literal> parameter + in the socket options (i.e. + <literal>systemd.sockets.systemd-networkd.socketOptions.ReceiveBufferSize</literal>) + without recompiling <literal>systemd-networkd</literal>. + </para> + <para> + Since the actual memory requirements depend on hardware, + timing, exact configurations etc. it isn't currently possible + to infer a good default from within the NixOS module system. + Administrators are advised to monitor the logs of + <literal>systemd-networkd</literal> for + <literal>rtnl: kernel receive buffer overrun</literal> spam + and increase the memory limit as they see fit. + </para> + <para> + Note: Increasing the <literal>ReceiveBufferSize=</literal> + doesn't allocate any memory. It just increases the upper bound + on the kernel side. The memory allocation depends on the + amount of messages that are queued on the kernel side of the + netlink socket. + </para> + </listitem> + <listitem> + <para> + Specifying + <link xlink:href="options.html#opt-services.dovecot2.mailboxes">mailboxes</link> + in the dovecot2 module as a list is deprecated and will break + eval in 21.05. Instead, an attribute-set should be specified + where the <literal>name</literal> should be the key of the + attribute. + </para> + <para> + This means that a configuration like this + </para> + <programlisting language="bash"> +{ + services.dovecot2.mailboxes = [ + { name = "Junk"; + auto = "create"; + } + ]; +} +</programlisting> + <para> + should now look like this: + </para> + <programlisting language="bash"> +{ + services.dovecot2.mailboxes = { + Junk.auto = "create"; + }; +} +</programlisting> + </listitem> + <listitem> + <para> + netbeans was upgraded to 12.0 and now defaults to OpenJDK 11. + This might cause problems if your projects depend on packages + that were removed in Java 11. + </para> + </listitem> + <listitem> + <para> + nextcloud has been updated to + <link xlink:href="https://nextcloud.com/blog/nextcloud-hub-brings-productivity-to-home-office/">v19</link>. + </para> + <para> + If you have an existing installation, please make sure that + you're on nextcloud18 before upgrading to nextcloud19 since + Nextcloud doesn't support upgrades across multiple major + versions. + </para> + </listitem> + <listitem> + <para> + The <literal>nixos-run-vms</literal> script now deletes the + previous run machines states on test startup. You can use the + <literal>--keep-vm-state</literal> flag to match the previous + behaviour and keep the same VM state between different test + runs. + </para> + </listitem> + <listitem> + <para> + The + <link xlink:href="options.html#opt-nix.buildMachines">nix.buildMachines</link> + option is now type-checked. There are no functional changes, + however this may require updating some configurations to use + correct types for all attributes. + </para> + </listitem> + <listitem> + <para> + The <literal>fontconfig</literal> module stopped generating + config and cache files for fontconfig 2.10.x, the + <literal>/etc/fonts/fonts.conf</literal> now belongs to the + latest fontconfig, just like on other Linux distributions, and + we will + <link xlink:href="https://github.com/NixOS/nixpkgs/pull/95358">no + longer</link> be versioning the config directories. + </para> + <para> + Fontconfig 2.10.x was removed from Nixpkgs since it hasn’t + been used in any Nixpkgs package for years now. + </para> + </listitem> + <listitem> + <para> + Nginx module + <literal>nginxModules.fastcgi-cache-purge</literal> renamed to + official name <literal>nginxModules.cache-purge</literal>. + Nginx module <literal>nginxModules.ngx_aws_auth</literal> + renamed to official name + <literal>nginxModules.aws-auth</literal>. + </para> + </listitem> + <listitem> + <para> + The option <literal>defaultPackages</literal> was added. It + installs the packages perl, rsync and strace for now. They + were added unconditionally to + <literal>systemPackages</literal> before, but are not strictly + necessary for a minimal NixOS install. You can set it to an + empty list to have a more minimal system. Be aware that some + functionality might still have an impure dependency on those + packages, so things might break. + </para> + </listitem> + <listitem> + <para> + The <literal>undervolt</literal> option no longer needs to + apply its settings every 30s. If they still become undone, + open an issue and restore the previous behaviour using + <literal>undervolt.useTimer</literal>. + </para> + </listitem> + <listitem> + <para> + Agda has been heavily reworked. + </para> + <itemizedlist> + <listitem> + <para> + <literal>agda.mkDerivation</literal> has been heavily + changed and is now located at agdaPackages.mkDerivation. + </para> + </listitem> + <listitem> + <para> + New top-level packages agda and + <literal>agda.withPackages</literal> have been added, the + second of which sets up agda with access to chosen + libraries. + </para> + </listitem> + <listitem> + <para> + All agda libraries now live under + <literal>agdaPackages</literal>. + </para> + </listitem> + <listitem> + <para> + Many broken libraries have been removed. + </para> + </listitem> + </itemizedlist> + <para> + See the + <link xlink:href="https://nixos.org/nixpkgs/manual/#agda">new + documentation</link> for more information. + </para> + </listitem> + <listitem> + <para> + The <literal>deepin</literal> package set has been removed + from nixpkgs. It was a work in progress to package the + <link xlink:href="https://www.deepin.org/en/dde/">Deepin + Desktop Environment (DDE)</link>, including libraries, tools + and applications, and it was still missing a service to launch + the desktop environment. It has shown to no longer be a + feasible goal due to reasons discussed in + <link xlink:href="https://github.com/NixOS/nixpkgs/issues/94870">issue + #94870</link>. The package + <literal>netease-cloud-music</literal> has also been removed, + as it depends on libraries from deepin. + </para> + </listitem> + <listitem> + <para> + The <literal>opendkim</literal> module now uses systemd + sandboxing features to limit the exposure of the system + towards the opendkim service. + </para> + </listitem> + <listitem> + <para> + Kubernetes has been upgraded to 1.19.1, which also means that + the golang version to build it has been bumped to 1.15. This + may have consequences for your existing clusters and their + certificates. Please consider + <link xlink:href="https://relnotes.k8s.io/?markdown=93264"> + the release notes for Kubernetes 1.19 carefully </link> before + upgrading. + </para> + </listitem> + <listitem> + <para> + For AMD GPUs, Vulkan can now be used by adding + <literal>amdvlk</literal> to + <literal>hardware.opengl.extraPackages</literal>. + </para> + </listitem> + <listitem> + <para> + Similarly, still for AMD GPUs, the ROCm OpenCL stack can now + be used by adding <literal>rocm-opencl-icd</literal> to + <literal>hardware.opengl.extraPackages</literal>. + </para> + </listitem> + </itemizedlist> + </section> + <section xml:id="sec-release-20.09-contributions"> + <title>Contributions</title> + <para> + I, Jonathan Ringer, would like to thank the following individuals + for their work on nixpkgs. This release could not be done without + the hard work of the NixOS community. There were 31282 + contributions across 1313 contributors. + </para> + <orderedlist numeration="arabic"> + <listitem> + <para> + 2288 Mario Rodas + </para> + </listitem> + <listitem> + <para> + 1837 Frederik Rietdijk + </para> + </listitem> + <listitem> + <para> + 946 Jörg Thalheim + </para> + </listitem> + <listitem> + <para> + 925 Maximilian Bosch + </para> + </listitem> + <listitem> + <para> + 687 Jonathan Ringer + </para> + </listitem> + <listitem> + <para> + 651 Jan Tojnar + </para> + </listitem> + <listitem> + <para> + 622 Daniël de Kok + </para> + </listitem> + <listitem> + <para> + 605 WORLDofPEACE + </para> + </listitem> + <listitem> + <para> + 597 Florian Klink + </para> + </listitem> + <listitem> + <para> + 528 José Romildo Malaquias + </para> + </listitem> + <listitem> + <para> + 281 volth + </para> + </listitem> + <listitem> + <para> + 101 Robert Scott + </para> + </listitem> + <listitem> + <para> + 86 Tim Steinbach + </para> + </listitem> + <listitem> + <para> + 76 WORLDofPEACE + </para> + </listitem> + <listitem> + <para> + 49 Maximilian Bosch + </para> + </listitem> + <listitem> + <para> + 42 Thomas Tuegel + </para> + </listitem> + <listitem> + <para> + 37 Doron Behar + </para> + </listitem> + <listitem> + <para> + 36 Vladimír Čunát + </para> + </listitem> + <listitem> + <para> + 27 Jonathan Ringer + </para> + </listitem> + <listitem> + <para> + 27 Maciej Krüger + </para> + </listitem> + </orderedlist> + <para> + I, Jonathan Ringer, would also like to personally thank + @WORLDofPEACE for their help in mentoring me on the release + process. Special thanks also goes to Thomas Tuegel for helping + immensely with stabilizing Qt, KDE, and Plasma5; I would also like + to thank Robert Scott for his numerous fixes and pull request + reviews. + </para> + </section> +</section> diff --git a/nixos/doc/manual/from_md/release-notes/rl-2105.section.xml b/nixos/doc/manual/from_md/release-notes/rl-2105.section.xml new file mode 100644 index 00000000000..f4155d6f8ce --- /dev/null +++ b/nixos/doc/manual/from_md/release-notes/rl-2105.section.xml @@ -0,0 +1,1567 @@ +<section xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="sec-release-21.05"> + <title>Release 21.05 (<quote>Okapi</quote>, 2021.05/31)</title> + <para> + Support is planned until the end of December 2021, handing over to + 21.11. + </para> + <section xml:id="sec-release-21.05-highlights"> + <title>Highlights</title> + <para> + In addition to numerous new and upgraded packages, this release + has the following highlights: + </para> + <itemizedlist> + <listitem> + <para> + Core version changes: + </para> + <itemizedlist> + <listitem> + <para> + gcc: 9.3.0 -> 10.3.0 + </para> + </listitem> + <listitem> + <para> + glibc: 2.30 -> 2.32 + </para> + </listitem> + <listitem> + <para> + default linux: 5.4 -> 5.10, all supported kernels + available + </para> + </listitem> + <listitem> + <para> + mesa: 20.1.7 -> 21.0.1 + </para> + </listitem> + </itemizedlist> + </listitem> + <listitem> + <para> + Desktop Environments: + </para> + <itemizedlist> + <listitem> + <para> + GNOME: 3.36 -> 40, see its + <link xlink:href="https://help.gnome.org/misc/release-notes/40.0/">release + notes</link> + </para> + </listitem> + <listitem> + <para> + Plasma5: 5.18.5 -> 5.21.3 + </para> + </listitem> + <listitem> + <para> + kdeApplications: 20.08.1 -> 20.12.3 + </para> + </listitem> + <listitem> + <para> + cinnamon: 4.6 -> 4.8.1 + </para> + </listitem> + </itemizedlist> + </listitem> + <listitem> + <para> + Programming Languages and Frameworks: + </para> + <itemizedlist spacing="compact"> + <listitem> + <para> + Python optimizations were disabled again. Builds with + optimizations enabled are not reproducible. Optimizations + can now be enabled with an option. + </para> + </listitem> + </itemizedlist> + </listitem> + <listitem> + <para> + The linux_latest kernel was updated to the 5.12 series. It + currently is not officially supported for use with the zfs + filesystem. If you use zfs, you should use a different kernel + version (either the LTS kernel, or track a specific one). + </para> + </listitem> + </itemizedlist> + </section> + <section xml:id="sec-release-21.05-new-services"> + <title>New Services</title> + <para> + The following new services were added since the last release: + </para> + <itemizedlist> + <listitem> + <para> + <link xlink:href="https://www.gnuradio.org/">GNURadio</link> + 3.8 and 3.9 were + <link xlink:href="https://github.com/NixOS/nixpkgs/issues/82263">finally</link> + packaged, along with a rewrite to the Nix expressions, + allowing users to override the features upstream supports + selecting to compile or not to. Additionally, the attribute + <literal>gnuradio</literal> (3.9), + <literal>gnuradio3_8</literal> and + <literal>gnuradio3_7</literal> now point to an externally + wrapped by default derivations, that allow you to also add + `extraPythonPackages` to the Python interpreter used by + GNURadio. Missing environmental variables needed for + operational GUI were also added + (<link xlink:href="https://github.com/NixOS/nixpkgs/issues/75478">#75478</link>). + </para> + </listitem> + <listitem> + <para> + <link xlink:href="https://www.keycloak.org/">Keycloak</link>, + an open source identity and access management server with + support for + <link xlink:href="https://openid.net/connect/">OpenID + Connect</link>, <link xlink:href="https://oauth.net/2/">OAUTH + 2.0</link> and + <link xlink:href="https://en.wikipedia.org/wiki/SAML_2.0">SAML + 2.0</link>. + </para> + <para> + See the <link linkend="module-services-keycloak">Keycloak + section of the NixOS manual</link> for more information. + </para> + </listitem> + <listitem> + <para> + <link xlink:href="options.html#opt-services.samba-wsdd.enable">services.samba-wsdd.enable</link> + Web Services Dynamic Discovery host daemon + </para> + </listitem> + <listitem> + <para> + <link xlink:href="https://www.discourse.org/">Discourse</link>, + a modern and open source discussion platform. + </para> + <para> + See the <link linkend="module-services-discourse">Discourse + section of the NixOS manual</link> for more information. + </para> + </listitem> + <listitem> + <para> + <link xlink:href="options.html#opt-services.nebula.networks">services.nebula.networks</link> + <link xlink:href="https://github.com/slackhq/nebula">Nebula + VPN</link> + </para> + </listitem> + </itemizedlist> + </section> + <section xml:id="sec-release-21.05-incompatibilities"> + <title>Backward Incompatibilities</title> + <para> + When upgrading from a previous release, please be aware of the + following incompatible changes: + </para> + <itemizedlist> + <listitem> + <para> + GNOME desktop environment was upgraded to 40, see the release + notes for + <link xlink:href="https://help.gnome.org/misc/release-notes/40.0/">40.0</link> + and + <link xlink:href="https://help.gnome.org/misc/release-notes/3.38/">3.38</link>. + The <literal>gnome3</literal> attribute set has been renamed + to <literal>gnome</literal> and so have been the NixOS + options. + </para> + </listitem> + <listitem> + <para> + If you are using <literal>services.udev.extraRules</literal> + to assign custom names to network interfaces, this may stop + working due to a change in the initialisation of dhcpcd and + systemd networkd. To avoid this, either move them to + <literal>services.udev.initrdRules</literal> or see the new + <link linkend="sec-custom-ifnames">Assigning custom + names</link> section of the NixOS manual for an example using + networkd links. + </para> + </listitem> + <listitem> + <para> + The <literal>security.hideProcessInformation</literal> module + has been removed. It was broken since the switch to + cgroups-v2. + </para> + </listitem> + <listitem> + <para> + The <literal>linuxPackages.ati_drivers_x11</literal> kernel + modules have been removed. The drivers only supported kernels + prior to 4.2, and thus have become obsolete. + </para> + </listitem> + <listitem> + <para> + The <literal>systemConfig</literal> kernel parameter is no + longer added to boot loader entries. It has been unused since + September 2010, but if do have a system generation from that + era, you will now be unable to boot into them. + </para> + </listitem> + <listitem> + <para> + <literal>systemd-journal2gelf</literal> no longer parses json + and expects the receiving system to handle it. How to achieve + this with Graylog is described in this + <link xlink:href="https://github.com/parse-nl/SystemdJournal2Gelf/issues/10">GitHub + issue</link>. + </para> + </listitem> + <listitem> + <para> + If the <literal>services.dbus</literal> module is enabled, + then the user D-Bus session is now always socket activated. + The associated options + <literal>services.dbus.socketActivated</literal> and + <literal>services.xserver.startDbusSession</literal> have + therefore been removed and you will receive a warning if they + are present in your configuration. This change makes the user + D-Bus session available also for non-graphical logins. + </para> + </listitem> + <listitem> + <para> + The <literal>networking.wireless.iwd</literal> module now + installs the upstream-provided 80-iwd.link file, which sets + the NamePolicy= for all wlan devices to "keep + kernel", to avoid race conditions between iwd and + networkd. If you don't want this, you can set + <literal>systemd.network.links."80-iwd" = lib.mkForce {}</literal>. + </para> + </listitem> + <listitem> + <para> + <literal>rubyMinimal</literal> was removed due to being unused + and unusable. The default ruby interpreter includes JIT + support, which makes it reference it's compiler. Since JIT + support is probably needed by some Gems, it was decided to + enable this feature with all cc references by default, and + allow to build a Ruby derivation without references to cc, by + setting <literal>jitSupport = false;</literal> in an overlay. + See + <link xlink:href="https://github.com/NixOS/nixpkgs/pull/90151">#90151</link> + for more info. + </para> + </listitem> + <listitem> + <para> + Setting + <literal>services.openssh.authorizedKeysFiles</literal> now + also affects which keys + <literal>security.pam.enableSSHAgentAuth</literal> will use. + WARNING: If you are using these options in combination do make + sure that any key paths you use are present in + <literal>services.openssh.authorizedKeysFiles</literal>! + </para> + </listitem> + <listitem> + <para> + The option <literal>fonts.enableFontDir</literal> has been + renamed to + <link xlink:href="options.html#opt-fonts.fontDir.enable">fonts.fontDir.enable</link>. + The path of font directory has also been changed to + <literal>/run/current-system/sw/share/X11/fonts</literal>, for + consistency with other X11 resources. + </para> + </listitem> + <listitem> + <para> + A number of options have been renamed in the kicad interface. + <literal>oceSupport</literal> has been renamed to + <literal>withOCE</literal>, <literal>withOCCT</literal> has + been renamed to <literal>withOCC</literal>, + <literal>ngspiceSupport</literal> has been renamed to + <literal>withNgspice</literal>, and + <literal>scriptingSupport</literal> has been renamed to + <literal>withScripting</literal>. Additionally, + <literal>kicad/base.nix</literal> no longer provides default + argument values since these are provided by + <literal>kicad/default.nix</literal>. + </para> + </listitem> + <listitem> + <para> + The socket for the <literal>pdns-recursor</literal> module was + moved from <literal>/var/lib/pdns-recursor</literal> to + <literal>/run/pdns-recursor</literal> to match upstream. + </para> + </listitem> + <listitem> + <para> + Paperwork was updated to version 2. The on-disk format + slightly changed, and it is not possible to downgrade from + Paperwork 2 back to Paperwork 1.3. Back your documents up + before upgrading. See + <link xlink:href="https://forum.openpaper.work/t/paperwork-2-0/112/5">this + thread</link> for more details. + </para> + </listitem> + <listitem> + <para> + PowerDNS has been updated from <literal>4.2.x</literal> to + <literal>4.3.x</literal>. Please be sure to review the + <link xlink:href="https://doc.powerdns.com/authoritative/upgrading.html#x-to-4-3-0">Upgrade + Notes</link> provided by upstream before upgrading. Worth + specifically noting is that the service now runs entirely as a + dedicated <literal>pdns</literal> user, instead of starting as + <literal>root</literal> and dropping privileges, as well as + the default <literal>socket-dir</literal> location changing + from <literal>/var/lib/powerdns</literal> to + <literal>/run/pdns</literal>. + </para> + </listitem> + <listitem> + <para> + The <literal>mediatomb</literal> service is now using by + default the new and maintained fork <literal>gerbera</literal> + package instead of the unmaintained + <literal>mediatomb</literal> package. If you want to keep the + old behavior, you must declare it with: + </para> + <programlisting language="bash"> +{ + services.mediatomb.package = pkgs.mediatomb; +} +</programlisting> + <para> + One new option <literal>openFirewall</literal> has been + introduced which defaults to false. If you relied on the + service declaration to add the firewall rules itself before, + you should now declare it with: + </para> + <programlisting language="bash"> +{ + services.mediatomb.openFirewall = true; +} +</programlisting> + </listitem> + <listitem> + <para> + xfsprogs was update from 4.19 to 5.11. It now enables reflink + support by default on filesystem creation. Support for + reflinks was added with an experimental status to kernel 4.9 + and deemed stable in kernel 4.16. If you want to be able to + mount XFS filesystems created with this release of xfsprogs on + kernel releases older than those, you need to format them with + <literal>mkfs.xfs -m reflink=0</literal>. + </para> + </listitem> + <listitem> + <para> + The uWSGI server is now built with POSIX capabilities. As a + consequence, root is no longer required in emperor mode and + the service defaults to running as the unprivileged + <literal>uwsgi</literal> user. Any additional capability can + be added via the new option + <link xlink:href="options.html#opt-services.uwsgi.capabilities">services.uwsgi.capabilities</link>. + The previous behaviour can be restored by setting: + </para> + <programlisting language="bash"> +{ + services.uwsgi.user = "root"; + services.uwsgi.group = "root"; + services.uwsgi.instance = + { + uid = "uwsgi"; + gid = "uwsgi"; + }; +} +</programlisting> + <para> + Another incompatibility from the previous release is that + vassals running under a different user or group need to use + <literal>immediate-{uid,gid}</literal> instead of the usual + <literal>uid,gid</literal> options. + </para> + </listitem> + <listitem> + <para> + btc1 has been abandoned upstream, and removed. + </para> + </listitem> + <listitem> + <para> + cpp_ethereum (aleth) has been abandoned upstream, and removed. + </para> + </listitem> + <listitem> + <para> + riak-cs package removed along with + <literal>services.riak-cs</literal> module. + </para> + </listitem> + <listitem> + <para> + stanchion package removed along with + <literal>services.stanchion</literal> module. + </para> + </listitem> + <listitem> + <para> + mutt has been updated to a new major version (2.x), which + comes with some backward incompatible changes that are + described in the + <link xlink:href="http://www.mutt.org/relnotes/2.0/">release + notes for Mutt 2.0</link>. + </para> + </listitem> + <listitem> + <para> + <literal>vim</literal> and <literal>neovim</literal> switched + to Python 3, dropping all Python 2 support. + </para> + </listitem> + <listitem> + <para> + <link xlink:href="options.html#opt-networking.wireguard.interfaces">networking.wireguard.interfaces.<name>.generatePrivateKeyFile</link>, + which is off by default, had a <literal>chmod</literal> race + condition fixed. As an aside, the parent directory's + permissions were widened, and the key files were made + owner-writable. This only affects newly created keys. However, + if the exact permissions are important for your setup, read + <link xlink:href="https://github.com/NixOS/nixpkgs/pull/121294">#121294</link>. + </para> + </listitem> + <listitem> + <para> + <link xlink:href="options.html#opt-boot.zfs.forceImportAll">boot.zfs.forceImportAll</link> + previously did nothing, but has been fixed. However its + default has been changed to <literal>false</literal> to + preserve the existing default behaviour. If you have this + explicitly set to <literal>true</literal>, please note that + your non-root pools will now be forcibly imported. + </para> + </listitem> + <listitem> + <para> + openafs now points to openafs_1_8, which is the new stable + release. OpenAFS 1.6 was removed. + </para> + </listitem> + <listitem> + <para> + The WireGuard module gained a new option + <literal>networking.wireguard.interfaces.<name>.peers.*.dynamicEndpointRefreshSeconds</literal> + that implements refreshing the IP of DNS-based endpoints + periodically (which WireGuard itself + <link xlink:href="https://lists.zx2c4.com/pipermail/wireguard/2017-November/002028.html">cannot + do</link>). + </para> + </listitem> + <listitem> + <para> + MariaDB has been updated to 10.5. Before you upgrade, it would + be best to take a backup of your database and read + <link xlink:href="https://mariadb.com/kb/en/upgrading-from-mariadb-104-to-mariadb-105/#incompatible-changes-between-104-and-105"> + Incompatible Changes Between 10.4 and 10.5</link>. After the + upgrade you will need to run <literal>mysql_upgrade</literal>. + </para> + </listitem> + <listitem> + <para> + The TokuDB storage engine dropped in mariadb 10.5 and removed + in mariadb 10.6. It is recommended to switch to RocksDB. See + also + <link xlink:href="https://mariadb.com/kb/en/tokudb/">TokuDB</link> + and + <link xlink:href="https://jira.mariadb.org/browse/MDEV-19780">MDEV-19780: + Remove the TokuDB storage engine</link>. + </para> + </listitem> + <listitem> + <para> + The <literal>openldap</literal> module now has support for + OLC-style configuration, users of the + <literal>configDir</literal> option may wish to migrate. If + you continue to use <literal>configDir</literal>, ensure that + <literal>olcPidFile</literal> is set to + <literal>/run/slapd/slapd.pid</literal>. + </para> + <para> + As a result, <literal>extraConfig</literal> and + <literal>extraDatabaseConfig</literal> are removed. To help + with migration, you can convert your + <literal>slapd.conf</literal> file to OLC configuration with + the following script (find the location of this configuration + file by running <literal>systemctl status openldap</literal>, + it is the <literal>-f</literal> option. + </para> + <programlisting> +$ TMPDIR=$(mktemp -d) +$ slaptest -f /path/to/slapd.conf -F $TMPDIR +$ slapcat -F $TMPDIR -n0 -H 'ldap:///???(!(objectClass=olcSchemaConfig))' +</programlisting> + <para> + This will dump your current configuration in LDIF format, + which should be straightforward to convert into Nix settings. + This does not show your schema configuration, as this is + unnecessarily verbose for users of the default schemas and + <literal>slaptest</literal> is buggy with schemas directly in + the config file. + </para> + </listitem> + <listitem> + <para> + Amazon EC2 and OpenStack Compute (nova) images now re-fetch + instance meta data and user data from the instance metadata + service (IMDS) on each boot. For example: stopping an EC2 + instance, changing its user data, and restarting the instance + will now cause it to fetch and apply the new user data. + </para> + <warning> + <para> + Specifically, <literal>/etc/ec2-metadata</literal> is + re-populated on each boot. Some NixOS scripts that read from + this directory are guarded to only run if the files they + want to manipulate do not already exist, and so will not + re-apply their changes if the IMDS response changes. + Examples: <literal>root</literal>'s SSH key is only added if + <literal>/root/.ssh/authorized_keys</literal> does not + exist, and SSH host keys are only set from user data if they + do not exist in <literal>/etc/ssh</literal>. + </para> + </warning> + </listitem> + <listitem> + <para> + The <literal>rspamd</literal> services is now sandboxed. It is + run as a dynamic user instead of root, so secrets and other + files may have to be moved or their permissions may have to be + fixed. The sockets are now located in + <literal>/run/rspamd</literal> instead of + <literal>/run</literal>. + </para> + </listitem> + <listitem> + <para> + Enabling the Tor client no longer silently also enables and + configures Privoxy, and the + <literal>services.tor.client.privoxy.enable</literal> option + has been removed. To enable Privoxy, and to configure it to + use Tor's faster port, use the following configuration: + </para> + <programlisting language="bash"> +{ + opt-services.privoxy.enable = true; + opt-services.privoxy.enableTor = true; +} +</programlisting> + </listitem> + <listitem> + <para> + The <literal>services.tor</literal> module has a new + exhaustively typed + <link xlink:href="options.html#opt-services.tor.settings">services.tor.settings</link> + option following RFC 0042; backward compatibility with old + options has been preserved when aliasing was possible. The + corresponding systemd service has been hardened, but there is + a chance that the service still requires more permissions, so + please report any related trouble on the bugtracker. Onion + services v3 are now supported in + <link xlink:href="options.html#opt-services.tor.relay.onionServices">services.tor.relay.onionServices</link>. + A new + <link xlink:href="options.html#opt-services.tor.openFirewall">services.tor.openFirewall</link> + option as been introduced for allowing connections on all the + TCP ports configured. + </para> + </listitem> + <listitem> + <para> + The options + <literal>services.slurm.dbdserver.storagePass</literal> and + <literal>services.slurm.dbdserver.configFile</literal> have + been removed. Use + <literal>services.slurm.dbdserver.storagePassFile</literal> + instead to provide the database password. Extra config options + can be given via the option + <literal>services.slurm.dbdserver.extraConfig</literal>. The + actual configuration file is created on the fly on startup of + the service. This avoids that the password gets exposed in the + nix store. + </para> + </listitem> + <listitem> + <para> + The <literal>wafHook</literal> hook does not wrap Python + anymore. Packages depending on <literal>wafHook</literal> need + to include any Python into their + <literal>nativeBuildInputs</literal>. + </para> + </listitem> + <listitem> + <para> + Starting with version 1.7.0, the project formerly named + <literal>CodiMD</literal> is now named + <literal>HedgeDoc</literal>. New installations will no longer + use the old name for users, state directories and such, this + needs to be considered when moving state to a more recent + NixOS installation. Based on + <link xlink:href="options.html#opt-system.stateVersion">system.stateVersion</link>, + existing installations will continue to work. + </para> + </listitem> + <listitem> + <para> + The fish-foreign-env package has been replaced with + fishPlugins.foreign-env, in which the fish functions have been + relocated to the <literal>vendor_functions.d</literal> + directory to be loaded automatically. + </para> + </listitem> + <listitem> + <para> + The prometheus json exporter is now managed by the prometheus + community. Together with additional features some backwards + incompatibilities were introduced. Most importantly the + exporter no longer accepts a fixed command-line parameter to + specify the URL of the endpoint serving JSON. It now expects + this URL to be passed as an URL parameter, when scraping the + exporter's <literal>/probe</literal> endpoint. In the + prometheus scrape configuration the scrape target might look + like this: + </para> + <programlisting> +http://some.json-exporter.host:7979/probe?target=https://example.com/some/json/endpoint +</programlisting> + <para> + Existing configuration for the exporter needs to be updated, + but can partially be re-used. Documentation is available in + the upstream repository and a small example for NixOS is + available in the corresponding NixOS test. + </para> + <para> + These changes also affect + <link xlink:href="options.html#opt-services.prometheus.exporters.rspamd.enable">services.prometheus.exporters.rspamd.enable</link>, + which is just a preconfigured instance of the json exporter. + </para> + <para> + For more information, take a look at the + <link xlink:href="https://github.com/prometheus-community/json_exporter"> + official documentation</link> of the json_exporter. + </para> + </listitem> + <listitem> + <para> + Androidenv was updated, removing the + <literal>includeDocs</literal> and + <literal>lldbVersions</literal> arguments. Docs only covered a + single version of the Android SDK, LLDB is now bundled with + the NDK, and both are no longer available to download from the + Android package repositories. Additionally, since the package + lists have been updated, some older versions of Android + packages may not be bundled. If you depend on older versions + of Android packages, we recommend overriding the repo. + </para> + <para> + Android packages are now loaded from a repo.json file created + by parsing Android repo XML files. The arguments + <literal>repoJson</literal> and <literal>repoXmls</literal> + have been added to allow overriding the built-in androidenv + repo.json with your own. Additionally, license files are now + written to allow compatibility with Gradle-based tools, and + the <literal>extraLicenses</literal> argument has been added + to accept more SDK licenses if your project requires it. See + the androidenv documentation for more details. + </para> + </listitem> + <listitem> + <para> + The attribute <literal>mpi</literal> is now consistently used + to provide a default, system-wide MPI implementation. The + default implementation is openmpi, which has been used before + by all derivations affects by this change. Note that all + packages that have used <literal>mpi ? null</literal> in the + input for optional MPI builds, have been changed to the + boolean input paramater <literal>useMpi</literal> to enable + building with MPI. Building all packages with + <literal>mpich</literal> instead of the default + <literal>openmpi</literal> can now be achived like this: + </para> + <programlisting language="bash"> +self: super: +{ + mpi = super.mpich; +} +</programlisting> + </listitem> + <listitem> + <para> + The Searx module has been updated with the ability to + configure the service declaratively and uWSGI integration. The + option <literal>services.searx.configFile</literal> has been + renamed to + <link xlink:href="options.html#opt-services.searx.settingsFile">services.searx.settingsFile</link> + for consistency with the new + <link xlink:href="options.html#opt-services.searx.settings">services.searx.settings</link>. + In addition, the <literal>searx</literal> uid and gid + reservations have been removed since they were not necessary: + the service is now running with a dynamically allocated uid. + </para> + </listitem> + <listitem> + <para> + The libinput module has been updated with the ability to + configure mouse and touchpad settings separately. The options + in <literal>services.xserver.libinput</literal> have been + renamed to + <literal>services.xserver.libinput.touchpad</literal>, while + there is a new + <literal>services.xserver.libinput.mouse</literal> for mouse + related configuration. + </para> + <para> + Since touchpad options no longer apply to all devices, you may + want to replicate your touchpad configuration in mouse + section. + </para> + </listitem> + <listitem> + <para> + ALSA OSS emulation + (<literal>sound.enableOSSEmulation</literal>) is now disabled + by default. + </para> + </listitem> + <listitem> + <para> + Thinkfan as been updated to <literal>1.2.x</literal>, which + comes with a new YAML based configuration format. For this + reason, several NixOS options of the thinkfan module have been + changed to non-backward compatible types. In addition, a new + <link xlink:href="options.html#opt-services.thinkfan.settings">services.thinkfan.settings</link> + option has been added. + </para> + <para> + Please read the + <link xlink:href="https://github.com/vmatare/thinkfan#readme"> + thinkfan documentation</link> before updating. + </para> + </listitem> + <listitem> + <para> + Adobe Flash Player support has been dropped from the tree. In + particular, the following packages no longer support it: + </para> + <itemizedlist> + <listitem> + <para> + chromium + </para> + </listitem> + <listitem> + <para> + firefox + </para> + </listitem> + <listitem> + <para> + qt48 + </para> + </listitem> + <listitem> + <para> + qt5.qtwebkit + </para> + </listitem> + </itemizedlist> + <para> + Additionally, packages flashplayer and hal-flash were removed + along with the <literal>services.flashpolicyd</literal> + module. + </para> + </listitem> + <listitem> + <para> + The <literal>security.rngd</literal> module has been removed. + It was disabled by default in 20.09 as it was functionally + redundant with krngd in the linux kernel. It is not necessary + for any device that the kernel recognises as an hardware RNG, + as it will automatically run the krngd task to periodically + collect random data from the device and mix it into the + kernel's RNG. + </para> + <para> + The default SMTP port for GitLab has been changed to + <literal>25</literal> from its previous default of + <literal>465</literal>. If you depended on this default, you + should now set the + <link xlink:href="options.html#opt-services.gitlab.smtp.port">services.gitlab.smtp.port</link> + option. + </para> + </listitem> + <listitem> + <para> + The default version of ImageMagick has been updated from 6 to + 7. You can use imagemagick6, imagemagick6_light, and + imagemagick6Big if you need the older version. + </para> + </listitem> + <listitem> + <para> + <link xlink:href="options.html#opt-services.xserver.videoDrivers">services.xserver.videoDrivers</link> + no longer uses the deprecated <literal>cirrus</literal> and + <literal>vesa</literal> device dependent X drivers by default. + It also enables both <literal>amdgpu</literal> and + <literal>nouveau</literal> drivers by default now. + </para> + </listitem> + <listitem> + <para> + The <literal>kindlegen</literal> package is gone, because it + is no longer supported or hosted by Amazon. Sadly, its + replacement, Kindle Previewer, has no Linux support. However, + there are other ways to generate MOBI files. See + <link xlink:href="https://github.com/NixOS/nixpkgs/issues/96439">the + discussion</link> for more info. + </para> + </listitem> + <listitem> + <para> + The apacheKafka packages are now built with version-matched + JREs. Versions 2.6 and above, the ones that recommend it, use + jdk11, while versions below remain on jdk8. The NixOS service + has been adjusted to start the service using the same version + as the package, adjustable with the new + <link xlink:href="options.html#opt-services.apache-kafka.jre">services.apache-kafka.jre</link> + option. Furthermore, the default list of + <link xlink:href="options.html#opt-services.apache-kafka.jvmOptions">services.apache-kafka.jvmOptions</link> + have been removed. You should set your own according to the + <link xlink:href="https://kafka.apache.org/documentation/#java">upstream + documentation</link> for your Kafka version. + </para> + </listitem> + <listitem> + <para> + The kodi package has been modified to allow concise addon + management. Consider the following configuration from previous + releases of NixOS to install kodi, including the + kodiPackages.inputstream-adaptive and kodiPackages.vfs-sftp + addons: + </para> + <programlisting language="bash"> +{ + environment.systemPackages = [ + pkgs.kodi + ]; + + nixpkgs.config.kodi = { + enableInputStreamAdaptive = true; + enableVFSSFTP = true; + }; +} +</programlisting> + <para> + All Kodi <literal>config</literal> flags have been removed, + and as a result the above configuration should now be written + as: + </para> + <programlisting language="bash"> +{ + environment.systemPackages = [ + (pkgs.kodi.withPackages (p: with p; [ + inputstream-adaptive + vfs-sftp + ])) + ]; +} +</programlisting> + </listitem> + <listitem> + <para> + <literal>environment.defaultPackages</literal> now includes + the nano package. If pkgs.nano is not added to the list, make + sure another editor is installed and the + <literal>EDITOR</literal> environment variable is set to it. + Environment variables can be set using + <literal>environment.variables</literal>. + </para> + </listitem> + <listitem> + <para> + <literal>services.minio.dataDir</literal> changed type to a + list of paths, required for specifiyng multiple data + directories for using with erasure coding. Currently, the + service doesn't enforce nor checks the correct number of paths + to correspond to minio requirements. + </para> + </listitem> + <listitem> + <para> + All CUDA toolkit versions prior to CUDA 10 have been removed. + </para> + </listitem> + <listitem> + <para> + The kbdKeymaps package was removed since dvp and neo are now + included in kbd. If you want to use the Programmer Dvorak + Keyboard Layout, you have to use + <literal>dvorak-programmer</literal> in + <literal>console.keyMap</literal> now instead of + <literal>dvp</literal>. In + <literal>services.xserver.xkbVariant</literal> it's still + <literal>dvp</literal>. + </para> + </listitem> + <listitem> + <para> + The babeld service is now being run as an unprivileged user. + To achieve that the module configures + <literal>skip-kernel-setup true</literal> and takes care of + setting forwarding and rp_filter sysctls by itself as well as + for each interface in + <literal>services.babeld.interfaces</literal>. + </para> + </listitem> + <listitem> + <para> + The <literal>services.zigbee2mqtt.config</literal> option has + been renamed to + <literal>services.zigbee2mqtt.settings</literal> and now + follows + <link xlink:href="https://github.com/NixOS/rfcs/blob/master/rfcs/0042-config-option.md">RFC + 0042</link>. + </para> + </listitem> + </itemizedlist> + <para> + The yadm dotfile manager has been updated from 2.x to 3.x, which + has new (XDG) default locations for some data/state files. Most + yadm commands will fail and print a legacy path warning (which + describes how to upgrade/migrate your repository). If you have + scripts, daemons, scheduled jobs, shell profiles, etc. that invoke + yadm, expect them to fail or misbehave until you perform this + migration and prepare accordingly. + </para> + <itemizedlist> + <listitem> + <para> + Instead of determining + <literal>services.radicale.package</literal> automatically + based on <literal>system.stateVersion</literal>, the latest + version is always used because old versions are not officially + supported. + </para> + <para> + Furthermore, Radicale's systemd unit was hardened which might + break some deployments. In particular, a non-default + <literal>filesystem_folder</literal> has to be added to + <literal>systemd.services.radicale.serviceConfig.ReadWritePaths</literal> + if the deprecated <literal>services.radicale.config</literal> + is used. + </para> + </listitem> + <listitem> + <para> + In the <literal>security.acme</literal> module, use of + <literal>--reuse-key</literal> parameter for Lego has been + removed. It was introduced for HKPK, but this security feature + is now deprecated. It is a better security practice to rotate + key pairs instead of always keeping the same. If you need to + keep this parameter, you can add it back using + <literal>extraLegoRenewFlags</literal> as an option for the + appropriate certificate. + </para> + </listitem> + </itemizedlist> + </section> + <section xml:id="sec-release-21.05-notable-changes"> + <title>Other Notable Changes</title> + <itemizedlist> + <listitem> + <para> + <literal>stdenv.lib</literal> has been deprecated and will + break eval in 21.11. Please use <literal>pkgs.lib</literal> + instead. See + <link xlink:href="https://github.com/NixOS/nixpkgs/issues/108938">#108938</link> + for details. + </para> + </listitem> + <listitem> + <para> + <link xlink:href="https://www.gnuradio.org/">GNURadio</link> + has a <literal>pkgs</literal> attribute set, and there's a + <literal>gnuradio.callPackage</literal> function that extends + <literal>pkgs</literal> with a + <literal>mkDerivation</literal>, and a + <literal>mkDerivationWith</literal>, like Qt5. Now all + <literal>gnuradio.pkgs</literal> are defined with + <literal>gnuradio.callPackage</literal> and some packages that + depend on gnuradio are defined with this as well. + </para> + </listitem> + <listitem> + <para> + <link xlink:href="https://www.privoxy.org/">Privoxy</link> has + been updated to version 3.0.32 (See + <link xlink:href="https://lists.privoxy.org/pipermail/privoxy-announce/2021-February/000007.html">announcement</link>). + Compared to the previous release, Privoxy has gained support + for HTTPS inspection (still experimental), Brotli + decompression, several new filters and lots of bug fixes, + including security ones. In addition, the package is now built + with compression and external filters support, which were + previously disabled. + </para> + <para> + Regarding the NixOS module, new options for HTTPS inspection + have been added and + <literal>services.privoxy.extraConfig</literal> has been + replaced by the new + <link xlink:href="options.html#opt-services.privoxy.settings">services.privoxy.settings</link> + (See + <link xlink:href="https://github.com/NixOS/rfcs/blob/master/rfcs/0042-config-option.md">RFC + 0042</link> for the motivation). + </para> + </listitem> + <listitem> + <para> + <link xlink:href="https://kodi.tv/">Kodi</link> has been + updated to version 19.1 "Matrix". See the + <link xlink:href="https://kodi.tv/article/kodi-19-0-matrix-release">announcement</link> + for further details. + </para> + </listitem> + <listitem> + <para> + The <literal>services.packagekit.backend</literal> option has + been removed as it only supported a single setting which would + always be the default. Instead new + <link xlink:href="https://github.com/NixOS/rfcs/blob/master/rfcs/0042-config-option.md">RFC + 0042</link> compliant + <link xlink:href="options.html#opt-services.packagekit.settings">services.packagekit.settings</link> + and + <link xlink:href="options.html#opt-services.packagekit.vendorSettings">services.packagekit.vendorSettings</link> + options have been introduced. + </para> + </listitem> + <listitem> + <para> + <link xlink:href="https://nginx.org">Nginx</link> has been + updated to stable version 1.20.0. Now nginx uses the zlib-ng + library by default. + </para> + </listitem> + <listitem> + <para> + KDE Gear (formerly KDE Applications) is upgraded to 21.04, see + its + <link xlink:href="https://kde.org/announcements/gear/21.04/">release + notes</link> for details. + </para> + <para> + The <literal>kdeApplications</literal> package set is now + <literal>kdeGear</literal>, in keeping with the new name. The + old name remains for compatibility, but it is deprecated. + </para> + </listitem> + <listitem> + <para> + <link xlink:href="https://libreswan.org/">Libreswan</link> has + been updated to version 4.4. The package now includes example + configurations and manual pages by default. The NixOS module + has been changed to use the upstream systemd units and write + the configuration in the <literal>/etc/ipsec.d/ </literal> + directory. In addition, two new options have been added to + specify connection policies + (<link xlink:href="options.html#opt-services.libreswan.policies">services.libreswan.policies</link>) + and disable send/receive redirects + (<link xlink:href="options.html#opt-services.libreswan.disableRedirects">services.libreswan.disableRedirects</link>). + </para> + </listitem> + <listitem> + <para> + The Mailman NixOS module (<literal>services.mailman</literal>) + has a new option + <link xlink:href="options.html#opt-services.mailman.enablePostfix">services.mailman.enablePostfix</link>, + defaulting to true, that controls integration with Postfix. + </para> + <para> + If this option is disabled, default MTA config becomes not set + and you should set the options in + <literal>services.mailman.settings.mta</literal> according to + the desired configuration as described in + <link xlink:href="https://mailman.readthedocs.io/en/latest/src/mailman/docs/mta.html">Mailman + documentation</link>. + </para> + </listitem> + <listitem> + <para> + The default-version of <literal>nextcloud</literal> is + nextcloud21. Please note that it's <emphasis>not</emphasis> + possible to upgrade <literal>nextcloud</literal> across + multiple major versions! This means that it's e.g. not + possible to upgrade from nextcloud18 to nextcloud20 in a + single deploy and most <literal>20.09</literal> users will + have to upgrade to nextcloud20 first. + </para> + <para> + The package can be manually upgraded by setting + <link xlink:href="options.html#opt-services.nextcloud.package">services.nextcloud.package</link> + to nextcloud21. + </para> + </listitem> + <listitem> + <para> + The setting + <link xlink:href="options.html#opt-services.redis.bind">services.redis.bind</link> + defaults to <literal>127.0.0.1</literal> now, making Redis + listen on the loopback interface only, and not all public + network interfaces. + </para> + </listitem> + <listitem> + <para> + NixOS now emits a deprecation warning if systemd's + <literal>StartLimitInterval</literal> setting is used in a + <literal>serviceConfig</literal> section instead of in a + <literal>unitConfig</literal>; that setting is deprecated and + now undocumented for the service section by systemd upstream, + but still effective and somewhat buggy there, which can be + confusing. See + <link xlink:href="https://github.com/NixOS/nixpkgs/issues/45785">#45785</link> + for details. + </para> + <para> + All services should use + <link xlink:href="options.html#opt-systemd.services._name_.startLimitIntervalSec">systemd.services.<emphasis>name</emphasis>.startLimitIntervalSec</link> + or <literal>StartLimitIntervalSec</literal> in + <link xlink:href="options.html#opt-systemd.services._name_.unitConfig">systemd.services.<emphasis>name</emphasis>.unitConfig</link> + instead. + </para> + </listitem> + <listitem> + <para> + The <literal>mediatomb</literal> service declares new options. + It also adapts existing options so the configuration + generation is now lazy. The existing option + <literal>customCfg</literal> (defaults to false), when + enabled, stops the service configuration generation + completely. It then expects the users to provide their own + correct configuration at the right location (whereas the + configuration was generated and not used at all before). The + new option <literal>transcodingOption</literal> (defaults to + no) allows a generated configuration. It makes the mediatomb + service pulls the necessary runtime dependencies in the nix + store (whereas it was generated with hardcoded values before). + The new option <literal>mediaDirectories</literal> allows the + users to declare autoscan media directories from their nixos + configuration: + </para> + <programlisting language="bash"> +{ + services.mediatomb.mediaDirectories = [ + { path = "/var/lib/mediatomb/pictures"; recursive = false; hidden-files = false; } + { path = "/var/lib/mediatomb/audio"; recursive = true; hidden-files = false; } + ]; +} +</programlisting> + </listitem> + <listitem> + <para> + The Unbound DNS resolver service + (<literal>services.unbound</literal>) has been refactored to + allow reloading, control sockets and to fix startup ordering + issues. + </para> + <para> + It is now possible to enable a local UNIX control socket for + unbound by setting the + <link xlink:href="options.html#opt-services.unbound.localControlSocketPath">services.unbound.localControlSocketPath</link> + option. + </para> + <para> + Previously we just applied a very minimal set of restrictions + and trusted unbound to properly drop root privs and + capabilities. + </para> + <para> + As of this we are (for the most part) just using the upstream + example unit file for unbound. The main difference is that we + start unbound as <literal>unbound</literal> user with the + required capabilities instead of letting unbound do the chroot + & uid/gid changes. + </para> + <para> + The upstream unit configuration this is based on is a lot + stricter with all kinds of permissions then our previous + variant. It also came with the default of having the + <literal>Type</literal> set to <literal>notify</literal>, + therefore we are now also using the + <literal>unbound-with-systemd</literal> package here. Unbound + will start up, read the configuration files and start + listening on the configured ports before systemd will declare + the unit <literal>active (running)</literal>. This will likely + help with startup order and the occasional race condition + during system activation where the DNS service is started but + not yet ready to answer queries. Services depending on + <literal>nss-lookup.target</literal> or + <literal>unbound.service</literal> are now be able to use + unbound when those targets have been reached. + </para> + <para> + Additionally to the much stricter runtime environment the + <literal>/dev/urandom</literal> mount lines we previously had + in the code (that randomly failed during the stop-phase) have + been removed as systemd will take care of those for us. + </para> + <para> + The <literal>preStart</literal> script is now only required if + we enabled the trust anchor updates (which are still enabled + by default). + </para> + <para> + Another benefit of the refactoring is that we can now issue + reloads via either <literal>pkill -HUP unbound</literal> and + <literal>systemctl reload unbound</literal> to reload the + running configuration without taking the daemon offline. A + prerequisite of this was that unbound configuration is + available on a well known path on the file system. We are + using the path <literal>/etc/unbound/unbound.conf</literal> as + that is the default in the CLI tooling which in turn enables + us to use <literal>unbound-control</literal> without passing a + custom configuration location. + </para> + <para> + The module has also been reworked to be + <link xlink:href="https://github.com/NixOS/rfcs/blob/master/rfcs/0042-config-option.md">RFC + 0042</link> compliant. As such, + <literal>sevices.unbound.extraConfig</literal> has been + removed and replaced by + <link xlink:href="options.html#opt-services.unbound.settings">services.unbound.settings</link>. + <literal>services.unbound.interfaces</literal> has been + renamed to + <literal>services.unbound.settings.server.interface</literal>. + </para> + <para> + <literal>services.unbound.forwardAddresses</literal> and + <literal>services.unbound.allowedAccess</literal> have also + been changed to use the new settings interface. You can follow + the instructions when executing + <literal>nixos-rebuild</literal> to upgrade your configuration + to use the new interface. + </para> + </listitem> + <listitem> + <para> + The <literal>services.dnscrypt-proxy2</literal> module now + takes the upstream's example configuration and updates it with + the user's settings. An option has been added to restore the + old behaviour if you prefer to declare the configuration from + scratch. + </para> + </listitem> + <listitem> + <para> + NixOS now defaults to the unified cgroup hierarchy + (cgroupsv2). See the + <link xlink:href="https://www.redhat.com/sysadmin/fedora-31-control-group-v2">Fedora + Article for 31</link> for details on why this is desirable, + and how it impacts containers. + </para> + <para> + If you want to run containers with a runtime that does not yet + support cgroupsv2, you can switch back to the old behaviour by + setting + <link xlink:href="options.html#opt-systemd.enableUnifiedCgroupHierarchy">systemd.enableUnifiedCgroupHierarchy</link> + = <literal>false</literal>; and rebooting. + </para> + </listitem> + <listitem> + <para> + PulseAudio was upgraded to 14.0, with changes to the handling + of default sinks. See its + <link xlink:href="https://www.freedesktop.org/wiki/Software/PulseAudio/Notes/14.0/">release + notes</link>. + </para> + </listitem> + <listitem> + <para> + GNOME users may wish to delete their + <literal>~/.config/pulse</literal> due to the changes to + stream routing logic. See + <link xlink:href="https://gitlab.freedesktop.org/pulseaudio/pulseaudio/-/issues/832">PulseAudio + bug 832</link> for more information. + </para> + </listitem> + <listitem> + <para> + The zookeeper package does not provide + <literal>zooInspector.sh</literal> anymore, as that + "contrib" has been dropped from upstream releases. + </para> + </listitem> + <listitem> + <para> + In the ACME module, the data used to build the hash for the + account directory has changed to accomodate new features to + reduce account rate limit issues. This will trigger new + account creation on the first rebuild following this update. + No issues are expected to arise from this, thanks to the new + account creation handling. + </para> + </listitem> + <listitem> + <para> + <link xlink:href="options.html#opt-users.users._name_.createHome">users.users.<emphasis>name</emphasis>.createHome</link> + now always ensures home directory permissions to be + <literal>0700</literal>. Permissions had previously been + ignored for already existing home directories, possibly + leaving them readable by others. The option's description was + incorrect regarding ownership management and has been + simplified greatly. + </para> + </listitem> + <listitem> + <para> + When defining a new user, one of + <link xlink:href="options.html#opt-users.users._name_.isNormalUser">users.users.<emphasis>name</emphasis>.isNormalUser</link> + and + <link xlink:href="options.html#opt-users.users._name_.isSystemUser">users.users.<emphasis>name</emphasis>.isSystemUser</link> + is now required. This is to prevent accidentally giving a UID + above 1000 to system users, which could have unexpected + consequences, like running user activation scripts for system + users. Note that users defined with an explicit UID below 500 + are exempted from this check, as + <link xlink:href="options.html#opt-users.users._name_.isSystemUser">users.users.<emphasis>name</emphasis>.isSystemUser</link> + has no effect for those. + </para> + </listitem> + <listitem> + <para> + The <literal>security.apparmor</literal> module, for the + <link xlink:href="https://gitlab.com/apparmor/apparmor/-/wikis/Documentation">AppArmor</link> + Mandatory Access Control system, has been substantialy + improved along with related tools, so that module maintainers + can now more easily write AppArmor profiles for NixOS. The + most notable change on the user-side is the new option + <link xlink:href="options.html#opt-security.apparmor.policies">security.apparmor.policies</link>, + replacing the previous <literal>profiles</literal> option to + provide a way to disable a profile and to select whether to + confine in enforce mode (default) or in complain mode (see + <literal>journalctl -b --grep apparmor</literal>). + Security-minded users may also want to enable + <link xlink:href="options.html#opt-security.apparmor.killUnconfinedConfinables">security.apparmor.killUnconfinedConfinables</link>, + at the cost of having some of their processes killed when + updating to a NixOS version introducing new AppArmor profiles. + </para> + </listitem> + <listitem> + <para> + The GNOME desktop manager once again installs gnome.epiphany + by default. + </para> + </listitem> + <listitem> + <para> + NixOS now generates empty <literal>/etc/netgroup</literal>. + <literal>/etc/netgroup</literal> defines network-wide groups + and may affect to setups using NIS. + </para> + </listitem> + <listitem> + <para> + Platforms, like <literal>stdenv.hostPlatform</literal>, no + longer have a <literal>platform</literal> attribute. It has + been (mostly) flattened away: + </para> + <itemizedlist> + <listitem> + <para> + <literal>platform.gcc</literal> is now + <literal>gcc</literal> + </para> + </listitem> + <listitem> + <para> + <literal>platform.kernel*</literal> is now + <literal>linux-kernel.*</literal> + </para> + </listitem> + </itemizedlist> + <para> + Additionally, <literal>platform.kernelArch</literal> moved to + the top level as <literal>linuxArch</literal> to match the + other <literal>*Arch</literal> variables. + </para> + <para> + The <literal>platform</literal> grouping of these things never + meant anything, and was just a historial/implementation + artifact that was overdue removal. + </para> + </listitem> + <listitem> + <para> + <literal>services.restic</literal> now uses a dedicated cache + directory for every backup defined in + <literal>services.restic.backups</literal>. The old global + cache directory, <literal>/root/.cache/restic</literal>, is + now unused and can be removed to free up disk space. + </para> + </listitem> + <listitem> + <para> + <literal>isync</literal>: The <literal>isync</literal> + compatibility wrapper was removed and the Master/Slave + terminology has been deprecated and should be replaced with + Far/Near in the configuration file. + </para> + </listitem> + <listitem> + <para> + The nix-gc service now accepts randomizedDelaySec (default: 0) + and persistent (default: true) parameters. By default nix-gc + will now run immediately if it would have been triggered at + least once during the time when the timer was inactive. + </para> + </listitem> + <listitem> + <para> + The <literal>rustPlatform.buildRustPackage</literal> function + is split into several hooks: cargoSetupHook to set up + vendoring for Cargo-based projects, cargoBuildHook to build a + project using Cargo, cargoInstallHook to install a project + using Cargo, and cargoCheckHook to run tests in Cargo-based + projects. With this change, mixed-language projects can use + the relevant hooks within builders other than + <literal>buildRustPackage</literal>. However, these changes + also required several API changes to + <literal>buildRustPackage</literal> itself: + </para> + <itemizedlist> + <listitem> + <para> + The <literal>target</literal> argument was removed. + Instead, <literal>buildRustPackage</literal> will always + use the same target as the C/C++ compiler that is used. + </para> + </listitem> + <listitem> + <para> + The <literal>cargoParallelTestThreads</literal> argument + was removed. Parallel tests are now disabled through + <literal>dontUseCargoParallelTests</literal>. + </para> + </listitem> + </itemizedlist> + </listitem> + <listitem> + <para> + The <literal>rustPlatform.maturinBuildHook</literal> hook was + added. This hook can be used with + <literal>buildPythonPackage</literal> to build Python packages + that are written in Rust and use Maturin as their build tool. + </para> + </listitem> + <listitem> + <para> + Kubernetes has + <link xlink:href="https://kubernetes.io/blog/2020/12/02/dont-panic-kubernetes-and-docker/">deprecated + docker</link> as container runtime. As a consequence, the + Kubernetes module now has support for configuration of custom + remote container runtimes and enables containerd by default. + Note that containerd is more strict regarding container image + OCI-compliance. As an example, images with CMD or ENTRYPOINT + defined as strings (not lists) will fail on containerd, while + working fine on docker. Please test your setup and container + images with containerd prior to upgrading. + </para> + </listitem> + <listitem> + <para> + The GitLab module now has support for automatic backups. A + schedule can be set with the + <link xlink:href="options.html#opt-services.gitlab.backup.startAt">services.gitlab.backup.startAt</link> + option. + </para> + </listitem> + <listitem> + <para> + Prior to this release, systemd would also read system units + from an undocumented + <literal>/etc/systemd-mutable/system</literal> path. This path + has been dropped from the defaults. That path (or others) can + be re-enabled by adding it to the + <link xlink:href="options.html#opt-boot.extraSystemdUnitPaths">boot.extraSystemdUnitPaths</link> + list. + </para> + </listitem> + <listitem> + <para> + PostgreSQL 9.5 is scheduled EOL during the 21.05 life cycle + and has been removed. + </para> + </listitem> + <listitem> + <para> + <link xlink:href="https://www.xfce.org/">Xfce4</link> relies + on GIO/GVfs for userspace virtual filesystem access in + applications like + <link xlink:href="https://docs.xfce.org/xfce/thunar/">thunar</link> + and + <link xlink:href="https://docs.xfce.org/apps/gigolo/">gigolo</link>. + For that to work, the gvfs nixos service is enabled by + default, and it can be configured with the specific package + that provides GVfs. Until now Xfce4 was setting it to use a + lighter version of GVfs (without support for samba). To avoid + conflicts with other desktop environments this setting has + been dropped. Users that still want it should add the + following to their system configuration: + </para> + <programlisting language="bash"> +{ + services.gvfs.package = pkgs.gvfs.override { samba = null; }; +} +</programlisting> + </listitem> + <listitem> + <para> + The newly enabled <literal>systemd-pstore.service</literal> + now automatically evacuates crashdumps and panic logs from the + persistent storage to + <literal>/var/lib/systemd/pstore</literal>. This prevents + NVRAM from filling up, which ensures the latest diagnostic + data is always stored and alleviates problems with writing new + boot configurations. + </para> + </listitem> + <listitem> + <para> + Nixpkgs now contains + <link xlink:href="https://github.com/NixOS/nixpkgs/pull/118232">automatically + packaged GNOME Shell extensions</link> from the + <link xlink:href="https://extensions.gnome.org/">GNOME + Extensions</link> portal. You can find them, filed by their + UUID, under <literal>gnome38Extensions</literal> attribute for + GNOME 3.38 and under <literal>gnome40Extensions</literal> for + GNOME 40. Finally, the <literal>gnomeExtensions</literal> + attribute contains extensions for the latest GNOME Shell + version in Nixpkgs, listed under a more human-friendly name. + The unqualified attribute scope also contains manually + packaged extensions. Note that the automatically packaged + extensions are provided for convenience and are not checked or + guaranteed to work. + </para> + </listitem> + <listitem> + <para> + Erlang/OTP versions older than R21 got dropped. We also + dropped the cuter package, as it was purely an example of how + to build a package. We also dropped <literal>lfe_1_2</literal> + as it could not build with R21+. Moving forward, we expect to + only support 3 yearly releases of OTP. + </para> + </listitem> + </itemizedlist> + </section> +</section> diff --git a/nixos/doc/manual/from_md/release-notes/rl-2111.section.xml b/nixos/doc/manual/from_md/release-notes/rl-2111.section.xml index dc5a30d19bc..f573f731365 100644 --- a/nixos/doc/manual/from_md/release-notes/rl-2111.section.xml +++ b/nixos/doc/manual/from_md/release-notes/rl-2111.section.xml @@ -1,5 +1,5 @@ -<section xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="release-21.11"> - <title>Release 21.11 (<quote>?</quote>, 2021.11/??)</title> +<section xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="sec-release-21.11"> + <title>Release 21.11 (“?”, 2021.11/??)</title> <para> In addition to numerous new and upgraded packages, this release has the following highlights: @@ -7,18 +7,699 @@ <itemizedlist spacing="compact"> <listitem> <para> - Support is planned until the end of April 2022, handing over to + Support is planned until the end of June 2022, handing over to 22.05. </para> </listitem> </itemizedlist> - <section xml:id="backward-incompatibilities"> - <title>Backward incompatibilities</title> - <itemizedlist spacing="compact"> + <section xml:id="sec-release-21.11-highlights"> + <title>Highlights</title> + <itemizedlist> + <listitem> + <para> + PHP now defaults to PHP 8.0, updated from 7.4. + </para> + </listitem> + <listitem> + <para> + kOps now defaults to 1.21.0, which uses containerd as the + default runtime. + </para> + </listitem> + <listitem> + <para> + <literal>python3</literal> now defaults to Python 3.9, updated + from Python 3.8. + </para> + </listitem> + <listitem> + <para> + PostgreSQL now defaults to major version 13. + </para> + </listitem> + </itemizedlist> + </section> + <section xml:id="sec-release-21.11-new-services"> + <title>New Services</title> + <itemizedlist> + <listitem> + <para> + <link xlink:href="https://digint.ch/btrbk/index.html">btrbk</link>, + a backup tool for btrfs subvolumes, taking advantage of btrfs + specific capabilities to create atomic snapshots and transfer + them incrementally to your backup locations. Available as + <link xlink:href="options.html#opt-services.brtbk.instances">services.btrbk</link>. + </para> + </listitem> + <listitem> + <para> + <link xlink:href="https://github.com/xrelkd/clipcat/">clipcat</link>, + an X11 clipboard manager written in Rust. Available at + [services.clipcat](options.html#o pt-services.clipcat.enable). + </para> + </listitem> + <listitem> + <para> + <link xlink:href="https://github.com/maxmind/geoipupdate">geoipupdate</link>, + a GeoIP database updater from MaxMind. Available as + <link xlink:href="options.html#opt-services.geoipupdate.enable">services.geoipupdate</link>. + </para> + </listitem> + <listitem> + <para> + <link xlink:href="https://www.isc.org/kea/">Kea</link>, ISCs + 2nd generation DHCP and DDNS server suite. Available at + <link xlink:href="options.html#opt-services.kea">services.kea</link>. + </para> + </listitem> + <listitem> + <para> + <link xlink:href="https://sr.ht">sourcehut</link>, a + collection of tools useful for software development. Available + as + <link xlink:href="options.html#opt-services.sourcehut.enable">services.sourcehut</link>. + </para> + </listitem> + <listitem> + <para> + <link xlink:href="https://download.pureftpd.org/pub/ucarp/README">ucarp</link>, + an userspace implementation of the Common Address Redundancy + Protocol (CARP). Available as + <link xlink:href="options.html#opt-networking.ucarp.enable">networking.ucarp</link>. + </para> + </listitem> + <listitem> + <para> + Users of flashrom should migrate to + <link xlink:href="options.html#opt-programs.flashrom.enable">programs.flashrom.enable</link> + and add themselves to the <literal>flashrom</literal> group to + be able to access programmers supported by flashrom. + </para> + </listitem> + <listitem> + <para> + <link xlink:href="https://vikunja.io">vikunja</link>, a to-do + list app. Available as + <link linkend="opt-services.vikunja.enable">services.vikunja</link>. + </para> + </listitem> + <listitem> + <para> + <link xlink:href="https://www.snapraid.it/">snapraid</link>, a + backup program for disk arrays. Available as + <link linkend="opt-snapraid.enable">snapraid</link>. + </para> + </listitem> + <listitem> + <para> + <link xlink:href="https://github.com/hockeypuck/hockeypuck">Hockeypuck</link>, + a OpenPGP Key Server. Available as + <link linkend="opt-services.hockeypuck.enable">services.hockeypuck</link>. + </para> + </listitem> + <listitem> + <para> + <link xlink:href="https://github.com/buildkite/buildkite-agent-metrics">buildkite-agent-metrics</link>, + a command-line tool for collecting Buildkite agent metrics, + now has a Prometheus exporter available as + <link linkend="opt-services.prometheus.exporters.buildkite-agent.enable">services.prometheus.exporters.buildkite-agent</link>. + </para> + </listitem> + </itemizedlist> + </section> + <section xml:id="sec-release-21.11-incompatibilities"> + <title>Backward Incompatibilities</title> + <itemizedlist> <listitem> <para> The <literal>staticjinja</literal> package has been upgraded - from 1.0.4 to 2.0.0 + from 1.0.4 to 3.0.1 + </para> + </listitem> + <listitem> + <para> + <literal>services.geoip-updater</literal> was broken and has + been replaced by + <link xlink:href="options.html#opt-services.geoipupdate.enable">services.geoipupdate</link>. + </para> + </listitem> + <listitem> + <para> + PHP 7.3 is no longer supported due to upstream not supporting + this version for the entire lifecycle of the 21.11 release. + </para> + </listitem> + <listitem> + <para> + Those making use of <literal>buildBazelPackage</literal> will + need to regenerate the fetch hashes (preferred), or set + <literal>fetchConfigured = false;</literal>. + </para> + </listitem> + <listitem> + <para> + <literal>consul</literal> was upgraded to a new major release + with breaking changes, see + <link xlink:href="https://github.com/hashicorp/consul/releases/tag/v1.10.0">upstream + changelog</link>. + </para> + </listitem> + <listitem> + <para> + fsharp41 has been removed in preference to use the latest + dotnet-sdk + </para> + </listitem> + <listitem> + <para> + The following F#-related packages have been removed for being + unmaintaned. Please use <literal>fetchNuGet</literal> for + specific packages. + </para> + <itemizedlist spacing="compact"> + <listitem> + <para> + ExtCore + </para> + </listitem> + <listitem> + <para> + Fake + </para> + </listitem> + <listitem> + <para> + Fantomas + </para> + </listitem> + <listitem> + <para> + FsCheck + </para> + </listitem> + <listitem> + <para> + FsCheck262 + </para> + </listitem> + <listitem> + <para> + FsCheckNunit + </para> + </listitem> + <listitem> + <para> + FSharpAutoComplete + </para> + </listitem> + <listitem> + <para> + FSharpCompilerCodeDom + </para> + </listitem> + <listitem> + <para> + FSharpCompilerService + </para> + </listitem> + <listitem> + <para> + FSharpCompilerTools + </para> + </listitem> + <listitem> + <para> + FSharpCore302 + </para> + </listitem> + <listitem> + <para> + FSharpCore3125 + </para> + </listitem> + <listitem> + <para> + FSharpCore4001 + </para> + </listitem> + <listitem> + <para> + FSharpCore4117 + </para> + </listitem> + <listitem> + <para> + FSharpData + </para> + </listitem> + <listitem> + <para> + FSharpData225 + </para> + </listitem> + <listitem> + <para> + FSharpDataSQLProvider + </para> + </listitem> + <listitem> + <para> + FSharpFormatting + </para> + </listitem> + <listitem> + <para> + FsLexYacc + </para> + </listitem> + <listitem> + <para> + FsLexYacc706 + </para> + </listitem> + <listitem> + <para> + FsLexYaccRuntime + </para> + </listitem> + <listitem> + <para> + FsPickler + </para> + </listitem> + <listitem> + <para> + FsUnit + </para> + </listitem> + <listitem> + <para> + Projekt + </para> + </listitem> + <listitem> + <para> + Suave + </para> + </listitem> + <listitem> + <para> + UnionArgParser + </para> + </listitem> + <listitem> + <para> + ExcelDnaRegistration + </para> + </listitem> + <listitem> + <para> + MathNetNumerics + </para> + </listitem> + </itemizedlist> + </listitem> + <listitem> + <para> + <literal>programs.x2goserver</literal> is now + <literal>services.x2goserver</literal> + </para> + </listitem> + <listitem> + <para> + The following dotnet-related packages have been removed for + being unmaintaned. Please use <literal>fetchNuGet</literal> + for specific packages. + </para> + <itemizedlist spacing="compact"> + <listitem> + <para> + Autofac + </para> + </listitem> + <listitem> + <para> + SystemValueTuple + </para> + </listitem> + <listitem> + <para> + MicrosoftDiaSymReader + </para> + </listitem> + <listitem> + <para> + MicrosoftDiaSymReaderPortablePdb + </para> + </listitem> + <listitem> + <para> + SystemCollectionsImmutable + </para> + </listitem> + <listitem> + <para> + SystemCollectionsImmutable131 + </para> + </listitem> + <listitem> + <para> + SystemReflectionMetadata + </para> + </listitem> + <listitem> + <para> + NUnit350 + </para> + </listitem> + <listitem> + <para> + Deedle + </para> + </listitem> + <listitem> + <para> + ExcelDna + </para> + </listitem> + <listitem> + <para> + GitVersionTree + </para> + </listitem> + <listitem> + <para> + NDeskOptions + </para> + </listitem> + </itemizedlist> + </listitem> + </itemizedlist> + <itemizedlist> + <listitem> + <para> + The <literal>antlr</literal> package now defaults to the 4.x + release instead of the old 2.7.7 version. + </para> + </listitem> + <listitem> + <para> + The <literal>pulseeffects</literal> package updated to + <link xlink:href="https://github.com/wwmm/easyeffects/releases/tag/v6.0.0">version + 4.x</link> and renamed to <literal>easyeffects</literal>. + </para> + </listitem> + <listitem> + <para> + The <literal>libwnck</literal> package now defaults to the 3.x + release instead of the old 2.31.0 version. + </para> + </listitem> + <listitem> + <para> + The <literal>bitwarden_rs</literal> packages and modules were + renamed to <literal>vaultwarden</literal> + <link xlink:href="https://github.com/dani-garcia/vaultwarden/discussions/1642">following + upstream</link>. More specifically, + </para> + <itemizedlist> + <listitem> + <para> + <literal>pkgs.bitwarden_rs</literal>, + <literal>pkgs.bitwarden_rs-sqlite</literal>, + <literal>pkgs.bitwarden_rs-mysql</literal> and + <literal>pkgs.bitwarden_rs-postgresql</literal> were + renamed to <literal>pkgs.vaultwarden</literal>, + <literal>pkgs.vaultwarden-sqlite</literal>, + <literal>pkgs.vaultwarden-mysql</literal> and + <literal>pkgs.vaultwarden-postgresql</literal>, + respectively. + </para> + <itemizedlist spacing="compact"> + <listitem> + <para> + Old names are preserved as aliases for backwards + compatibility, but may be removed in the future. + </para> + </listitem> + <listitem> + <para> + The <literal>bitwarden_rs</literal> executable was + also renamed to <literal>vaultwarden</literal> in all + packages. + </para> + </listitem> + </itemizedlist> + </listitem> + <listitem> + <para> + <literal>pkgs.bitwarden_rs-vault</literal> was renamed to + <literal>pkgs.vaultwarden-vault</literal>. + </para> + <itemizedlist spacing="compact"> + <listitem> + <para> + <literal>pkgs.bitwarden_rs-vault</literal> is + preserved as an alias for backwards compatibility, but + may be removed in the future. + </para> + </listitem> + <listitem> + <para> + The static files were moved from + <literal>/usr/share/bitwarden_rs</literal> to + <literal>/usr/share/vaultwarden</literal>. + </para> + </listitem> + </itemizedlist> + </listitem> + <listitem> + <para> + The <literal>services.bitwarden_rs</literal> config module + was renamed to <literal>services.vaultwarden</literal>. + </para> + <itemizedlist spacing="compact"> + <listitem> + <para> + <literal>services.bitwarden_rs</literal> is preserved + as an alias for backwards compatibility, but may be + removed in the future. + </para> + </listitem> + </itemizedlist> + </listitem> + <listitem> + <para> + <literal>systemd.services.bitwarden_rs</literal>, + <literal>systemd.services.backup-bitwarden_rs</literal> + and <literal>systemd.timers.backup-bitwarden_rs</literal> + were renamed to + <literal>systemd.services.vaultwarden</literal>, + <literal>systemd.services.backup-vaultwarden</literal> and + <literal>systemd.timers.backup-vaultwarden</literal>, + respectively. + </para> + <itemizedlist spacing="compact"> + <listitem> + <para> + Old names are preserved as aliases for backwards + compatibility, but may be removed in the future. + </para> + </listitem> + </itemizedlist> + </listitem> + <listitem> + <para> + <literal>users.users.bitwarden_rs</literal> and + <literal>users.groups.bitwarden_rs</literal> were renamed + to <literal>users.users.vaultwarden</literal> and + <literal>users.groups.vaultwarden</literal>, respectively. + </para> + </listitem> + <listitem> + <para> + The data directory remains located at + <literal>/var/lib/bitwarden_rs</literal>, for backwards + compatibility. + </para> + </listitem> + </itemizedlist> + </listitem> + </itemizedlist> + <itemizedlist> + <listitem> + <para> + <literal>yggdrasil</literal> was upgraded to a new major + release with breaking changes, see + <link xlink:href="https://github.com/yggdrasil-network/yggdrasil-go/releases/tag/v0.4.0">upstream + changelog</link>. + </para> + </listitem> + <listitem> + <para> + <literal>icingaweb2</literal> was upgraded to a new release + which requires a manual database upgrade, see + <link xlink:href="https://github.com/Icinga/icingaweb2/releases/tag/v2.9.0">upstream + changelog</link>. + </para> + </listitem> + <listitem> + <para> + The <literal>isabelle</literal> package has been upgraded from + 2020 to 2021 + </para> + </listitem> + <listitem> + <para> + the <literal>mingw-64</literal> package has been upgraded from + 6.0.0 to 9.0.0 + </para> + </listitem> + </itemizedlist> + </section> + <section xml:id="sec-release-21.11-notable-changes"> + <title>Other Notable Changes</title> + <itemizedlist> + <listitem> + <para> + The setting + <link xlink:href="options.html#opt-services.openssh.logLevel"><literal>services.openssh.logLevel</literal></link> + <literal>"VERBOSE"</literal> + <literal>"INFO"</literal>. This brings NixOS in line + with upstream and other Linux distributions, and reduces log + spam on servers due to bruteforcing botnets. + </para> + <para> + However, if + <link xlink:href="options.html#opt-services.fail2ban.enable"><literal>services.fail2ban.enable</literal></link> + is <literal>true</literal>, the <literal>fail2ban</literal> + will override the verbosity to + <literal>"VERBOSE"</literal>, so that + <literal>fail2ban</literal> can observe the failed login + attempts from the SSH logs. + </para> + </listitem> + <listitem> + <para> + Sway: The terminal emulator <literal>rxvt-unicode</literal> is + no longer installed by default via + <literal>programs.sway.extraPackages</literal>. The current + default configuration uses <literal>alacritty</literal> (and + soon <literal>foot</literal>) so this is only an issue when + using a customized configuration and not installing + <literal>rxvt-unicode</literal> explicitly. + </para> + </listitem> + <listitem> + <para> + <literal>python3</literal> now defaults to Python 3.9. Python + 3.9 introduces many deprecation warnings, please look at the + <link xlink:href="https://docs.python.org/3/whatsnew/3.9.html">What’s + New In Python 3.9 post</link> for more information. + </para> + </listitem> + <listitem> + <para> + The <literal>claws-mail</literal> package now references the + new GTK+ 3 release branch, major version 4. To use the GTK+ 2 + releases, one can install the + <literal>claws-mail-gtk2</literal> package. + </para> + </listitem> + <listitem> + <para> + The wordpress module provides a new interface which allows to + use different webservers with the new option + <link xlink:href="options.html#opt-services.wordpress.webserver"><literal>services.wordpress.webserver</literal></link>. + Currently <literal>httpd</literal> and + <literal>nginx</literal> are supported. The definitions of + wordpress sites should now be set in + <link xlink:href="options.html#opt-services.wordpress.sites"><literal>services.wordpress.sites</literal></link>. + </para> + <para> + Sites definitions that use the old interface are automatically + migrated in the new option. This backward compatibility will + be removed in 22.05. + </para> + </listitem> + <listitem> + <para> + The order of NSS (host) modules has been brought in line with + upstream recommendations: + </para> + <itemizedlist spacing="compact"> + <listitem> + <para> + The <literal>myhostname</literal> module is placed before + the <literal>resolve</literal> (optional) and + <literal>dns</literal> entries, but after + <literal>file</literal> (to allow overriding via + <literal>/etc/hosts</literal> / + <literal>networking.extraHosts</literal>, and prevent ISPs + with catchall-DNS resolvers from hijacking + <literal>.localhost</literal> domains) + </para> + </listitem> + <listitem> + <para> + The <literal>mymachines</literal> module, which provides + hostname resolution for local containers (registered with + <literal>systemd-machined</literal>) is placed to the + front, to make sure its mappings are preferred over other + resolvers. + </para> + </listitem> + <listitem> + <para> + If systemd-networkd is enabled, the + <literal>resolve</literal> module is placed before + <literal>files</literal> and + <literal>myhostname</literal>, as it provides the same + logic internally, with caching. + </para> + </listitem> + <listitem> + <para> + The <literal>mdns(_minimal)</literal> module has been + updated to the new priorities. + </para> + </listitem> + </itemizedlist> + <para> + If you use your own NSS host modules, make sure to update your + priorities according to these rules: + </para> + <itemizedlist spacing="compact"> + <listitem> + <para> + NSS modules which should be queried before + <literal>resolved</literal> DNS resolution should use + mkBefore. + </para> + </listitem> + <listitem> + <para> + NSS modules which should be queried after + <literal>resolved</literal>, <literal>files</literal> and + <literal>myhostname</literal>, but before + <literal>dns</literal> should use the default priority + </para> + </listitem> + <listitem> + <para> + NSS modules which should come after <literal>dns</literal> + should use mkAfter. + </para> + </listitem> + </itemizedlist> + </listitem> + <listitem> + <para> + The + <link xlink:href="options.html#opt-networking.wireless.iwd.enable">networking.wireless.iwd</link> + module has a new + <link xlink:href="options.html#opt-networking.wireless.iwd.settings">networking.wireless.iwd.settings</link> + option. </para> </listitem> </itemizedlist> diff --git a/nixos/doc/manual/installation/installing.xml b/nixos/doc/manual/installation/installing.xml index f03b9443d23..d019bb31809 100644 --- a/nixos/doc/manual/installation/installing.xml +++ b/nixos/doc/manual/installation/installing.xml @@ -446,8 +446,8 @@ password for the <literal>root</literal> user, e.g. <screen> setting root password... -Enter new UNIX password: *** -Retype new UNIX password: ***</screen> +New password: *** +Retype new password: ***</screen> <note> <para> For unattended installations, it is possible to use diff --git a/nixos/doc/manual/installation/upgrading.xml b/nixos/doc/manual/installation/upgrading.xml index 15ba5db9a37..960d4fa9a43 100644 --- a/nixos/doc/manual/installation/upgrading.xml +++ b/nixos/doc/manual/installation/upgrading.xml @@ -14,7 +14,7 @@ <para> <emphasis>Stable channels</emphasis>, such as <literal - xlink:href="https://nixos.org/channels/nixos-20.09">nixos-20.09</literal>. + xlink:href="https://nixos.org/channels/nixos-21.05">nixos-21.05</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 @@ -38,7 +38,7 @@ <para> <emphasis>Small channels</emphasis>, such as <literal - xlink:href="https://nixos.org/channels/nixos-20.09-small">nixos-20.09-small</literal> + xlink:href="https://nixos.org/channels/nixos-21.05-small">nixos-21.05-small</literal> or <literal xlink:href="https://nixos.org/channels/nixos-unstable-small">nixos-unstable-small</literal>. @@ -63,8 +63,8 @@ <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 20.09 ISO, you will be subscribed to the - <literal>nixos-20.09</literal> channel. To see which NixOS channel you’re + installed from a 21.05 ISO, you will be subscribed to the + <literal>nixos-21.05</literal> channel. To see which NixOS channel you’re subscribed to, run the following as root: <screen> <prompt># </prompt>nix-channel --list | grep nixos @@ -75,13 +75,13 @@ nixos https://nixos.org/channels/nixos-unstable <prompt># </prompt>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 20.09 stable channel: + instance, to use the NixOS 21.05 stable channel: <screen> -<prompt># </prompt>nix-channel --add https://nixos.org/channels/nixos-20.09 nixos +<prompt># </prompt>nix-channel --add https://nixos.org/channels/nixos-21.05 nixos </screen> If you have a server, you may want to use the “small” channel instead: <screen> -<prompt># </prompt>nix-channel --add https://nixos.org/channels/nixos-20.09-small nixos +<prompt># </prompt>nix-channel --add https://nixos.org/channels/nixos-21.05-small nixos </screen> And if you want to live on the bleeding edge: <screen> @@ -132,7 +132,7 @@ nixos https://nixos.org/channels/nixos-unstable kernel, initrd or kernel modules. You can also specify a channel explicitly, e.g. <programlisting> -<xref linkend="opt-system.autoUpgrade.channel"/> = https://nixos.org/channels/nixos-20.09; +<xref linkend="opt-system.autoUpgrade.channel"/> = https://nixos.org/channels/nixos-21.05; </programlisting> </para> </section> diff --git a/nixos/doc/manual/man-nixos-rebuild.xml b/nixos/doc/manual/man-nixos-rebuild.xml index d0ff81c1dbb..8c34ea7458e 100644 --- a/nixos/doc/manual/man-nixos-rebuild.xml +++ b/nixos/doc/manual/man-nixos-rebuild.xml @@ -91,6 +91,10 @@ <option>--flake</option> <replaceable>flake-uri</replaceable> </arg> + <arg> + <option>--override-input</option> <replaceable>input-name</replaceable> <replaceable>flake-uri</replaceable> + </arg> + <sbr /> <arg> @@ -104,7 +108,23 @@ </arg> </group> <replaceable>name</replaceable> </arg> + + <sbr /> + + <arg> + <option>--build-host</option> <replaceable>host</replaceable> + </arg> + + <arg> + <option>--target-host</option> <replaceable>host</replaceable> + </arg> + + <arg> + <option>--use-remote-sudo</option> + </arg> + <sbr /> + <arg> <option>--show-trace</option> </arg> @@ -402,10 +422,9 @@ </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>. 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> diff --git a/nixos/doc/manual/md-to-db.sh b/nixos/doc/manual/md-to-db.sh index fc4be7da22b..7949b42e8d8 100755 --- a/nixos/doc/manual/md-to-db.sh +++ b/nixos/doc/manual/md-to-db.sh @@ -8,25 +8,31 @@ DIR="$( cd "$( dirname "${BASH_SOURCE[0]}" )" >/dev/null 2>&1 && pwd )" pushd $DIR +# NOTE: Keep in sync with Nixpkgs manual (/doc/Makefile). +# TODO: Remove raw-attribute when we can get rid of DocBook altogether. +pandoc_commonmark_enabled_extensions=+attributes+fenced_divs+footnotes+bracketed_spans+definition_lists+pipe_tables+raw_attribute +pandoc_flags=( + # media extraction and diagram-generator.lua not needed + "--lua-filter=$DIR/../../../doc/labelless-link-is-xref.lua" + -f "commonmark${pandoc_commonmark_enabled_extensions}+smart" + -t docbook +) + OUT="$DIR/from_md" mapfile -t MD_FILES < <(find . -type f -regex '.*\.md$') for mf in ${MD_FILES[*]}; do if [ "${mf: -11}" == ".section.md" ]; then mkdir -p $(dirname "$OUT/$mf") - pandoc "$mf" -t docbook \ - --extract-media=media \ - -f markdown+smart \ - | cat > "$OUT/${mf%".section.md"}.section.xml" + pandoc "$mf" "${pandoc_flags[@]}" \ + -o "$OUT/${mf%".section.md"}.section.xml" fi if [ "${mf: -11}" == ".chapter.md" ]; then mkdir -p $(dirname "$OUT/$mf") - pandoc "$mf" -t docbook \ + pandoc "$mf" "${pandoc_flags[@]}" \ --top-level-division=chapter \ - --extract-media=media \ - -f markdown+smart \ - | cat > "$OUT/${mf%".chapter.md"}.chapter.xml" + -o "$OUT/${mf%".chapter.md"}.chapter.xml" fi done diff --git a/nixos/doc/manual/preface.xml b/nixos/doc/manual/preface.xml index 0f7db6ef1a8..c0d530c3d1b 100644 --- a/nixos/doc/manual/preface.xml +++ b/nixos/doc/manual/preface.xml @@ -18,12 +18,13 @@ <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>, or - consider - <link + xlink:href="https://discourse.nixos.org">Discourse</literal>, + the <link + xlink:href="https://matrix.to/#nix:nixos.org">Matrix room</link>, + or on the <link + xlink:href="irc://irc.libera.chat/#nixos"> + <literal>#nixos</literal> channel on Libera.Chat</link>. + Alternatively, consider <link xlink:href="#chap-contributing"> contributing to this manual</link>. Bugs should be reported in diff --git a/nixos/doc/manual/release-notes/release-notes.xml b/nixos/doc/manual/release-notes/release-notes.xml index 6d7899f6dcd..74ca57850ea 100644 --- a/nixos/doc/manual/release-notes/release-notes.xml +++ b/nixos/doc/manual/release-notes/release-notes.xml @@ -9,19 +9,19 @@ current unstable revision. </para> <xi:include href="../from_md/release-notes/rl-2111.section.xml" /> - <xi:include href="rl-2105.xml" /> - <xi:include href="rl-2009.xml" /> - <xi:include href="rl-2003.xml" /> - <xi:include href="rl-1909.xml" /> - <xi:include href="rl-1903.xml" /> - <xi:include href="rl-1809.xml" /> - <xi:include href="rl-1803.xml" /> - <xi:include href="rl-1709.xml" /> - <xi:include href="rl-1703.xml" /> - <xi:include href="rl-1609.xml" /> - <xi:include href="rl-1603.xml" /> - <xi:include href="rl-1509.xml" /> - <xi:include href="rl-1412.xml" /> - <xi:include href="rl-1404.xml" /> - <xi:include href="rl-1310.xml" /> + <xi:include href="../from_md/release-notes/rl-2105.section.xml" /> + <xi:include href="../from_md/release-notes/rl-2009.section.xml" /> + <xi:include href="../from_md/release-notes/rl-2003.section.xml" /> + <xi:include href="../from_md/release-notes/rl-1909.section.xml" /> + <xi:include href="../from_md/release-notes/rl-1903.section.xml" /> + <xi:include href="../from_md/release-notes/rl-1809.section.xml" /> + <xi:include href="../from_md/release-notes/rl-1803.section.xml" /> + <xi:include href="../from_md/release-notes/rl-1709.section.xml" /> + <xi:include href="../from_md/release-notes/rl-1703.section.xml" /> + <xi:include href="../from_md/release-notes/rl-1609.section.xml" /> + <xi:include href="../from_md/release-notes/rl-1603.section.xml" /> + <xi:include href="../from_md/release-notes/rl-1509.section.xml" /> + <xi:include href="../from_md/release-notes/rl-1412.section.xml" /> + <xi:include href="../from_md/release-notes/rl-1404.section.xml" /> + <xi:include href="../from_md/release-notes/rl-1310.section.xml" /> </appendix> diff --git a/nixos/doc/manual/release-notes/rl-1310.section.md b/nixos/doc/manual/release-notes/rl-1310.section.md new file mode 100644 index 00000000000..9efd8f6e8a1 --- /dev/null +++ b/nixos/doc/manual/release-notes/rl-1310.section.md @@ -0,0 +1,3 @@ +# Release 13.10 ("Aardvark", 2013/10/31) {#sec-release-13.10} + +This is the first stable release branch of NixOS. diff --git a/nixos/doc/manual/release-notes/rl-1310.xml b/nixos/doc/manual/release-notes/rl-1310.xml deleted file mode 100644 index 248bab70c36..00000000000 --- a/nixos/doc/manual/release-notes/rl-1310.xml +++ /dev/null @@ -1,11 +0,0 @@ -<section xmlns="http://docbook.org/ns/docbook" - xmlns:xlink="http://www.w3.org/1999/xlink" - xmlns:xi="http://www.w3.org/2001/XInclude" - version="5.0" - xml:id="sec-release-13.10"> - <title>Release 13.10 (“Aardvark”, 2013/10/31)</title> - - <para> - This is the first stable release branch of NixOS. - </para> -</section> diff --git a/nixos/doc/manual/release-notes/rl-1404.section.md b/nixos/doc/manual/release-notes/rl-1404.section.md new file mode 100644 index 00000000000..e0a70df3a63 --- /dev/null +++ b/nixos/doc/manual/release-notes/rl-1404.section.md @@ -0,0 +1,81 @@ +# Release 14.04 ("Baboon", 2014/04/30) {#sec-release-14.04} + +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: + +- Installation on UEFI systems is now supported. See [](#sec-installation) for details. + +- Systemd has been updated to version 212, which has [numerous improvements](http://cgit.freedesktop.org/systemd/systemd/plain/NEWS?id=v212). NixOS now automatically starts systemd user instances when you log in. You can define global user units through the `systemd.unit.*` options. + +- NixOS is now based on Glibc 2.19 and GCC 4.8. + +- The default Linux kernel has been updated to 3.12. + +- KDE has been updated to 4.12. + +- GNOME 3.10 experimental support has been added. + +- Nix has been updated to 1.7 ([details](https://nixos.org/nix/manual/#ssec-relnotes-1.7)). + +- NixOS now supports fully declarative management of users and groups. If you set `users.mutableUsers` to `false`, then the contents of `/etc/passwd` and `/etc/group` will be [congruent](https://www.usenix.org/legacy/event/lisa02/tech/full_papers/traugott/traugott_html/) to your NixOS configuration. For instance, if you remove a user from `users.extraUsers` 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. If `users.mutableUsers` is `true` (the default), then behaviour is unchanged from NixOS 13.10. + +- 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 [](#ch-containers) for details. + +- Systemd units provided by packages can now be overridden from the NixOS configuration. For instance, if a package `foo` provides systemd units, you can say: + + ```nix + { + systemd.packages = [ pkgs.foo ]; + } + ``` + + to enable those units. You can then set or override unit options in the usual way, e.g. + + ```nix + { + systemd.services.foo.wantedBy = [ "multi-user.target" ]; + systemd.services.foo.serviceConfig.MemoryLimit = "512M"; + } + ``` + + When upgrading from a previous release, please be aware of the following incompatible changes: + +- 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: + + ```nix + { + nixpkgs.config.allowUnfree = true; + } + ``` + + Otherwise, you get an error message such as: + + ```ShellSession + error: package ‘nvidia-x11-331.49-3.12.17’ in ‘…/nvidia-x11/default.nix:56’ + has an unfree license, refusing to evaluate + ``` + +- The Adobe Flash player is no longer enabled by default in the Firefox and Chromium wrappers. To enable it, you must set: + + ```nix + { + nixpkgs.config.allowUnfree = true; + nixpkgs.config.firefox.enableAdobeFlash = true; # for Firefox + nixpkgs.config.chromium.enableAdobeFlash = true; # for Chromium + } + ``` + +- The firewall is now enabled by default. If you don't want this, you need to disable it explicitly: + + ```nix + { + networking.firewall.enable = false; + } + ``` + +- The option `boot.loader.grub.memtest86` has been renamed to `boot.loader.grub.memtest86.enable`. + +- The `mysql55` service has been merged into the `mysql` service, which no longer sets a default for the option `services.mysql.package`. + +- Package variants are now differentiated by suffixing the name, rather than the version. For instance, `sqlite-3.8.4.3-interactive` is now called `sqlite-interactive-3.8.4.3`. This ensures that `nix-env -i sqlite` is unambiguous, and that `nix-env -u` won't "upgrade" `sqlite` to `sqlite-interactive` or vice versa. Notably, this change affects the Firefox wrapper (which provides plugins), as it is now called `firefox-wrapper`. So when using `nix-env`, you should do `nix-env -e firefox; nix-env -i firefox-wrapper` if you want to keep using the wrapper. This change does not affect declarative package management, since attribute names like `pkgs.firefoxWrapper` were already unambiguous. + +- The symlink `/etc/ca-bundle.crt` is gone. Programs should instead use the environment variable `OPENSSL_X509_CERT_FILE` (which points to `/etc/ssl/certs/ca-bundle.crt`). diff --git a/nixos/doc/manual/release-notes/rl-1404.xml b/nixos/doc/manual/release-notes/rl-1404.xml deleted file mode 100644 index 56dbb74a71d..00000000000 --- a/nixos/doc/manual/release-notes/rl-1404.xml +++ /dev/null @@ -1,179 +0,0 @@ -<section xmlns="http://docbook.org/ns/docbook" - xmlns:xlink="http://www.w3.org/1999/xlink" - xmlns:xi="http://www.w3.org/2001/XInclude" - version="5.0" - xml:id="sec-release-14.04"> - <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: - <itemizedlist> - <listitem> - <para> - 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. - </para> - </listitem> - <listitem> - <para> - NixOS is now based on Glibc 2.19 and GCC 4.8. - </para> - </listitem> - <listitem> - <para> - The default Linux kernel has been updated to 3.12. - </para> - </listitem> - <listitem> - <para> - KDE has been updated to 4.12. - </para> - </listitem> - <listitem> - <para> - GNOME 3.10 experimental support has been added. - </para> - </listitem> - <listitem> - <para> - Nix has been updated to 1.7 - (<link - xlink:href="https://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. - </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. - </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: -<programlisting> -systemd.packages = [ pkgs.foo ]; -</programlisting> - 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"; -</programlisting> - </para> - </listitem> - </itemizedlist> - </para> - - <para> - 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: -<programlisting> -nixpkgs.config.allowUnfree = true; -</programlisting> - Otherwise, you get an error message such as: -<screen> -error: package ‘nvidia-x11-331.49-3.12.17’ in ‘…/nvidia-x11/default.nix:56’ - has an unfree license, refusing to evaluate -</screen> - </para> - </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: -<programlisting> -nixpkgs.config.allowUnfree = true; -nixpkgs.config.firefox.enableAdobeFlash = true; # for Firefox -nixpkgs.config.chromium.enableAdobeFlash = true; # for Chromium -</programlisting> - </para> - </listitem> - <listitem> - <para> - 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> - </para> - </listitem> - <listitem> - <para> - 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>. - </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. - </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>). - </para> - </listitem> - </itemizedlist> - </para> -</section> diff --git a/nixos/doc/manual/release-notes/rl-1412.section.md b/nixos/doc/manual/release-notes/rl-1412.section.md new file mode 100644 index 00000000000..683f1e45f09 --- /dev/null +++ b/nixos/doc/manual/release-notes/rl-1412.section.md @@ -0,0 +1,171 @@ +# Release 14.12 ("Caterpillar", 2014/12/30) {#sec-release-14.12} + +In addition to numerous new and upgraded packages, this release has the following highlights: + +- Systemd has been updated to version 217, which has numerous [improvements.](http://lists.freedesktop.org/archives/systemd-devel/2014-October/024662.html) + +- [Nix has been updated to 1.8.](https://www.mail-archive.com/nix-dev@lists.science.uu.nl/msg13957.html) + +- NixOS is now based on Glibc 2.20. + +- KDE has been updated to 4.14. + +- The default Linux kernel has been updated to 3.14. + +- If `users.mutableUsers` is enabled (the default), changes made to the declaration of a user or group will be correctly realised when running `nixos-rebuild`. For instance, removing a user specification from `configuration.nix` will cause the actual user account to be deleted. If `users.mutableUsers` is disabled, it is no longer necessary to specify UIDs or GIDs; if omitted, they are allocated dynamically. + +Following new services were added since the last release: + +- `atftpd` + +- `bosun` + +- `bspwm` + +- `chronos` + +- `collectd` + +- `consul` + +- `cpuminer-cryptonight` + +- `crashplan` + +- `dnscrypt-proxy` + +- `docker-registry` + +- `docker` + +- `etcd` + +- `fail2ban` + +- `fcgiwrap` + +- `fleet` + +- `fluxbox` + +- `gdm` + +- `geoclue2` + +- `gitlab` + +- `gitolite` + +- `gnome3.gnome-documents` + +- `gnome3.gnome-online-miners` + +- `gnome3.gvfs` + +- `gnome3.seahorse` + +- `hbase` + +- `i2pd` + +- `influxdb` + +- `kubernetes` + +- `liquidsoap` + +- `lxc` + +- `mailpile` + +- `mesos` + +- `mlmmj` + +- `monetdb` + +- `mopidy` + +- `neo4j` + +- `nsd` + +- `openntpd` + +- `opentsdb` + +- `openvswitch` + +- `parallels-guest` + +- `peerflix` + +- `phd` + +- `polipo` + +- `prosody` + +- `radicale` + +- `redmine` + +- `riemann` + +- `scollector` + +- `seeks` + +- `siproxd` + +- `strongswan` + +- `tcsd` + +- `teamspeak3` + +- `thermald` + +- `torque/mrom` + +- `torque/server` + +- `uhub` + +- `unifi` + +- `znc` + +- `zookeeper` + +When upgrading from a previous release, please be aware of the following incompatible changes: + +- The default version of Apache httpd is now 2.4. If you use the `extraConfig` option to pass literal Apache configuration text, you may need to update it --- see [Apache's documentation](http://httpd.apache.org/docs/2.4/upgrading.html) for details. If you wish to continue to use httpd 2.2, add the following line to your NixOS configuration: + + ```nix + { + services.httpd.package = pkgs.apacheHttpd_2_2; + } + ``` + +- PHP 5.3 has been removed because it is no longer supported by the PHP project. A [migration guide](http://php.net/migration54) is available. + +- The host side of a container virtual Ethernet pair is now called `ve-container-name` rather than `c-container-name`. + +- GNOME 3.10 support has been dropped. The default GNOME version is now 3.12. + +- VirtualBox has been upgraded to 4.3.20 release. Users may be required to run `rm -rf /tmp/.vbox*`. The line `imports = [ <nixpkgs/nixos/modules/programs/virtualbox.nix> ]` is no longer necessary, use `services.virtualboxHost.enable = true` instead. + + 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 `vboxusers` group. + +- Chromium has been updated to 39.0.2171.65. `enablePepperPDF` is now enabled by default. `chromium*Wrapper` packages no longer exist, because upstream removed NSAPI support. `chromium-stable` has been renamed to `chromium`. + +- Python packaging documentation is now part of nixpkgs manual. To override the python packages available to a custom python you now use `pkgs.pythonFull.buildEnv.override` instead of `pkgs.pythonFull.override`. + +- `boot.resumeDevice = "8:6"` 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. + +- The system-wide default timezone for NixOS installations changed from `CET` to `UTC`. To choose a different timezone for your system, configure `time.timeZone` in `configuration.nix`. A fairly complete list of possible values for that setting is available at <https://en.wikipedia.org/wiki/List_of_tz_database_time_zones>. + +- GNU screen has been updated to 4.2.1, which breaks the ability to connect to sessions created by older versions of screen. + +- The Intel GPU driver was updated to the 3.x prerelease version (used by most distributions) and supports DRI3 now. diff --git a/nixos/doc/manual/release-notes/rl-1412.xml b/nixos/doc/manual/release-notes/rl-1412.xml deleted file mode 100644 index 139f61c2a55..00000000000 --- a/nixos/doc/manual/release-notes/rl-1412.xml +++ /dev/null @@ -1,467 +0,0 @@ -<section xmlns="http://docbook.org/ns/docbook" - xmlns:xlink="http://www.w3.org/1999/xlink" - xmlns:xi="http://www.w3.org/2001/XInclude" - version="5.0" - xml:id="sec-release-14.12"> - <title>Release 14.12 (“Caterpillar”, 2014/12/30)</title> - - <para> - 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> - </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> - </para> - </listitem> - <listitem> - <para> - NixOS is now based on Glibc 2.20. - </para> - </listitem> - <listitem> - <para> - KDE has been updated to 4.14. - </para> - </listitem> - <listitem> - <para> - The default Linux kernel has been updated to 3.14. - </para> - </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. - </para> - </listitem> - </itemizedlist> - </para> - - <para> - Following new services were added since the last release: - <itemizedlist> - <listitem> - <para> - <literal>atftpd</literal> - </para> - </listitem> - <listitem> - <para> - <literal>bosun</literal> - </para> - </listitem> - <listitem> - <para> - <literal>bspwm</literal> - </para> - </listitem> - <listitem> - <para> - <literal>chronos</literal> - </para> - </listitem> - <listitem> - <para> - <literal>collectd</literal> - </para> - </listitem> - <listitem> - <para> - <literal>consul</literal> - </para> - </listitem> - <listitem> - <para> - <literal>cpuminer-cryptonight</literal> - </para> - </listitem> - <listitem> - <para> - <literal>crashplan</literal> - </para> - </listitem> - <listitem> - <para> - <literal>dnscrypt-proxy</literal> - </para> - </listitem> - <listitem> - <para> - <literal>docker-registry</literal> - </para> - </listitem> - <listitem> - <para> - <literal>docker</literal> - </para> - </listitem> - <listitem> - <para> - <literal>etcd</literal> - </para> - </listitem> - <listitem> - <para> - <literal>fail2ban</literal> - </para> - </listitem> - <listitem> - <para> - <literal>fcgiwrap</literal> - </para> - </listitem> - <listitem> - <para> - <literal>fleet</literal> - </para> - </listitem> - <listitem> - <para> - <literal>fluxbox</literal> - </para> - </listitem> - <listitem> - <para> - <literal>gdm</literal> - </para> - </listitem> - <listitem> - <para> - <literal>geoclue2</literal> - </para> - </listitem> - <listitem> - <para> - <literal>gitlab</literal> - </para> - </listitem> - <listitem> - <para> - <literal>gitolite</literal> - </para> - </listitem> - <listitem> - <para> - <literal>gnome3.gnome-documents</literal> - </para> - </listitem> - <listitem> - <para> - <literal>gnome3.gnome-online-miners</literal> - </para> - </listitem> - <listitem> - <para> - <literal>gnome3.gvfs</literal> - </para> - </listitem> - <listitem> - <para> - <literal>gnome3.seahorse</literal> - </para> - </listitem> - <listitem> - <para> - <literal>hbase</literal> - </para> - </listitem> - <listitem> - <para> - <literal>i2pd</literal> - </para> - </listitem> - <listitem> - <para> - <literal>influxdb</literal> - </para> - </listitem> - <listitem> - <para> - <literal>kubernetes</literal> - </para> - </listitem> - <listitem> - <para> - <literal>liquidsoap</literal> - </para> - </listitem> - <listitem> - <para> - <literal>lxc</literal> - </para> - </listitem> - <listitem> - <para> - <literal>mailpile</literal> - </para> - </listitem> - <listitem> - <para> - <literal>mesos</literal> - </para> - </listitem> - <listitem> - <para> - <literal>mlmmj</literal> - </para> - </listitem> - <listitem> - <para> - <literal>monetdb</literal> - </para> - </listitem> - <listitem> - <para> - <literal>mopidy</literal> - </para> - </listitem> - <listitem> - <para> - <literal>neo4j</literal> - </para> - </listitem> - <listitem> - <para> - <literal>nsd</literal> - </para> - </listitem> - <listitem> - <para> - <literal>openntpd</literal> - </para> - </listitem> - <listitem> - <para> - <literal>opentsdb</literal> - </para> - </listitem> - <listitem> - <para> - <literal>openvswitch</literal> - </para> - </listitem> - <listitem> - <para> - <literal>parallels-guest</literal> - </para> - </listitem> - <listitem> - <para> - <literal>peerflix</literal> - </para> - </listitem> - <listitem> - <para> - <literal>phd</literal> - </para> - </listitem> - <listitem> - <para> - <literal>polipo</literal> - </para> - </listitem> - <listitem> - <para> - <literal>prosody</literal> - </para> - </listitem> - <listitem> - <para> - <literal>radicale</literal> - </para> - </listitem> - <listitem> - <para> - <literal>redmine</literal> - </para> - </listitem> - <listitem> - <para> - <literal>riemann</literal> - </para> - </listitem> - <listitem> - <para> - <literal>scollector</literal> - </para> - </listitem> - <listitem> - <para> - <literal>seeks</literal> - </para> - </listitem> - <listitem> - <para> - <literal>siproxd</literal> - </para> - </listitem> - <listitem> - <para> - <literal>strongswan</literal> - </para> - </listitem> - <listitem> - <para> - <literal>tcsd</literal> - </para> - </listitem> - <listitem> - <para> - <literal>teamspeak3</literal> - </para> - </listitem> - <listitem> - <para> - <literal>thermald</literal> - </para> - </listitem> - <listitem> - <para> - <literal>torque/mrom</literal> - </para> - </listitem> - <listitem> - <para> - <literal>torque/server</literal> - </para> - </listitem> - <listitem> - <para> - <literal>uhub</literal> - </para> - </listitem> - <listitem> - <para> - <literal>unifi</literal> - </para> - </listitem> - <listitem> - <para> - <literal>znc</literal> - </para> - </listitem> - <listitem> - <para> - <literal>zookeeper</literal> - </para> - </listitem> - </itemizedlist> - </para> - - <para> - 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: -<programlisting> -services.httpd.package = pkgs.apacheHttpd_2_2; -</programlisting> - </para> - </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. - </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>. - </para> - </listitem> - <listitem> - <para> - 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. - </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. - </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>. - </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>. - </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. - </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 -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. - </para> - </listitem> - <listitem> - <para> - The Intel GPU driver was updated to the 3.x prerelease version (used by - most distributions) and supports DRI3 now. - </para> - </listitem> - </itemizedlist> - </para> -</section> diff --git a/nixos/doc/manual/release-notes/rl-1509.section.md b/nixos/doc/manual/release-notes/rl-1509.section.md new file mode 100644 index 00000000000..55804ddb988 --- /dev/null +++ b/nixos/doc/manual/release-notes/rl-1509.section.md @@ -0,0 +1,319 @@ +# Release 15.09 ("Dingo", 2015/09/30) {#sec-release-15.09} + +In addition to numerous new and upgraded packages, this release has the following highlights: + +- The [Haskell](http://haskell.org/) packages infrastructure has been re-designed from the ground up (\"Haskell NG\"). NixOS now distributes the latest version of every single package registered on [Hackage](http://hackage.haskell.org/) \-- well in excess of 8,000 Haskell packages. Detailed instructions on how to use that infrastructure can be found in the [User\'s Guide to the Haskell Infrastructure](https://nixos.org/nixpkgs/manual/#users-guide-to-the-haskell-infrastructure). 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 [LTS Haskell](http://www.stackage.org/) release since version 0.0 as well as the most recent [Stackage Nightly](http://www.stackage.org/) snapshot. The announcement [\"Full Stackage Support in Nixpkgs\"](https://nixos.org/nix-dev/2015-September/018138.html) gives additional details. + +- Nix has been updated to version 1.10, which among other improvements enables cryptographic signatures on binary caches for improved security. + +- You can now keep your NixOS system up to date automatically by setting + +```nix +{ + system.autoUpgrade.enable = true; +} +``` + +This will cause the system to periodically check for updates in your current channel and run `nixos-rebuild`. + +- This release is based on Glibc 2.21, GCC 4.9 and Linux 3.18. + +- GNOME has been upgraded to 3.16. + +- Xfce has been upgraded to 4.12. + +- 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. + +- E19 has been upgraded to 0.16.8.15. + +The following new services were added since the last release: + +- `services/mail/exim.nix` + +- `services/misc/apache-kafka.nix` + +- `services/misc/canto-daemon.nix` + +- `services/misc/confd.nix` + +- `services/misc/devmon.nix` + +- `services/misc/gitit.nix` + +- `services/misc/ihaskell.nix` + +- `services/misc/mbpfan.nix` + +- `services/misc/mediatomb.nix` + +- `services/misc/mwlib.nix` + +- `services/misc/parsoid.nix` + +- `services/misc/plex.nix` + +- `services/misc/ripple-rest.nix` + +- `services/misc/ripple-data-api.nix` + +- `services/misc/subsonic.nix` + +- `services/misc/sundtek.nix` + +- `services/monitoring/cadvisor.nix` + +- `services/monitoring/das_watchdog.nix` + +- `services/monitoring/grafana.nix` + +- `services/monitoring/riemann-tools.nix` + +- `services/monitoring/teamviewer.nix` + +- `services/network-filesystems/u9fs.nix` + +- `services/networking/aiccu.nix` + +- `services/networking/asterisk.nix` + +- `services/networking/bird.nix` + +- `services/networking/charybdis.nix` + +- `services/networking/docker-registry-server.nix` + +- `services/networking/fan.nix` + +- `services/networking/firefox/sync-server.nix` + +- `services/networking/gateone.nix` + +- `services/networking/heyefi.nix` + +- `services/networking/i2p.nix` + +- `services/networking/lambdabot.nix` + +- `services/networking/mstpd.nix` + +- `services/networking/nix-serve.nix` + +- `services/networking/nylon.nix` + +- `services/networking/racoon.nix` + +- `services/networking/skydns.nix` + +- `services/networking/shout.nix` + +- `services/networking/softether.nix` + +- `services/networking/sslh.nix` + +- `services/networking/tinc.nix` + +- `services/networking/tlsdated.nix` + +- `services/networking/tox-bootstrapd.nix` + +- `services/networking/tvheadend.nix` + +- `services/networking/zerotierone.nix` + +- `services/scheduling/marathon.nix` + +- `services/security/fprintd.nix` + +- `services/security/hologram.nix` + +- `services/security/munge.nix` + +- `services/system/cloud-init.nix` + +- `services/web-servers/shellinabox.nix` + +- `services/web-servers/uwsgi.nix` + +- `services/x11/unclutter.nix` + +- `services/x11/display-managers/sddm.nix` + +- `system/boot/coredump.nix` + +- `system/boot/loader/loader.nix` + +- `system/boot/loader/generic-extlinux-compatible` + +- `system/boot/networkd.nix` + +- `system/boot/resolved.nix` + +- `system/boot/timesyncd.nix` + +- `tasks/filesystems/exfat.nix` + +- `tasks/filesystems/ntfs.nix` + +- `tasks/filesystems/vboxsf.nix` + +- `virtualisation/virtualbox-host.nix` + +- `virtualisation/vmware-guest.nix` + +- `virtualisation/xen-dom0.nix` + +When upgrading from a previous release, please be aware of the following incompatible changes: + +- `sshd` 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 + +```nix +{ + system.stateVersion = "14.12"; +} +``` + +The new option `system.stateVersion` ensures that certain configuration changes that could break existing systems (such as the `sshd` host key setting) will maintain compatibility with the specified NixOS release. NixOps sets the state version of existing deployments automatically. + +- `cron` is no longer enabled by default, unless you have a non-empty `services.cron.systemCronJobs`. To force `cron` to be enabled, set `services.cron.enable = true`. + +- 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 `nix.requireSignedBinaryCaches = false`. + +- Steam now doesn\'t need root rights to work. Instead of using `*-steam-chrootenv`, you should now just run `steam`. `steamChrootEnv` package was renamed to `steam`, and old `steam` package \-- to `steamOriginal`. + +- CMPlayer has been renamed to bomi upstream. Package `cmplayer` was accordingly renamed to `bomi` + +- Atom Shell has been renamed to Electron upstream. Package `atom-shell` was accordingly renamed to `electron` + +- Elm is not released on Hackage anymore. You should now use `elmPackages.elm` which contains the latest Elm platform. + +- The CUPS printing service has been updated to version `2.0.2`. Furthermore its systemd service has been renamed to `cups.service`. + + Local printers are no longer shared or advertised by default. This behavior can be changed by enabling `services.printing.defaultShared` or `services.printing.browsing` respectively. + +- The VirtualBox host and guest options have been named more consistently. They can now found in `virtualisation.virtualbox.host.*` instead of `services.virtualboxHost.*` and `virtualisation.virtualbox.guest.*` instead of `services.virtualboxGuest.*`. + + Also, there now is support for the `vboxsf` file system using the `fileSystems` configuration attribute. An example of how this can be used in a configuration: + +```nix +{ + fileSystems."/shiny" = { + device = "myshinysharedfolder"; + fsType = "vboxsf"; + }; +} +``` + +- \"`nix-env -qa`\" no longer discovers Haskell packages by name. The only packages visible in the global scope are `ghc`, `cabal-install`, and `stack`, 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 `nix-env -qa` 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: + +```ShellSession +nix-env -f "<nixpkgs>" -qaP -A haskellPackages +``` + +Executable programs written in Haskell can be installed with: + +```ShellSession +nix-env -f "<nixpkgs>" -iA haskellPackages.pandoc +``` + +Installing Haskell _libraries_ this way, however, is no longer supported. See the next item for more details. + +- Previous versions of NixOS came with a feature called `ghc-wrapper`, a small script that allowed GHC to transparently pick up on libraries installed in the user\'s profile. This feature has been deprecated; `ghc-wrapper` was removed from the distribution. The proper way to register Haskell libraries with the compiler now is the `haskellPackages.ghcWithPackages` function. The [User\'s Guide to the Haskell Infrastructure](https://nixos.org/nixpkgs/manual/#users-guide-to-the-haskell-infrastructure) provides more information about this subject. + +- All Haskell builds that have been generated with version 1.x of the `cabal2nix` utility are now invalid and need to be re-generated with a current version of `cabal2nix` to function. The most recent version of this tool can be installed by running `nix-env -i cabal2nix`. + +- The `haskellPackages` set in Nixpkgs used to have a function attribute called `extension` that users could override in their `~/.nixpkgs/config.nix` files to configure additional attributes, etc. That function still exists, but it\'s now called `overrides`. + +- The OpenBLAS library has been updated to version `0.2.14`. Support for the `x86_64-darwin` 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 `phpfpm` is now using the default PHP version (`pkgs.php`) instead of PHP 5.4 (`pkgs.php54`). + +- The `locate` 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 `services.locate.includeStore = true`. + +- The Nix expression search path (`NIX_PATH`) no longer contains `/etc/nixos/nixpkgs` by default. You can override `NIX_PATH` by setting `nix.nixPath`. + +- Python 2.6 has been marked as broken (as it no longer receives security updates from upstream). + +- Any use of module arguments such as `pkgs` to access library functions, or to define `imports` attributes will now lead to an infinite loop at the time of the evaluation. + + In case of an infinite loop, use the `--show-trace` command line argument and read the line just above the error message. + + ```ShellSession + $ nixos-rebuild build --show-trace + … + while evaluating the module argument `pkgs' in "/etc/nixos/my-module.nix": + infinite recursion encountered + ``` + + Any use of `pkgs.lib`, should be replaced by `lib`, after adding it as argument of the module. The following module + + ```nix + { config, pkgs, ... }: + + with pkgs.lib; + + { + options = { + foo = mkOption { … }; + }; + config = mkIf config.foo { … }; + } + ``` + + should be modified to look like: + + ```nix + { config, pkgs, lib, ... }: + + with lib; + + { + options = { + foo = mkOption { option declaration }; + }; + config = mkIf config.foo { option definition }; + } + ``` + + When `pkgs` is used to download other projects to import their modules, and only in such cases, it should be replaced by `(import <nixpkgs> {})`. The following module + + ```nix + { config, pkgs, ... }: + + let + myProject = pkgs.fetchurl { + src = url; + sha256 = hash; + }; + in + + { + imports = [ "${myProject}/module.nix" ]; + } + ``` + + should be modified to look like: + + ```nix + { config, pkgs, ... }: + + let + myProject = (import <nixpkgs> {}).fetchurl { + src = url; + sha256 = hash; + }; + in + + { + imports = [ "${myProject}/module.nix" ]; + } + ``` + +Other notable improvements: + +- The nixos and nixpkgs channels were unified, so one _can_ use `nix-env -iA nixos.bash` instead of `nix-env -iA nixos.pkgs.bash`. See [the commit](https://github.com/NixOS/nixpkgs/commit/2cd7c1f198) for details. + +- Users running an SSH server who worry about the quality of their `/etc/ssh/moduli` file with respect to the [vulnerabilities discovered in the Diffie-Hellman key exchange](https://stribika.github.io/2015/01/04/secure-secure-shell.html) can now replace OpenSSH\'s default version with one they generated themselves using the new `services.openssh.moduliFile` option. + +- A newly packaged TeX Live 2015 is provided in `pkgs.texlive`, split into 6500 nix packages. For basic user documentation see [the source](https://github.com/NixOS/nixpkgs/blob/release-15.09/pkgs/tools/typesetting/tex/texlive/default.nix#L1). Beware of [an issue](https://github.com/NixOS/nixpkgs/issues/9757) when installing a too large package set. The plan is to deprecate and maybe delete the original TeX packages until the next release. + +- `buildEnv.env` on all Python interpreters is now available for nix-shell interoperability. diff --git a/nixos/doc/manual/release-notes/rl-1509.xml b/nixos/doc/manual/release-notes/rl-1509.xml deleted file mode 100644 index 098c8c5095b..00000000000 --- a/nixos/doc/manual/release-notes/rl-1509.xml +++ /dev/null @@ -1,750 +0,0 @@ -<section xmlns="http://docbook.org/ns/docbook" - xmlns:xlink="http://www.w3.org/1999/xlink" - xmlns:xi="http://www.w3.org/2001/XInclude" - version="5.0" - xml:id="sec-release-15.09"> - <title>Release 15.09 (“Dingo”, 2015/09/30)</title> - - <para> - 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="https://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. - </para> - </listitem> - <listitem> - <para> - You can now keep your NixOS system up to date automatically by setting -<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>. - </para> - </listitem> - <listitem> - <para> - This release is based on Glibc 2.21, GCC 4.9 and Linux 3.18. - </para> - </listitem> - <listitem> - <para> - GNOME has been upgraded to 3.16. - </para> - </listitem> - <listitem> - <para> - Xfce has been upgraded to 4.12. - </para> - </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. - </para> - </listitem> - <listitem> - <para> - E19 has been upgraded to 0.16.8.15. - </para> - </listitem> - </itemizedlist> - - <para> - The following new services were added since the last release: - <itemizedlist> - <listitem> - <para> - <literal>services/mail/exim.nix</literal> - </para> - </listitem> - <listitem> - <para> - <literal>services/misc/apache-kafka.nix</literal> - </para> - </listitem> - <listitem> - <para> - <literal>services/misc/canto-daemon.nix</literal> - </para> - </listitem> - <listitem> - <para> - <literal>services/misc/confd.nix</literal> - </para> - </listitem> - <listitem> - <para> - <literal>services/misc/devmon.nix</literal> - </para> - </listitem> - <listitem> - <para> - <literal>services/misc/gitit.nix</literal> - </para> - </listitem> - <listitem> - <para> - <literal>services/misc/ihaskell.nix</literal> - </para> - </listitem> - <listitem> - <para> - <literal>services/misc/mbpfan.nix</literal> - </para> - </listitem> - <listitem> - <para> - <literal>services/misc/mediatomb.nix</literal> - </para> - </listitem> - <listitem> - <para> - <literal>services/misc/mwlib.nix</literal> - </para> - </listitem> - <listitem> - <para> - <literal>services/misc/parsoid.nix</literal> - </para> - </listitem> - <listitem> - <para> - <literal>services/misc/plex.nix</literal> - </para> - </listitem> - <listitem> - <para> - <literal>services/misc/ripple-rest.nix</literal> - </para> - </listitem> - <listitem> - <para> - <literal>services/misc/ripple-data-api.nix</literal> - </para> - </listitem> - <listitem> - <para> - <literal>services/misc/subsonic.nix</literal> - </para> - </listitem> - <listitem> - <para> - <literal>services/misc/sundtek.nix</literal> - </para> - </listitem> - <listitem> - <para> - <literal>services/monitoring/cadvisor.nix</literal> - </para> - </listitem> - <listitem> - <para> - <literal>services/monitoring/das_watchdog.nix</literal> - </para> - </listitem> - <listitem> - <para> - <literal>services/monitoring/grafana.nix</literal> - </para> - </listitem> - <listitem> - <para> - <literal>services/monitoring/riemann-tools.nix</literal> - </para> - </listitem> - <listitem> - <para> - <literal>services/monitoring/teamviewer.nix</literal> - </para> - </listitem> - <listitem> - <para> - <literal>services/network-filesystems/u9fs.nix</literal> - </para> - </listitem> - <listitem> - <para> - <literal>services/networking/aiccu.nix</literal> - </para> - </listitem> - <listitem> - <para> - <literal>services/networking/asterisk.nix</literal> - </para> - </listitem> - <listitem> - <para> - <literal>services/networking/bird.nix</literal> - </para> - </listitem> - <listitem> - <para> - <literal>services/networking/charybdis.nix</literal> - </para> - </listitem> - <listitem> - <para> - <literal>services/networking/docker-registry-server.nix</literal> - </para> - </listitem> - <listitem> - <para> - <literal>services/networking/fan.nix</literal> - </para> - </listitem> - <listitem> - <para> - <literal>services/networking/firefox/sync-server.nix</literal> - </para> - </listitem> - <listitem> - <para> - <literal>services/networking/gateone.nix</literal> - </para> - </listitem> - <listitem> - <para> - <literal>services/networking/heyefi.nix</literal> - </para> - </listitem> - <listitem> - <para> - <literal>services/networking/i2p.nix</literal> - </para> - </listitem> - <listitem> - <para> - <literal>services/networking/lambdabot.nix</literal> - </para> - </listitem> - <listitem> - <para> - <literal>services/networking/mstpd.nix</literal> - </para> - </listitem> - <listitem> - <para> - <literal>services/networking/nix-serve.nix</literal> - </para> - </listitem> - <listitem> - <para> - <literal>services/networking/nylon.nix</literal> - </para> - </listitem> - <listitem> - <para> - <literal>services/networking/racoon.nix</literal> - </para> - </listitem> - <listitem> - <para> - <literal>services/networking/skydns.nix</literal> - </para> - </listitem> - <listitem> - <para> - <literal>services/networking/shout.nix</literal> - </para> - </listitem> - <listitem> - <para> - <literal>services/networking/softether.nix</literal> - </para> - </listitem> - <listitem> - <para> - <literal>services/networking/sslh.nix</literal> - </para> - </listitem> - <listitem> - <para> - <literal>services/networking/tinc.nix</literal> - </para> - </listitem> - <listitem> - <para> - <literal>services/networking/tlsdated.nix</literal> - </para> - </listitem> - <listitem> - <para> - <literal>services/networking/tox-bootstrapd.nix</literal> - </para> - </listitem> - <listitem> - <para> - <literal>services/networking/tvheadend.nix</literal> - </para> - </listitem> - <listitem> - <para> - <literal>services/networking/zerotierone.nix</literal> - </para> - </listitem> - <listitem> - <para> - <literal>services/scheduling/marathon.nix</literal> - </para> - </listitem> - <listitem> - <para> - <literal>services/security/fprintd.nix</literal> - </para> - </listitem> - <listitem> - <para> - <literal>services/security/hologram.nix</literal> - </para> - </listitem> - <listitem> - <para> - <literal>services/security/munge.nix</literal> - </para> - </listitem> - <listitem> - <para> - <literal>services/system/cloud-init.nix</literal> - </para> - </listitem> - <listitem> - <para> - <literal>services/web-servers/shellinabox.nix</literal> - </para> - </listitem> - <listitem> - <para> - <literal>services/web-servers/uwsgi.nix</literal> - </para> - </listitem> - <listitem> - <para> - <literal>services/x11/unclutter.nix</literal> - </para> - </listitem> - <listitem> - <para> - <literal>services/x11/display-managers/sddm.nix</literal> - </para> - </listitem> - <listitem> - <para> - <literal>system/boot/coredump.nix</literal> - </para> - </listitem> - <listitem> - <para> - <literal>system/boot/loader/loader.nix</literal> - </para> - </listitem> - <listitem> - <para> - <literal>system/boot/loader/generic-extlinux-compatible</literal> - </para> - </listitem> - <listitem> - <para> - <literal>system/boot/networkd.nix</literal> - </para> - </listitem> - <listitem> - <para> - <literal>system/boot/resolved.nix</literal> - </para> - </listitem> - <listitem> - <para> - <literal>system/boot/timesyncd.nix</literal> - </para> - </listitem> - <listitem> - <para> - <literal>tasks/filesystems/exfat.nix</literal> - </para> - </listitem> - <listitem> - <para> - <literal>tasks/filesystems/ntfs.nix</literal> - </para> - </listitem> - <listitem> - <para> - <literal>tasks/filesystems/vboxsf.nix</literal> - </para> - </listitem> - <listitem> - <para> - <literal>virtualisation/virtualbox-host.nix</literal> - </para> - </listitem> - <listitem> - <para> - <literal>virtualisation/vmware-guest.nix</literal> - </para> - </listitem> - <listitem> - <para> - <literal>virtualisation/xen-dom0.nix</literal> - </para> - </listitem> - </itemizedlist> - </para> - - <para> - 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 -<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. - </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>. - </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>. - </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>. - </para> - </listitem> - <listitem> - <para> - 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> - </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. - </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>. - </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. - </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>. - </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: -<programlisting> -fileSystems."/shiny" = { - device = "myshinysharedfolder"; - fsType = "vboxsf"; -}; -</programlisting> - </para> - </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: - </para> -<programlisting> -nix-env -f "<nixpkgs>" -qaP -A haskellPackages -</programlisting> - <para> - Executable programs written in Haskell can be installed with: - </para> -<programlisting> -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. - </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="https://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>. - </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>. - </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. - </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>). - </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>. - </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>. - </para> - </listitem> - <listitem> - <para> - 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. - </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. -<screen> -<prompt>$ </prompt>nixos-rebuild build --show-trace -… -while evaluating the module argument `pkgs' in "/etc/nixos/my-module.nix": -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 -<programlisting> -{ config, pkgs, ... }: - -with pkgs.lib; - -{ - options = { - foo = mkOption { … }; - }; - config = mkIf config.foo { … }; -} -</programlisting> - should be modified to look like: -<programlisting> -{ config, pkgs, lib, ... }: - -with lib; - -{ - options = { - foo = mkOption { <replaceable>option declaration</replaceable> }; - }; - config = mkIf config.foo { <replaceable>option definition</replaceable> }; -} -</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 -<programlisting> -{ config, pkgs, ... }: - -let - myProject = pkgs.fetchurl { - src = <replaceable>url</replaceable>; - sha256 = <replaceable>hash</replaceable>; - }; -in - -{ - imports = [ "${myProject}/module.nix" ]; -} -</programlisting> - should be modified to look like: -<programlisting> -{ config, pkgs, ... }: - -let - myProject = (import <nixpkgs> {}).fetchurl { - src = <replaceable>url</replaceable>; - sha256 = <replaceable>hash</replaceable>; - }; -in - -{ - imports = [ "${myProject}/module.nix" ]; -} -</programlisting> - </para> - </listitem> - </itemizedlist> - </para> - - <para> - Other notable improvements: - <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. - </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. - </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. - </para> - </listitem> - <listitem> - <para> - <option>buildEnv.env</option> on all Python interpreters is now available - for nix-shell interoperability. - </para> - </listitem> - </itemizedlist> - </para> -</section> diff --git a/nixos/doc/manual/release-notes/rl-1603.section.md b/nixos/doc/manual/release-notes/rl-1603.section.md new file mode 100644 index 00000000000..dce879ec16d --- /dev/null +++ b/nixos/doc/manual/release-notes/rl-1603.section.md @@ -0,0 +1,282 @@ +# Release 16.03 ("Emu", 2016/03/31) {#sec-release-16.03} + +In addition to numerous new and upgraded packages, this release has the following highlights: + +- Systemd 229, bringing [numerous improvements](https://github.com/systemd/systemd/blob/v229/NEWS) over 217. + +- Linux 4.4 (was 3.18). + +- GCC 5.3 (was 4.9). Note that GCC 5 [changes the C++ ABI in an incompatible way](https://gcc.gnu.org/onlinedocs/libstdc++/manual/using_dual_abi.html); this may cause problems if you try to link objects compiled with different versions of GCC. + +- Glibc 2.23 (was 2.21). + +- Binutils 2.26 (was 2.23.1). See \#909 + +- Improved support for ensuring [bitwise reproducible builds](https://reproducible-builds.org/). For example, `stdenv` now sets the environment variable `SOURCE_DATE_EPOCH` to a deterministic value, and Nix has [gained an option](https://nixos.org/nix/manual/#ssec-relnotes-1.11) 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). + +- Perl 5.22. + +The following new services were added since the last release: + +- `services/monitoring/longview.nix` + +- `hardware/video/webcam/facetimehd.nix` + +- `i18n/input-method/default.nix` + +- `i18n/input-method/fcitx.nix` + +- `i18n/input-method/ibus.nix` + +- `i18n/input-method/nabi.nix` + +- `i18n/input-method/uim.nix` + +- `programs/fish.nix` + +- `security/acme.nix` + +- `security/audit.nix` + +- `security/oath.nix` + +- `services/hardware/irqbalance.nix` + +- `services/mail/dspam.nix` + +- `services/mail/opendkim.nix` + +- `services/mail/postsrsd.nix` + +- `services/mail/rspamd.nix` + +- `services/mail/rmilter.nix` + +- `services/misc/autofs.nix` + +- `services/misc/bepasty.nix` + +- `services/misc/calibre-server.nix` + +- `services/misc/cfdyndns.nix` + +- `services/misc/gammu-smsd.nix` + +- `services/misc/mathics.nix` + +- `services/misc/matrix-synapse.nix` + +- `services/misc/octoprint.nix` + +- `services/monitoring/hdaps.nix` + +- `services/monitoring/heapster.nix` + +- `services/monitoring/longview.nix` + +- `services/network-filesystems/netatalk.nix` + +- `services/network-filesystems/xtreemfs.nix` + +- `services/networking/autossh.nix` + +- `services/networking/dnschain.nix` + +- `services/networking/gale.nix` + +- `services/networking/miniupnpd.nix` + +- `services/networking/namecoind.nix` + +- `services/networking/ostinato.nix` + +- `services/networking/pdnsd.nix` + +- `services/networking/shairport-sync.nix` + +- `services/networking/supplicant.nix` + +- `services/search/kibana.nix` + +- `services/security/haka.nix` + +- `services/security/physlock.nix` + +- `services/web-apps/pump.io.nix` + +- `services/x11/hardware/libinput.nix` + +- `services/x11/window-managers/windowlab.nix` + +- `system/boot/initrd-network.nix` + +- `system/boot/initrd-ssh.nix` + +- `system/boot/loader/loader.nix` + +- `system/boot/networkd.nix` + +- `system/boot/resolved.nix` + +- `virtualisation/lxd.nix` + +- `virtualisation/rkt.nix` + +When upgrading from a previous release, please be aware of the following incompatible changes: + +- We no longer produce graphical ISO images and VirtualBox images for `i686-linux`. A minimal ISO image is still provided. + +- Firefox and similar browsers are now _wrapped by default_. The package and attribute names are plain `firefox` or `midori`, etc. Backward-compatibility attributes were set up, but note that `nix-env -u` will _not_ update your current `firefox-with-plugins`; you have to uninstall it and install `firefox` instead. + +- `wmiiSnap` has been replaced with `wmii_hg`, but `services.xserver.windowManager.wmii.enable` has been updated respectively so this only affects you if you have explicitly installed `wmiiSnap`. + +- `jobs` NixOS option has been removed. It served as compatibility layer between Upstart jobs and SystemD services. All services have been rewritten to use `systemd.services` + +- `wmiimenu` is removed, as it has been removed by the developers upstream. Use `wimenu` from the `wmii-hg` package. + +- 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. + + ```nix + { + imports = [ <nixpkgs/nixos/modules/services/misc/gitit.nix> ]; + } + ``` + + will include the Gitit service configuration options. + +- `nginx` does not accept flags for enabling and disabling modules anymore. Instead it accepts `modules` argument, which is a list of modules to be built in. All modules now reside in `nginxModules` set. Example configuration: + + ```nix + nginx.override { + modules = [ nginxModules.rtmp nginxModules.dav nginxModules.moreheaders ]; + } + ``` + +- `s3sync` 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 `tarsnap` and others. + +- `ruby_1_8` has been removed as it\'s not supported from upstream anymore and probably contains security issues. + +- `tidy-html5` package is removed. Upstream only provided `(lib)tidy5` during development, and now they went back to `(lib)tidy` to work as a drop-in replacement of the original package that has been unmaintained for years. You can (still) use the `html-tidy` package, which got updated to a stable release from this new upstream. + +- `extraDeviceOptions` argument is removed from `bumblebee` package. Instead there are now two separate arguments: `extraNvidiaDeviceOptions` and `extraNouveauDeviceOptions` for setting extra X11 options for nvidia and nouveau drivers, respectively. + +- The `Ctrl+Alt+Backspace` key combination no longer kills the X server by default. There\'s a new option `services.xserver.enableCtrlAltBackspace` allowing to enable the combination again. + +- `emacsPackagesNg` now contains all packages from the ELPA, MELPA, and MELPA Stable repositories. + +- Data directory for Postfix MTA server is moved from `/var/postfix` to `/var/lib/postfix`. Old configurations are migrated automatically. `service.postfix` module has also received many improvements, such as correct directories\' access rights, new `aliasFiles` and `mapFiles` options and more. + +- 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: + + ```nix + { + fileSystems."/example" = { + device = "/dev/sdc"; + fsType = "btrfs"; + options = [ "noatime" "compress=lzo" "space_cache" "autodefrag" ]; + }; + } + ``` + +- CUPS, installed by `services.printing` module, now has its data directory in `/var/lib/cups`. Old configurations from `/etc/cups` are moved there automatically, but there might be problems. Also configuration options `services.printing.cupsdConf` and `services.printing.cupsdFilesConf` 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, `services.printing.extraConf` and new option `services.printing.extraFilesConf` should be enough; if you encounter a situation when they are not, please file a bug. + + There are also Gutenprint improvements; in particular, a new option `services.printing.gutenprint` is added to enable automatic updating of Gutenprint PPMs; it\'s greatly recommended to enable it instead of adding `gutenprint` to the `drivers` list. + +- `services.xserver.vaapiDrivers` has been removed. Use `hardware.opengl.extraPackages{,32}` instead. You can also specify VDPAU drivers there. + +- `programs.ibus` moved to `i18n.inputMethod.ibus`. The option `programs.ibus.plugins` changed to `i18n.inputMethod.ibus.engines` and the option to enable ibus changed from `programs.ibus.enable` to `i18n.inputMethod.enabled`. `i18n.inputMethod.enabled` should be set to the used input method name, `"ibus"` for ibus. An example of the new style: + + ```nix + { + i18n.inputMethod.enabled = "ibus"; + i18n.inputMethod.ibus.engines = with pkgs.ibus-engines; [ anthy mozc ]; + } + ``` + + That is equivalent to the old version: + + ```nix + { + programs.ibus.enable = true; + programs.ibus.plugins = with pkgs; [ ibus-anthy mozc ]; + } + ``` + +- `services.udev.extraRules` option now writes rules to `99-local.rules` instead of `10-local.rules`. This makes all the user rules apply after others, so their results wouldn\'t be overriden by anything else. + +- Large parts of the `services.gitlab` module has been been rewritten. There are new configuration options available. The `stateDir` option was renamned to `statePath` and the `satellitesDir` option was removed. Please review the currently available options. + +- The option `services.nsd.zones.<name>.data` no longer interpret the dollar sign (\$) as a shell variable, as such it should not be escaped anymore. Thus the following zone data: + + ```dns-zone + $ORIGIN example.com. + $TTL 1800 + @ IN SOA ns1.vpn.nbp.name. admin.example.com. ( + + ``` + + Should modified to look like the actual file expected by nsd: + + ```dns-zone + $ORIGIN example.com. + $TTL 1800 + @ IN SOA ns1.vpn.nbp.name. admin.example.com. ( + + ``` + +- `service.syncthing.dataDir` options now has to point to exact folder where syncthing is writing to. Example configuration should look something like: + + ```nix + { + services.syncthing = { + enable = true; + dataDir = "/home/somebody/.syncthing"; + user = "somebody"; + }; + } + ``` + +- `networking.firewall.allowPing` is now enabled by default. Users are encouraged to configure an appropriate rate limit for their machines using the Kernel interface at `/proc/sys/net/ipv4/icmp_ratelimit` and `/proc/sys/net/ipv6/icmp/ratelimit` or using the firewall itself, i.e. by setting the NixOS option `networking.firewall.pingLimit`. + +- Systems with some broadcom cards used to result into a generated config that is no longer accepted. If you get errors like + + ```ShellSession + error: path ‘/nix/store/*-broadcom-sta-*’ does not exist and cannot be created + ``` + + you should either re-run `nixos-generate-config` or manually replace `"${config.boot.kernelPackages.broadcom_sta}"` by `config.boot.kernelPackages.broadcom_sta` in your `/etc/nixos/hardware-configuration.nix`. More discussion is on [ the github issue](https://github.com/NixOS/nixpkgs/pull/12595). + +- The `services.xserver.startGnuPGAgent` 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 `~/.bashrc` or some file that's sourced when your shell is started: + + ```shell + GPG_TTY=$(tty) + export GPG_TTY + ``` + + If you want to use gpg-agent for SSH, too, add the following to your session initialization (e.g. `displayManager.sessionCommands`) + + ```shell + gpg-connect-agent /bye + unset SSH_AGENT_PID + export SSH_AUTH_SOCK="''${HOME}/.gnupg/S.gpg-agent.ssh" + ``` + + and make sure that + + ```conf + enable-ssh-support + ``` + + is included in your `~/.gnupg/gpg-agent.conf`. You will need to use `ssh-add` 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: + + ```ShellSession + gpg --import ~/.gnupg/secring.gpg + ``` + + The `gpg-agent(1)` man page has more details about this subject, i.e. in the \"EXAMPLES\" section. + +Other notable improvements: + +- `ejabberd` module is brought back and now works on NixOS. + +- 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. diff --git a/nixos/doc/manual/release-notes/rl-1603.xml b/nixos/doc/manual/release-notes/rl-1603.xml deleted file mode 100644 index 6d4b28825fa..00000000000 --- a/nixos/doc/manual/release-notes/rl-1603.xml +++ /dev/null @@ -1,671 +0,0 @@ -<section xmlns="http://docbook.org/ns/docbook" - xmlns:xlink="http://www.w3.org/1999/xlink" - xmlns:xi="http://www.w3.org/2001/XInclude" - version="5.0" - xml:id="sec-release-16.03"> - <title>Release 16.03 (“Emu”, 2016/03/31)</title> - - <para> - 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. - </para> - </listitem> - <listitem> - <para> - Linux 4.4 (was 3.18). - </para> - </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. - </para> - </listitem> - <listitem> - <para> - Glibc 2.23 (was 2.21). - </para> - </listitem> - <listitem> - <para> - Binutils 2.26 (was 2.23.1). See #909 - </para> - </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="https://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> - <para> - Perl 5.22. - </para> - </listitem> - </itemizedlist> - - <para> - The following new services were added since the last release: - <itemizedlist> - <listitem> - <para> - <literal>services/monitoring/longview.nix</literal> - </para> - </listitem> - <listitem> - <para> - <literal>hardware/video/webcam/facetimehd.nix</literal> - </para> - </listitem> - <listitem> - <para> - <literal>i18n/input-method/default.nix</literal> - </para> - </listitem> - <listitem> - <para> - <literal>i18n/input-method/fcitx.nix</literal> - </para> - </listitem> - <listitem> - <para> - <literal>i18n/input-method/ibus.nix</literal> - </para> - </listitem> - <listitem> - <para> - <literal>i18n/input-method/nabi.nix</literal> - </para> - </listitem> - <listitem> - <para> - <literal>i18n/input-method/uim.nix</literal> - </para> - </listitem> - <listitem> - <para> - <literal>programs/fish.nix</literal> - </para> - </listitem> - <listitem> - <para> - <literal>security/acme.nix</literal> - </para> - </listitem> - <listitem> - <para> - <literal>security/audit.nix</literal> - </para> - </listitem> - <listitem> - <para> - <literal>security/oath.nix</literal> - </para> - </listitem> - <listitem> - <para> - <literal>services/hardware/irqbalance.nix</literal> - </para> - </listitem> - <listitem> - <para> - <literal>services/mail/dspam.nix</literal> - </para> - </listitem> - <listitem> - <para> - <literal>services/mail/opendkim.nix</literal> - </para> - </listitem> - <listitem> - <para> - <literal>services/mail/postsrsd.nix</literal> - </para> - </listitem> - <listitem> - <para> - <literal>services/mail/rspamd.nix</literal> - </para> - </listitem> - <listitem> - <para> - <literal>services/mail/rmilter.nix</literal> - </para> - </listitem> - <listitem> - <para> - <literal>services/misc/autofs.nix</literal> - </para> - </listitem> - <listitem> - <para> - <literal>services/misc/bepasty.nix</literal> - </para> - </listitem> - <listitem> - <para> - <literal>services/misc/calibre-server.nix</literal> - </para> - </listitem> - <listitem> - <para> - <literal>services/misc/cfdyndns.nix</literal> - </para> - </listitem> - <listitem> - <para> - <literal>services/misc/gammu-smsd.nix</literal> - </para> - </listitem> - <listitem> - <para> - <literal>services/misc/mathics.nix</literal> - </para> - </listitem> - <listitem> - <para> - <literal>services/misc/matrix-synapse.nix</literal> - </para> - </listitem> - <listitem> - <para> - <literal>services/misc/octoprint.nix</literal> - </para> - </listitem> - <listitem> - <para> - <literal>services/monitoring/hdaps.nix</literal> - </para> - </listitem> - <listitem> - <para> - <literal>services/monitoring/heapster.nix</literal> - </para> - </listitem> - <listitem> - <para> - <literal>services/monitoring/longview.nix</literal> - </para> - </listitem> - <listitem> - <para> - <literal>services/network-filesystems/netatalk.nix</literal> - </para> - </listitem> - <listitem> - <para> - <literal>services/network-filesystems/xtreemfs.nix</literal> - </para> - </listitem> - <listitem> - <para> - <literal>services/networking/autossh.nix</literal> - </para> - </listitem> - <listitem> - <para> - <literal>services/networking/dnschain.nix</literal> - </para> - </listitem> - <listitem> - <para> - <literal>services/networking/gale.nix</literal> - </para> - </listitem> - <listitem> - <para> - <literal>services/networking/miniupnpd.nix</literal> - </para> - </listitem> - <listitem> - <para> - <literal>services/networking/namecoind.nix</literal> - </para> - </listitem> - <listitem> - <para> - <literal>services/networking/ostinato.nix</literal> - </para> - </listitem> - <listitem> - <para> - <literal>services/networking/pdnsd.nix</literal> - </para> - </listitem> - <listitem> - <para> - <literal>services/networking/shairport-sync.nix</literal> - </para> - </listitem> - <listitem> - <para> - <literal>services/networking/supplicant.nix</literal> - </para> - </listitem> - <listitem> - <para> - <literal>services/search/kibana.nix</literal> - </para> - </listitem> - <listitem> - <para> - <literal>services/security/haka.nix</literal> - </para> - </listitem> - <listitem> - <para> - <literal>services/security/physlock.nix</literal> - </para> - </listitem> - <listitem> - <para> - <literal>services/web-apps/pump.io.nix</literal> - </para> - </listitem> - <listitem> - <para> - <literal>services/x11/hardware/libinput.nix</literal> - </para> - </listitem> - <listitem> - <para> - <literal>services/x11/window-managers/windowlab.nix</literal> - </para> - </listitem> - <listitem> - <para> - <literal>system/boot/initrd-network.nix</literal> - </para> - </listitem> - <listitem> - <para> - <literal>system/boot/initrd-ssh.nix</literal> - </para> - </listitem> - <listitem> - <para> - <literal>system/boot/loader/loader.nix</literal> - </para> - </listitem> - <listitem> - <para> - <literal>system/boot/networkd.nix</literal> - </para> - </listitem> - <listitem> - <para> - <literal>system/boot/resolved.nix</literal> - </para> - </listitem> - <listitem> - <para> - <literal>virtualisation/lxd.nix</literal> - </para> - </listitem> - <listitem> - <para> - <literal>virtualisation/rkt.nix</literal> - </para> - </listitem> - </itemizedlist> - </para> - - <para> - 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. - </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. - </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>. - </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> - </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. - </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. -<programlisting><![CDATA[ -{ - imports = [ <nixpkgs/nixos/modules/services/misc/gitit.nix> ]; -} -]]></programlisting> - will include the Gitit service configuration options. - </para> - </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: -<programlisting><![CDATA[ -nginx.override { - modules = [ nginxModules.rtmp nginxModules.dav nginxModules.moreheaders ]; -} -]]></programlisting> - </para> - </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. - </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. - </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. - </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. - </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. - </para> - </listitem> - <listitem> - <para> - <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. - </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: -<programlisting> -fileSystems."/example" = { - device = "/dev/sdc"; - fsType = "btrfs"; - options = [ "noatime" "compress=lzo" "space_cache" "autodefrag" ]; -}; -</programlisting> - </para> - </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. - </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. - </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. - </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: -<programlisting> -i18n.inputMethod.enabled = "ibus"; -i18n.inputMethod.ibus.engines = with pkgs.ibus-engines; [ anthy mozc ]; -</programlisting> - That is equivalent to the old version: -<programlisting> -programs.ibus.enable = true; -programs.ibus.plugins = with pkgs; [ ibus-anthy mozc ]; -</programlisting> - </para> - </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. - </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. - </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: - </para> -<programlisting> -\$ORIGIN example.com. -\$TTL 1800 -@ IN SOA ns1.vpn.nbp.name. admin.example.com. ( - </programlisting> - <para> - Should modified to look like the actual file expected by nsd: - </para> -<programlisting> -$ORIGIN example.com. -$TTL 1800 -@ IN SOA ns1.vpn.nbp.name. admin.example.com. ( - </programlisting> - </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: - </para> -<programlisting> -services.syncthing = { - enable = true; - dataDir = "/home/somebody/.syncthing"; - user = "somebody"; -}; - </programlisting> - </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>. - </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 -<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>. - </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: -<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>) -<programlisting> -gpg-connect-agent /bye -unset SSH_AGENT_PID -export SSH_AUTH_SOCK="''${HOME}/.gnupg/S.gpg-agent.ssh" - </programlisting> - and make sure that -<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: -<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. - </para> - </listitem> - </itemizedlist> - - <para> - Other notable improvements: - <itemizedlist> -<!-- - <listitem> - <para>The <command>command-not-found</command> hook was extended. - Apart from <literal>$NIX_AUTO_INSTALL</literal> variable, - it newly also checks for <literal>$NIX_AUTO_RUN</literal> - which causes it to directly run the missing commands via - <command>nix-shell</command> (without installing anything).</para> - </listitem> - --> - <listitem> - <para> - <literal>ejabberd</literal> module is brought back and now works on NixOS. - </para> - </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. - </para> - </listitem> - </itemizedlist> - </para> -</section> diff --git a/nixos/doc/manual/release-notes/rl-1609.section.md b/nixos/doc/manual/release-notes/rl-1609.section.md new file mode 100644 index 00000000000..075f0cf52cd --- /dev/null +++ b/nixos/doc/manual/release-notes/rl-1609.section.md @@ -0,0 +1,73 @@ +# Release 16.09 ("Flounder", 2016/09/30) {#sec-release-16.09} + +In addition to numerous new and upgraded packages, this release has the following highlights: + +- Many NixOS configurations and Nix packages now use significantly less disk space, thanks to the [extensive work on closure size reduction](https://github.com/NixOS/nixpkgs/issues/7117). 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. + +- To improve security, packages are now [built using various hardening features](https://github.com/NixOS/nixpkgs/pull/12895). See the Nixpkgs manual for more information. + +- Support for PXE netboot. See [](#sec-booting-from-pxe) for documentation. + +- X.org server 1.18. If you use the `ati_unfree` driver, 1.17 is still used due to an ABI incompatibility. + +- This release is based on Glibc 2.24, GCC 5.4.0 and systemd 231. The default Linux kernel remains 4.4. + +The following new services were added since the last release: + +- `(this will get automatically generated at release time)` + +When upgrading from a previous release, please be aware of the following incompatible changes: + +- 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 [were changed](https://github.com/NixOS/nixpkgs/pull/14766) late (August 2016) in the release cycle and differ from the initial introduction of multiple outputs.) + +- Previous versions of Nixpkgs had support for all versions of the LTS Haskell package set. That support has been dropped. The previously provided `haskell.packages.lts-x_y` 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. [The motivation for this change](https://nixos.org/nix-dev/2016-June/020585.html) has been discussed at length on the `nix-dev` mailing list and in [Github issue \#14897](https://github.com/NixOS/nixpkgs/issues/14897). Development strategies for Haskell hackers who want to rely on Nix and NixOS have been described in [another nix-dev article](https://nixos.org/nix-dev/2016-June/020642.html). + +- Shell aliases for systemd sub-commands [were dropped](https://github.com/NixOS/nixpkgs/pull/15598): `start`, `stop`, `restart`, `status`. + +- 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 + +- `/var/empty` is now immutable. Activation script runs `chattr +i` to forbid any modifications inside the folder. See [ the pull request](https://github.com/NixOS/nixpkgs/pull/18365) for what bugs this caused. + +- Gitlab\'s maintainance script `gitlab-runner` was removed and split up into the more clearer `gitlab-run` and `gitlab-rake` scripts, because `gitlab-runner` is a component of Gitlab CI. + +- `services.xserver.libinput.accelProfile` default changed from `flat` to `adaptive`, as per [ official documentation](https://wayland.freedesktop.org/libinput/doc/latest/group__config.html#gad63796972347f318b180e322e35cee79). + +- `fonts.fontconfig.ultimate.rendering` was removed because our presets were obsolete for some time. New presets are hardcoded into FreeType; you can select a preset via `fonts.fontconfig.ultimate.preset`. You can customize those presets via ordinary environment variables, using `environment.variables`. + +- The `audit` service is no longer enabled by default. Use `security.audit.enable = true` to explicitly enable it. + +- `pkgs.linuxPackages.virtualbox` 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 `pkgs.virtualbox` instead. + +- `goPackages` was replaced with separated Go applications in appropriate `nixpkgs` categories. Each Go package uses its own dependency set. There\'s also a new `go2nix` tool introduced to generate a Go package definition from its Go source automatically. + +- `services.mongodb.extraConfig` configuration format was changed to YAML. + +- PHP has been upgraded to 7.0 + +Other notable improvements: + +- 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 + + ```nix + { + security.grsecurity.enable = true; + } + ``` + + to get a reasonably secure system without having to sacrifice too much functionality. + +- Special filesystems, like `/proc`, `/run` 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 `nixos-rebuild switch` if possible. One benefit from this is improved security --- most such filesystems are now mounted with `noexec`, `nodev` and/or `nosuid` options. + +- 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 (`networking.firewall.logReversePathDrops`) for easier debugging. + +- Containers configuration within `containers.<name>.config` is [now properly typed and checked](https://github.com/NixOS/nixpkgs/pull/17365). In particular, partial configurations are merged correctly. + +- The directory container setuid wrapper programs, `/var/setuid-wrappers`, [is now updated atomically to prevent failures if the switch to a new configuration is interrupted.](https://github.com/NixOS/nixpkgs/pull/18124) + +- `services.xserver.startGnuPGAgent` has been removed due to GnuPG 2.1.x bump. See [ how to achieve similar behavior](https://github.com/NixOS/nixpkgs/commit/5391882ebd781149e213e8817fba6ac3c503740c). You might need to `pkill gpg-agent` after the upgrade to prevent a stale agent being in the way. + +- [ Declarative users could share the uid due to the bug in the script handling conflict resolution. ](https://github.com/NixOS/nixpkgs/commit/e561edc322d275c3687fec431935095cfc717147) + +- Gummi boot has been replaced using systemd-boot. + +- Hydra package and NixOS module were added for convenience. diff --git a/nixos/doc/manual/release-notes/rl-1609.xml b/nixos/doc/manual/release-notes/rl-1609.xml deleted file mode 100644 index 4a2343edc97..00000000000 --- a/nixos/doc/manual/release-notes/rl-1609.xml +++ /dev/null @@ -1,277 +0,0 @@ -<section xmlns="http://docbook.org/ns/docbook" - xmlns:xlink="http://www.w3.org/1999/xlink" - xmlns:xi="http://www.w3.org/2001/XInclude" - version="5.0" - xml:id="sec-release-16.09"> - <title>Release 16.09 (“Flounder”, 2016/09/30)</title> - - <para> - 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. - </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. - </para> - </listitem> - <listitem> - <para> - Support for PXE netboot. See <xref - 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. - </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. - </para> - </listitem> - </itemizedlist> - - <para> - The following new services were added since the last release: - </para> - - <itemizedlist> - <listitem> - <para> - <literal>(this will get automatically generated at release time)</literal> - </para> - </listitem> - </itemizedlist> - - <para> - 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.) - </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>. - </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>. - </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 - </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. - </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. - </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>. - </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>. - </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. - </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. - </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. - </para> - </listitem> - <listitem> - <para> - <literal>services.mongodb.extraConfig</literal> configuration format was - changed to YAML. - </para> - </listitem> - <listitem> - <para> - PHP has been upgraded to 7.0 - </para> - </listitem> - </itemizedlist> - - <para> - Other notable improvements: - </para> - - <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 -<programlisting>security.grsecurity.enable = true</programlisting> - 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. - </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. - </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. - </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> - </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. - </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> - </para> - </listitem> - <listitem> - <para> - Gummi boot has been replaced using systemd-boot. - </para> - </listitem> - <listitem> - <para> - Hydra package and NixOS module were added for convenience. - </para> - </listitem> - </itemizedlist> -</section> diff --git a/nixos/doc/manual/release-notes/rl-1703.section.md b/nixos/doc/manual/release-notes/rl-1703.section.md new file mode 100644 index 00000000000..7f424f2a6ce --- /dev/null +++ b/nixos/doc/manual/release-notes/rl-1703.section.md @@ -0,0 +1,303 @@ +# Release 17.03 ("Gorilla", 2017/03/31) {#sec-release-17.03} + +## Highlights {#sec-release-17.03-highlights} + +In addition to numerous new and upgraded packages, this release has the following highlights: + +- Nixpkgs is now extensible through overlays. See the [Nixpkgs manual](https://nixos.org/nixpkgs/manual/#sec-overlays-install) for more information. + +- 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. + +- The default desktop environment now is KDE\'s Plasma 5. KDE 4 has been removed + +- The setuid wrapper functionality now supports setting capabilities. + +- X.org server uses branch 1.19. Due to ABI incompatibilities, `ati_unfree` keeps forcing 1.17 and `amdgpu-pro` starts forcing 1.18. + +- Cross compilation has been rewritten. See the nixpkgs manual for details. The most obvious breaking change is that in derivations there is no `.nativeDrv` nor `.crossDrv` are now cross by default, not native. + +- The `overridePackages` function has been rewritten to be replaced by [ overlays](https://nixos.org/nixpkgs/manual/#sec-overlays-install) + +- Packages in nixpkgs can be marked as insecure through listed vulnerabilities. See the [Nixpkgs manual](https://nixos.org/nixpkgs/manual/#sec-allow-insecure) for more information. + +- PHP now defaults to PHP 7.1 + +## New Services {#sec-release-17.03-new-services} + +The following new services were added since the last release: + +- `hardware/ckb.nix` + +- `hardware/mcelog.nix` + +- `hardware/usb-wwan.nix` + +- `hardware/video/capture/mwprocapture.nix` + +- `programs/adb.nix` + +- `programs/chromium.nix` + +- `programs/gphoto2.nix` + +- `programs/java.nix` + +- `programs/mtr.nix` + +- `programs/oblogout.nix` + +- `programs/vim.nix` + +- `programs/wireshark.nix` + +- `security/dhparams.nix` + +- `services/audio/ympd.nix` + +- `services/computing/boinc/client.nix` + +- `services/continuous-integration/buildbot/master.nix` + +- `services/continuous-integration/buildbot/worker.nix` + +- `services/continuous-integration/gitlab-runner.nix` + +- `services/databases/riak-cs.nix` + +- `services/databases/stanchion.nix` + +- `services/desktops/gnome3/gnome-terminal-server.nix` + +- `services/editors/infinoted.nix` + +- `services/hardware/illum.nix` + +- `services/hardware/trezord.nix` + +- `services/logging/journalbeat.nix` + +- `services/mail/offlineimap.nix` + +- `services/mail/postgrey.nix` + +- `services/misc/couchpotato.nix` + +- `services/misc/docker-registry.nix` + +- `services/misc/errbot.nix` + +- `services/misc/geoip-updater.nix` + +- `services/misc/gogs.nix` + +- `services/misc/leaps.nix` + +- `services/misc/nix-optimise.nix` + +- `services/misc/ssm-agent.nix` + +- `services/misc/sssd.nix` + +- `services/monitoring/arbtt.nix` + +- `services/monitoring/netdata.nix` + +- `services/monitoring/prometheus/default.nix` + +- `services/monitoring/prometheus/alertmanager.nix` + +- `services/monitoring/prometheus/blackbox-exporter.nix` + +- `services/monitoring/prometheus/json-exporter.nix` + +- `services/monitoring/prometheus/nginx-exporter.nix` + +- `services/monitoring/prometheus/node-exporter.nix` + +- `services/monitoring/prometheus/snmp-exporter.nix` + +- `services/monitoring/prometheus/unifi-exporter.nix` + +- `services/monitoring/prometheus/varnish-exporter.nix` + +- `services/monitoring/sysstat.nix` + +- `services/monitoring/telegraf.nix` + +- `services/monitoring/vnstat.nix` + +- `services/network-filesystems/cachefilesd.nix` + +- `services/network-filesystems/glusterfs.nix` + +- `services/network-filesystems/ipfs.nix` + +- `services/networking/dante.nix` + +- `services/networking/dnscrypt-wrapper.nix` + +- `services/networking/fakeroute.nix` + +- `services/networking/flannel.nix` + +- `services/networking/htpdate.nix` + +- `services/networking/miredo.nix` + +- `services/networking/nftables.nix` + +- `services/networking/powerdns.nix` + +- `services/networking/pdns-recursor.nix` + +- `services/networking/quagga.nix` + +- `services/networking/redsocks.nix` + +- `services/networking/wireguard.nix` + +- `services/system/cgmanager.nix` + +- `services/torrent/opentracker.nix` + +- `services/web-apps/atlassian/confluence.nix` + +- `services/web-apps/atlassian/crowd.nix` + +- `services/web-apps/atlassian/jira.nix` + +- `services/web-apps/frab.nix` + +- `services/web-apps/nixbot.nix` + +- `services/web-apps/selfoss.nix` + +- `services/web-apps/quassel-webserver.nix` + +- `services/x11/unclutter-xfixes.nix` + +- `services/x11/urxvtd.nix` + +- `system/boot/systemd-nspawn.nix` + +- `virtualisation/ecs-agent.nix` + +- `virtualisation/lxcfs.nix` + +- `virtualisation/openstack/keystone.nix` + +- `virtualisation/openstack/glance.nix` + +## Backward Incompatibilities {#sec-release-17.03-incompatibilities} + +When upgrading from a previous release, please be aware of the following incompatible changes: + +- Derivations have no `.nativeDrv` nor `.crossDrv` and are now cross by default, not native. + +- `stdenv.overrides` is now expected to take `self` and `super` arguments. See `lib.trivial.extends` for what those parameters represent. + +- `ansible` now defaults to ansible version 2 as version 1 has been removed due to a serious [ vulnerability](https://www.computest.nl/advisories/CT-2017-0109_Ansible.txt) unpatched by upstream. + +- `gnome` alias has been removed along with `gtk`, `gtkmm` and several others. Now you need to use versioned attributes, like `gnome3`. + +- The attribute name of the Radicale daemon has been changed from `pythonPackages.radicale` to `radicale`. + +- The `stripHash` bash function in `stdenv` changed according to its documentation; it now outputs the stripped name to `stdout` instead of putting it in the variable `strippedName`. + +- 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. + +- Two lone top-level dict dbs moved into `dictdDBs`. This affects: `dictdWordnet` which is now at `dictdDBs.wordnet` and `dictdWiktionary` which is now at `dictdDBs.wiktionary` + +- Parsoid service now uses YAML configuration format. `service.parsoid.interwikis` is now called `service.parsoid.wikis` and is a list of either API URLs or attribute sets as specified in parsoid\'s documentation. + +- `Ntpd` was replaced by `systemd-timesyncd` as the default service to synchronize system time with a remote NTP server. The old behavior can be restored by setting `services.ntp.enable` to `true`. Upstream time servers for all NTP implementations are now configured using `networking.timeServers`. + +- `service.nylon` is now declared using named instances. As an example: + + ```nix + { + services.nylon = { + enable = true; + acceptInterface = "br0"; + bindInterface = "tun1"; + port = 5912; + }; + } + ``` + + should be replaced with: + + ```nix + { + services.nylon.myvpn = { + enable = true; + acceptInterface = "br0"; + bindInterface = "tun1"; + port = 5912; + }; + } + ``` + + this enables you to declare a SOCKS proxy for each uplink. + +- `overridePackages` function no longer exists. It is replaced by [ overlays](https://nixos.org/nixpkgs/manual/#sec-overlays-install). For example, the following code: + + ```nix + let + pkgs = import <nixpkgs> {}; + in + pkgs.overridePackages (self: super: ...) + ``` + + should be replaced by: + + ```nix + let + pkgs = import <nixpkgs> {}; + in + import pkgs.path { overlays = [(self: super: ...)]; } + ``` + +- 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 `networking.firewall.autoLoadConntrackHelpers` and tune `networking.firewall.connectionTrackingModules` to suit your needs. + +- `local_recipient_maps` 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 `services.postfix.extraConfig`. + +- 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 `-4` and `-6` have been added. One notable incompatibility is that specifying an interface (for link-local IPv6 for instance) is no longer done with the `-I` flag, but by encoding the interface into the address (`ping fe80::1%eth0`). + +- The socket handling of the `services.rmilter` module has been fixed and refactored. As rmilter doesn\'t support binding to more than one socket, the options `bindUnixSockets` and `bindInetSockets` have been replaced by `services.rmilter.bindSocket.*`. The default is still a unix socket in `/run/rmilter/rmilter.sock`. Refer to the options documentation for more information. + +- The `fetch*` functions no longer support md5, please use sha256 instead. + +- The dnscrypt-proxy module interface has been streamlined around the `extraArgs` option. Where possible, legacy option declarations are mapped to `extraArgs` but will emit warnings. The `resolverList` has been outright removed: to use an unlisted resolver, use the `customResolver` option. + +- torbrowser now stores local state under `~/.local/share/tor-browser` by default. Any browser profile data from the old location, `~/.torbrowser4`, must be migrated manually. + +- The ihaskell, monetdb, offlineimap and sitecopy services have been removed. + +## Other Notable Changes {#sec-release-17.03-notable-changes} + +- 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. + +- `jre` 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 `jre_headless`. + +- Python 2.6 interpreter and package set have been removed. + +- 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. + +- 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 `nix-shell`. See the Nixpkgs manual for details. + +- The Python package sets now use a fixed-point combinator and the sets are available as attributes of the interpreters. + +- The Python function `buildPythonPackage` has been improved and can be used to build from Setuptools source, Flit source, and precompiled Wheels. + +- When adding new or updating current Python libraries, the expressions should be put in separate files in `pkgs/development/python-modules` and called from `python-packages.nix`. + +- 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. + +- Containers using bridged networking no longer lose their connection after changes to the host networking. + +- ZFS supports pool auto scrubbing. + +- The bind DNS utilities (e.g. dig) have been split into their own output and are now also available in `pkgs.dnsutils` and it is no longer necessary to pull in all of `bind` to use them. + +- Per-user configuration was moved from `~/.nixpkgs` to `~/.config/nixpkgs`. The former is still valid for `config.nix` for backwards compatibility. diff --git a/nixos/doc/manual/release-notes/rl-1703.xml b/nixos/doc/manual/release-notes/rl-1703.xml deleted file mode 100644 index 14b31b232e9..00000000000 --- a/nixos/doc/manual/release-notes/rl-1703.xml +++ /dev/null @@ -1,817 +0,0 @@ -<section xmlns="http://docbook.org/ns/docbook" - xmlns:xlink="http://www.w3.org/1999/xlink" - xmlns:xi="http://www.w3.org/2001/XInclude" - version="5.0" - xml:id="sec-release-17.03"> - <title>Release 17.03 (“Gorilla”, 2017/03/31)</title> - - <section xmlns="http://docbook.org/ns/docbook" - xmlns:xlink="http://www.w3.org/1999/xlink" - xmlns:xi="http://www.w3.org/2001/XInclude" - version="5.0" - xml:id="sec-release-17.03-highlights"> - <title>Highlights</title> - - <para> - 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. - </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. - </para> - </listitem> - <listitem> - <para> - The default desktop environment now is KDE's Plasma 5. KDE 4 has been - removed - </para> - </listitem> - <listitem> - <para> - The setuid wrapper functionality now supports setting capabilities. - </para> - </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. - </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. - </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> - </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. - </para> - </listitem> - <listitem> - <para> - PHP now defaults to PHP 7.1 - </para> - </listitem> - </itemizedlist> - </section> - - <section xmlns="http://docbook.org/ns/docbook" - xmlns:xlink="http://www.w3.org/1999/xlink" - xmlns:xi="http://www.w3.org/2001/XInclude" - version="5.0" - xml:id="sec-release-17.03-new-services"> - <title>New Services</title> - - <para> - The following new services were added since the last release: - </para> - - <itemizedlist> - <listitem> - <para> - <literal>hardware/ckb.nix</literal> - </para> - </listitem> - <listitem> - <para> - <literal>hardware/mcelog.nix</literal> - </para> - </listitem> - <listitem> - <para> - <literal>hardware/usb-wwan.nix</literal> - </para> - </listitem> - <listitem> - <para> - <literal>hardware/video/capture/mwprocapture.nix</literal> - </para> - </listitem> - <listitem> - <para> - <literal>programs/adb.nix</literal> - </para> - </listitem> - <listitem> - <para> - <literal>programs/chromium.nix</literal> - </para> - </listitem> - <listitem> - <para> - <literal>programs/gphoto2.nix</literal> - </para> - </listitem> - <listitem> - <para> - <literal>programs/java.nix</literal> - </para> - </listitem> - <listitem> - <para> - <literal>programs/mtr.nix</literal> - </para> - </listitem> - <listitem> - <para> - <literal>programs/oblogout.nix</literal> - </para> - </listitem> - <listitem> - <para> - <literal>programs/vim.nix</literal> - </para> - </listitem> - <listitem> - <para> - <literal>programs/wireshark.nix</literal> - </para> - </listitem> - <listitem> - <para> - <literal>security/dhparams.nix</literal> - </para> - </listitem> - <listitem> - <para> - <literal>services/audio/ympd.nix</literal> - </para> - </listitem> - <listitem> - <para> - <literal>services/computing/boinc/client.nix</literal> - </para> - </listitem> - <listitem> - <para> - <literal>services/continuous-integration/buildbot/master.nix</literal> - </para> - </listitem> - <listitem> - <para> - <literal>services/continuous-integration/buildbot/worker.nix</literal> - </para> - </listitem> - <listitem> - <para> - <literal>services/continuous-integration/gitlab-runner.nix</literal> - </para> - </listitem> - <listitem> - <para> - <literal>services/databases/riak-cs.nix</literal> - </para> - </listitem> - <listitem> - <para> - <literal>services/databases/stanchion.nix</literal> - </para> - </listitem> - <listitem> - <para> - <literal>services/desktops/gnome3/gnome-terminal-server.nix</literal> - </para> - </listitem> - <listitem> - <para> - <literal>services/editors/infinoted.nix</literal> - </para> - </listitem> - <listitem> - <para> - <literal>services/hardware/illum.nix</literal> - </para> - </listitem> - <listitem> - <para> - <literal>services/hardware/trezord.nix</literal> - </para> - </listitem> - <listitem> - <para> - <literal>services/logging/journalbeat.nix</literal> - </para> - </listitem> - <listitem> - <para> - <literal>services/mail/offlineimap.nix</literal> - </para> - </listitem> - <listitem> - <para> - <literal>services/mail/postgrey.nix</literal> - </para> - </listitem> - <listitem> - <para> - <literal>services/misc/couchpotato.nix</literal> - </para> - </listitem> - <listitem> - <para> - <literal>services/misc/docker-registry.nix</literal> - </para> - </listitem> - <listitem> - <para> - <literal>services/misc/errbot.nix</literal> - </para> - </listitem> - <listitem> - <para> - <literal>services/misc/geoip-updater.nix</literal> - </para> - </listitem> - <listitem> - <para> - <literal>services/misc/gogs.nix</literal> - </para> - </listitem> - <listitem> - <para> - <literal>services/misc/leaps.nix</literal> - </para> - </listitem> - <listitem> - <para> - <literal>services/misc/nix-optimise.nix</literal> - </para> - </listitem> - <listitem> - <para> - <literal>services/misc/ssm-agent.nix</literal> - </para> - </listitem> - <listitem> - <para> - <literal>services/misc/sssd.nix</literal> - </para> - </listitem> - <listitem> - <para> - <literal>services/monitoring/arbtt.nix</literal> - </para> - </listitem> - <listitem> - <para> - <literal>services/monitoring/netdata.nix</literal> - </para> - </listitem> - <listitem> - <para> - <literal>services/monitoring/prometheus/default.nix</literal> - </para> - </listitem> - <listitem> - <para> - <literal>services/monitoring/prometheus/alertmanager.nix</literal> - </para> - </listitem> - <listitem> - <para> - <literal>services/monitoring/prometheus/blackbox-exporter.nix</literal> - </para> - </listitem> - <listitem> - <para> - <literal>services/monitoring/prometheus/json-exporter.nix</literal> - </para> - </listitem> - <listitem> - <para> - <literal>services/monitoring/prometheus/nginx-exporter.nix</literal> - </para> - </listitem> - <listitem> - <para> - <literal>services/monitoring/prometheus/node-exporter.nix</literal> - </para> - </listitem> - <listitem> - <para> - <literal>services/monitoring/prometheus/snmp-exporter.nix</literal> - </para> - </listitem> - <listitem> - <para> - <literal>services/monitoring/prometheus/unifi-exporter.nix</literal> - </para> - </listitem> - <listitem> - <para> - <literal>services/monitoring/prometheus/varnish-exporter.nix</literal> - </para> - </listitem> - <listitem> - <para> - <literal>services/monitoring/sysstat.nix</literal> - </para> - </listitem> - <listitem> - <para> - <literal>services/monitoring/telegraf.nix</literal> - </para> - </listitem> - <listitem> - <para> - <literal>services/monitoring/vnstat.nix</literal> - </para> - </listitem> - <listitem> - <para> - <literal>services/network-filesystems/cachefilesd.nix</literal> - </para> - </listitem> - <listitem> - <para> - <literal>services/network-filesystems/glusterfs.nix</literal> - </para> - </listitem> - <listitem> - <para> - <literal>services/network-filesystems/ipfs.nix</literal> - </para> - </listitem> - <listitem> - <para> - <literal>services/networking/dante.nix</literal> - </para> - </listitem> - <listitem> - <para> - <literal>services/networking/dnscrypt-wrapper.nix</literal> - </para> - </listitem> - <listitem> - <para> - <literal>services/networking/fakeroute.nix</literal> - </para> - </listitem> - <listitem> - <para> - <literal>services/networking/flannel.nix</literal> - </para> - </listitem> - <listitem> - <para> - <literal>services/networking/htpdate.nix</literal> - </para> - </listitem> - <listitem> - <para> - <literal>services/networking/miredo.nix</literal> - </para> - </listitem> - <listitem> - <para> - <literal>services/networking/nftables.nix</literal> - </para> - </listitem> - <listitem> - <para> - <literal>services/networking/powerdns.nix</literal> - </para> - </listitem> - <listitem> - <para> - <literal>services/networking/pdns-recursor.nix</literal> - </para> - </listitem> - <listitem> - <para> - <literal>services/networking/quagga.nix</literal> - </para> - </listitem> - <listitem> - <para> - <literal>services/networking/redsocks.nix</literal> - </para> - </listitem> - <listitem> - <para> - <literal>services/networking/wireguard.nix</literal> - </para> - </listitem> - <listitem> - <para> - <literal>services/system/cgmanager.nix</literal> - </para> - </listitem> - <listitem> - <para> - <literal>services/torrent/opentracker.nix</literal> - </para> - </listitem> - <listitem> - <para> - <literal>services/web-apps/atlassian/confluence.nix</literal> - </para> - </listitem> - <listitem> - <para> - <literal>services/web-apps/atlassian/crowd.nix</literal> - </para> - </listitem> - <listitem> - <para> - <literal>services/web-apps/atlassian/jira.nix</literal> - </para> - </listitem> - <listitem> - <para> - <literal>services/web-apps/frab.nix</literal> - </para> - </listitem> - <listitem> - <para> - <literal>services/web-apps/nixbot.nix</literal> - </para> - </listitem> - <listitem> - <para> - <literal>services/web-apps/selfoss.nix</literal> - </para> - </listitem> - <listitem> - <para> - <literal>services/web-apps/quassel-webserver.nix</literal> - </para> - </listitem> - <listitem> - <para> - <literal>services/x11/unclutter-xfixes.nix</literal> - </para> - </listitem> - <listitem> - <para> - <literal>services/x11/urxvtd.nix</literal> - </para> - </listitem> - <listitem> - <para> - <literal>system/boot/systemd-nspawn.nix</literal> - </para> - </listitem> - <listitem> - <para> - <literal>virtualisation/ecs-agent.nix</literal> - </para> - </listitem> - <listitem> - <para> - <literal>virtualisation/lxcfs.nix</literal> - </para> - </listitem> - <listitem> - <para> - <literal>virtualisation/openstack/keystone.nix</literal> - </para> - </listitem> - <listitem> - <para> - <literal>virtualisation/openstack/glance.nix</literal> - </para> - </listitem> - </itemizedlist> - </section> - - <section xmlns="http://docbook.org/ns/docbook" - xmlns:xlink="http://www.w3.org/1999/xlink" - xmlns:xi="http://www.w3.org/2001/XInclude" - version="5.0" - xml:id="sec-release-17.03-incompatibilities"> - <title>Backward Incompatibilities</title> - - <para> - 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. - </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. - </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. - </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>. - </para> - </listitem> - <listitem> - <para> - 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>. - </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. - </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> - </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. - </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>. - </para> - </listitem> - <listitem> - <para> - <literal>service.nylon</literal> is now declared using named instances. As - an example: -<programlisting> - services.nylon = { - enable = true; - acceptInterface = "br0"; - bindInterface = "tun1"; - port = 5912; - }; -</programlisting> - should be replaced with: -<programlisting> - services.nylon.myvpn = { - enable = true; - acceptInterface = "br0"; - bindInterface = "tun1"; - port = 5912; - }; -</programlisting> - this enables you to declare a SOCKS proxy for each uplink. - </para> - </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: -<programlisting> -let - pkgs = import <nixpkgs> {}; -in - pkgs.overridePackages (self: super: ...) -</programlisting> - should be replaced by: -<programlisting> -let - pkgs = import <nixpkgs> {}; -in - import pkgs.path { overlays = [(self: super: ...)]; } -</programlisting> - </para> - </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. - </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>. - </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>). - </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. - </para> - </listitem> - <listitem> - <para> - 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. - </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. - </para> - </listitem> - <listitem> - <para> - The ihaskell, monetdb, offlineimap and sitecopy services have been - removed. - </para> - </listitem> - </itemizedlist> - </section> - - <section xmlns="http://docbook.org/ns/docbook" - xmlns:xlink="http://www.w3.org/1999/xlink" - xmlns:xi="http://www.w3.org/2001/XInclude" - version="5.0" - xml:id="sec-release-17.03-notable-changes"> - <title>Other Notable Changes</title> - - <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. - </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>. - </para> - </listitem> - <listitem> - <para> - Python 2.6 interpreter and package set have been removed. - </para> - </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. - </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. - </para> - </listitem> - <listitem> - <para> - 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. - </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>. - </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. - </para> - </listitem> - <listitem> - <para> - Containers using bridged networking no longer lose their connection after - changes to the host networking. - </para> - </listitem> - <listitem> - <para> - ZFS supports pool auto scrubbing. - </para> - </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. - </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. - </para> - </listitem> - </itemizedlist> - </section> -</section> diff --git a/nixos/doc/manual/release-notes/rl-1709.section.md b/nixos/doc/manual/release-notes/rl-1709.section.md new file mode 100644 index 00000000000..e5af22721b0 --- /dev/null +++ b/nixos/doc/manual/release-notes/rl-1709.section.md @@ -0,0 +1,316 @@ +# Release 17.09 ("Hummingbird", 2017/09/??) {#sec-release-17.09} + +## Highlights {#sec-release-17.09-highlights} + +In addition to numerous new and upgraded packages, this release has the following highlights: + +- 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 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 module option `services.xserver.xrandrHeads` 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: + + ```nix + { services.xserver.xrandrHeads = [ + "HDMI-0" + { + output = "DVI-0"; + primary = true; + monitorConfig = '' + Option "Rotate" "right" + ''; + } + ]; + } + ``` + + This will set the `DVI-0` output to be the primary head, even though `HDMI-0` is the first head in the list. + +- The handling of SSL in the `services.nginx` module has been cleaned up, renaming the misnamed `enableSSL` to `onlySSL` which reflects its original intention. This is not to be used with the already existing `forceSSL` 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 `enableSSL` option to keep the previous behaviour. + + Another `addSSL` option has been introduced to configure both a non-SSL virtual host and an SSL virtual host with the same configuration. + + Options to configure `resolver` options and `upstream` blocks have been introduced. See their information for further details. + + The `port` option has been replaced by a more generic `listen` option which makes it possible to specify multiple addresses, ports and SSL configs dependant on the new SSL handling mentioned above. + +## New Services {#sec-release-17.09-new-services} + +The following new services were added since the last release: + +- `config/fonts/fontconfig-penultimate.nix` + +- `config/fonts/fontconfig-ultimate.nix` + +- `config/terminfo.nix` + +- `hardware/sensor/iio.nix` + +- `hardware/nitrokey.nix` + +- `hardware/raid/hpsa.nix` + +- `programs/browserpass.nix` + +- `programs/gnupg.nix` + +- `programs/qt5ct.nix` + +- `programs/slock.nix` + +- `programs/thefuck.nix` + +- `security/auditd.nix` + +- `security/lock-kernel-modules.nix` + +- `service-managers/docker.nix` + +- `service-managers/trivial.nix` + +- `services/admin/salt/master.nix` + +- `services/admin/salt/minion.nix` + +- `services/audio/slimserver.nix` + +- `services/cluster/kubernetes/default.nix` + +- `services/cluster/kubernetes/dns.nix` + +- `services/cluster/kubernetes/dashboard.nix` + +- `services/continuous-integration/hail.nix` + +- `services/databases/clickhouse.nix` + +- `services/databases/postage.nix` + +- `services/desktops/gnome3/gnome-disks.nix` + +- `services/desktops/gnome3/gpaste.nix` + +- `services/logging/SystemdJournal2Gelf.nix` + +- `services/logging/heartbeat.nix` + +- `services/logging/journalwatch.nix` + +- `services/logging/syslogd.nix` + +- `services/mail/mailhog.nix` + +- `services/mail/nullmailer.nix` + +- `services/misc/airsonic.nix` + +- `services/misc/autorandr.nix` + +- `services/misc/exhibitor.nix` + +- `services/misc/fstrim.nix` + +- `services/misc/gollum.nix` + +- `services/misc/irkerd.nix` + +- `services/misc/jackett.nix` + +- `services/misc/radarr.nix` + +- `services/misc/snapper.nix` + +- `services/monitoring/osquery.nix` + +- `services/monitoring/prometheus/collectd-exporter.nix` + +- `services/monitoring/prometheus/fritzbox-exporter.nix` + +- `services/network-filesystems/kbfs.nix` + +- `services/networking/dnscache.nix` + +- `services/networking/fireqos.nix` + +- `services/networking/iwd.nix` + +- `services/networking/keepalived/default.nix` + +- `services/networking/keybase.nix` + +- `services/networking/lldpd.nix` + +- `services/networking/matterbridge.nix` + +- `services/networking/squid.nix` + +- `services/networking/tinydns.nix` + +- `services/networking/xrdp.nix` + +- `services/security/shibboleth-sp.nix` + +- `services/security/sks.nix` + +- `services/security/sshguard.nix` + +- `services/security/torify.nix` + +- `services/security/usbguard.nix` + +- `services/security/vault.nix` + +- `services/system/earlyoom.nix` + +- `services/system/saslauthd.nix` + +- `services/web-apps/nexus.nix` + +- `services/web-apps/pgpkeyserver-lite.nix` + +- `services/web-apps/piwik.nix` + +- `services/web-servers/lighttpd/collectd.nix` + +- `services/web-servers/minio.nix` + +- `services/x11/display-managers/xpra.nix` + +- `services/x11/xautolock.nix` + +- `tasks/filesystems/bcachefs.nix` + +- `tasks/powertop.nix` + +## Backward Incompatibilities {#sec-release-17.09-incompatibilities} + +When upgrading from a previous release, please be aware of the following incompatible changes: + +- **In an Qemu-based virtualization environment, the network interface names changed from i.e. `enp0s3` to `ens3`.** + + This is due to a kernel configuration change. The new naming is consistent with those of other Linux distributions with systemd. See [\#29197](https://github.com/NixOS/nixpkgs/issues/29197) for more information. + + A machine is affected if the `virt-what` tool either returns `qemu` or `kvm` _and_ has interface names used in any part of its NixOS configuration, in particular if a static network configuration with `networking.interfaces` is used. + + Before rebooting affected machines, please ensure: + + - Change the interface names in your NixOS configuration. The first interface will be called `ens3`, the second one `ens8` and starting from there incremented by 1. + + - After changing the interface names, rebuild your system with `nixos-rebuild boot` to activate the new configuration after a reboot. If you switch to the new configuration right away you might lose network connectivity! If using `nixops`, deploy with `nixops deploy --force-reboot`. + +- The following changes apply if the `stateVersion` is changed to 17.09 or higher. For `stateVersion = "17.03"` or lower the old behavior is preserved. + + - The `postgres` default version was changed from 9.5 to 9.6. + + - The `postgres` superuser name has changed from `root` to `postgres` to more closely follow what other Linux distributions are doing. + + - The `postgres` default `dataDir` has changed from `/var/db/postgres` to `/var/lib/postgresql/$psqlSchema` where \$psqlSchema is 9.6 for example. + + - The `mysql` default `dataDir` has changed from `/var/mysql` to `/var/lib/mysql`. + + - Radicale\'s default package has changed from 1.x to 2.x. Instructions to migrate can be found [ here ](http://radicale.org/1to2/). It is also possible to use the newer version by setting the `package` to `radicale2`, which is done automatically when `stateVersion` is 17.09 or higher. The `extraArgs` option has been added to allow passing the data migration arguments specified in the instructions; see the `radicale.nix` NixOS test for an example migration. + +- The `aiccu` package was removed. This is due to SixXS [ sunsetting](https://www.sixxs.net/main/) its IPv6 tunnel. + +- The `fanctl` package and `fan` module have been removed due to the developers not upstreaming their iproute2 patches and lagging with compatibility to recent iproute2 versions. + +- Top-level `idea` package collection was renamed. All JetBrains IDEs are now at `jetbrains`. + +- `flexget`\'s state database cannot be upgraded to its new internal format, requiring removal of any existing `db-config.sqlite` which will be automatically recreated. + +- The `ipfs` service now doesn\'t ignore the `dataDir` 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 + + ```ShellSession + dataDir=<valueOfDataDir> + mv /var/lib/ipfs/.ipfs/* $dataDir + rmdir /var/lib/ipfs/.ipfs + ``` + +- The `caddy` service was previously using an extra `.caddy` directory in the data directory specified with the `dataDir` option. The contents of the `.caddy` directory are now expected to be in the `dataDir`. + +- The `ssh-agent` user service is not started by default anymore. Use `programs.ssh.startAgent` to enable it if needed. There is also a new `programs.gnupg.agent` module that creates a `gpg-agent` user service. It can also serve as a SSH agent if `enableSSHSupport` is set. + +- The `services.tinc.networks.<name>.listenAddress` 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 `services.tinc.networks.<name>.bindToAddress` instead. Refer to the description of the options for more details. + +- `tlsdate` package and module were removed. This is due to the project being dead and not building with openssl 1.1. + +- `wvdial` package and module were removed. This is due to the project being dead and not building with openssl 1.1. + +- `cc-wrapper`\'s setup-hook now exports a number of environment variables corresponding to binutils binaries, (e.g. `LD`, `STRIP`, `RANLIB`, 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. + +- `services.firefox.syncserver` 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. + +- The `compiz` window manager and package was removed. The system support had been broken for several years. + +- Touchpad support should now be enabled through `libinput` as `synaptics` is now deprecated. See the option `services.xserver.libinput.enable`. + +- grsecurity/PaX support has been dropped, following upstream\'s decision to cease free support. See [ upstream\'s announcement](https://grsecurity.net/passing_the_baton.php) for more information. No complete replacement for grsecurity/PaX is available presently. + +- `services.mysql` now has declarative configuration of databases and users with the `ensureDatabases` and `ensureUsers` options. + + These options will never delete existing databases and users, especially not when the value of the options are changed. + + The MySQL users will be identified using [ Unix socket authentication](https://mariadb.com/kb/en/library/authentication-plugin-unix-socket/). This authenticates the Unix user with the same name only, and that without the need for a password. + + If you have previously created a MySQL `root` user _with a password_, you will need to add `root` user for unix socket authentication before using the new options. This can be done by running the following SQL script: + + ```SQL + CREATE USER 'root'@'%' IDENTIFIED BY ''; + GRANT ALL PRIVILEGES ON *.* TO 'root'@'%' WITH GRANT OPTION; + FLUSH PRIVILEGES; + + -- Optionally, delete the password-authenticated user: + -- DROP USER 'root'@'localhost'; + ``` + +- `services.mysqlBackup` now works by default without any user setup, including for users other than `mysql`. + + By default, the `mysql` user is no longer the user which performs the backup. Instead a system account `mysqlbackup` is used. + + The `mysqlBackup` service is also now using systemd timers instead of `cron`. + + Therefore, the `services.mysqlBackup.period` option no longer exists, and has been replaced with `services.mysqlBackup.calendar`, which is in the format of [systemd.time(7)](https://www.freedesktop.org/software/systemd/man/systemd.time.html#Calendar%20Events). + + 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. + + You can check that backups still work by running `systemctl start mysql-backup` then `systemctl status mysql-backup`. + +- Templated systemd services e.g `container@name` are now handled currectly when switching to a new configuration, resulting in them being reloaded. + +- Steam: the `newStdcpp` parameter was removed and should not be needed anymore. + +- 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. + +## Other Notable Changes {#sec-release-17.09-notable-changes} + +- Modules can now be disabled by using [ disabledModules](https://nixos.org/nixpkgs/manual/#sec-replace-modules), 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. + +- 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. + +- ZFS/SPL have been updated to 0.7.0, `zfsUnstable, splUnstable` have therefore been removed. + +- The `time.timeZone` option now allows the value `null` in addition to timezone strings. This value allows changing the timezone of a system imperatively using `timedatectl set-timezone`. The default timezone is still UTC. + +- Nixpkgs overlays may now be specified with a file as well as a directory. The value of `<nixpkgs-overlays>` may be a file, and `~/.config/nixpkgs/overlays.nix` can be used instead of the `~/.config/nixpkgs/overlays` directory. + + See the overlays chapter of the Nixpkgs manual for more details. + +- Definitions for `/etc/hosts` can now be specified declaratively with `networking.hosts`. + +- 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. + + This therefore leads to adding a new `debug` option to set the log level to the previous verbose mode, to make debugging easier, but still accessible easily. + + Additionally a `copytoram` 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. + +- `services.gitlab-runner.configOptions` has been added to specify the configuration of gitlab-runners declaratively. + +- `services.jenkins.plugins` has been added to install plugins easily, this can be generated with jenkinsPlugins2nix. + +- `services.postfix.config` 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. + +- The GitLab package and module have been updated to the latest 10.0 release. + +- The `systemd-boot` boot loader now lists the NixOS version, kernel version and build date of all bootable generations. + +- 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 `services.dnscrypt-proxy.resolverName` option or setting it to `"random"`. diff --git a/nixos/doc/manual/release-notes/rl-1709.xml b/nixos/doc/manual/release-notes/rl-1709.xml deleted file mode 100644 index 795c51d2923..00000000000 --- a/nixos/doc/manual/release-notes/rl-1709.xml +++ /dev/null @@ -1,899 +0,0 @@ -<section xmlns="http://docbook.org/ns/docbook" - xmlns:xlink="http://www.w3.org/1999/xlink" - xmlns:xi="http://www.w3.org/2001/XInclude" - version="5.0" - xml:id="sec-release-17.09"> - <title>Release 17.09 (“Hummingbird”, 2017/09/??)</title> - - <section xmlns="http://docbook.org/ns/docbook" - xmlns:xlink="http://www.w3.org/1999/xlink" - xmlns:xi="http://www.w3.org/2001/XInclude" - version="5.0" - xml:id="sec-release-17.09-highlights"> - <title>Highlights</title> - - <para> - 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. - </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. - </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: -<programlisting> -{ services.xserver.xrandrHeads = [ - "HDMI-0" - { - output = "DVI-0"; - primary = true; - monitorConfig = '' - Option "Rotate" "right" - ''; - } - ]; -} -</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. - </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. - </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. - </para> - <para> - 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. - </para> - </listitem> - </itemizedlist> - </section> - - <section xmlns="http://docbook.org/ns/docbook" - xmlns:xlink="http://www.w3.org/1999/xlink" - xmlns:xi="http://www.w3.org/2001/XInclude" - version="5.0" - xml:id="sec-release-17.09-new-services"> - <title>New Services</title> - - <para> - The following new services were added since the last release: - </para> - - <itemizedlist> - <listitem> - <para> - <literal>config/fonts/fontconfig-penultimate.nix</literal> - </para> - </listitem> - <listitem> - <para> - <literal>config/fonts/fontconfig-ultimate.nix</literal> - </para> - </listitem> - <listitem> - <para> - <literal>config/terminfo.nix</literal> - </para> - </listitem> - <listitem> - <para> - <literal>hardware/sensor/iio.nix</literal> - </para> - </listitem> - <listitem> - <para> - <literal>hardware/nitrokey.nix</literal> - </para> - </listitem> - <listitem> - <para> - <literal>hardware/raid/hpsa.nix</literal> - </para> - </listitem> - <listitem> - <para> - <literal>programs/browserpass.nix</literal> - </para> - </listitem> - <listitem> - <para> - <literal>programs/gnupg.nix</literal> - </para> - </listitem> - <listitem> - <para> - <literal>programs/qt5ct.nix</literal> - </para> - </listitem> - <listitem> - <para> - <literal>programs/slock.nix</literal> - </para> - </listitem> - <listitem> - <para> - <literal>programs/thefuck.nix</literal> - </para> - </listitem> - <listitem> - <para> - <literal>security/auditd.nix</literal> - </para> - </listitem> - <listitem> - <para> - <literal>security/lock-kernel-modules.nix</literal> - </para> - </listitem> - <listitem> - <para> - <literal>service-managers/docker.nix</literal> - </para> - </listitem> - <listitem> - <para> - <literal>service-managers/trivial.nix</literal> - </para> - </listitem> - <listitem> - <para> - <literal>services/admin/salt/master.nix</literal> - </para> - </listitem> - <listitem> - <para> - <literal>services/admin/salt/minion.nix</literal> - </para> - </listitem> - <listitem> - <para> - <literal>services/audio/slimserver.nix</literal> - </para> - </listitem> - <listitem> - <para> - <literal>services/cluster/kubernetes/default.nix</literal> - </para> - </listitem> - <listitem> - <para> - <literal>services/cluster/kubernetes/dns.nix</literal> - </para> - </listitem> - <listitem> - <para> - <literal>services/cluster/kubernetes/dashboard.nix</literal> - </para> - </listitem> - <listitem> - <para> - <literal>services/continuous-integration/hail.nix</literal> - </para> - </listitem> - <listitem> - <para> - <literal>services/databases/clickhouse.nix</literal> - </para> - </listitem> - <listitem> - <para> - <literal>services/databases/postage.nix</literal> - </para> - </listitem> - <listitem> - <para> - <literal>services/desktops/gnome3/gnome-disks.nix</literal> - </para> - </listitem> - <listitem> - <para> - <literal>services/desktops/gnome3/gpaste.nix</literal> - </para> - </listitem> - <listitem> - <para> - <literal>services/logging/SystemdJournal2Gelf.nix</literal> - </para> - </listitem> - <listitem> - <para> - <literal>services/logging/heartbeat.nix</literal> - </para> - </listitem> - <listitem> - <para> - <literal>services/logging/journalwatch.nix</literal> - </para> - </listitem> - <listitem> - <para> - <literal>services/logging/syslogd.nix</literal> - </para> - </listitem> - <listitem> - <para> - <literal>services/mail/mailhog.nix</literal> - </para> - </listitem> - <listitem> - <para> - <literal>services/mail/nullmailer.nix</literal> - </para> - </listitem> - <listitem> - <para> - <literal>services/misc/airsonic.nix</literal> - </para> - </listitem> - <listitem> - <para> - <literal>services/misc/autorandr.nix</literal> - </para> - </listitem> - <listitem> - <para> - <literal>services/misc/exhibitor.nix</literal> - </para> - </listitem> - <listitem> - <para> - <literal>services/misc/fstrim.nix</literal> - </para> - </listitem> - <listitem> - <para> - <literal>services/misc/gollum.nix</literal> - </para> - </listitem> - <listitem> - <para> - <literal>services/misc/irkerd.nix</literal> - </para> - </listitem> - <listitem> - <para> - <literal>services/misc/jackett.nix</literal> - </para> - </listitem> - <listitem> - <para> - <literal>services/misc/radarr.nix</literal> - </para> - </listitem> - <listitem> - <para> - <literal>services/misc/snapper.nix</literal> - </para> - </listitem> - <listitem> - <para> - <literal>services/monitoring/osquery.nix</literal> - </para> - </listitem> - <listitem> - <para> - <literal>services/monitoring/prometheus/collectd-exporter.nix</literal> - </para> - </listitem> - <listitem> - <para> - <literal>services/monitoring/prometheus/fritzbox-exporter.nix</literal> - </para> - </listitem> - <listitem> - <para> - <literal>services/network-filesystems/kbfs.nix</literal> - </para> - </listitem> - <listitem> - <para> - <literal>services/networking/dnscache.nix</literal> - </para> - </listitem> - <listitem> - <para> - <literal>services/networking/fireqos.nix</literal> - </para> - </listitem> - <listitem> - <para> - <literal>services/networking/iwd.nix</literal> - </para> - </listitem> - <listitem> - <para> - <literal>services/networking/keepalived/default.nix</literal> - </para> - </listitem> - <listitem> - <para> - <literal>services/networking/keybase.nix</literal> - </para> - </listitem> - <listitem> - <para> - <literal>services/networking/lldpd.nix</literal> - </para> - </listitem> - <listitem> - <para> - <literal>services/networking/matterbridge.nix</literal> - </para> - </listitem> - <listitem> - <para> - <literal>services/networking/squid.nix</literal> - </para> - </listitem> - <listitem> - <para> - <literal>services/networking/tinydns.nix</literal> - </para> - </listitem> - <listitem> - <para> - <literal>services/networking/xrdp.nix</literal> - </para> - </listitem> - <listitem> - <para> - <literal>services/security/shibboleth-sp.nix</literal> - </para> - </listitem> - <listitem> - <para> - <literal>services/security/sks.nix</literal> - </para> - </listitem> - <listitem> - <para> - <literal>services/security/sshguard.nix</literal> - </para> - </listitem> - <listitem> - <para> - <literal>services/security/torify.nix</literal> - </para> - </listitem> - <listitem> - <para> - <literal>services/security/usbguard.nix</literal> - </para> - </listitem> - <listitem> - <para> - <literal>services/security/vault.nix</literal> - </para> - </listitem> - <listitem> - <para> - <literal>services/system/earlyoom.nix</literal> - </para> - </listitem> - <listitem> - <para> - <literal>services/system/saslauthd.nix</literal> - </para> - </listitem> - <listitem> - <para> - <literal>services/web-apps/nexus.nix</literal> - </para> - </listitem> - <listitem> - <para> - <literal>services/web-apps/pgpkeyserver-lite.nix</literal> - </para> - </listitem> - <listitem> - <para> - <literal>services/web-apps/piwik.nix</literal> - </para> - </listitem> - <listitem> - <para> - <literal>services/web-servers/lighttpd/collectd.nix</literal> - </para> - </listitem> - <listitem> - <para> - <literal>services/web-servers/minio.nix</literal> - </para> - </listitem> - <listitem> - <para> - <literal>services/x11/display-managers/xpra.nix</literal> - </para> - </listitem> - <listitem> - <para> - <literal>services/x11/xautolock.nix</literal> - </para> - </listitem> - <listitem> - <para> - <literal>tasks/filesystems/bcachefs.nix</literal> - </para> - </listitem> - <listitem> - <para> - <literal>tasks/powertop.nix</literal> - </para> - </listitem> - </itemizedlist> - </section> - - <section xmlns="http://docbook.org/ns/docbook" - xmlns:xlink="http://www.w3.org/1999/xlink" - xmlns:xi="http://www.w3.org/2001/XInclude" - version="5.0" - xml:id="sec-release-17.09-incompatibilities"> - <title>Backward Incompatibilities</title> - - <para> - 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> - </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. - </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. - </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. - </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>. - </para> - </listitem> - </itemizedlist> - </para> - </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. - </para> - <itemizedlist> - <listitem> - <para> - 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. - </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. - </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>. - </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. - </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. - </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. - </para> - </listitem> - <listitem> - <para> - 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. - </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 -<programlisting> -dataDir=<valueOfDataDir> -mv /var/lib/ipfs/.ipfs/* $dataDir -rmdir /var/lib/ipfs/.ipfs -</programlisting> - </para> - </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>. - </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. - </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. - </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. - </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. - </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. - </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. - </para> - </listitem> - <listitem> - <para> - 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>. - </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. - </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. - </para> - <para> - 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. - </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: -<programlisting language="sql"> -CREATE USER 'root'@'%' IDENTIFIED BY ''; -GRANT ALL PRIVILEGES ON *.* TO 'root'@'%' WITH GRANT OPTION; -FLUSH PRIVILEGES; - --- Optionally, delete the password-authenticated user: --- DROP USER 'root'@'localhost'; -</programlisting> - </para> - </listitem> - <listitem> - <para> - <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. - </para> - <para> - 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 - 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. - </para> - <para> - 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. - </para> - </listitem> - <listitem> - <para> - 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. - </para> - </listitem> - </itemizedlist> - </section> - - <section xmlns="http://docbook.org/ns/docbook" - xmlns:xlink="http://www.w3.org/1999/xlink" - xmlns:xi="http://www.w3.org/2001/XInclude" - version="5.0" - xml:id="sec-release-17.09-notable-changes"> - <title>Other Notable Changes</title> - - <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. - </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. - </para> - </listitem> - <listitem> - <para> - 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. - </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. - </para> - <para> - See the overlays chapter of the Nixpkgs manual for more details. - </para> - </listitem> - <listitem> - <para> - 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. - </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. - </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. - </para> - </listitem> - <listitem> - <para> - <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. - </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. - </para> - </listitem> - <listitem> - <para> - 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. - </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>. - </para> - </listitem> - </itemizedlist> - </section> -</section> diff --git a/nixos/doc/manual/release-notes/rl-1803.section.md b/nixos/doc/manual/release-notes/rl-1803.section.md new file mode 100644 index 00000000000..e4e46798104 --- /dev/null +++ b/nixos/doc/manual/release-notes/rl-1803.section.md @@ -0,0 +1,284 @@ +# Release 18.03 ("Impala", 2018/04/04) {#sec-release-18.03} + +## Highlights {#sec-release-18.03-highlights} + +In addition to numerous new and upgraded packages, this release has the following highlights: + +- End of support is planned for end of October 2018, handing over to 18.09. + +- 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. + +- Nix now defaults to 2.0; see its [release notes](https://nixos.org/nix/manual/#ssec-relnotes-2.0). + +- Core version changes: linux: 4.9 -\> 4.14, glibc: 2.25 -\> 2.26, gcc: 6 -\> 7, systemd: 234 -\> 237. + +- Desktop version changes: gnome: 3.24 -\> 3.26, (KDE) plasma-desktop: 5.10 -\> 5.12. + +- 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: + + - `libmysql` has been deprecated, please use `mysql.connector-c` instead, a compatibility passthru has been added to the MySQL packages. + + - The `mysql57` package has a new `static` output containing the static libraries including `libmysqld.a` + +- PHP now defaults to PHP 7.2, updated from 7.1. + +## New Services {#sec-release-18.03-new-services} + +The following new services were added since the last release: + +- `./config/krb5/default.nix` + +- `./hardware/digitalbitbox.nix` + +- `./misc/label.nix` + +- `./programs/ccache.nix` + +- `./programs/criu.nix` + +- `./programs/digitalbitbox/default.nix` + +- `./programs/less.nix` + +- `./programs/npm.nix` + +- `./programs/plotinus.nix` + +- `./programs/rootston.nix` + +- `./programs/systemtap.nix` + +- `./programs/sway.nix` + +- `./programs/udevil.nix` + +- `./programs/way-cooler.nix` + +- `./programs/yabar.nix` + +- `./programs/zsh/zsh-autoenv.nix` + +- `./services/backup/borgbackup.nix` + +- `./services/backup/crashplan-small-business.nix` + +- `./services/desktops/dleyna-renderer.nix` + +- `./services/desktops/dleyna-server.nix` + +- `./services/desktops/pipewire.nix` + +- `./services/desktops/gnome3/chrome-gnome-shell.nix` + +- `./services/desktops/gnome3/tracker-miners.nix` + +- `./services/hardware/fwupd.nix` + +- `./services/hardware/interception-tools.nix` + +- `./services/hardware/u2f.nix` + +- `./services/hardware/usbmuxd.nix` + +- `./services/mail/clamsmtp.nix` + +- `./services/mail/dkimproxy-out.nix` + +- `./services/mail/pfix-srsd.nix` + +- `./services/misc/gitea.nix` + +- `./services/misc/home-assistant.nix` + +- `./services/misc/ihaskell.nix` + +- `./services/misc/logkeys.nix` + +- `./services/misc/novacomd.nix` + +- `./services/misc/osrm.nix` + +- `./services/misc/plexpy.nix` + +- `./services/misc/pykms.nix` + +- `./services/misc/tzupdate.nix` + +- `./services/monitoring/fusion-inventory.nix` + +- `./services/monitoring/prometheus/exporters.nix` + +- `./services/network-filesystems/beegfs.nix` + +- `./services/network-filesystems/davfs2.nix` + +- `./services/network-filesystems/openafs/client.nix` + +- `./services/network-filesystems/openafs/server.nix` + +- `./services/network-filesystems/ceph.nix` + +- `./services/networking/aria2.nix` + +- `./services/networking/monero.nix` + +- `./services/networking/nghttpx/default.nix` + +- `./services/networking/nixops-dns.nix` + +- `./services/networking/rxe.nix` + +- `./services/networking/stunnel.nix` + +- `./services/web-apps/matomo.nix` + +- `./services/web-apps/restya-board.nix` + +- `./services/web-servers/mighttpd2.nix` + +- `./services/x11/fractalart.nix` + +- `./system/boot/binfmt.nix` + +- `./system/boot/grow-partition.nix` + +- `./tasks/filesystems/ecryptfs.nix` + +- `./virtualisation/hyperv-guest.nix` + +## Backward Incompatibilities {#sec-release-18.03-incompatibilities} + +When upgrading from a previous release, please be aware of the following incompatible changes: + +- `sound.enable` now defaults to false. + +- Dollar signs in options under `services.postfix` 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. + +- The `postage` package (for web-based PostgreSQL administration) has been renamed to `pgmanage`. The corresponding module has also been renamed. To migrate please rename all `services.postage` options to `services.pgmanage`. + +- 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 `nix-env`. The change affects the following packages: + + - `2048-in-terminal` → `_2048-in-terminal` + + - `90secondportraits` → `_90secondportraits` + + - `2bwm` → `_2bwm` + + - `389-ds-base` → `_389-ds-base` + +- **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.** + + DSA support was [deprecated in OpenSSH 7.0](https://www.openssh.com/legacy.html), due to it being too weak. To re-enable support, add `PubkeyAcceptedKeyTypes +ssh-dss` to the end of your `services.openssh.extraConfig`. + + After updating the keys to be stronger, anyone still on a pre-17.03 version is safe to jump to 17.03, as vetted [here](https://search.nix.gsc.io/?q=stateVersion). + +- The `openssh` package now includes Kerberos support by default; the `openssh_with_kerberos` package is now a deprecated alias. If you do not want Kerberos support, you can do `openssh.override { withKerberos = false; }`. Note, this also applies to the `openssh_hpn` package. + +- `cc-wrapper` has been split in two; there is now also a `bintools-wrapper`. The most commonly used files in `nix-support` are now split between the two wrappers. Some commonly used ones, like `nix-support/dynamic-linker`, are duplicated for backwards compatability, even though they rightly belong only in `bintools-wrapper`. Other more obscure ones are just moved. + +- 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 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 `propagatedNativeBuildInputs` should instead be `propagatedBuildInputs`. Thankfully, that was and is the least used type of dependency. Also, it means that some `propagatedBuildInputs` should instead be `depsTargetTargetPropagated`. Other types dependencies should be unaffected. + +- `lib.addPassthru drv passthru` is removed. Use `lib.extendDerivation true passthru drv` instead. + +- The `memcached` service no longer accept dynamic socket paths via `services.memcached.socket`. Unix sockets can be still enabled by `services.memcached.enableUnixSocket` and will be accessible at `/run/memcached/memcached.sock`. + +- The `hardware.amdHybridGraphics.disable` 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 merging of config options for `services.postfix.config` was buggy. Previously, if other options in the Postfix module like `services.postfix.useSrs` 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, `lib.mkForce` or `lib.mkOverride` can be used. + +- The following changes apply if the `stateVersion` is changed to 18.03 or higher. For `stateVersion = "17.09"` or lower the old behavior is preserved. + + - `matrix-synapse` uses postgresql by default instead of sqlite. Migration instructions can be found [ here ](https://github.com/matrix-org/synapse/blob/master/docs/postgres.rst#porting-from-sqlite). + +- The `jid` package has been removed, due to maintenance overhead of a go package having non-versioned dependencies. + +- When using `services.xserver.libinput` (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, `Option "XkbRules" "base"` may result in broken keyboard layout. + +- The `attic` package was removed. A maintained fork called [Borg](https://www.borgbackup.org/) should be used instead. Migration instructions can be found [here](http://borgbackup.readthedocs.io/en/stable/usage/upgrade.html#attic-and-borg-0-xx-to-borg-1-x). + +- The Piwik analytics software was renamed to Matomo: + + - The package `pkgs.piwik` was renamed to `pkgs.matomo`. + + - The service `services.piwik` was renamed to `services.matomo`. + + - The data directory `/var/lib/piwik` was renamed to `/var/lib/matomo`. All files will be moved automatically on first startup, but you might need to adjust your backup scripts. + + - The default `serverName` for the nginx configuration changed from `piwik.${config.networking.hostName}` to `matomo.${config.networking.hostName}.${config.networking.domain}` if `config.networking.domain` is set, `matomo.${config.networking.hostName}` if it is not set. If you change your `serverName`, remember you\'ll need to update the `trustedHosts[]` array in `/var/lib/matomo/config/config.ini.php` as well. + + - The `piwik` user was renamed to `matomo`. The service will adjust ownership automatically for files in the data directory. If you use unix socket authentication, remember to give the new `matomo` user access to the database and to change the `username` to `matomo` in the `[database]` section of `/var/lib/matomo/config/config.ini.php`. + + - 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. + +- `nodejs-4_x` is end-of-life. `nodejs-4_x`, `nodejs-slim-4_x` and `nodePackages_4_x` are removed. + +- The `pump.io` NixOS module was removed. It is now maintained as an [external module](https://github.com/rvl/pump.io-nixos). + +- The Prosody XMPP server has received a major update. The following modules were renamed: + + - `services.prosody.modules.httpserver` is now `services.prosody.modules.http_files` + + - `services.prosody.modules.console` is now `services.prosody.modules.admin_telnet` + + Many new modules are now core modules, most notably `services.prosody.modules.carbons` and `services.prosody.modules.mam`. + + The better-performing `libevent` backend is now enabled by default. + + `withCommunityModules` now passes through the modules to `services.prosody.extraModules`. Use `withOnlyInstalledCommunityModules` for modules that should not be enabled directly, e.g `lib_ldap`. + +- All prometheus exporter modules are now defined as submodules. The exporters are configured using `services.prometheus.exporters`. + +## Other Notable Changes {#sec-release-18.03-notable-changes} + +- ZNC option `services.znc.mutable` now defaults to `true`. That means that old configuration is not overwritten by default when update to the znc options are made. + +- The option `networking.wireless.networks.<name>.auth` has been added for wireless networks with WPA-Enterprise authentication. There is also a new `extraConfig` option to directly configure `wpa_supplicant` and `hidden` to connect to hidden networks. + +- In the module `networking.interfaces.<name>` the following options have been removed: + + - `ipAddress` + + - `ipv6Address` + + - `prefixLength` + + - `ipv6PrefixLength` + + - `subnetMask` + + To assign static addresses to an interface the options `ipv4.addresses` and `ipv6.addresses` should be used instead. The options `ip4` and `ip6` have been renamed to `ipv4.addresses` `ipv6.addresses` respectively. The new options `ipv4.routes` and `ipv6.routes` have been added to set up static routing. + +- The option `services.logstash.listenAddress` is now `127.0.0.1` by default. Previously the default behaviour was to listen on all interfaces. + +- `services.btrfs.autoScrub` has been added, to periodically check btrfs filesystems for data corruption. If there\'s a correct copy available, it will automatically repair corrupted blocks. + +- `displayManager.lightdm.greeters.gtk.clock-format.` has been added, the clock format string (as expected by strftime, e.g. `%H:%M`) to use with the lightdm gtk greeter panel. + + If set to null the default clock format is used. + +- `displayManager.lightdm.greeters.gtk.indicators` has been added, a list of allowed indicator modules to use with the lightdm gtk greeter panel. + + Built-in indicators include `~a11y`, `~language`, `~session`, `~power`, `~clock`, `~host`, `~spacer`. Unity indicators can be represented by short name (e.g. `sound`, `power`), service file name, or absolute path. + + If set to `null` the default indicators are used. + + In order to have the previous default configuration add + + ```nix + { + services.xserver.displayManager.lightdm.greeters.gtk.indicators = [ + "~host" "~spacer" + "~clock" "~spacer" + "~session" + "~language" + "~a11y" + "~power" + ]; + } + ``` + + to your `configuration.nix`. + +- The NixOS test driver supports user services declared by `systemd.user.services`. The methods `waitForUnit`, `getUnitInfo`, `startJob` and `stopJob` provide an optional `$user` argument for that purpose. + +- Enabling bash completion on NixOS, `programs.bash.enableCompletion`, will now also enable completion for the Nix command line tools by installing the [nix-bash-completions](https://github.com/hedning/nix-bash-completions) package. diff --git a/nixos/doc/manual/release-notes/rl-1803.xml b/nixos/doc/manual/release-notes/rl-1803.xml deleted file mode 100644 index c14679eea07..00000000000 --- a/nixos/doc/manual/release-notes/rl-1803.xml +++ /dev/null @@ -1,855 +0,0 @@ -<section xmlns="http://docbook.org/ns/docbook" - xmlns:xlink="http://www.w3.org/1999/xlink" - xmlns:xi="http://www.w3.org/2001/XInclude" - version="5.0" - xml:id="sec-release-18.03"> - <title>Release 18.03 (“Impala”, 2018/04/04)</title> - - <section xmlns="http://docbook.org/ns/docbook" - xmlns:xlink="http://www.w3.org/1999/xlink" - xmlns:xi="http://www.w3.org/2001/XInclude" - version="5.0" - xml:id="sec-release-18.03-highlights"> - <title>Highlights</title> - - <para> - In addition to numerous new and upgraded packages, this release has the - following highlights: - </para> - - <itemizedlist> - <listitem> - <para> - End of support is planned for end of October 2018, handing over to 18.09. - </para> - </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. - </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>. - </para> - </listitem> - <listitem> - <para> - 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. - </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: - <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. - </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> - </para> - </listitem> - </itemizedlist> - </para> - </listitem> - <listitem> - <para> - PHP now defaults to PHP 7.2, updated from 7.1. - </para> - </listitem> - </itemizedlist> - </section> - - <section xmlns="http://docbook.org/ns/docbook" - xmlns:xlink="http://www.w3.org/1999/xlink" - xmlns:xi="http://www.w3.org/2001/XInclude" - version="5.0" - xml:id="sec-release-18.03-new-services"> - <title>New Services</title> - - <para> - The following new services were added since the last release: - </para> - - <itemizedlist> - <listitem> - <para> - <literal>./config/krb5/default.nix</literal> - </para> - </listitem> - <listitem> - <para> - <literal>./hardware/digitalbitbox.nix</literal> - </para> - </listitem> - <listitem> - <para> - <literal>./misc/label.nix</literal> - </para> - </listitem> - <listitem> - <para> - <literal>./programs/ccache.nix</literal> - </para> - </listitem> - <listitem> - <para> - <literal>./programs/criu.nix</literal> - </para> - </listitem> - <listitem> - <para> - <literal>./programs/digitalbitbox/default.nix</literal> - </para> - </listitem> - <listitem> - <para> - <literal>./programs/less.nix</literal> - </para> - </listitem> - <listitem> - <para> - <literal>./programs/npm.nix</literal> - </para> - </listitem> - <listitem> - <para> - <literal>./programs/plotinus.nix</literal> - </para> - </listitem> - <listitem> - <para> - <literal>./programs/rootston.nix</literal> - </para> - </listitem> - <listitem> - <para> - <literal>./programs/systemtap.nix</literal> - </para> - </listitem> - <listitem> - <para> - <literal>./programs/sway.nix</literal> - </para> - </listitem> - <listitem> - <para> - <literal>./programs/udevil.nix</literal> - </para> - </listitem> - <listitem> - <para> - <literal>./programs/way-cooler.nix</literal> - </para> - </listitem> - <listitem> - <para> - <literal>./programs/yabar.nix</literal> - </para> - </listitem> - <listitem> - <para> - <literal>./programs/zsh/zsh-autoenv.nix</literal> - </para> - </listitem> - <listitem> - <para> - <literal>./services/backup/borgbackup.nix</literal> - </para> - </listitem> - <listitem> - <para> - <literal>./services/backup/crashplan-small-business.nix</literal> - </para> - </listitem> - <listitem> - <para> - <literal>./services/desktops/dleyna-renderer.nix</literal> - </para> - </listitem> - <listitem> - <para> - <literal>./services/desktops/dleyna-server.nix</literal> - </para> - </listitem> - <listitem> - <para> - <literal>./services/desktops/pipewire.nix</literal> - </para> - </listitem> - <listitem> - <para> - <literal>./services/desktops/gnome3/chrome-gnome-shell.nix</literal> - </para> - </listitem> - <listitem> - <para> - <literal>./services/desktops/gnome3/tracker-miners.nix</literal> - </para> - </listitem> - <listitem> - <para> - <literal>./services/hardware/fwupd.nix</literal> - </para> - </listitem> - <listitem> - <para> - <literal>./services/hardware/interception-tools.nix</literal> - </para> - </listitem> - <listitem> - <para> - <literal>./services/hardware/u2f.nix</literal> - </para> - </listitem> - <listitem> - <para> - <literal>./services/hardware/usbmuxd.nix</literal> - </para> - </listitem> - <listitem> - <para> - <literal>./services/mail/clamsmtp.nix</literal> - </para> - </listitem> - <listitem> - <para> - <literal>./services/mail/dkimproxy-out.nix</literal> - </para> - </listitem> - <listitem> - <para> - <literal>./services/mail/pfix-srsd.nix</literal> - </para> - </listitem> - <listitem> - <para> - <literal>./services/misc/gitea.nix</literal> - </para> - </listitem> - <listitem> - <para> - <literal>./services/misc/home-assistant.nix</literal> - </para> - </listitem> - <listitem> - <para> - <literal>./services/misc/ihaskell.nix</literal> - </para> - </listitem> - <listitem> - <para> - <literal>./services/misc/logkeys.nix</literal> - </para> - </listitem> - <listitem> - <para> - <literal>./services/misc/novacomd.nix</literal> - </para> - </listitem> - <listitem> - <para> - <literal>./services/misc/osrm.nix</literal> - </para> - </listitem> - <listitem> - <para> - <literal>./services/misc/plexpy.nix</literal> - </para> - </listitem> - <listitem> - <para> - <literal>./services/misc/pykms.nix</literal> - </para> - </listitem> - <listitem> - <para> - <literal>./services/misc/tzupdate.nix</literal> - </para> - </listitem> - <listitem> - <para> - <literal>./services/monitoring/fusion-inventory.nix</literal> - </para> - </listitem> - <listitem> - <para> - <literal>./services/monitoring/prometheus/exporters.nix</literal> - </para> - </listitem> - <listitem> - <para> - <literal>./services/network-filesystems/beegfs.nix</literal> - </para> - </listitem> - <listitem> - <para> - <literal>./services/network-filesystems/davfs2.nix</literal> - </para> - </listitem> - <listitem> - <para> - <literal>./services/network-filesystems/openafs/client.nix</literal> - </para> - </listitem> - <listitem> - <para> - <literal>./services/network-filesystems/openafs/server.nix</literal> - </para> - </listitem> - <listitem> - <para> - <literal>./services/network-filesystems/ceph.nix</literal> - </para> - </listitem> - <listitem> - <para> - <literal>./services/networking/aria2.nix</literal> - </para> - </listitem> - <listitem> - <para> - <literal>./services/networking/monero.nix</literal> - </para> - </listitem> - <listitem> - <para> - <literal>./services/networking/nghttpx/default.nix</literal> - </para> - </listitem> - <listitem> - <para> - <literal>./services/networking/nixops-dns.nix</literal> - </para> - </listitem> - <listitem> - <para> - <literal>./services/networking/rxe.nix</literal> - </para> - </listitem> - <listitem> - <para> - <literal>./services/networking/stunnel.nix</literal> - </para> - </listitem> - <listitem> - <para> - <literal>./services/web-apps/matomo.nix</literal> - </para> - </listitem> - <listitem> - <para> - <literal>./services/web-apps/restya-board.nix</literal> - </para> - </listitem> - <listitem> - <para> - <literal>./services/web-servers/mighttpd2.nix</literal> - </para> - </listitem> - <listitem> - <para> - <literal>./services/x11/fractalart.nix</literal> - </para> - </listitem> - <listitem> - <para> - <literal>./system/boot/binfmt.nix</literal> - </para> - </listitem> - <listitem> - <para> - <literal>./system/boot/grow-partition.nix</literal> - </para> - </listitem> - <listitem> - <para> - <literal>./tasks/filesystems/ecryptfs.nix</literal> - </para> - </listitem> - <listitem> - <para> - <literal>./virtualisation/hyperv-guest.nix</literal> - </para> - </listitem> - </itemizedlist> - </section> - - <section xmlns="http://docbook.org/ns/docbook" - xmlns:xlink="http://www.w3.org/1999/xlink" - xmlns:xi="http://www.w3.org/2001/XInclude" - version="5.0" - xml:id="sec-release-18.03-incompatibilities"> - <title>Backward Incompatibilities</title> - - <para> - When upgrading from a previous release, please be aware of the following - incompatible changes: - </para> - - <itemizedlist> - <listitem> - <para> - <literal>sound.enable</literal> now defaults to false. - </para> - </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. - </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>. - </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: - <itemizedlist> - <listitem> - <para> - <literal>2048-in-terminal</literal> → - <literal>_2048-in-terminal</literal> - </para> - </listitem> - <listitem> - <para> - <literal>90secondportraits</literal> → - <literal>_90secondportraits</literal> - </para> - </listitem> - <listitem> - <para> - <literal>2bwm</literal> → <literal>_2bwm</literal> - </para> - </listitem> - <listitem> - <para> - <literal>389-ds-base</literal> → <literal>_389-ds-base</literal> - </para> - </listitem> - </itemizedlist> - </para> - </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> - </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>. - </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>. - </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. - </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. - </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. -<!-- 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. - </para> - </listitem> - <listitem> - <para> - <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>. - </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. - </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. - </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. - </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>. - </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. - </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. - </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>. - </para> - </listitem> - <listitem> - <para> - The Piwik analytics software was renamed to Matomo: - <itemizedlist> - <listitem> - <para> - 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>. - </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. - </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. - </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>. - </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. - </para> - </listitem> - </itemizedlist> - </para> - </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. - </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>. - </para> - </listitem> - <listitem> - <para> - 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> - </para> - </listitem> - <listitem> - <para> - <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>. - </para> - <para> - 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>. - </para> - </listitem> - <listitem> - <para> - All prometheus exporter modules are now defined as submodules. The - exporters are configured using - <literal>services.prometheus.exporters</literal>. - </para> - </listitem> - </itemizedlist> - </section> - - <section xmlns="http://docbook.org/ns/docbook" - xmlns:xlink="http://www.w3.org/1999/xlink" - xmlns:xi="http://www.w3.org/2001/XInclude" - version="5.0" - xml:id="sec-release-18.03-notable-changes"> - <title>Other Notable Changes</title> - - <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. - </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. - </para> - </listitem> - <listitem> - <para> - In the module <option>networking.interfaces.<name></option> the - following options have been removed: - <itemizedlist> - <listitem> - <para> - <option>ipAddress</option> - </para> - </listitem> - <listitem> - <para> - <option>ipv6Address</option> - </para> - </listitem> - <listitem> - <para> - <option>prefixLength</option> - </para> - </listitem> - <listitem> - <para> - <option>ipv6PrefixLength</option> - </para> - </listitem> - <listitem> - <para> - <option>subnetMask</option> - </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. - </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. - </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. - </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. - </para> - <para> - If set to null the default clock format is used. - </para> - </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. - </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. - </para> - <para> - If set to <literal>null</literal> the default indicators are used. - </para> - <para> - In order to have the previous default configuration add -<programlisting> - services.xserver.displayManager.lightdm.greeters.gtk.indicators = [ - "~host" "~spacer" - "~clock" "~spacer" - "~session" - "~language" - "~a11y" - "~power" - ]; -</programlisting> - to your <literal>configuration.nix</literal>. - </para> - </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. - </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. - </para> - </listitem> - </itemizedlist> - </section> -</section> diff --git a/nixos/doc/manual/release-notes/rl-1809.section.md b/nixos/doc/manual/release-notes/rl-1809.section.md new file mode 100644 index 00000000000..3443db37c97 --- /dev/null +++ b/nixos/doc/manual/release-notes/rl-1809.section.md @@ -0,0 +1,332 @@ +# Release 18.09 ("Jellyfish", 2018/10/05) {#sec-release-18.09} + +## Highlights {#sec-release-18.09-highlights} + +In addition to numerous new and upgraded packages, this release has the following notable updates: + +- End of support is planned for end of April 2019, handing over to 19.03. + +- 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. + +- Nix has been updated to 2.1; see its [release notes](https://nixos.org/nix/manual/#ssec-relnotes-2.1). + +- Core versions: linux: 4.14 LTS (unchanged), glibc: 2.26 → 2.27, gcc: 7 (unchanged), systemd: 237 → 239. + +- Desktop version changes: gnome: 3.26 → 3.28, (KDE) plasma-desktop: 5.12 → 5.13. + +Notable changes and additions for 18.09 include: + +- Support for wrapping binaries using `firejail` has been added through `programs.firejail.wrappedBinaries`. + + For example + + ```nix + { + programs.firejail = { + enable = true; + wrappedBinaries = { + firefox = "${lib.getBin pkgs.firefox}/bin/firefox"; + mpv = "${lib.getBin pkgs.mpv}/bin/mpv"; + }; + }; + } + ``` + + This will place `firefox` and `mpv` binaries in the global path wrapped by firejail. + +- User channels are now in the default `NIX_PATH`, allowing users to use their personal `nix-channel` defined channels in `nix-build` and `nix-shell` commands, as well as in imports like `import <mychannel>`. + + For example + + ```ShellSession + $ nix-channel --add https://nixos.org/channels/nixpkgs-unstable nixpkgsunstable + $ nix-channel --update + $ nix-build '<nixpkgsunstable>' -A gitFull + $ nix run -f '<nixpkgsunstable>' gitFull + $ nix-instantiate -E '(import <nixpkgsunstable> {}).gitFull' + ``` + +## New Services {#sec-release-18.09-new-services} + +A curated selection of new services that were added since the last release: + +- The `services.cassandra` 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 [Apache Cassandra](https://cassandra.apache.org/). + +- There is a new `services.foundationdb` module for deploying [FoundationDB](https://www.foundationdb.org) clusters. + +- When enabled the `iproute2` will copy the files expected by ip route (e.g., `rt_tables`) in `/etc/iproute2`. This allows to write aliases for routing tables for instance. + +- `services.strongswan-swanctl` is a modern replacement for `services.strongswan`. You can use either one of them to setup IPsec VPNs but not both at the same time. + + `services.strongswan-swanctl` uses the [swanctl](https://wiki.strongswan.org/projects/strongswan/wiki/swanctl) command which uses the modern [vici](https://github.com/strongswan/strongswan/blob/master/src/libcharon/plugins/vici/README.md) _Versatile IKE Configuration Interface_. The deprecated `ipsec` command used in `services.strongswan` is using the legacy [stroke configuration interface](https://github.com/strongswan/strongswan/blob/master/README_LEGACY.md). + +- The new `services.elasticsearch-curator` service periodically curates or manages, your Elasticsearch indices and snapshots. + +Every new services: + +- `./config/xdg/autostart.nix` + +- `./config/xdg/icons.nix` + +- `./config/xdg/menus.nix` + +- `./config/xdg/mime.nix` + +- `./hardware/brightnessctl.nix` + +- `./hardware/onlykey.nix` + +- `./hardware/video/uvcvideo/default.nix` + +- `./misc/documentation.nix` + +- `./programs/firejail.nix` + +- `./programs/iftop.nix` + +- `./programs/sedutil.nix` + +- `./programs/singularity.nix` + +- `./programs/xss-lock.nix` + +- `./programs/zsh/zsh-autosuggestions.nix` + +- `./services/admin/oxidized.nix` + +- `./services/backup/duplicati.nix` + +- `./services/backup/restic.nix` + +- `./services/backup/restic-rest-server.nix` + +- `./services/cluster/hadoop/default.nix` + +- `./services/databases/aerospike.nix` + +- `./services/databases/monetdb.nix` + +- `./services/desktops/bamf.nix` + +- `./services/desktops/flatpak.nix` + +- `./services/desktops/zeitgeist.nix` + +- `./services/development/bloop.nix` + +- `./services/development/jupyter/default.nix` + +- `./services/hardware/lcd.nix` + +- `./services/hardware/undervolt.nix` + +- `./services/misc/clipmenu.nix` + +- `./services/misc/gitweb.nix` + +- `./services/misc/serviio.nix` + +- `./services/misc/safeeyes.nix` + +- `./services/misc/sysprof.nix` + +- `./services/misc/weechat.nix` + +- `./services/monitoring/datadog-agent.nix` + +- `./services/monitoring/incron.nix` + +- `./services/networking/dnsdist.nix` + +- `./services/networking/freeradius.nix` + +- `./services/networking/hans.nix` + +- `./services/networking/morty.nix` + +- `./services/networking/ndppd.nix` + +- `./services/networking/ocserv.nix` + +- `./services/networking/owamp.nix` + +- `./services/networking/quagga.nix` + +- `./services/networking/shadowsocks.nix` + +- `./services/networking/stubby.nix` + +- `./services/networking/zeronet.nix` + +- `./services/security/certmgr.nix` + +- `./services/security/cfssl.nix` + +- `./services/security/oauth2_proxy_nginx.nix` + +- `./services/web-apps/virtlyst.nix` + +- `./services/web-apps/youtrack.nix` + +- `./services/web-servers/hitch/default.nix` + +- `./services/web-servers/hydron.nix` + +- `./services/web-servers/meguca.nix` + +- `./services/web-servers/nginx/gitweb.nix` + +- `./virtualisation/kvmgt.nix` + +- `./virtualisation/qemu-guest-agent.nix` + +## Backward Incompatibilities {#sec-release-18.09-incompatibilities} + +When upgrading from a previous release, please be aware of the following incompatible changes: + +- Some licenses that were incorrectly not marked as unfree now are. This is the case for: + + - cc-by-nc-sa-20: Creative Commons Attribution Non Commercial Share Alike 2.0 + + - cc-by-nc-sa-25: Creative Commons Attribution Non Commercial Share Alike 2.5 + + - cc-by-nc-sa-30: Creative Commons Attribution Non Commercial Share Alike 3.0 + + - cc-by-nc-sa-40: Creative Commons Attribution Non Commercial Share Alike 4.0 + + - cc-by-nd-30: Creative Commons Attribution-No Derivative Works v3.00 + + - msrla: Microsoft Research License Agreement + +- The deprecated `services.cassandra` module has seen a complete rewrite. (See above.) + +- `lib.strict` is removed. Use `builtins.seq` instead. + +- The `clementine` package points now to the free derivation. `clementineFree` is removed now and `clementineUnfree` points to the package which is bundled with the unfree `libspotify` package. + +- The `netcat` package is now taken directly from OpenBSD\'s `libressl`, 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 `services.docker-registry.extraConfig` 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 [the `docker/distribution` docs](https://github.com/docker/distribution/blob/v2.6.2/docs/configuration.md). + +- `gnucash` has changed from version 2.4 to 3.x. If you\'ve been using `gnucash` (version 2.4) instead of `gnucash26` (version 2.6) you must open your Gnucash data file(s) with `gnucash26` and then save them to upgrade the file format. Then you may use your data file(s) with Gnucash 3.x. See the upgrade [documentation](https://wiki.gnucash.org/wiki/FAQ#Using_Different_Versions.2C_Up_And_Downgrade). Gnucash 2.4 is still available under the attribute `gnucash24`. + +- `services.munge` now runs as user (and group) `munge` instead of root. Make sure the key file is accessible to the daemon. + +- `dockerTools.buildImage` now uses `null` as default value for `tag`, which indicates that the nix output hash will be used as tag. + +- The ELK stack: `elasticsearch`, `logstash` and `kibana` has been upgraded from 2.\* to 6.3.\*. The 2.\* versions have been [unsupported since last year](https://www.elastic.co/support/eol) so they have been removed. You can still use the 5.\* versions under the names `elasticsearch5`, `logstash5` and `kibana5`. + + The elastic beats: `filebeat`, `heartbeat`, `metricbeat` and `packetbeat` have had the same treatment: they now target 6.3.\* as well. The 5.\* versions are available under the names: `filebeat5`, `heartbeat5`, `metricbeat5` and `packetbeat5` + + The ELK-6.3 stack now comes with [X-Pack by default](https://www.elastic.co/products/x-pack/open). Since X-Pack is licensed under the [Elastic License](https://github.com/elastic/elasticsearch/blob/master/licenses/ELASTIC-LICENSE.txt) the ELK packages now have an unfree license. To use them you need to specify `allowUnfree = true;` in your nixpkgs configuration. + + Fortunately there is also a free variant of the ELK stack without X-Pack. The packages are available under the names: `elasticsearch-oss`, `logstash-oss` and `kibana-oss`. + +- Options `boot.initrd.luks.devices.name.yubikey.ramfsMountPoint` `boot.initrd.luks.devices.name.yubikey.storage.mountPoint` were removed. `luksroot.nix` 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. + +- `stdenv.system` and `system` 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 `stdenv.buildPlatform.system` can be used instead for the old behavior. They should be using that anyways for clarity. + +- Groups `kvm` and `render` are introduced now, as systemd requires them. + +## Other Notable Changes {#sec-release-18.09-notable-changes} + +- `dockerTools.pullImage` relies on image digest instead of image tag to download the image. The `sha256` of a pulled image has to be updated. + +- `lib.attrNamesToStr` has been deprecated. Use more specific concatenation (`lib.concat(Map)StringsSep`) instead. + +- `lib.addErrorContextToAttrs` has been deprecated. Use `builtins.addErrorContext` directly. + +- `lib.showVal` has been deprecated. Use `lib.traceSeqN` instead. + +- `lib.traceXMLVal` has been deprecated. Use `lib.traceValFn builtins.toXml` instead. + +- `lib.traceXMLValMarked` has been deprecated. Use `lib.traceValFn (x: str + builtins.toXML x)` instead. + +- The `pkgs` argument to NixOS modules can now be set directly using `nixpkgs.pkgs`. Previously, only the `system`, `config` and `overlays` arguments could be used to influence `pkgs`. + +- A NixOS system can now be constructed more easily based on a preexisting invocation of Nixpkgs. For example: + + ```nix + { + inherit (pkgs.nixos { + boot.loader.grub.enable = false; + fileSystems."/".device = "/dev/xvda1"; + }) toplevel kernel initialRamdisk manual; + } + ``` + + 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. + +- `lib.traceValIfNot` has been deprecated. Use `if/then/else` and `lib.traceValSeq` instead. + +- `lib.traceCallXml` has been deprecated. Please complain if you use the function regularly. + +- The attribute `lib.nixpkgsVersion` has been deprecated in favor of `lib.version`. Please refer to the discussion in [NixOS/nixpkgs\#39416](https://github.com/NixOS/nixpkgs/pull/39416#discussion_r183845745) for further reference. + +- `lib.recursiveUpdateUntil` was not acting according to its specification. It has been fixed to act according to the docstring, and a test has been added. + +- The module for `security.dhparams` has two new options now: + + `security.dhparams.stateless` + + : Puts the generated Diffie-Hellman parameters into the Nix store instead of managing them in a stateful manner in `/var/lib/dhparams`. + + `security.dhparams.defaultBitSize` + + : The default bit size to use for the generated Diffie-Hellman parameters. + + ::: {.note} + The path to the actual generated parameter files should now be queried using `config.security.dhparams.params.name.path` because it might be either in the Nix store or in a directory configured by `security.dhparams.path`. + ::: + + ::: {.note} + **For developers:** + + 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). + + An example usage of this would be: + + ```nix + { config, ... }: + + { + security.dhparams.params.myservice = {}; + environment.etc."myservice.conf".text = '' + dhparams = ${config.security.dhparams.params.myservice.path} + ''; + } + ``` + + ::: + +- `networking.networkmanager.useDnsmasq` has been deprecated. Use `networking.networkmanager.dns` instead. + +- The Kubernetes package has been bumped to major version 1.11. Please consult the [release notes](https://github.com/kubernetes/kubernetes/blob/release-1.11/CHANGELOG-1.11.md) for details on new features and api changes. + +- The option `services.kubernetes.apiserver.admissionControl` was renamed to `services.kubernetes.apiserver.enableAdmissionPlugins`. + +- 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. + +- The option `services.kubernetes.apiserver.address` was renamed to `services.kubernetes.apiserver.bindAddress`. Note that the default value has changed from 127.0.0.1 to 0.0.0.0. + +- The option `services.kubernetes.apiserver.publicAddress` was not used and thus has been removed. + +- The option `services.kubernetes.addons.dashboard.enableRBAC` was renamed to `services.kubernetes.addons.dashboard.rbac.enable`. + +- The Kubernetes Dashboard now has only minimal RBAC permissions by default. If dashboard cluster-admin rights are desired, set `services.kubernetes.addons.dashboard.rbac.clusterAdmin` 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: `kubectl delete clusterrolebinding kubernetes-dashboard` + +- The `programs.screen` module provides allows to configure `/etc/screenrc`, however the module behaved fairly counterintuitive as the config exists, but the package wasn\'t available. Since 18.09 `pkgs.screen` will be added to `environment.systemPackages`. + +- The module `services.networking.hostapd` now uses WPA2 by default. + +- `s6Dns`, `s6Networking`, `s6LinuxUtils` and `s6PortableUtils` renamed to `s6-dns`, `s6-networking`, `s6-linux-utils` and `s6-portable-utils` respectively. + +- The module option `nix.useSandbox` is now defaulted to `true`. + +- The config activation script of `nixos-rebuild` now [reloads](https://www.freedesktop.org/software/systemd/man/systemctl.html#Manager%20Lifecycle%20Commands) all user units for each authenticated user. + +- The default display manager is now LightDM. To use SLiM set `services.xserver.displayManager.slim.enable` to `true`. + +- 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 `</para><para>` to start a new paragraph. + +- Top-level `buildPlatform`, `hostPlatform`, and `targetPlatform` in Nixpkgs are deprecated. Please use their equivalents in `stdenv` instead: `stdenv.buildPlatform`, `stdenv.hostPlatform`, and `stdenv.targetPlatform`. diff --git a/nixos/doc/manual/release-notes/rl-1809.xml b/nixos/doc/manual/release-notes/rl-1809.xml deleted file mode 100644 index 3f10b26223d..00000000000 --- a/nixos/doc/manual/release-notes/rl-1809.xml +++ /dev/null @@ -1,933 +0,0 @@ -<section xmlns="http://docbook.org/ns/docbook" - xmlns:xlink="http://www.w3.org/1999/xlink" - xmlns:xi="http://www.w3.org/2001/XInclude" - version="5.0" - xml:id="sec-release-18.09"> - <title>Release 18.09 (“Jellyfish”, 2018/10/05)</title> - - <section xmlns="http://docbook.org/ns/docbook" - xmlns:xlink="http://www.w3.org/1999/xlink" - xmlns:xi="http://www.w3.org/2001/XInclude" - version="5.0" - xml:id="sec-release-18.09-highlights"> - <title>Highlights</title> - - <para> - In addition to numerous new and upgraded packages, this release has the - following notable updates: - </para> - - <itemizedlist> - <listitem> - <para> - End of support is planned for end of April 2019, handing over to 19.03. - </para> - </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. - </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>. - </para> - </listitem> - <listitem> - <para> - 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. - </para> - </listitem> - </itemizedlist> - - <para> - Notable changes and additions for 18.09 include: - </para> - - <itemizedlist> - <listitem> - <para> - Support for wrapping binaries using <literal>firejail</literal> has been - added through <varname>programs.firejail.wrappedBinaries</varname>. - </para> - <para> - For example - </para> -<programlisting> -programs.firejail = { - enable = true; - wrappedBinaries = { - firefox = "${lib.getBin pkgs.firefox}/bin/firefox"; - mpv = "${lib.getBin pkgs.mpv}/bin/mpv"; - }; -}; -</programlisting> - <para> - 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>. - </para> - <para> - For example - </para> -<programlisting> -$ nix-channel --add https://nixos.org/channels/nixpkgs-unstable nixpkgsunstable -$ nix-channel --update -$ nix-build '<nixpkgsunstable>' -A gitFull -$ nix run -f '<nixpkgsunstable>' gitFull -$ nix-instantiate -E '(import <nixpkgsunstable> {}).gitFull' -</programlisting> - </listitem> - </itemizedlist> - </section> - - <section xmlns="http://docbook.org/ns/docbook" - xmlns:xlink="http://www.w3.org/1999/xlink" - xmlns:xi="http://www.w3.org/2001/XInclude" - version="5.0" - xml:id="sec-release-18.09-new-services"> - <title>New Services</title> - - <para> - A curated selection of new services that were added since the last release: - </para> - - <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>. - </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. - </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. - </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. - </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>. - </para> - </listitem> - <listitem> - <para> - The new <varname>services.elasticsearch-curator</varname> service - periodically curates or manages, your Elasticsearch indices and snapshots. - </para> - </listitem> - </itemizedlist> - - <para> - Every new services: - </para> - - <itemizedlist> - <listitem> - <para> - <literal>./config/xdg/autostart.nix</literal> - </para> - </listitem> - <listitem> - <para> - <literal>./config/xdg/icons.nix</literal> - </para> - </listitem> - <listitem> - <para> - <literal>./config/xdg/menus.nix</literal> - </para> - </listitem> - <listitem> - <para> - <literal>./config/xdg/mime.nix</literal> - </para> - </listitem> - <listitem> - <para> - <literal>./hardware/brightnessctl.nix</literal> - </para> - </listitem> - <listitem> - <para> - <literal>./hardware/onlykey.nix</literal> - </para> - </listitem> - <listitem> - <para> - <literal>./hardware/video/uvcvideo/default.nix</literal> - </para> - </listitem> - <listitem> - <para> - <literal>./misc/documentation.nix</literal> - </para> - </listitem> - <listitem> - <para> - <literal>./programs/firejail.nix</literal> - </para> - </listitem> - <listitem> - <para> - <literal>./programs/iftop.nix</literal> - </para> - </listitem> - <listitem> - <para> - <literal>./programs/sedutil.nix</literal> - </para> - </listitem> - <listitem> - <para> - <literal>./programs/singularity.nix</literal> - </para> - </listitem> - <listitem> - <para> - <literal>./programs/xss-lock.nix</literal> - </para> - </listitem> - <listitem> - <para> - <literal>./programs/zsh/zsh-autosuggestions.nix</literal> - </para> - </listitem> - <listitem> - <para> - <literal>./services/admin/oxidized.nix</literal> - </para> - </listitem> - <listitem> - <para> - <literal>./services/backup/duplicati.nix</literal> - </para> - </listitem> - <listitem> - <para> - <literal>./services/backup/restic.nix</literal> - </para> - </listitem> - <listitem> - <para> - <literal>./services/backup/restic-rest-server.nix</literal> - </para> - </listitem> - <listitem> - <para> - <literal>./services/cluster/hadoop/default.nix</literal> - </para> - </listitem> - <listitem> - <para> - <literal>./services/databases/aerospike.nix</literal> - </para> - </listitem> - <listitem> - <para> - <literal>./services/databases/monetdb.nix</literal> - </para> - </listitem> - <listitem> - <para> - <literal>./services/desktops/bamf.nix</literal> - </para> - </listitem> - <listitem> - <para> - <literal>./services/desktops/flatpak.nix</literal> - </para> - </listitem> - <listitem> - <para> - <literal>./services/desktops/zeitgeist.nix</literal> - </para> - </listitem> - <listitem> - <para> - <literal>./services/development/bloop.nix</literal> - </para> - </listitem> - <listitem> - <para> - <literal>./services/development/jupyter/default.nix</literal> - </para> - </listitem> - <listitem> - <para> - <literal>./services/hardware/lcd.nix</literal> - </para> - </listitem> - <listitem> - <para> - <literal>./services/hardware/undervolt.nix</literal> - </para> - </listitem> - <listitem> - <para> - <literal>./services/misc/clipmenu.nix</literal> - </para> - </listitem> - <listitem> - <para> - <literal>./services/misc/gitweb.nix</literal> - </para> - </listitem> - <listitem> - <para> - <literal>./services/misc/serviio.nix</literal> - </para> - </listitem> - <listitem> - <para> - <literal>./services/misc/safeeyes.nix</literal> - </para> - </listitem> - <listitem> - <para> - <literal>./services/misc/sysprof.nix</literal> - </para> - </listitem> - <listitem> - <para> - <literal>./services/misc/weechat.nix</literal> - </para> - </listitem> - <listitem> - <para> - <literal>./services/monitoring/datadog-agent.nix</literal> - </para> - </listitem> - <listitem> - <para> - <literal>./services/monitoring/incron.nix</literal> - </para> - </listitem> - <listitem> - <para> - <literal>./services/networking/dnsdist.nix</literal> - </para> - </listitem> - <listitem> - <para> - <literal>./services/networking/freeradius.nix</literal> - </para> - </listitem> - <listitem> - <para> - <literal>./services/networking/hans.nix</literal> - </para> - </listitem> - <listitem> - <para> - <literal>./services/networking/morty.nix</literal> - </para> - </listitem> - <listitem> - <para> - <literal>./services/networking/ndppd.nix</literal> - </para> - </listitem> - <listitem> - <para> - <literal>./services/networking/ocserv.nix</literal> - </para> - </listitem> - <listitem> - <para> - <literal>./services/networking/owamp.nix</literal> - </para> - </listitem> - <listitem> - <para> - <literal>./services/networking/quagga.nix</literal> - </para> - </listitem> - <listitem> - <para> - <literal>./services/networking/shadowsocks.nix</literal> - </para> - </listitem> - <listitem> - <para> - <literal>./services/networking/stubby.nix</literal> - </para> - </listitem> - <listitem> - <para> - <literal>./services/networking/zeronet.nix</literal> - </para> - </listitem> - <listitem> - <para> - <literal>./services/security/certmgr.nix</literal> - </para> - </listitem> - <listitem> - <para> - <literal>./services/security/cfssl.nix</literal> - </para> - </listitem> - <listitem> - <para> - <literal>./services/security/oauth2_proxy_nginx.nix</literal> - </para> - </listitem> - <listitem> - <para> - <literal>./services/web-apps/virtlyst.nix</literal> - </para> - </listitem> - <listitem> - <para> - <literal>./services/web-apps/youtrack.nix</literal> - </para> - </listitem> - <listitem> - <para> - <literal>./services/web-servers/hitch/default.nix</literal> - </para> - </listitem> - <listitem> - <para> - <literal>./services/web-servers/hydron.nix</literal> - </para> - </listitem> - <listitem> - <para> - <literal>./services/web-servers/meguca.nix</literal> - </para> - </listitem> - <listitem> - <para> - <literal>./services/web-servers/nginx/gitweb.nix</literal> - </para> - </listitem> - <listitem> - <para> - <literal>./virtualisation/kvmgt.nix</literal> - </para> - </listitem> - <listitem> - <para> - <literal>./virtualisation/qemu-guest-agent.nix</literal> - </para> - </listitem> - </itemizedlist> - </section> - - <section xmlns="http://docbook.org/ns/docbook" - xmlns:xlink="http://www.w3.org/1999/xlink" - xmlns:xi="http://www.w3.org/2001/XInclude" - version="5.0" - xml:id="sec-release-18.09-incompatibilities"> - <title>Backward Incompatibilities</title> - - <para> - 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: - <itemizedlist> - <listitem> - <para> - 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 - </para> - </listitem> - <listitem> - <para> - 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 - </para> - </listitem> - <listitem> - <para> - cc-by-nd-30: Creative Commons Attribution-No Derivative Works v3.00 - </para> - </listitem> - <listitem> - <para> - msrla: Microsoft Research License Agreement - </para> - </listitem> - </itemizedlist> - </para> - </listitem> - <listitem> - <para> - 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. - </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. - </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. - </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>. - </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>. - </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. - </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. - </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>. - </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> - </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. - </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>. - </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. - </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. - </para> - </listitem> - <listitem> - <para> - Groups <literal>kvm</literal> and <literal>render</literal> are introduced - now, as systemd requires them. - </para> - </listitem> - </itemizedlist> - </section> - - <section xmlns="http://docbook.org/ns/docbook" - xmlns:xlink="http://www.w3.org/1999/xlink" - xmlns:xi="http://www.w3.org/2001/XInclude" - version="5.0" - xml:id="sec-release-18.09-notable-changes"> - <title>Other Notable Changes</title> - - <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. - </para> - </listitem> - <listitem> - <para> - <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. - </para> - </listitem> - <listitem> - <para> - <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. - </para> - </listitem> - <listitem> - <para> - <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>. - </para> - </listitem> - <listitem> - <para> - 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. - </para> - </listitem> - <listitem> - <para> - <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. - </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. - </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. - </para> - </listitem> - <listitem> - <para> - The module for <option>security.dhparams</option> has two new options now: - </para> - <variablelist> - <varlistentry> - <term> - <option>security.dhparams.stateless</option> - </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>. - </para> - </listitem> - </varlistentry> - <varlistentry> - <term> - <option>security.dhparams.defaultBitSize</option> - </term> - <listitem> - <para> - 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>. - </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). - </para> - <para> - An example usage of this would be: -<programlisting> -{ config, ... }: - -{ - security.dhparams.params.myservice = {}; - environment.etc."myservice.conf".text = '' - dhparams = ${config.security.dhparams.params.myservice.path} - ''; -} -</programlisting> - </para> - </note> - </listitem> - <listitem> - <para> - <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. - </para> - </listitem> - <listitem> - <para> - 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. - </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. - </para> - </listitem> - <listitem> - <para> - 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>. - </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> - </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>. - </para> - </listitem> - <listitem> - <para> - 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. - </para> - </listitem> - <listitem> - <para> - 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. - </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>. - </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. - </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>. - </para> - </listitem> - </itemizedlist> - </section> -</section> diff --git a/nixos/doc/manual/release-notes/rl-1903.section.md b/nixos/doc/manual/release-notes/rl-1903.section.md new file mode 100644 index 00000000000..7637a70c1bf --- /dev/null +++ b/nixos/doc/manual/release-notes/rl-1903.section.md @@ -0,0 +1,214 @@ +# Release 19.03 ("Koi", 2019/04/11) {#sec-release-19.03} + +## Highlights {#sec-release-19.03-highlights} + +In addition to numerous new and upgraded packages, this release has the following highlights: + +- End of support is planned for end of October 2019, handing over to 19.09. + +- The default Python 3 interpreter is now CPython 3.7 instead of CPython 3.6. + +- Added the Pantheon desktop environment. It can be enabled through `services.xserver.desktopManager.pantheon.enable`. + + ::: {.note} + By default, `services.xserver.desktopManager.pantheon` enables LightDM as a display manager, as pantheon\'s screen locking implementation relies on it. + Because of that it is recommended to leave LightDM enabled. If you\'d like to disable it anyway, set `services.xserver.displayManager.lightdm.enable` to `false` and enable your preferred display manager. + ::: + + 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. + +- 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: [](#sec-kubernetes) for details. + +- There is now a set of `confinement` options for `systemd.services`, which allows to restrict services into a chroot 2 ed environment that only contains the store paths from the runtime closure of the service. + +## New Services {#sec-release-19.03-new-services} + +The following new services were added since the last release: + +- `./programs/nm-applet.nix` + +- There is a new `security.googleOsLogin` module for using [OS Login](https://cloud.google.com/compute/docs/instances/managing-instance-access) to manage SSH access to Google Compute Engine instances, which supersedes the imperative and broken `google-accounts-daemon` used in `nixos/modules/virtualisation/google-compute-config.nix`. + +- `./services/misc/beanstalkd.nix` + +- There is a new `services.cockroachdb` module for running CockroachDB databases. NixOS now ships with CockroachDB 2.1.x as well, available on `x86_64-linux` and `aarch64-linux`. + +- `./security/duosec.nix` + +- The [PAM module for Duo Security](https://duo.com/docs/duounix) has been enabled for use. One can configure it using the `security.duosec` options along with the corresponding PAM option in `security.pam.services.<name?>.duoSecurity.enable`. + +## Backward Incompatibilities {#sec-release-19.03-incompatibilities} + +When upgrading from a previous release, please be aware of the following incompatible changes: + +- The minimum version of Nix required to evaluate Nixpkgs is now 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 `nix.package = pkgs.nix1;`. 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 17.09, you will first need to upgrade Nix by setting `nix.package = pkgs.nixStable2;` and run `nixos-rebuild switch` as the `root` user. + + - For users of a daemon-less Nix installation on Linux or macOS, you can upgrade Nix by running `curl -L https://nixos.org/nix/install | sh`, or prior to doing a channel update, running `nix-env -iA 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. + + - For users of the Nix daemon on macOS, you can upgrade Nix by running `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`. + +- The `buildPythonPackage` function now sets `strictDeps = true` 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 `buildPythonPackage` function now sets `LANG = C.UTF-8` to enable Unicode support. The `glibcLocales` package is no longer needed as a build input. + +- The Syncthing state and configuration data has been moved from `services.syncthing.dataDir` to the newly defined `services.syncthing.configDir`, which default to `/var/lib/syncthing/.config/syncthing`. This change makes possible to share synced directories using ACLs without Syncthing resetting the permission on every start. + +- The `ntp` 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 `services.ntp.restrictDefault` and `services.ntp.restrictSource` to `[]`. + +- Package `rabbitmq_server` is renamed to `rabbitmq-server`. + +- The `light` module no longer uses setuid binaries, but udev rules. As a consequence users of that module have to belong to the `video` group in order to use the executable (i.e. `users.users.yourusername.extraGroups = ["video"];`). + +- Buildbot now supports Python 3 and its packages have been moved to `pythonPackages`. The options `services.buildbot-master.package` and `services.buildbot-worker.package` can be used to select the Python 2 or 3 version of the package. + +- Options `services.znc.confOptions.networks.name.userName` and `services.znc.confOptions.networks.name.modulePackages` were removed. They were never used for anything and can therefore safely be removed. + +- Package `wasm` has been renamed `proglodyte-wasm`. The package `wasm` will be pointed to `ocamlPackages.wasm` in 19.09, so make sure to update your configuration if you want to keep `proglodyte-wasm` + +- When the `nixpkgs.pkgs` option is set, NixOS will no longer ignore the `nixpkgs.overlays` option. The old behavior can be recovered by setting `nixpkgs.overlays = lib.mkForce [];`. + +- OpenSMTPD has been upgraded to version 6.4.0p1. This release makes backwards-incompatible changes to the configuration file format. See `man smtpd.conf` for more information on the new file format. + +- The versioned `postgresql` have been renamed to use underscore number seperators. For example, `postgresql96` has been renamed to `postgresql_9_6`. + +- Package `consul-ui` and passthrough `consul.ui` have been removed. The package `consul` now uses upstream releases that vendor the UI into the binary. See [\#48714](https://github.com/NixOS/nixpkgs/pull/48714#issuecomment-433454834) for details. + +- Slurm introduces the new option `services.slurm.stateSaveLocation`, which is now set to `/var/spool/slurm` by default (instead of `/var/spool`). Make sure to move all files to the new directory or to set the option accordingly. + + The slurmctld now runs as user `slurm` instead of `root`. If you want to keep slurmctld running as `root`, set `services.slurm.user = root`. + + The options `services.slurm.nodeName` and `services.slurm.partitionName` are now sets of strings to correctly reflect that fact that each of these options can occour more than once in the configuration. + +- The `solr` package has been upgraded from 4.10.3 to 7.5.0 and has undergone some major changes. The `services.solr` module has been updated to reflect these changes. Please review http://lucene.apache.org/solr/ carefully before upgrading. + +- Package `ckb` is renamed to `ckb-next`, and options `hardware.ckb.*` are renamed to `hardware.ckb-next.*`. + +- The option `services.xserver.displayManager.job.logToFile` which was previously set to `true` when using the display managers `lightdm`, `sddm` or `xpra` has been reset to the default value (`false`). + +- Network interface indiscriminate NixOS firewall options (`networking.firewall.allow*`) are now preserved when also setting interface specific rules such as `networking.firewall.interfaces.en0.allow*`. These rules continue to use the pseudo device \"default\" (`networking.firewall.interfaces.default.*`), and assigning to this pseudo device will override the (`networking.firewall.allow*`) options. + +- The `nscd` service now disables all caching of `passwd` and `group` databases by default. This was interferring with the correct functioning of the `libnss_systemd.so` module which is used by `systemd` to manage uids and usernames in the presence of `DynamicUser=` in systemd services. This was already the default behaviour in presence of `services.sssd.enable = true` because nscd caching would interfere with `sssd` 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. + + If the old behaviour is desired, this can be restored by setting the `services.nscd.config` option with the desired caching parameters. + + ```nix + { + services.nscd.config = + '' + server-user nscd + threads 1 + paranoia no + debug-level 0 + + enable-cache passwd yes + positive-time-to-live passwd 600 + negative-time-to-live passwd 20 + suggested-size passwd 211 + check-files passwd yes + persistent passwd no + shared passwd yes + + enable-cache group yes + positive-time-to-live group 3600 + negative-time-to-live group 60 + suggested-size group 211 + check-files group yes + persistent group no + shared group yes + + enable-cache hosts yes + positive-time-to-live hosts 600 + negative-time-to-live hosts 5 + suggested-size hosts 211 + check-files hosts yes + persistent hosts no + shared hosts yes + ''; + } + ``` + + See [\#50316](https://github.com/NixOS/nixpkgs/pull/50316) for details. + +- GitLab Shell previously used the nix store paths for the `gitlab-shell` command in its `authorized_keys` file, which might stop working after garbage collection. To circumvent that, we regenerated that file on each startup. As `gitlab-shell` has now been changed to use `/var/run/current-system/sw/bin/gitlab-shell`, this is not necessary anymore, but there might be leftover lines with a nix store path. Regenerate the `authorized_keys` file via `sudo -u git -H gitlab-rake gitlab:shell:setup` in that case. + +- The `pam_unix` account module is now loaded with its control field set to `required` instead of `sufficient`, 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 `pam_unix`. 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 `security.pam.services.<name?>.text`. + +- The `pam_unix` password module is now loaded with its control field set to `sufficient` instead of `required`, 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 `pam_unix`, preventing `pam_ldap` to manage the password as it should. + +- `fish` has been upgraded to 3.0. It comes with a number of improvements and backwards incompatible changes. See the `fish` [release notes](https://github.com/fish-shell/fish-shell/releases/tag/3.0.0) for more information. + +- The ibus-table input method has had a change in config format, which causes all previous settings to be lost. See [this commit message](https://github.com/mike-fabian/ibus-table/commit/f9195f877c5212fef0dfa446acb328c45ba5852b) for details. + +- NixOS module system type `types.optionSet` and `lib.mkOption` argument `options` are deprecated. Use `types.submodule` instead. ([\#54637](https://github.com/NixOS/nixpkgs/pull/54637)) + +- `matrix-synapse` has been updated to version 0.99. It will [no longer generate a self-signed certificate on first launch](https://github.com/matrix-org/synapse/pull/4509) and will be [the last version to accept self-signed certificates](https://matrix.org/blog/2019/02/05/synapse-0-99-0/). As such, it is now recommended to use a proper certificate verified by a root CA (for example Let\'s Encrypt). The new [manual chapter on Matrix](#module-services-matrix) contains a working example of using nginx as a reverse proxy in front of `matrix-synapse`, using Let\'s Encrypt certificates. + +- `mailutils` now works by default when `sendmail` is not in a setuid wrapper. As a consequence, the `sendmailPath` argument, having lost its main use, has been removed. + +- `graylog` 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 [Upgrading Graylog](http://docs.graylog.org/en/3.0/pages/upgrade/graylog-3.0.html#simplified-http-interface-configuration) for details. + +- The option `users.ldap.bind.password` was renamed to `users.ldap.bind.passwordFile`, and needs to be readable by the `nslcd` user. Same applies to the new `users.ldap.daemon.rootpwmodpwFile` option. + +- `nodejs-6_x` is end-of-life. `nodejs-6_x`, `nodejs-slim-6_x` and `nodePackages_6_x` are removed. + +## Other Notable Changes {#sec-release-19.03-notable-changes} + +- The `services.matomo` module gained the option `services.matomo.package` which determines the used Matomo version. + + The Matomo module now also comes with the systemd service `matomo-archive-processing.service` and a timer that automatically triggers archive processing every hour. This means that you can safely [ disable browser triggers for Matomo archiving ](https://matomo.org/docs/setup-auto-archiving/#disable-browser-triggers-for-matomo-archiving-and-limit-matomo-reports-to-updating-every-hour) at `Administration > System > General Settings`. + + Additionally, you can enable to [ delete old visitor logs ](https://matomo.org/docs/privacy/#step-2-delete-old-visitors-logs) at `Administration > System > Privacy`, but make sure that you run `systemctl start matomo-archive-processing.service` at least once without errors if you have already collected data before, so that the reports get archived before the source data gets deleted. + +- `composableDerivation` along with supporting library functions has been removed. + +- The deprecated `truecrypt` package has been removed and `truecrypt` attribute is now an alias for `veracrypt`. VeraCrypt is backward-compatible with TrueCrypt volumes. Note that `cryptsetup` also supports loading TrueCrypt volumes. + +- 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 [Kubernetes v1.11](https://github.com/kubernetes/kubernetes/blob/master/CHANGELOG-1.11.md#sig-cluster-lifecycle). 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: `services.kubernetes.addons.dns.replicas`. + +- The quassel-webserver package and module was removed from nixpkgs due to the lack of maintainers. + +- The manual gained a [ new chapter on self-hosting `matrix-synapse` and `riot-web` ](#module-services-matrix), the most prevalent server and client implementations for the [Matrix](https://matrix.org/) federated communication network. + +- The astah-community package was removed from nixpkgs due to it being discontinued and the downloads not being available anymore. + +- The httpd service now saves log files with a .log file extension by default for easier integration with the logrotate service. + +- The owncloud server packages and httpd subservice module were removed from nixpkgs due to the lack of maintainers. + +- 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 `zramSwap.swapDevices` explicitly. + + ZRAM algorithm can be changed now. + + Changes to ZRAM algorithm are applied during `nixos-rebuild switch`, so make sure you have enough swap space on disk to survive ZRAM device rebuild. Alternatively, use `nixos-rebuild boot; reboot`. + +- Flat volumes are now disabled by default in `hardware.pulseaudio`. 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. + + ::: {.note} + 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. + ::: + +- The [`ndppd`](https://github.com/DanielAdolfsson/ndppd) module now supports [all config options](options.html#opt-services.ndppd.enable) provided by the current upstream version as service options. Additionally the `ndppd` package doesn\'t contain the systemd unit configuration from upstream anymore, the unit is completely configured by the NixOS module now. + +- New installs of NixOS will default to the Redmine 4.x series unless otherwise specified in `services.redmine.package` while existing installs of NixOS will default to the Redmine 3.x series. + +- The [Grafana module](options.html#opt-services.grafana.enable) now supports declarative [datasource and dashboard](http://docs.grafana.org/administration/provisioning/) provisioning. + +- The use of insecure ports on kubernetes has been deprecated. Thus options: `services.kubernetes.apiserver.port` and `services.kubernetes.controllerManager.port` has been renamed to `.insecurePort`, and default of both options has changed to 0 (disabled). + +- Note that the default value of `services.kubernetes.apiserver.bindAddress` 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: `services.kubernetes.apiserver.insecurebindAddress`. + +- The option `services.kubernetes.apiserver.allowPrivileged` and `services.kubernetes.kubelet.allowPrivileged` now defaults to false. Disallowing privileged containers on the cluster. + +- The kubernetes module does no longer add the kubernetes package to `environment.systemPackages` implicitly. + +- The `intel` driver has been removed from the default list of [X.org video drivers](options.html#opt-services.xserver.videoDrivers). The `modesetting` 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 `xrandr`. 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 `modesetting` driver, too). Kernel mode setting API does not support backlight control, so `xbacklight` tool will not work; backlight level can be controlled directly via `/sys/` or with `brightnessctl`. 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) + +- 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 [here](https://www.open-mpi.org/faq/?category=mpi-removed). + + 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 [services.nginx.sslProtocols](options.html#opt-services.nginx.sslProtocols). + +- A new subcommand `nixos-rebuild edit` was added. diff --git a/nixos/doc/manual/release-notes/rl-1903.xml b/nixos/doc/manual/release-notes/rl-1903.xml deleted file mode 100644 index 5593cb3e5df..00000000000 --- a/nixos/doc/manual/release-notes/rl-1903.xml +++ /dev/null @@ -1,768 +0,0 @@ -<section xmlns="http://docbook.org/ns/docbook" - xmlns:xlink="http://www.w3.org/1999/xlink" - xmlns:xi="http://www.w3.org/2001/XInclude" - version="5.0" - xml:id="sec-release-19.03"> - <title>Release 19.03 (“Koi”, 2019/04/11)</title> - - <section xmlns="http://docbook.org/ns/docbook" - xmlns:xlink="http://www.w3.org/1999/xlink" - xmlns:xi="http://www.w3.org/2001/XInclude" - version="5.0" - xml:id="sec-release-19.03-highlights"> - <title>Highlights</title> - - <para> - In addition to numerous new and upgraded packages, this release has the - following highlights: - </para> - - <itemizedlist> - <listitem> - <para> - End of support is planned for end of October 2019, handing over to 19.09. - </para> - </listitem> - <listitem> - <para> - 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>. - </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. - </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. - </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. - </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. - </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> - </listitem> - </itemizedlist> - </section> - - <section xmlns="http://docbook.org/ns/docbook" - xmlns:xlink="http://www.w3.org/1999/xlink" - xmlns:xi="http://www.w3.org/2001/XInclude" - version="5.0" - xml:id="sec-release-19.03-new-services"> - <title>New Services</title> - - <para> - The following new services were added since the last release: - </para> - - <itemizedlist> - <listitem> - <para> - <literal>./programs/nm-applet.nix</literal> - </para> - </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>. - </para> - </listitem> - <listitem> - <para> - <literal>./services/misc/beanstalkd.nix</literal> - </para> - </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>. - </para> - </listitem> - </itemizedlist> - - <itemizedlist> - <listitem> - <para> - <literal>./security/duosec.nix</literal> - </para> - </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>. - </para> - </listitem> - </itemizedlist> - </section> - - <section xmlns="http://docbook.org/ns/docbook" - xmlns:xlink="http://www.w3.org/1999/xlink" - xmlns:xi="http://www.w3.org/2001/XInclude" - version="5.0" - xml:id="sec-release-19.03-incompatibilities"> - <title>Backward Incompatibilities</title> - - <para> - When upgrading from a previous release, please be aware of the following - incompatible changes: - </para> - - <itemizedlist> - <listitem> - <para> - The minimum version of Nix required to evaluate Nixpkgs is now 2.0. - </para> - <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. - </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. - </para> - </listitem> - <listitem> - <para> - For users of a daemon-less Nix installation on Linux or macOS, you can - upgrade Nix by running <command>curl -L 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. - </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>. - </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. - </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. - </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. - </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>. - </para> - </listitem> - <listitem> - <para> - 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>). - </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. - </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. - </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> - </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>. - </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. - </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>. - </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. - </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. - </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>. - </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. - </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. - </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>. - </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>). - </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. - </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. - </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. -<programlisting> - services.nscd.config = - '' - server-user nscd - threads 1 - paranoia no - debug-level 0 - - enable-cache passwd yes - positive-time-to-live passwd 600 - negative-time-to-live passwd 20 - suggested-size passwd 211 - check-files passwd yes - persistent passwd no - shared passwd yes - - enable-cache group yes - positive-time-to-live group 3600 - negative-time-to-live group 60 - suggested-size group 211 - check-files group yes - persistent group no - shared group yes - - enable-cache hosts yes - positive-time-to-live hosts 600 - negative-time-to-live hosts 5 - suggested-size hosts 211 - check-files hosts yes - persistent hosts no - shared hosts yes - ''; - </programlisting> - 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. - </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> -<![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. - </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. - </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. - </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>) - </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. - </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. - </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. - </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. - </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> - </listitem> - </itemizedlist> - </section> - - <section xmlns="http://docbook.org/ns/docbook" - xmlns:xlink="http://www.w3.org/1999/xlink" - xmlns:xi="http://www.w3.org/2001/XInclude" - version="5.0" - xml:id="sec-release-19.03-notable-changes"> - <title>Other Notable Changes</title> - - <itemizedlist> - <listitem> - <para> - 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>. - </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. - </para> - </listitem> - <listitem> - <para> - <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. - </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>. - </para> - </listitem> - <listitem> - <para> - 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. - </para> - </listitem> - <listitem> - <para> - 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. - </para> - </listitem> - <listitem> - <para> - 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. - </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>. - </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. - </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. - </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. - </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. - </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. - </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). - </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>. - </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. - </para> - </listitem> - <listitem> - <para> - 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) - </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>. - </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"/>. - </para> - </listitem> - <listitem> - <para> - A new subcommand <command>nixos-rebuild edit</command> was added. - </para> - </listitem> - </itemizedlist> - </section> -</section> diff --git a/nixos/doc/manual/release-notes/rl-1909.section.md b/nixos/doc/manual/release-notes/rl-1909.section.md new file mode 100644 index 00000000000..572f1bf5a25 --- /dev/null +++ b/nixos/doc/manual/release-notes/rl-1909.section.md @@ -0,0 +1,313 @@ +# Release 19.09 ("Loris", 2019/10/09) {#sec-release-19.09} + +## Highlights {#sec-release-19.09-highlights} + +In addition to numerous new and upgraded packages, this release has the following highlights: + +- End of support is planned for end of April 2020, handing over to 20.03. + +- Nix has been updated to 2.3; see its [release notes](https://nixos.org/nix/manual/#ssec-relnotes-2.3). + +- Core version changes: + + systemd: 239 -\> 243 + + gcc: 7 -\> 8 + + glibc: 2.27 (unchanged) + + linux: 4.19 LTS (unchanged) + + openssl: 1.0 -\> 1.1 + +- Desktop version changes: + + plasma5: 5.14 -\> 5.16 + + gnome3: 3.30 -\> 3.32 + +- PHP now defaults to PHP 7.3, updated from 7.2. + +- PHP 7.1 is no longer supported due to upstream not supporting this version for the entire lifecycle of the 19.09 release. + +- The binfmt module is now easier to use. Additional systems can be added through `boot.binfmt.emulatedSystems`. For instance, `boot.binfmt.emulatedSystems = [ "wasm32-wasi" "x86_64-windows" "aarch64-linux" ];` will set up binfmt interpreters for each of those listed systems. + +- The installer now uses a less privileged `nixos` user whereas before we logged in as root. To gain root privileges use `sudo -i` without a password. + +- We\'ve updated to Xfce 4.14, which brings a new module `services.xserver.desktopManager.xfce4-14`. If you\'d like to upgrade, please switch from the `services.xserver.desktopManager.xfce` module as it will be deprecated in a future release. They\'re incompatibilities with the current Xfce module; it doesn\'t support `thunarPlugins` and it isn\'t recommended to use `services.xserver.desktopManager.xfce` and `services.xserver.desktopManager.xfce4-14` simultaneously or to downgrade from Xfce 4.14 after upgrading. + +- The GNOME 3 desktop manager module sports an interface to enable/disable core services, applications, and optional GNOME packages like games. + + - `services.gnome3.core-os-services.enable` + + - `services.gnome3.core-shell.enable` + + - `services.gnome3.core-utilities.enable` + + - `services.gnome3.games.enable` + + 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 `environment.gnome3.excludePackages` which only excluded the optional applications. `environment.gnome3.excludePackages` is now unguarded, it can exclude any package installed with `environment.systemPackages` in the GNOME 3 module. + +- 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. + + **The following changes were enacted in `services.gnome3.core-utilities.enable`** + + - `accerciser` + + - `dconf-editor` + + - `evolution` + + - `gnome-documents` + + - `gnome-nettool` + + - `gnome-power-manager` + + - `gnome-todo` + + - `gnome-tweaks` + + - `gnome-usage` + + - `gucharmap` + + - `nautilus-sendto` + + - `vinagre` + + - `cheese` + + - `geary` + + **The following changes were enacted in `services.gnome3.core-shell.enable`** + + - `gnome-color-manager` + + - `orca` + + - `services.avahi.enable` + +## New Services {#sec-release-19.09-new-services} + +The following new services were added since the last release: + +- `./programs/dwm-status.nix` + +- The new `hardware.printers` module allows to declaratively configure CUPS printers via the `ensurePrinters` and `ensureDefaultPrinter` options. `ensurePrinters` will never delete existing printers, but will make sure that the given printers are configured as declared. + +- There is a new [services.system-config-printer.enable](options.html#opt-services.system-config-printer.enable) and [programs.system-config-printer.enable](options.html#opt-programs.system-config-printer.enable) module for the program of the same name. If you previously had `system-config-printer` enabled through some other means you should migrate to using one of these modules. + + - `services.xserver.desktopManager.plasma5` + + - `services.xserver.desktopManager.gnome3` + + - `services.xserver.desktopManager.pantheon` + + - `services.xserver.desktopManager.mate` Note Mate uses `programs.system-config-printer` as it doesn\'t use it as a service, but its graphical interface directly. + +- [services.blueman.enable](options.html#opt-services.blueman.enable) has been added. If you previously had blueman installed via `environment.systemPackages` please migrate to using the NixOS module, as this would result in an insufficiently configured blueman. + +## Backward Incompatibilities {#sec-release-19.09-incompatibilities} + +When upgrading from a previous release, please be aware of the following incompatible changes: + +- 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. + +- PostgreSQL now uses `/run/postgresql` as its socket directory instead of `/tmp`. 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 9.4 is scheduled EOL during the 19.09 life cycle and has been removed. + +- The options `services.prometheus.alertmanager.user` and `services.prometheus.alertmanager.group` have been removed because the alertmanager service is now using systemd\'s [ DynamicUser mechanism](http://0pointer.net/blog/dynamic-users-with-systemd.html) which obviates these options. + +- 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 `services.nzbget.configFile` and `services.nzbget.openFirewall` options were removed as they are managed internally by the nzbget. The `services.nzbget.dataDir` option hadn\'t actually been used by the module for some time and so was removed as cleanup. + +- The `services.mysql.pidDir` 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) `/run/mysqld/mysql.sock` file to appear. + +- The `services.emby.enable` module has been removed, see `services.jellyfin.enable` instead for a free software fork of Emby. See the Jellyfin documentation: [ Migrating from Emby to Jellyfin ](https://jellyfin.readthedocs.io/en/latest/administrator-docs/migrate-from-emby/) + +- IPv6 Privacy Extensions are now enabled by default for undeclared interfaces. The previous behaviour was quite misleading --- even though the default value for `networking.interfaces.*.preferTempAddress` was `true`, 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 `false` for the interface in question. + +- Since Bittorrent Sync was superseded by Resilio Sync in 2016, the `bittorrentSync`, `bittorrentSync14`, and `bittorrentSync16` packages have been removed in favor of `resilio-sync`. + + The corresponding module, `services.btsync` has been replaced by the `services.resilio` module. + +- 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: `systemd.services.httpd.after = [ "postgresql.service" ];` + + The option `services.httpd.extraSubservices` 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. + + 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 `services.limesurvey.enable`, `services.mediawiki.enable`, `services.wordpress.enable`, and `services.zabbixWeb.enable` options. + +- The option `systemd.network.networks.<name>.routes.*.routeConfig.GatewayOnlink` was renamed to `systemd.network.networks.<name>.routes.*.routeConfig.GatewayOnLink` (capital `L`). This follows [ upstreams renaming ](https://github.com/systemd/systemd/commit/9cb8c5593443d24c19e40bfd4fc06d672f8c554c) of the setting. + +- As of this release the NixOps feature `autoLuks` is deprecated. It no longer works with our systemd version without manual intervention. + + Whenever the usage of the module is detected the evaluation will fail with a message explaining why and how to deal with the situation. + + A new knob named `nixops.enableDeprecatedAutoLuks` 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. + + Make sure you set the `_netdev` 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. + + If you are actively using the `autoLuks` module please let us know in [issue \#62211](https://github.com/NixOS/nixpkgs/issues/62211). + +- The setopt declarations will be evaluated at the end of `/etc/zshrc`, so any code in [programs.zsh.interactiveShellInit](options.html#opt-programs.zsh.interactiveShellInit), [programs.zsh.loginShellInit](options.html#opt-programs.zsh.loginShellInit) and [programs.zsh.promptInit](options.html#opt-programs.zsh.promptInit) may break if it relies on those options being set. + +- The `prometheus-nginx-exporter` 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 [official repo](https://github.com/nginxinc/nginx-prometheus-exporter). + +- The `shibboleth-sp` package has been updated to version 3. It is largely backward compatible, for further information refer to the [release notes](https://wiki.shibboleth.net/confluence/display/SP3/ReleaseNotes) and [upgrade guide](https://wiki.shibboleth.net/confluence/display/SP3/UpgradingFromV2). + + Nodejs 8 is scheduled EOL under the lifetime of 19.09 and has been dropped. + +- By default, prometheus exporters are now run with `DynamicUser` enabled. Exporters that need a real user, now run under a seperate user and group which follow the pattern `<exporter-name>-exporter`, instead of the previous default `nobody` and `nogroup`. Only some exporters are affected by the latter, namely the exporters `dovecot`, `node`, `postfix` and `varnish`. + +- The `ibus-qt` package is not installed by default anymore when [i18n.inputMethod.enabled](options.html#opt-i18n.inputMethod.enabled) is set to `ibus`. If IBus support in Qt 4.x applications is required, add the `ibus-qt` package to your [environment.systemPackages](options.html#opt-environment.systemPackages) manually. + +- The CUPS Printing service now uses socket-based activation by default, only starting when needed. The previous behavior can be restored by setting `services.cups.startWhenNeeded` to `false`. + +- The `services.systemhealth` module has been removed from nixpkgs due to lack of maintainer. + +- The `services.mantisbt` module has been removed from nixpkgs due to lack of maintainer. + +- Squid 3 has been removed and the `squid` derivation now refers to Squid 4. + +- The `services.pdns-recursor.extraConfig` option has been replaced by `services.pdns-recursor.settings`. The new option allows setting extra configuration while being better type-checked and mergeable. + +- No service depends on `keys.target` anymore which is a systemd target that indicates if all [NixOps keys](https://nixos.org/nixops/manual/#idm140737322342384) were successfully uploaded. Instead, `<key-name>-key.service` should be used to define a dependency of a key in a service. The full issue behind the `keys.target` dependency is described at [NixOS/nixpkgs\#67265](https://github.com/NixOS/nixpkgs/issues/67265). + + The following services are affected by this: + + - [`services.dovecot2`](options.html#opt-services.dovecot2.enable) + + - [`services.nsd`](options.html#opt-services.nsd.enable) + + - [`services.softether`](options.html#opt-services.softether.enable) + + - [`services.strongswan`](options.html#opt-services.strongswan.enable) + + - [`services.strongswan-swanctl`](options.html#opt-services.strongswan-swanctl.enable) + + - [`services.httpd`](options.html#opt-services.httpd.enable) + +- The `security.acme.directory` option has been replaced by a read-only `security.acme.certs.<cert>.directory` option for each certificate you define. This will be a subdirectory of `/var/lib/acme`. You can use this read-only option to figure out where the certificates are stored for a specific certificate. For example, the `services.nginx.virtualhosts.<name>.enableACME` option will use this directory option to find the certs for the virtual host. + + `security.acme.preDelay` and `security.acme.activationDelay` options have been removed. To execute a service before certificates are provisioned or renewed add a `RequiredBy=acme-${cert}.service` to any service. + + Furthermore, the acme module will not automatically add a dependency on `lighttpd.service` anymore. If you are using certficates provided by letsencrypt for lighttpd, then you should depend on the certificate service `acme-${cert}.service>` manually. + + For nginx, the dependencies are still automatically managed when `services.nginx.virtualhosts.<name>.enableACME` 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 `acme-certificates.target`. 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 [NixOS/nixpkgs\#60180](https://github.com/NixOS/nixpkgs/issues/60180). + +- The old deprecated `emacs` package sets have been dropped. What used to be called `emacsPackagesNg` is now simply called `emacsPackages`. + +- `services.xserver.desktopManager.xterm` is now disabled by default if `stateVersion` 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. + +- The WeeChat plugin `pkgs.weechatScripts.weechat-xmpp` has been removed as it doesn\'t receive any updates from upstream and depends on outdated Python2-based modules. + +- Old unsupported versions (`logstash5`, `kibana5`, `filebeat5`, `heartbeat5`, `metricbeat5`, `packetbeat5`) of the ELK-stack and Elastic beats have been removed. + +- 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 `services.prometheus`. + +- Citrix Receiver (`citrix_receiver`) has been dropped in favor of Citrix Workspace (`citrix_workspace`). + +- The `services.gitlab` module has had its literal secret options (`services.gitlab.smtp.password`, `services.gitlab.databasePassword`, `services.gitlab.initialRootPassword`, `services.gitlab.secrets.secret`, `services.gitlab.secrets.db`, `services.gitlab.secrets.otp` and `services.gitlab.secrets.jws`) replaced by file-based versions (`services.gitlab.smtp.passwordFile`, `services.gitlab.databasePasswordFile`, `services.gitlab.initialRootPasswordFile`, `services.gitlab.secrets.secretFile`, `services.gitlab.secrets.dbFile`, `services.gitlab.secrets.otpFile` and `services.gitlab.secrets.jwsFile`). This was done so that secrets aren\'t stored in the world-readable nix store, but means that for each option you\'ll have to create a file with the same exact string, add \"File\" to the end of the option name, and change the definition to a string pointing to the corresponding file; e.g. `services.gitlab.databasePassword = "supersecurepassword"` becomes `services.gitlab.databasePasswordFile = "/path/to/secret_file"` where the file `secret_file` contains the string `supersecurepassword`. + + The state path (`services.gitlab.statePath`) now has the following restriction: no parent directory can be owned by any other user than `root` or the user specified in `services.gitlab.user`; i.e. if `services.gitlab.statePath` is set to `/var/lib/gitlab/state`, `gitlab` and all parent directories must be owned by either `root` or the user specified in `services.gitlab.user`. + +- The `networking.useDHCP` option is unsupported in combination with `networking.useNetworkd` in anticipation of defaulting to it. It has to be set to `false` and enabled per interface with `networking.interfaces.<name>.useDHCP = true;` + +- The Twitter client `corebird` has been dropped as [it is discontinued and does not work against the new Twitter API](https://www.patreon.com/posts/corebirds-future-18921328). Please use the fork `cawbird` instead which has been adapted to the API changes and is still maintained. + +- The `nodejs-11_x` package has been removed as it\'s EOLed by upstream. + +- Because of the systemd upgrade, systemd-timesyncd will no longer work if `system.stateVersion` is not set correctly. When upgrading from NixOS 19.03, please make sure that `system.stateVersion` is set to `"19.03"`, or lower if the installation dates back to an earlier version of NixOS. + +- Due to the short lifetime of non-LTS kernel releases package attributes like `linux_5_1`, `linux_5_2` and `linux_5_3` have been removed to discourage dependence on specific non-LTS kernel versions in stable NixOS releases. Going forward, versioned attributes like `linux_4_9` will exist for LTS versions only. Please use `linux_latest` or `linux_testing` if you depend on non-LTS releases. Keep in mind that `linux_latest` and `linux_testing` will change versions under the hood during the lifetime of a stable release and might include breaking changes. + +- Because of the systemd upgrade, some network interfaces might change their name. For details see [ upstream docs](https://www.freedesktop.org/software/systemd/man/systemd.net-naming-scheme.html#History) or [ our ticket](https://github.com/NixOS/nixpkgs/issues/71086). + +## Other Notable Changes {#sec-release-19.09-notable-changes} + +- The `documentation` module gained an option named `documentation.nixos.includeAllModules` which makes the generated configuration.nix 5 manual page include all options from all NixOS modules included in a given `configuration.nix` configuration file. Currently, it is set to `false` by default as enabling it frequently prevents evaluation. But the plan is to eventually have it set to `true` by default. Please set it to `true` now in your `configuration.nix` and fix all the bugs it uncovers. + +- The `vlc` package gained support for Chromecast streaming, enabled by default. TCP port 8010 must be open for it to work, so something like `networking.firewall.allowedTCPPorts = [ 8010 ];` may be required in your configuration. Also consider enabling [ Accelerated Video Playback](https://nixos.wiki/wiki/Accelerated_Video_Playback) for better transcoding performance. + +- The following changes apply if the `stateVersion` is changed to 19.09 or higher. For `stateVersion = "19.03"` or lower the old behavior is preserved. + + - `solr.package` defaults to `pkgs.solr_8`. + +- The `hunspellDicts.fr-any` dictionary now ships with `fr_FR.{aff,dic}` which is linked to `fr-toutesvariantes.{aff,dic}`. + +- The `mysql` service now runs as `mysql` user. Previously, systemd did execute it as root, and mysql dropped privileges itself. This includes `ExecStartPre=` and `ExecStartPost=` phases. To accomplish that, runtime and data directory setup was delegated to RuntimeDirectory and tmpfiles. + +- With the upgrade to systemd version 242 the `systemd-timesyncd` service is no longer using `DynamicUser=yes`. 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 `19.09`) was `/var/lib/private/systemd/timesync`. + + As long as the `system.config.stateVersion` is below `19.09` the state folder will migrated to its proper location (`/var/lib/systemd/timesync`), if required. + +- The package `avahi` is now built to look up service definitions from `/etc/avahi/services` instead of its output directory in the nix store. Accordingly the module `avahi` now supports custom service definitions via `services.avahi.extraServiceFiles`, which are then placed in the aforementioned directory. See avahi.service5 for more information on custom service definitions. + +- Since version 0.1.19, `cargo-vendor` honors package includes that are specified in the `Cargo.toml` file of Rust crates. `rustPlatform.buildRustPackage` uses `cargo-vendor` to collect and build dependent crates. Since this change in `cargo-vendor` changes the set of vendored files for most Rust packages, the hash that use used to verify the dependencies, `cargoSha256`, also changes. + + The `cargoSha256` hashes of all in-tree derivations that use `buildRustPackage` have been updated to reflect this change. However, third-party derivations that use `buildRustPackage` may have to be updated as well. + +- The `consul` package was upgraded past version `1.5`, so its deprecated legacy UI is no longer available. + +- The default resample-method for PulseAudio has been changed from the upstream default `speex-float-1` to `speex-float-5`. Be aware that low-powered ARM-based and MIPS-based boards will struggle with this so you\'ll need to set `hardware.pulseaudio.daemon.config.resample-method` back to `speex-float-1`. + +- The `phabricator` package and associated `httpd.extraSubservice`, as well as the `phd` service have been removed from nixpkgs due to lack of maintainer. + +- The `mercurial` `httpd.extraSubservice` has been removed from nixpkgs due to lack of maintainer. + +- The `trac` `httpd.extraSubservice` has been removed from nixpkgs because it was unmaintained. + +- The `foswiki` package and associated `httpd.extraSubservice` have been removed from nixpkgs due to lack of maintainer. + +- The `tomcat-connector` `httpd.extraSubservice` has been removed from nixpkgs. + +- It\'s now possible to change configuration in [services.nextcloud](options.html#opt-services.nextcloud.enable) 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 `/var/lib/nextcloud`. + +- There exists now `lib.forEach`, which is like `map`, but with arguments flipped. When mapping function body spans many lines (or has nested `map`s), it is often hard to follow which list is modified. + + Previous solution to this problem was either to use `lib.flip map` idiom or extract that anonymous mapping function to a named one. Both can still be used but `lib.forEach` is preferred over `lib.flip map`. + + The `/etc/sysctl.d/nixos.conf` file containing all the options set via [boot.kernel.sysctl](options.html#opt-boot.kernel.sysctl) was moved to `/etc/sysctl.d/60-nixos.conf`, as sysctl.d5 recommends prefixing all filenames in `/etc/sysctl.d` with a two-digit number and a dash to simplify the ordering of the files. + +- We now install the sysctl snippets shipped with systemd. + + - Loose reverse path filtering + + - Source route filtering + + - `fq_codel` as a packet scheduler (this helps to fight bufferbloat) + + This also configures the kernel to pass core dumps to `systemd-coredump`, and restricts the SysRq key combinations to the sync command only. These sysctl snippets can be found in `/etc/sysctl.d/50-*.conf`, and overridden via [boot.kernel.sysctl](options.html#opt-boot.kernel.sysctl) (which will place the parameters in `/etc/sysctl.d/60-nixos.conf`). + +- Core dumps are now processed by `systemd-coredump` by default. `systemd-coredump` behaviour can still be modified via `systemd.coredump.extraConfig`. To stick to the old behaviour (having the kernel dump to a file called `core` in the working directory), without piping it through `systemd-coredump`, set `systemd.coredump.enable` to `false`. + +- `systemd.packages` option now also supports generators and shutdown scripts. Old `systemd.generator-packages` option has been removed. + +- The `rmilter` package was removed with associated module and options due deprecation by upstream developer. Use `rspamd` in proxy mode instead. + +- systemd cgroup accounting via the [systemd.enableCgroupAccounting](options.html#opt-systemd.enableCgroupAccounting) option is now enabled by default. It now also enables the more recent Block IO and IP accounting features. + +- We no longer enable custom font rendering settings with `fonts.fontconfig.penultimate.enable` by default. The defaults from fontconfig are sufficient. + +- The `crashplan` package and the `crashplan` service have been removed from nixpkgs due to crashplan shutting down the service, while the `crashplansb` package and `crashplan-small-business` service have been removed from nixpkgs due to lack of maintainer. + + The [redis module](options.html#opt-services.redis.enable) was hardcoded to use the `redis` user, `/run/redis` as runtime directory and `/var/lib/redis` 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). + +- Using `fonts.enableDefaultFonts` adds a default emoji font `noto-fonts-emoji`. + + - `services.xserver.enable` + + - `programs.sway.enable` + + - `programs.way-cooler.enable` + + - `services.xrdp.enable` + +- The `altcoins` categorization of packages has been removed. You now access these packages at the top level, ie. `nix-shell -p dogecoin` instead of `nix-shell -p altcoins.dogecoin`, etc. + +- Ceph has been upgraded to v14.2.1. See the [release notes](https://ceph.com/releases/v14-2-0-nautilus-released/) 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. + +- `pkgs.weechat` is now compiled against `pkgs.python3`. Weechat also recommends [to use Python3 in their docs.](https://weechat.org/scripts/python3/) diff --git a/nixos/doc/manual/release-notes/rl-1909.xml b/nixos/doc/manual/release-notes/rl-1909.xml deleted file mode 100644 index 0dae49c636f..00000000000 --- a/nixos/doc/manual/release-notes/rl-1909.xml +++ /dev/null @@ -1,902 +0,0 @@ -<section xmlns="http://docbook.org/ns/docbook" - xmlns:xlink="http://www.w3.org/1999/xlink" - xmlns:xi="http://www.w3.org/2001/XInclude" - version="5.0" - xml:id="sec-release-19.09"> - <title>Release 19.09 (“Loris”, 2019/10/09)</title> - - <section xmlns="http://docbook.org/ns/docbook" - xmlns:xlink="http://www.w3.org/1999/xlink" - xmlns:xi="http://www.w3.org/2001/XInclude" - version="5.0" - xml:id="sec-release-19.09-highlights"> - <title>Highlights</title> - - <para> - In addition to numerous new and upgraded packages, this release has the - following highlights: - </para> - - <itemizedlist> - <listitem> - <para> - End of support is planned for end of April 2020, handing over to 20.03. - </para> - </listitem> - <listitem> - <para> - Nix has been updated to 2.3; see its - <link xlink:href="https://nixos.org/nix/manual/#ssec-relnotes-2.3">release - notes</link>. - </para> - </listitem> - <listitem> - <para>Core version changes:</para> - <para>systemd: 239 -> 243</para> - <para>gcc: 7 -> 8</para> - <para>glibc: 2.27 (unchanged)</para> - <para>linux: 4.19 LTS (unchanged)</para> - <para>openssl: 1.0 -> 1.1</para> - </listitem> - <listitem> - <para>Desktop version changes:</para> - <para>plasma5: 5.14 -> 5.16</para> - <para>gnome3: 3.30 -> 3.32</para> - </listitem> - <listitem> - <para> - PHP now defaults to PHP 7.3, updated from 7.2. - </para> - </listitem> - <listitem> - <para> - PHP 7.1 is no longer supported due to upstream not supporting this version for the entire lifecycle of the 19.09 release. - </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> - </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> - </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. - </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><option>services.gnome3.core-os-services.enable</option></para></listitem> - <listitem><para><option>services.gnome3.core-shell.enable</option></para></listitem> - <listitem><para><option>services.gnome3.core-utilities.enable</option></para></listitem> - <listitem><para><option>services.gnome3.games.enable</option></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. - </para> - - <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> - </itemizedlist> - <itemizedlist> - <title>Applications added to defaults:</title> - <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> - - <itemizedlist> - <title>Applications added to defaults:</title> - <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> - </itemizedlist> - </listitem> - </itemizedlist> - </section> - - <section xmlns="http://docbook.org/ns/docbook" - xmlns:xlink="http://www.w3.org/1999/xlink" - xmlns:xi="http://www.w3.org/2001/XInclude" - version="5.0" - xml:id="sec-release-19.09-new-services"> - <title>New Services</title> - - <para> - The following new services were added since the last release: - </para> - - <itemizedlist> - <listitem> - <para> - <literal>./programs/dwm-status.nix</literal> - </para> - </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. - </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. - </para> - <itemizedlist> - <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> - </listitem> - <listitem> - <para><option>services.xserver.desktopManager.gnome3</option></para> - </listitem> - <listitem> - <para><option>services.xserver.desktopManager.pantheon</option></para> - </listitem> - <listitem> - <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. - </para> - </listitem> - </itemizedlist> - </listitem> - <listitem> - <para> - <xref linkend="opt-services.blueman.enable"/> has been added. - If you previously had blueman installed via <option>environment.systemPackages</option> please - migrate to using the NixOS module, as this would result in an insufficiently configured blueman. - </para> - </listitem> - </itemizedlist> - - </section> - - <section xmlns="http://docbook.org/ns/docbook" - xmlns:xlink="http://www.w3.org/1999/xlink" - xmlns:xi="http://www.w3.org/2001/XInclude" - version="5.0" - xml:id="sec-release-19.09-incompatibilities"> - <title>Backward Incompatibilities</title> - - <para> - 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. - </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. - </para> - </listitem> - <listitem> - <para> - PostgreSQL 9.4 is scheduled EOL during the 19.09 life cycle and has been removed. - </para> - </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. - </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. - </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. - </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. - </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> - </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> - </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>. - </para> - <para> - 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> - </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. - </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. - </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. - </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. - </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. - </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. - </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. - </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>. - </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. - </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>. - </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. - </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> - </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> - </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> - </listitem> - <listitem> - <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> - </listitem> - <listitem> - <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> - </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>. - </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> - </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> - </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> - </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> - </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. - </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. - </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>. - </para> - </listitem> - <listitem> - <para> - Citrix Receiver (<literal>citrix_receiver</literal>) has been dropped in favor of Citrix Workspace - (<literal>citrix_workspace</literal>). - </para> - </listitem> - <listitem> - <para> - The <literal>services.gitlab</literal> module has had its literal secret options (<option>services.gitlab.smtp.password</option>, - <option>services.gitlab.databasePassword</option>, - <option>services.gitlab.initialRootPassword</option>, - <option>services.gitlab.secrets.secret</option>, - <option>services.gitlab.secrets.db</option>, - <option>services.gitlab.secrets.otp</option> and - <option>services.gitlab.secrets.jws</option>) replaced by file-based versions (<option>services.gitlab.smtp.passwordFile</option>, - <option>services.gitlab.databasePasswordFile</option>, - <option>services.gitlab.initialRootPasswordFile</option>, - <option>services.gitlab.secrets.secretFile</option>, - <option>services.gitlab.secrets.dbFile</option>, - <option>services.gitlab.secrets.otpFile</option> and - <option>services.gitlab.secrets.jwsFile</option>). This was done so that secrets aren't stored - in the world-readable nix store, but means that for each option you'll have to create a file with - the same exact string, add "File" to the end of the option name, and change the definition to a - string pointing to the corresponding file; e.g. <literal>services.gitlab.databasePassword = "supersecurepassword"</literal> - becomes <literal>services.gitlab.databasePasswordFile = "/path/to/secret_file"</literal> where the - file <literal>secret_file</literal> contains the string <literal>supersecurepassword</literal>. - </para> - <para> - The state path (<option>services.gitlab.statePath</option>) now has the following restriction: - no parent directory can be owned by any other user than <literal>root</literal> or the user - specified in <option>services.gitlab.user</option>; i.e. if <option>services.gitlab.statePath</option> - is set to <literal>/var/lib/gitlab/state</literal>, <literal>gitlab</literal> and all parent directories - must be owned by either <literal>root</literal> or the user specified in <option>services.gitlab.user</option>. - </para> - </listitem> - <listitem> - <para> - The <option>networking.useDHCP</option> option is unsupported in combination with - <option>networking.useNetworkd</option> in anticipation of defaulting to it. - It has to be set to <literal>false</literal> and enabled per - interface with <option>networking.interfaces.<name>.useDHCP = true;</option> - </para> - </listitem> - <listitem> - <para> - The Twitter client <literal>corebird</literal> has been dropped as <link xlink:href="https://www.patreon.com/posts/corebirds-future-18921328">it is discontinued and does not work against the new Twitter API</link>. - Please use the fork <literal>cawbird</literal> instead which has been adapted to the API changes and is still maintained. - </para> - </listitem> - <listitem> - <para> - The <literal>nodejs-11_x</literal> package has been removed as it's EOLed by upstream. - </para> - </listitem> - <listitem> - <para> - Because of the systemd upgrade, - <application>systemd-timesyncd</application> will no longer work if - <option>system.stateVersion</option> is not set correctly. When - upgrading from NixOS 19.03, please make sure that - <option>system.stateVersion</option> is set to - <literal>"19.03"</literal>, or lower if the installation dates back to an - earlier version of NixOS. - </para> - </listitem> - <listitem> - <para> - Due to the short lifetime of non-LTS kernel releases package attributes like <literal>linux_5_1</literal>, - <literal>linux_5_2</literal> and <literal>linux_5_3</literal> have been removed to discourage dependence - on specific non-LTS kernel versions in stable NixOS releases. - - Going forward, versioned attributes like <literal>linux_4_9</literal> will exist for LTS versions only. - Please use <literal>linux_latest</literal> or <literal>linux_testing</literal> if you depend on non-LTS - releases. Keep in mind that <literal>linux_latest</literal> and <literal>linux_testing</literal> will - change versions under the hood during the lifetime of a stable release and might include breaking changes. - </para> - </listitem> - <listitem> - <para> - Because of the systemd upgrade, - some network interfaces might change their name. For details see - <link xlink:href="https://www.freedesktop.org/software/systemd/man/systemd.net-naming-scheme.html#History"> - upstream docs</link> or <link xlink:href="https://github.com/NixOS/nixpkgs/issues/71086"> - our ticket</link>. - </para> - </listitem> - </itemizedlist> - </section> - - <section xmlns="http://docbook.org/ns/docbook" - xmlns:xlink="http://www.w3.org/1999/xlink" - xmlns:xi="http://www.w3.org/2001/XInclude" - version="5.0" - xml:id="sec-release-19.09-notable-changes"> - <title>Other Notable Changes</title> - - <itemizedlist> - <listitem> - <para> - 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. - </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. - </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. - </para> - <itemizedlist> - <listitem> - <para> - <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>. - </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. - </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>. - </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. - </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. - </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. - </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. - </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. - </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>. - </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. - </para> - </listitem> - <listitem> - <para> - The <literal>mercurial</literal> <literal>httpd.extraSubservice</literal> has been removed from nixpkgs due to lack of maintainer. - </para> - </listitem> - <listitem> - <para> - The <literal>trac</literal> <literal>httpd.extraSubservice</literal> has been removed from nixpkgs because it was unmaintained. - </para> - </listitem> - <listitem> - <para> - The <literal>foswiki</literal> package and associated <literal>httpd.extraSubservice</literal> have been removed - from nixpkgs due to lack of maintainer. - </para> - </listitem> - <listitem> - <para> - The <literal>tomcat-connector</literal> <literal>httpd.extraSubservice</literal> has been removed from nixpkgs. - </para> - </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>. - </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. - </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>. - </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. - </para> - </listitem> - <listitem> - <para> - 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> - <literal>fq_codel</literal> as a packet scheduler (this helps to fight bufferbloat) - </para> - </listitem> - </itemizedlist> - This also configures the kernel to pass core dumps 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> - Core dumps are now processed 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>systemd.coredump.enable</option> to - <literal>false</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. - </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. - </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. - </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. - </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. - </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). - </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> - <listitem> - <para><option>services.xserver.enable</option></para> - </listitem> - <listitem> - <para><option>programs.sway.enable</option></para> - </listitem> - <listitem> - <para><option>programs.way-cooler.enable</option></para> - </listitem> - <listitem> - <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> - </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.section.md b/nixos/doc/manual/release-notes/rl-2003.section.md new file mode 100644 index 00000000000..b92c7f6634c --- /dev/null +++ b/nixos/doc/manual/release-notes/rl-2003.section.md @@ -0,0 +1,507 @@ +# Release 20.03 ("Markhor", 2020.04/20) {#sec-release-20.03} + +## Highlights {#sec-release-20.03-highlights} + +In addition to numerous new and upgraded packages, this release has the following highlights: + +- Support is planned until the end of October 2020, handing over to 20.09. + +- Core version changes: + + gcc: 8.3.0 -\> 9.2.0 + + glibc: 2.27 -\> 2.30 + + linux: 4.19 -\> 5.4 + + mesa: 19.1.5 -\> 19.3.3 + + openssl: 1.0.2u -\> 1.1.1d + +- Desktop version changes: + + plasma5: 5.16.5 -\> 5.17.5 + + kdeApplications: 19.08.2 -\> 19.12.3 + + gnome3: 3.32 -\> 3.34 + + pantheon: 5.0 -\> 5.1.3 + +- Linux kernel is updated to branch 5.4 by default (from 4.19). + +- Grub is updated to 2.04, adding support for booting from F2FS filesystems and Btrfs volumes using zstd compression. Note that some users have been unable to boot after upgrading to 2.04 - for more information, please see [this discussion](https://github.com/NixOS/nixpkgs/issues/61718#issuecomment-617618503). + +- Postgresql for NixOS service now defaults to v11. + +- The graphical installer image starts the graphical session automatically. Before you\'d be greeted by a tty and asked to enter `systemctl start display-manager`. It is now possible to disable the display-manager from running by selecting the `Disable display-manager` quirk in the boot menu. + +- GNOME 3 has been upgraded to 3.34. Please take a look at their [Release Notes](https://help.gnome.org/misc/release-notes/3.34) for details. + +- If you enable the Pantheon Desktop Manager via [services.xserver.desktopManager.pantheon.enable](options.html#opt-services.xserver.desktopManager.pantheon.enable), we now default to also use [ Pantheon\'s newly designed greeter ](https://blog.elementary.io/say-hello-to-the-new-greeter/). Contrary to NixOS\'s usual update policy, Pantheon will receive updates during the cycle of NixOS 20.03 when backwards compatible. + +- By default zfs pools will now be trimmed on a weekly basis. Trimming is only done on supported devices (i.e. NVME or SSDs) and should improve throughput and lifetime of these devices. It is controlled by the `services.zfs.trim.enable` varname. The zfs scrub service (`services.zfs.autoScrub.enable`) and the zfs autosnapshot service (`services.zfs.autoSnapshot.enable`) are now only enabled if zfs is set in `config.boot.initrd.supportedFilesystems` or `config.boot.supportedFilesystems`. These lists will automatically contain zfs as soon as any zfs mountpoint is configured in `fileSystems`. + +- `nixos-option` has been rewritten in C++, speeding it up, improving correctness, and adding a `-r` option which prints all options and their values recursively. + +- `services.xserver.desktopManager.default` and `services.xserver.windowManager.default` options were replaced by a single [services.xserver.displayManager.defaultSession](options.html#opt-services.xserver.displayManager.defaultSession) option to improve support for upstream session files. If you used something like: + + ```nix + { + services.xserver.desktopManager.default = "xfce"; + services.xserver.windowManager.default = "icewm"; + } + ``` + + you should change it to: + + ```nix + { + services.xserver.displayManager.defaultSession = "xfce+icewm"; + } + ``` + +- The testing driver implementation in NixOS is now in Python `make-test-python.nix`. This was done by Jacek Galowicz ([\@tfc](https://github.com/tfc)), and with the collaboration of Julian Stecklina ([\@blitz](https://github.com/blitz)) and Jana Traue ([\@jtraue](https://github.com/jtraue)). All documentation has been updated to use this testing driver, and a vast majority of the 286 tests in NixOS were ported to python driver. In 20.09 the Perl driver implementation, `make-test.nix`, is slated for removal. This should give users of the NixOS integration framework a transitory period to rewrite their tests to use the Python implementation. Users of the Perl driver will see this warning everytime they use it: + + ```ShellSession + $ warning: Perl VM tests are deprecated and will be removed for 20.09. + Please update your tests to use the python test driver. + See https://github.com/NixOS/nixpkgs/pull/71684 for details. + ``` + + API compatibility is planned to be kept for at least the next release with the perl driver. + +## New Services {#sec-release-20.03-new-services} + +The following new services were added since the last release: + +- The kubernetes kube-proxy now supports a new hostname configuration `services.kubernetes.proxy.hostname` which has to be set if the hostname of the node should be non default. + +- UPower\'s configuration is now managed by NixOS and can be customized via `services.upower`. + +- To use Geary you should enable [programs.geary.enable](options.html#opt-programs.geary.enable) instead of just adding it to [environment.systemPackages](options.html#opt-environment.systemPackages). It was created so Geary could function properly outside of GNOME. + +- `./config/console.nix` + +- `./hardware/brillo.nix` + +- `./hardware/tuxedo-keyboard.nix` + +- `./programs/bandwhich.nix` + +- `./programs/bash-my-aws.nix` + +- `./programs/liboping.nix` + +- `./programs/traceroute.nix` + +- `./services/backup/sanoid.nix` + +- `./services/backup/syncoid.nix` + +- `./services/backup/zfs-replication.nix` + +- `./services/continuous-integration/buildkite-agents.nix` + +- `./services/databases/victoriametrics.nix` + +- `./services/desktops/gnome3/gnome-initial-setup.nix` + +- `./services/desktops/neard.nix` + +- `./services/games/openarena.nix` + +- `./services/hardware/fancontrol.nix` + +- `./services/mail/sympa.nix` + +- `./services/misc/freeswitch.nix` + +- `./services/misc/mame.nix` + +- `./services/monitoring/do-agent.nix` + +- `./services/monitoring/prometheus/xmpp-alerts.nix` + +- `./services/network-filesystems/orangefs/server.nix` + +- `./services/network-filesystems/orangefs/client.nix` + +- `./services/networking/3proxy.nix` + +- `./services/networking/corerad.nix` + +- `./services/networking/go-shadowsocks2.nix` + +- `./services/networking/ntp/openntpd.nix` + +- `./services/networking/shorewall.nix` + +- `./services/networking/shorewall6.nix` + +- `./services/networking/spacecookie.nix` + +- `./services/networking/trickster.nix` + +- `./services/networking/v2ray.nix` + +- `./services/networking/xandikos.nix` + +- `./services/networking/yggdrasil.nix` + +- `./services/web-apps/dokuwiki.nix` + +- `./services/web-apps/gotify-server.nix` + +- `./services/web-apps/grocy.nix` + +- `./services/web-apps/ihatemoney` + +- `./services/web-apps/moinmoin.nix` + +- `./services/web-apps/trac.nix` + +- `./services/web-apps/trilium.nix` + +- `./services/web-apps/shiori.nix` + +- `./services/web-servers/ttyd.nix` + +- `./services/x11/picom.nix` + +- `./services/x11/hardware/digimend.nix` + +- `./services/x11/imwheel.nix` + +- `./virtualisation/cri-o.nix` + +## Backward Incompatibilities {#sec-release-20.03-incompatibilities} + +When upgrading from a previous release, please be aware of the following incompatible changes: + +- The dhcpcd package [ does not request IPv4 addresses for tap and bridge interfaces anymore by default](https://roy.marples.name/archives/dhcpcd-discuss/0002621.html). In order to still get an address on a bridge interface, one has to disable `networking.useDHCP` and explicitly enable `networking.interfaces.<name>.useDHCP` on every interface, that should get an address via DHCP. This way, dhcpcd is configured in an explicit way about which interface to run on. + +- GnuPG is now built without support for a graphical passphrase entry by default. Please enable the `gpg-agent` user service via the NixOS option `programs.gnupg.agent.enable`. Note that upstream recommends using `gpg-agent` and will spawn a `gpg-agent` on the first invocation of GnuPG anyway. + +- The `dynamicHosts` option has been removed from the [NetworkManager](options.html#opt-networking.networkmanager.enable) module. Allowing (multiple) regular users to override host entries affecting the whole system opens up a huge attack vector. There seem to be very rare cases where this might be useful. Consider setting system-wide host entries using [networking.hosts](options.html#opt-networking.hosts), provide them via the DNS server in your network, or use [environment.etc](options.html#opt-environment.etc) to add a file into `/etc/NetworkManager/dnsmasq.d` reconfiguring `hostsdir`. + +- The `99-main.network` file was removed. Matching all network interfaces caused many breakages, see [\#18962](https://github.com/NixOS/nixpkgs/pull/18962) and [\#71106](https://github.com/NixOS/nixpkgs/pull/71106). + + We already don\'t support the global [networking.useDHCP](options.html#opt-networking.useDHCP), [networking.defaultGateway](options.html#opt-networking.defaultGateway) and [networking.defaultGateway6](options.html#opt-networking.defaultGateway6) options if [networking.useNetworkd](options.html#opt-networking.useNetworkd) is enabled, but direct users to configure the per-device [networking.interfaces.\<name\>....](options.html#opt-networking.interfaces) options. + +- The stdenv now runs all bash with `set -u`, to catch the use of undefined variables. Before, it itself used `set -u` but was careful to unset it so other packages\' code ran as before. Now, all bash code is held to the same high standard, and the rather complex stateful manipulation of the options can be discarded. + +- The SLIM Display Manager has been removed, as it has been unmaintained since 2013. Consider migrating to a different display manager such as LightDM (current default in NixOS), SDDM, GDM, or using the startx module which uses Xinitrc. + +- The Way Cooler wayland compositor has been removed, as the project has been officially canceled. There are no more `way-cooler` attribute and `programs.way-cooler` options. + +- The BEAM package set has been deleted. You will only find there the different interpreters. You should now use the different build tools coming with the languages with sandbox mode disabled. + +- There is now only one Xfce package-set and module. This means that attributes `xfce4-14` and `xfceUnstable` all now point to the latest Xfce 4.14 packages. And in the future NixOS releases will be the latest released version of Xfce available at the time of the release\'s development (if viable). + +- The [phpfpm](options.html#opt-services.phpfpm.pools) module now sets `PrivateTmp=true` in its systemd units for better process isolation. If you rely on `/tmp` being shared with other services, explicitly override this by setting `serviceConfig.PrivateTmp` to `false` for each phpfpm unit. + +- KDE's old multimedia framework Phonon no longer supports Qt 4. For that reason, Plasma desktop also does not have `enableQt4Support` option any more. + +- The BeeGFS module has been removed. + +- The osquery module has been removed. + +- Going forward, `~/bin` in the users home directory will no longer be in `PATH` by default. If you depend on this you should set the option `environment.homeBinInPath` to `true`. The aforementioned option was added this release. + +- The `buildRustCrate` infrastructure now produces `lib` outputs in addition to the `out` output. This has led to drastically reduced closure sizes for some rust crates since development dependencies are now in the `lib` output. + +- Pango was upgraded to 1.44, which no longer uses freetype for font loading. This means that type1 and bitmap fonts are no longer supported in applications relying on Pango for font rendering (notably, GTK application). See [ upstream issue](https://gitlab.gnome.org/GNOME/pango/issues/386) for more information. + +- The `roundcube` module has been hardened. + + - The password of the database is not written world readable in the store any more. If `database.host` is set to `localhost`, then a unix user of the same name as the database will be created and PostreSQL peer authentication will be used, removing the need for a password. Otherwise, a password is still needed and can be provided with the new option `database.passwordFile`, which should be set to the path of a file containing the password and readable by the user `nginx` only. The `database.password` option is insecure and deprecated. Usage of this option will print a warning. + + - A random `des_key` is set by default in the configuration of roundcube, instead of using the hardcoded and insecure default. To ensure a clean migration, all users will be logged out when you upgrade to this release. + +- The packages `openobex` and `obexftp` are no longer installed when enabling Bluetooth via `hardware.bluetooth.enable`. + +- The `dump1090` derivation has been changed to use FlightAware\'s dump1090 as its upstream. However, this version does not have an internal webserver anymore. The assets in the `share/dump1090` directory of the derivation can be used in conjunction with an external webserver to replace this functionality. + +- The fourStore and fourStoreEndpoint modules have been removed. + +- Polkit no longer has the user of uid 0 (root) as an admin identity. We now follow the upstream default of only having every member of the wheel group admin privileged. Before it was root and members of wheel. The positive outcome of this is pkexec GUI popups or terminal prompts will no longer require the user to choose between two essentially equivalent choices (whether to perform the action as themselves with wheel permissions, or as the root user). + +- NixOS containers no longer build NixOS manual by default. This saves evaluation time, especially if there are many declarative containers defined. Note that this is already done when `<nixos/modules/profiles/minimal.nix>` module is included in container config. + +- The `kresd` services deprecates the `interfaces` option in favor of the `listenPlain` option which requires full [systemd.socket compatible](https://www.freedesktop.org/software/systemd/man/systemd.socket.html#ListenStream=) declaration which always include a port. + +- Virtual console options have been reorganized and can be found under a single top-level attribute: `console`. The full set of changes is as follows: + + - `i18n.consoleFont` renamed to [console.font](options.html#opt-console.font) + + - `i18n.consoleKeyMap` renamed to [console.keyMap](options.html#opt-console.keyMap) + + - `i18n.consoleColors` renamed to [console.colors](options.html#opt-console.colors) + + - `i18n.consolePackages` renamed to [console.packages](options.html#opt-console.packages) + + - `i18n.consoleUseXkbConfig` renamed to [console.useXkbConfig](options.html#opt-console.useXkbConfig) + + - `boot.earlyVconsoleSetup` renamed to [console.earlySetup](options.html#opt-console.earlySetup) + + - `boot.extraTTYs` renamed to `console.extraTTYs`. + +- The [awstats](options.html#opt-services.awstats.enable) module has been rewritten to serve stats via static html pages, updated on a timer, over [nginx](options.html#opt-services.nginx.virtualHosts), instead of dynamic cgi pages over [apache](options.html#opt-services.httpd.enable). + + Minor changes will be required to migrate existing configurations. Details of the required changes can seen by looking through the [awstats](options.html#opt-services.awstats.enable) module. + +- The httpd module no longer provides options to support serving web content without defining a virtual host. As a result of this the [services.httpd.logPerVirtualHost](options.html#opt-services.httpd.logPerVirtualHost) option now defaults to `true` instead of `false`. Please update your configuration to make use of [services.httpd.virtualHosts](options.html#opt-services.httpd.virtualHosts). + + The [services.httpd.virtualHosts.\<name\>](options.html#opt-services.httpd.virtualHosts) option has changed type from a list of submodules to an attribute set of submodules, better matching [services.nginx.virtualHosts.\<name\>](options.html#opt-services.nginx.virtualHosts). + + This change comes with the addition of the following options which mimic the functionality of their `nginx` counterparts: [services.httpd.virtualHosts.\<name\>.addSSL](options.html#opt-services.httpd.virtualHosts), [services.httpd.virtualHosts.\<name\>.forceSSL](options.html#opt-services.httpd.virtualHosts), [services.httpd.virtualHosts.\<name\>.onlySSL](options.html#opt-services.httpd.virtualHosts), [services.httpd.virtualHosts.\<name\>.enableACME](options.html#opt-services.httpd.virtualHosts), [services.httpd.virtualHosts.\<name\>.acmeRoot](options.html#opt-services.httpd.virtualHosts), and [services.httpd.virtualHosts.\<name\>.useACMEHost](options.html#opt-services.httpd.virtualHosts). + +- For NixOS configuration options, the `loaOf` type has been deprecated and will be removed in a future release. In nixpkgs, options of this type will be changed to `attrsOf` instead. If you were using one of these in your configuration, you will see a warning suggesting what changes will be required. + + For example, [users.users](options.html#opt-users.users) is a `loaOf` option that is commonly used as follows: + + ```nix + { + users.users = + [ { name = "me"; + description = "My personal user."; + isNormalUser = true; + } + ]; + } + ``` + + This should be rewritten by removing the list and using the value of `name` as the name of the attribute set: + + ```nix + { + users.users.me = + { description = "My personal user."; + isNormalUser = true; + }; + } + ``` + + For more information on this change have look at these links: [issue \#1800](https://github.com/NixOS/nixpkgs/issues/1800), [PR \#63103](https://github.com/NixOS/nixpkgs/pull/63103). + +- For NixOS modules, the types `types.submodule` and `types.submoduleWith` now support paths as allowed values, similar to how `imports` supports paths. Because of this, if you have a module that defines an option of type `either (submodule ...) path`, it will break since a path is now treated as the first type instead of the second. To fix this, change the type to `either path (submodule ...)`. + +- The [Buildkite Agent](options.html#opt-services.buildkite-agents) module and corresponding packages have been updated to 3.x, and to support multiple instances of the agent running at the same time. This means you will have to rename `services.buildkite-agent` to `services.buildkite-agents.<name>`. Furthermore, the following options have been changed: + + - `services.buildkite-agent.meta-data` has been renamed to [services.buildkite-agents.\<name\>.tags](options.html#opt-services.buildkite-agents), to match upstreams naming for 3.x. Its type has also changed - it now accepts an attrset of strings. + + - The`services.buildkite-agent.openssh.publicKeyPath` option has been removed, as it\'s not necessary to deploy public keys to clone private repositories. + + - `services.buildkite-agent.openssh.privateKeyPath` has been renamed to [buildkite-agents.\<name\>.privateSshKeyPath](options.html#opt-services.buildkite-agents), as the whole `openssh` now only contained that single option. + + - [services.buildkite-agents.\<name\>.shell](options.html#opt-services.buildkite-agents) has been introduced, allowing to specify a custom shell to be used. + +- The `citrix_workspace_19_3_0` package has been removed as it will be EOLed within the lifespan of 20.03. For further information, please refer to the [support and maintenance information](https://www.citrix.com/de-de/support/product-lifecycle/milestones/receiver.html) from upstream. + +- The `gcc5` and `gfortran5` packages have been removed. + +- The `services.xserver.displayManager.auto` module has been removed. It was only intended for use in internal NixOS tests, and gave the false impression of it being a special display manager when it\'s actually LightDM. Please use the `services.xserver.displayManager.lightdm.autoLogin` options instead, or any other display manager in NixOS as they all support auto-login. If you used this module specifically because it permitted root auto-login you can override the lightdm-autologin pam module like: + + ```nix + { + security.pam.services.lightdm-autologin.text = lib.mkForce '' + auth requisite pam_nologin.so + auth required pam_succeed_if.so quiet + auth required pam_permit.so + + account include lightdm + + password include lightdm + + session include lightdm + ''; + } + ``` + + The difference is the: + + ``` + auth required pam_succeed_if.so quiet + ``` + + line, where default it\'s: + + ``` + auth required pam_succeed_if.so uid >= 1000 quiet + ``` + + not permitting users with uid\'s below 1000 (like root). All other display managers in NixOS are configured like this. + +- There have been lots of improvements to the Mailman module. As a result, + + - The `services.mailman.hyperkittyBaseUrl` option has been renamed to [services.mailman.hyperkitty.baseUrl](options.html#opt-services.mailman.hyperkitty.baseUrl). + + - The `services.mailman.hyperkittyApiKey` option has been removed. This is because having an option for the Hyperkitty API key meant that the API key would be stored in the world-readable Nix store, which was a security vulnerability. A new Hyperkitty API key will be generated the first time the new Hyperkitty service is run, and it will then be persisted outside of the Nix store. To continue using Hyperkitty, you must set [services.mailman.hyperkitty.enable](options.html#opt-services.mailman.hyperkitty.enable) to `true`. + + - Additionally, some Postfix configuration must now be set manually instead of automatically by the Mailman module: + + ```nix + { + services.postfix.relayDomains = [ "hash:/var/lib/mailman/data/postfix_domains" ]; + services.postfix.config.transport_maps = [ "hash:/var/lib/mailman/data/postfix_lmtp" ]; + services.postfix.config.local_recipient_maps = [ "hash:/var/lib/mailman/data/postfix_lmtp" ]; + } + ``` + + This is because some users may want to include other values in these lists as well, and this was not possible if they were set automatically by the Mailman module. It would not have been possible to just concatenate values from multiple modules each setting the values they needed, because the order of elements in the list is significant. + +- The LLVM versions 3.5, 3.9 and 4 (including the corresponding CLang versions) have been dropped. + +- The `networking.interfaces.*.preferTempAddress` option has been replaced by `networking.interfaces.*.tempAddress`. The new option allows better control of the IPv6 temporary addresses, including completely disabling them for interfaces where they are not needed. + +- Rspamd was updated to version 2.2. Read [ the upstream migration notes](https://rspamd.com/doc/migration.html#migration-to-rspamd-20) carefully. Please be especially aware that some modules were removed and the default Bayes backend is now Redis. + +- The `*psu` versions of oraclejdk8 have been removed as they aren\'t provided by upstream anymore. + +- The `services.dnscrypt-proxy` module has been removed as it used the deprecated version of dnscrypt-proxy. We\'ve added [services.dnscrypt-proxy2.enable](options.html#opt-services.dnscrypt-proxy2.enable) to use the supported version. This module supports configuration via the Nix attribute set [services.dnscrypt-proxy2.settings](options.html#opt-services.dnscrypt-proxy2.settings), or by passing a TOML configuration file via [services.dnscrypt-proxy2.configFile](options.html#opt-services.dnscrypt-proxy2.configFile). + + ```nix + { + # Example configuration: + services.dnscrypt-proxy2.enable = true; + services.dnscrypt-proxy2.settings = { + listen_addresses = [ "127.0.0.1:43" ]; + sources.public-resolvers = { + urls = [ "https://download.dnscrypt.info/resolvers-list/v2/public-resolvers.md" ]; + cache_file = "public-resolvers.md"; + minisign_key = "RWQf6LRCGA9i53mlYecO4IzT51TGPpvWucNSCh1CBM0QTaLn73Y7GFO3"; + refresh_delay = 72; + }; + }; + + services.dnsmasq.enable = true; + services.dnsmasq.servers = [ "127.0.0.1#43" ]; + } + ``` + +- `qesteidutil` has been deprecated in favor of `qdigidoc`. + +- sqldeveloper_18 has been removed as it\'s not maintained anymore, sqldeveloper has been updated to version `19.4`. Please note that this means that this means that the oraclejdk is now required. For further information please read the [release notes](https://www.oracle.com/technetwork/developer-tools/sql-developer/downloads/sqldev-relnotes-194-5908846.html). + +- Haskell `env` and `shellFor` dev shell environments now organize dependencies the same way as regular builds. In particular, rather than receiving all the different lists of dependencies mashed together as one big list, and then partitioning into Haskell and non-Hakell dependencies, they work from the original many different dependency parameters and don\'t need to algorithmically partition anything. + + This means that if you incorrectly categorize a dependency, e.g. non-Haskell library dependency as a `buildDepends` or run-time Haskell dependency as a `setupDepends`, whereas things would have worked before they may not work now. + +- The gcc-snapshot-package has been removed. It\'s marked as broken for \>2 years and used to point to a fairly old snapshot from the gcc7-branch. + +- The nixos-build-vms8 -script now uses the python test-driver. + +- The riot-web package now accepts configuration overrides as an attribute set instead of a string. A formerly used JSON configuration can be converted to an attribute set with `builtins.fromJSON`. + + The new default configuration also disables automatic guest account registration and analytics to improve privacy. The previous behavior can be restored by setting `config.riot-web.conf = { disable_guests = false; piwik = true; }`. + +- Stand-alone usage of `Upower` now requires `services.upower.enable` instead of just installing into [environment.systemPackages](options.html#opt-environment.systemPackages). + +- nextcloud has been updated to `v18.0.2`. This means that users from NixOS 19.09 can\'t upgrade directly since you can only move one version forward and 19.09 uses `v16.0.8`. + + To provide a safe upgrade-path and to circumvent similar issues in the future, the following measures were taken: + + - The pkgs.nextcloud-attribute has been removed and replaced with versioned attributes (currently pkgs.nextcloud17 and pkgs.nextcloud18). With this change major-releases can be backported without breaking stuff and to make upgrade-paths easier. + + - Existing setups will be detected using [system.stateVersion](options.html#opt-system.stateVersion): by default, nextcloud17 will be used, but will raise a warning which notes that after that deploy it\'s recommended to update to the latest stable version (nextcloud18) by declaring the newly introduced setting [services.nextcloud.package](options.html#opt-services.nextcloud.package). + + - Users with an overlay (e.g. to use nextcloud at version `v18` on `19.09`) will get an evaluation error by default. This is done to ensure that our [package](options.html#opt-services.nextcloud.package)-option doesn\'t select an older version by accident. It\'s recommended to use pkgs.nextcloud18 or to set [package](options.html#opt-services.nextcloud.package) to pkgs.nextcloud explicitly. + + ::: {.warning} + Please note that if you\'re coming from `19.03` or older, you have to manually upgrade to `19.09` first to upgrade your server to Nextcloud v16. + ::: + +- Hydra has gained a massive performance improvement due to [some database schema changes](https://github.com/NixOS/hydra/pull/710) by adding several IDs and better indexing. However, it\'s necessary to upgrade Hydra in multiple steps: + + - At first, an older version of Hydra needs to be deployed which adds those (nullable) columns. When having set [stateVersion ](options.html#opt-system.stateVersion) to a value older than `20.03`, this package will be selected by default from the module when upgrading. Otherwise, the package can be deployed using the following config: + + ```nix + { pkgs, ... }: { + services.hydra.package = pkgs.hydra-migration; + } + ``` + +- Automatically fill the newly added ID columns on the server by running the following command: + + ```ShellSession + $ hydra-backfill-ids + ``` + ::: {.warning} + Please note that this process can take a while depending on your database-size! + ::: + +- Deploy a newer version of Hydra to activate the DB optimizations. This can be done by using hydra-unstable. This package already includes [flake-support](https://github.com/nixos/rfcs/pull/49) and is therefore compiled against pkgs.nixFlakes. + + ::: {.warning} + If your [stateVersion](options.html#opt-system.stateVersion) is set to `20.03` or greater, hydra-unstable will be used automatically! This will break your setup if you didn\'t run the migration. + ::: + + Please note that Hydra is currently not available with nixStable as this doesn\'t compile anymore. + + ::: {.warning} + pkgs.hydra has been removed to ensure a graceful database-migration using the dedicated package-attributes. If you still have pkgs.hydra defined in e.g. an overlay, an assertion error will be thrown. To circumvent this, you need to set [services.hydra.package](options.html#opt-services.hydra.package) to pkgs.hydra explicitly and make sure you know what you\'re doing! + ::: + +- The TokuDB storage engine will be disabled in mariadb 10.5. It is recommended to switch to RocksDB. See also [TokuDB](https://mariadb.com/kb/en/tokudb/). + +## Other Notable Changes {#sec-release-20.03-notable-changes} + +- SD images are now compressed by default using `bzip2`. + +- The nginx web server previously started its master process as root privileged, then ran worker processes as a less privileged identity user (the `nginx` user). This was changed to start all of nginx as a less privileged user (defined by `services.nginx.user` and `services.nginx.group`). As a consequence, all files that are needed for nginx to run (included configuration fragments, SSL certificates and keys, etc.) must now be readable by this less privileged user/group. + + To continue to use the old approach, you can configure: + + ```nix + { + services.nginx.appendConfig = let cfg = config.services.nginx; in ''user ${cfg.user} ${cfg.group};''; + systemd.services.nginx.serviceConfig.User = lib.mkForce "root"; + } + ``` + +- OpenSSH has been upgraded from 7.9 to 8.1, improving security and adding features but with potential incompatibilities. Consult the [ release announcement](https://www.openssh.com/txt/release-8.1) for more information. + +- `PRETTY_NAME` in `/etc/os-release` now uses the short rather than full version string. + +- The ACME module has switched from simp-le to [lego](https://github.com/go-acme/lego) which allows us to support DNS-01 challenges and wildcard certificates. The following options have been added: [security.acme.acceptTerms](options.html#opt-security.acme.acceptTerms), [security.acme.certs.\<name\>.dnsProvider](options.html#opt-security.acme.certs), [security.acme.certs.\<name\>.credentialsFile](options.html#opt-security.acme.certs), [security.acme.certs.\<name\>.dnsPropagationCheck](options.html#opt-security.acme.certs). As well as this, the options `security.acme.acceptTerms` and either `security.acme.email` or `security.acme.certs.<name>.email` must be set in order to use the ACME module. Certificates will be regenerated on activation, no account or certificate will be migrated from simp-le. In particular private keys will not be preserved. However, the credentials for simp-le are preserved and thus it is possible to roll back to previous versions without breaking certificate generation. Note also that in contrary to simp-le a new private key is recreated at each renewal by default, which can have consequences if you embed your public key in apps. + +- It is now possible to unlock LUKS-Encrypted file systems using a FIDO2 token via `boot.initrd.luks.fido2Support`. + +- Predictably named network interfaces get renamed in stage-1. This means that it is possible to use the proper interface name for e.g. Dropbear setups. + + For further reference, please read [\#68953](https://github.com/NixOS/nixpkgs/pull/68953) or the corresponding [discourse thread](https://discourse.nixos.org/t/predictable-network-interface-names-in-initrd/4055). + +- The matrix-synapse-package has been updated to [v1.11.1](https://github.com/matrix-org/synapse/releases/tag/v1.11.1). Due to [stricter requirements](https://github.com/matrix-org/synapse/releases/tag/v1.10.0rc1) for database configuration when using postgresql, the automated database setup of the module has been removed to avoid any further edge-cases. + + matrix-synapse expects `postgresql`-databases to have the options `LC_COLLATE` and `LC_CTYPE` set to [`'C'`](https://www.postgresql.org/docs/12/locale.html) which basically instructs `postgresql` to ignore any locale-based preferences. + + Depending on your setup, you need to incorporate one of the following changes in your setup to upgrade to 20.03: + + - If you use `sqlite3` you don\'t need to do anything. + + - If you use `postgresql` on a different server, you don\'t need to change anything as well since this module was never designed to configure remote databases. + + - If you use `postgresql` and configured your synapse initially on `19.09` or older, you simply need to enable postgresql-support explicitly: + + ```nix + { ... }: { + services.matrix-synapse = { + enable = true; + /* and all the other config you've defined here */ + }; + services.postgresql.enable = true; + } + ``` + +- If you deploy a fresh matrix-synapse, you need to configure the database yourself (e.g. by using the [services.postgresql.initialScript](options.html#opt-services.postgresql.initialScript) option). An example for this can be found in the [documentation of the Matrix module](#module-services-matrix). + +- If you initially deployed your matrix-synapse on `nixos-unstable` _after_ the `19.09`-release, your database is misconfigured due to a regression in NixOS. For now, matrix-synapse will startup with a warning, but it\'s recommended to reconfigure the database to set the values `LC_COLLATE` and `LC_CTYPE` to [`'C'`](https://www.postgresql.org/docs/12/locale.html). + +- The [systemd.network.links](options.html#opt-systemd.network.links) option is now respected even when [systemd-networkd](options.html#opt-systemd.network.enable) is disabled. This mirrors the behaviour of systemd - It\'s udev that parses `.link` files, not `systemd-networkd`. + +- mongodb has been updated to version `3.4.24`. + + ::: {.warning} + Please note that mongodb has been relicensed under their own [` sspl`](https://www.mongodb.com/licensing/server-side-public-license/faq)-license. Since it\'s not entirely free and not OSI-approved, it\'s listed as non-free. This means that Hydra doesn\'t provide prebuilt mongodb-packages and needs to be built locally. + ::: diff --git a/nixos/doc/manual/release-notes/rl-2003.xml b/nixos/doc/manual/release-notes/rl-2003.xml deleted file mode 100644 index 4206f44f6c7..00000000000 --- a/nixos/doc/manual/release-notes/rl-2003.xml +++ /dev/null @@ -1,1252 +0,0 @@ -<section xmlns="http://docbook.org/ns/docbook" - xmlns:xlink="http://www.w3.org/1999/xlink" - xmlns:xi="http://www.w3.org/2001/XInclude" - version="5.0" - xml:id="sec-release-20.03"> - <title>Release 20.03 (“Markhor”, 2020.04/20)</title> - - <section xmlns="http://docbook.org/ns/docbook" - xmlns:xlink="http://www.w3.org/1999/xlink" - xmlns:xi="http://www.w3.org/2001/XInclude" - version="5.0" - xml:id="sec-release-20.03-highlights"> - <title>Highlights</title> - - <para> - In addition to numerous new and upgraded packages, this release has the - following highlights: - </para> - - <itemizedlist> - <listitem> - <para> - Support is planned until the end of October 2020, handing over to 20.09. - </para> - </listitem> - <listitem> - <para>Core version changes:</para> - <para>gcc: 8.3.0 -> 9.2.0</para> - <para>glibc: 2.27 -> 2.30</para> - <para>linux: 4.19 -> 5.4</para> - <para>mesa: 19.1.5 -> 19.3.3</para> - <para>openssl: 1.0.2u -> 1.1.1d</para> - </listitem> - <listitem> - <para>Desktop version changes:</para> - <para>plasma5: 5.16.5 -> 5.17.5</para> - <para>kdeApplications: 19.08.2 -> 19.12.3</para> - <para>gnome3: 3.32 -> 3.34</para> - <para>pantheon: 5.0 -> 5.1.3</para> - </listitem> - <listitem> - <para> - Linux kernel is updated to branch 5.4 by default (from 4.19). - </para> - </listitem> - <listitem> - <para> - Grub is updated to 2.04, adding support for booting from F2FS filesystems and - Btrfs volumes using zstd compression. Note that some users have been unable -to boot after upgrading to 2.04 - for more information, please see <link -xlink:href="https://github.com/NixOS/nixpkgs/issues/61718#issuecomment-617618503">this - discussion</link>. - </para> - </listitem> - <listitem> - <para> - Postgresql for NixOS service now defaults to v11. - </para> - </listitem> - <listitem> - <para> - The graphical installer image starts the graphical session automatically. - Before you'd be greeted by a tty and asked to enter <command>systemctl start display-manager</command>. - It is now possible to disable the display-manager from running by selecting the <literal>Disable display-manager</literal> - quirk in the boot menu. - </para> - </listitem> - <listitem> - <para> - GNOME 3 has been upgraded to 3.34. Please take a look at their - <link xlink:href="https://help.gnome.org/misc/release-notes/3.34">Release Notes</link> - for details. - </para> - </listitem> - <listitem> - <para> - If you enable the Pantheon Desktop Manager via - <xref linkend="opt-services.xserver.desktopManager.pantheon.enable" />, we now default to also use - <link xlink:href="https://blog.elementary.io/say-hello-to-the-new-greeter/"> - Pantheon's newly designed greeter - </link>. - Contrary to NixOS's usual update policy, Pantheon will receive updates during the cycle of - NixOS 20.03 when backwards compatible. - </para> - </listitem> - <listitem> - <para> - By default zfs pools will now be trimmed on a weekly basis. - Trimming is only done on supported devices (i.e. NVME or SSDs) - and should improve throughput and lifetime of these devices. - It is controlled by the <varname>services.zfs.trim.enable</varname> varname. - The zfs scrub service (<varname>services.zfs.autoScrub.enable</varname>) - and the zfs autosnapshot service (<varname>services.zfs.autoSnapshot.enable</varname>) - are now only enabled if zfs is set in <varname>config.boot.initrd.supportedFilesystems</varname> or - <varname>config.boot.supportedFilesystems</varname>. These lists will automatically contain - zfs as soon as any zfs mountpoint is configured in <varname>fileSystems</varname>. - </para> - </listitem> - <listitem> - <para> - <command>nixos-option</command> has been rewritten in C++, speeding it up, improving correctness, - and adding a <option>-r</option> option which prints all options and their values recursively. - </para> - </listitem> - <listitem> - <para> - <option>services.xserver.desktopManager.default</option> and <option>services.xserver.windowManager.default</option> options were replaced by a single <xref linkend="opt-services.xserver.displayManager.defaultSession"/> option to improve support for upstream session files. If you used something like: -<programlisting> -services.xserver.desktopManager.default = "xfce"; -services.xserver.windowManager.default = "icewm"; -</programlisting> - you should change it to: -<programlisting> -services.xserver.displayManager.defaultSession = "xfce+icewm"; -</programlisting> - </para> - </listitem> - <listitem> - <para> - The testing driver implementation in NixOS is now in Python <filename>make-test-python.nix</filename>. - This was done by Jacek Galowicz (<link xlink:href="https://github.com/tfc">@tfc</link>), and with the - collaboration of Julian Stecklina (<link xlink:href="https://github.com/blitz">@blitz</link>) and - Jana Traue (<link xlink:href="https://github.com/jtraue">@jtraue</link>). All documentation has been updated to use this - testing driver, and a vast majority of the 286 tests in NixOS were ported to python driver. In 20.09 the Perl driver implementation, - <filename>make-test.nix</filename>, is slated for removal. This should give users of the NixOS integration framework - a transitory period to rewrite their tests to use the Python implementation. Users of the Perl driver will see - this warning everytime they use it: -<screen> -<prompt>$ </prompt>warning: Perl VM tests are deprecated and will be removed for 20.09. -Please update your tests to use the python test driver. -See https://github.com/NixOS/nixpkgs/pull/71684 for details. -</screen> - API compatibility is planned to be kept for at least the next release with the perl driver. - </para> - </listitem> - </itemizedlist> - </section> - - <section xmlns="http://docbook.org/ns/docbook" - xmlns:xlink="http://www.w3.org/1999/xlink" - xmlns:xi="http://www.w3.org/2001/XInclude" - version="5.0" - xml:id="sec-release-20.03-new-services"> - <title>New Services</title> - - <para> - The following new services were added since the last release: - </para> - - <itemizedlist> - <listitem> - <para> - The kubernetes kube-proxy now supports a new hostname configuration - <literal>services.kubernetes.proxy.hostname</literal> which has to - be set if the hostname of the node should be non default. - </para> - </listitem> - <listitem> - <para> - UPower's configuration is now managed by NixOS and can be customized - via <option>services.upower</option>. - </para> - </listitem> - <listitem> - <para> - To use Geary you should enable <xref linkend="opt-programs.geary.enable"/> instead of - just adding it to <xref linkend="opt-environment.systemPackages"/>. - It was created so Geary could function properly outside of GNOME. - </para> - </listitem> - <listitem> - <para> - <filename>./config/console.nix</filename> - </para> - </listitem> - <listitem> - <para> - <filename>./hardware/brillo.nix</filename> - </para> - </listitem> - <listitem> - <para> - <filename>./hardware/tuxedo-keyboard.nix</filename> - </para> - </listitem> - <listitem> - <para> - <filename>./programs/bandwhich.nix</filename> - </para> - </listitem> - <listitem> - <para> - <filename>./programs/bash-my-aws.nix</filename> - </para> - </listitem> - <listitem> - <para> - <filename>./programs/liboping.nix</filename> - </para> - </listitem> - <listitem> - <para> - <filename>./programs/traceroute.nix</filename> - </para> - </listitem> - <listitem> - <para> - <filename>./services/backup/sanoid.nix</filename> - </para> - </listitem> - <listitem> - <para> - <filename>./services/backup/syncoid.nix</filename> - </para> - </listitem> - <listitem> - <para> - <filename>./services/backup/zfs-replication.nix</filename> - </para> - </listitem> - <listitem> - <para> - <filename>./services/continuous-integration/buildkite-agents.nix</filename> - </para> - </listitem> - <listitem> - <para> - <filename>./services/databases/victoriametrics.nix</filename> - </para> - </listitem> - <listitem> - <para> - <filename>./services/desktops/gnome3/gnome-initial-setup.nix</filename> - </para> - </listitem> - <listitem> - <para> - <filename>./services/desktops/neard.nix</filename> - </para> - </listitem> - <listitem> - <para> - <filename>./services/games/openarena.nix</filename> - </para> - </listitem> - <listitem> - <para> - <filename>./services/hardware/fancontrol.nix</filename> - </para> - </listitem> - <listitem> - <para> - <filename>./services/mail/sympa.nix</filename> - </para> - </listitem> - <listitem> - <para> - <filename>./services/misc/freeswitch.nix</filename> - </para> - </listitem> - <listitem> - <para> - <filename>./services/misc/mame.nix</filename> - </para> - </listitem> - <listitem> - <para> - <filename>./services/monitoring/do-agent.nix</filename> - </para> - </listitem> - <listitem> - <para> - <filename>./services/monitoring/prometheus/xmpp-alerts.nix</filename> - </para> - </listitem> - <listitem> - <para> - <filename>./services/network-filesystems/orangefs/server.nix</filename> - </para> - </listitem> - <listitem> - <para> - <filename>./services/network-filesystems/orangefs/client.nix</filename> - </para> - </listitem> - <listitem> - <para> - <filename>./services/networking/3proxy.nix</filename> - </para> - </listitem> - <listitem> - <para> - <filename>./services/networking/corerad.nix</filename> - </para> - </listitem> - <listitem> - <para> - <filename>./services/networking/go-shadowsocks2.nix</filename> - </para> - </listitem> - <listitem> - <para> - <filename>./services/networking/ntp/openntpd.nix</filename> - </para> - </listitem> - <listitem> - <para> - <filename>./services/networking/shorewall.nix</filename> - </para> - </listitem> - <listitem> - <para> - <filename>./services/networking/shorewall6.nix</filename> - </para> - </listitem> - <listitem> - <para> - <filename>./services/networking/spacecookie.nix</filename> - </para> - </listitem> - <listitem> - <para> - <filename>./services/networking/trickster.nix</filename> - </para> - </listitem> - <listitem> - <para> - <filename>./services/networking/v2ray.nix</filename> - </para> - </listitem> - <listitem> - <para> - <filename>./services/networking/xandikos.nix</filename> - </para> - </listitem> - <listitem> - <para> - <filename>./services/networking/yggdrasil.nix</filename> - </para> - </listitem> - <listitem> - <para> - <filename>./services/web-apps/dokuwiki.nix</filename> - </para> - </listitem> - <listitem> - <para> - <filename>./services/web-apps/gotify-server.nix</filename> - </para> - </listitem> - <listitem> - <para> - <filename>./services/web-apps/grocy.nix</filename> - </para> - </listitem> - <listitem> - <para> - <filename>./services/web-apps/ihatemoney</filename> - </para> - </listitem> - <listitem> - <para> - <filename>./services/web-apps/moinmoin.nix</filename> - </para> - </listitem> - <listitem> - <para> - <filename>./services/web-apps/trac.nix</filename> - </para> - </listitem> - <listitem> - <para> - <filename>./services/web-apps/trilium.nix</filename> - </para> - </listitem> - <listitem> - <para> - <filename>./services/web-apps/shiori.nix</filename> - </para> - </listitem> - <listitem> - <para> - <filename>./services/web-servers/ttyd.nix</filename> - </para> - </listitem> - <listitem> - <para> - <filename>./services/x11/picom.nix</filename> - </para> - </listitem> - <listitem> - <para> - <filename>./services/x11/hardware/digimend.nix</filename> - </para> - </listitem> - <listitem> - <para> - <filename>./services/x11/imwheel.nix</filename> - </para> - </listitem> - <listitem> - <para> - <filename>./virtualisation/cri-o.nix</filename> - </para> - </listitem> - </itemizedlist> - - </section> - - <section xmlns="http://docbook.org/ns/docbook" - xmlns:xlink="http://www.w3.org/1999/xlink" - xmlns:xi="http://www.w3.org/2001/XInclude" - version="5.0" - xml:id="sec-release-20.03-incompatibilities"> - <title>Backward Incompatibilities</title> - - <para> - When upgrading from a previous release, please be aware of the following - incompatible changes: - </para> - - <itemizedlist> - <listitem> - <para> - The <package>dhcpcd</package> package <link xlink:href="https://roy.marples.name/archives/dhcpcd-discuss/0002621.html"> - does not request IPv4 addresses for tap and bridge interfaces anymore by default</link>. - In order to still get an address on a bridge interface, one has to disable - <literal>networking.useDHCP</literal> and explicitly enable - <literal>networking.interfaces.<name>.useDHCP</literal> on - every interface, that should get an address via DHCP. This way, dhcpcd - is configured in an explicit way about which interface to run on. - </para> - </listitem> - <listitem> - <para> - GnuPG is now built without support for a graphical passphrase entry - by default. Please enable the <literal>gpg-agent</literal> user service - via the NixOS option <literal>programs.gnupg.agent.enable</literal>. - Note that upstream recommends using <literal>gpg-agent</literal> and - will spawn a <literal>gpg-agent</literal> on the first invocation of - GnuPG anyway. - </para> - </listitem> - <listitem> - <para> - The <literal>dynamicHosts</literal> option has been removed from the - <link linkend="opt-networking.networkmanager.enable">NetworkManager</link> - module. Allowing (multiple) regular users to override host entries - affecting the whole system opens up a huge attack vector. - There seem to be very rare cases where this might be useful. - Consider setting system-wide host entries using - <link linkend="opt-networking.hosts">networking.hosts</link>, provide - them via the DNS server in your network, or use - <link linkend="opt-environment.etc">environment.etc</link> - to add a file into <literal>/etc/NetworkManager/dnsmasq.d</literal> - reconfiguring <literal>hostsdir</literal>. - </para> - </listitem> - <listitem> - <para> - The <literal>99-main.network</literal> file was removed. Matching all - network interfaces caused many breakages, see - <link xlink:href="https://github.com/NixOS/nixpkgs/pull/18962">#18962</link> - and <link xlink:href="https://github.com/NixOS/nixpkgs/pull/71106">#71106</link>. - </para> - <para> - We already don't support the global <link linkend="opt-networking.useDHCP">networking.useDHCP</link>, - <link linkend="opt-networking.defaultGateway">networking.defaultGateway</link> and - <link linkend="opt-networking.defaultGateway6">networking.defaultGateway6</link> options - if <link linkend="opt-networking.useNetworkd">networking.useNetworkd</link> is enabled, - but direct users to configure the per-device - <link linkend="opt-networking.interfaces">networking.interfaces.<name>.…</link> options. - </para> - </listitem> - <listitem> - <para> - The stdenv now runs all bash with <literal>set -u</literal>, to catch the use of undefined variables. - Before, it itself used <literal>set -u</literal> but was careful to unset it so other packages' code ran as before. - Now, all bash code is held to the same high standard, and the rather complex stateful manipulation of the options can be discarded. - </para> - </listitem> - <listitem> - <para> - The SLIM Display Manager has been removed, as it has been unmaintained since 2013. - Consider migrating to a different display manager such as LightDM (current default in NixOS), - SDDM, GDM, or using the startx module which uses Xinitrc. - </para> - </listitem> - <listitem> - <para> - The Way Cooler wayland compositor has been removed, as the project has been officially canceled. - There are no more <literal>way-cooler</literal> attribute and <literal>programs.way-cooler</literal> options. - </para> - </listitem> - <listitem> - <para> - The BEAM package set has been deleted. You will only find there the different interpreters. - You should now use the different build tools coming with the languages with sandbox mode disabled. - </para> - </listitem> - <listitem> - <para> - There is now only one Xfce package-set and module. This means that attributes <literal>xfce4-14</literal> - and <literal>xfceUnstable</literal> all now point to the latest Xfce 4.14 - packages. And in the future NixOS releases will be the latest released version of Xfce available at the - time of the release's development (if viable). - </para> - </listitem> - <listitem> - <para> - The <link linkend="opt-services.phpfpm.pools">phpfpm</link> module now sets - <literal>PrivateTmp=true</literal> in its systemd units for better process isolation. - If you rely on <literal>/tmp</literal> being shared with other services, explicitly override this by - setting <literal>serviceConfig.PrivateTmp</literal> to <literal>false</literal> for each phpfpm unit. - </para> - </listitem> - <listitem> - <para> - KDE’s old multimedia framework Phonon no longer supports Qt 4. For that reason, Plasma desktop also does not have <option>enableQt4Support</option> option any more. - </para> - </listitem> - <listitem> - <para> - The BeeGFS module has been removed. - </para> - </listitem> - <listitem> - <para> - The osquery module has been removed. - </para> - </listitem> - <listitem> - <para> - Going forward, <literal>~/bin</literal> in the users home directory will no longer be in <literal>PATH</literal> by default. - If you depend on this you should set the option <literal>environment.homeBinInPath</literal> to <literal>true</literal>. - The aforementioned option was added this release. - </para> - </listitem> - <listitem> - <para> - The <literal>buildRustCrate</literal> infrastructure now produces <literal>lib</literal> outputs in addition to the <literal>out</literal> output. - This has led to drastically reduced closure sizes for some rust crates since development dependencies are now in the <literal>lib</literal> output. - </para> - </listitem> - <listitem> - <para> - Pango was upgraded to 1.44, which no longer uses freetype for font loading. This means that type1 - and bitmap fonts are no longer supported in applications relying on Pango for font rendering - (notably, GTK application). See <link xlink:href="https://gitlab.gnome.org/GNOME/pango/issues/386"> - upstream issue</link> for more information. - </para> - </listitem> - <listitem> - <para> - The <literal>roundcube</literal> module has been hardened. - <itemizedlist> - <listitem> - <para> - The password of the database is not written world readable in the store any more. If <literal>database.host</literal> is set to <literal>localhost</literal>, then a unix user of the same name as the database will be created and PostreSQL peer authentication will be used, removing the need for a password. Otherwise, a password is still needed and can be provided with the new option <literal>database.passwordFile</literal>, which should be set to the path of a file containing the password and readable by the user <literal>nginx</literal> only. The <literal>database.password</literal> option is insecure and deprecated. Usage of this option will print a warning. - </para> - </listitem> - <listitem> - <para> - A random <literal>des_key</literal> is set by default in the configuration of roundcube, instead of using the hardcoded and insecure default. To ensure a clean migration, all users will be logged out when you upgrade to this release. - </para> - </listitem> - </itemizedlist> - </para> - </listitem> - <listitem> - <para> - The packages <literal>openobex</literal> and <literal>obexftp</literal> - are no longer installed when enabling Bluetooth via - <option>hardware.bluetooth.enable</option>. - </para> - </listitem> - <listitem> - <para> - The <literal>dump1090</literal> derivation has been changed to use FlightAware's dump1090 - as its upstream. However, this version does not have an internal webserver anymore. The - assets in the <literal>share/dump1090</literal> directory of the derivation can be used - in conjunction with an external webserver to replace this functionality. - </para> - </listitem> - <listitem> - <para> - The fourStore and fourStoreEndpoint modules have been removed. - </para> - </listitem> - <listitem> - <para> - Polkit no longer has the user of uid 0 (root) as an admin identity. - We now follow the upstream default of only having every member of the wheel - group admin privileged. Before it was root and members of wheel. - The positive outcome of this is pkexec GUI popups or terminal prompts - will no longer require the user to choose between two essentially equivalent - choices (whether to perform the action as themselves with wheel permissions, or as the root user). - </para> - </listitem> - <listitem> - <para> - NixOS containers no longer build NixOS manual by default. This saves evaluation time, - especially if there are many declarative containers defined. Note that this is already done - when <literal><nixos/modules/profiles/minimal.nix></literal> module is included - in container config. - </para> - </listitem> - <listitem> - <para> - The <literal>kresd</literal> services deprecates the <literal>interfaces</literal> option - in favor of the <literal>listenPlain</literal> option which requires full - <link xlink:href="https://www.freedesktop.org/software/systemd/man/systemd.socket.html#ListenStream=">systemd.socket compatible</link> - declaration which always include a port. - </para> - </listitem> - <listitem> - <para> - Virtual console options have been reorganized and can be found under - a single top-level attribute: <literal>console</literal>. - The full set of changes is as follows: - </para> - <itemizedlist> - <listitem> - <para> - <literal>i18n.consoleFont</literal> renamed to - <link linkend="opt-console.font">console.font</link> - </para> - </listitem> - <listitem> - <para> - <literal>i18n.consoleKeyMap</literal> renamed to - <link linkend="opt-console.keyMap">console.keyMap</link> - </para> - </listitem> - <listitem> - <para> - <literal>i18n.consoleColors</literal> renamed to - <link linkend="opt-console.colors">console.colors</link> - </para> - </listitem> - <listitem> - <para> - <literal>i18n.consolePackages</literal> renamed to - <link linkend="opt-console.packages">console.packages</link> - </para> - </listitem> - <listitem> - <para> - <literal>i18n.consoleUseXkbConfig</literal> renamed to - <link linkend="opt-console.useXkbConfig">console.useXkbConfig</link> - </para> - </listitem> - <listitem> - <para> - <literal>boot.earlyVconsoleSetup</literal> renamed to - <link linkend="opt-console.earlySetup">console.earlySetup</link> - </para> - </listitem> - <listitem> - <para> - <literal>boot.extraTTYs</literal> renamed to - <literal>console.extraTTYs</literal>. - </para> - </listitem> - </itemizedlist> - </listitem> - <listitem> - <para> - The <link linkend="opt-services.awstats.enable">awstats</link> module has been rewritten - to serve stats via static html pages, updated on a timer, over <link linkend="opt-services.nginx.virtualHosts">nginx</link>, - instead of dynamic cgi pages over <link linkend="opt-services.httpd.enable">apache</link>. - </para> - <para> - Minor changes will be required to migrate existing configurations. Details of the - required changes can seen by looking through the <link linkend="opt-services.awstats.enable">awstats</link> - module. - </para> - </listitem> - <listitem> - <para> - The httpd module no longer provides options to support serving web content without defining a virtual host. As a - result of this the <link linkend="opt-services.httpd.logPerVirtualHost">services.httpd.logPerVirtualHost</link> - option now defaults to <literal>true</literal> instead of <literal>false</literal>. Please update your - configuration to make use of <link linkend="opt-services.httpd.virtualHosts">services.httpd.virtualHosts</link>. - </para> - <para> - The <link linkend="opt-services.httpd.virtualHosts">services.httpd.virtualHosts.<name></link> - option has changed type from a list of submodules to an attribute set of submodules, better matching - <link linkend="opt-services.nginx.virtualHosts">services.nginx.virtualHosts.<name></link>. - </para> - <para> - This change comes with the addition of the following options which mimic the functionality of their <literal>nginx</literal> counterparts: - <link linkend="opt-services.httpd.virtualHosts">services.httpd.virtualHosts.<name>.addSSL</link>, - <link linkend="opt-services.httpd.virtualHosts">services.httpd.virtualHosts.<name>.forceSSL</link>, - <link linkend="opt-services.httpd.virtualHosts">services.httpd.virtualHosts.<name>.onlySSL</link>, - <link linkend="opt-services.httpd.virtualHosts">services.httpd.virtualHosts.<name>.enableACME</link>, - <link linkend="opt-services.httpd.virtualHosts">services.httpd.virtualHosts.<name>.acmeRoot</link>, and - <link linkend="opt-services.httpd.virtualHosts">services.httpd.virtualHosts.<name>.useACMEHost</link>. - </para> - </listitem> - <listitem> - <para> - For NixOS configuration options, the <literal>loaOf</literal> type has - been deprecated and will be removed in a future release. In nixpkgs, - options of this type will be changed to <literal>attrsOf</literal> - instead. If you were using one of these in your configuration, you will - see a warning suggesting what changes will be required. - </para> - <para> - For example, <link linkend="opt-users.users">users.users</link> is a - <literal>loaOf</literal> option that is commonly used as follows: - <programlisting> -users.users = - [ { name = "me"; - description = "My personal user."; - isNormalUser = true; - } - ]; - </programlisting> - This should be rewritten by removing the list and using the - value of <literal>name</literal> as the name of the attribute set: - <programlisting> -users.users.me = - { description = "My personal user."; - isNormalUser = true; - }; - </programlisting> - </para> - <para> - For more information on this change have look at these links: - <link xlink:href="https://github.com/NixOS/nixpkgs/issues/1800">issue #1800</link>, - <link xlink:href="https://github.com/NixOS/nixpkgs/pull/63103">PR #63103</link>. - </para> - </listitem> - <listitem> - <para> - For NixOS modules, the types <literal>types.submodule</literal> and <literal>types.submoduleWith</literal> now support - paths as allowed values, similar to how <literal>imports</literal> supports paths. - Because of this, if you have a module that defines an option of type - <literal>either (submodule ...) path</literal>, it will break since a path - is now treated as the first type instead of the second. To fix this, change - the type to <literal>either path (submodule ...)</literal>. - </para> - </listitem> - <listitem> - <para> - The <link linkend="opt-services.buildkite-agents">Buildkite - Agent</link> module and corresponding packages have been updated to - 3.x, and to support multiple instances of the agent running at the - same time. This means you will have to rename - <literal>services.buildkite-agent</literal> to - <literal>services.buildkite-agents.<name></literal>. Furthermore, - the following options have been changed: - </para> - <itemizedlist> - <listitem> - <para> - <literal>services.buildkite-agent.meta-data</literal> has been renamed to - <link linkend="opt-services.buildkite-agents">services.buildkite-agents.<name>.tags</link>, - to match upstreams naming for 3.x. - Its type has also changed - it now accepts an attrset of strings. - </para> - </listitem> - <listitem> - <para> - The<literal>services.buildkite-agent.openssh.publicKeyPath</literal> option - has been removed, as it's not necessary to deploy public keys to clone private - repositories. - </para> - </listitem> - <listitem> - <para> - <literal>services.buildkite-agent.openssh.privateKeyPath</literal> - has been renamed to - <link linkend="opt-services.buildkite-agents">buildkite-agents.<name>.privateSshKeyPath</link>, - as the whole <literal>openssh</literal> now only contained that single option. - </para> - </listitem> - <listitem> - <para> - <link linkend="opt-services.buildkite-agents">services.buildkite-agents.<name>.shell</link> - has been introduced, allowing to specify a custom shell to be used. - </para> - </listitem> - </itemizedlist> - </listitem> - <listitem> - <para> - The <literal>citrix_workspace_19_3_0</literal> package has been removed as - it will be EOLed within the lifespan of 20.03. For further information, - please refer to the <link xlink:href="https://www.citrix.com/de-de/support/product-lifecycle/milestones/receiver.html">support and maintenance information</link> from upstream. - </para> - </listitem> - <listitem> - <para> - The <literal>gcc5</literal> and <literal>gfortran5</literal> packages have been removed. - </para> - </listitem> - <listitem> - <para> - The <option>services.xserver.displayManager.auto</option> module has been removed. - It was only intended for use in internal NixOS tests, and gave the false impression - of it being a special display manager when it's actually LightDM. - Please use the <option>services.xserver.displayManager.lightdm.autoLogin</option> options instead, - or any other display manager in NixOS as they all support auto-login. If you used this module specifically - because it permitted root auto-login you can override the lightdm-autologin pam module like: -<programlisting> -<link xlink:href="#opt-security.pam.services._name_.text">security.pam.services.lightdm-autologin.text</link> = lib.mkForce '' - auth requisite pam_nologin.so - auth required pam_succeed_if.so quiet - auth required pam_permit.so - - account include lightdm - - password include lightdm - - session include lightdm -''; -</programlisting> - The difference is the: -<programlisting> -auth required pam_succeed_if.so quiet -</programlisting> - line, where default it's: -<programlisting> -auth required pam_succeed_if.so uid >= 1000 quiet -</programlisting> - not permitting users with uid's below 1000 (like root). - All other display managers in NixOS are configured like this. - </para> - </listitem> - <listitem> - <para> - There have been lots of improvements to the Mailman module. As - a result, - </para> - <itemizedlist> - <listitem> - <para> - The <option>services.mailman.hyperkittyBaseUrl</option> - option has been renamed to <xref - linkend="opt-services.mailman.hyperkitty.baseUrl"/>. - </para> - </listitem> - <listitem> - <para> - The <option>services.mailman.hyperkittyApiKey</option> - option has been removed. This is because having an option - for the Hyperkitty API key meant that the API key would be - stored in the world-readable Nix store, which was a - security vulnerability. A new Hyperkitty API key will be - generated the first time the new Hyperkitty service is run, - and it will then be persisted outside of the Nix store. To - continue using Hyperkitty, you must set <xref - linkend="opt-services.mailman.hyperkitty.enable"/> to - <literal>true</literal>. - </para> - </listitem> - <listitem> - <para> - Additionally, some Postfix configuration must now be set - manually instead of automatically by the Mailman module: -<programlisting> -<xref linkend="opt-services.postfix.relayDomains"/> = [ "hash:/var/lib/mailman/data/postfix_domains" ]; -<xref linkend="opt-services.postfix.config"/>.transport_maps = [ "hash:/var/lib/mailman/data/postfix_lmtp" ]; -<xref linkend="opt-services.postfix.config"/>.local_recipient_maps = [ "hash:/var/lib/mailman/data/postfix_lmtp" ]; -</programlisting> - This is because some users may want to include other values - in these lists as well, and this was not possible if they - were set automatically by the Mailman module. It would not - have been possible to just concatenate values from multiple - modules each setting the values they needed, because the - order of elements in the list is significant. - </para> - </listitem> - </itemizedlist> - </listitem> - <listitem> - <para>The LLVM versions 3.5, 3.9 and 4 (including the corresponding CLang versions) have been dropped.</para> - </listitem> - <listitem> - <para> - The <option>networking.interfaces.*.preferTempAddress</option> option has - been replaced by <option>networking.interfaces.*.tempAddress</option>. - The new option allows better control of the IPv6 temporary addresses, - including completely disabling them for interfaces where they are not - needed. - </para> - </listitem> - <listitem> - <para> - Rspamd was updated to version 2.2. Read - <link xlink:href="https://rspamd.com/doc/migration.html#migration-to-rspamd-20"> - the upstream migration notes</link> carefully. Please be especially - aware that some modules were removed and the default Bayes backend is - now Redis. - </para> - </listitem> - <listitem> - <para> - The <literal>*psu</literal> versions of <package>oraclejdk8</package> have been removed - as they aren't provided by upstream anymore. - </para> - </listitem> - <listitem> - <para> - The <option>services.dnscrypt-proxy</option> module has been removed - as it used the deprecated version of dnscrypt-proxy. We've added - <xref linkend="opt-services.dnscrypt-proxy2.enable"/> to use the supported version. - This module supports configuration via the Nix attribute set - <xref linkend="opt-services.dnscrypt-proxy2.settings" />, or by passing a TOML configuration file via - <xref linkend="opt-services.dnscrypt-proxy2.configFile" />. -<programlisting> -# Example configuration: -services.dnscrypt-proxy2.enable = true; -services.dnscrypt-proxy2.settings = { - listen_addresses = [ "127.0.0.1:43" ]; - sources.public-resolvers = { - urls = [ "https://download.dnscrypt.info/resolvers-list/v2/public-resolvers.md" ]; - cache_file = "public-resolvers.md"; - minisign_key = "RWQf6LRCGA9i53mlYecO4IzT51TGPpvWucNSCh1CBM0QTaLn73Y7GFO3"; - refresh_delay = 72; - }; -}; - -services.dnsmasq.enable = true; -services.dnsmasq.servers = [ "127.0.0.1#43" ]; -</programlisting> - </para> - </listitem> - <listitem> - <para> - <literal>qesteidutil</literal> has been deprecated in favor of <literal>qdigidoc</literal>. - </para> - </listitem> - <listitem> - <para> - <package>sqldeveloper_18</package> has been removed as it's not maintained anymore, - <package>sqldeveloper</package> has been updated to version <literal>19.4</literal>. - Please note that this means that this means that the <package>oraclejdk</package> is now - required. For further information please read the - <link xlink:href="https://www.oracle.com/technetwork/developer-tools/sql-developer/downloads/sqldev-relnotes-194-5908846.html">release notes</link>. - </para> - </listitem> - <listitem> - <para> - Haskell <varname>env</varname> and <varname>shellFor</varname> dev shell environments now organize dependencies the same way as regular builds. - In particular, rather than receiving all the different lists of dependencies mashed together as one big list, and then partitioning into Haskell and non-Hakell dependencies, they work from the original many different dependency parameters and don't need to algorithmically partition anything. - </para> - <para> - This means that if you incorrectly categorize a dependency, e.g. non-Haskell library dependency as a <varname>buildDepends</varname> or run-time Haskell dependency as a <varname>setupDepends</varname>, whereas things would have worked before they may not work now. - </para> - </listitem> - <listitem> - <para> - The <package>gcc-snapshot</package>-package has been removed. It's marked as broken for >2 years and used to point - to a fairly old snapshot from the <package>gcc7</package>-branch. - </para> - </listitem> - <listitem> - <para> - The <citerefentry><refentrytitle>nixos-build-vms</refentrytitle><manvolnum>8</manvolnum> - </citerefentry>-script now uses the python test-driver. - </para> - </listitem> - <listitem> - <para> - The <package>riot-web</package> package now accepts configuration overrides as an attribute set instead of a string. - A formerly used JSON configuration can be converted to an attribute set with <literal>builtins.fromJSON</literal>. - </para> - <para> - The new default configuration also disables automatic guest account registration and analytics to improve privacy. - The previous behavior can be restored by setting <literal>config.riot-web.conf = { disable_guests = false; piwik = true; }</literal>. - </para> - </listitem> - <listitem> - <para> - Stand-alone usage of <literal>Upower</literal> now requires - <option>services.upower.enable</option> instead of just installing into - <xref linkend="opt-environment.systemPackages"/>. - </para> - </listitem> - <listitem> - <para> - <package>nextcloud</package> has been updated to <literal>v18.0.2</literal>. This means - that users from NixOS 19.09 can't upgrade directly since you can only move one version - forward and 19.09 uses <literal>v16.0.8</literal>. - </para> - <para> - To provide a safe upgrade-path and to circumvent similar issues in the future, the following - measures were taken: - <itemizedlist> - <listitem> - <para> - The <package>pkgs.nextcloud</package>-attribute has been removed and replaced with - versioned attributes (currently <package>pkgs.nextcloud17</package> and - <package>pkgs.nextcloud18</package>). With this change major-releases can be backported - without breaking stuff and to make upgrade-paths easier. - </para> - </listitem> - <listitem> - <para> - Existing setups will be detected using - <link linkend="opt-system.stateVersion">system.stateVersion</link>: by default, - <package>nextcloud17</package> will be used, but will raise a warning which notes - that after that deploy it's recommended to update to the latest stable version - (<package>nextcloud18</package>) by declaring the newly introduced setting - <link linkend="opt-services.nextcloud.package">services.nextcloud.package</link>. - </para> - </listitem> - <listitem> - <para> - Users with an overlay (e.g. to use <package>nextcloud</package> at version - <literal>v18</literal> on <literal>19.09</literal>) will get an evaluation error - by default. This is done to ensure that our - <link linkend="opt-services.nextcloud.package">package</link>-option doesn't select an - older version by accident. It's recommended to use <package>pkgs.nextcloud18</package> - or to set <link linkend="opt-services.nextcloud.package">package</link> to - <package>pkgs.nextcloud</package> explicitly. - </para> - </listitem> - </itemizedlist> - </para> - <warning> - <para> - Please note that if you're coming from <literal>19.03</literal> or older, you have - to manually upgrade to <literal>19.09</literal> first to upgrade your server - to Nextcloud v16. - </para> - </warning> - </listitem> - <listitem> - <para> - <package>Hydra</package> has gained a massive performance improvement due to - <link xlink:href="https://github.com/NixOS/hydra/pull/710">some database schema - changes</link> by adding several IDs and better indexing. However, it's necessary - to upgrade Hydra in multiple steps: - <itemizedlist> - <listitem> - <para> - At first, an older version of Hydra needs to be deployed which adds those - (nullable) columns. When having set <link linkend="opt-system.stateVersion">stateVersion - </link> to a value older than <literal>20.03</literal>, this package will be selected - by default from the module when upgrading. Otherwise, the package can be deployed using - the following config: -<programlisting>{ pkgs, ... }: { - <link linkend="opt-services.hydra.package">services.hydra.package</link> = pkgs.hydra-migration; -}</programlisting> - </para> - </listitem> - <listitem> - <para> - Automatically fill the newly added ID columns on the server by running the following - command: -<screen> -<prompt>$ </prompt>hydra-backfill-ids -</screen> - <warning> - <para>Please note that this process can take a while depending on your database-size!</para> - </warning> - </para> - </listitem> - <listitem> - <para> - Deploy a newer version of Hydra to activate the DB optimizations. This can be done by - using <package>hydra-unstable</package>. This package already includes - <link xlink:href="https://github.com/nixos/rfcs/pull/49">flake-support</link> and is - therefore compiled against <package>pkgs.nixFlakes</package>. - <warning> - <para> - If your <link linkend="opt-system.stateVersion">stateVersion</link> is set to - <literal>20.03</literal> or greater, <package>hydra-unstable</package> will be used - automatically! This will break your setup if you didn't run the migration. - </para> - </warning> - Please note that Hydra is currently not available with <package>nixStable</package> - as this doesn't compile anymore. - </para> - </listitem> - </itemizedlist> - <warning> - <para> - <package>pkgs.hydra</package> has been removed to ensure a graceful database-migration - using the dedicated package-attributes. If you still have <package>pkgs.hydra</package> - defined in e.g. an overlay, an assertion error will be thrown. To circumvent this, - you need to set <xref linkend="opt-services.hydra.package" /> to <package>pkgs.hydra</package> - explicitly and make sure you know what you're doing! - </para> - </warning> - </para> - </listitem> - <listitem> - <para> - The TokuDB storage engine will be disabled in <package>mariadb</package> 10.5. It is recommended to switch - to RocksDB. See also <link xlink:href="https://mariadb.com/kb/en/tokudb/">TokuDB</link>. - </para> - </listitem> - </itemizedlist> - </section> - - <section xmlns="http://docbook.org/ns/docbook" - xmlns:xlink="http://www.w3.org/1999/xlink" - xmlns:xi="http://www.w3.org/2001/XInclude" - version="5.0" - xml:id="sec-release-20.03-notable-changes"> - <title>Other Notable Changes</title> - - <itemizedlist> - <listitem> - <para>SD images are now compressed by default using <literal>bzip2</literal>.</para> - </listitem> - <listitem> - <para> - The nginx web server previously started its master process as root - privileged, then ran worker processes as a less privileged identity user - (the <literal>nginx</literal> user). - This was changed to start all of nginx as a less privileged user (defined by - <literal>services.nginx.user</literal> and - <literal>services.nginx.group</literal>). As a consequence, all files that - are needed for nginx to run (included configuration fragments, SSL - certificates and keys, etc.) must now be readable by this less privileged - user/group. - </para> - <para> - To continue to use the old approach, you can configure: - <programlisting> -services.nginx.appendConfig = let cfg = config.services.nginx; in ''user ${cfg.user} ${cfg.group};''; -systemd.services.nginx.serviceConfig.User = lib.mkForce "root"; - </programlisting> - </para> - </listitem> - <listitem> - <para> - OpenSSH has been upgraded from 7.9 to 8.1, improving security and adding features - but with potential incompatibilities. Consult the - <link xlink:href="https://www.openssh.com/txt/release-8.1"> - release announcement</link> for more information. - </para> - </listitem> - <listitem> - <para> - <literal>PRETTY_NAME</literal> in <literal>/etc/os-release</literal> - now uses the short rather than full version string. - </para> - </listitem> - <listitem> - <para> - The ACME module has switched from simp-le to <link xlink:href="https://github.com/go-acme/lego">lego</link> - which allows us to support DNS-01 challenges and wildcard certificates. The following options have been added: - <link linkend="opt-security.acme.acceptTerms">security.acme.acceptTerms</link>, - <link linkend="opt-security.acme.certs">security.acme.certs.<name>.dnsProvider</link>, - <link linkend="opt-security.acme.certs">security.acme.certs.<name>.credentialsFile</link>, - <link linkend="opt-security.acme.certs">security.acme.certs.<name>.dnsPropagationCheck</link>. - As well as this, the options <literal>security.acme.acceptTerms</literal> and either - <literal>security.acme.email</literal> or <literal>security.acme.certs.<name>.email</literal> - must be set in order to use the ACME module. - Certificates will be regenerated on activation, no account or certificate will be migrated from simp-le. - In particular private keys will not be preserved. However, the credentials for simp-le are preserved and - thus it is possible to roll back to previous versions without breaking certificate generation. - Note also that in contrary to simp-le a new private key is recreated at each renewal by default, which can - have consequences if you embed your public key in apps. - </para> - </listitem> - <listitem> - <para> - It is now possible to unlock LUKS-Encrypted file systems using a FIDO2 token - via <option>boot.initrd.luks.fido2Support</option>. - </para> - </listitem> - <listitem> - <para> - Predictably named network interfaces get renamed in stage-1. This means that it is possible - to use the proper interface name for e.g. Dropbear setups. - </para> - <para> - For further reference, please read <link xlink:href="https://github.com/NixOS/nixpkgs/pull/68953">#68953</link> or the corresponding <link xlink:href="https://discourse.nixos.org/t/predictable-network-interface-names-in-initrd/4055">discourse thread</link>. - </para> - </listitem> - <listitem> - <para> - The <package>matrix-synapse</package>-package has been updated to - <link xlink:href="https://github.com/matrix-org/synapse/releases/tag/v1.11.1">v1.11.1</link>. - Due to <link xlink:href="https://github.com/matrix-org/synapse/releases/tag/v1.10.0rc1">stricter requirements</link> - for database configuration when using <package>postgresql</package>, the automated database setup - of the module has been removed to avoid any further edge-cases. - </para> - <para> - <package>matrix-synapse</package> expects <literal>postgresql</literal>-databases to have the options - <literal>LC_COLLATE</literal> and <literal>LC_CTYPE</literal> set to - <link xlink:href="https://www.postgresql.org/docs/12/locale.html"><literal>'C'</literal></link> which basically - instructs <literal>postgresql</literal> to ignore any locale-based preferences. - </para> - <para> - Depending on your setup, you need to incorporate one of the following changes in your setup to - upgrade to 20.03: - <itemizedlist> - <listitem><para>If you use <literal>sqlite3</literal> you don't need to do anything.</para></listitem> - <listitem><para>If you use <literal>postgresql</literal> on a different server, you don't need - to change anything as well since this module was never designed to configure remote databases. - </para></listitem> - <listitem><para>If you use <literal>postgresql</literal> and configured your synapse initially on - <literal>19.09</literal> or older, you simply need to enable <package>postgresql</package>-support - explicitly: -<programlisting>{ ... }: { - services.matrix-synapse = { - <link linkend="opt-services.matrix-synapse.enable">enable</link> = true; - /* and all the other config you've defined here */ - }; - <link linkend="opt-services.postgresql.enable">services.postgresql.enable</link> = true; -}</programlisting> - </para></listitem> - <listitem><para>If you deploy a fresh <package>matrix-synapse</package>, you need to configure - the database yourself (e.g. by using the - <link linkend="opt-services.postgresql.initialScript">services.postgresql.initialScript</link> - option). An example for this can be found in the - <link linkend="module-services-matrix">documentation of the Matrix module</link>. - </para></listitem> - <listitem><para>If you initially deployed your <package>matrix-synapse</package> on - <literal>nixos-unstable</literal> <emphasis>after</emphasis> the <literal>19.09</literal>-release, - your database is misconfigured due to a regression in NixOS. For now, <package>matrix-synapse</package> will - startup with a warning, but it's recommended to reconfigure the database to set the values - <literal>LC_COLLATE</literal> and <literal>LC_CTYPE</literal> to - <link xlink:href="https://www.postgresql.org/docs/12/locale.html"><literal>'C'</literal></link>. - </para></listitem> - </itemizedlist> - </para> - </listitem> - <listitem> - <para> - The <link linkend="opt-systemd.network.links">systemd.network.links</link> option is now respected - even when <link linkend="opt-systemd.network.enable">systemd-networkd</link> is disabled. - This mirrors the behaviour of systemd - It's udev that parses <literal>.link</literal> files, - not <command>systemd-networkd</command>. - </para> - </listitem> - <listitem> - <para> - <package>mongodb</package> has been updated to version <literal>3.4.24</literal>. - <warning> - <para> - Please note that <package>mongodb</package> has been relicensed under their own - <link xlink:href="https://www.mongodb.com/licensing/server-side-public-license/faq"><literal> - sspl</literal></link>-license. Since it's not entirely free and not OSI-approved, - it's listed as non-free. This means that Hydra doesn't provide prebuilt - <package>mongodb</package>-packages and needs to be built locally. - </para> - </warning> - </para> - </listitem> - </itemizedlist> - </section> -</section> diff --git a/nixos/doc/manual/release-notes/rl-2009.section.md b/nixos/doc/manual/release-notes/rl-2009.section.md new file mode 100644 index 00000000000..48059ab07f5 --- /dev/null +++ b/nixos/doc/manual/release-notes/rl-2009.section.md @@ -0,0 +1,745 @@ +# Release 20.09 ("Nightingale", 2020.10/27) {#sec-release-20.09} + +Support is planned until the end of June 2021, handing over to 21.05. (Plans [ have shifted](https://github.com/NixOS/rfcs/blob/master/rfcs/0080-nixos-release-schedule.md#core-changes) by two months since release of 20.09.) + +## Highlights {#sec-release-20.09-highlights} + +In addition to 7349 new, 14442 updated, and 8181 removed packages, this release has the following highlights: + +- Core version changes: + + - gcc: 9.2.0 -\> 9.3.0 + + - glibc: 2.30 -\> 2.31 + + - linux: still defaults to 5.4.x, all supported kernels available + + - mesa: 19.3.5 -\> 20.1.7 + +- Desktop Environments: + + - plasma5: 5.17.5 -\> 5.18.5 + + - kdeApplications: 19.12.3 -\> 20.08.1 + + - gnome3: 3.34 -\> 3.36, see its [release notes](https://help.gnome.org/misc/release-notes/3.36/) + + - cinnamon: added at 4.6 + + - NixOS now distributes an official [GNOME ISO](https://nixos.org/download.html#nixos-iso) + +- Programming Languages and Frameworks: + + - Agda ecosystem was heavily reworked (see more details below) + + - PHP now defaults to PHP 7.4, updated from 7.3 + + - PHP 7.2 is no longer supported due to upstream not supporting this version for the entire lifecycle of the 20.09 release + + - Python 3 now defaults to Python 3.8 instead of 3.7 + + - Python 3.5 reached its upstream EOL at the end of September 2020: it has been removed from the list of available packages + +- Databases and Service Monitoring: + + - MariaDB has been updated to 10.4, MariaDB Galera to 26.4. Please read the related upgrade instructions under [backwards incompatibilities](#sec-release-20.09-incompatibilities) before upgrading. + + - Zabbix now defaults to 5.0, updated from 4.4. Please read related sections under [backwards compatibilities](#sec-release-20.09-incompatibilities) before upgrading. + +- Major module changes: + + - Quickly configure a complete, private, self-hosted video conferencing solution with the new Jitsi Meet module. + + - Two new options, [authorizedKeysCommand](options.html#opt-services.openssh.authorizedKeysCommand) and [authorizedKeysCommandUser](options.html#opt-services.openssh.authorizedKeysCommandUser), have been added to the `openssh` module. If you have `AuthorizedKeysCommand` in your [services.openssh.extraConfig](options.html#opt-services.openssh.extraConfig) you should make use of these new options instead. + + - There is a new module for Podman (`virtualisation.podman`), a drop-in replacement for the Docker command line. + + - The new `virtualisation.containers` module manages configuration shared by the CRI-O and Podman modules. + + - Declarative Docker containers are renamed from `docker-containers` to `virtualisation.oci-containers.containers`. This is to make it possible to use `podman` instead of `docker`. + + - The new option [documentation.man.generateCaches](options.html#opt-documentation.man.generateCaches) has been added to automatically generate the `man-db` caches, which are needed by utilities like `whatis` and `apropos`. The caches are generated during the build of the NixOS configuration: since this can be expensive when a large number of packages are installed, the feature is disabled by default. + + - `services.postfix.sslCACert` was replaced by `services.postfix.tlsTrustedAuthorities` which now defaults to system certificate authorities. + + - The various documented workarounds to use steam have been converted to a module. `programs.steam.enable` enables steam, controller support and the workarounds. + + - Support for built-in LCDs in various pieces of Logitech hardware (keyboards and USB speakers). `hardware.logitech.lcd.enable` enables support for all hardware supported by the [g15daemon project](https://sourceforge.net/projects/g15daemon/). + + - The GRUB module gained support for basic password protection, which allows to restrict non-default entries in the boot menu to one or more users. The users and passwords are defined via the option `boot.loader.grub.users`. Note: Password support is only available in GRUB version 2. + +- NixOS module changes: + + - The NixOS module system now supports freeform modules as a mix between `types.attrsOf` and `types.submodule`. These allow you to explicitly declare a subset of options while still permitting definitions without an associated option. See [](#sec-freeform-modules) for how to use them. + + - Following its deprecation in 20.03, the Perl NixOS test driver has been removed. All remaining tests have been ported to the Python test framework. Code outside nixpkgs using `make-test.nix` or `testing.nix` needs to be ported to `make-test-python.nix` and `testing-python.nix` respectively. + + - Subordinate GID and UID mappings are now set up automatically for all normal users. This will make container tools like Podman work as non-root users out of the box. + +- Starting with this release, the hydra-build-result `nixos-YY.MM` branches no longer exist in the [deprecated nixpkgs-channels repository](https://github.com/nixos/nixpkgs-channels). These branches are now in [the main nixpkgs repository](https://github.com/nixos/nixpkgs). + +## New Services {#sec-release-20.09-new-services} + +In addition to 1119 new, 118 updated, and 476 removed options; 61 new modules were added since the last release: + +- Hardware: + + - [hardware.system76.firmware-daemon.enable](options.html#opt-hardware.system76.firmware-daemon.enable) adds easy support of system76 firmware + + - [hardware.uinput.enable](options.html#opt-hardware.uinput.enable) loads uinput kernel module + + - [hardware.video.hidpi.enable](options.html#opt-hardware.video.hidpi.enable) enable good defaults for HiDPI displays + + - [hardware.wooting.enable](options.html#opt-hardware.wooting.enable) support for Wooting keyboards + + - [hardware.xpadneo.enable](options.html#opt-hardware.xpadneo.enable) xpadneo driver for Xbox One wireless controllers + +- Programs: + + - [programs.hamster.enable](options.html#opt-programs.hamster.enable) enable hamster time tracking + + - [programs.steam.enable](options.html#opt-programs.steam.enable) adds easy enablement of steam and related system configuration + +- Security: + + - [security.doas.enable](options.html#opt-security.doas.enable) alternative to sudo, allows non-root users to execute commands as root + + - [security.tpm2.enable](options.html#opt-security.tpm2.enable) add Trusted Platform Module 2 support + +- System: + + - [boot.initrd.network.openvpn.enable](options.html#opt-boot.initrd.network.openvpn.enable) start an OpenVPN client during initrd boot + +- Virtualization: + + - [boot.enableContainers](options.html#opt-boot.enableContainers) use nixos-containers + + - [virtualisation.oci-containers.containers](options.html#opt-virtualisation.oci-containers.containers) run OCI (Docker) containers + + - [virtualisation.podman.enable](options.html#opt-virtualisation.podman.enable) daemonless container engine + +- Services: + + - [services.ankisyncd.enable](options.html#opt-services.ankisyncd.enable) Anki sync server + + - [services.bazarr.enable](options.html#opt-services.bazarr.enable) Subtitle manager for Sonarr and Radarr + + - [services.biboumi.enable](options.html#opt-services.biboumi.enable) Biboumi XMPP gateway to IRC + + - [services.blockbook-frontend](options.html#opt-services.blockbook-frontend) Blockbook-frontend, a service for the Trezor wallet + + - [services.cage.enable](options.html#opt-services.cage.enable) Wayland cage service + + - [services.convos.enable](options.html#opt-services.convos.enable) IRC daemon, which can be accessed throught the browser + + - [services.engelsystem.enable](options.html#opt-services.engelsystem.enable) Tool for coordinating volunteers and shifts on large events + + - [services.espanso.enable](options.html#opt-services.espanso.enable) text-expander written in rust + + - [services.foldingathome.enable](options.html#opt-services.foldingathome.enable) Folding\@home client + + - [services.gerrit.enable](options.html#opt-services.gerrit.enable) Web-based team code collaboration tool + + - [services.go-neb.enable](options.html#opt-services.go-neb.enable) Matrix bot + + - [services.hardware.xow.enable](options.html#opt-services.hardware.xow.enable) xow as a systemd service + + - [services.hercules-ci-agent.enable](options.html#opt-services.hercules-ci-agent.enable) Hercules CI build agent + + - [services.jicofo.enable](options.html#opt-services.jicofo.enable) Jitsi Conference Focus, component of Jitsi Meet + + - [services.jirafeau.enable](options.html#opt-services.jirafeau.enable) A web file repository + + - [services.jitsi-meet.enable](options.html#opt-services.jitsi-meet.enable) Secure, simple and scalable video conferences + + - [services.jitsi-videobridge.enable](options.html#opt-services.jitsi-videobridge.enable) Jitsi Videobridge, a WebRTC compatible router + + - [services.jupyterhub.enable](options.html#opt-services.jupyterhub.enable) Jupyterhub development server + + - [services.k3s.enable](options.html#opt-services.k3s.enable) Lightweight Kubernetes distribution + + - [services.magic-wormhole-mailbox-server.enable](options.html#opt-services.magic-wormhole-mailbox-server.enable) Magic Wormhole Mailbox Server + + - [services.malcontent.enable](options.html#opt-services.malcontent.enable) Parental Control support + + - [services.matrix-appservice-discord.enable](options.html#opt-services.matrix-appservice-discord.enable) Matrix and Discord bridge + + - [services.mautrix-telegram.enable](options.html#opt-services.mautrix-telegram.enable) Matrix-Telegram puppeting/relaybot bridge + + - [services.mirakurun.enable](options.html#opt-services.mirakurun.enable) Japanese DTV Tuner Server Service + + - [services.molly-brown.enable](options.html#opt-services.molly-brown.enable) Molly-Brown Gemini server + + - [services.mullvad-vpn.enable](options.html#opt-services.mullvad-vpn.enable) Mullvad VPN daemon + + - [services.ncdns.enable](options.html#opt-services.ncdns.enable) Namecoin to DNS bridge + + - [services.nextdns.enable](options.html#opt-services.nextdns.enable) NextDNS to DoH Proxy service + + - [services.nix-store-gcs-proxy](options.html#opt-services.nix-store-gcs-proxy) Google storage bucket to be used as a nix store + + - [services.onedrive.enable](options.html#opt-services.onedrive.enable) OneDrive sync service + + - [services.pinnwand.enable](options.html#opt-services.pinnwand.enable) Pastebin-like service + + - [services.pixiecore.enable](options.html#opt-services.pixiecore.enable) Manage network booting of machines + + - [services.privacyidea.enable](options.html#opt-services.privacyidea.enable) Privacy authentication server + + - [services.quorum.enable](options.html#opt-services.quorum.enable) Quorum blockchain daemon + + - [services.robustirc-bridge.enable](options.html#opt-services.robustirc-bridge.enable) RobustIRC bridge + + - [services.rss-bridge.enable](options.html#opt-services.rss-bridge.enable) Generate RSS and Atom feeds + + - [services.rtorrent.enable](options.html#opt-services.rtorrent.enable) rTorrent service + + - [services.smartdns.enable](options.html#opt-services.smartdns.enable) SmartDNS DNS server + + - [services.sogo.enable](options.html#opt-services.sogo.enable) SOGo groupware + + - [services.teeworlds.enable](options.html#opt-services.teeworlds.enable) Teeworlds game server + + - [services.torque.mom.enable](options.html#opt-services.torque.mom.enable) torque computing node + + - [services.torque.server.enable](options.html#opt-services.torque.server.enable) torque server + + - [services.tuptime.enable](options.html#opt-services.tuptime.enable) A total uptime service + + - [services.urserver.enable](options.html#opt-services.urserver.enable) X11 remote server + + - [services.wasabibackend.enable](options.html#opt-services.wasabibackend.enable) Wasabi backend service + + - [services.yubikey-agent.enable](options.html#opt-services.yubikey-agent.enable) Yubikey agent + + - [services.zigbee2mqtt.enable](options.html#opt-services.zigbee2mqtt.enable) Zigbee to MQTT bridge + +## Backward Incompatibilities {#sec-release-20.09-incompatibilities} + +When upgrading from a previous release, please be aware of the following incompatible changes: + +- MariaDB has been updated to 10.4, MariaDB Galera to 26.4. Before you upgrade, it would be best to take a backup of your database. For MariaDB Galera Cluster, see [Upgrading from MariaDB 10.3 to MariaDB 10.4 with Galera Cluster](https://mariadb.com/kb/en/upgrading-from-mariadb-103-to-mariadb-104-with-galera-cluster/) instead. Before doing the upgrade read [Incompatible Changes Between 10.3 and 10.4](https://mariadb.com/kb/en/upgrading-from-mariadb-103-to-mariadb-104/#incompatible-changes-between-103-and-104). After the upgrade you will need to run `mysql_upgrade`. MariaDB 10.4 introduces a number of changes to the authentication process, intended to make things easier and more intuitive. See [Authentication from MariaDB 10.4](https://mariadb.com/kb/en/authentication-from-mariadb-104/). unix_socket auth plugin does not use a password, and uses the connecting user\'s UID instead. When a new MariaDB data directory is initialized, two MariaDB users are created and can be used with new unix_socket auth plugin, as well as traditional mysql_native_password plugin: root\@localhost and mysql\@localhost. To actually use the traditional mysql_native_password plugin method, one must run the following: + + ```nix + { + services.mysql.initialScript = pkgs.writeText "mariadb-init.sql" '' + ALTER USER root@localhost IDENTIFIED VIA mysql_native_password USING PASSWORD("verysecret"); + ''; + } + ``` + + When MariaDB data directory is just upgraded (not initialized), the users are not created or modified. + +- MySQL server is now started with additional systemd sandbox/hardening options for better security. The PrivateTmp, ProtectHome, and ProtectSystem options may be problematic when MySQL is attempting to read from or write to your filesystem anywhere outside of its own state directory, for example when calling `LOAD DATA INFILE or SELECT * INTO OUTFILE`. In this scenario a variant of the following may be required: - allow MySQL to read from /home and /tmp directories when using `LOAD DATA INFILE` + + ```nix + { + systemd.services.mysql.serviceConfig.ProtectHome = lib.mkForce "read-only"; + } + ``` + + \- allow MySQL to write to custom folder `/var/data` when using `SELECT * INTO OUTFILE`, assuming the mysql user has write access to `/var/data` + + ```nix + { + systemd.services.mysql.serviceConfig.ReadWritePaths = [ "/var/data" ]; + } + ``` + + The MySQL service no longer runs its `systemd` service startup script as `root` anymore. A dedicated non `root` super user account is required for operation. This means users with an existing MySQL or MariaDB database server are required to run the following SQL statements as a super admin user before upgrading: + + ```SQL + CREATE USER IF NOT EXISTS 'mysql'@'localhost' identified with unix_socket; + GRANT ALL PRIVILEGES ON *.* TO 'mysql'@'localhost' WITH GRANT OPTION; + ``` + + If you use MySQL instead of MariaDB please replace `unix_socket` with `auth_socket`. If you have changed the value of [services.mysql.user](options.html#opt-services.mysql.user) from the default of `mysql` to a different user please change `'mysql'@'localhost'` to the corresponding user instead. + +- Zabbix now defaults to 5.0, updated from 4.4. Please carefully read through [the upgrade guide](https://www.zabbix.com/documentation/current/manual/installation/upgrade/sources) and apply any changes required. Be sure to take special note of the section on [enabling extended range of numeric (float) values](https://www.zabbix.com/documentation/current/manual/installation/upgrade_notes_500#enabling_extended_range_of_numeric_float_values) as you will need to apply this database migration manually. + + If you are using Zabbix Server with a MySQL or MariaDB database you should note that using a character set of `utf8` and a collate of `utf8_bin` has become mandatory with this release. See the upstream [issue](https://support.zabbix.com/browse/ZBX-17357) for further discussion. Before upgrading you should check the character set and collation used by your database and ensure they are correct: + + ```SQL + SELECT + default_character_set_name, + default_collation_name + FROM + information_schema.schemata + WHERE + schema_name = 'zabbix'; + ``` + + If these values are not correct you should take a backup of your database and convert the character set and collation as required. Here is an [example](https://www.zabbix.com/forum/zabbix-help/396573-reinstall-after-upgrade?p=396891#post396891) of how to do so, taken from the Zabbix forums: + + ```SQL + ALTER DATABASE `zabbix` DEFAULT CHARACTER SET utf8 COLLATE utf8_bin; + + -- the following will produce a list of SQL commands you should subsequently execute + SELECT CONCAT("ALTER TABLE ", TABLE_NAME," CONVERT TO CHARACTER SET utf8 COLLATE utf8_bin;") AS ExecuteTheString + FROM information_schema.`COLUMNS` + WHERE table_schema = "zabbix" AND COLLATION_NAME = "utf8_general_ci"; + ``` + +- maxx package removed along with `services.xserver.desktopManager.maxx` module. Please migrate to cdesktopenv and `services.xserver.desktopManager.cde` module. + +- The [matrix-synapse](options.html#opt-services.matrix-synapse.enable) module no longer includes optional dependencies by default, they have to be added through the [plugins](options.html#opt-services.matrix-synapse.plugins) option. + +- `buildGoModule` now internally creates a vendor directory in the source tree for downloaded modules instead of using go\'s [module proxy protocol](https://golang.org/cmd/go/#hdr-Module_proxy_protocol). This storage format is simpler and therefore less likely to break with future versions of go. As a result `buildGoModule` switched from `modSha256` to the `vendorSha256` attribute to pin fetched version data. + +- Grafana is now built without support for phantomjs by default. Phantomjs support has been [deprecated in Grafana](https://grafana.com/docs/grafana/latest/guides/whats-new-in-v6-4/) and the phantomjs project is [currently unmaintained](https://github.com/ariya/phantomjs/issues/15344#issue-302015362). It can still be enabled by providing `phantomJsSupport = true` to the package instantiation: + + ```nix + { + services.grafana.package = pkgs.grafana.overrideAttrs (oldAttrs: rec { + phantomJsSupport = true; + }); + } + ``` + +- The [supybot](options.html#opt-services.supybot.enable) module now uses `/var/lib/supybot` as its default [stateDir](options.html#opt-services.supybot.stateDir) path if `stateVersion` is 20.09 or higher. It also enables a number of [systemd sandboxing options](https://www.freedesktop.org/software/systemd/man/systemd.exec.html#Sandboxing) which may possibly interfere with some plugins. If this is the case you can disable the options through attributes in `systemd.services.supybot.serviceConfig`. + +- The `security.duosec.skey` option, which stored a secret in the nix store, has been replaced by a new [security.duosec.secretKeyFile](options.html#opt-security.duosec.secretKeyFile) option for better security. + + `security.duosec.ikey` has been renamed to [security.duosec.integrationKey](options.html#opt-security.duosec.integrationKey). + +- `vmware` has been removed from the `services.x11.videoDrivers` defaults. For VMWare guests set `virtualisation.vmware.guest.enable` to `true` which will include the appropriate drivers. + +- The initrd SSH support now uses OpenSSH rather than Dropbear to allow the use of Ed25519 keys and other OpenSSH-specific functionality. Host keys must now be in the OpenSSH format, and at least one pre-generated key must be specified. + + If you used the `boot.initrd.network.ssh.host*Key` options, you\'ll get an error explaining how to convert your host keys and migrate to the new `boot.initrd.network.ssh.hostKeys` option. Otherwise, if you don\'t have any host keys set, you\'ll need to generate some; see the `hostKeys` option documentation for instructions. + +- Since this release there\'s an easy way to customize your PHP install to get a much smaller base PHP with only wanted extensions enabled. See the following snippet installing a smaller PHP with the extensions `imagick`, `opcache`, `pdo` and `pdo_mysql` loaded: + + ```nix + { + environment.systemPackages = [ + (pkgs.php.withExtensions + ({ all, ... }: with all; [ + imagick + opcache + pdo + pdo_mysql + ]) + ) + ]; + } + ``` + + The default `php` attribute hasn\'t lost any extensions. The `opcache` extension has been added. All upstream PHP extensions are available under php.extensions.\<name?\>. + + All PHP `config` flags have been removed for the following reasons: + +- The updated `php` attribute is now easily customizable to your liking by using `php.withExtensions` or `php.buildEnv` instead of writing config files or changing configure flags. + +- The remaining configuration flags can now be set directly on the `php` attribute. For example, instead of + + ```nix + { + php.override { + config.php.embed = true; + config.php.apxs2 = false; + } + } + ``` + + you should now write + + ```nix + { + php.override { + embedSupport = true; + apxs2Support = false; + } + } + ``` + +- The ACME module has been overhauled for simplicity and maintainability. Cert generation now implicitly uses the `acme` user, and the `security.acme.certs._name_.user` option has been removed. Instead, certificate access from other services is now managed through group permissions. The module no longer runs lego twice under certain conditions, and will correctly renew certificates if their configuration is changed. Services which reload nginx and httpd after certificate renewal are now properly configured too so you no longer have to do this manually if you are using HTTPS enabled virtual hosts. A mechanism for regenerating certs on demand has also been added and documented. + +- Gollum received a major update to version 5.x and you may have to change some links in your wiki when migrating from gollum 4.x. More information can be found [here](https://github.com/gollum/gollum/wiki/5.0-release-notes#migrating-your-wiki). + +- Deluge 2.x was added and is used as default for new NixOS installations where stateVersion is \>= 20.09. If you are upgrading from a previous NixOS version, you can set `service.deluge.package = pkgs.deluge-2_x` to upgrade to Deluge 2.x and migrate the state to the new format. Be aware that backwards state migrations are not supported by Deluge. + +- Nginx web server now starting with additional sandbox/hardening options. By default, write access to `/var/log/nginx` and `/var/cache/nginx` is allowed. To allow writing to other folders, use `systemd.services.nginx.serviceConfig.ReadWritePaths` + + ```nix + { + systemd.services.nginx.serviceConfig.ReadWritePaths = [ "/var/www" ]; + } + ``` + + Nginx is also started with the systemd option `ProtectHome = mkDefault true;` which forbids it to read anything from `/home`, `/root` and `/run/user` (see [ProtectHome docs](https://www.freedesktop.org/software/systemd/man/systemd.exec.html#ProtectHome=) for details). If you require serving files from home directories, you may choose to set e.g. + + ```nix + { + systemd.services.nginx.serviceConfig.ProtectHome = "read-only"; + } + ``` + +- The NixOS options `nesting.clone` and `nesting.children` have been deleted, and replaced with named [specialisation](options.html#opt-specialisation) configurations. + + Replace a `nesting.clone` entry with: + + ```nix + { + specialisation.example-sub-configuration = { + configuration = { + ... + }; + }; + ``` + + Replace a `nesting.children` entry with: + + ```nix + { + specialisation.example-sub-configuration = { + inheritParentConfig = false; + configuration = { + ... + }; + }; + ``` + + To switch to a specialised configuration at runtime you need to run: + + ```ShellSession + $ sudo /run/current-system/specialisation/example-sub-configuration/bin/switch-to-configuration test + ``` + + Before you would have used: + + ```ShellSession + $ sudo /run/current-system/fine-tune/child-1/bin/switch-to-configuration test + ``` + +- The Nginx log directory has been moved to `/var/log/nginx`, the cache directory to `/var/cache/nginx`. The option `services.nginx.stateDir` has been removed. + +- The httpd web server previously started its main process as root privileged, then ran worker processes as a less privileged identity user. This was changed to start all of httpd as a less privileged user (defined by [services.httpd.user](options.html#opt-services.httpd.user) and [services.httpd.group](options.html#opt-services.httpd.group)). As a consequence, all files that are needed for httpd to run (included configuration fragments, SSL certificates and keys, etc.) must now be readable by this less privileged user/group. + + The default value for [services.httpd.mpm](options.html#opt-services.httpd.mpm) has been changed from `prefork` to `event`. Along with this change the default value for [services.httpd.virtualHosts.\<name\>.http2](options.html#opt-services.httpd.virtualHosts) has been set to `true`. + +- The `systemd-networkd` option `systemd.network.networks.<name>.dhcp.CriticalConnection` has been removed following upstream systemd\'s deprecation of the same. It is recommended to use `systemd.network.networks.<name>.networkConfig.KeepConfiguration` instead. See systemd.network 5 for details. + +- The `systemd-networkd` option `systemd.network.networks._name_.dhcpConfig` has been renamed to [systemd.network.networks._name_.dhcpV4Config](options.html#opt-systemd.network.networks._name_.dhcpV4Config) following upstream systemd\'s documentation change. See systemd.network 5 for details. + +- In the `picom` module, several options that accepted floating point numbers encoded as strings (for example [services.picom.activeOpacity](options.html#opt-services.picom.activeOpacity)) have been changed to the (relatively) new native `float` type. To migrate your configuration simply remove the quotes around the numbers. + +- When using `buildBazelPackage` from Nixpkgs, `flat` hash mode is now used for dependencies instead of `recursive`. This is to better allow using hashed mirrors where needed. As a result, these hashes will have changed. + +- The syntax of the PostgreSQL configuration file is now checked at build time. If your configuration includes a file inaccessible inside the build sandbox, set `services.postgresql.checkConfig` to `false`. + +- The rkt module has been removed, it was archived by upstream. + +- The [Bazaar](https://bazaar.canonical.com) VCS is unmaintained and, as consequence of the Python 2 EOL, the packages `bazaar` and `bazaarTools` were removed. Breezy, the backward compatible fork of Bazaar (see the [announcement](https://www.jelmer.uk/breezy-intro.html)), was packaged as `breezy` and can be used instead. + + Regarding Nixpkgs, `fetchbzr`, `nix-prefetch-bzr` and Bazaar support in Hydra will continue to work through Breezy. + +- In addition to the hostname, the fully qualified domain name (FQDN), which consists of `${networking.hostName}` and `${networking.domain}` is now added to `/etc/hosts`, to allow local FQDN resolution, as used by the `hostname --fqdn` command and other applications that try to determine the FQDN. These new entries take precedence over entries from the DNS which could cause regressions in some very specific setups. Additionally the hostname is now resolved to `127.0.0.2` instead of `127.0.1.1` to be consistent with what `nss-myhostname` (from systemd) returns. The old behaviour can e.g. be restored by using `networking.hosts = lib.mkForce { "127.0.1.1" = [ config.networking.hostName ]; };`. + +- The hostname (`networking.hostName`) must now be a valid DNS label (see RFC 1035, RFC 1123) and as such must not contain the domain part. This means that the hostname must start with a letter or digit, end with a letter or digit, and have as interior characters only letters, digits, and hyphen. The maximum length is 63 characters. Additionally it is recommended to only use lower-case characters. If (e.g. for legacy reasons) a FQDN is required as the Linux kernel network node hostname (`uname --nodename`) the option `boot.kernel.sysctl."kernel.hostname"` can be used as a workaround (but be aware of the 64 character limit). + +- The GRUB specific option `boot.loader.grub.extraInitrd` has been replaced with the generic option `boot.initrd.secrets`. This option creates a secondary initrd from the specified files, rather than using a manually created initrd file. Due to an existing bug with `boot.loader.grub.extraInitrd`, it is not possible to directly boot an older generation that used that option. It is still possible to rollback to that generation if the required initrd file has not been deleted. + +- The [DNSChain](https://github.com/okTurtles/dnschain) package and NixOS module have been removed from Nixpkgs as the software is unmaintained and can\'t be built. For more information see issue [\#89205](https://github.com/NixOS/nixpkgs/issues/89205). + +- In the `resilio` module, [services.resilio.httpListenAddr](options.html#opt-services.resilio.httpListenAddr) has been changed to listen to `[::1]` instead of `0.0.0.0`. + +- `sslh` has been updated to version `1.21`. The `ssl` probe must be renamed to `tls` in [services.sslh.appendConfig](options.html#opt-services.sslh.appendConfig). + +- Users of [OpenAFS 1.6](http://openafs.org) must upgrade their services to OpenAFS 1.8! In this release, the OpenAFS package version 1.6.24 is marked broken but can be used during transition to OpenAFS 1.8.x. Use the options `services.openafsClient.packages.module`, `services.openafsClient.packages.programs` and `services.openafsServer.package` to select a different OpenAFS package. OpenAFS 1.6 will be removed in the next release. The package `openafs` and the service options will then silently point to the OpenAFS 1.8 release. + + See also the OpenAFS [Administrator Guide](http://docs.openafs.org/AdminGuide/index.html) for instructions. Beware of the following when updating servers: + + - The storage format of the server key has changed and the key must be converted before running the new release. + + - When updating multiple database servers, turn off the database servers from the highest IP down to the lowest with resting periods in between. Start up in reverse order. Do not concurrently run database servers working with different OpenAFS releases! + + - Update servers first, then clients. + +- Radicale\'s default package has changed from 2.x to 3.x. An upgrade checklist can be found [here](https://github.com/Kozea/Radicale/blob/3.0.x/NEWS.md#upgrade-checklist). You can use the newer version in the NixOS service by setting the `package` to `radicale3`, which is done automatically if `stateVersion` is 20.09 or higher. + +- `udpt` experienced a complete rewrite from C++ to rust. The configuration format changed from ini to toml. The new configuration documentation can be found at [the official website](https://naim94a.github.io/udpt/config.html) and example configuration is packaged in `${udpt}/share/udpt/udpt.toml`. + +- We now have a unified [services.xserver.displayManager.autoLogin](options.html#opt-services.xserver.displayManager.autoLogin) option interface to be used for every display-manager in NixOS. + +- The `bitcoind` module has changed to multi-instance, using submodules. Therefore, it is now mandatory to name each instance. To use this new multi-instance config with an existing bitcoind data directory and user, you have to adjust the original config, e.g.: + + ```nix + { + services.bitcoind = { + enable = true; + extraConfig = "..."; + ... + }; + } + ``` + + To something similar: + + ```nix + { + services.bitcoind.mainnet = { + enable = true; + dataDir = "/var/lib/bitcoind"; + user = "bitcoin"; + extraConfig = "..."; + ... + }; + } + ``` + + The key settings are: + + - `dataDir` - to continue using the same data directory. + + - `user` - to continue using the same user so that bitcoind maintains access to its files. + +- Graylog introduced a change in the LDAP server certificate validation behaviour for version 3.3.3 which might break existing setups. When updating Graylog from a version before 3.3.3 make sure to check the Graylog [release info](https://www.graylog.org/post/announcing-graylog-v3-3-3) for information on how to avoid the issue. + +- The `dokuwiki` module has changed to multi-instance, using submodules. Therefore, it is now mandatory to name each instance. Moreover, forcing SSL by default has been dropped, so `nginx.forceSSL` and `nginx.enableACME` are no longer set to `true`. To continue using your service with the original SSL settings, you have to adjust the original config, e.g.: + + ```nix + { + services.dokuwiki = { + enable = true; + ... + }; + } + ``` + + To something similar: + + ```nix + { + services.dokuwiki."mywiki" = { + enable = true; + nginx = { + forceSSL = true; + enableACME = true; + }; + ... + }; + } + ``` + + The base package has also been upgraded to the 2020-07-29 \"Hogfather\" release. Plugins might be incompatible or require upgrading. + +- The [services.postgresql.dataDir](options.html#opt-services.postgresql.dataDir) option is now set to `"/var/lib/postgresql/${cfg.package.psqlSchema}"` regardless of your [system.stateVersion](options.html#opt-system.stateVersion). Users with an existing postgresql install that have a [system.stateVersion](options.html#opt-system.stateVersion) of `17.03` or below should double check what the value of their [services.postgresql.dataDir](options.html#opt-services.postgresql.dataDir) option is (`/var/db/postgresql`) and then explicitly set this value to maintain compatibility: + + ```nix + { + services.postgresql.dataDir = "/var/db/postgresql"; + } + ``` + + The postgresql module now expects there to be a database super user account called `postgres` regardless of your [system.stateVersion](options.html#opt-system.stateVersion). Users with an existing postgresql install that have a [system.stateVersion](options.html#opt-system.stateVersion) of `17.03` or below should run the following SQL statements as a database super admin user before upgrading: + + ```SQL + CREATE ROLE postgres LOGIN SUPERUSER; + ``` + +- The USBGuard module now removes options and instead hardcodes values for `IPCAccessControlFiles`, `ruleFiles`, and `auditFilePath`. Audit logs can be found in the journal. + +- The NixOS module system now evaluates option definitions more strictly, allowing it to detect a larger set of problems. As a result, what previously evaluated may not do so anymore. See [the PR that changed this](https://github.com/NixOS/nixpkgs/pull/82743#issuecomment-674520472) for more info. + +- For NixOS configuration options, the type `loaOf`, after its initial deprecation in release 20.03, has been removed. In NixOS and Nixpkgs options using this type have been converted to `attrsOf`. For more information on this change have look at these links: [issue \#1800](https://github.com/NixOS/nixpkgs/issues/1800), [PR \#63103](https://github.com/NixOS/nixpkgs/pull/63103). + +- `config.systemd.services.${name}.path` now returns a list of paths instead of a colon-separated string. + +- Caddy module now uses Caddy v2 by default. Caddy v1 can still be used by setting [services.caddy.package](options.html#opt-services.caddy.package) to `pkgs.caddy1`. + + New option [services.caddy.adapter](options.html#opt-services.caddy.adapter) has been added. + +- The [jellyfin](options.html#opt-services.jellyfin.enable) module will use and stay on the Jellyfin version `10.5.5` if `stateVersion` is lower than `20.09`. This is because significant changes were made to the database schema, and it is highly recommended to backup your instance before upgrading. After making your backup, you can upgrade to the latest version either by setting your `stateVersion` to `20.09` or higher, or set the `services.jellyfin.package` to `pkgs.jellyfin`. If you do not wish to upgrade Jellyfin, but want to change your `stateVersion`, you can set the value of `services.jellyfin.package` to `pkgs.jellyfin_10_5`. + +- The `security.rngd` service is now disabled by default. This choice was made because there\'s krngd in the linux kernel space making it (for most usecases) functionally redundent. + +- The `hardware.nvidia.optimus_prime.enable` service has been renamed to `hardware.nvidia.prime.sync.enable` and has many new enhancements. Related nvidia prime settings may have also changed. + +- The package nextcloud17 has been removed and nextcloud18 was marked as insecure since both of them will [ will be EOL (end of life) within the lifetime of 20.09](https://docs.nextcloud.com/server/19/admin_manual/release_schedule.html). + + It\'s necessary to upgrade to nextcloud19: + + - From nextcloud17, you have to upgrade to nextcloud18 first as Nextcloud doesn\'t allow going multiple major revisions forward in a single upgrade. This is possible by setting [services.nextcloud.package](options.html#opt-services.nextcloud.package) to nextcloud18. + + - From nextcloud18, it\'s possible to directly upgrade to nextcloud19 by setting [services.nextcloud.package](options.html#opt-services.nextcloud.package) to nextcloud19. + +- The GNOME desktop manager no longer default installs gnome3.epiphany. It was chosen to do this as it has a usability breaking issue (see issue [\#98819](https://github.com/NixOS/nixpkgs/issues/98819)) that makes it unsuitable to be a default app. + + ::: {.note} + Issue [\#98819](https://github.com/NixOS/nixpkgs/issues/98819) is now fixed and gnome3.epiphany is once again installed by default. + ::: + +- If you want to manage the configuration of wpa_supplicant outside of NixOS you must ensure that none of [networking.wireless.networks](options.html#opt-networking.wireless.networks), [networking.wireless.extraConfig](options.html#opt-networking.wireless.extraConfig) or [networking.wireless.userControlled.enable](options.html#opt-networking.wireless.userControlled.enable) is being used or `true`. Using any of those options will cause wpa_supplicant to be started with a NixOS generated configuration file instead of your own. + +## Other Notable Changes {#sec-release-20.09-notable-changes} + +- SD images are now compressed by default using `zstd`. The compression for ISO images has also been changed to `zstd`, but ISO images are still not compressed by default. + +- `services.journald.rateLimitBurst` was updated from `1000` to `10000` to follow the new upstream systemd default. + +- The notmuch package move its emacs-related binaries and emacs lisp files to a separate output. They\'re not part of the default `out` output anymore - if you relied on the `notmuch-emacs-mua` binary or the emacs lisp files, access them via the `notmuch.emacs` output. Device tree overlay support was improved in [\#79370](https://github.com/NixOS/nixpkgs/pull/79370) and now uses [hardware.deviceTree.kernelPackage](options.html#opt-hardware.deviceTree.kernelPackage) instead of `hardware.deviceTree.base`. [hardware.deviceTree.overlays](options.html#opt-hardware.deviceTree.overlays) configuration was extended to support `.dts` files with symbols. Device trees can now be filtered by setting [hardware.deviceTree.filter](options.html#opt-hardware.deviceTree.filter) option. + +- The default output of `buildGoPackage` is now `$out` instead of `$bin`. + +- `buildGoModule` `doCheck` now defaults to `true`. + +- Packages built using `buildRustPackage` now use `release` mode for the `checkPhase` by default. + + Please note that Rust packages utilizing a custom build/install procedure (e.g. by using a `Makefile`) or test suites that rely on the structure of the `target/` directory may break due to those assumptions. For further information, please read the Rust section in the Nixpkgs manual. + +- The cc- and binutils-wrapper\'s \"infix salt\" and `_BUILD_` and `_TARGET_` user infixes have been replaced with with a \"suffix salt\" and suffixes and `_FOR_BUILD` and `_FOR_TARGET`. This matches the autotools convention for env vars which standard for these things, making interfacing with other tools easier. + +- Additional Git documentation (HTML and text files) is now available via the `git-doc` package. + +- Default algorithm for ZRAM swap was changed to `zstd`. + +- The installer now enables sshd by default. This improves installation on headless machines especially ARM single-board-computer. To login through ssh, either a password or an ssh key must be set for the root user or the nixos user. + +- The scripted networking system now uses `.link` files in `/etc/systemd/network` to configure mac address and link MTU, instead of the sometimes buggy `network-link-*` units, which have been removed. Bringing the interface up has been moved to the beginning of the `network-addresses-*` unit. Note this doesn\'t require `systemd-networkd` - it\'s udev that parses `.link` files. Extra care needs to be taken in the presence of [legacy udev rules](https://wiki.debian.org/NetworkInterfaceNames#THE_.22PERSISTENT_NAMES.22_SCHEME) to rename interfaces, as MAC Address and MTU defined in these options can only match on the original link name. In such cases, you most likely want to create a `10-*.link` file through [systemd.network.links](options.html#opt-systemd.network.links) and set both name and MAC Address / MTU there. + +- Grafana received a major update to version 7.x. A plugin is now needed for image rendering support, and plugins must now be signed by default. More information can be found [in the Grafana documentation](https://grafana.com/docs/grafana/latest/installation/upgrading/#upgrading-to-v7-0). + +- The `hardware.u2f` module, which was installing udev rules was removed, as udev gained native support to handle FIDO security tokens. + +- The `services.transmission` module was enhanced with the new options: [services.transmission.credentialsFile](options.html#opt-services.transmission.credentialsFile), [services.transmission.openFirewall](options.html#opt-services.transmission.openFirewall), and [services.transmission.performanceNetParameters](options.html#opt-services.transmission.performanceNetParameters). + + `transmission-daemon` is now started with additional systemd sandbox/hardening options for better security. Please [report](https://github.com/NixOS/nixpkgs/issues) any use case where this is not working well. In particular, the `RootDirectory` option newly set forbids uploading or downloading a torrent outside of the default directory configured at [settings.download-dir](options.html#opt-services.transmission.settings). If you really need Transmission to access other directories, you must include those directories into the `BindPaths` of the service: + + ```nix + { + systemd.services.transmission.serviceConfig.BindPaths = [ "/path/to/alternative/download-dir" ]; + } + ``` + + Also, connection to the RPC (Remote Procedure Call) of `transmission-daemon` is now only available on the local network interface by default. Use: + + ```nix + { + services.transmission.settings.rpc-bind-address = "0.0.0.0"; + } + ``` + + to get the previous behavior of listening on all network interfaces. + +- With this release `systemd-networkd` (when enabled through [networking.useNetworkd](options.html#opt-networking.useNetworkd)) has it\'s netlink socket created through a `systemd.socket` unit. This gives us control over socket buffer sizes and other parameters. For larger setups where networkd has to create a lot of (virtual) devices the default buffer size (currently 128MB) is not enough. + + On a machine with \>100 virtual interfaces (e.g., wireguard tunnels, VLANs, ...), that all have to be brought up during system startup, the receive buffer size will spike for a brief period. Eventually some of the message will be dropped since there is not enough (permitted) buffer space available. + + By having `systemd-networkd` start with a netlink socket created by `systemd` we can configure the `ReceiveBufferSize=` parameter in the socket options (i.e. `systemd.sockets.systemd-networkd.socketOptions.ReceiveBufferSize`) without recompiling `systemd-networkd`. + + Since the actual memory requirements depend on hardware, timing, exact configurations etc. it isn\'t currently possible to infer a good default from within the NixOS module system. Administrators are advised to monitor the logs of `systemd-networkd` for `rtnl: kernel receive buffer overrun` spam and increase the memory limit as they see fit. + + Note: Increasing the `ReceiveBufferSize=` doesn\'t allocate any memory. It just increases the upper bound on the kernel side. The memory allocation depends on the amount of messages that are queued on the kernel side of the netlink socket. + +- Specifying [mailboxes](options.html#opt-services.dovecot2.mailboxes) in the dovecot2 module as a list is deprecated and will break eval in 21.05. Instead, an attribute-set should be specified where the `name` should be the key of the attribute. + + This means that a configuration like this + + ```nix + { + services.dovecot2.mailboxes = [ + { name = "Junk"; + auto = "create"; + } + ]; + } + ``` + + should now look like this: + + ```nix + { + services.dovecot2.mailboxes = { + Junk.auto = "create"; + }; + } + ``` + +- netbeans was upgraded to 12.0 and now defaults to OpenJDK 11. This might cause problems if your projects depend on packages that were removed in Java 11. + +- nextcloud has been updated to [v19](https://nextcloud.com/blog/nextcloud-hub-brings-productivity-to-home-office/). + + If you have an existing installation, please make sure that you\'re on nextcloud18 before upgrading to nextcloud19 since Nextcloud doesn\'t support upgrades across multiple major versions. + +- The `nixos-run-vms` script now deletes the previous run machines states on test startup. You can use the `--keep-vm-state` flag to match the previous behaviour and keep the same VM state between different test runs. + +- The [nix.buildMachines](options.html#opt-nix.buildMachines) option is now type-checked. There are no functional changes, however this may require updating some configurations to use correct types for all attributes. + +- The `fontconfig` module stopped generating config and cache files for fontconfig 2.10.x, the `/etc/fonts/fonts.conf` now belongs to the latest fontconfig, just like on other Linux distributions, and we will [no longer](https://github.com/NixOS/nixpkgs/pull/95358) be versioning the config directories. + + Fontconfig 2.10.x was removed from Nixpkgs since it hasn't been used in any Nixpkgs package for years now. + +- Nginx module `nginxModules.fastcgi-cache-purge` renamed to official name `nginxModules.cache-purge`. Nginx module `nginxModules.ngx_aws_auth` renamed to official name `nginxModules.aws-auth`. + +- The option `defaultPackages` was added. It installs the packages perl, rsync and strace for now. They were added unconditionally to `systemPackages` before, but are not strictly necessary for a minimal NixOS install. You can set it to an empty list to have a more minimal system. Be aware that some functionality might still have an impure dependency on those packages, so things might break. + +- The `undervolt` option no longer needs to apply its settings every 30s. If they still become undone, open an issue and restore the previous behaviour using `undervolt.useTimer`. + +- Agda has been heavily reworked. + + - `agda.mkDerivation` has been heavily changed and is now located at agdaPackages.mkDerivation. + + - New top-level packages agda and `agda.withPackages` have been added, the second of which sets up agda with access to chosen libraries. + + - All agda libraries now live under `agdaPackages`. + + - Many broken libraries have been removed. + + See the [new documentation](https://nixos.org/nixpkgs/manual/#agda) for more information. + +- The `deepin` package set has been removed from nixpkgs. It was a work in progress to package the [Deepin Desktop Environment (DDE)](https://www.deepin.org/en/dde/), including libraries, tools and applications, and it was still missing a service to launch the desktop environment. It has shown to no longer be a feasible goal due to reasons discussed in [issue \#94870](https://github.com/NixOS/nixpkgs/issues/94870). The package `netease-cloud-music` has also been removed, as it depends on libraries from deepin. + +- The `opendkim` module now uses systemd sandboxing features to limit the exposure of the system towards the opendkim service. + +- Kubernetes has been upgraded to 1.19.1, which also means that the golang version to build it has been bumped to 1.15. This may have consequences for your existing clusters and their certificates. Please consider [ the release notes for Kubernetes 1.19 carefully ](https://relnotes.k8s.io/?markdown=93264) before upgrading. + +- For AMD GPUs, Vulkan can now be used by adding `amdvlk` to `hardware.opengl.extraPackages`. + +- Similarly, still for AMD GPUs, the ROCm OpenCL stack can now be used by adding `rocm-opencl-icd` to `hardware.opengl.extraPackages`. + +## Contributions {#sec-release-20.09-contributions} + +I, Jonathan Ringer, would like to thank the following individuals for their work on nixpkgs. This release could not be done without the hard work of the NixOS community. There were 31282 contributions across 1313 contributors. + +1. 2288 Mario Rodas + +2. 1837 Frederik Rietdijk + +3. 946 Jörg Thalheim + +4. 925 Maximilian Bosch + +5. 687 Jonathan Ringer + +6. 651 Jan Tojnar + +7. 622 Daniël de Kok + +8. 605 WORLDofPEACE + +9. 597 Florian Klink + +10. 528 José Romildo Malaquias + +11. 281 volth + +12. 101 Robert Scott + +13. 86 Tim Steinbach + +14. 76 WORLDofPEACE + +15. 49 Maximilian Bosch + +16. 42 Thomas Tuegel + +17. 37 Doron Behar + +18. 36 Vladimír Čunát + +19. 27 Jonathan Ringer + +20. 27 Maciej Krüger + +I, Jonathan Ringer, would also like to personally thank \@WORLDofPEACE for their help in mentoring me on the release process. Special thanks also goes to Thomas Tuegel for helping immensely with stabilizing Qt, KDE, and Plasma5; I would also like to thank Robert Scott for his numerous fixes and pull request reviews. diff --git a/nixos/doc/manual/release-notes/rl-2009.xml b/nixos/doc/manual/release-notes/rl-2009.xml deleted file mode 100644 index 49446afdead..00000000000 --- a/nixos/doc/manual/release-notes/rl-2009.xml +++ /dev/null @@ -1,1838 +0,0 @@ -<section xmlns="http://docbook.org/ns/docbook" - xmlns:xlink="http://www.w3.org/1999/xlink" - xmlns:xi="http://www.w3.org/2001/XInclude" - version="5.0" - xml:id="sec-release-20.09"> - <title>Release 20.09 (“Nightingale”, 2020.10/27)</title> - - <para> - Support is planned until the end of June 2021, handing over to 21.05. - (Plans <link xlink:href="https://github.com/NixOS/rfcs/blob/master/rfcs/0080-nixos-release-schedule.md#core-changes"> - have shifted</link> by two months since release of 20.09.) - </para> - <section xmlns="http://docbook.org/ns/docbook" - xmlns:xlink="http://www.w3.org/1999/xlink" - xmlns:xi="http://www.w3.org/2001/XInclude" - version="5.0" - xml:id="sec-release-20.09-highlights"> - <title>Highlights</title> - - <para> - In addition to 7349 new, 14442 updated, and 8181 removed packages, this release has the - following highlights: - </para> - - <itemizedlist> - <listitem> - <para> - Core version changes: - </para> - <itemizedlist> - <listitem> - <para> - gcc: 9.2.0 -> 9.3.0 - </para> - </listitem> - <listitem> - <para> - glibc: 2.30 -> 2.31 - </para> - </listitem> - <listitem> - <para> - linux: still defaults to 5.4.x, all supported kernels available - </para> - </listitem> - <listitem> - <para> - mesa: 19.3.5 -> 20.1.7 - </para> - </listitem> - </itemizedlist> - </listitem> - <listitem> - <para> - Desktop Environments: - </para> - <itemizedlist> - <listitem> - <para> - plasma5: 5.17.5 -> 5.18.5 - </para> - </listitem> - <listitem> - <para> - kdeApplications: 19.12.3 -> 20.08.1 - </para> - </listitem> - <listitem> - <para> - gnome3: 3.34 -> 3.36, see its <link xlink:href="https://help.gnome.org/misc/release-notes/3.36/">release notes</link> - </para> - </listitem> - <listitem> - <para> - cinnamon: added at 4.6 - </para> - </listitem> - <listitem> - <para> - NixOS now distributes an official <link xlink:href="https://nixos.org/download.html#nixos-iso">GNOME ISO</link> - </para> - </listitem> - </itemizedlist> - </listitem> - - <listitem> - <para> - Programming Languages and Frameworks: - </para> - <itemizedlist> - - <listitem> - <para> - Agda ecosystem was heavily reworked (see more details below) - </para> - </listitem> - <listitem> - <para> - PHP now defaults to PHP 7.4, updated from 7.3 - </para> - </listitem> - <listitem> - <para> - PHP 7.2 is no longer supported due to upstream not supporting this version for the entire lifecycle of the 20.09 release - </para> - </listitem> - <listitem> - <para> - Python 3 now defaults to Python 3.8 instead of 3.7 - </para> - </listitem> - <listitem> - <para> - Python 3.5 reached its upstream EOL at the end of September 2020: it - has been removed from the list of available packages - </para> - </listitem> - </itemizedlist> - </listitem> - - <listitem> - <para> - Databases and Service Monitoring: - </para> - <itemizedlist> - <listitem> - <para> - MariaDB has been updated to 10.4, MariaDB Galera to 26.4. Please read the related upgrade instructions under <link linkend="sec-release-20.09-incompatibilities">backwards incompatibilities</link> before upgrading. - </para> - </listitem> - <listitem> - <para> - Zabbix now defaults to 5.0, updated from 4.4. Please read related sections under <link linkend="sec-release-20.09-incompatibilities">backwards compatibilities</link> before upgrading. - </para> - </listitem> - </itemizedlist> - </listitem> - - <listitem> - <para> - Major module changes: - </para> - <itemizedlist> - <listitem> - <para> - Quickly configure a complete, private, self-hosted video - conferencing solution with the new Jitsi Meet module. - </para> - </listitem> - <listitem> - <para> - Two new options, <link linkend="opt-services.openssh.authorizedKeysCommand">authorizedKeysCommand</link> - and <link linkend="opt-services.openssh.authorizedKeysCommandUser">authorizedKeysCommandUser</link>, have - been added to the <literal>openssh</literal> module. If you have <literal>AuthorizedKeysCommand</literal> - in your <link linkend="opt-services.openssh.extraConfig">services.openssh.extraConfig</link> you should - make use of these new options instead. - </para> - </listitem> - <listitem> - <para> - There is a new module for Podman (<varname>virtualisation.podman</varname>), a drop-in replacement for the Docker command line. - </para> - </listitem> - <listitem> - <para> - The new <varname>virtualisation.containers</varname> module manages configuration shared by the CRI-O and Podman modules. - </para> - </listitem> - <listitem> - <para> - Declarative Docker containers are renamed from <varname>docker-containers</varname> to <varname>virtualisation.oci-containers.containers</varname>. - This is to make it possible to use <literal>podman</literal> instead of <literal>docker</literal>. - </para> - </listitem> - <listitem> - <para> - The new option <link linkend="opt-documentation.man.generateCaches">documentation.man.generateCaches</link> - has been added to automatically generate the <literal>man-db</literal> caches, which are needed by utilities - like <command>whatis</command> and <command>apropos</command>. The caches are generated during the build of - the NixOS configuration: since this can be expensive when a large number of packages are installed, the - feature is disabled by default. - </para> - </listitem> - <listitem> - <para> - <varname>services.postfix.sslCACert</varname> was replaced by <varname>services.postfix.tlsTrustedAuthorities</varname> which now defaults to system certificate authorities. - </para> - </listitem> - <listitem> - <para> - The various documented workarounds to use steam have been converted to a module. <varname>programs.steam.enable</varname> enables steam, controller support and the workarounds. - </para> - </listitem> - <listitem> - <para> - Support for built-in LCDs in various pieces of Logitech hardware (keyboards and USB speakers). <varname>hardware.logitech.lcd.enable</varname> enables support for all hardware supported by the <link xlink:href="https://sourceforge.net/projects/g15daemon/">g15daemon project</link>. - </para> - </listitem> - <listitem> - <para> - The GRUB module gained support for basic password protection, which - allows to restrict non-default entries in the boot menu to one or more - users. The users and passwords are defined via the option - <option>boot.loader.grub.users</option>. - Note: Password support is only available in GRUB version 2. - </para> - </listitem> - </itemizedlist> - </listitem> - - <listitem> - <para> - NixOS module changes: - </para> - <itemizedlist> - <listitem> - <para> - The NixOS module system now supports freeform modules as a mix between <literal>types.attrsOf</literal> and <literal>types.submodule</literal>. These allow you to explicitly declare a subset of options while still permitting definitions without an associated option. See <xref linkend='sec-freeform-modules'/> for how to use them. - </para> - </listitem> - <listitem> - <para> - Following its deprecation in 20.03, the Perl NixOS test driver has been removed. - All remaining tests have been ported to the Python test framework. - Code outside nixpkgs using <filename>make-test.nix</filename> or - <filename>testing.nix</filename> needs to be ported to - <filename>make-test-python.nix</filename> and - <filename>testing-python.nix</filename> respectively. - </para> - </listitem> - <listitem> - <para> - Subordinate GID and UID mappings are now set up automatically for all normal users. - This will make container tools like Podman work as non-root users out of the box. - </para> - </listitem> - </itemizedlist> - </listitem> - <listitem> - <para> - Starting with this release, the hydra-build-result - <literal>nixos-<replaceable>YY.MM</replaceable></literal> - branches no longer exist in the <link - xlink:href="https://github.com/nixos/nixpkgs-channels">deprecated - nixpkgs-channels repository</link>. These branches are now in - <link xlink:href="https://github.com/nixos/nixpkgs">the main nixpkgs - repository</link>. - </para> - </listitem> - </itemizedlist> - </section> - - <section xmlns="http://docbook.org/ns/docbook" - xmlns:xlink="http://www.w3.org/1999/xlink" - xmlns:xi="http://www.w3.org/2001/XInclude" - version="5.0" - xml:id="sec-release-20.09-new-services"> - <title>New Services</title> - - <para> - In addition to 1119 new, 118 updated, and 476 removed options; 61 new modules were added since the last release: - </para> - - <itemizedlist> - <listitem> - <para> - Hardware: - </para> - <itemizedlist> - <listitem> - <para> - <xref linkend="opt-hardware.system76.firmware-daemon.enable" /> adds easy support of system76 firmware - </para> - </listitem> - <listitem> - <para> - <xref linkend="opt-hardware.uinput.enable" /> loads uinput kernel module - </para> - </listitem> - <listitem> - <para> - <xref linkend="opt-hardware.video.hidpi.enable" /> enable good defaults for HiDPI displays - </para> - </listitem> - <listitem> - <para> - <xref linkend="opt-hardware.wooting.enable" /> support for Wooting keyboards - </para> - </listitem> - <listitem> - <para> - <xref linkend="opt-hardware.xpadneo.enable" /> xpadneo driver for Xbox One wireless controllers - </para> - </listitem> - </itemizedlist> - </listitem> - <listitem> - <para> - Programs: - </para> - <itemizedlist> - <listitem> - <para> - <xref linkend="opt-programs.hamster.enable" /> enable hamster time tracking - </para> - </listitem> - <listitem> - <para> - <xref linkend="opt-programs.steam.enable" /> adds easy enablement of steam and related system configuration - </para> - </listitem> - </itemizedlist> - </listitem> - <listitem> - <para> - Security: - </para> - <itemizedlist> - <listitem> - <para> - <xref linkend="opt-security.doas.enable" /> alternative to sudo, allows non-root users to execute commands as root - </para> - </listitem> - <listitem> - <para> - <xref linkend="opt-security.tpm2.enable" /> add Trusted Platform Module 2 support - </para> - </listitem> - </itemizedlist> - </listitem> - <listitem> - <para> - System: - </para> - <itemizedlist> - <listitem> - <para> - <xref linkend="opt-boot.initrd.network.openvpn.enable" /> start an OpenVPN client during initrd boot - </para> - </listitem> - </itemizedlist> - </listitem> - <listitem> - <para> - Virtualization: - </para> - <itemizedlist> - <listitem> - <para> - <xref linkend="opt-boot.enableContainers" /> use nixos-containers - </para> - </listitem> - <listitem> - <para> - <xref linkend="opt-virtualisation.oci-containers.containers" /> run OCI (Docker) containers - </para> - </listitem> - <listitem> - <para> - <xref linkend="opt-virtualisation.podman.enable" /> daemonless container engine - </para> - </listitem> - </itemizedlist> - </listitem> - - <listitem> - <para> - Services: - </para> - <itemizedlist> - <listitem> - <para> - <xref linkend="opt-services.ankisyncd.enable" /> Anki sync server - </para> - </listitem> - <listitem> - <para> - <xref linkend="opt-services.bazarr.enable" /> Subtitle manager for Sonarr and Radarr - </para> - </listitem> - <listitem> - <para> - <xref linkend="opt-services.biboumi.enable" /> Biboumi XMPP gateway to IRC - </para> - </listitem> - <listitem> - <para> - <xref linkend="opt-services.blockbook-frontend" /> Blockbook-frontend, a service for the Trezor wallet - </para> - </listitem> - <listitem> - <para> - <xref linkend="opt-services.cage.enable" /> Wayland cage service - </para> - </listitem> - <listitem> - <para> - <xref linkend="opt-services.convos.enable" /> IRC daemon, which can be accessed throught the browser - </para> - </listitem> - <listitem> - <para> - <xref linkend="opt-services.engelsystem.enable" /> Tool for coordinating volunteers and shifts on large events - </para> - </listitem> - <listitem> - <para> - <xref linkend="opt-services.espanso.enable" /> text-expander written in rust - </para> - </listitem> - <listitem> - <para> - <xref linkend="opt-services.foldingathome.enable" /> Folding@home client - </para> - </listitem> - <listitem> - <para> - <xref linkend="opt-services.gerrit.enable" /> Web-based team code collaboration tool - </para> - </listitem> - <listitem> - <para> - <xref linkend="opt-services.go-neb.enable" /> Matrix bot - </para> - </listitem> - <listitem> - <para> - <xref linkend="opt-services.hardware.xow.enable" /> xow as a systemd service - </para> - </listitem> - <listitem> - <para> - <xref linkend="opt-services.hercules-ci-agent.enable" /> Hercules CI build agent - </para> - </listitem> - <listitem> - <para> - <xref linkend="opt-services.jicofo.enable" /> Jitsi Conference Focus, component of Jitsi Meet - </para> - </listitem> - <listitem> - <para> - <xref linkend="opt-services.jirafeau.enable" /> A web file repository - </para> - </listitem> - <listitem> - <para> - <xref linkend="opt-services.jitsi-meet.enable" /> Secure, simple and scalable video conferences - </para> - </listitem> - <listitem> - <para> - <xref linkend="opt-services.jitsi-videobridge.enable" /> Jitsi Videobridge, a WebRTC compatible router - </para> - </listitem> - <listitem> - <para> - <xref linkend="opt-services.jupyterhub.enable" /> Jupyterhub development server - </para> - </listitem> - <listitem> - <para> - <xref linkend="opt-services.k3s.enable" /> Lightweight Kubernetes distribution - </para> - </listitem> - <listitem> - <para> - <xref linkend="opt-services.magic-wormhole-mailbox-server.enable" /> Magic Wormhole Mailbox Server - </para> - </listitem> - <listitem> - <para> - <xref linkend="opt-services.malcontent.enable" /> Parental Control support - </para> - </listitem> - <listitem> - <para> - <xref linkend="opt-services.matrix-appservice-discord.enable" /> Matrix and Discord bridge - </para> - </listitem> - <listitem> - <para> - <xref linkend="opt-services.mautrix-telegram.enable" /> Matrix-Telegram puppeting/relaybot bridge - </para> - </listitem> - <listitem> - <para> - <xref linkend="opt-services.mirakurun.enable" /> Japanese DTV Tuner Server Service - </para> - </listitem> - <listitem> - <para> - <xref linkend="opt-services.molly-brown.enable" /> Molly-Brown Gemini server - </para> - </listitem> - <listitem> - <para> - <xref linkend="opt-services.mullvad-vpn.enable" /> Mullvad VPN daemon - </para> - </listitem> - <listitem> - <para> - <xref linkend="opt-services.ncdns.enable" /> Namecoin to DNS bridge - </para> - </listitem> - <listitem> - <para> - <xref linkend="opt-services.nextdns.enable" /> NextDNS to DoH Proxy service - </para> - </listitem> - <listitem> - <para> - <xref linkend="opt-services.nix-store-gcs-proxy" /> Google storage bucket to be used as a nix store - </para> - </listitem> - <listitem> - <para> - <xref linkend="opt-services.onedrive.enable" /> OneDrive sync service - </para> - </listitem> - <listitem> - <para> - <xref linkend="opt-services.pinnwand.enable" /> Pastebin-like service - </para> - </listitem> - <listitem> - <para> - <xref linkend="opt-services.pixiecore.enable" /> Manage network booting of machines - </para> - </listitem> - <listitem> - <para> - <xref linkend="opt-services.privacyidea.enable" /> Privacy authentication server - </para> - </listitem> - <listitem> - <para> - <xref linkend="opt-services.quorum.enable" /> Quorum blockchain daemon - </para> - </listitem> - <listitem> - <para> - <xref linkend="opt-services.robustirc-bridge.enable" /> RobustIRC bridge - </para> - </listitem> - <listitem> - <para> - <xref linkend="opt-services.rss-bridge.enable" /> Generate RSS and Atom feeds - </para> - </listitem> - <listitem> - <para> - <xref linkend="opt-services.rtorrent.enable" /> rTorrent service - </para> - </listitem> - <listitem> - <para> - <xref linkend="opt-services.smartdns.enable" /> SmartDNS DNS server - </para> - </listitem> - <listitem> - <para> - <xref linkend="opt-services.sogo.enable" /> SOGo groupware - </para> - </listitem> - <listitem> - <para> - <xref linkend="opt-services.teeworlds.enable" /> Teeworlds game server - </para> - </listitem> - <listitem> - <para> - <xref linkend="opt-services.torque.mom.enable" /> torque computing node - </para> - </listitem> - <listitem> - <para> - <xref linkend="opt-services.torque.server.enable" /> torque server - </para> - </listitem> - <listitem> - <para> - <xref linkend="opt-services.tuptime.enable" /> A total uptime service - </para> - </listitem> - <listitem> - <para> - <xref linkend="opt-services.urserver.enable" /> X11 remote server - </para> - </listitem> - <listitem> - <para> - <xref linkend="opt-services.wasabibackend.enable" /> Wasabi backend service - </para> - </listitem> - <listitem> - <para> - <xref linkend="opt-services.yubikey-agent.enable" /> Yubikey agent - </para> - </listitem> - <listitem> - <para> - <xref linkend="opt-services.zigbee2mqtt.enable" /> Zigbee to MQTT bridge - </para> - </listitem> - </itemizedlist> - </listitem> - - </itemizedlist> - - </section> - - <section xmlns="http://docbook.org/ns/docbook" - xmlns:xlink="http://www.w3.org/1999/xlink" - xmlns:xi="http://www.w3.org/2001/XInclude" - version="5.0" - xml:id="sec-release-20.09-incompatibilities"> - <title>Backward Incompatibilities</title> - - <para> - When upgrading from a previous release, please be aware of the following - incompatible changes: - </para> - - <itemizedlist> - <listitem> - <para> - MariaDB has been updated to 10.4, MariaDB Galera to 26.4. - Before you upgrade, it would be best to take a backup of your database. - For MariaDB Galera Cluster, see <link xlink:href="https://mariadb.com/kb/en/upgrading-from-mariadb-103-to-mariadb-104-with-galera-cluster/">Upgrading - from MariaDB 10.3 to MariaDB 10.4 with Galera Cluster</link> instead. - Before doing the upgrade read <link xlink:href="https://mariadb.com/kb/en/upgrading-from-mariadb-103-to-mariadb-104/#incompatible-changes-between-103-and-104">Incompatible - Changes Between 10.3 and 10.4</link>. - After the upgrade you will need to run <literal>mysql_upgrade</literal>. - MariaDB 10.4 introduces a number of changes to the authentication process, intended to make things easier and more - intuitive. See <link xlink:href="https://mariadb.com/kb/en/authentication-from-mariadb-104/">Authentication from MariaDB 10.4</link>. - unix_socket auth plugin does not use a password, and uses the connecting user's UID instead. When a new MariaDB data directory is initialized, two MariaDB users are - created and can be used with new unix_socket auth plugin, as well as traditional mysql_native_password plugin: root@localhost and mysql@localhost. To actually use - the traditional mysql_native_password plugin method, one must run the following: -<programlisting> -services.mysql.initialScript = pkgs.writeText "mariadb-init.sql" '' - ALTER USER root@localhost IDENTIFIED VIA mysql_native_password USING PASSWORD("verysecret"); -''; -</programlisting> - When MariaDB data directory is just upgraded (not initialized), the users are not created or modified. - </para> - </listitem> - <listitem> - <para> - MySQL server is now started with additional systemd sandbox/hardening options for better security. The PrivateTmp, ProtectHome, and ProtectSystem options - may be problematic when MySQL is attempting to read from or write to your filesystem anywhere outside of its own state directory, for example when - calling <literal>LOAD DATA INFILE or SELECT * INTO OUTFILE</literal>. In this scenario a variant of the following may be required: - - allow MySQL to read from /home and /tmp directories when using <literal>LOAD DATA INFILE</literal> -<programlisting> -systemd.services.mysql.serviceConfig.ProtectHome = lib.mkForce "read-only"; -</programlisting> - - allow MySQL to write to custom folder <literal>/var/data</literal> when using <literal>SELECT * INTO OUTFILE</literal>, assuming the mysql user has write - access to <literal>/var/data</literal> -<programlisting> -systemd.services.mysql.serviceConfig.ReadWritePaths = [ "/var/data" ]; -</programlisting> - </para> - <para> - The MySQL service no longer runs its <literal>systemd</literal> service startup script as <literal>root</literal> anymore. A dedicated non <literal>root</literal> - super user account is required for operation. This means users with an existing MySQL or MariaDB database server are required to run the following SQL statements - as a super admin user before upgrading: -<programlisting> -CREATE USER IF NOT EXISTS 'mysql'@'localhost' identified with unix_socket; -GRANT ALL PRIVILEGES ON *.* TO 'mysql'@'localhost' WITH GRANT OPTION; -</programlisting> - If you use MySQL instead of MariaDB please replace <literal>unix_socket</literal> with <literal>auth_socket</literal>. If you have changed the value of <xref linkend="opt-services.mysql.user"/> - from the default of <literal>mysql</literal> to a different user please change <literal>'mysql'@'localhost'</literal> to the corresponding user instead. - </para> - </listitem> - - <listitem> - <para> - Zabbix now defaults to 5.0, updated from 4.4. Please carefully read through - <link xlink:href="https://www.zabbix.com/documentation/current/manual/installation/upgrade/sources">the upgrade guide</link> - and apply any changes required. Be sure to take special note of the section on - <link xlink:href="https://www.zabbix.com/documentation/current/manual/installation/upgrade_notes_500#enabling_extended_range_of_numeric_float_values">enabling extended range of numeric (float) values</link> - as you will need to apply this database migration manually. - </para> - <para> - If you are using Zabbix Server with a MySQL or MariaDB database you should note that using a character set of <literal>utf8</literal> and a collate of <literal>utf8_bin</literal> has become mandatory with - this release. See the upstream <link xlink:href="https://support.zabbix.com/browse/ZBX-17357">issue</link> for further discussion. Before upgrading you should check the character set and collation used by - your database and ensure they are correct: -<programlisting> - SELECT - default_character_set_name, - default_collation_name - FROM - information_schema.schemata - WHERE - schema_name = 'zabbix'; -</programlisting> - If these values are not correct you should take a backup of your database and convert the character set and collation as required. Here is an - <link xlink:href="https://www.zabbix.com/forum/zabbix-help/396573-reinstall-after-upgrade?p=396891#post396891">example</link> of how to do so, taken from - the Zabbix forums: -<programlisting> - ALTER DATABASE `zabbix` DEFAULT CHARACTER SET utf8 COLLATE utf8_bin; - - -- the following will produce a list of SQL commands you should subsequently execute - SELECT CONCAT("ALTER TABLE ", TABLE_NAME," CONVERT TO CHARACTER SET utf8 COLLATE utf8_bin;") AS ExecuteTheString - FROM information_schema.`COLUMNS` - WHERE table_schema = "zabbix" AND COLLATION_NAME = "utf8_general_ci"; -</programlisting> - </para> - </listitem> - - <listitem> - <para> - <package>maxx</package> package removed along with <varname>services.xserver.desktopManager.maxx</varname> module. - Please migrate to <package>cdesktopenv</package> and <varname>services.xserver.desktopManager.cde</varname> module. - </para> - </listitem> - <listitem> - <para> - The <link linkend="opt-services.matrix-synapse.enable">matrix-synapse</link> module no longer includes optional dependencies by default, they have to be added through the <link linkend="opt-services.matrix-synapse.plugins">plugins</link> option. - </para> - </listitem> - <listitem> - <para> - <literal>buildGoModule</literal> now internally creates a vendor directory - in the source tree for downloaded modules instead of using go's <link - xlink:href="https://golang.org/cmd/go/#hdr-Module_proxy_protocol">module - proxy protocol</link>. This storage format is simpler and therefore less - likely to break with future versions of go. As a result - <literal>buildGoModule</literal> switched from - <literal>modSha256</literal> to the <literal>vendorSha256</literal> - attribute to pin fetched version data. - </para> - </listitem> - <listitem> - <para> - Grafana is now built without support for phantomjs by default. Phantomjs support has been - <link xlink:href="https://grafana.com/docs/grafana/latest/guides/whats-new-in-v6-4/">deprecated in Grafana</link> - and the <package>phantomjs</package> project is - <link xlink:href="https://github.com/ariya/phantomjs/issues/15344#issue-302015362">currently unmaintained</link>. - It can still be enabled by providing <literal>phantomJsSupport = true</literal> to the package instantiation: -<programlisting>{ - services.grafana.package = pkgs.grafana.overrideAttrs (oldAttrs: rec { - phantomJsSupport = true; - }); -}</programlisting> - </para> - </listitem> - <listitem> - <para> - The <link linkend="opt-services.supybot.enable">supybot</link> module now uses <literal>/var/lib/supybot</literal> - as its default <link linkend="opt-services.supybot.stateDir">stateDir</link> path if <literal>stateVersion</literal> - is 20.09 or higher. It also enables a number of - <link xlink:href="https://www.freedesktop.org/software/systemd/man/systemd.exec.html#Sandboxing">systemd sandboxing options</link> - which may possibly interfere with some plugins. If this is the case you can disable the options through attributes in - <option>systemd.services.supybot.serviceConfig</option>. - </para> - </listitem> - <listitem> - <para> - The <literal>security.duosec.skey</literal> option, which stored a secret in the - nix store, has been replaced by a new - <link linkend="opt-security.duosec.secretKeyFile">security.duosec.secretKeyFile</link> - option for better security. - </para> - <para> - <literal>security.duosec.ikey</literal> has been renamed to - <link linkend="opt-security.duosec.integrationKey">security.duosec.integrationKey</link>. - </para> - </listitem> - <listitem> - <para> - <literal>vmware</literal> has been removed from the <literal>services.x11.videoDrivers</literal> defaults. - For VMWare guests set <literal>virtualisation.vmware.guest.enable</literal> to <literal>true</literal> which will include the appropriate drivers. - </para> - </listitem> - <listitem> - <para> - The initrd SSH support now uses OpenSSH rather than Dropbear to - allow the use of Ed25519 keys and other OpenSSH-specific - functionality. Host keys must now be in the OpenSSH format, and at - least one pre-generated key must be specified. - </para> - <para> - If you used the <option>boot.initrd.network.ssh.host*Key</option> - options, you'll get an error explaining how to convert your host - keys and migrate to the new - <option>boot.initrd.network.ssh.hostKeys</option> option. - Otherwise, if you don't have any host keys set, you'll need to - generate some; see the <option>hostKeys</option> option - documentation for instructions. - </para> - </listitem> - <listitem> - <para> - Since this release there's an easy way to customize your PHP - install to get a much smaller base PHP with only wanted - extensions enabled. See the following snippet installing a - smaller PHP with the extensions <literal>imagick</literal>, - <literal>opcache</literal>, <literal>pdo</literal> and - <literal>pdo_mysql</literal> loaded: - - <programlisting> -environment.systemPackages = [ - (pkgs.php.withExtensions - ({ all, ... }: with all; [ - imagick - opcache - pdo - pdo_mysql - ]) - ) -];</programlisting> - - The default <literal>php</literal> attribute hasn't lost any - extensions. The <literal>opcache</literal> extension has been - added. - - All upstream PHP extensions are available under <package><![CDATA[php.extensions.<name?>]]></package>. - </para> - <para> - All PHP <literal>config</literal> flags have been removed for - the following reasons: - - <itemizedlist> - <listitem> - <para> - The updated <literal>php</literal> attribute is now easily - customizable to your liking by using - <literal>php.withExtensions</literal> or - <literal>php.buildEnv</literal> instead of writing config files - or changing configure flags. - </para> - </listitem> - <listitem> - <para> - The remaining configuration flags can now be set directly on - the <literal>php</literal> attribute. For example, instead of - - <programlisting> -php.override { - config.php.embed = true; - config.php.apxs2 = false; -} - </programlisting> - - you should now write - - <programlisting> -php.override { - embedSupport = true; - apxs2Support = false; -} - </programlisting> - </para> - </listitem> - </itemizedlist> - - </para> - </listitem> - <listitem> - <para> - The ACME module has been overhauled for simplicity and maintainability. - Cert generation now implicitly uses the <literal>acme</literal> - user, and the <literal>security.acme.certs._name_.user</literal> option - has been removed. Instead, certificate access from other services is now - managed through group permissions. The module no longer runs lego - twice under certain conditions, and will correctly renew certificates if - their configuration is changed. Services which reload nginx and httpd after - certificate renewal are now properly configured too so you no longer have - to do this manually if you are using HTTPS enabled virtual hosts. A mechanism - for regenerating certs on demand has also been added and documented. - </para> - </listitem> - <listitem> - <para> - Gollum received a major update to version 5.x and you may have to change - some links in your wiki when migrating from gollum 4.x. More information - can be found - <link xlink:href="https://github.com/gollum/gollum/wiki/5.0-release-notes#migrating-your-wiki">here</link>. - </para> - </listitem> - <listitem> - <para> - Deluge 2.x was added and is used as default for new NixOS - installations where stateVersion is >= 20.09. If you are upgrading from a previous - NixOS version, you can set <literal>service.deluge.package = pkgs.deluge-2_x</literal> - to upgrade to Deluge 2.x and migrate the state to the new format. - Be aware that backwards state migrations are not supported by Deluge. - </para> - </listitem> - <listitem> - <para> - Nginx web server now starting with additional sandbox/hardening options. By default, write access - to <literal>/var/log/nginx</literal> and <literal>/var/cache/nginx</literal> is allowed. To allow writing to other folders, - use <literal>systemd.services.nginx.serviceConfig.ReadWritePaths</literal> - <programlisting> -systemd.services.nginx.serviceConfig.ReadWritePaths = [ "/var/www" ]; - </programlisting> - </para> - <para> - Nginx is also started with the systemd option <literal>ProtectHome = mkDefault true;</literal> - which forbids it to read anything from <literal>/home</literal>, <literal>/root</literal> - and <literal>/run/user</literal> (see - <link xlink:href="https://www.freedesktop.org/software/systemd/man/systemd.exec.html#ProtectHome=">ProtectHome docs</link> - for details). - If you require serving files from home directories, you may choose to set e.g. -<programlisting> -systemd.services.nginx.serviceConfig.ProtectHome = "read-only"; -</programlisting> - </para> - </listitem> - <listitem> - <para> - The NixOS options <literal>nesting.clone</literal> and - <literal>nesting.children</literal> have been deleted, and - replaced with named <xref linkend="opt-specialisation"/> - configurations. - </para> - - <para> - Replace a <literal>nesting.clone</literal> entry with: - -<programlisting>{ -<link xlink:href="#opt-specialisation">specialisation.example-sub-configuration</link> = { - <link xlink:href="#opt-specialisation._name_.configuration">configuration</link> = { - ... - }; -};</programlisting> - - </para> - <para> - Replace a <literal>nesting.children</literal> entry with: - -<programlisting>{ -<link xlink:href="#opt-specialisation">specialisation.example-sub-configuration</link> = { - <link xlink:href="#opt-specialisation._name_.inheritParentConfig">inheritParentConfig</link> = false; - <link xlink:href="#opt-specialisation._name_.configuration">configuration</link> = { - ... - }; -};</programlisting> - </para> - - <para> - To switch to a specialised configuration at runtime you need to - run: -<programlisting> -# sudo /run/current-system/specialisation/example-sub-configuration/bin/switch-to-configuration test -</programlisting> - Before you would have used: -<programlisting> -# sudo /run/current-system/fine-tune/child-1/bin/switch-to-configuration test -</programlisting> - </para> - </listitem> - <listitem> - <para> - The Nginx log directory has been moved to <literal>/var/log/nginx</literal>, the cache directory - to <literal>/var/cache/nginx</literal>. The option <literal>services.nginx.stateDir</literal> has - been removed. - </para> - </listitem> - <listitem> - <para> - The httpd web server previously started its main process as root - privileged, then ran worker processes as a less privileged identity user. - This was changed to start all of httpd as a less privileged user (defined by - <xref linkend="opt-services.httpd.user"/> and - <xref linkend="opt-services.httpd.group"/>). As a consequence, all files that - are needed for httpd to run (included configuration fragments, SSL - certificates and keys, etc.) must now be readable by this less privileged - user/group. - </para> - <para> - The default value for <xref linkend="opt-services.httpd.mpm"/> - has been changed from <literal>prefork</literal> to <literal>event</literal>. Along with - this change the default value for - <link linkend="opt-services.httpd.virtualHosts">services.httpd.virtualHosts.<name>.http2</link> - has been set to <literal>true</literal>. - </para> - </listitem> - <listitem> - <para> - The <literal>systemd-networkd</literal> option - <literal>systemd.network.networks.<name>.dhcp.CriticalConnection</literal> - has been removed following upstream systemd's deprecation of the same. It is recommended to use - <literal>systemd.network.networks.<name>.networkConfig.KeepConfiguration</literal> instead. - See <citerefentry><refentrytitle>systemd.network</refentrytitle> - <manvolnum>5</manvolnum></citerefentry> for details. - </para> - </listitem> - <listitem> - <para> - The <literal>systemd-networkd</literal> option - <literal>systemd.network.networks._name_.dhcpConfig</literal> - has been renamed to - <xref linkend="opt-systemd.network.networks._name_.dhcpV4Config"/> - following upstream systemd's documentation change. - See <citerefentry><refentrytitle>systemd.network</refentrytitle> - <manvolnum>5</manvolnum></citerefentry> for details. - </para> - </listitem> - <listitem> - <para> - In the <literal>picom</literal> module, several options that accepted - floating point numbers encoded as strings (for example - <xref linkend="opt-services.picom.activeOpacity"/>) have been changed - to the (relatively) new native <literal>float</literal> type. To migrate - your configuration simply remove the quotes around the numbers. - </para> - </listitem> - <listitem> - <para> - When using <literal>buildBazelPackage</literal> from Nixpkgs, - <literal>flat</literal> hash mode is now used for dependencies - instead of <literal>recursive</literal>. This is to better allow - using hashed mirrors where needed. As a result, these hashes - will have changed. - </para> - </listitem> - <listitem> - <para> - The syntax of the PostgreSQL configuration file is now checked at build - time. If your configuration includes a file inaccessible inside the build - sandbox, set <varname>services.postgresql.checkConfig</varname> to - <literal>false</literal>. - </para> - </listitem> - <listitem> - <para> - The rkt module has been removed, it was archived by upstream. - </para> - </listitem> - <listitem> - <para> - The <link xlink:href="https://bazaar.canonical.com">Bazaar</link> VCS is - unmaintained and, as consequence of the Python 2 EOL, the packages - <literal>bazaar</literal> and <literal>bazaarTools</literal> were - removed. Breezy, the backward compatible fork of Bazaar (see the - <link xlink:href="https://www.jelmer.uk/breezy-intro.html">announcement</link>), - was packaged as <literal>breezy</literal> and can be used instead. - </para> - <para> - Regarding Nixpkgs, <literal>fetchbzr</literal>, - <literal>nix-prefetch-bzr</literal> and Bazaar support in Hydra will - continue to work through Breezy. - </para> - </listitem> - <listitem> - <para> - In addition to the hostname, the fully qualified domain name (FQDN), - which consists of <literal>${networking.hostName}</literal> and - <literal>${networking.domain}</literal> is now added to - <literal>/etc/hosts</literal>, to allow local FQDN resolution, as used by the - <literal>hostname --fqdn</literal> command and other applications that - try to determine the FQDN. These new entries take precedence over entries - from the DNS which could cause regressions in some very specific setups. - Additionally the hostname is now resolved to <literal>127.0.0.2</literal> - instead of <literal>127.0.1.1</literal> to be consistent with what - <literal>nss-myhostname</literal> (from systemd) returns. - The old behaviour can e.g. be restored by using - <literal>networking.hosts = lib.mkForce { "127.0.1.1" = [ config.networking.hostName ]; };</literal>. - </para> - </listitem> - <listitem> - <para> - The hostname (<literal>networking.hostName</literal>) must now be a valid - DNS label (see RFC 1035, RFC 1123) and as such must not contain the domain part. - This means that the hostname must start with a letter or digit, end with a letter - or digit, and have as interior characters only letters, digits, and - hyphen. The maximum length is 63 characters. Additionally it is - recommended to only use lower-case characters. - If (e.g. for legacy reasons) a FQDN is required as the Linux kernel network node hostname - (<literal>uname --nodename</literal>) the option - <literal>boot.kernel.sysctl."kernel.hostname"</literal> - can be used as a workaround (but be aware of the 64 character limit). - </para> - </listitem> - <listitem> - <para> - The GRUB specific option <option>boot.loader.grub.extraInitrd</option> - has been replaced with the generic option - <option>boot.initrd.secrets</option>. This option creates a secondary - initrd from the specified files, rather than using a manually created - initrd file. - - Due to an existing bug with <option>boot.loader.grub.extraInitrd</option>, - it is not possible to directly boot an older generation that used that - option. It is still possible to rollback to that generation if the required - initrd file has not been deleted. - </para> - </listitem> - <listitem> - <para> - The <link xlink:href="https://github.com/okTurtles/dnschain">DNSChain</link> - package and NixOS module have been removed from Nixpkgs as the software is - unmaintained and can't be built. For more information see issue - <link xlink:href="https://github.com/NixOS/nixpkgs/issues/89205">#89205</link>. - </para> - </listitem> - <listitem> - <para> - In the <literal>resilio</literal> module, <xref linkend="opt-services.resilio.httpListenAddr"/> has been changed to listen to <literal>[::1]</literal> instead of <literal>0.0.0.0</literal>. - </para> - </listitem> - <listitem> - <para> - <literal>sslh</literal> has been updated to version - <literal>1.21</literal>. The <literal>ssl</literal> probe must be - renamed to <literal>tls</literal> in <xref linkend="opt-services.sslh.appendConfig"/>. - </para> - </listitem> - <listitem> - <para> - Users of <link xlink:href="http://openafs.org">OpenAFS 1.6</link> must - upgrade their services to OpenAFS 1.8! In this release, the OpenAFS package - version 1.6.24 is marked broken but can be used during transition to - OpenAFS 1.8.x. Use the options - <option>services.openafsClient.packages.module</option>, - <option>services.openafsClient.packages.programs</option> and - <option>services.openafsServer.package</option> to select a different - OpenAFS package. OpenAFS 1.6 will be removed in the next release. The - package <literal>openafs</literal> and the service options will then - silently point to the OpenAFS 1.8 release. - </para> - <para> - See also the OpenAFS <link - xlink:href="http://docs.openafs.org/AdminGuide/index.html">Administrator - Guide</link> for instructions. Beware of the following when updating - servers: - <itemizedlist> - <listitem> - <para> - The storage format of the server key has changed and the key must be converted before running the new release. - </para> - </listitem> - <listitem> - <para> - When updating multiple database servers, turn off the database servers - from the highest IP down to the lowest with resting periods in - between. Start up in reverse order. Do not concurrently run database - servers working with different OpenAFS releases! - </para> - </listitem> - <listitem> - <para> - Update servers first, then clients. - </para> - </listitem> - </itemizedlist> - </para> - </listitem> - <listitem> - <para> - Radicale's default package has changed from 2.x to 3.x. An upgrade - checklist can be found - <link xlink:href="https://github.com/Kozea/Radicale/blob/3.0.x/NEWS.md#upgrade-checklist">here</link>. - You can use the newer version in the NixOS service by setting the - <literal>package</literal> to <literal>radicale3</literal>, which is done - automatically if <literal>stateVersion</literal> is 20.09 or higher. - </para> - </listitem> - <listitem> - <para> - <literal>udpt</literal> experienced a complete rewrite from C++ to rust. The configuration format changed from ini to toml. - The new configuration documentation can be found at - <link xlink:href="https://naim94a.github.io/udpt/config.html">the official website</link> and example - configuration is packaged in <literal>${udpt}/share/udpt/udpt.toml</literal>. - </para> - </listitem> - <listitem> - <para> - We now have a unified <xref linkend="opt-services.xserver.displayManager.autoLogin"/> option interface - to be used for every display-manager in NixOS. - </para> - </listitem> - <listitem> - <para> - The <literal>bitcoind</literal> module has changed to multi-instance, using submodules. - Therefore, it is now mandatory to name each instance. - To use this new multi-instance config with an existing bitcoind data directory and user, - you have to adjust the original config, e.g.: -<programlisting> - services.bitcoind = { - enable = true; - extraConfig = "..."; - ... - }; -</programlisting> - To something similar: -<programlisting> - services.bitcoind.mainnet = { - enable = true; - dataDir = "/var/lib/bitcoind"; - user = "bitcoin"; - extraConfig = "..."; - ... - }; -</programlisting> - The key settings are: - <itemizedlist> - <listitem> - <para> - <literal>dataDir</literal> - to continue using the same data directory. - </para> - </listitem> - <listitem> - <para> - <literal>user</literal> - to continue using the same user so that bitcoind maintains access to its files. - </para> - </listitem> - </itemizedlist> - </para> - </listitem> - <listitem> - <para> - Graylog introduced a change in the LDAP server certificate validation behaviour for version 3.3.3 which might break existing setups. - When updating Graylog from a version before 3.3.3 make sure to check the Graylog <link xlink:href="https://www.graylog.org/post/announcing-graylog-v3-3-3">release info</link> for information on how to avoid the issue. - </para> - </listitem> - <listitem> - <para> - The <literal>dokuwiki</literal> module has changed to multi-instance, using submodules. - Therefore, it is now mandatory to name each instance. Moreover, forcing SSL by default has been dropped, so - <literal>nginx.forceSSL</literal> and <literal>nginx.enableACME</literal> are no longer set to <literal>true</literal>. - To continue using your service with the original SSL settings, you have to adjust the original config, e.g.: -<programlisting> -services.dokuwiki = { - enable = true; - ... -}; -</programlisting> - To something similar: -<programlisting> -services.dokuwiki."mywiki" = { - enable = true; - nginx = { - forceSSL = true; - enableACME = true; - }; - ... -}; -</programlisting> - The base package has also been upgraded to the 2020-07-29 "Hogfather" release. Plugins might be incompatible or require upgrading. - </para> - </listitem> - <listitem> - <para> - The <xref linkend="opt-services.postgresql.dataDir"/> option is now set to <literal>"/var/lib/postgresql/${cfg.package.psqlSchema}"</literal> regardless of your - <xref linkend="opt-system.stateVersion"/>. Users with an existing postgresql install that have a <xref linkend="opt-system.stateVersion"/> of <literal>17.03</literal> or below - should double check what the value of their <xref linkend="opt-services.postgresql.dataDir"/> option is (<literal>/var/db/postgresql</literal>) and then explicitly - set this value to maintain compatibility: -<programlisting> -services.postgresql.dataDir = "/var/db/postgresql"; -</programlisting> - </para> - <para> - The postgresql module now expects there to be a database super user account called <literal>postgres</literal> regardless of your <xref linkend="opt-system.stateVersion"/>. Users - with an existing postgresql install that have a <xref linkend="opt-system.stateVersion"/> of <literal>17.03</literal> or below should run the following SQL statements as a - database super admin user before upgrading: -<programlisting> -CREATE ROLE postgres LOGIN SUPERUSER; -</programlisting> - </para> - </listitem> - <listitem> - <para> - The USBGuard module now removes options and instead hardcodes values for <literal>IPCAccessControlFiles</literal>, <literal>ruleFiles</literal>, and <literal>auditFilePath</literal>. Audit logs can be found in the journal. - </para> - </listitem> - <listitem> - <para> - The NixOS module system now evaluates option definitions more strictly, allowing it to detect a larger set of problems. - As a result, what previously evaluated may not do so anymore. - See <link xlink:href="https://github.com/NixOS/nixpkgs/pull/82743#issuecomment-674520472">the PR that changed this</link> for more info. - </para> - </listitem> - <listitem> - <para> - For NixOS configuration options, the type <literal>loaOf</literal>, after - its initial deprecation in release 20.03, has been removed. In NixOS and - Nixpkgs options using this type have been converted to <literal>attrsOf</literal>. - For more information on this change have look at these links: - <link xlink:href="https://github.com/NixOS/nixpkgs/issues/1800">issue #1800</link>, - <link xlink:href="https://github.com/NixOS/nixpkgs/pull/63103">PR #63103</link>. - </para> - </listitem> - <listitem> - <para> - <literal>config.systemd.services.${name}.path</literal> now returns a list of paths instead of a colon-separated string. - </para> - </listitem> - <listitem> - <para> - Caddy module now uses Caddy v2 by default. Caddy v1 can still be used by setting - <xref linkend="opt-services.caddy.package"/> to <literal>pkgs.caddy1</literal>. - </para> - <para> - New option <xref linkend="opt-services.caddy.adapter"/> has been added. - </para> - </listitem> - <listitem> - <para> - The <link linkend="opt-services.jellyfin.enable">jellyfin</link> module will use and stay on the Jellyfin version <literal>10.5.5</literal> - if <literal>stateVersion</literal> is lower than <literal>20.09</literal>. This is because significant changes were made to the database schema, - and it is highly recommended to backup your instance before upgrading. After making your backup, you can upgrade to the latest version either by - setting your <literal>stateVersion</literal> to <literal>20.09</literal> or higher, or set the <option>services.jellyfin.package</option> to - <literal>pkgs.jellyfin</literal>. If you do not wish to upgrade Jellyfin, but want to change your <literal>stateVersion</literal>, you can set - the value of <option>services.jellyfin.package</option> to <literal>pkgs.jellyfin_10_5</literal>. - </para> - </listitem> - <listitem> - <para> - The <literal>security.rngd</literal> service is now disabled by default. - This choice was made because there's krngd in the linux kernel space making it (for most usecases) - functionally redundent. - </para> - </listitem> - <listitem> - <para> - The <literal>hardware.nvidia.optimus_prime.enable</literal> service has been renamed to - <literal>hardware.nvidia.prime.sync.enable</literal> and has many new enhancements. - Related nvidia prime settings may have also changed. - </para> - </listitem> - <listitem> - <para> - The package <package>nextcloud17</package> has been removed and <package>nextcloud18</package> was marked as insecure - since both of them will <link xlink:href="https://docs.nextcloud.com/server/19/admin_manual/release_schedule.html"> - will be EOL (end of life) within the lifetime of 20.09</link>. - </para> - <para> - It's necessary to upgrade to <package>nextcloud19</package>: - <itemizedlist> - <listitem> - <para> - From <package>nextcloud17</package>, you have to upgrade to <package>nextcloud18</package> first as - Nextcloud doesn't allow going multiple major revisions forward in a single upgrade. This is possible - by setting <xref linkend="opt-services.nextcloud.package" /> to <package>nextcloud18</package>. - </para> - </listitem> - <listitem> - <para> - From <package>nextcloud18</package>, it's possible to directly upgrade to <package>nextcloud19</package> - by setting <xref linkend="opt-services.nextcloud.package" /> to <package>nextcloud19</package>. - </para> - </listitem> - </itemizedlist> - </para> - </listitem> - <listitem> - <para> - The GNOME desktop manager no longer default installs <package>gnome3.epiphany</package>. - It was chosen to do this as it has a usability breaking issue (see issue <link xlink:href="https://github.com/NixOS/nixpkgs/issues/98819">#98819</link>) - that makes it unsuitable to be a default app. - </para> - <note> - <para> - Issue <link - xlink:href="https://github.com/NixOS/nixpkgs/issues/98819">#98819</link> - is now fixed and <package>gnome3.epiphany</package> is once - again installed by default. - </para> - </note> - </listitem> - <listitem> - <para> - If you want to manage the configuration of <package>wpa_supplicant</package> outside of NixOS you must ensure that none of <xref linkend="opt-networking.wireless.networks" />, <xref linkend="opt-networking.wireless.extraConfig" /> or <xref linkend="opt-networking.wireless.userControlled.enable" /> is being used or <literal>true</literal>. - Using any of those options will cause <package>wpa_supplicant</package> to be started with a NixOS generated configuration file instead of your own. - </para> - </listitem> - </itemizedlist> - </section> - - <section xmlns="http://docbook.org/ns/docbook" - xmlns:xlink="http://www.w3.org/1999/xlink" - xmlns:xi="http://www.w3.org/2001/XInclude" - version="5.0" - xml:id="sec-release-20.09-notable-changes"> - <title>Other Notable Changes</title> - - <itemizedlist> - <listitem> - <para>SD images are now compressed by default using <literal>zstd</literal>. The compression for ISO images has also been changed to <literal>zstd</literal>, but ISO images are still not compressed by default.</para> - </listitem> - <listitem> - <para> - <option>services.journald.rateLimitBurst</option> was updated from - <literal>1000</literal> to <literal>10000</literal> to follow the new - upstream systemd default. - </para> - </listitem> - <listitem> - <para> - The <package>notmuch</package> package move its emacs-related binaries and - emacs lisp files to a separate output. They're not part - of the default <literal>out</literal> output anymore - if you relied on the - <literal>notmuch-emacs-mua</literal> binary or the emacs lisp files, access them via - the <literal>notmuch.emacs</literal> output. - - Device tree overlay support was improved in - <link xlink:href="https://github.com/NixOS/nixpkgs/pull/79370">#79370</link> - and now uses <xref linkend="opt-hardware.deviceTree.kernelPackage"/> - instead of <option>hardware.deviceTree.base</option>. - - <xref linkend="opt-hardware.deviceTree.overlays"/> configuration was - extended to support <literal>.dts</literal> files with symbols. - - Device trees can now be filtered by setting - <xref linkend="opt-hardware.deviceTree.filter"/> option. - </para> - </listitem> - <listitem> - <para> - The default output of <literal>buildGoPackage</literal> is now <literal>$out</literal> instead of <literal>$bin</literal>. - </para> - </listitem> - <listitem> - <para> - <literal>buildGoModule</literal> <literal>doCheck</literal> now defaults to <literal>true</literal>. - </para> - </listitem> - <listitem> - <para> - Packages built using <literal>buildRustPackage</literal> now use <literal>release</literal> - mode for the <literal>checkPhase</literal> by default. - </para> - <para> - Please note that Rust packages utilizing a custom build/install procedure - (e.g. by using a <filename>Makefile</filename>) or test suites that rely on the - structure of the <filename>target/</filename> directory may break due to those assumptions. - For further information, please read the Rust section in the Nixpkgs manual. - </para> - </listitem> - <listitem> - <para> - The cc- and binutils-wrapper's "infix salt" and <literal>_BUILD_</literal> and <literal>_TARGET_</literal> user infixes have been replaced with with a "suffix salt" and suffixes and <literal>_FOR_BUILD</literal> and <literal>_FOR_TARGET</literal>. - This matches the autotools convention for env vars which standard for these things, making interfacing with other tools easier. - </para> - </listitem> - <listitem> - <para> - Additional Git documentation (HTML and text files) is now available via the <literal>git-doc</literal> package. - </para> - </listitem> - <listitem> - <para> - Default algorithm for ZRAM swap was changed to <literal>zstd</literal>. - </para> - </listitem> - <listitem> - <para> - The installer now enables sshd by default. This improves installation on headless machines especially ARM single-board-computer. - To login through ssh, either a password or an ssh key must be set for the root user or the nixos user. - </para> - </listitem> - <listitem> - <para> - The scripted networking system now uses <literal>.link</literal> files in - <literal>/etc/systemd/network</literal> to configure mac address and link MTU, - instead of the sometimes buggy <literal>network-link-*</literal> units, which - have been removed. - Bringing the interface up has been moved to the beginning of the - <literal>network-addresses-*</literal> unit. - Note this doesn't require <command>systemd-networkd</command> - it's udev that - parses <literal>.link</literal> files. - Extra care needs to be taken in the presence of <link xlink:href="https://wiki.debian.org/NetworkInterfaceNames#THE_.22PERSISTENT_NAMES.22_SCHEME">legacy udev rules</link> - to rename interfaces, as MAC Address and MTU defined in these options can only match on the original link name. - In such cases, you most likely want to create a <literal>10-*.link</literal> file through <xref linkend="opt-systemd.network.links"/> and set both name and MAC Address / MTU there. - </para> - </listitem> - <listitem> - <para> - Grafana received a major update to version 7.x. A plugin is now needed for - image rendering support, and plugins must now be signed by default. More - information can be found - <link xlink:href="https://grafana.com/docs/grafana/latest/installation/upgrading/#upgrading-to-v7-0">in the Grafana documentation</link>. - </para> - </listitem> - <listitem> - <para> - The <literal>hardware.u2f</literal> module, which was installing udev rules - was removed, as udev gained native support to handle FIDO security tokens. - </para> - </listitem> - <listitem> - <para> - The <literal>services.transmission</literal> module - was enhanced with the new options: - <xref linkend="opt-services.transmission.credentialsFile"/>, - <xref linkend="opt-services.transmission.openFirewall"/>, - and <xref linkend="opt-services.transmission.performanceNetParameters"/>. - </para> - <para> - <literal>transmission-daemon</literal> is now started with additional systemd sandbox/hardening options for better security. - Please <link xlink:href="https://github.com/NixOS/nixpkgs/issues">report</link> - any use case where this is not working well. - In particular, the <literal>RootDirectory</literal> option newly set - forbids uploading or downloading a torrent outside of the default directory - configured at <link linkend="opt-services.transmission.settings">settings.download-dir</link>. - If you really need Transmission to access other directories, - you must include those directories into the <literal>BindPaths</literal> of the service: -<programlisting> -systemd.services.transmission.serviceConfig.BindPaths = [ "/path/to/alternative/download-dir" ]; -</programlisting> - </para> - <para> - Also, connection to the RPC (Remote Procedure Call) of <literal>transmission-daemon</literal> - is now only available on the local network interface by default. - Use: -<programlisting> -services.transmission.settings.rpc-bind-address = "0.0.0.0"; -</programlisting> - to get the previous behavior of listening on all network interfaces. - </para> - </listitem> - <listitem> - <para> - With this release <literal>systemd-networkd</literal> (when enabled through <xref linkend="opt-networking.useNetworkd"/>) - has it's netlink socket created through a <literal>systemd.socket</literal> unit. This gives us control over - socket buffer sizes and other parameters. For larger setups where networkd has to create a lot of (virtual) - devices the default buffer size (currently 128MB) is not enough. - </para> - <para> - On a machine with >100 virtual interfaces (e.g., wireguard tunnels, VLANs, …), that all have to - be brought up during system startup, the receive buffer size will spike for a brief period. - Eventually some of the message will be dropped since there is not enough (permitted) buffer - space available. - </para> - <para> - By having <literal>systemd-networkd</literal> start with a netlink socket created by - <literal>systemd</literal> we can configure the <literal>ReceiveBufferSize=</literal> parameter - in the socket options (i.e. <literal>systemd.sockets.systemd-networkd.socketOptions.ReceiveBufferSize</literal>) - without recompiling <literal>systemd-networkd</literal>. - </para> - <para> - Since the actual memory requirements depend on hardware, timing, exact - configurations etc. it isn't currently possible to infer a good default - from within the NixOS module system. Administrators are advised to - monitor the logs of <literal>systemd-networkd</literal> for <literal>rtnl: kernel receive buffer - overrun</literal> spam and increase the memory limit as they see fit. - </para> - <para> - Note: Increasing the <literal>ReceiveBufferSize=</literal> doesn't allocate any memory. It just increases - the upper bound on the kernel side. The memory allocation depends on the amount of messages that are - queued on the kernel side of the netlink socket. - </para> - </listitem> - <listitem> - <para> - Specifying <link linkend="opt-services.dovecot2.mailboxes">mailboxes</link> in the <package>dovecot2</package> module - as a list is deprecated and will break eval in 21.05. Instead, an attribute-set should be specified where the <literal>name</literal> - should be the key of the attribute. - </para> - <para> - This means that a configuration like this -<programlisting>{ - <link linkend="opt-services.dovecot2.mailboxes">services.dovecot2.mailboxes</link> = [ - { name = "Junk"; - auto = "create"; - } - ]; -}</programlisting> - should now look like this: -<programlisting>{ - <link linkend="opt-services.dovecot2.mailboxes">services.dovecot2.mailboxes</link> = { - Junk.auto = "create"; - }; -}</programlisting> - </para> - </listitem> - <listitem> - <para> - <package>netbeans</package> was upgraded to 12.0 and now defaults to OpenJDK 11. This might cause problems if your projects depend on packages that were removed in Java 11. - </para> - </listitem> - <listitem> - <para> - <package>nextcloud</package> has been updated to <link xlink:href="https://nextcloud.com/blog/nextcloud-hub-brings-productivity-to-home-office/">v19</link>. - </para> - <para> - If you have an existing installation, please make sure that you're on - <package>nextcloud18</package> before upgrading to <package>nextcloud19</package> - since Nextcloud doesn't support upgrades across multiple major versions. - </para> - </listitem> - <listitem> - <para> - The <literal>nixos-run-vms</literal> script now deletes the - previous run machines states on test startup. You can use the - <literal>--keep-vm-state</literal> flag to match the previous - behaviour and keep the same VM state between different test runs. - </para> - </listitem> - <listitem> - <para> - The <link linkend="opt-nix.buildMachines">nix.buildMachines</link> option is now type-checked. - There are no functional changes, however this may require updating some configurations to use correct types for all attributes. - </para> - </listitem> - <listitem> - <para> - The <literal>fontconfig</literal> module stopped generating config and cache files for fontconfig 2.10.x, the <filename>/etc/fonts/fonts.conf</filename> now belongs to the latest fontconfig, just like on other Linux distributions, and we will <link xlink:href="https://github.com/NixOS/nixpkgs/pull/95358">no longer</link> be versioning the config directories. - </para> - <para> - Fontconfig 2.10.x was removed from Nixpkgs since it hasn’t been used in any Nixpkgs package for years now. - </para> - </listitem> - <listitem> - <para> - Nginx module <literal>nginxModules.fastcgi-cache-purge</literal> renamed to official name <literal>nginxModules.cache-purge</literal>. - Nginx module <literal>nginxModules.ngx_aws_auth</literal> renamed to official name <literal>nginxModules.aws-auth</literal>. - </para> - </listitem> - <listitem> - <para> - The option <option>defaultPackages</option> was added. It installs the packages <package>perl</package>, <package>rsync</package> and <package>strace</package> for now. They were added unconditionally to <option>systemPackages</option> before, but are not strictly necessary for a minimal NixOS install. You can set it to an empty list to have a more minimal system. Be aware that some functionality might still have an impure dependency on those packages, so things might break. - </para> - </listitem> - <listitem> - <para> - The <literal>undervolt</literal> option no longer needs to apply its - settings every 30s. If they still become undone, open an issue and restore - the previous behaviour using <literal>undervolt.useTimer</literal>. - </para> - </listitem> - <listitem> - <para> - Agda has been heavily reworked. - <itemizedlist> - <listitem> - <para> - <literal>agda.mkDerivation</literal> has been heavily changed and - is now located at <package>agdaPackages.mkDerivation</package>. - </para> - </listitem> - <listitem> - <para> - New top-level packages <package>agda</package> and - <literal>agda.withPackages</literal> have been added, the second - of which sets up agda with access to chosen libraries. - </para> - </listitem> - <listitem> - <para> - All agda libraries now live under - <literal>agdaPackages</literal>. - </para> - </listitem> - <listitem> - <para> - Many broken libraries have been removed. - </para> - </listitem> - </itemizedlist> - See the <link - xlink:href="https://nixos.org/nixpkgs/manual/#agda">new - documentation</link> for more information. - </para> - </listitem> - <listitem> - <para> - The <literal>deepin</literal> package set has been removed from - nixpkgs. It was a work in progress to package the - <link xlink:href="https://www.deepin.org/en/dde/">Deepin Desktop Environment (DDE)</link>, - including libraries, tools and applications, and it was still - missing a service to launch the desktop environment. It has shown - to no longer be a feasible goal due to reasons discussed in - <link xlink:href="https://github.com/NixOS/nixpkgs/issues/94870">issue #94870</link>. - The package <literal>netease-cloud-music</literal> has also been - removed, as it depends on libraries from deepin. - </para> - </listitem> - <listitem> - <para> - The <literal>opendkim</literal> module now uses systemd sandboxing features - to limit the exposure of the system towards the opendkim service. - </para> - </listitem> - </itemizedlist> - <itemizedlist> - <listitem> - <para /> - <para> - Kubernetes has been upgraded to 1.19.1, which also means that the - golang version to build it has been bumped to 1.15. This may have - consequences for your existing clusters and their certificates. Please - consider - <link xlink:href="https://relnotes.k8s.io/?markdown=93264"> - the release notes for Kubernetes 1.19 carefully - </link> - before upgrading. - </para> - </listitem> - </itemizedlist> - <itemizedlist> - <listitem> - <para> - For AMD GPUs, Vulkan can now be used by adding <literal>amdvlk</literal> - to <literal>hardware.opengl.extraPackages</literal>. - </para> - </listitem> - <listitem> - <para> - Similarly, still for AMD GPUs, the ROCm OpenCL stack can now be used by adding - <literal>rocm-opencl-icd</literal> to - <literal>hardware.opengl.extraPackages</literal>. - </para> - </listitem> - </itemizedlist> - </section> - - <section xmlns="http://docbook.org/ns/docbook" - xmlns:xlink="http://www.w3.org/1999/xlink" - xmlns:xi="http://www.w3.org/2001/XInclude" - version="5.0" - xml:id="sec-release-20.09-contributions"> - <title>Contributions</title> - <para> - I, Jonathan Ringer, would like to thank the following individuals for their work on nixpkgs. This release could not be done without the hard work of the NixOS community. There were 31282 contributions across 1313 contributors. - </para> - <orderedlist> - <para> - Top contributors to NixOS/Nixpkgs from the 20.03 release to the 20.09 release: - </para> - <listitem> - <para> - 2288 Mario Rodas - </para> - </listitem> - <listitem> - <para> - 1837 Frederik Rietdijk - </para> - </listitem> - <listitem> - <para> - 946 Jörg Thalheim - </para> - </listitem> - <listitem> - <para> - 925 Maximilian Bosch - </para> - </listitem> - <listitem> - <para> - 687 Jonathan Ringer - </para> - </listitem> - <listitem> - <para> - 651 Jan Tojnar - </para> - </listitem> - <listitem> - <para> - 622 Daniël de Kok - </para> - </listitem> - <listitem> - <para> - 605 WORLDofPEACE - </para> - </listitem> - <listitem> - <para> - 597 Florian Klink - </para> - </listitem> - <listitem> - <para> - 528 José Romildo Malaquias - </para> - </listitem> - </orderedlist> - - <orderedlist> - <para> - Top contributors to stabilizing this release (Zero Hydra Failures period): - </para> - <listitem> - <para> - 281 volth - </para> - </listitem> - <listitem> - <para> - 101 Robert Scott - </para> - </listitem> - <listitem> - <para> - 86 Tim Steinbach - </para> - </listitem> - <listitem> - <para> - 76 WORLDofPEACE - </para> - </listitem> - <listitem> - <para> - 49 Maximilian Bosch - </para> - </listitem> - <listitem> - <para> - 42 Thomas Tuegel - </para> - </listitem> - <listitem> - <para> - 37 Doron Behar - </para> - </listitem> - <listitem> - <para> - 36 Vladimír Čunát - </para> - </listitem> - <listitem> - <para> - 27 Jonathan Ringer - </para> - </listitem> - <listitem> - <para> - 27 Maciej Krüger - </para> - </listitem> - </orderedlist> - - <para> - I, Jonathan Ringer, would also like to personally thank @WORLDofPEACE for their help in mentoring me on the release process. Special thanks also goes to Thomas Tuegel for helping immensely with stabilizing Qt, KDE, and Plasma5; I would also like to thank Robert Scott for his numerous fixes and pull request reviews. - </para> - - </section> -</section> diff --git a/nixos/doc/manual/release-notes/rl-2105.section.md b/nixos/doc/manual/release-notes/rl-2105.section.md new file mode 100644 index 00000000000..49b97c203fe --- /dev/null +++ b/nixos/doc/manual/release-notes/rl-2105.section.md @@ -0,0 +1,428 @@ +# Release 21.05 ("Okapi", 2021.05/31) {#sec-release-21.05} + +Support is planned until the end of December 2021, handing over to 21.11. + +## Highlights {#sec-release-21.05-highlights} + +In addition to numerous new and upgraded packages, this release has the following highlights: + +- Core version changes: + + - gcc: 9.3.0 -\> 10.3.0 + + - glibc: 2.30 -\> 2.32 + + - default linux: 5.4 -\> 5.10, all supported kernels available + + - mesa: 20.1.7 -\> 21.0.1 + +- Desktop Environments: + + - GNOME: 3.36 -\> 40, see its [release notes](https://help.gnome.org/misc/release-notes/40.0/) + + - Plasma5: 5.18.5 -\> 5.21.3 + + - kdeApplications: 20.08.1 -\> 20.12.3 + + - cinnamon: 4.6 -\> 4.8.1 + +- Programming Languages and Frameworks: + + - Python optimizations were disabled again. Builds with optimizations enabled are not reproducible. Optimizations can now be enabled with an option. + +- The linux_latest kernel was updated to the 5.12 series. It currently is not officially supported for use with the zfs filesystem. If you use zfs, you should use a different kernel version (either the LTS kernel, or track a specific one). + +## New Services {#sec-release-21.05-new-services} + +The following new services were added since the last release: + +- [GNURadio](https://www.gnuradio.org/) 3.8 and 3.9 were [finally](https://github.com/NixOS/nixpkgs/issues/82263) packaged, along with a rewrite to the Nix expressions, allowing users to override the features upstream supports selecting to compile or not to. Additionally, the attribute `gnuradio` (3.9), `gnuradio3_8` and `gnuradio3_7` now point to an externally wrapped by default derivations, that allow you to also add \`extraPythonPackages\` to the Python interpreter used by GNURadio. Missing environmental variables needed for operational GUI were also added ([\#75478](https://github.com/NixOS/nixpkgs/issues/75478)). + +- [Keycloak](https://www.keycloak.org/), an open source identity and access management server with support for [OpenID Connect](https://openid.net/connect/), [OAUTH 2.0](https://oauth.net/2/) and [SAML 2.0](https://en.wikipedia.org/wiki/SAML_2.0). + + See the [Keycloak section of the NixOS manual](#module-services-keycloak) for more information. + +- [services.samba-wsdd.enable](options.html#opt-services.samba-wsdd.enable) Web Services Dynamic Discovery host daemon + +- [Discourse](https://www.discourse.org/), a modern and open source discussion platform. + + See the [Discourse section of the NixOS manual](#module-services-discourse) for more information. + +- [services.nebula.networks](options.html#opt-services.nebula.networks) [Nebula VPN](https://github.com/slackhq/nebula) + +## Backward Incompatibilities {#sec-release-21.05-incompatibilities} + +When upgrading from a previous release, please be aware of the following incompatible changes: + +- GNOME desktop environment was upgraded to 40, see the release notes for [40.0](https://help.gnome.org/misc/release-notes/40.0/) and [3.38](https://help.gnome.org/misc/release-notes/3.38/). The `gnome3` attribute set has been renamed to `gnome` and so have been the NixOS options. + +- If you are using `services.udev.extraRules` to assign custom names to network interfaces, this may stop working due to a change in the initialisation of dhcpcd and systemd networkd. To avoid this, either move them to `services.udev.initrdRules` or see the new [Assigning custom names](#sec-custom-ifnames) section of the NixOS manual for an example using networkd links. + +- The `security.hideProcessInformation` module has been removed. It was broken since the switch to cgroups-v2. + +- The `linuxPackages.ati_drivers_x11` kernel modules have been removed. The drivers only supported kernels prior to 4.2, and thus have become obsolete. + +- The `systemConfig` kernel parameter is no longer added to boot loader entries. It has been unused since September 2010, but if do have a system generation from that era, you will now be unable to boot into them. + +- `systemd-journal2gelf` no longer parses json and expects the receiving system to handle it. How to achieve this with Graylog is described in this [GitHub issue](https://github.com/parse-nl/SystemdJournal2Gelf/issues/10). + +- If the `services.dbus` module is enabled, then the user D-Bus session is now always socket activated. The associated options `services.dbus.socketActivated` and `services.xserver.startDbusSession` have therefore been removed and you will receive a warning if they are present in your configuration. This change makes the user D-Bus session available also for non-graphical logins. + +- The `networking.wireless.iwd` module now installs the upstream-provided 80-iwd.link file, which sets the NamePolicy= for all wlan devices to \"keep kernel\", to avoid race conditions between iwd and networkd. If you don\'t want this, you can set `systemd.network.links."80-iwd" = lib.mkForce {}`. + +- `rubyMinimal` was removed due to being unused and unusable. The default ruby interpreter includes JIT support, which makes it reference it\'s compiler. Since JIT support is probably needed by some Gems, it was decided to enable this feature with all cc references by default, and allow to build a Ruby derivation without references to cc, by setting `jitSupport = false;` in an overlay. See [\#90151](https://github.com/NixOS/nixpkgs/pull/90151) for more info. + +- Setting `services.openssh.authorizedKeysFiles` now also affects which keys `security.pam.enableSSHAgentAuth` will use. WARNING: If you are using these options in combination do make sure that any key paths you use are present in `services.openssh.authorizedKeysFiles`! + +- The option `fonts.enableFontDir` has been renamed to [fonts.fontDir.enable](options.html#opt-fonts.fontDir.enable). The path of font directory has also been changed to `/run/current-system/sw/share/X11/fonts`, for consistency with other X11 resources. + +- A number of options have been renamed in the kicad interface. `oceSupport` has been renamed to `withOCE`, `withOCCT` has been renamed to `withOCC`, `ngspiceSupport` has been renamed to `withNgspice`, and `scriptingSupport` has been renamed to `withScripting`. Additionally, `kicad/base.nix` no longer provides default argument values since these are provided by `kicad/default.nix`. + +- The socket for the `pdns-recursor` module was moved from `/var/lib/pdns-recursor` to `/run/pdns-recursor` to match upstream. + +- Paperwork was updated to version 2. The on-disk format slightly changed, and it is not possible to downgrade from Paperwork 2 back to Paperwork 1.3. Back your documents up before upgrading. See [this thread](https://forum.openpaper.work/t/paperwork-2-0/112/5) for more details. + +- PowerDNS has been updated from `4.2.x` to `4.3.x`. Please be sure to review the [Upgrade Notes](https://doc.powerdns.com/authoritative/upgrading.html#x-to-4-3-0) provided by upstream before upgrading. Worth specifically noting is that the service now runs entirely as a dedicated `pdns` user, instead of starting as `root` and dropping privileges, as well as the default `socket-dir` location changing from `/var/lib/powerdns` to `/run/pdns`. + +- The `mediatomb` service is now using by default the new and maintained fork `gerbera` package instead of the unmaintained `mediatomb` package. If you want to keep the old behavior, you must declare it with: + + ```nix + { + services.mediatomb.package = pkgs.mediatomb; + } + ``` + + One new option `openFirewall` has been introduced which defaults to false. If you relied on the service declaration to add the firewall rules itself before, you should now declare it with: + + ```nix + { + services.mediatomb.openFirewall = true; + } + ``` + +- xfsprogs was update from 4.19 to 5.11. It now enables reflink support by default on filesystem creation. Support for reflinks was added with an experimental status to kernel 4.9 and deemed stable in kernel 4.16. If you want to be able to mount XFS filesystems created with this release of xfsprogs on kernel releases older than those, you need to format them with `mkfs.xfs -m reflink=0`. + +- The uWSGI server is now built with POSIX capabilities. As a consequence, root is no longer required in emperor mode and the service defaults to running as the unprivileged `uwsgi` user. Any additional capability can be added via the new option [services.uwsgi.capabilities](options.html#opt-services.uwsgi.capabilities). The previous behaviour can be restored by setting: + + ```nix + { + services.uwsgi.user = "root"; + services.uwsgi.group = "root"; + services.uwsgi.instance = + { + uid = "uwsgi"; + gid = "uwsgi"; + }; + } + ``` + + Another incompatibility from the previous release is that vassals running under a different user or group need to use `immediate-{uid,gid}` instead of the usual `uid,gid` options. + +- btc1 has been abandoned upstream, and removed. + +- cpp_ethereum (aleth) has been abandoned upstream, and removed. + +- riak-cs package removed along with `services.riak-cs` module. + +- stanchion package removed along with `services.stanchion` module. + +- mutt has been updated to a new major version (2.x), which comes with some backward incompatible changes that are described in the [release notes for Mutt 2.0](http://www.mutt.org/relnotes/2.0/). + +- `vim` and `neovim` switched to Python 3, dropping all Python 2 support. + +- [networking.wireguard.interfaces.\<name\>.generatePrivateKeyFile](options.html#opt-networking.wireguard.interfaces), which is off by default, had a `chmod` race condition fixed. As an aside, the parent directory\'s permissions were widened, and the key files were made owner-writable. This only affects newly created keys. However, if the exact permissions are important for your setup, read [\#121294](https://github.com/NixOS/nixpkgs/pull/121294). + +- [boot.zfs.forceImportAll](options.html#opt-boot.zfs.forceImportAll) previously did nothing, but has been fixed. However its default has been changed to `false` to preserve the existing default behaviour. If you have this explicitly set to `true`, please note that your non-root pools will now be forcibly imported. + +- openafs now points to openafs_1_8, which is the new stable release. OpenAFS 1.6 was removed. + +- The WireGuard module gained a new option `networking.wireguard.interfaces.<name>.peers.*.dynamicEndpointRefreshSeconds` that implements refreshing the IP of DNS-based endpoints periodically (which WireGuard itself [cannot do](https://lists.zx2c4.com/pipermail/wireguard/2017-November/002028.html)). + +- MariaDB has been updated to 10.5. Before you upgrade, it would be best to take a backup of your database and read [ Incompatible Changes Between 10.4 and 10.5](https://mariadb.com/kb/en/upgrading-from-mariadb-104-to-mariadb-105/#incompatible-changes-between-104-and-105). After the upgrade you will need to run `mysql_upgrade`. + +- The TokuDB storage engine dropped in mariadb 10.5 and removed in mariadb 10.6. It is recommended to switch to RocksDB. See also [TokuDB](https://mariadb.com/kb/en/tokudb/) and [MDEV-19780: Remove the TokuDB storage engine](https://jira.mariadb.org/browse/MDEV-19780). + +- The `openldap` module now has support for OLC-style configuration, users of the `configDir` option may wish to migrate. If you continue to use `configDir`, ensure that `olcPidFile` is set to `/run/slapd/slapd.pid`. + + As a result, `extraConfig` and `extraDatabaseConfig` are removed. To help with migration, you can convert your `slapd.conf` file to OLC configuration with the following script (find the location of this configuration file by running `systemctl status openldap`, it is the `-f` option. + + ```ShellSession + $ TMPDIR=$(mktemp -d) + $ slaptest -f /path/to/slapd.conf -F $TMPDIR + $ slapcat -F $TMPDIR -n0 -H 'ldap:///???(!(objectClass=olcSchemaConfig))' + ``` + + This will dump your current configuration in LDIF format, which should be straightforward to convert into Nix settings. This does not show your schema configuration, as this is unnecessarily verbose for users of the default schemas and `slaptest` is buggy with schemas directly in the config file. + +- Amazon EC2 and OpenStack Compute (nova) images now re-fetch instance meta data and user data from the instance metadata service (IMDS) on each boot. For example: stopping an EC2 instance, changing its user data, and restarting the instance will now cause it to fetch and apply the new user data. + + ::: {.warning} + Specifically, `/etc/ec2-metadata` is re-populated on each boot. Some NixOS scripts that read from this directory are guarded to only run if the files they want to manipulate do not already exist, and so will not re-apply their changes if the IMDS response changes. Examples: `root`\'s SSH key is only added if `/root/.ssh/authorized_keys` does not exist, and SSH host keys are only set from user data if they do not exist in `/etc/ssh`. + ::: + +- The `rspamd` services is now sandboxed. It is run as a dynamic user instead of root, so secrets and other files may have to be moved or their permissions may have to be fixed. The sockets are now located in `/run/rspamd` instead of `/run`. + +- Enabling the Tor client no longer silently also enables and configures Privoxy, and the `services.tor.client.privoxy.enable` option has been removed. To enable Privoxy, and to configure it to use Tor\'s faster port, use the following configuration: + + ```nix + { + opt-services.privoxy.enable = true; + opt-services.privoxy.enableTor = true; + } + ``` + +- The `services.tor` module has a new exhaustively typed [services.tor.settings](options.html#opt-services.tor.settings) option following RFC 0042; backward compatibility with old options has been preserved when aliasing was possible. The corresponding systemd service has been hardened, but there is a chance that the service still requires more permissions, so please report any related trouble on the bugtracker. Onion services v3 are now supported in [services.tor.relay.onionServices](options.html#opt-services.tor.relay.onionServices). A new [services.tor.openFirewall](options.html#opt-services.tor.openFirewall) option as been introduced for allowing connections on all the TCP ports configured. + +- The options `services.slurm.dbdserver.storagePass` and `services.slurm.dbdserver.configFile` have been removed. Use `services.slurm.dbdserver.storagePassFile` instead to provide the database password. Extra config options can be given via the option `services.slurm.dbdserver.extraConfig`. The actual configuration file is created on the fly on startup of the service. This avoids that the password gets exposed in the nix store. + +- The `wafHook` hook does not wrap Python anymore. Packages depending on `wafHook` need to include any Python into their `nativeBuildInputs`. + +- Starting with version 1.7.0, the project formerly named `CodiMD` is now named `HedgeDoc`. New installations will no longer use the old name for users, state directories and such, this needs to be considered when moving state to a more recent NixOS installation. Based on [system.stateVersion](options.html#opt-system.stateVersion), existing installations will continue to work. + +- The fish-foreign-env package has been replaced with fishPlugins.foreign-env, in which the fish functions have been relocated to the `vendor_functions.d` directory to be loaded automatically. + +- The prometheus json exporter is now managed by the prometheus community. Together with additional features some backwards incompatibilities were introduced. Most importantly the exporter no longer accepts a fixed command-line parameter to specify the URL of the endpoint serving JSON. It now expects this URL to be passed as an URL parameter, when scraping the exporter\'s `/probe` endpoint. In the prometheus scrape configuration the scrape target might look like this: + + ``` + http://some.json-exporter.host:7979/probe?target=https://example.com/some/json/endpoint + ``` + + Existing configuration for the exporter needs to be updated, but can partially be re-used. Documentation is available in the upstream repository and a small example for NixOS is available in the corresponding NixOS test. + + These changes also affect [services.prometheus.exporters.rspamd.enable](options.html#opt-services.prometheus.exporters.rspamd.enable), which is just a preconfigured instance of the json exporter. + + For more information, take a look at the [ official documentation](https://github.com/prometheus-community/json_exporter) of the json_exporter. + +- Androidenv was updated, removing the `includeDocs` and `lldbVersions` arguments. Docs only covered a single version of the Android SDK, LLDB is now bundled with the NDK, and both are no longer available to download from the Android package repositories. Additionally, since the package lists have been updated, some older versions of Android packages may not be bundled. If you depend on older versions of Android packages, we recommend overriding the repo. + + Android packages are now loaded from a repo.json file created by parsing Android repo XML files. The arguments `repoJson` and `repoXmls` have been added to allow overriding the built-in androidenv repo.json with your own. Additionally, license files are now written to allow compatibility with Gradle-based tools, and the `extraLicenses` argument has been added to accept more SDK licenses if your project requires it. See the androidenv documentation for more details. + +- The attribute `mpi` is now consistently used to provide a default, system-wide MPI implementation. The default implementation is openmpi, which has been used before by all derivations affects by this change. Note that all packages that have used `mpi ? null` in the input for optional MPI builds, have been changed to the boolean input paramater `useMpi` to enable building with MPI. Building all packages with `mpich` instead of the default `openmpi` can now be achived like this: + + ```nix + self: super: + { + mpi = super.mpich; + } + ``` + +- The Searx module has been updated with the ability to configure the service declaratively and uWSGI integration. The option `services.searx.configFile` has been renamed to [services.searx.settingsFile](options.html#opt-services.searx.settingsFile) for consistency with the new [services.searx.settings](options.html#opt-services.searx.settings). In addition, the `searx` uid and gid reservations have been removed since they were not necessary: the service is now running with a dynamically allocated uid. + +- The libinput module has been updated with the ability to configure mouse and touchpad settings separately. The options in `services.xserver.libinput` have been renamed to `services.xserver.libinput.touchpad`, while there is a new `services.xserver.libinput.mouse` for mouse related configuration. + + Since touchpad options no longer apply to all devices, you may want to replicate your touchpad configuration in mouse section. + +- ALSA OSS emulation (`sound.enableOSSEmulation`) is now disabled by default. + +- Thinkfan as been updated to `1.2.x`, which comes with a new YAML based configuration format. For this reason, several NixOS options of the thinkfan module have been changed to non-backward compatible types. In addition, a new [services.thinkfan.settings](options.html#opt-services.thinkfan.settings) option has been added. + + Please read the [ thinkfan documentation](https://github.com/vmatare/thinkfan#readme) before updating. + +- Adobe Flash Player support has been dropped from the tree. In particular, the following packages no longer support it: + + - chromium + + - firefox + + - qt48 + + - qt5.qtwebkit + + Additionally, packages flashplayer and hal-flash were removed along with the `services.flashpolicyd` module. + +- The `security.rngd` module has been removed. It was disabled by default in 20.09 as it was functionally redundant with krngd in the linux kernel. It is not necessary for any device that the kernel recognises as an hardware RNG, as it will automatically run the krngd task to periodically collect random data from the device and mix it into the kernel\'s RNG. + + The default SMTP port for GitLab has been changed to `25` from its previous default of `465`. If you depended on this default, you should now set the [services.gitlab.smtp.port](options.html#opt-services.gitlab.smtp.port) option. + +- The default version of ImageMagick has been updated from 6 to 7. You can use imagemagick6, imagemagick6_light, and imagemagick6Big if you need the older version. + +- [services.xserver.videoDrivers](options.html#opt-services.xserver.videoDrivers) no longer uses the deprecated `cirrus` and `vesa` device dependent X drivers by default. It also enables both `amdgpu` and `nouveau` drivers by default now. + +- The `kindlegen` package is gone, because it is no longer supported or hosted by Amazon. Sadly, its replacement, Kindle Previewer, has no Linux support. However, there are other ways to generate MOBI files. See [the discussion](https://github.com/NixOS/nixpkgs/issues/96439) for more info. + +- The apacheKafka packages are now built with version-matched JREs. Versions 2.6 and above, the ones that recommend it, use jdk11, while versions below remain on jdk8. The NixOS service has been adjusted to start the service using the same version as the package, adjustable with the new [services.apache-kafka.jre](options.html#opt-services.apache-kafka.jre) option. Furthermore, the default list of [services.apache-kafka.jvmOptions](options.html#opt-services.apache-kafka.jvmOptions) have been removed. You should set your own according to the [upstream documentation](https://kafka.apache.org/documentation/#java) for your Kafka version. + +- The kodi package has been modified to allow concise addon management. Consider the following configuration from previous releases of NixOS to install kodi, including the kodiPackages.inputstream-adaptive and kodiPackages.vfs-sftp addons: + + ```nix + { + environment.systemPackages = [ + pkgs.kodi + ]; + + nixpkgs.config.kodi = { + enableInputStreamAdaptive = true; + enableVFSSFTP = true; + }; + } + ``` + + All Kodi `config` flags have been removed, and as a result the above configuration should now be written as: + + ```nix + { + environment.systemPackages = [ + (pkgs.kodi.withPackages (p: with p; [ + inputstream-adaptive + vfs-sftp + ])) + ]; + } + ``` + +- `environment.defaultPackages` now includes the nano package. If pkgs.nano is not added to the list, make sure another editor is installed and the `EDITOR` environment variable is set to it. Environment variables can be set using `environment.variables`. + +- `services.minio.dataDir` changed type to a list of paths, required for specifiyng multiple data directories for using with erasure coding. Currently, the service doesn\'t enforce nor checks the correct number of paths to correspond to minio requirements. + +- All CUDA toolkit versions prior to CUDA 10 have been removed. + +- The kbdKeymaps package was removed since dvp and neo are now included in kbd. If you want to use the Programmer Dvorak Keyboard Layout, you have to use `dvorak-programmer` in `console.keyMap` now instead of `dvp`. In `services.xserver.xkbVariant` it\'s still `dvp`. + +- The babeld service is now being run as an unprivileged user. To achieve that the module configures `skip-kernel-setup true` and takes care of setting forwarding and rp_filter sysctls by itself as well as for each interface in `services.babeld.interfaces`. + +- The `services.zigbee2mqtt.config` option has been renamed to `services.zigbee2mqtt.settings` and now follows [RFC 0042](https://github.com/NixOS/rfcs/blob/master/rfcs/0042-config-option.md). + + The yadm dotfile manager has been updated from 2.x to 3.x, which has new (XDG) default locations for some data/state files. Most yadm commands will fail and print a legacy path warning (which describes how to upgrade/migrate your repository). If you have scripts, daemons, scheduled jobs, shell profiles, etc. that invoke yadm, expect them to fail or misbehave until you perform this migration and prepare accordingly. + +- Instead of determining `services.radicale.package` automatically based on `system.stateVersion`, the latest version is always used because old versions are not officially supported. + + Furthermore, Radicale\'s systemd unit was hardened which might break some deployments. In particular, a non-default `filesystem_folder` has to be added to `systemd.services.radicale.serviceConfig.ReadWritePaths` if the deprecated `services.radicale.config` is used. + +- In the `security.acme` module, use of `--reuse-key` parameter for Lego has been removed. It was introduced for HKPK, but this security feature is now deprecated. It is a better security practice to rotate key pairs instead of always keeping the same. If you need to keep this parameter, you can add it back using `extraLegoRenewFlags` as an option for the appropriate certificate. + +## Other Notable Changes {#sec-release-21.05-notable-changes} + +- `stdenv.lib` has been deprecated and will break eval in 21.11. Please use `pkgs.lib` instead. See [\#108938](https://github.com/NixOS/nixpkgs/issues/108938) for details. + +- [GNURadio](https://www.gnuradio.org/) has a `pkgs` attribute set, and there\'s a `gnuradio.callPackage` function that extends `pkgs` with a `mkDerivation`, and a `mkDerivationWith`, like Qt5. Now all `gnuradio.pkgs` are defined with `gnuradio.callPackage` and some packages that depend on gnuradio are defined with this as well. + +- [Privoxy](https://www.privoxy.org/) has been updated to version 3.0.32 (See [announcement](https://lists.privoxy.org/pipermail/privoxy-announce/2021-February/000007.html)). Compared to the previous release, Privoxy has gained support for HTTPS inspection (still experimental), Brotli decompression, several new filters and lots of bug fixes, including security ones. In addition, the package is now built with compression and external filters support, which were previously disabled. + + Regarding the NixOS module, new options for HTTPS inspection have been added and `services.privoxy.extraConfig` has been replaced by the new [services.privoxy.settings](options.html#opt-services.privoxy.settings) (See [RFC 0042](https://github.com/NixOS/rfcs/blob/master/rfcs/0042-config-option.md) for the motivation). + +- [Kodi](https://kodi.tv/) has been updated to version 19.1 \"Matrix\". See the [announcement](https://kodi.tv/article/kodi-19-0-matrix-release) for further details. + +- The `services.packagekit.backend` option has been removed as it only supported a single setting which would always be the default. Instead new [RFC 0042](https://github.com/NixOS/rfcs/blob/master/rfcs/0042-config-option.md) compliant [services.packagekit.settings](options.html#opt-services.packagekit.settings) and [services.packagekit.vendorSettings](options.html#opt-services.packagekit.vendorSettings) options have been introduced. + +- [Nginx](https://nginx.org) has been updated to stable version 1.20.0. Now nginx uses the zlib-ng library by default. + +- KDE Gear (formerly KDE Applications) is upgraded to 21.04, see its [release notes](https://kde.org/announcements/gear/21.04/) for details. + + The `kdeApplications` package set is now `kdeGear`, in keeping with the new name. The old name remains for compatibility, but it is deprecated. + +- [Libreswan](https://libreswan.org/) has been updated to version 4.4. The package now includes example configurations and manual pages by default. The NixOS module has been changed to use the upstream systemd units and write the configuration in the `/etc/ipsec.d/ ` directory. In addition, two new options have been added to specify connection policies ([services.libreswan.policies](options.html#opt-services.libreswan.policies)) and disable send/receive redirects ([services.libreswan.disableRedirects](options.html#opt-services.libreswan.disableRedirects)). + +- The Mailman NixOS module (`services.mailman`) has a new option [services.mailman.enablePostfix](options.html#opt-services.mailman.enablePostfix), defaulting to true, that controls integration with Postfix. + + If this option is disabled, default MTA config becomes not set and you should set the options in `services.mailman.settings.mta` according to the desired configuration as described in [Mailman documentation](https://mailman.readthedocs.io/en/latest/src/mailman/docs/mta.html). + +- The default-version of `nextcloud` is nextcloud21. Please note that it\'s _not_ possible to upgrade `nextcloud` across multiple major versions! This means that it\'s e.g. not possible to upgrade from nextcloud18 to nextcloud20 in a single deploy and most `20.09` users will have to upgrade to nextcloud20 first. + + The package can be manually upgraded by setting [services.nextcloud.package](options.html#opt-services.nextcloud.package) to nextcloud21. + +- The setting [services.redis.bind](options.html#opt-services.redis.bind) defaults to `127.0.0.1` now, making Redis listen on the loopback interface only, and not all public network interfaces. + +- NixOS now emits a deprecation warning if systemd\'s `StartLimitInterval` setting is used in a `serviceConfig` section instead of in a `unitConfig`; that setting is deprecated and now undocumented for the service section by systemd upstream, but still effective and somewhat buggy there, which can be confusing. See [\#45785](https://github.com/NixOS/nixpkgs/issues/45785) for details. + + All services should use [systemd.services._name_.startLimitIntervalSec](options.html#opt-systemd.services._name_.startLimitIntervalSec) or `StartLimitIntervalSec` in [systemd.services._name_.unitConfig](options.html#opt-systemd.services._name_.unitConfig) instead. + +- The `mediatomb` service declares new options. It also adapts existing options so the configuration generation is now lazy. The existing option `customCfg` (defaults to false), when enabled, stops the service configuration generation completely. It then expects the users to provide their own correct configuration at the right location (whereas the configuration was generated and not used at all before). The new option `transcodingOption` (defaults to no) allows a generated configuration. It makes the mediatomb service pulls the necessary runtime dependencies in the nix store (whereas it was generated with hardcoded values before). The new option `mediaDirectories` allows the users to declare autoscan media directories from their nixos configuration: + + ```nix + { + services.mediatomb.mediaDirectories = [ + { path = "/var/lib/mediatomb/pictures"; recursive = false; hidden-files = false; } + { path = "/var/lib/mediatomb/audio"; recursive = true; hidden-files = false; } + ]; + } + ``` + +- The Unbound DNS resolver service (`services.unbound`) has been refactored to allow reloading, control sockets and to fix startup ordering issues. + + It is now possible to enable a local UNIX control socket for unbound by setting the [services.unbound.localControlSocketPath](options.html#opt-services.unbound.localControlSocketPath) option. + + Previously we just applied a very minimal set of restrictions and trusted unbound to properly drop root privs and capabilities. + + As of this we are (for the most part) just using the upstream example unit file for unbound. The main difference is that we start unbound as `unbound` user with the required capabilities instead of letting unbound do the chroot & uid/gid changes. + + The upstream unit configuration this is based on is a lot stricter with all kinds of permissions then our previous variant. It also came with the default of having the `Type` set to `notify`, therefore we are now also using the `unbound-with-systemd` package here. Unbound will start up, read the configuration files and start listening on the configured ports before systemd will declare the unit `active (running)`. This will likely help with startup order and the occasional race condition during system activation where the DNS service is started but not yet ready to answer queries. Services depending on `nss-lookup.target` or `unbound.service` are now be able to use unbound when those targets have been reached. + + Additionally to the much stricter runtime environment the `/dev/urandom` mount lines we previously had in the code (that randomly failed during the stop-phase) have been removed as systemd will take care of those for us. + + The `preStart` script is now only required if we enabled the trust anchor updates (which are still enabled by default). + + Another benefit of the refactoring is that we can now issue reloads via either `pkill -HUP unbound` and `systemctl reload unbound` to reload the running configuration without taking the daemon offline. A prerequisite of this was that unbound configuration is available on a well known path on the file system. We are using the path `/etc/unbound/unbound.conf` as that is the default in the CLI tooling which in turn enables us to use `unbound-control` without passing a custom configuration location. + + The module has also been reworked to be [RFC 0042](https://github.com/NixOS/rfcs/blob/master/rfcs/0042-config-option.md) compliant. As such, `sevices.unbound.extraConfig` has been removed and replaced by [services.unbound.settings](options.html#opt-services.unbound.settings). `services.unbound.interfaces` has been renamed to `services.unbound.settings.server.interface`. + + `services.unbound.forwardAddresses` and `services.unbound.allowedAccess` have also been changed to use the new settings interface. You can follow the instructions when executing `nixos-rebuild` to upgrade your configuration to use the new interface. + +- The `services.dnscrypt-proxy2` module now takes the upstream\'s example configuration and updates it with the user\'s settings. An option has been added to restore the old behaviour if you prefer to declare the configuration from scratch. + +- NixOS now defaults to the unified cgroup hierarchy (cgroupsv2). See the [Fedora Article for 31](https://www.redhat.com/sysadmin/fedora-31-control-group-v2) for details on why this is desirable, and how it impacts containers. + + If you want to run containers with a runtime that does not yet support cgroupsv2, you can switch back to the old behaviour by setting [systemd.enableUnifiedCgroupHierarchy](options.html#opt-systemd.enableUnifiedCgroupHierarchy) = `false`; and rebooting. + +- PulseAudio was upgraded to 14.0, with changes to the handling of default sinks. See its [release notes](https://www.freedesktop.org/wiki/Software/PulseAudio/Notes/14.0/). + +- GNOME users may wish to delete their `~/.config/pulse` due to the changes to stream routing logic. See [PulseAudio bug 832](https://gitlab.freedesktop.org/pulseaudio/pulseaudio/-/issues/832) for more information. + +- The zookeeper package does not provide `zooInspector.sh` anymore, as that \"contrib\" has been dropped from upstream releases. + +- In the ACME module, the data used to build the hash for the account directory has changed to accomodate new features to reduce account rate limit issues. This will trigger new account creation on the first rebuild following this update. No issues are expected to arise from this, thanks to the new account creation handling. + +- [users.users._name_.createHome](options.html#opt-users.users._name_.createHome) now always ensures home directory permissions to be `0700`. Permissions had previously been ignored for already existing home directories, possibly leaving them readable by others. The option\'s description was incorrect regarding ownership management and has been simplified greatly. + +- When defining a new user, one of [users.users._name_.isNormalUser](options.html#opt-users.users._name_.isNormalUser) and [users.users._name_.isSystemUser](options.html#opt-users.users._name_.isSystemUser) is now required. This is to prevent accidentally giving a UID above 1000 to system users, which could have unexpected consequences, like running user activation scripts for system users. Note that users defined with an explicit UID below 500 are exempted from this check, as [users.users._name_.isSystemUser](options.html#opt-users.users._name_.isSystemUser) has no effect for those. + +- The `security.apparmor` module, for the [AppArmor](https://gitlab.com/apparmor/apparmor/-/wikis/Documentation) Mandatory Access Control system, has been substantialy improved along with related tools, so that module maintainers can now more easily write AppArmor profiles for NixOS. The most notable change on the user-side is the new option [security.apparmor.policies](options.html#opt-security.apparmor.policies), replacing the previous `profiles` option to provide a way to disable a profile and to select whether to confine in enforce mode (default) or in complain mode (see `journalctl -b --grep apparmor`). Security-minded users may also want to enable [security.apparmor.killUnconfinedConfinables](options.html#opt-security.apparmor.killUnconfinedConfinables), at the cost of having some of their processes killed when updating to a NixOS version introducing new AppArmor profiles. + +- The GNOME desktop manager once again installs gnome.epiphany by default. + +- NixOS now generates empty `/etc/netgroup`. `/etc/netgroup` defines network-wide groups and may affect to setups using NIS. + +- Platforms, like `stdenv.hostPlatform`, no longer have a `platform` attribute. It has been (mostly) flattened away: + + - `platform.gcc` is now `gcc` + + - `platform.kernel*` is now `linux-kernel.*` + + Additionally, `platform.kernelArch` moved to the top level as `linuxArch` to match the other `*Arch` variables. + + The `platform` grouping of these things never meant anything, and was just a historial/implementation artifact that was overdue removal. + +- `services.restic` now uses a dedicated cache directory for every backup defined in `services.restic.backups`. The old global cache directory, `/root/.cache/restic`, is now unused and can be removed to free up disk space. + +- `isync`: The `isync` compatibility wrapper was removed and the Master/Slave terminology has been deprecated and should be replaced with Far/Near in the configuration file. + +- The nix-gc service now accepts randomizedDelaySec (default: 0) and persistent (default: true) parameters. By default nix-gc will now run immediately if it would have been triggered at least once during the time when the timer was inactive. + +- The `rustPlatform.buildRustPackage` function is split into several hooks: cargoSetupHook to set up vendoring for Cargo-based projects, cargoBuildHook to build a project using Cargo, cargoInstallHook to install a project using Cargo, and cargoCheckHook to run tests in Cargo-based projects. With this change, mixed-language projects can use the relevant hooks within builders other than `buildRustPackage`. However, these changes also required several API changes to `buildRustPackage` itself: + + - The `target` argument was removed. Instead, `buildRustPackage` will always use the same target as the C/C++ compiler that is used. + + - The `cargoParallelTestThreads` argument was removed. Parallel tests are now disabled through `dontUseCargoParallelTests`. + +- The `rustPlatform.maturinBuildHook` hook was added. This hook can be used with `buildPythonPackage` to build Python packages that are written in Rust and use Maturin as their build tool. + +- Kubernetes has [deprecated docker](https://kubernetes.io/blog/2020/12/02/dont-panic-kubernetes-and-docker/) as container runtime. As a consequence, the Kubernetes module now has support for configuration of custom remote container runtimes and enables containerd by default. Note that containerd is more strict regarding container image OCI-compliance. As an example, images with CMD or ENTRYPOINT defined as strings (not lists) will fail on containerd, while working fine on docker. Please test your setup and container images with containerd prior to upgrading. + +- The GitLab module now has support for automatic backups. A schedule can be set with the [services.gitlab.backup.startAt](options.html#opt-services.gitlab.backup.startAt) option. + +- Prior to this release, systemd would also read system units from an undocumented `/etc/systemd-mutable/system` path. This path has been dropped from the defaults. That path (or others) can be re-enabled by adding it to the [boot.extraSystemdUnitPaths](options.html#opt-boot.extraSystemdUnitPaths) list. + +- PostgreSQL 9.5 is scheduled EOL during the 21.05 life cycle and has been removed. + +- [Xfce4](https://www.xfce.org/) relies on GIO/GVfs for userspace virtual filesystem access in applications like [thunar](https://docs.xfce.org/xfce/thunar/) and [gigolo](https://docs.xfce.org/apps/gigolo/). For that to work, the gvfs nixos service is enabled by default, and it can be configured with the specific package that provides GVfs. Until now Xfce4 was setting it to use a lighter version of GVfs (without support for samba). To avoid conflicts with other desktop environments this setting has been dropped. Users that still want it should add the following to their system configuration: + + ```nix + { + services.gvfs.package = pkgs.gvfs.override { samba = null; }; + } + ``` + +- The newly enabled `systemd-pstore.service` now automatically evacuates crashdumps and panic logs from the persistent storage to `/var/lib/systemd/pstore`. This prevents NVRAM from filling up, which ensures the latest diagnostic data is always stored and alleviates problems with writing new boot configurations. + +- Nixpkgs now contains [automatically packaged GNOME Shell extensions](https://github.com/NixOS/nixpkgs/pull/118232) from the [GNOME Extensions](https://extensions.gnome.org/) portal. You can find them, filed by their UUID, under `gnome38Extensions` attribute for GNOME 3.38 and under `gnome40Extensions` for GNOME 40. Finally, the `gnomeExtensions` attribute contains extensions for the latest GNOME Shell version in Nixpkgs, listed under a more human-friendly name. The unqualified attribute scope also contains manually packaged extensions. Note that the automatically packaged extensions are provided for convenience and are not checked or guaranteed to work. + +- Erlang/OTP versions older than R21 got dropped. We also dropped the cuter package, as it was purely an example of how to build a package. We also dropped `lfe_1_2` as it could not build with R21+. Moving forward, we expect to only support 3 yearly releases of OTP. diff --git a/nixos/doc/manual/release-notes/rl-2105.xml b/nixos/doc/manual/release-notes/rl-2105.xml deleted file mode 100644 index 07b28147d69..00000000000 --- a/nixos/doc/manual/release-notes/rl-2105.xml +++ /dev/null @@ -1,1146 +0,0 @@ -<section xmlns="http://docbook.org/ns/docbook" - xmlns:xlink="http://www.w3.org/1999/xlink" - xmlns:xi="http://www.w3.org/2001/XInclude" - version="5.0" - xml:id="sec-release-21.05"> - <title>Release 21.05 (“Okapi”, 2021.05/??)</title> - - <section xmlns="http://docbook.org/ns/docbook" - xmlns:xlink="http://www.w3.org/1999/xlink" - xmlns:xi="http://www.w3.org/2001/XInclude" - version="5.0" - xml:id="sec-release-21.05-highlights"> - <title>Highlights</title> - - <para> - In addition to numerous new and upgraded packages, this release has the - following highlights: - </para> - - <itemizedlist> - <listitem> - <para> - Support is planned until the end of December 2021, handing over to 21.11. - </para> - </listitem> - <listitem> - <para>The default Linux kernel was updated to the 5.10 LTS series, coming from the 5.4 LTS series.</para> - </listitem> - <listitem> - <para>GNOME desktop environment was upgraded to 40, see the release notes for <link xlink:href="https://help.gnome.org/misc/release-notes/40.0/">40.0</link> and <link xlink:href="https://help.gnome.org/misc/release-notes/3.38/">3.38</link>. The <code>gnome3</code> attribute set has been renamed to <code>gnome</code> and so have been the NixOS options.</para> - </listitem> - <listitem> - <para> - <link xlink:href="https://www.gnuradio.org/">GNURadio</link> 3.8 was - <link xlink:href="https://github.com/NixOS/nixpkgs/issues/82263">finally</link> - packaged, along with a rewrite to the Nix expressions, allowing users to - override the features upstream supports selecting to compile or not to. - Additionally, the attribute <code>gnuradio</code> and <code>gnuradio3_7</code> - now point to an externally wrapped by default derivations, that allow you to - also add `extraPythonPackages` to the Python interpreter used by GNURadio. - Missing environmental variables needed for operational GUI were also added - (<link xlink:href="https://github.com/NixOS/nixpkgs/issues/75478">#75478</link>). - </para> - </listitem> - <listitem> - <para> - <link xlink:href="https://www.gnuradio.org/">GNURadio</link> has a - <code>pkgs</code> attribute set, and there's a <code>gnuradio.callPackage</code> - function that extends <code>pkgs</code> with a <code>mkDerivation</code>, and a - <code>mkDerivationWith</code>, like Qt5. Now all <code>gnuradio.pkgs</code> are - defined with <code>gnuradio.callPackage</code> and some packages that depend - on gnuradio are defined with this as well. - </para> - </listitem> - <listitem> - <para> - <link xlink:href="https://www.privoxy.org/">Privoxy</link> has been updated - to version 3.0.32 (See <link xlink:href="https://lists.privoxy.org/pipermail/privoxy-announce/2021-February/000007.html">announcement</link>). - Compared to the previous release, Privoxy has gained support for HTTPS - inspection (still experimental), Brotli decompression, several new filters - and lots of bug fixes, including security ones. In addition, the package - is now built with compression and external filters support, which were - previously disabled. - </para> - <para> - Regarding the NixOS module, new options for HTTPS inspection have been added - and <option>services.privoxy.extraConfig</option> has been replaced by the new - <xref linkend="opt-services.privoxy.settings"/> - (See <link xlink:href="https://github.com/NixOS/rfcs/blob/master/rfcs/0042-config-option.md">RFC 0042</link> - for the motivation). - </para> - </listitem> - <listitem> - <para> - Python optimizations were disabled again. Builds with optimizations enabled - are not reproducible. Optimizations can now be enabled with an option. - </para> - </listitem> - <listitem> - <para> - <link xlink:href="https://kodi.tv/">Kodi</link> has been updated to version 19.1 "Matrix". See - the <link xlink:href="https://kodi.tv/article/kodi-190-matrix-release">announcement</link> for - further details. - </para> - </listitem> - <listitem> - <para> - The <option>services.packagekit.backend</option> option has been removed as - it only supported a single setting which would always be the default. - Instead new <link - xlink:href="https://github.com/NixOS/rfcs/blob/master/rfcs/0042-config-option.md">RFC - 0042</link> compliant <xref linkend="opt-services.packagekit.settings"/> - and <xref linkend="opt-services.packagekit.vendorSettings"/> options have - been introduced. - </para> - </listitem> - <listitem> - <para> - <link xlink:href="https://nginx.org">Nginx</link> has been updated to stable version 1.20.0. - Now nginx uses the zlib-ng library by default. - </para> - </listitem> - <listitem> - <para> - KDE Gear (formerly KDE Applications) is upgraded to 21.04, see its - <link xlink:href="https://kde.org/announcements/gear/21.04/">release - notes</link> for details. - </para> - <para> - The <code>kdeApplications</code> package set is now <code>kdeGear</code>, - in keeping with the new name. The old name remains for compatibility, but - it is deprecated. - </para> - </listitem> - <listitem> - <para> - <link xlink:href="https://libreswan.org/">Libreswan</link> has been updated - to version 4.4. The package now includes example configurations and manual - pages by default. The NixOS module has been changed to use the upstream - systemd units and write the configuration in the <literal>/etc/ipsec.d/ - </literal> directory. In addition, two new options have been added to - specify connection policies - (<xref linkend="opt-services.libreswan.policies"/>) - and disable send/receive redirects - (<xref linkend="opt-services.libreswan.disableRedirects"/>). - </para> - </listitem> - </itemizedlist> - </section> - - <section xmlns="http://docbook.org/ns/docbook" - xmlns:xlink="http://www.w3.org/1999/xlink" - xmlns:xi="http://www.w3.org/2001/XInclude" - version="5.0" - xml:id="sec-release-21.05-new-services"> - <title>New Services</title> - - <para> - The following new services were added since the last release: - </para> - - <itemizedlist> - <listitem> - <para> - <link xlink:href="https://www.keycloak.org/">Keycloak</link>, - an open source identity and access management server with - support for <link - xlink:href="https://openid.net/connect/">OpenID Connect</link>, - <link xlink:href="https://oauth.net/2/">OAUTH 2.0</link> and - <link xlink:href="https://en.wikipedia.org/wiki/SAML_2.0">SAML - 2.0</link>. - </para> - <para> - See the <link linkend="module-services-keycloak">Keycloak - section of the NixOS manual</link> for more information. - </para> - </listitem> - <listitem> - <para> - <xref linkend="opt-services.samba-wsdd.enable" /> Web Services Dynamic Discovery host daemon - </para> - </listitem> - <listitem> - <para> - <link xlink:href="https://www.discourse.org/">Discourse</link>, a - modern and open source discussion platform. - </para> - <para> - See the <link linkend="module-services-discourse">Discourse - section of the NixOS manual</link> for more information. - </para> - </listitem> - <listitem> - <para> - <xref linkend="opt-services.nebula.networks" /> <link xlink:href="https://github.com/slackhq/nebula">Nebula VPN</link> - </para> - </listitem> - </itemizedlist> - - </section> - - <section xmlns="http://docbook.org/ns/docbook" - xmlns:xlink="http://www.w3.org/1999/xlink" - xmlns:xi="http://www.w3.org/2001/XInclude" - version="5.0" - xml:id="sec-release-21.05-incompatibilities"> - <title>Backward Incompatibilities</title> - - <para> - When upgrading from a previous release, please be aware of the following - incompatible changes: - </para> - - <itemizedlist> - <listitem> - <para> - If you are using <option>services.udev.extraRules</option> to assign - custom names to network interfaces, this may stop working due to a change - in the initialisation of dhcpcd and systemd networkd. To avoid this, either - move them to <option>services.udev.initrdRules</option> or see the new - <link linkend="sec-custom-ifnames">Assigning custom names</link> section - of the NixOS manual for an example using networkd links. - </para> - </listitem> - <listitem> - <para> - The <option>security.hideProcessInformation</option> module has been removed. - It was broken since the switch to cgroups-v2. - </para> - </listitem> - <listitem> - <para> - The <literal>linuxPackages.ati_drivers_x11</literal> kernel modules have been removed. - The drivers only supported kernels prior to 4.2, and thus have become obsolete. - </para> - </listitem> - <listitem> - <para> - The <literal>systemConfig</literal> kernel parameter is no longer added to boot loader entries. It has been unused since September 2010, but if do have a system generation from that era, you will now be unable to boot into them. - </para> - </listitem> - <listitem> - <para> - <literal>systemd-journal2gelf</literal> no longer parses json and expects the receiving system to handle it. How to achieve this with Graylog is described in this <link xlink:href="https://github.com/parse-nl/SystemdJournal2Gelf/issues/10">GitHub issue</link>. - </para> - </listitem> - <listitem> - <para> - If the <varname>services.dbus</varname> module is enabled, then - the user D-Bus session is now always socket activated. The - associated options <varname>services.dbus.socketActivated</varname> - and <varname>services.xserver.startDbusSession</varname> have - therefore been removed and you will receive a warning if - they are present in your configuration. This change makes the - user D-Bus session available also for non-graphical logins. - </para> - </listitem> - <listitem> - <para> - The <varname>networking.wireless.iwd</varname> module now installs - the upstream-provided 80-iwd.link file, which sets the NamePolicy= - for all wlan devices to "keep kernel", to avoid race conditions - between iwd and networkd. If you don't want this, you can set - <literal>systemd.network.links."80-iwd" = lib.mkForce {}</literal>. - </para> - </listitem> - <listitem> - <para> - <literal>rubyMinimal</literal> was removed due to being unused and - unusable. The default ruby interpreter includes JIT support, which makes - it reference it's compiler. Since JIT support is probably needed by some - Gems, it was decided to enable this feature with all cc references by - default, and allow to build a Ruby derivation without references to cc, - by setting <literal>jitSupport = false;</literal> in an overlay. See - <link xlink:href="https://github.com/NixOS/nixpkgs/pull/90151">#90151</link> - for more info. - </para> - </listitem> - <listitem> - <para> - Setting <option>services.openssh.authorizedKeysFiles</option> now also affects which keys <option>security.pam.enableSSHAgentAuth</option> will use. - - WARNING: If you are using these options in combination do make sure that any key paths you use are present in <option>services.openssh.authorizedKeysFiles</option>! - </para> - </listitem> - <listitem> - <para> - The option <option>fonts.enableFontDir</option> has been renamed to - <xref linkend="opt-fonts.fontDir.enable"/>. The path of font directory - has also been changed to <literal>/run/current-system/sw/share/X11/fonts</literal>, - for consistency with other X11 resources. - </para> - </listitem> - <listitem> - <para> - A number of options have been renamed in the kicad interface. <literal>oceSupport</literal> - has been renamed to <literal>withOCE</literal>, <literal>withOCCT</literal> has been renamed - to <literal>withOCC</literal>, <literal>ngspiceSupport</literal> has been renamed to - <literal>withNgspice</literal>, and <literal>scriptingSupport</literal> has been renamed to - <literal>withScripting</literal>. Additionally, <literal>kicad/base.nix</literal> no longer - provides default argument values since these are provided by - <literal>kicad/default.nix</literal>. - </para> - </listitem> - <listitem> - <para> - The socket for the <literal>pdns-recursor</literal> module was moved from <literal>/var/lib/pdns-recursor</literal> - to <literal>/run/pdns-recursor</literal> to match upstream. - </para> - </listitem> - <listitem> - <para> - Paperwork was updated to version 2. The on-disk format slightly changed, - and it is not possible to downgrade from Paperwork 2 back to Paperwork - 1.3. Back your documents up before upgrading. See <link xlink:href="https://forum.openpaper.work/t/paperwork-2-0/112/5">this thread</link> for more details. - </para> - </listitem> - <listitem> - <para> - PowerDNS has been updated from <literal>4.2.x</literal> to <literal>4.3.x</literal>. Please - be sure to review the <link xlink:href="https://doc.powerdns.com/authoritative/upgrading.html#x-to-4-3-0">Upgrade Notes</link> - provided by upstream before upgrading. Worth specifically noting is that the service now runs - entirely as a dedicated <literal>pdns</literal> user, instead of starting as <literal>root</literal> - and dropping privileges, as well as the default <literal>socket-dir</literal> location changing from - <literal>/var/lib/powerdns</literal> to <literal>/run/pdns</literal>. - </para> - </listitem> - <listitem> - <para> - xfsprogs was update from 4.19 to 5.11. It now enables reflink support by default on filesystem creation. - Support for reflinks was added with an experimental status to kernel 4.9 and deemed stable in kernel 4.16. - If you want to be able to mount XFS filesystems created with this release of xfsprogs on kernel releases older than those, you need to format them - with <literal>mkfs.xfs -m reflink=0</literal>. - </para> - </listitem> - <listitem> - <para> - The uWSGI server is now built with POSIX capabilities. As a consequence, - root is no longer required in emperor mode and the service defaults to - running as the unprivileged <literal>uwsgi</literal> user. Any additional - capability can be added via the new option - <xref linkend="opt-services.uwsgi.capabilities"/>. - The previous behaviour can be restored by setting: -<programlisting> - <xref linkend="opt-services.uwsgi.user"/> = "root"; - <xref linkend="opt-services.uwsgi.group"/> = "root"; - <xref linkend="opt-services.uwsgi.instance"/> = - { - uid = "uwsgi"; - gid = "uwsgi"; - }; -</programlisting> - </para> - <para> - Another incompatibility from the previous release is that vassals running under a - different user or group need to use <literal>immediate-{uid,gid}</literal> - instead of the usual <literal>uid,gid</literal> options. - </para> - </listitem> - <listitem> - <para> - <package>btc1</package> has been abandoned upstream, and removed. - </para> - </listitem> - <listitem> - <para> - <package>cpp_ethereum</package> (aleth) has been abandoned upstream, and removed. - </para> - </listitem> - <listitem> - <para> - <package>riak-cs</package> package removed along with <varname>services.riak-cs</varname> module. - </para> - </listitem> - <listitem> - <para> - <package>stanchion</package> package removed along with <varname>services.stanchion</varname> module. - </para> - </listitem> - <listitem> - <para> - <package>mutt</package> has been updated to a new major version (2.x), which comes with - some backward incompatible changes that are described in the - <link xlink:href="http://www.mutt.org/relnotes/2.0/">release notes for Mutt 2.0</link>. - </para> - </listitem> - <listitem> - <para> - <literal>vim</literal> and <literal>neovim</literal> switched to Python 3, dropping all Python 2 support. - </para> - </listitem> - <listitem> - <para> - <link linkend="opt-networking.wireguard.interfaces">networking.wireguard.interfaces.<name>.generatePrivateKeyFile</link>, - which is off by default, had a <literal>chmod</literal> race condition - fixed. As an aside, the parent directory's permissions were widened, - and the key files were made owner-writable. - This only affects newly created keys. - However, if the exact permissions are important for your setup, read - <link xlink:href="https://github.com/NixOS/nixpkgs/pull/121294">#121294</link>. - </para> - </listitem> - <listitem> - <para> - <link linkend="opt-boot.zfs.forceImportAll">boot.zfs.forceImportAll</link> - previously did nothing, but has been fixed. However its default has been - changed to <literal>false</literal> to preserve the existing default - behaviour. If you have this explicitly set to <literal>true</literal>, - please note that your non-root pools will now be forcibly imported. - </para> - </listitem> - <listitem> - <para> - <package>openafs</package> now points to <package>openafs_1_8</package>, - which is the new stable release. OpenAFS 1.6 was removed. - </para> - </listitem> - <listitem> - <para> - The WireGuard module gained a new option - <option>networking.wireguard.interfaces.<name>.peers.*.dynamicEndpointRefreshSeconds</option> - that implements refreshing the IP of DNS-based endpoints periodically - (which WireGuard itself - <link xlink:href="https://lists.zx2c4.com/pipermail/wireguard/2017-November/002028.html">cannot do</link>). - </para> - </listitem> - <listitem> - <para> - MariaDB has been updated to 10.5. - Before you upgrade, it would be best to take a backup of your database and read - <link xlink:href="https://mariadb.com/kb/en/upgrading-from-mariadb-104-to-mariadb-105/#incompatible-changes-between-104-and-105"> - Incompatible Changes Between 10.4 and 10.5</link>. - After the upgrade you will need to run <literal>mysql_upgrade</literal>. - </para> - </listitem> - <listitem> - <para> - The TokuDB storage engine dropped in <package>mariadb</package> 10.5 and removed in <package>mariadb</package> 10.6. - It is recommended to switch to RocksDB. See also <link xlink:href="https://mariadb.com/kb/en/tokudb/">TokuDB</link> and - <link xlink:href="https://jira.mariadb.org/browse/MDEV-19780">MDEV-19780: Remove the TokuDB storage engine</link>. - </para> - </listitem> - <listitem> - <para> - The <literal>openldap</literal> module now has support for OLC-style - configuration, users of the <literal>configDir</literal> option may wish - to migrate. If you continue to use <literal>configDir</literal>, ensure that - <literal>olcPidFile</literal> is set to <literal>/run/slapd/slapd.pid</literal>. - </para> - <para> - As a result, <literal>extraConfig</literal> and <literal>extraDatabaseConfig</literal> - are removed. To help with migration, you can convert your <literal>slapd.conf</literal> - file to OLC configuration with the following script (find the location of this - configuration file by running <literal>systemctl status openldap</literal>, it is the - <literal>-f</literal> option. - </para> - <programlisting> - TMPDIR=$(mktemp -d) - slaptest -f /path/to/slapd.conf $TMPDIR - slapcat -F $TMPDIR -n0 -H 'ldap:///???(!(objectClass=olcSchemaConfig))' - </programlisting> - <para> - This will dump your current configuration in LDIF format, which should be - straightforward to convert into Nix settings. This does not show your schema - configuration, as this is unnecessarily verbose for users of the default schemas - and <literal>slaptest</literal> is buggy with schemas directly in the config file. - </para> - </listitem> - <listitem> - <para> - Amazon EC2 and OpenStack Compute (nova) images now re-fetch instance meta data and user data from the instance - metadata service (IMDS) on each boot. For example: stopping an EC2 instance, changing its user data, and - restarting the instance will now cause it to fetch and apply the new user data. - </para> - <warning> - <para> - Specifically, <literal>/etc/ec2-metadata</literal> is re-populated on each boot. Some NixOS scripts that read - from this directory are guarded to only run if the files they want to manipulate do not already exist, and so - will not re-apply their changes if the IMDS response changes. Examples: <literal>root</literal>'s SSH key is - only added if <literal>/root/.ssh/authorized_keys</literal> does not exist, and SSH host keys are only set from - user data if they do not exist in <literal>/etc/ssh</literal>. - </para> - </warning> - </listitem> - <listitem> - <para> - The <literal>rspamd</literal> services is now sandboxed. It is run as - a dynamic user instead of root, so secrets and other files may have to - be moved or their permissions may have to be fixed. The sockets are now - located in <literal>/run/rspamd</literal> instead of <literal>/run</literal>. - </para> - </listitem> - <listitem> - <para> - Enabling the Tor client no longer silently also enables and - configures Privoxy, and the - <varname>services.tor.client.privoxy.enable</varname> option has - been removed. To enable Privoxy, and to configure it to use - Tor's faster port, use the following configuration: - </para> - <programlisting> - <xref linkend="opt-services.privoxy.enable" /> = true; - <xref linkend="opt-services.privoxy.enableTor" /> = true; - </programlisting> - </listitem> - <listitem> - <para> - The <literal>services.tor</literal> module has a new exhaustively typed <xref linkend="opt-services.tor.settings" /> option following RFC 0042; backward compatibility with old options has been preserved when aliasing was possible. - The corresponding systemd service has been hardened, - but there is a chance that the service still requires more permissions, - so please report any related trouble on the bugtracker. - Onion services v3 are now supported in <xref linkend="opt-services.tor.relay.onionServices" />. - A new <xref linkend="opt-services.tor.openFirewall" /> option as been introduced for allowing connections on all the TCP ports configured. - </para> - </listitem> - <listitem> - <para> - The options <literal>services.slurm.dbdserver.storagePass</literal> - and <literal>services.slurm.dbdserver.configFile</literal> have been removed. - Use <literal>services.slurm.dbdserver.storagePassFile</literal> instead to provide the database password. - Extra config options can be given via the option <literal>services.slurm.dbdserver.extraConfig</literal>. The actual configuration file is created on the fly on startup of the service. - This avoids that the password gets exposed in the nix store. - </para> - </listitem> - <listitem> - <para> - The <literal>wafHook</literal> hook does not wrap Python anymore. - Packages depending on <literal>wafHook</literal> need to include any Python into their <literal>nativeBuildInputs</literal>. - </para> - </listitem> - <listitem> - <para> - Starting with version 1.7.0, the project formerly named <literal>CodiMD</literal> - is now named <literal>HedgeDoc</literal>. - New installations will no longer use the old name for users, state directories and such, this needs to be considered when moving state to a more recent NixOS installation. - Based on <xref linkend="opt-system.stateVersion" />, existing installations will continue to work. - </para> - </listitem> - <listitem> - <para> - The <package>fish-foreign-env</package> package has been replaced with - <package>fishPlugins.foreign-env</package>, in which the fish - functions have been relocated to the - <literal>vendor_functions.d</literal> directory to be loaded automatically. - </para> - </listitem> - <listitem> - <para> - The prometheus json exporter is now managed by the prometheus community. Together with additional features - some backwards incompatibilities were introduced. - Most importantly the exporter no longer accepts a fixed command-line parameter to specify the URL of the - endpoint serving JSON. It now expects this URL to be passed as an URL parameter, when scraping the exporter's - <literal>/probe</literal> endpoint. - In the prometheus scrape configuration the scrape target might look like this: - <programlisting> -http://some.json-exporter.host:7979/probe?target=https://example.com/some/json/endpoint - </programlisting> - </para> - <para> - Existing configuration for the exporter needs to be updated, but can partially be re-used. - Documentation is available in the upstream repository and a small example for NixOS is available - in the corresponding NixOS test. - </para> - <para> - These changes also affect <xref linkend="opt-services.prometheus.exporters.rspamd.enable" />, which is - just a preconfigured instance of the json exporter. - </para> - <para> - For more information, take a look at the <link xlink:href="https://github.com/prometheus-community/json_exporter"> - official documentation</link> of the json_exporter. - </para> - </listitem> - <listitem> - <para> - Androidenv was updated, removing the <literal>includeDocs</literal> and <literal>lldbVersions</literal> - arguments. Docs only covered a single version of the Android SDK, LLDB is now bundled with the NDK, - and both are no longer available to download from the Android package repositories. Additionally, since - the package lists have been updated, some older versions of Android packages may not be bundled. If you - depend on older versions of Android packages, we recommend overriding the repo. - </para> - <para> - Android packages are now loaded from a repo.json file created by parsing Android repo XML files. The arguments - <literal>repoJson</literal> and <literal>repoXmls</literal> have been added to allow overriding the built-in - androidenv repo.json with your own. Additionally, license files are now written to allow compatibility - with Gradle-based tools, and the <literal>extraLicenses</literal> argument has been added to accept more - SDK licenses if your project requires it. See the androidenv documentation for more details. - </para> - </listitem> - <listitem> - <para> - The attribute <varname>mpi</varname> is now consistently used to - provide a default, system-wide MPI implementation. - The default implementation is openmpi, which has been used before by - all derivations affects by this change. - Note that all packages that have used <varname>mpi ? null</varname> in the input - for optional MPI builds, have been changed to the boolean input paramater - <varname>useMpi</varname> to enable building with MPI. - - Building all packages with <varname>mpich</varname> instead - of the default <varname>openmpi</varname> can now be achived like this: - <programlisting> -self: super: -{ - mpi = super.mpich; -} - </programlisting> - </para> - </listitem> - <listitem> - <para> - The Searx module has been updated with the ability to configure the - service declaratively and uWSGI integration. - The option <literal>services.searx.configFile</literal> has been renamed - to <xref linkend="opt-services.searx.settingsFile"/> for consistency with - the new <xref linkend="opt-services.searx.settings"/>. In addition, the - <literal>searx</literal> uid and gid reservations have been removed - since they were not necessary: the service is now running with a - dynamically allocated uid. - </para> - </listitem> - <listitem> - <para> - The libinput module has been updated with the ability to configure mouse and touchpad settings separately. - The options in <literal>services.xserver.libinput</literal> have been renamed to <literal>services.xserver.libinput.touchpad</literal>, - while there is a new <literal>services.xserver.libinput.mouse</literal> for mouse related configuration. - </para> - <para> - Since touchpad options no longer apply to all devices, you may want to replicate your touchpad configuration in - mouse section. - </para> - </listitem> - <listitem> - <para> - ALSA OSS emulation (<varname>sound.enableOSSEmulation</varname>) is now disabled by default. - </para> - </listitem> - <listitem> - <para> - Thinkfan as been updated to <literal>1.2.x</literal>, which comes with a - new YAML based configuration format. For this reason, several NixOS options - of the thinkfan module have been changed to non-backward compatible types. - In addition, a new <xref linkend="opt-services.thinkfan.settings"/> option has - been added. - </para> - <para> - Please read the <link xlink:href="https://github.com/vmatare/thinkfan#readme"> - thinkfan documentation</link> before updating. - </para> - </listitem> - <listitem> - <para> - Adobe Flash Player support has been dropped from the tree. In particular, - the following packages no longer support it: - <itemizedlist> - <listitem><simpara><package>chromium</package></simpara></listitem> - <listitem><simpara><package>firefox</package></simpara></listitem> - <listitem><simpara><package>qt48</package></simpara></listitem> - <listitem><simpara><package>qt5.qtwebkit</package></simpara></listitem> - </itemizedlist> - Additionally, packages <package>flashplayer</package> and - <package>hal-flash</package> were removed along with the - <varname>services.flashpolicyd</varname> module. - </para> - </listitem> - <listitem> - <para> - The <literal>security.rngd</literal> module has been removed. - It was disabled by default in 20.09 as it was functionally redundant - with krngd in the linux kernel. It is not necessary for any device that the kernel recognises - as an hardware RNG, as it will automatically run the krngd task to periodically collect random - data from the device and mix it into the kernel's RNG. - </para> - <para> - The default SMTP port for GitLab has been changed to - <literal>25</literal> from its previous default of - <literal>465</literal>. If you depended on this default, you - should now set the <xref linkend="opt-services.gitlab.smtp.port" /> - option. - </para> - </listitem> - <listitem> - <para> - The default version of ImageMagick has been updated from 6 to 7. - You can use <package>imagemagick6</package>, - <package>imagemagick6_light</package>, and - <package>imagemagick6Big</package> if you need the older version. - </para> - </listitem> - <listitem> - <para> - <xref linkend="opt-services.xserver.videoDrivers" /> no longer uses the deprecated <literal>cirrus</literal> and <literal>vesa</literal> device dependent X drivers by default. It also enables both <literal>amdgpu</literal> and <literal>nouveau</literal> drivers by default now. - </para> - </listitem> - <listitem> - <para> - The <literal>kindlegen</literal> package is gone, because it is no longer supported or hosted by Amazon. Sadly, its replacement, Kindle Previewer, has no Linux support. However, there are other ways to generate MOBI files. See <link xlink:href="https://github.com/NixOS/nixpkgs/issues/96439">the discussion</link> for more info. - </para> - </listitem> - <listitem> - <para> - The <package>apacheKafka</package> packages are now built with - version-matched JREs. Versions 2.6 and above, the ones that recommend it, - use jdk11, while versions below remain on jdk8. The NixOS service has - been adjusted to start the service using the same version as the package, - adjustable with the new - <link linkend="opt-services.apache-kafka.jre">services.apache-kafka.jre</link> - option. Furthermore, the default list of - <link linkend="opt-services.apache-kafka.jvmOptions">services.apache-kafka.jvmOptions</link> - have been removed. You should set your own according to the - <link xlink:href="https://kafka.apache.org/documentation/#java">upstream documentation</link> - for your Kafka version. - </para> - </listitem> - <listitem> - <para> - The <package>kodi</package> package has been modified to allow concise addon management. Consider - the following configuration from previous releases of NixOS to install <package>kodi</package>, - including the <package>kodiPackages.inputstream-adaptive</package> and <package>kodiPackages.vfs-sftp</package> - addons: - - <programlisting> -environment.systemPackages = [ - pkgs.kodi -]; - -nixpkgs.config.kodi = { - enableInputStreamAdaptive = true; - enableVFSSFTP = true; -}; - </programlisting> - - All Kodi <literal>config</literal> flags have been removed, and as a result the above configuration - should now be written as: - - <programlisting> -environment.systemPackages = [ - (pkgs.kodi.withPackages (p: with p; [ - inputstream-adaptive - vfs-sftp - ])) -]; - </programlisting> - </para> - </listitem> - <listitem> - <para> - <option>environment.defaultPackages</option> now includes the nano package. - If <package>pkgs.nano</package> is not added to the list, - make sure another editor is installed and the <literal>EDITOR</literal> - environment variable is set to it. - Environment variables can be set using <option>environment.variables</option>. - </para> - </listitem> - <listitem> - <para> - <option>services.minio.dataDir</option> changed type to a list of paths, required for specifiyng multiple data directories for using with erasure coding. - Currently, the service doesn't enforce nor checks the correct number of paths to correspond to minio requirements. - </para> - </listitem> - <listitem> - <para> - All CUDA toolkit versions prior to CUDA 10 have been removed. - </para> - </listitem> - <listitem> - <para> - The <package>kbdKeymaps</package> package was removed since dvp and neo - are now included in <package>kbd</package>. - - If you want to use the Programmer Dvorak Keyboard Layout, you have to use - <literal>dvorak-programmer</literal> in <option>console.keyMap</option> - now instead of <literal>dvp</literal>. - In <option>services.xserver.xkbVariant</option> it's still <literal>dvp</literal>. - </para> - </listitem> - <listitem> - <para> - The <package>babeld</package> service is now being run as an unprivileged user. To achieve that the module configures - <literal>skip-kernel-setup true</literal> and takes care of setting forwarding and rp_filter sysctls by itself as well - as for each interface in <varname>services.babeld.interfaces</varname>. - </para> - </listitem> - <listitem> - <para> - The <option>services.zigbee2mqtt.config</option> option has been renamed to <option>services.zigbee2mqtt.settings</option> and - now follows <link xlink:href="https://github.com/NixOS/rfcs/blob/master/rfcs/0042-config-option.md">RFC 0042</link>. - </para> - </listitem> - <listitem> - <para> - The <package>yadm</package> dotfile manager has been updated from 2.x to 3.x, which has new (XDG) default locations for some data/state files. Most yadm commands will fail and print a legacy path warning (which describes how to upgrade/migrate your repository). If you have scripts, daemons, scheduled jobs, shell profiles, etc. that invoke yadm, expect them to fail or misbehave until you perform this migration and prepare accordingly. - </para> - </listitem> - <listitem> - <para> - Instead of determining <option>services.radicale.package</option> - automatically based on <option>system.stateVersion</option>, the latest - version is always used because old versions are not officially supported. - </para> - <para> - Furthermore, Radicale's systemd unit was hardened which might break some - deployments. In particular, a non-default - <literal>filesystem_folder</literal> has to be added to - <option>systemd.services.radicale.serviceConfig.ReadWritePaths</option> if - the deprecated <option>services.radicale.config</option> is used. - </para> - </listitem> - </itemizedlist> - </section> - - <section xmlns="http://docbook.org/ns/docbook" - xmlns:xlink="http://www.w3.org/1999/xlink" - xmlns:xi="http://www.w3.org/2001/XInclude" - version="5.0" - xml:id="sec-release-21.05-notable-changes"> - <title>Other Notable Changes</title> - - <itemizedlist> - <listitem> - <para> - <literal>stdenv.lib</literal> has been deprecated and will break - eval in 21.11. Please use <literal>pkgs.lib</literal> instead. - See <link xlink:href="https://github.com/NixOS/nixpkgs/issues/108938">#108938</link> - for details. - </para> - </listitem> - <listitem> - <para> - The Mailman NixOS module (<literal>services.mailman</literal>) has a new - option <xref linkend="opt-services.mailman.enablePostfix" />, defaulting - to true, that controls integration with Postfix. - </para> - <para> - If this option is disabled, default MTA config becomes not set and you - should set the options in <literal>services.mailman.settings.mta</literal> - according to the desired configuration as described in - <link xlink:href="https://mailman.readthedocs.io/en/latest/src/mailman/docs/mta.html">Mailman documentation</link>. - </para> - </listitem> - <listitem> - <para> - The default-version of <literal>nextcloud</literal> is <package>nextcloud21</package>. - Please note that it's <emphasis>not</emphasis> possible to upgrade <literal>nextcloud</literal> - across multiple major versions! This means that it's e.g. not possible to upgrade - from <package>nextcloud18</package> to <package>nextcloud20</package> in a single deploy and - most <literal>20.09</literal> users will have to upgrade to <package>nextcloud20</package> - first. - </para> - <para> - The package can be manually upgraded by setting <xref linkend="opt-services.nextcloud.package" /> - to <package>nextcloud21</package>. - </para> - </listitem> - <listitem> - <para> - The setting <xref linkend="opt-services.redis.bind" /> defaults to <literal>127.0.0.1</literal> now, making Redis listen on the loopback interface only, and not all public network interfaces. - </para> - </listitem> - <listitem> - <para> - NixOS now emits a deprecation warning if systemd's <literal>StartLimitInterval</literal> setting is used in a <literal>serviceConfig</literal> section instead of in a <literal>unitConfig</literal>; that setting is deprecated and now undocumented for the service section by systemd upstream, but still effective and somewhat buggy there, which can be confusing. See <link xlink:href="https://github.com/NixOS/nixpkgs/issues/45785">#45785</link> for details. - </para> - <para> - All services should use <xref linkend="opt-systemd.services._name_.startLimitIntervalSec" /> or <literal>StartLimitIntervalSec</literal> in <xref linkend="opt-systemd.services._name_.unitConfig" /> instead. - </para> - </listitem> - <listitem> - <para> - The Unbound DNS resolver service (<literal>services.unbound</literal>) has been refactored to allow reloading, control sockets and to fix startup ordering issues. - </para> - - <para> - It is now possible to enable a local UNIX control socket for unbound by setting the <xref linkend="opt-services.unbound.localControlSocketPath" /> - option. - </para> - - <para> - Previously we just applied a very minimal set of restrictions and - trusted unbound to properly drop root privs and capabilities. - </para> - - <para> - As of this we are (for the most part) just using the upstream - example unit file for unbound. The main difference is that we start - unbound as <literal>unbound</literal> user with the required capabilities instead of - letting unbound do the chroot & uid/gid changes. - </para> - - <para> - The upstream unit configuration this is based on is a lot stricter with - all kinds of permissions then our previous variant. It also came with - the default of having the <literal>Type</literal> set to <literal>notify</literal>, therefore we are now also - using the <literal>unbound-with-systemd</literal> package here. Unbound will start up, - read the configuration files and start listening on the configured ports - before systemd will declare the unit <literal>active (running)</literal>. - This will likely help with startup order and the occasional race condition during system - activation where the DNS service is started but not yet ready to answer - queries. Services depending on <literal>nss-lookup.target</literal> or <literal>unbound.service</literal> - are now be able to use unbound when those targets have been reached. - </para> - - <para> - Additionally to the much stricter runtime environment the - <literal>/dev/urandom</literal> mount lines we previously had in the code (that - randomly failed during the stop-phase) have been removed as systemd will take care of those for us. - </para> - - <para> - The <literal>preStart</literal> script is now only required if we enabled the trust - anchor updates (which are still enabled by default). - </para> - - <para> - Another benefit of the refactoring is that we can now issue reloads via - either <literal>pkill -HUP unbound</literal> and <literal>systemctl reload unbound</literal> to reload the - running configuration without taking the daemon offline. A prerequisite - of this was that unbound configuration is available on a well known path - on the file system. We are using the path <literal>/etc/unbound/unbound.conf</literal> as that is the - default in the CLI tooling which in turn enables us to use - <literal>unbound-control</literal> without passing a custom configuration location. - </para> - - <para> - The module has also been reworked to be <link - xlink:href="https://github.com/NixOS/rfcs/blob/master/rfcs/0042-config-option.md">RFC - 0042</link> compliant. As such, - <option>sevices.unbound.extraConfig</option> has been removed and replaced - by <xref linkend="opt-services.unbound.settings"/>. <option>services.unbound.interfaces</option> - has been renamed to <option>services.unbound.settings.server.interface</option>. - </para> - - <para> - <option>services.unbound.forwardAddresses</option> and - <option>services.unbound.allowedAccess</option> have also been changed to - use the new settings interface. You can follow the instructions when - executing <literal>nixos-rebuild</literal> to upgrade your configuration to - use the new interface. - </para> - </listitem> - <listitem> - <para> - The <literal>services.dnscrypt-proxy2</literal> module now takes the upstream's example configuration and updates it with the user's settings. - - An option has been added to restore the old behaviour if you prefer to declare the configuration from scratch. - </para> - </listitem> - <listitem> - <para> - NixOS now defaults to the unified cgroup hierarchy (cgroupsv2). - See the <link xlink:href="https://www.redhat.com/sysadmin/fedora-31-control-group-v2">Fedora Article for 31</link> - for details on why this is desirable, and how it impacts containers. - </para> - <para> - If you want to run containers with a runtime that does not yet support cgroupsv2, - you can switch back to the old behaviour by setting - <xref linkend="opt-systemd.enableUnifiedCgroupHierarchy"/> = <literal>false</literal>; - and rebooting. - </para> - </listitem> - <listitem> - <para> - PulseAudio was upgraded to 14.0, with changes to the handling of default sinks. - See its <link xlink:href="https://www.freedesktop.org/wiki/Software/PulseAudio/Notes/14.0/">release notes</link>. - </para> - - <para> - GNOME users may wish to delete their <literal>~/.config/pulse</literal> due to the changes to stream routing - logic. See <link xlink:href="https://gitlab.freedesktop.org/pulseaudio/pulseaudio/-/issues/832">PulseAudio bug 832</link> - for more information. - </para> - </listitem> - <listitem> - <para> - The <package>zookeeper</package> package does not provide - <literal>zooInspector.sh</literal> anymore, as that "contrib" has - been dropped from upstream releases. - </para> - </listitem> - <listitem> - <para> - In the ACME module, the data used to build the hash for the account - directory has changed to accomodate new features to reduce account - rate limit issues. This will trigger new account creation on the first - rebuild following this update. No issues are expected to arise from this, - thanks to the new account creation handling. - </para> - </listitem> - <listitem> - <para> - <xref linkend="opt-users.users._name_.createHome" /> now always ensures home directory permissions to be <literal>0700</literal>. - Permissions had previously been ignored for already existing home directories, possibly leaving them readable by others. - The option's description was incorrect regarding ownership management and has been simplified greatly. - </para> - </listitem> - <listitem> - <para> - When defining a new user, one of <xref linkend="opt-users.users._name_.isNormalUser" /> and <xref linkend="opt-users.users._name_.isSystemUser" /> is now required. - This is to prevent accidentally giving a UID above 1000 to system users, which could have unexpected consequences, like running user activation scripts for system users. - Note that users defined with an explicit UID below 500 are exempted from this check, as <xref linkend="opt-users.users._name_.isSystemUser" /> has no effect for those. - </para> - </listitem> - <listitem> - <para> - The <literal>security.apparmor</literal> module, - for the <link xlink:href="https://gitlab.com/apparmor/apparmor/-/wikis/Documentation">AppArmor</link> - Mandatory Access Control system, - has been substantialy improved along with related tools, - so that module maintainers can now more easily write AppArmor profiles for NixOS. - The most notable change on the user-side is the new option <xref linkend="opt-security.apparmor.policies"/>, - replacing the previous <literal>profiles</literal> option - to provide a way to disable a profile - and to select whether to confine in enforce mode (default) - or in complain mode (see <literal>journalctl -b --grep apparmor</literal>). - Security-minded users may also want to enable <xref linkend="opt-security.apparmor.killUnconfinedConfinables"/>, - at the cost of having some of their processes killed - when updating to a NixOS version introducing new AppArmor profiles. - </para> - </listitem> - <listitem> - <para> - The GNOME desktop manager once again installs <package>gnome.epiphany</package> by default. - </para> - </listitem> - <listitem> - <para> - NixOS now generates empty <literal>/etc/netgroup</literal>. - <literal>/etc/netgroup</literal> defines network-wide groups and may affect to setups using NIS. - </para> - </listitem> - <listitem> - <para> - Platforms, like <varname>stdenv.hostPlatform</varname>, no longer have a <varname>platform</varname> attribute. - It has been (mostly) flattened away: - </para> - <itemizedlist> - <listitem><para><varname>platform.gcc</varname> is now <varname>gcc</varname></para></listitem> - <listitem><para><literal>platform.kernel*</literal> is now <literal>linux-kernel.*</literal></para></listitem> - </itemizedlist> - <para> - Additionally, <varname>platform.kernelArch</varname> moved to the top level as <varname>linuxArch</varname> to match the other <literal>*Arch</literal> variables. - </para> - <para> - The <varname>platform</varname> grouping of these things never meant anything, and was just a historial/implementation artifact that was overdue removal. - </para> - </listitem> - <listitem> - <para> - <varname>services.restic</varname> now uses a dedicated cache directory for every backup defined in <varname>services.restic.backups</varname>. The old global cache directory, <literal>/root/.cache/restic</literal>, is now unused and can be removed to free up disk space. - </para> - </listitem> - <listitem> - <para> - <literal>isync</literal>: The <literal>isync</literal> compatibility wrapper was removed and the Master/Slave - terminology has been deprecated and should be replaced with Far/Near in the configuration file. - </para> - </listitem> - <listitem> - <para> - The nix-gc service now accepts randomizedDelaySec (default: 0) and persistent (default: true) parameters. - By default nix-gc will now run immediately if it would have been triggered at least - once during the time when the timer was inactive. - </para> - </listitem> - <listitem> - <para> - The <literal>rustPlatform.buildRustPackage</literal> function is split into several hooks: - <package>cargoSetupHook</package> to set up vendoring for Cargo-based projects, - <package>cargoBuildHook</package> to build a project using Cargo, - <package>cargoInstallHook</package> to install a project using Cargo, and - <package>cargoCheckHook</package> to run tests in Cargo-based projects. With this change, - mixed-language projects can use the relevant hooks within builders other than - <literal>buildRustPackage</literal>. However, these changes also required several API changes to - <literal>buildRustPackage</literal> itself: - - <itemizedlist> - <listitem> - <para> - The <literal>target</literal> argument was removed. Instead, <literal>buildRustPackage</literal> - will always use the same target as the C/C++ compiler that is used. - </para> - </listitem> - <listitem> - <para> - The <literal>cargoParallelTestThreads</literal> argument was removed. Parallel tests are - now disabled through <literal>dontUseCargoParallelTests</literal>. - </para> - </listitem> - </itemizedlist> - </para> - </listitem> - <listitem> - <para> - The <literal>rustPlatform.maturinBuildHook</literal> hook was added. This hook can be used - with <literal>buildPythonPackage</literal> to build Python packages that are written in Rust - and use Maturin as their build tool. - </para> - </listitem> - <listitem> - <para> - Kubernetes has <link xlink:href="https://kubernetes.io/blog/2020/12/02/dont-panic-kubernetes-and-docker/">deprecated docker</link> as container runtime. - As a consequence, the Kubernetes module now has support for configuration of custom remote container runtimes and enables containerd by default. - Note that containerd is more strict regarding container image OCI-compliance. - As an example, images with CMD or ENTRYPOINT defined as strings (not lists) will fail on containerd, while working fine on docker. - Please test your setup and container images with containerd prior to upgrading. - </para> - </listitem> - <listitem> - <para> - The GitLab module now has support for automatic backups. A - schedule can be set with the - <link linkend="opt-services.gitlab.backup.startAt">services.gitlab.backup.startAt</link> - option. - </para> - </listitem> - <listitem> - <para> - Prior to this release, systemd would also read system units from an undocumented <literal>/etc/systemd-mutable/system</literal> path. - This path has been dropped from the defaults. That path (or others) can be re-enabled by adding it to the - <link linkend="opt-boot.extraSystemdUnitPaths">boot.extraSystemdUnitPaths</link> list. - </para> - </listitem> - <listitem> - <para> - PostgreSQL 9.5 is scheduled EOL during the 21.05 life cycle and has been removed. - </para> - </listitem> - <listitem> - <para> - <link xlink:href="https://www.xfce.org/">Xfce4</link> relies on - GIO/GVfs for userspace virtual filesystem access in applications - like <link xlink:href="https://docs.xfce.org/xfce/thunar/">thunar</link> and - <link xlink:href="https://docs.xfce.org/apps/gigolo/">gigolo</link>. - For that to work, the gvfs nixos service is enabled by default, - and it can be configured with the specific package that provides - GVfs. Until now Xfce4 was setting it to use a lighter version of - GVfs (without support for samba). To avoid conflicts with other - desktop environments this setting has been dropped. Users that - still want it should add the following to their system - configuration: - <programlisting> -<xref linkend="opt-services.gvfs.package" /> = pkgs.gvfs.override { samba = null; }; - </programlisting> - </para> - </listitem> - <listitem> - <para> - The newly enabled <literal>systemd-pstore.service</literal> now automatically evacuates crashdumps and panic logs from the persistent storage to <literal>/var/lib/systemd/pstore</literal>. - This prevents NVRAM from filling up, which ensures the latest diagnostic data is always stored and alleviates problems with writing new boot configurations. - </para> - </listitem> - <listitem> - <para> - Nixpkgs now contains <link xlink:href="https://github.com/NixOS/nixpkgs/pull/118232">automatically packaged GNOME Shell extensions</link> from the <link xlink:href="https://extensions.gnome.org/">GNOME Extensions</link> portal. You can find them, filed by their UUID, under <literal>gnome38Extensions</literal> attribute for GNOME 3.38 and under <literal>gnome40Extensions</literal> for GNOME 40. Finally, the <literal>gnomeExtensions</literal> attribute contains extensions for the latest GNOME Shell version in Nixpkgs, listed under a more human-friendly name. The unqualified attribute scope also contains manually packaged extensions. Note that the automatically packaged extensions are provided for convenience and are not checked or guaranteed to work. - </para> - </listitem> - <listitem> - <para> - Erlang/OTP versions older than R21 got dropped. We also dropped the cuter package, as it was purely an example of how to build a package. - We also dropped <literal>lfe_1_2</literal> as it could not build with R21+. - Moving forward, we expect to only support 3 yearly releases of OTP. - </para> - </listitem> - - </itemizedlist> - </section> -</section> diff --git a/nixos/doc/manual/release-notes/rl-2111.section.md b/nixos/doc/manual/release-notes/rl-2111.section.md index 6bd552c873a..5e379ad6fd1 100644 --- a/nixos/doc/manual/release-notes/rl-2111.section.md +++ b/nixos/doc/manual/release-notes/rl-2111.section.md @@ -1,9 +1,185 @@ -# Release 21.11 (“?”, 2021.11/??) {#release-21.11} +# Release 21.11 (“?”, 2021.11/??) {#sec-release-21.11} In addition to numerous new and upgraded packages, this release has the following highlights: -* Support is planned until the end of April 2022, handing over to 22.05. +- Support is planned until the end of June 2022, handing over to 22.05. -## Backward incompatibilities +## Highlights {#sec-release-21.11-highlights} -* The `staticjinja` package has been upgraded from 1.0.4 to 2.0.0 +- PHP now defaults to PHP 8.0, updated from 7.4. +- kOps now defaults to 1.21.0, which uses containerd as the default runtime. + +- `python3` now defaults to Python 3.9, updated from Python 3.8. + +- PostgreSQL now defaults to major version 13. + +## New Services {#sec-release-21.11-new-services} + +- [btrbk](https://digint.ch/btrbk/index.html), a backup tool for btrfs subvolumes, taking advantage of btrfs specific capabilities to create atomic snapshots and transfer them incrementally to your backup locations. Available as [services.btrbk](options.html#opt-services.brtbk.instances). + +- [clipcat](https://github.com/xrelkd/clipcat/), an X11 clipboard manager written in Rust. Available at [services.clipcat](options.html#o +pt-services.clipcat.enable). + +- [geoipupdate](https://github.com/maxmind/geoipupdate), a GeoIP database updater from MaxMind. Available as [services.geoipupdate](options.html#opt-services.geoipupdate.enable). + +- [Kea](https://www.isc.org/kea/), ISCs 2nd generation DHCP and DDNS server suite. Available at [services.kea](options.html#opt-services.kea). + +- [sourcehut](https://sr.ht), a collection of tools useful for software development. Available as [services.sourcehut](options.html#opt-services.sourcehut.enable). + +- [ucarp](https://download.pureftpd.org/pub/ucarp/README), an userspace implementation of the Common Address Redundancy Protocol (CARP). Available as [networking.ucarp](options.html#opt-networking.ucarp.enable). + +- Users of flashrom should migrate to [programs.flashrom.enable](options.html#opt-programs.flashrom.enable) and add themselves to the `flashrom` group to be able to access programmers supported by flashrom. + +- [vikunja](https://vikunja.io), a to-do list app. Available as [services.vikunja](#opt-services.vikunja.enable). + +- [snapraid](https://www.snapraid.it/), a backup program for disk arrays. + Available as [snapraid](#opt-snapraid.enable). + +- [Hockeypuck](https://github.com/hockeypuck/hockeypuck), a OpenPGP Key Server. Available as [services.hockeypuck](#opt-services.hockeypuck.enable). + +- [buildkite-agent-metrics](https://github.com/buildkite/buildkite-agent-metrics), a command-line tool for collecting Buildkite agent metrics, now has a Prometheus exporter available as [services.prometheus.exporters.buildkite-agent](#opt-services.prometheus.exporters.buildkite-agent.enable). + +## Backward Incompatibilities {#sec-release-21.11-incompatibilities} + +- The `staticjinja` package has been upgraded from 1.0.4 to 3.0.1 + +- `services.geoip-updater` was broken and has been replaced by [services.geoipupdate](options.html#opt-services.geoipupdate.enable). + +- PHP 7.3 is no longer supported due to upstream not supporting this version for the entire lifecycle of the 21.11 release. + +- Those making use of `buildBazelPackage` will need to regenerate the fetch hashes (preferred), or set `fetchConfigured = false;`. + +- `consul` was upgraded to a new major release with breaking changes, see [upstream changelog](https://github.com/hashicorp/consul/releases/tag/v1.10.0). + +- fsharp41 has been removed in preference to use the latest dotnet-sdk + +- The following F#-related packages have been removed for being unmaintaned. Please use `fetchNuGet` for specific packages. + + - ExtCore + - Fake + - Fantomas + - FsCheck + - FsCheck262 + - FsCheckNunit + - FSharpAutoComplete + - FSharpCompilerCodeDom + - FSharpCompilerService + - FSharpCompilerTools + - FSharpCore302 + - FSharpCore3125 + - FSharpCore4001 + - FSharpCore4117 + - FSharpData + - FSharpData225 + - FSharpDataSQLProvider + - FSharpFormatting + - FsLexYacc + - FsLexYacc706 + - FsLexYaccRuntime + - FsPickler + - FsUnit + - Projekt + - Suave + - UnionArgParser + - ExcelDnaRegistration + - MathNetNumerics + +- `programs.x2goserver` is now `services.x2goserver` + +- The following dotnet-related packages have been removed for being unmaintaned. Please use `fetchNuGet` for specific packages. + - Autofac + - SystemValueTuple + - MicrosoftDiaSymReader + - MicrosoftDiaSymReaderPortablePdb + - SystemCollectionsImmutable + - SystemCollectionsImmutable131 + - SystemReflectionMetadata + - NUnit350 + - Deedle + - ExcelDna + - GitVersionTree + - NDeskOptions + +* The `antlr` package now defaults to the 4.x release instead of the + old 2.7.7 version. + +* The `pulseeffects` package updated to [version 4.x](https://github.com/wwmm/easyeffects/releases/tag/v6.0.0) and renamed to `easyeffects`. + +* The `libwnck` package now defaults to the 3.x release instead of the + old 2.31.0 version. + +* The `bitwarden_rs` packages and modules were renamed to `vaultwarden` + [following upstream](https://github.com/dani-garcia/vaultwarden/discussions/1642). More specifically, + + * `pkgs.bitwarden_rs`, `pkgs.bitwarden_rs-sqlite`, `pkgs.bitwarden_rs-mysql` and + `pkgs.bitwarden_rs-postgresql` were renamed to `pkgs.vaultwarden`, `pkgs.vaultwarden-sqlite`, + `pkgs.vaultwarden-mysql` and `pkgs.vaultwarden-postgresql`, respectively. + * Old names are preserved as aliases for backwards compatibility, but may be removed in the future. + * The `bitwarden_rs` executable was also renamed to `vaultwarden` in all packages. + + * `pkgs.bitwarden_rs-vault` was renamed to `pkgs.vaultwarden-vault`. + * `pkgs.bitwarden_rs-vault` is preserved as an alias for backwards compatibility, but may be removed in the future. + * The static files were moved from `/usr/share/bitwarden_rs` to `/usr/share/vaultwarden`. + + * The `services.bitwarden_rs` config module was renamed to `services.vaultwarden`. + * `services.bitwarden_rs` is preserved as an alias for backwards compatibility, but may be removed in the future. + + * `systemd.services.bitwarden_rs`, `systemd.services.backup-bitwarden_rs` and `systemd.timers.backup-bitwarden_rs` + were renamed to `systemd.services.vaultwarden`, `systemd.services.backup-vaultwarden` and + `systemd.timers.backup-vaultwarden`, respectively. + * Old names are preserved as aliases for backwards compatibility, but may be removed in the future. + + * `users.users.bitwarden_rs` and `users.groups.bitwarden_rs` were renamed to `users.users.vaultwarden` and + `users.groups.vaultwarden`, respectively. + + * The data directory remains located at `/var/lib/bitwarden_rs`, for backwards compatibility. + +- `yggdrasil` was upgraded to a new major release with breaking changes, see [upstream changelog](https://github.com/yggdrasil-network/yggdrasil-go/releases/tag/v0.4.0). + +- `icingaweb2` was upgraded to a new release which requires a manual database upgrade, see [upstream changelog](https://github.com/Icinga/icingaweb2/releases/tag/v2.9.0). + +- The `isabelle` package has been upgraded from 2020 to 2021 + +- the `mingw-64` package has been upgraded from 6.0.0 to 9.0.0 + +## Other Notable Changes {#sec-release-21.11-notable-changes} + +- The setting [`services.openssh.logLevel`](options.html#opt-services.openssh.logLevel) `"VERBOSE"` `"INFO"`. This brings NixOS in line with upstream and other Linux distributions, and reduces log spam on servers due to bruteforcing botnets. + + However, if [`services.fail2ban.enable`](options.html#opt-services.fail2ban.enable) is `true`, the `fail2ban` will override the verbosity to `"VERBOSE"`, so that `fail2ban` can observe the failed login attempts from the SSH logs. + +- Sway: The terminal emulator `rxvt-unicode` is no longer installed by default via `programs.sway.extraPackages`. The current default configuration uses `alacritty` (and soon `foot`) so this is only an issue when using a customized configuration and not installing `rxvt-unicode` explicitly. + +- `python3` now defaults to Python 3.9. Python 3.9 introduces many deprecation warnings, please look at the [What's New In Python 3.9 post](https://docs.python.org/3/whatsnew/3.9.html) for more information. + +- The `claws-mail` package now references the new GTK+ 3 release branch, major version 4. To use the GTK+ 2 releases, one can install the `claws-mail-gtk2` package. + +- The wordpress module provides a new interface which allows to use different webservers with the new option [`services.wordpress.webserver`](options.html#opt-services.wordpress.webserver). Currently `httpd` and `nginx` are supported. The definitions of wordpress sites should now be set in [`services.wordpress.sites`](options.html#opt-services.wordpress.sites). + + Sites definitions that use the old interface are automatically migrated in the new option. This backward compatibility will be removed in 22.05. + +- The order of NSS (host) modules has been brought in line with upstream + recommendations: + + - The `myhostname` module is placed before the `resolve` (optional) and `dns` + entries, but after `file` (to allow overriding via `/etc/hosts` / + `networking.extraHosts`, and prevent ISPs with catchall-DNS resolvers from + hijacking `.localhost` domains) + - The `mymachines` module, which provides hostname resolution for local + containers (registered with `systemd-machined`) is placed to the front, to + make sure its mappings are preferred over other resolvers. + - If systemd-networkd is enabled, the `resolve` module is placed before + `files` and `myhostname`, as it provides the same logic internally, with + caching. + - The `mdns(_minimal)` module has been updated to the new priorities. + + If you use your own NSS host modules, make sure to update your priorities + according to these rules: + + - NSS modules which should be queried before `resolved` DNS resolution should + use mkBefore. + - NSS modules which should be queried after `resolved`, `files` and + `myhostname`, but before `dns` should use the default priority + - NSS modules which should come after `dns` should use mkAfter. + +- The [networking.wireless.iwd](options.html#opt-networking.wireless.iwd.enable) module has a new [networking.wireless.iwd.settings](options.html#opt-networking.wireless.iwd.settings) option. diff --git a/nixos/lib/build-vms.nix b/nixos/lib/build-vms.nix index 064e44f643b..f0a58628c68 100644 --- a/nixos/lib/build-vms.nix +++ b/nixos/lib/build-vms.nix @@ -41,7 +41,7 @@ rec { # The human version (e.g. 21.05-pre) is left as is, because it is useful # for external modules that test with e.g. nixosTest and rely on that # version number. - config.system.nixos.revision = "constant-nixos-revision"; + config.system.nixos.revision = mkForce "constant-nixos-revision"; } { key = "nodes"; _module.args.nodes = nodes; } ] ++ optional minimal ../modules/testing/minimal-kernel.nix; diff --git a/nixos/lib/make-disk-image.nix b/nixos/lib/make-disk-image.nix index 7d40d3b5548..55643facea0 100644 --- a/nixos/lib/make-disk-image.nix +++ b/nixos/lib/make-disk-image.nix @@ -278,7 +278,7 @@ let format' = format; in let additionalSpace=$(( $(numfmt --from=iec '${additionalSpace}') + reservedSpace )) # Compute required space in filesystem blocks - diskUsage=$(find . ! -type d -exec 'du' '--apparent-size' '--block-size' "${blockSize}" '{}' ';' | cut -f1 | sum_lines) + diskUsage=$(find . ! -type d -print0 | du --files0-from=- --apparent-size --block-size "${blockSize}" | cut -f1 | sum_lines) # Each inode takes space! numInodes=$(find . | wc -l) # Convert to bytes, inodes take two blocks each! diff --git a/nixos/lib/make-ext4-fs.nix b/nixos/lib/make-ext4-fs.nix index 33dbc8f5ec4..416beeb32f2 100644 --- a/nixos/lib/make-ext4-fs.nix +++ b/nixos/lib/make-ext4-fs.nix @@ -74,11 +74,9 @@ pkgs.stdenv.mkDerivation { return 1 fi - echo "Resizing to minimum allowed size" - resize2fs -M $img - - # And a final fsck, because of the previous truncating. - fsck.ext4 -n -f $img + # We may want to shrink the file system and resize the image to + # get rid of the unnecessary slack here--but see + # https://github.com/NixOS/nixpkgs/issues/125121 for caveats. if [ ${builtins.toString compressImage} ]; then echo "Compressing image" diff --git a/nixos/lib/test-driver/test-driver.py b/nixos/lib/test-driver/test-driver.py index e216e566f28..2a3e4d94b94 100644 --- a/nixos/lib/test-driver/test-driver.py +++ b/nixos/lib/test-driver/test-driver.py @@ -21,6 +21,7 @@ import shutil import socket import subprocess import sys +import telnetlib import tempfile import time import traceback @@ -128,18 +129,18 @@ def create_vlan(vlan_nr: str) -> Tuple[str, str, "subprocess.Popen[bytes]", Any] return (vlan_nr, vde_socket, vde_process, fd) -def retry(fn: Callable) -> None: +def retry(fn: Callable, timeout: int = 900) -> None: """Call the given function repeatedly, with 1 second intervals, until it returns True or a timeout is reached. """ - for _ in range(900): + for _ in range(timeout): if fn(False): return time.sleep(1) if not fn(True): - raise Exception("action timed out") + raise Exception(f"action timed out after {timeout} seconds") class Logger: @@ -291,7 +292,12 @@ class Machine: net_frontend += "," + args["netFrontendArgs"] start_command = ( - "qemu-kvm -m 384 " + net_backend + " " + net_frontend + " $QEMU_OPTS " + args.get("qemuBinary", "qemu-kvm") + + " -m 384 " + + net_backend + + " " + + net_frontend + + " $QEMU_OPTS " ) if "hda" in args: @@ -440,7 +446,7 @@ class Machine: def execute(self, command: str) -> Tuple[int, str]: self.connect() - out_command = "( {} ); echo '|!=EOF' $?\n".format(command) + out_command = "( set -euo pipefail; {} ); echo '|!=EOF' $?\n".format(command) self.shell.send(out_command.encode()) output = "" @@ -455,6 +461,17 @@ class Machine: return (status_code, output) output += chunk + def shell_interact(self) -> None: + """Allows you to interact with the guest shell + + Should only be used during test development, not in the production test.""" + self.connect() + self.log("Terminal is ready (there is no prompt):") + subprocess.run( + ["socat", "READLINE", f"FD:{self.shell.fileno()}"], + pass_fds=[self.shell.fileno()], + ) + def succeed(self, *commands: str) -> str: """Execute each command and check that it succeeds.""" output = "" @@ -482,7 +499,7 @@ class Machine: output += out return output - def wait_until_succeeds(self, command: str) -> str: + def wait_until_succeeds(self, command: str, timeout: int = 900) -> str: """Wait until a command returns success and return its output. Throws an exception on timeout. """ @@ -494,7 +511,7 @@ class Machine: return status == 0 with self.nested("waiting for success: {}".format(command)): - retry(check_success) + retry(check_success, timeout) return output def wait_until_fails(self, command: str) -> str: @@ -896,7 +913,6 @@ class Machine: def create_machine(args: Dict[str, Any]) -> Machine: global log args["log"] = log - args["redirectSerial"] = os.environ.get("USE_SERIAL", "0") == "1" return Machine(args) @@ -963,7 +979,7 @@ def subtest(name: str) -> Iterator[None]: if __name__ == "__main__": - arg_parser = argparse.ArgumentParser() + arg_parser = argparse.ArgumentParser(prog="nixos-test-driver") arg_parser.add_argument( "-K", "--keep-vm-state", diff --git a/nixos/lib/testing-python.nix b/nixos/lib/testing-python.nix index c9d4f0f0861..768f1dc2a17 100644 --- a/nixos/lib/testing-python.nix +++ b/nixos/lib/testing-python.nix @@ -16,13 +16,19 @@ rec { inherit pkgs; - - mkTestDriver = + # Reifies and correctly wraps the python test driver for + # the respective qemu version and with or without ocr support + pythonTestDriver = { + qemu_pkg ? pkgs.qemu_test + , enableOCR ? false + }: let - testDriverScript = ./test-driver/test-driver.py; - in - qemu_pkg: stdenv.mkDerivation { name = "nixos-test-driver"; + testDriverScript = ./test-driver/test-driver.py; + ocrProg = tesseract4.override { enableLanguages = [ "eng" ]; }; + imagemagick_tiff = imagemagick_light.override { inherit libtiff; }; + in stdenv.mkDerivation { + inherit name; nativeBuildInputs = [ makeWrapper ]; buildInputs = [ (python3.withPackages (p: [ p.ptpython p.colorama ])) ]; @@ -35,7 +41,7 @@ rec { buildPhase = '' python <<EOF from pydoc import importfile - with open('driver-exports', 'w') as fp: + with open('driver-symbols', 'w') as fp: fp.write(','.join(dir(importfile('${testDriverScript}')))) EOF ''; @@ -57,20 +63,17 @@ rec { # TODO: copy user script part into this file (append) wrapProgram $out/bin/nixos-test-driver \ - --prefix PATH : "${lib.makeBinPath [ qemu_pkg vde2 netpbm coreutils ]}" \ + --argv0 ${name} \ + --prefix PATH : "${lib.makeBinPath [ qemu_pkg vde2 netpbm coreutils socat ]}" \ + ${lib.optionalString enableOCR + "--prefix PATH : '${ocrProg}/bin:${imagemagick_tiff}/bin'"} \ - install -m 0644 -vD driver-exports $out/nix-support/driver-exports + install -m 0644 -vD driver-symbols $out/nix-support/driver-symbols ''; }; # Run an automated test suite in the given virtual network. - runTests = { - # the script that runs the network - driver, - # a source position in the format of builtins.unsafeGetAttrPos - # for meta.position - pos, - }: + runTests = { driver, pos }: stdenv.mkDerivation { name = "vm-test-run-${driver.testName}"; @@ -87,10 +90,99 @@ rec { inherit driver; }; - inherit pos; + inherit pos; # for better debugging }; + # Generate convenience wrappers for running the test driver + # has vlans, vms and test script defaulted through env variables + # also instantiates test script with nodes, if it's a function (contract) + setupDriverForTest = { + testScript + , testName + , nodes + , qemu_pkg ? pkgs.qemu_test + , enableOCR ? false + , skipLint ? false + , passthru ? {} + }: + let + # FIXME: get this pkg from the module system + testDriver = pythonTestDriver { inherit qemu_pkg enableOCR;}; + + testDriverName = + let + # A standard store path to the vm monitor is built like this: + # /tmp/nix-build-vm-test-run-$name.drv-0/vm-state-machine/monitor + # The max filename length of a unix domain socket is 108 bytes. + # This means $name can at most be 50 bytes long. + maxTestNameLen = 50; + testNameLen = builtins.stringLength testName; + in with builtins; + if testNameLen > maxTestNameLen then + abort + ("The name of the test '${testName}' must not be longer than ${toString maxTestNameLen} " + + "it's currently ${toString testNameLen} characters long.") + else + "nixos-test-driver-${testName}"; + + vlans = map (m: m.config.virtualisation.vlans) (lib.attrValues nodes); + vms = map (m: m.config.system.build.vm) (lib.attrValues nodes); + + nodeHostNames = map (c: c.config.system.name) (lib.attrValues nodes); + invalidNodeNames = lib.filter + (node: builtins.match "^[A-z_]([A-z0-9_]+)?$" node == null) + (builtins.attrNames nodes); + + testScript' = + # Call the test script with the computed nodes. + if lib.isFunction testScript + then testScript { inherit nodes; } + else testScript; + + in + if lib.length invalidNodeNames > 0 then + throw '' + Cannot create machines out of (${lib.concatStringsSep ", " invalidNodeNames})! + All machines are referenced as python variables in the testing framework which will break the + script when special characters are used. + Please stick to alphanumeric chars and underscores as separation. + '' + else lib.warnIf skipLint "Linting is disabled" (runCommand testDriverName + { + inherit testName; + nativeBuildInputs = [ makeWrapper ]; + testScript = testScript'; + preferLocalBuild = true; + passthru = passthru // { + inherit nodes; + }; + } + '' + mkdir -p $out/bin + + echo -n "$testScript" > $out/test-script + ${lib.optionalString (!skipLint) '' + PYFLAKES_BUILTINS="$( + echo -n ${lib.escapeShellArg (lib.concatStringsSep "," nodeHostNames)}, + < ${lib.escapeShellArg "${testDriver}/nix-support/driver-symbols"} + )" ${python3Packages.pyflakes}/bin/pyflakes $out/test-script + ''} + + ln -s ${testDriver}/bin/nixos-test-driver $out/bin/ + vms=($(for i in ${toString vms}; do echo $i/bin/run-*-vm; done)) + wrapProgram $out/bin/nixos-test-driver \ + --add-flags "''${vms[*]}" \ + --run "export testScript=\"\$(${coreutils}/bin/cat $out/test-script)\"" \ + --set VLANS '${toString vlans}' + ln -s ${testDriver}/bin/nixos-test-driver $out/bin/nixos-run-vms + wrapProgram $out/bin/nixos-run-vms \ + --add-flags "''${vms[*]}" \ + --set tests 'start_all(); join_all();' \ + --set VLANS '${toString vlans}' + ''); + + # Make a full-blown test makeTest = { testScript , enableOCR ? false @@ -106,123 +198,47 @@ rec { , ... } @ t: let - # A standard store path to the vm monitor is built like this: - # /tmp/nix-build-vm-test-run-$name.drv-0/vm-state-machine/monitor - # The max filename length of a unix domain socket is 108 bytes. - # This means $name can at most be 50 bytes long. - maxTestNameLen = 50; - testNameLen = builtins.stringLength name; - - - - ocrProg = tesseract4.override { enableLanguages = [ "eng" ]; }; - - imagemagick_tiff = imagemagick_light.override { inherit libtiff; }; - - # Generate convenience wrappers for running the test driver - # interactively with the specified network, and for starting the - # VMs from the command line. - mkDriver = qemu_pkg: + nodes = qemu_pkg: let build-vms = import ./build-vms.nix { inherit system pkgs minimal specialArgs; - extraConfigurations = extraConfigurations ++ (pkgs.lib.optional (qemu_pkg != null) + extraConfigurations = extraConfigurations ++ [( { virtualisation.qemu.package = qemu_pkg; + # Ensure we do not use aliases. Ideally this is only set + # when the test framework is used by Nixpkgs NixOS tests. + nixpkgs.config.allowAliases = false; } - ); + )]; }; - - # FIXME: get this pkg from the module system - testDriver = mkTestDriver (if qemu_pkg == null then pkgs.qemu_test else qemu_pkg); - - nodes = build-vms.buildVirtualNetwork ( - t.nodes or (if t ? machine then { machine = t.machine; } else { }) - ); - vlans = map (m: m.config.virtualisation.vlans) (lib.attrValues nodes); - vms = map (m: m.config.system.build.vm) (lib.attrValues nodes); - - testScript' = - # Call the test script with the computed nodes. - if lib.isFunction testScript - then testScript { inherit nodes; } - else testScript; - - testDriverName = with builtins; - if testNameLen > maxTestNameLen then - abort - ("The name of the test '${name}' must not be longer than ${toString maxTestNameLen} " + - "it's currently ${toString testNameLen} characters long.") - else - "nixos-test-driver-${name}"; in - lib.warnIf skipLint "Linting is disabled" (runCommand testDriverName - { - nativeBuildInputs = [ makeWrapper ]; - testScript = testScript'; - preferLocalBuild = true; - testName = name; - passthru = passthru // { - inherit nodes; - }; - } - '' - mkdir -p $out/bin - - echo -n "$testScript" > $out/test-script - ${lib.optionalString (!skipLint) '' - PYFLAKES_BUILTINS="$( - echo -n ${lib.escapeShellArg (lib.concatStringsSep "," nodeHostNames)}, - < ${lib.escapeShellArg "${testDriver}/nix-support/driver-exports"} - )" ${python3Packages.pyflakes}/bin/pyflakes $out/test-script - ''} - - ln -s ${testDriver}/bin/nixos-test-driver $out/bin/ - vms=($(for i in ${toString vms}; do echo $i/bin/run-*-vm; done)) - wrapProgram $out/bin/nixos-test-driver \ - --add-flags "''${vms[*]}" \ - ${lib.optionalString enableOCR - "--prefix PATH : '${ocrProg}/bin:${imagemagick_tiff}/bin'"} \ - --run "export testScript=\"\$(${coreutils}/bin/cat $out/test-script)\"" \ - --set VLANS '${toString vlans}' - ln -s ${testDriver}/bin/nixos-test-driver $out/bin/nixos-run-vms - wrapProgram $out/bin/nixos-run-vms \ - --add-flags "''${vms[*]}" \ - ${lib.optionalString enableOCR "--prefix PATH : '${ocrProg}/bin'"} \ - --set tests 'start_all(); join_all();' \ - --set VLANS '${toString vlans}' \ - ${lib.optionalString (builtins.length vms == 1) "--set USE_SERIAL 1"} - ''); # " - - passMeta = drv: drv // lib.optionalAttrs (t ? meta) { - meta = (drv.meta or { }) // t.meta; - }; - - driver = mkDriver null; - driverInteractive = mkDriver pkgs.qemu; - - test = passMeta (runTests { inherit driver pos; }); + build-vms.buildVirtualNetwork ( + t.nodes or (if t ? machine then { machine = t.machine; } else { }) + ); - nodeNames = builtins.attrNames driver.nodes; - invalidNodeNames = lib.filter - (node: builtins.match "^[A-z_]([A-z0-9_]+)?$" node == null) - nodeNames; + driver = setupDriverForTest { + inherit testScript enableOCR skipLint passthru; + testName = name; + qemu_pkg = pkgs.qemu_test; + nodes = nodes pkgs.qemu_test; + }; + driverInteractive = setupDriverForTest { + inherit testScript enableOCR skipLint passthru; + testName = name; + qemu_pkg = pkgs.qemu; + nodes = nodes pkgs.qemu; + }; - nodeHostNames = map (c: c.config.system.name) (lib.attrValues driver.nodes); + test = + let + passMeta = drv: drv // lib.optionalAttrs (t ? meta) { + meta = (drv.meta or { }) // t.meta; + }; + in passMeta (runTests { inherit driver pos; }); in - if lib.length invalidNodeNames > 0 then - throw '' - Cannot create machines out of (${lib.concatStringsSep ", " invalidNodeNames})! - All machines are referenced as python variables in the testing framework which will break the - script when special characters are used. - - Please stick to alphanumeric chars and underscores as separation. - '' - else test // { - inherit test driver driverInteractive; - inherit (driver) nodes; + inherit test driver driverInteractive nodes; }; runInMachine = @@ -230,7 +246,7 @@ rec { , machine , preBuild ? "" , postBuild ? "" - , qemu ? pkgs.qemu_test + , qemu_pkg ? pkgs.qemu_test , ... # ??? }: let @@ -267,6 +283,8 @@ rec { client.succeed("sync") # flush all data before pulling the plug ''; + testDriver = pythonTestDriver { inherit qemu_pkg; }; + vmRunCommand = writeText "vm-run" '' xchg=vm-state-client/xchg ${coreutils}/bin/mkdir $out @@ -285,7 +303,7 @@ rec { unset xchg export tests='${testScript}' - ${mkTestDriver qemu}/bin/nixos-test-driver --keep-vm-state ${vm.config.system.build.vm}/bin/run-*-vm + ${testDriver}/bin/nixos-test-driver --keep-vm-state ${vm.config.system.build.vm}/bin/run-*-vm ''; # */ in diff --git a/nixos/lib/utils.nix b/nixos/lib/utils.nix index c9dfdbed99a..f1332ab5593 100644 --- a/nixos/lib/utils.nix +++ b/nixos/lib/utils.nix @@ -14,8 +14,30 @@ rec { fsNeededForBoot = fs: fs.neededForBoot || elem fs.mountPoint pathsNeededForBoot; # Check whenever `b` depends on `a` as a fileSystem - fsBefore = a: b: a.mountPoint == b.device - || hasPrefix "${a.mountPoint}${optionalString (!(hasSuffix "/" a.mountPoint)) "/"}" b.mountPoint; + fsBefore = a: b: + let + # normalisePath adds a slash at the end of the path if it didn't already + # have one. + # + # The reason slashes are added at the end of each path is to prevent `b` + # from accidentally depending on `a` in cases like + # a = { mountPoint = "/aaa"; ... } + # b = { device = "/aaaa"; ... } + # Here a.mountPoint *is* a prefix of b.device even though a.mountPoint is + # *not* a parent of b.device. If we add a slash at the end of each string, + # though, this is not a problem: "/aaa/" is not a prefix of "/aaaa/". + normalisePath = path: "${path}${optionalString (!(hasSuffix "/" path)) "/"}"; + normalise = mount: mount // { device = normalisePath (toString mount.device); + mountPoint = normalisePath mount.mountPoint; + depends = map normalisePath mount.depends; + }; + + a' = normalise a; + b' = normalise b; + + in hasPrefix a'.mountPoint b'.device + || hasPrefix a'.mountPoint b'.mountPoint + || any (hasPrefix a'.mountPoint) b'.depends; # Escape a path according to the systemd rules, e.g. /dev/xyzzy # becomes dev-xyzzy. FIXME: slow. diff --git a/nixos/modules/config/console.nix b/nixos/modules/config/console.nix index 5be7f06c05d..c5150305bd8 100644 --- a/nixos/modules/config/console.nix +++ b/nixos/modules/config/console.nix @@ -43,13 +43,14 @@ in options.console = { font = mkOption { - type = types.str; + type = with types; either str path; default = "Lat2-Terminus16"; example = "LatArCyrHeb-16"; description = '' The font used for the virtual consoles. Leave empty to use whatever the <command>setfont</command> program considers the default font. + Can be either a font name or a path to a PSF font file. ''; }; diff --git a/nixos/modules/config/nsswitch.nix b/nixos/modules/config/nsswitch.nix index d19d35a4890..91a36cef10e 100644 --- a/nixos/modules/config/nsswitch.nix +++ b/nixos/modules/config/nsswitch.nix @@ -124,8 +124,8 @@ with lib; group = mkBefore [ "files" ]; shadow = mkBefore [ "files" ]; hosts = mkMerge [ - (mkBefore [ "files" ]) - (mkAfter [ "dns" ]) + (mkOrder 998 [ "files" ]) + (mkOrder 1499 [ "dns" ]) ]; services = mkBefore [ "files" ]; }; diff --git a/nixos/modules/config/pulseaudio.nix b/nixos/modules/config/pulseaudio.nix index 0266bbfb121..3f7ae109e8c 100644 --- a/nixos/modules/config/pulseaudio.nix +++ b/nixos/modules/config/pulseaudio.nix @@ -17,9 +17,9 @@ let binary = "${getBin overriddenPackage}/bin/pulseaudio"; binaryNoDaemon = "${binary} --daemonize=no"; - # Forces 32bit pulseaudio and alsaPlugins to be built/supported for apps + # Forces 32bit pulseaudio and alsa-plugins to be built/supported for apps # using 32bit alsa on 64bit linux. - enable32BitAlsaPlugins = cfg.support32Bit && stdenv.isx86_64 && (pkgs.pkgsi686Linux.alsaLib != null && pkgs.pkgsi686Linux.libpulseaudio != null); + enable32BitAlsaPlugins = cfg.support32Bit && stdenv.isx86_64 && (pkgs.pkgsi686Linux.alsa-lib != null && pkgs.pkgsi686Linux.libpulseaudio != null); myConfigFile = @@ -62,18 +62,18 @@ let # plugin. alsaConf = writeText "asound.conf" ('' pcm_type.pulse { - libs.native = ${pkgs.alsaPlugins}/lib/alsa-lib/libasound_module_pcm_pulse.so ; + libs.native = ${pkgs.alsa-plugins}/lib/alsa-lib/libasound_module_pcm_pulse.so ; ${lib.optionalString enable32BitAlsaPlugins - "libs.32Bit = ${pkgs.pkgsi686Linux.alsaPlugins}/lib/alsa-lib/libasound_module_pcm_pulse.so ;"} + "libs.32Bit = ${pkgs.pkgsi686Linux.alsa-plugins}/lib/alsa-lib/libasound_module_pcm_pulse.so ;"} } pcm.!default { type pulse hint.description "Default Audio Device (via PulseAudio)" } ctl_type.pulse { - libs.native = ${pkgs.alsaPlugins}/lib/alsa-lib/libasound_module_ctl_pulse.so ; + libs.native = ${pkgs.alsa-plugins}/lib/alsa-lib/libasound_module_ctl_pulse.so ; ${lib.optionalString enable32BitAlsaPlugins - "libs.32Bit = ${pkgs.pkgsi686Linux.alsaPlugins}/lib/alsa-lib/libasound_module_ctl_pulse.so ;"} + "libs.32Bit = ${pkgs.pkgsi686Linux.alsa-plugins}/lib/alsa-lib/libasound_module_ctl_pulse.so ;"} } ctl.!default { type pulse diff --git a/nixos/modules/config/shells-environment.nix b/nixos/modules/config/shells-environment.nix index a0a20228a74..34e558d8603 100644 --- a/nixos/modules/config/shells-environment.nix +++ b/nixos/modules/config/shells-environment.nix @@ -126,6 +126,14 @@ in type = types.bool; }; + environment.localBinInPath = mkOption { + description = '' + Add ~/.local/bin/ to $PATH + ''; + default = false; + type = types.bool; + }; + environment.binsh = mkOption { default = "${config.system.build.binsh}/bin/sh"; defaultText = "\${config.system.build.binsh}/bin/sh"; @@ -198,6 +206,10 @@ in # ~/bin if it exists overrides other bin directories. export PATH="$HOME/bin:$PATH" ''} + + ${optionalString cfg.localBinInPath '' + export PATH="$HOME/.local/bin:$PATH" + ''} ''; system.activationScripts.binsh = stringAfter [ "stdio" ] diff --git a/nixos/modules/config/swap.nix b/nixos/modules/config/swap.nix index 59bc9e9d11e..ff2ae1da31b 100644 --- a/nixos/modules/config/swap.nix +++ b/nixos/modules/config/swap.nix @@ -114,6 +114,28 @@ let ''; }; + discardPolicy = mkOption { + default = null; + example = "once"; + type = types.nullOr (types.enum ["once" "pages" "both" ]); + description = '' + Specify the discard policy for the swap device. If "once", then the + whole swap space is discarded at swapon invocation. If "pages", + asynchronous discard on freed pages is performed, before returning to + the available pages pool. With "both", both policies are activated. + See swapon(8) for more information. + ''; + }; + + options = mkOption { + default = [ "defaults" ]; + example = [ "nofail" ]; + type = types.listOf types.nonEmptyStr; + description = '' + Options used to mount the swap. + ''; + }; + deviceName = mkOption { type = types.str; internal = true; @@ -202,7 +224,7 @@ in fi ''} ${optionalString sw.randomEncryption.enable '' - cryptsetup plainOpen -c ${sw.randomEncryption.cipher} -d ${sw.randomEncryption.source} ${sw.device} ${sw.deviceName} + cryptsetup plainOpen -c ${sw.randomEncryption.cipher} -d ${sw.randomEncryption.source} ${optionalString (sw.discardPolicy != null) "--allow-discards"} ${sw.device} ${sw.deviceName} mkswap ${sw.realDevice} ''} ''; diff --git a/nixos/modules/config/xdg/portals/wlr.nix b/nixos/modules/config/xdg/portals/wlr.nix new file mode 100644 index 00000000000..55baab0026b --- /dev/null +++ b/nixos/modules/config/xdg/portals/wlr.nix @@ -0,0 +1,67 @@ +{ config, pkgs, lib, ... }: + +with lib; + +let + cfg = config.xdg.portal.wlr; + package = pkgs.xdg-desktop-portal-wlr; + settingsFormat = pkgs.formats.ini { }; + configFile = settingsFormat.generate "xdg-desktop-portal-wlr.ini" cfg.settings; +in +{ + meta = { + maintainers = with maintainers; [ minijackson ]; + }; + + options.xdg.portal.wlr = { + enable = mkEnableOption '' + desktop portal for wlroots-based desktops + + This will add the <package>xdg-desktop-portal-wlr</package> package into + the <option>xdg.portal.extraPortals</option> option, and provide the + configuration file + ''; + + settings = mkOption { + description = '' + Configuration for <package>xdg-desktop-portal-wlr</package>. + + See <literal>xdg-desktop-portal-wlr(5)</literal> for supported + values. + ''; + + type = types.submodule { + freeformType = settingsFormat.type; + }; + + default = { }; + + # Example taken from the manpage + example = literalExample '' + { + screencast = { + output_name = "HDMI-A-1"; + max_fps = 30; + exec_before = "disable_notifications.sh"; + exec_after = "enable_notifications.sh"; + chooser_type = "simple"; + chooser_cmd = "''${pkgs.slurp}/bin/slurp -f %o -or"; + }; + } + ''; + }; + }; + + config = mkIf cfg.enable { + xdg.portal = { + enable = true; + extraPortals = [ package ]; + }; + + systemd.user.services.xdg-desktop-portal-wlr.serviceConfig.ExecStart = [ + # Empty ExecStart value to override the field + "" + "${package}/libexec/xdg-desktop-portal-wlr --config=${configFile}" + ]; + }; +} diff --git a/nixos/modules/hardware/corectrl.nix b/nixos/modules/hardware/corectrl.nix new file mode 100644 index 00000000000..3185f6486c7 --- /dev/null +++ b/nixos/modules/hardware/corectrl.nix @@ -0,0 +1,62 @@ +{ config, pkgs, lib, ... }: + +with lib; + +let + cfg = config.programs.corectrl; +in +{ + options.programs.corectrl = { + enable = mkEnableOption '' + A tool to overclock amd graphics cards and processors. + Add your user to the corectrl group to run corectrl without needing to enter your password + ''; + + gpuOverclock = { + enable = mkEnableOption '' + true + ''; + ppfeaturemask = mkOption { + type = types.str; + default = "0xfffd7fff"; + example = "0xffffffff"; + description = '' + Sets the `amdgpu.ppfeaturemask` kernel option. + In particular, it is used here to set the overdrive bit. + Default is `0xfffd7fff` as it is less likely to cause flicker issues. + Setting it to `0xffffffff` enables all features. + ''; + }; + }; + }; + + config = mkIf cfg.enable (lib.mkMerge [ + { + environment.systemPackages = [ pkgs.corectrl ]; + + services.dbus.packages = [ pkgs.corectrl ]; + + users.groups.corectrl = { }; + + security.polkit.extraConfig = '' + polkit.addRule(function(action, subject) { + if ((action.id == "org.corectrl.helper.init" || + action.id == "org.corectrl.helperkiller.init") && + subject.local == true && + subject.active == true && + subject.isInGroup("corectrl")) { + return polkit.Result.YES; + } + }); + ''; + } + + (lib.mkIf cfg.gpuOverclock.enable { + # https://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git/tree/drivers/gpu/drm/amd/include/amd_shared.h#n169 + # The overdrive bit + boot.kernelParams = [ "amdgpu.ppfeaturemask=${cfg.gpuOverclock.ppfeaturemask}" ]; + }) + ]); + + meta.maintainers = with lib.maintainers; [ artturin ]; +} diff --git a/nixos/modules/hardware/sensor/iio.nix b/nixos/modules/hardware/sensor/iio.nix index 4c359c3b172..8b3ba87a7d9 100644 --- a/nixos/modules/hardware/sensor/iio.nix +++ b/nixos/modules/hardware/sensor/iio.nix @@ -9,7 +9,7 @@ with lib; hardware.sensor.iio = { enable = mkOption { description = '' - Enable this option to support IIO sensors. + Enable this option to support IIO sensors with iio-sensor-proxy. IIO sensors are used for orientation and ambient light sensors on some mobile devices. diff --git a/nixos/modules/hardware/system-76.nix b/nixos/modules/hardware/system-76.nix index ed661fd3303..d4896541dba 100644 --- a/nixos/modules/hardware/system-76.nix +++ b/nixos/modules/hardware/system-76.nix @@ -34,6 +34,25 @@ let wantedBy = [ "multi-user.target" ]; }; }; + + power-pkg = config.boot.kernelPackages.system76-power; + powerConfig = mkIf cfg.power-daemon.enable { + # Make system76-power usable by root from the command line. + environment.systemPackages = [ power-pkg ]; + + services.dbus.packages = [ power-pkg ]; + + systemd.services.system76-power = { + description = "System76 Power Daemon"; + serviceConfig = { + ExecStart = "${power-pkg}/bin/system76-power daemon"; + Restart = "on-failure"; + Type = "dbus"; + BusName = "com.system76.PowerDaemon"; + }; + wantedBy = [ "multi-user.target" ]; + }; + }; in { options = { hardware.system76 = { @@ -52,8 +71,15 @@ in { description = "Whether to make the system76 out-of-tree kernel modules available"; type = types.bool; }; + + power-daemon.enable = mkOption { + default = cfg.enableAll; + example = true; + description = "Whether to enable the system76 power daemon"; + type = types.bool; + }; }; }; - config = mkMerge [ moduleConfig firmwareConfig ]; + config = mkMerge [ moduleConfig firmwareConfig powerConfig ]; } diff --git a/nixos/modules/hardware/video/nvidia.nix b/nixos/modules/hardware/video/nvidia.nix index 97accc7b99a..2be9da8f42a 100644 --- a/nixos/modules/hardware/video/nvidia.nix +++ b/nixos/modules/hardware/video/nvidia.nix @@ -92,7 +92,7 @@ in example = "PCI:4:0:0"; description = '' Bus ID of the AMD APU. You can find it using lspci; for example if lspci - shows the AMD APU at "04:00.0", set this option to "PCI:4:0:0". + shows the AMD APU at "04:00.0", set this option to "PCI:4:0:0". ''; }; @@ -159,7 +159,7 @@ in description = '' The NVIDIA X11 derivation to use. ''; - example = "config.boot.kernelPackages.nvidiaPackages.legacy340"; + example = "config.boot.kernelPackages.nvidiaPackages.legacy_340"; }; }; diff --git a/nixos/modules/i18n/input-method/fcitx5.nix b/nixos/modules/i18n/input-method/fcitx5.nix index 44962d202fe..eecbe32fea4 100644 --- a/nixos/modules/i18n/input-method/fcitx5.nix +++ b/nixos/modules/i18n/input-method/fcitx5.nix @@ -6,28 +6,33 @@ let im = config.i18n.inputMethod; cfg = im.fcitx5; fcitx5Package = pkgs.fcitx5-with-addons.override { inherit (cfg) addons; }; -in - { - options = { - i18n.inputMethod.fcitx5 = { - addons = mkOption { - type = with types; listOf package; - default = []; - example = with pkgs; [ fcitx5-rime ]; - description = '' - Enabled Fcitx5 addons. - ''; - }; +in { + options = { + i18n.inputMethod.fcitx5 = { + addons = mkOption { + type = with types; listOf package; + default = []; + example = with pkgs; [ fcitx5-rime ]; + description = '' + Enabled Fcitx5 addons. + ''; }; }; + }; - config = mkIf (im.enabled == "fcitx5") { - i18n.inputMethod.package = fcitx5Package; + config = mkIf (im.enabled == "fcitx5") { + i18n.inputMethod.package = fcitx5Package; - environment.variables = { - GTK_IM_MODULE = "fcitx"; - QT_IM_MODULE = "fcitx"; - XMODIFIERS = "@im=fcitx"; - }; + environment.variables = { + GTK_IM_MODULE = "fcitx"; + QT_IM_MODULE = "fcitx"; + XMODIFIERS = "@im=fcitx"; + }; + + systemd.user.services.fcitx5-daemon = { + enable = true; + script = "${fcitx5Package}/bin/fcitx5"; + wantedBy = [ "graphical-session.target" ]; }; - } + }; +} diff --git a/nixos/modules/installer/cd-dvd/installation-cd-base.nix b/nixos/modules/installer/cd-dvd/installation-cd-base.nix index 6c7ea293e8a..aecb65b8c57 100644 --- a/nixos/modules/installer/cd-dvd/installation-cd-base.nix +++ b/nixos/modules/installer/cd-dvd/installation-cd-base.nix @@ -30,5 +30,16 @@ with lib; # Add Memtest86+ to the CD. boot.loader.grub.memtest86.enable = true; + boot.postBootCommands = '' + for o in $(</proc/cmdline); do + case "$o" in + live.nixos.passwd=*) + set -- $(IFS==; echo $o) + echo "nixos:$2" | ${pkgs.shadow}/bin/chpasswd + ;; + esac + done + ''; + system.stateVersion = mkDefault "18.03"; } diff --git a/nixos/modules/installer/cd-dvd/iso-image.nix b/nixos/modules/installer/cd-dvd/iso-image.nix index c2836b5a9a1..d94af0b5bf7 100644 --- a/nixos/modules/installer/cd-dvd/iso-image.nix +++ b/nixos/modules/installer/cd-dvd/iso-image.nix @@ -428,7 +428,8 @@ let # Rewrite dates for everything in the FS find . -exec touch --date=2000-01-01 {} + - usage_size=$(du -sb --apparent-size . | tr -cd '[:digit:]') + # Round up to the nearest multiple of 1MB, for more deterministic du output + usage_size=$(( $(du -s --block-size=1M --apparent-size . | tr -cd '[:digit:]') * 1024 * 1024 )) # Make the image 110% as big as the files need to make up for FAT overhead image_size=$(( ($usage_size * 110) / 100 )) # Make the image fit blocks of 1M @@ -438,7 +439,16 @@ let echo "Image size: $image_size" truncate --size=$image_size "$out" faketime "2000-01-01 00:00:00" mkfs.vfat -i 12345678 -n EFIBOOT "$out" - mcopy -psvm -i "$out" ./EFI ./boot :: + + # Force a fixed order in mcopy for better determinism, and avoid file globbing + for d in $(find EFI boot -type d | sort); do + faketime "2000-01-01 00:00:00" mmd -i "$out" "::/$d" + done + + for f in $(find EFI boot -type f | sort); do + mcopy -pvm -i "$out" "$f" "::/$f" + done + # Verify the FAT partition. fsck.vfat -vn "$out" ''; # */ @@ -680,6 +690,12 @@ in "upperdir=/nix/.rw-store/store" "workdir=/nix/.rw-store/work" ]; + + depends = [ + "/nix/.ro-store" + "/nix/.rw-store/store" + "/nix/.rw-store/work" + ]; }; boot.initrd.availableKernelModules = [ "squashfs" "iso9660" "uas" "overlay" ]; diff --git a/nixos/modules/installer/netboot/netboot.nix b/nixos/modules/installer/netboot/netboot.nix index fa074fdfcc6..238ab6d0617 100644 --- a/nixos/modules/installer/netboot/netboot.nix +++ b/nixos/modules/installer/netboot/netboot.nix @@ -57,6 +57,12 @@ with lib; "upperdir=/nix/.rw-store/store" "workdir=/nix/.rw-store/work" ]; + + depends = [ + "/nix/.ro-store" + "/nix/.rw-store/store" + "/nix/.rw-store/work" + ]; }; boot.initrd.availableKernelModules = [ "squashfs" "overlay" ]; diff --git a/nixos/modules/installer/sd-card/sd-image.nix b/nixos/modules/installer/sd-card/sd-image.nix index d0fe79903d3..2a10a77300e 100644 --- a/nixos/modules/installer/sd-card/sd-image.nix +++ b/nixos/modules/installer/sd-card/sd-image.nix @@ -55,6 +55,22 @@ in ''; }; + firmwarePartitionOffset = mkOption { + type = types.int; + default = 8; + description = '' + Gap in front of the /boot/firmware partition, in mebibytes (1024×1024 + bytes). + Can be increased to make more space for boards requiring to dd u-boot + SPL before actual partitions. + + Unless you are building your own images pre-configured with an + installed U-Boot, you can instead opt to delete the existing `FIRMWARE` + partition, which is used **only** for the Raspberry Pi family of + hardware. + ''; + }; + firmwarePartitionID = mkOption { type = types.str; default = "0x2178694e"; @@ -177,7 +193,7 @@ in zstd -d --no-progress "${rootfsImage}" -o ./root-fs.img # Gap in front of the first partition, in MiB - gap=8 + gap=${toString config.sdImage.firmwarePartitionOffset} # Create the image file sized to fit /boot/firmware and /, plus slack for the gap. rootSizeBlocks=$(du -B 512 --apparent-size ./root-fs.img | awk '{ print $1 }') diff --git a/nixos/modules/installer/tools/nix-fallback-paths.nix b/nixos/modules/installer/tools/nix-fallback-paths.nix index 801e28cec44..e3576074a5b 100644 --- a/nixos/modules/installer/tools/nix-fallback-paths.nix +++ b/nixos/modules/installer/tools/nix-fallback-paths.nix @@ -1,6 +1,7 @@ { - x86_64-linux = "/nix/store/d1ppfhjhdwcsb4npfzyifv5z8i00fzsk-nix-2.3.11"; - i686-linux = "/nix/store/c6ikndcrzwpfn2sb5b9xb1f17p9b8iga-nix-2.3.11"; - aarch64-linux = "/nix/store/fb0lfrn0m8s197d264jzd64vhz9c8zbx-nix-2.3.11"; - x86_64-darwin = "/nix/store/qvb86ffv08q3r66qbd6nqifz425lyyhf-nix-2.3.11"; + x86_64-linux = "/nix/store/qsgz2hhn6mzlzp53a7pwf9z2pq3l5z6h-nix-2.3.14"; + i686-linux = "/nix/store/1yw40bj04lykisw2jilq06lir3k9ga4a-nix-2.3.14"; + aarch64-linux = "/nix/store/32yzwmynmjxfrkb6y6l55liaqdrgkj4a-nix-2.3.14"; + x86_64-darwin = "/nix/store/06j0vi2d13w4l0p3jsigq7lk4x6gkycj-nix-2.3.14"; + aarch64-darwin = "/nix/store/77wi7vpbrghw5rgws25w30bwb8yggnk9-nix-2.3.14"; } diff --git a/nixos/modules/installer/tools/nixos-option/CMakeLists.txt b/nixos/modules/installer/tools/nixos-option/CMakeLists.txt deleted file mode 100644 index e5834598c4f..00000000000 --- a/nixos/modules/installer/tools/nixos-option/CMakeLists.txt +++ /dev/null @@ -1,8 +0,0 @@ -cmake_minimum_required (VERSION 2.6) -project (nixos-option) - -add_executable(nixos-option nixos-option.cc libnix-copy-paste.cc) -target_link_libraries(nixos-option PRIVATE -lnixmain -lnixexpr -lnixstore -lnixutil) -target_compile_features(nixos-option PRIVATE cxx_std_17) - -install (TARGETS nixos-option DESTINATION bin) diff --git a/nixos/modules/installer/tools/nixos-option/default.nix b/nixos/modules/installer/tools/nixos-option/default.nix index 72eec3a3836..061460f38a3 100644 --- a/nixos/modules/installer/tools/nixos-option/default.nix +++ b/nixos/modules/installer/tools/nixos-option/default.nix @@ -1,11 +1 @@ -{lib, stdenv, boost, cmake, pkg-config, nix, ... }: -stdenv.mkDerivation rec { - name = "nixos-option"; - src = ./.; - nativeBuildInputs = [ cmake pkg-config ]; - buildInputs = [ boost nix ]; - meta = with lib; { - license = licenses.lgpl2Plus; - maintainers = with maintainers; [ chkno ]; - }; -} +{ pkgs, ... }: pkgs.nixos-option diff --git a/nixos/modules/installer/tools/nixos-option/libnix-copy-paste.cc b/nixos/modules/installer/tools/nixos-option/libnix-copy-paste.cc deleted file mode 100644 index 875c07da639..00000000000 --- a/nixos/modules/installer/tools/nixos-option/libnix-copy-paste.cc +++ /dev/null @@ -1,83 +0,0 @@ -// These are useful methods inside the nix library that ought to be exported. -// Since they are not, copy/paste them here. -// TODO: Delete these and use the ones in the library as they become available. - -#include <nix/config.h> // for nix/globals.hh's reference to SYSTEM - -#include "libnix-copy-paste.hh" -#include <boost/format/alt_sstream.hpp> // for basic_altstringbuf... -#include <boost/format/alt_sstream_impl.hpp> // for basic_altstringbuf... -#include <boost/format/format_class.hpp> // for basic_format -#include <boost/format/format_fwd.hpp> // for format -#include <boost/format/format_implementation.hpp> // for basic_format::basi... -#include <boost/optional/optional.hpp> // for get_pointer -#include <iostream> // for operator<<, basic_... -#include <nix/types.hh> // for Strings, Error -#include <string> // for string, basic_string - -using boost::format; -using nix::Error; -using nix::Strings; -using std::string; - -// From nix/src/libexpr/attr-path.cc -Strings parseAttrPath(const string & s) -{ - Strings res; - string cur; - string::const_iterator i = s.begin(); - while (i != s.end()) { - if (*i == '.') { - res.push_back(cur); - cur.clear(); - } else if (*i == '"') { - ++i; - while (1) { - if (i == s.end()) - throw Error(format("missing closing quote in selection path '%1%'") % s); - if (*i == '"') - break; - cur.push_back(*i++); - } - } else - cur.push_back(*i); - ++i; - } - if (!cur.empty()) - res.push_back(cur); - return res; -} - -// From nix/src/nix/repl.cc -bool isVarName(const string & s) -{ - if (s.size() == 0) - return false; - char c = s[0]; - if ((c >= '0' && c <= '9') || c == '-' || c == '\'') - return false; - for (auto & i : s) - if (!((i >= 'a' && i <= 'z') || (i >= 'A' && i <= 'Z') || (i >= '0' && i <= '9') || i == '_' || i == '-' || - i == '\'')) - return false; - return true; -} - -// From nix/src/nix/repl.cc -std::ostream & printStringValue(std::ostream & str, const char * string) -{ - str << "\""; - for (const char * i = string; *i; i++) - if (*i == '\"' || *i == '\\') - str << "\\" << *i; - else if (*i == '\n') - str << "\\n"; - else if (*i == '\r') - str << "\\r"; - else if (*i == '\t') - str << "\\t"; - else - str << *i; - str << "\""; - return str; -} diff --git a/nixos/modules/installer/tools/nixos-option/libnix-copy-paste.hh b/nixos/modules/installer/tools/nixos-option/libnix-copy-paste.hh deleted file mode 100644 index 2274e9a0f85..00000000000 --- a/nixos/modules/installer/tools/nixos-option/libnix-copy-paste.hh +++ /dev/null @@ -1,9 +0,0 @@ -#pragma once - -#include <iostream> -#include <nix/types.hh> -#include <string> - -nix::Strings parseAttrPath(const std::string & s); -bool isVarName(const std::string & s); -std::ostream & printStringValue(std::ostream & str, const char * string); diff --git a/nixos/modules/installer/tools/nixos-option/nixos-option.cc b/nixos/modules/installer/tools/nixos-option/nixos-option.cc deleted file mode 100644 index f779d82edbd..00000000000 --- a/nixos/modules/installer/tools/nixos-option/nixos-option.cc +++ /dev/null @@ -1,643 +0,0 @@ -#include <nix/config.h> // for nix/globals.hh's reference to SYSTEM - -#include <exception> // for exception_ptr, current_exception -#include <functional> // for function -#include <iostream> // for operator<<, basic_ostream, ostrin... -#include <iterator> // for next -#include <list> // for _List_iterator -#include <memory> // for allocator, unique_ptr, make_unique -#include <new> // for operator new -#include <nix/args.hh> // for argvToStrings, UsageError -#include <nix/attr-path.hh> // for findAlongAttrPath -#include <nix/attr-set.hh> // for Attr, Bindings, Bindings::iterator -#include <nix/common-eval-args.hh> // for MixEvalArgs -#include <nix/eval-inline.hh> // for EvalState::forceValue -#include <nix/eval.hh> // for EvalState, initGC, operator<< -#include <nix/globals.hh> // for initPlugins, Settings, settings -#include <nix/nixexpr.hh> // for Pos -#include <nix/shared.hh> // for getArg, LegacyArgs, printVersion -#include <nix/store-api.hh> // for openStore -#include <nix/symbol-table.hh> // for Symbol, SymbolTable -#include <nix/types.hh> // for Error, Path, Strings, PathSet -#include <nix/util.hh> // for absPath, baseNameOf -#include <nix/value.hh> // for Value, Value::(anonymous), Value:... -#include <string> // for string, operator+, operator== -#include <utility> // for move -#include <variant> // for get, holds_alternative, variant -#include <vector> // for vector<>::iterator, vector - -#include "libnix-copy-paste.hh" - -using nix::absPath; -using nix::Bindings; -using nix::Error; -using nix::EvalError; -using nix::EvalState; -using nix::Path; -using nix::PathSet; -using nix::Strings; -using nix::Symbol; -using nix::tAttrs; -using nix::ThrownError; -using nix::tLambda; -using nix::tString; -using nix::UsageError; -using nix::Value; - -// An ostream wrapper to handle nested indentation -class Out -{ - public: - class Separator - {}; - const static Separator sep; - enum LinePolicy - { - ONE_LINE, - MULTI_LINE - }; - explicit Out(std::ostream & ostream) : ostream(ostream), policy(ONE_LINE), writeSinceSep(true) {} - Out(Out & o, const std::string & start, const std::string & end, LinePolicy policy); - Out(Out & o, const std::string & start, const std::string & end, int count) - : Out(o, start, end, count < 2 ? ONE_LINE : MULTI_LINE) - {} - Out(const Out &) = delete; - Out(Out &&) = default; - Out & operator=(const Out &) = delete; - Out & operator=(Out &&) = delete; - ~Out() { ostream << end; } - - private: - std::ostream & ostream; - std::string indentation; - std::string end; - LinePolicy policy; - bool writeSinceSep; - template <typename T> friend Out & operator<<(Out & o, T thing); -}; - -template <typename T> Out & operator<<(Out & o, T thing) -{ - if (!o.writeSinceSep && o.policy == Out::MULTI_LINE) { - o.ostream << o.indentation; - } - o.writeSinceSep = true; - o.ostream << thing; - return o; -} - -template <> Out & operator<<<Out::Separator>(Out & o, Out::Separator /* thing */) -{ - o.ostream << (o.policy == Out::ONE_LINE ? " " : "\n"); - o.writeSinceSep = false; - return o; -} - -Out::Out(Out & o, const std::string & start, const std::string & end, LinePolicy policy) - : ostream(o.ostream), indentation(policy == ONE_LINE ? o.indentation : o.indentation + " "), - end(policy == ONE_LINE ? end : o.indentation + end), policy(policy), writeSinceSep(true) -{ - o << start; - *this << Out::sep; -} - -// Stuff needed for evaluation -struct Context -{ - Context(EvalState & state, Bindings & autoArgs, Value optionsRoot, Value configRoot) - : state(state), autoArgs(autoArgs), optionsRoot(optionsRoot), configRoot(configRoot), - underscoreType(state.symbols.create("_type")) - {} - EvalState & state; - Bindings & autoArgs; - Value optionsRoot; - Value configRoot; - Symbol underscoreType; -}; - -Value evaluateValue(Context & ctx, Value & v) -{ - ctx.state.forceValue(v); - if (ctx.autoArgs.empty()) { - return v; - } - Value called{}; - ctx.state.autoCallFunction(ctx.autoArgs, v, called); - return called; -} - -bool isOption(Context & ctx, const Value & v) -{ - if (v.type != tAttrs) { - return false; - } - const auto & actualType = v.attrs->find(ctx.underscoreType); - if (actualType == v.attrs->end()) { - return false; - } - try { - Value evaluatedType = evaluateValue(ctx, *actualType->value); - if (evaluatedType.type != tString) { - return false; - } - return static_cast<std::string>(evaluatedType.string.s) == "option"; - } catch (Error &) { - return false; - } -} - -// Add quotes to a component of a path. -// These are needed for paths like: -// fileSystems."/".fsType -// systemd.units."dbus.service".text -std::string quoteAttribute(const std::string & attribute) -{ - if (isVarName(attribute)) { - return attribute; - } - std::ostringstream buf; - printStringValue(buf, attribute.c_str()); - return buf.str(); -} - -const std::string appendPath(const std::string & prefix, const std::string & suffix) -{ - if (prefix.empty()) { - return quoteAttribute(suffix); - } - return prefix + "." + quoteAttribute(suffix); -} - -bool forbiddenRecursionName(std::string name) { return (!name.empty() && name[0] == '_') || name == "haskellPackages"; } - -void recurse(const std::function<bool(const std::string & path, std::variant<Value, std::exception_ptr>)> & f, - Context & ctx, Value v, const std::string & path) -{ - std::variant<Value, std::exception_ptr> evaluated; - try { - evaluated = evaluateValue(ctx, v); - } catch (Error &) { - evaluated = std::current_exception(); - } - if (!f(path, evaluated)) { - return; - } - if (std::holds_alternative<std::exception_ptr>(evaluated)) { - return; - } - const Value & evaluated_value = std::get<Value>(evaluated); - if (evaluated_value.type != tAttrs) { - return; - } - for (const auto & child : evaluated_value.attrs->lexicographicOrder()) { - if (forbiddenRecursionName(child->name)) { - continue; - } - recurse(f, ctx, *child->value, appendPath(path, child->name)); - } -} - -bool optionTypeIs(Context & ctx, Value & v, const std::string & soughtType) -{ - try { - const auto & typeLookup = v.attrs->find(ctx.state.sType); - if (typeLookup == v.attrs->end()) { - return false; - } - Value type = evaluateValue(ctx, *typeLookup->value); - if (type.type != tAttrs) { - return false; - } - const auto & nameLookup = type.attrs->find(ctx.state.sName); - if (nameLookup == type.attrs->end()) { - return false; - } - Value name = evaluateValue(ctx, *nameLookup->value); - if (name.type != tString) { - return false; - } - return name.string.s == soughtType; - } catch (Error &) { - return false; - } -} - -bool isAggregateOptionType(Context & ctx, Value & v) -{ - return optionTypeIs(ctx, v, "attrsOf") || optionTypeIs(ctx, v, "listOf"); -} - -MakeError(OptionPathError, EvalError); - -Value getSubOptions(Context & ctx, Value & option) -{ - Value getSubOptions = evaluateValue(ctx, *findAlongAttrPath(ctx.state, "type.getSubOptions", ctx.autoArgs, option)); - if (getSubOptions.type != tLambda) { - throw OptionPathError("Option's type.getSubOptions isn't a function"); - } - Value emptyString{}; - nix::mkString(emptyString, ""); - Value v; - ctx.state.callFunction(getSubOptions, emptyString, v, nix::Pos{}); - return v; -} - -// Carefully walk an option path, looking for sub-options when a path walks past -// an option value. -struct FindAlongOptionPathRet -{ - Value option; - std::string path; -}; -FindAlongOptionPathRet findAlongOptionPath(Context & ctx, const std::string & path) -{ - Strings tokens = parseAttrPath(path); - Value v = ctx.optionsRoot; - std::string processedPath; - for (auto i = tokens.begin(); i != tokens.end(); i++) { - const auto & attr = *i; - try { - bool lastAttribute = std::next(i) == tokens.end(); - v = evaluateValue(ctx, v); - if (attr.empty()) { - throw OptionPathError("empty attribute name"); - } - if (isOption(ctx, v) && optionTypeIs(ctx, v, "submodule")) { - v = getSubOptions(ctx, v); - } - if (isOption(ctx, v) && isAggregateOptionType(ctx, v)) { - auto subOptions = getSubOptions(ctx, v); - if (lastAttribute && subOptions.attrs->empty()) { - break; - } - v = subOptions; - // Note that we've consumed attr, but didn't actually use it. This is the path component that's looked - // up in the list or attribute set that doesn't name an option -- the "root" in "users.users.root.name". - } else if (v.type != tAttrs) { - throw OptionPathError("Value is %s while a set was expected", showType(v)); - } else { - const auto & next = v.attrs->find(ctx.state.symbols.create(attr)); - if (next == v.attrs->end()) { - throw OptionPathError("Attribute not found", attr, path); - } - v = *next->value; - } - processedPath = appendPath(processedPath, attr); - } catch (OptionPathError & e) { - throw OptionPathError("At '%s' in path '%s': %s", attr, path, e.msg()); - } - } - return {v, processedPath}; -} - -// Calls f on all the option names at or below the option described by `path`. -// Note that "the option described by `path`" is not trivial -- if path describes a value inside an aggregate -// option (such as users.users.root), the *option* described by that path is one path component shorter -// (eg: users.users), which results in f being called on sibling-paths (eg: users.users.nixbld1). If f -// doesn't want these, it must do its own filtering. -void mapOptions(const std::function<void(const std::string & path)> & f, Context & ctx, const std::string & path) -{ - auto root = findAlongOptionPath(ctx, path); - recurse( - [f, &ctx](const std::string & path, std::variant<Value, std::exception_ptr> v) { - bool isOpt = std::holds_alternative<std::exception_ptr>(v) || isOption(ctx, std::get<Value>(v)); - if (isOpt) { - f(path); - } - return !isOpt; - }, - ctx, root.option, root.path); -} - -// Calls f on all the config values inside one option. -// Simple options have one config value inside, like sound.enable = true. -// Compound options have multiple config values. For example, the option -// "users.users" has about 1000 config values inside it: -// users.users.avahi.createHome = false; -// users.users.avahi.cryptHomeLuks = null; -// users.users.avahi.description = "`avahi-daemon' privilege separation user"; -// ... -// users.users.avahi.openssh.authorizedKeys.keyFiles = [ ]; -// users.users.avahi.openssh.authorizedKeys.keys = [ ]; -// ... -// users.users.avahi.uid = 10; -// users.users.avahi.useDefaultShell = false; -// users.users.cups.createHome = false; -// ... -// users.users.cups.useDefaultShell = false; -// users.users.gdm = ... ... ... -// users.users.messagebus = ... .. ... -// users.users.nixbld1 = ... .. ... -// ... -// users.users.systemd-timesync = ... .. ... -void mapConfigValuesInOption( - const std::function<void(const std::string & path, std::variant<Value, std::exception_ptr> v)> & f, - const std::string & path, Context & ctx) -{ - Value * option; - try { - option = findAlongAttrPath(ctx.state, path, ctx.autoArgs, ctx.configRoot); - } catch (Error &) { - f(path, std::current_exception()); - return; - } - recurse( - [f, ctx](const std::string & path, std::variant<Value, std::exception_ptr> v) { - bool leaf = std::holds_alternative<std::exception_ptr>(v) || std::get<Value>(v).type != tAttrs || - ctx.state.isDerivation(std::get<Value>(v)); - if (!leaf) { - return true; // Keep digging - } - f(path, v); - return false; - }, - ctx, *option, path); -} - -std::string describeError(const Error & e) { return "«error: " + e.msg() + "»"; } - -void describeDerivation(Context & ctx, Out & out, Value v) -{ - // Copy-pasted from nix/src/nix/repl.cc :( - Bindings::iterator i = v.attrs->find(ctx.state.sDrvPath); - PathSet pathset; - try { - Path drvPath = i != v.attrs->end() ? ctx.state.coerceToPath(*i->pos, *i->value, pathset) : "???"; - out << "«derivation " << drvPath << "»"; - } catch (Error & e) { - out << describeError(e); - } -} - -Value parseAndEval(EvalState & state, const std::string & expression, const std::string & path) -{ - Value v{}; - state.eval(state.parseExprFromString(expression, absPath(path)), v); - return v; -} - -void printValue(Context & ctx, Out & out, std::variant<Value, std::exception_ptr> maybeValue, const std::string & path); - -void printList(Context & ctx, Out & out, Value & v) -{ - Out listOut(out, "[", "]", v.listSize()); - for (unsigned int n = 0; n < v.listSize(); ++n) { - printValue(ctx, listOut, *v.listElems()[n], ""); - listOut << Out::sep; - } -} - -void printAttrs(Context & ctx, Out & out, Value & v, const std::string & path) -{ - Out attrsOut(out, "{", "}", v.attrs->size()); - for (const auto & a : v.attrs->lexicographicOrder()) { - std::string name = a->name; - if (!forbiddenRecursionName(name)) { - attrsOut << name << " = "; - printValue(ctx, attrsOut, *a->value, appendPath(path, name)); - attrsOut << ";" << Out::sep; - } - } -} - -void multiLineStringEscape(Out & out, const std::string & s) -{ - int i; - for (i = 1; i < s.size(); i++) { - if (s[i - 1] == '$' && s[i] == '{') { - out << "''${"; - i++; - } else if (s[i - 1] == '\'' && s[i] == '\'') { - out << "'''"; - i++; - } else { - out << s[i - 1]; - } - } - if (i == s.size()) { - out << s[i - 1]; - } -} - -void printMultiLineString(Out & out, const Value & v) -{ - std::string s = v.string.s; - Out strOut(out, "''", "''", Out::MULTI_LINE); - std::string::size_type begin = 0; - while (begin < s.size()) { - std::string::size_type end = s.find('\n', begin); - if (end == std::string::npos) { - multiLineStringEscape(strOut, s.substr(begin, s.size() - begin)); - break; - } - multiLineStringEscape(strOut, s.substr(begin, end - begin)); - strOut << Out::sep; - begin = end + 1; - } -} - -void printValue(Context & ctx, Out & out, std::variant<Value, std::exception_ptr> maybeValue, const std::string & path) -{ - try { - if (auto ex = std::get_if<std::exception_ptr>(&maybeValue)) { - std::rethrow_exception(*ex); - } - Value v = evaluateValue(ctx, std::get<Value>(maybeValue)); - if (ctx.state.isDerivation(v)) { - describeDerivation(ctx, out, v); - } else if (v.isList()) { - printList(ctx, out, v); - } else if (v.type == tAttrs) { - printAttrs(ctx, out, v, path); - } else if (v.type == tString && std::string(v.string.s).find('\n') != std::string::npos) { - printMultiLineString(out, v); - } else { - ctx.state.forceValueDeep(v); - out << v; - } - } catch (ThrownError & e) { - if (e.msg() == "The option `" + path + "' is used but not defined.") { - // 93% of errors are this, and just letting this message through would be - // misleading. These values may or may not actually be "used" in the - // config. The thing throwing the error message assumes that if anything - // ever looks at this value, it is a "use" of this value. But here in - // nixos-option, we are looking at this value only to print it. - // In order to avoid implying that this undefined value is actually - // referenced, eat the underlying error message and emit "«not defined»". - out << "«not defined»"; - } else { - out << describeError(e); - } - } catch (Error & e) { - out << describeError(e); - } -} - -void printConfigValue(Context & ctx, Out & out, const std::string & path, std::variant<Value, std::exception_ptr> v) -{ - out << path << " = "; - printValue(ctx, out, std::move(v), path); - out << ";\n"; -} - -// Replace with std::starts_with when C++20 is available -bool starts_with(const std::string & s, const std::string & prefix) -{ - return s.size() >= prefix.size() && - std::equal(s.begin(), std::next(s.begin(), prefix.size()), prefix.begin(), prefix.end()); -} - -void printRecursive(Context & ctx, Out & out, const std::string & path) -{ - mapOptions( - [&ctx, &out, &path](const std::string & optionPath) { - mapConfigValuesInOption( - [&ctx, &out, &path](const std::string & configPath, std::variant<Value, std::exception_ptr> v) { - if (starts_with(configPath, path)) { - printConfigValue(ctx, out, configPath, v); - } - }, - optionPath, ctx); - }, - ctx, path); -} - -void printAttr(Context & ctx, Out & out, const std::string & path, Value & root) -{ - try { - printValue(ctx, out, *findAlongAttrPath(ctx.state, path, ctx.autoArgs, root), path); - } catch (Error & e) { - out << describeError(e); - } -} - -bool hasExample(Context & ctx, Value & option) -{ - try { - findAlongAttrPath(ctx.state, "example", ctx.autoArgs, option); - return true; - } catch (Error &) { - return false; - } -} - -void printOption(Context & ctx, Out & out, const std::string & path, Value & option) -{ - out << "Value:\n"; - printAttr(ctx, out, path, ctx.configRoot); - - out << "\n\nDefault:\n"; - printAttr(ctx, out, "default", option); - - out << "\n\nType:\n"; - printAttr(ctx, out, "type.description", option); - - if (hasExample(ctx, option)) { - out << "\n\nExample:\n"; - printAttr(ctx, out, "example", option); - } - - out << "\n\nDescription:\n"; - printAttr(ctx, out, "description", option); - - out << "\n\nDeclared by:\n"; - printAttr(ctx, out, "declarations", option); - - out << "\n\nDefined by:\n"; - printAttr(ctx, out, "files", option); - out << "\n"; -} - -void printListing(Out & out, Value & v) -{ - out << "This attribute set contains:\n"; - for (const auto & a : v.attrs->lexicographicOrder()) { - std::string name = a->name; - if (!name.empty() && name[0] != '_') { - out << name << "\n"; - } - } -} - -void printOne(Context & ctx, Out & out, const std::string & path) -{ - try { - auto result = findAlongOptionPath(ctx, path); - Value & option = result.option; - option = evaluateValue(ctx, option); - if (path != result.path) { - out << "Note: showing " << result.path << " instead of " << path << "\n"; - } - if (isOption(ctx, option)) { - printOption(ctx, out, result.path, option); - } else { - printListing(out, option); - } - } catch (Error & e) { - std::cerr << "error: " << e.msg() - << "\nAn error occurred while looking for attribute names. Are " - "you sure that '" - << path << "' exists?\n"; - } -} - -int main(int argc, char ** argv) -{ - bool recursive = false; - std::string path = "."; - std::string optionsExpr = "(import <nixpkgs/nixos> {}).options"; - std::string configExpr = "(import <nixpkgs/nixos> {}).config"; - std::vector<std::string> args; - - struct MyArgs : nix::LegacyArgs, nix::MixEvalArgs - { - using nix::LegacyArgs::LegacyArgs; - }; - - MyArgs myArgs(nix::baseNameOf(argv[0]), [&](Strings::iterator & arg, const Strings::iterator & end) { - if (*arg == "--help") { - nix::showManPage("nixos-option"); - } else if (*arg == "--version") { - nix::printVersion("nixos-option"); - } else if (*arg == "-r" || *arg == "--recursive") { - recursive = true; - } else if (*arg == "--path") { - path = nix::getArg(*arg, arg, end); - } else if (*arg == "--options_expr") { - optionsExpr = nix::getArg(*arg, arg, end); - } else if (*arg == "--config_expr") { - configExpr = nix::getArg(*arg, arg, end); - } else if (!arg->empty() && arg->at(0) == '-') { - return false; - } else { - args.push_back(*arg); - } - return true; - }); - - myArgs.parseCmdline(nix::argvToStrings(argc, argv)); - - nix::initPlugins(); - nix::initGC(); - nix::settings.readOnlyMode = true; - auto store = nix::openStore(); - auto state = std::make_unique<EvalState>(myArgs.searchPath, store); - - Value optionsRoot = parseAndEval(*state, optionsExpr, path); - Value configRoot = parseAndEval(*state, configExpr, path); - - Context ctx{*state, *myArgs.getAutoArgs(*state), optionsRoot, configRoot}; - Out out(std::cout); - - auto print = recursive ? printRecursive : printOne; - if (args.empty()) { - print(ctx, out, ""); - } - for (const auto & arg : args) { - print(ctx, out, arg); - } - - ctx.state.printStats(); - - return 0; -} diff --git a/nixos/modules/installer/tools/tools.nix b/nixos/modules/installer/tools/tools.nix index cb2dbf6c859..f79ed3493df 100644 --- a/nixos/modules/installer/tools/tools.nix +++ b/nixos/modules/installer/tools/tools.nix @@ -40,9 +40,9 @@ let }; nixos-option = - if lib.versionAtLeast (lib.getVersion pkgs.nix) "2.4pre" + if lib.versionAtLeast (lib.getVersion config.nix.package) "2.4pre" then null - else pkgs.callPackage ./nixos-option { }; + else pkgs.nixos-option; nixos-version = makeProg { name = "nixos-version"; diff --git a/nixos/modules/misc/ids.nix b/nixos/modules/misc/ids.nix index 05cc5002aaf..858c7ee53db 100644 --- a/nixos/modules/misc/ids.nix +++ b/nixos/modules/misc/ids.nix @@ -229,7 +229,7 @@ in grafana = 196; skydns = 197; # ripple-rest = 198; # unused, removed 2017-08-12 - nix-serve = 199; + # nix-serve = 199; # unused, removed 2020-12-12 tvheadend = 200; uwsgi = 201; gitit = 202; @@ -252,7 +252,7 @@ in postsrsd = 220; opendkim = 221; dspam = 222; - gale = 223; + # gale = 223; removed 2021-06-10 matrix-synapse = 224; rspamd = 225; # rmilter = 226; # unused, removed 2019-08-22 @@ -300,7 +300,7 @@ in #pdns-recursor = 269; # dynamically allocated as of 2020-20-18 #kresd = 270; # switched to "knot-resolver" with dynamic ID rpc = 271; - geoip = 272; + #geoip = 272; # new module uses DynamicUser fcron = 273; sonarr = 274; radarr = 275; @@ -562,7 +562,7 @@ in postsrsd = 220; opendkim = 221; dspam = 222; - gale = 223; + # gale = 223; removed 2021-06-10 matrix-synapse = 224; rspamd = 225; # rmilter = 226; # unused, removed 2019-08-22 diff --git a/nixos/modules/module-list.nix b/nixos/modules/module-list.nix index aa4e2ccc46b..4d1700ed99a 100644 --- a/nixos/modules/module-list.nix +++ b/nixos/modules/module-list.nix @@ -9,6 +9,7 @@ ./config/xdg/menus.nix ./config/xdg/mime.nix ./config/xdg/portal.nix + ./config/xdg/portals/wlr.nix ./config/appstream.nix ./config/console.nix ./config/xdg/sounds.nix @@ -44,6 +45,7 @@ ./hardware/ckb-next.nix ./hardware/cpu/amd-microcode.nix ./hardware/cpu/intel-microcode.nix + ./hardware/corectrl.nix ./hardware/digitalbitbox.nix ./hardware/device-tree.nix ./hardware/i2c.nix @@ -136,9 +138,11 @@ ./programs/file-roller.nix ./programs/firejail.nix ./programs/fish.nix + ./programs/flashrom.nix ./programs/flexoptix-app.nix ./programs/freetds.nix ./programs/fuse.nix + ./programs/gamemode.nix ./programs/geary.nix ./programs/gnome-disks.nix ./programs/gnome-documents.nix @@ -150,6 +154,7 @@ ./programs/iftop.nix ./programs/iotop.nix ./programs/java.nix + ./programs/kdeconnect.nix ./programs/kbdlight.nix ./programs/less.nix ./programs/liboping.nix @@ -196,7 +201,6 @@ ./programs/waybar.nix ./programs/wireshark.nix ./programs/wshowkeys.nix - ./programs/x2goserver.nix ./programs/xfs_quota.nix ./programs/xonsh.nix ./programs/xss-lock.nix @@ -256,6 +260,7 @@ ./services/backup/bacula.nix ./services/backup/borgbackup.nix ./services/backup/borgmatic.nix + ./services/backup/btrbk.nix ./services/backup/duplicati.nix ./services/backup/duplicity.nix ./services/backup/mysql-backup.nix @@ -383,6 +388,7 @@ ./services/hardware/bluetooth.nix ./services/hardware/bolt.nix ./services/hardware/brltty.nix + ./services/hardware/ddccontrol.nix ./services/hardware/fancontrol.nix ./services/hardware/freefall.nix ./services/hardware/fwupd.nix @@ -398,6 +404,7 @@ ./services/hardware/ratbagd.nix ./services/hardware/sane.nix ./services/hardware/sane_extra_backends/brscan4.nix + ./services/hardware/sane_extra_backends/brscan5.nix ./services/hardware/sane_extra_backends/dsseries.nix ./services/hardware/spacenavd.nix ./services/hardware/tcsd.nix @@ -468,6 +475,7 @@ ./services/misc/calibre-server.nix ./services/misc/cfdyndns.nix ./services/misc/clipmenu.nix + ./services/misc/clipcat.nix ./services/misc/cpuminer-cryptonight.nix ./services/misc/cgminer.nix ./services/misc/confd.nix @@ -491,7 +499,7 @@ ./services/misc/freeswitch.nix ./services/misc/fstrim.nix ./services/misc/gammu-smsd.nix - ./services/misc/geoip-updater.nix + ./services/misc/geoipupdate.nix ./services/misc/gitea.nix #./services/misc/gitit.nix ./services/misc/gitlab.nix @@ -547,10 +555,12 @@ ./services/misc/ripple-data-api.nix ./services/misc/serviio.nix ./services/misc/safeeyes.nix + ./services/misc/sdrplay.nix ./services/misc/sickbeard.nix ./services/misc/siproxd.nix ./services/misc/snapper.nix ./services/misc/sonarr.nix + ./services/misc/sourcehut ./services/misc/spice-vdagentd.nix ./services/misc/ssm-agent.nix ./services/misc/sssd.nix @@ -590,6 +600,7 @@ ./services/monitoring/loki.nix ./services/monitoring/longview.nix ./services/monitoring/mackerel-agent.nix + ./services/monitoring/metricbeat.nix ./services/monitoring/monit.nix ./services/monitoring/munin.nix ./services/monitoring/nagios.nix @@ -687,11 +698,11 @@ ./services/networking/flannel.nix ./services/networking/freenet.nix ./services/networking/freeradius.nix - ./services/networking/gale.nix ./services/networking/gateone.nix ./services/networking/gdomap.nix ./services/networking/ghostunnel.nix ./services/networking/git-daemon.nix + ./services/networking/globalprotect-vpn.nix ./services/networking/gnunet.nix ./services/networking/go-neb.nix ./services/networking/go-shadowsocks2.nix @@ -717,6 +728,7 @@ ./services/networking/iwd.nix ./services/networking/jicofo.nix ./services/networking/jitsi-videobridge.nix + ./services/networking/kea.nix ./services/networking/keepalived/default.nix ./services/networking/keybase.nix ./services/networking/kippo.nix @@ -835,8 +847,10 @@ ./services/networking/tox-node.nix ./services/networking/toxvpn.nix ./services/networking/tvheadend.nix + ./services/networking/ucarp.nix ./services/networking/unbound.nix ./services/networking/unifi.nix + ./services/video/unifi-video.nix ./services/networking/v2ray.nix ./services/networking/vsftpd.nix ./services/networking/wakeonlan.nix @@ -849,6 +863,7 @@ ./services/networking/xandikos.nix ./services/networking/xinetd.nix ./services/networking/xl2tpd.nix + ./services/networking/x2goserver.nix ./services/networking/xrdp.nix ./services/networking/yggdrasil.nix ./services/networking/zerobin.nix @@ -864,7 +879,6 @@ ./services/search/hound.nix ./services/search/kibana.nix ./services/search/solr.nix - ./services/security/bitwarden_rs/default.nix ./services/security/certmgr.nix ./services/security/cfssl.nix ./services/security/clamav.nix @@ -873,6 +887,7 @@ ./services/security/fprot.nix ./services/security/haka.nix ./services/security/haveged.nix + ./services/security/hockeypuck.nix ./services/security/hologram-server.nix ./services/security/hologram-agent.nix ./services/security/munge.nix @@ -890,6 +905,7 @@ ./services/security/torsocks.nix ./services/security/usbguard.nix ./services/security/vault.nix + ./services/security/vaultwarden/default.nix ./services/security/yubikey-agent.nix ./services/system/cloud-init.nix ./services/system/dbus.nix @@ -945,6 +961,7 @@ ./services/web-apps/nextcloud.nix ./services/web-apps/nexus.nix ./services/web-apps/plantuml-server.nix + ./services/web-apps/plausible.nix ./services/web-apps/pgpkeyserver-lite.nix ./services/web-apps/matomo.nix ./services/web-apps/moinmoin.nix @@ -956,6 +973,7 @@ ./services/web-apps/trilium.nix ./services/web-apps/selfoss.nix ./services/web-apps/shiori.nix + ./services/web-apps/vikunja.nix ./services/web-apps/virtlyst.nix ./services/web-apps/wiki-js.nix ./services/web-apps/whitebophir.nix @@ -1089,6 +1107,7 @@ ./tasks/network-interfaces-systemd.nix ./tasks/network-interfaces-scripted.nix ./tasks/scsi-link-power-management.nix + ./tasks/snapraid.nix ./tasks/swraid.nix ./tasks/trackpoint.nix ./tasks/powertop.nix @@ -1112,6 +1131,7 @@ ./virtualisation/openvswitch.nix ./virtualisation/parallels-guest.nix ./virtualisation/podman.nix + ./virtualisation/podman-network-socket-ghostunnel.nix ./virtualisation/qemu-guest-agent.nix ./virtualisation/railcar.nix ./virtualisation/spice-usb-redirection.nix diff --git a/nixos/modules/programs/appgate-sdp.nix b/nixos/modules/programs/appgate-sdp.nix index 1dec4ecf9ec..12cb542f4d0 100644 --- a/nixos/modules/programs/appgate-sdp.nix +++ b/nixos/modules/programs/appgate-sdp.nix @@ -5,8 +5,7 @@ with lib; { options = { programs.appgate-sdp = { - enable = mkEnableOption - "AppGate SDP VPN client"; + enable = mkEnableOption "AppGate SDP VPN client"; }; }; @@ -17,7 +16,10 @@ with lib; systemd = { packages = [ pkgs.appgate-sdp ]; # https://github.com/NixOS/nixpkgs/issues/81138 - services.appgatedriver.wantedBy = [ "multi-user.target" ]; + services.appgatedriver.wantedBy = [ "multi-user.target" ]; + services.appgate-dumb-resolver.path = [ pkgs.e2fsprogs ]; + services.appgate-resolver.path = [ pkgs.procps pkgs.e2fsprogs ]; + services.appgatedriver.path = [ pkgs.e2fsprogs ]; }; }; } diff --git a/nixos/modules/programs/flashrom.nix b/nixos/modules/programs/flashrom.nix new file mode 100644 index 00000000000..f026c2e31cd --- /dev/null +++ b/nixos/modules/programs/flashrom.nix @@ -0,0 +1,26 @@ +{ config, lib, pkgs, ... }: + +with lib; + +let + cfg = config.programs.flashrom; +in +{ + options.programs.flashrom = { + enable = mkOption { + type = types.bool; + default = false; + description = '' + Installs flashrom and configures udev rules for programmers + used by flashrom. Grants access to users in the "flashrom" + group. + ''; + }; + }; + + config = mkIf cfg.enable { + services.udev.packages = [ pkgs.flashrom ]; + environment.systemPackages = [ pkgs.flashrom ]; + users.groups.flashrom = { }; + }; +} diff --git a/nixos/modules/programs/gamemode.nix b/nixos/modules/programs/gamemode.nix new file mode 100644 index 00000000000..03949bf98df --- /dev/null +++ b/nixos/modules/programs/gamemode.nix @@ -0,0 +1,96 @@ +{ config, lib, pkgs, ... }: + +with lib; + +let + cfg = config.programs.gamemode; + settingsFormat = pkgs.formats.ini { }; + configFile = settingsFormat.generate "gamemode.ini" cfg.settings; +in +{ + options = { + programs.gamemode = { + enable = mkEnableOption "GameMode to optimise system performance on demand"; + + enableRenice = mkEnableOption "CAP_SYS_NICE on gamemoded to support lowering process niceness" // { + default = true; + }; + + settings = mkOption { + type = settingsFormat.type; + default = {}; + description = '' + System-wide configuration for GameMode (/etc/gamemode.ini). + See gamemoded(8) man page for available settings. + ''; + example = literalExample '' + { + general = { + renice = 10; + }; + + # Warning: GPU optimisations have the potential to damage hardware + gpu = { + apply_gpu_optimisations = "accept-responsibility"; + gpu_device = 0; + amd_performance_level = "high"; + }; + + custom = { + start = "''${pkgs.libnotify}/bin/notify-send 'GameMode started'"; + end = "''${pkgs.libnotify}/bin/notify-send 'GameMode ended'"; + }; + } + ''; + }; + }; + }; + + config = mkIf cfg.enable { + environment = { + systemPackages = [ pkgs.gamemode ]; + etc."gamemode.ini".source = configFile; + }; + + security = { + polkit.enable = true; + wrappers = mkIf cfg.enableRenice { + gamemoded = { + source = "${pkgs.gamemode}/bin/gamemoded"; + capabilities = "cap_sys_nice+ep"; + }; + }; + }; + + systemd = { + packages = [ pkgs.gamemode ]; + user.services.gamemoded = { + # The upstream service already defines this, but doesn't get applied. + # See https://github.com/NixOS/nixpkgs/issues/81138 + wantedBy = [ "default.target" ]; + + # Use pkexec from the security wrappers to allow users to + # run libexec/cpugovctl & libexec/gpuclockctl as root with + # the the actions defined in share/polkit-1/actions. + # + # This uses a link farm to make sure other wrapped executables + # aren't included in PATH. + environment.PATH = mkForce (pkgs.linkFarm "pkexec" [ + { + name = "pkexec"; + path = "${config.security.wrapperDir}/pkexec"; + } + ]); + + serviceConfig.ExecStart = mkIf cfg.enableRenice [ + "" # Tell systemd to clear the existing ExecStart list, to prevent appending to it. + "${config.security.wrapperDir}/gamemoded" + ]; + }; + }; + }; + + meta = { + maintainers = with maintainers; [ kira-bruneau ]; + }; +} diff --git a/nixos/modules/programs/hamster.nix b/nixos/modules/programs/hamster.nix index b2f4a82b260..0bb56ad7ff3 100644 --- a/nixos/modules/programs/hamster.nix +++ b/nixos/modules/programs/hamster.nix @@ -6,7 +6,7 @@ with lib; meta.maintainers = pkgs.hamster.meta.maintainers; options.programs.hamster.enable = - mkEnableOption "Whether to enable hamster time tracking."; + mkEnableOption "hamster, a time tracking program"; config = lib.mkIf config.programs.hamster.enable { environment.systemPackages = [ pkgs.hamster ]; diff --git a/nixos/modules/programs/kdeconnect.nix b/nixos/modules/programs/kdeconnect.nix new file mode 100644 index 00000000000..673449b9f63 --- /dev/null +++ b/nixos/modules/programs/kdeconnect.nix @@ -0,0 +1,35 @@ +{ config, pkgs, lib, ... }: +with lib; +{ + options.programs.kdeconnect = { + enable = mkEnableOption '' + kdeconnect. + + Note that it will open the TCP and UDP port from + 1714 to 1764 as they are needed for it to function properly. + You can use the <option>package</option> to use + <code>gnomeExtensions.gsconnect</code> as an alternative + implementation if you use Gnome. + ''; + package = mkOption { + default = pkgs.kdeconnect; + defaultText = "pkgs.kdeconnect"; + type = types.package; + example = literalExample "pkgs.gnomeExtensions.gsconnect"; + description = '' + The package providing the implementation for kdeconnect. + ''; + }; + }; + config = + let + cfg = config.programs.kdeconnect; + in + mkIf cfg.enable { + environment.systemPackages = [ cfg.package ]; + networking.firewall = rec { + allowedTCPPortRanges = [ { from = 1714; to = 1764; } ]; + allowedUDPPortRanges = allowedTCPPortRanges; + }; + }; +} diff --git a/nixos/modules/programs/phosh.nix b/nixos/modules/programs/phosh.nix index 1f50065f781..cba3f73768e 100644 --- a/nixos/modules/programs/phosh.nix +++ b/nixos/modules/programs/phosh.nix @@ -143,10 +143,14 @@ in { oskItem ]; + systemd.packages = [ pkgs.phosh ]; + programs.feedbackd.enable = true; security.pam.services.phosh = {}; + hardware.opengl.enable = mkDefault true; + services.gnome.core-shell.enable = true; services.gnome.core-os-services.enable = true; services.xserver.displayManager.sessionPackages = [ pkgs.phosh ]; diff --git a/nixos/modules/programs/ssmtp.nix b/nixos/modules/programs/ssmtp.nix index 8039763facc..8b500f0383f 100644 --- a/nixos/modules/programs/ssmtp.nix +++ b/nixos/modules/programs/ssmtp.nix @@ -124,7 +124,8 @@ in example = "/run/keys/ssmtp-authpass"; description = '' Path to a file that contains the password used for SMTP auth. The file - should not contain a trailing newline, if the password does not contain one. + should not contain a trailing newline, if the password does not contain one + (e.g. use <command>echo -n "password" > file</command>). This file should be readable by the users that need to execute ssmtp. ''; }; diff --git a/nixos/modules/programs/sway.nix b/nixos/modules/programs/sway.nix index 3c09d9f00fd..d5819a08e8f 100644 --- a/nixos/modules/programs/sway.nix +++ b/nixos/modules/programs/sway.nix @@ -91,10 +91,9 @@ in { type = with types; listOf package; default = with pkgs; [ swaylock swayidle alacritty dmenu - rxvt-unicode # For backward compatibility (old default terminal) ]; defaultText = literalExample '' - with pkgs; [ swaylock swayidle rxvt-unicode alacritty dmenu ]; + with pkgs; [ swaylock swayidle alacritty dmenu ]; ''; example = literalExample '' with pkgs; [ diff --git a/nixos/modules/programs/udevil.nix b/nixos/modules/programs/udevil.nix index ba5670f9dfe..25975d88ec8 100644 --- a/nixos/modules/programs/udevil.nix +++ b/nixos/modules/programs/udevil.nix @@ -10,5 +10,8 @@ in { config = mkIf cfg.enable { security.wrappers.udevil.source = "${lib.getBin pkgs.udevil}/bin/udevil"; + + systemd.packages = [ pkgs.udevil ]; + systemd.services."devmon@".wantedBy = [ "multi-user.target" ]; }; } diff --git a/nixos/modules/programs/xwayland.nix b/nixos/modules/programs/xwayland.nix index 7e9a424a715..cb3c9c5b156 100644 --- a/nixos/modules/programs/xwayland.nix +++ b/nixos/modules/programs/xwayland.nix @@ -10,14 +10,16 @@ in { options.programs.xwayland = { - enable = mkEnableOption '' - Xwayland X server allows running X programs on a Wayland compositor. - ''; + enable = mkEnableOption "Xwayland (an X server for interfacing X11 apps with the Wayland protocol)"; defaultFontPath = mkOption { type = types.str; default = optionalString config.fonts.fontDir.enable "/run/current-system/sw/share/X11/fonts"; + defaultText = literalExample '' + optionalString config.fonts.fontDir.enable + "/run/current-system/sw/share/X11/fonts"; + ''; description = '' Default font path. Setting this option causes Xwayland to be rebuilt. ''; @@ -25,7 +27,15 @@ in package = mkOption { type = types.path; - description = "The Xwayland package"; + default = pkgs.xwayland.override (oldArgs: { + inherit (cfg) defaultFontPath; + }); + defaultText = literalExample '' + pkgs.xwayland.override (oldArgs: { + inherit (config.programs.xwayland) defaultFontPath; + }); + ''; + description = "The Xwayland package to use."; }; }; @@ -37,9 +47,5 @@ in environment.systemPackages = [ cfg.package ]; - programs.xwayland.package = pkgs.xwayland.override (oldArgs: { - inherit (cfg) defaultFontPath; - }); - }; } diff --git a/nixos/modules/programs/zsh/zsh.nix b/nixos/modules/programs/zsh/zsh.nix index 049a315c762..6c824a692b7 100644 --- a/nixos/modules/programs/zsh/zsh.nix +++ b/nixos/modules/programs/zsh/zsh.nix @@ -53,7 +53,7 @@ in }; shellAliases = mkOption { - default = {}; + default = { }; description = '' Set of aliases for zsh shell, which overrides <option>environment.shellAliases</option>. See <option>environment.shellAliases</option> for an option format description. @@ -91,7 +91,7 @@ in # before setting your PS1 and etc. Otherwise this will likely to interact with # your ~/.zshrc configuration in unexpected ways as the default prompt sets # a lot of different prompt variables. - autoload -U promptinit && promptinit && prompt walters && setopt prompt_sp + autoload -U promptinit && promptinit && prompt suse && setopt prompt_sp ''; description = '' Shell script code used to initialise the zsh prompt. @@ -118,7 +118,9 @@ in setOptions = mkOption { type = types.listOf types.str; default = [ - "HIST_IGNORE_DUPS" "SHARE_HISTORY" "HIST_FCNTL_LOCK" + "HIST_IGNORE_DUPS" + "SHARE_HISTORY" + "HIST_FCNTL_LOCK" ]; example = [ "EXTENDED_HISTORY" "RM_STAR_WAIT" ]; description = '' @@ -278,15 +280,29 @@ in environment.etc.zinputrc.source = ./zinputrc; - environment.systemPackages = [ pkgs.zsh ] - ++ optional cfg.enableCompletion pkgs.nix-zsh-completions; + environment.systemPackages = + let + completions = + if lib.versionAtLeast (lib.getVersion config.nix.package) "2.4pre" + then + pkgs.nix-zsh-completions.overrideAttrs + (_: { + postInstall = '' + rm $out/share/zsh/site-functions/_nix + ''; + }) + else pkgs.nix-zsh-completions; + in + [ pkgs.zsh ] + ++ optional cfg.enableCompletion completions; environment.pathsToLink = optional cfg.enableCompletion "/share/zsh"; #users.defaultUserShell = mkDefault "/run/current-system/sw/bin/zsh"; environment.shells = - [ "/run/current-system/sw/bin/zsh" + [ + "/run/current-system/sw/bin/zsh" "${pkgs.zsh}/bin/zsh" ]; diff --git a/nixos/modules/security/acme.nix b/nixos/modules/security/acme.nix index eb3599b924d..22bf34198a3 100644 --- a/nixos/modules/security/acme.nix +++ b/nixos/modules/security/acme.nix @@ -46,6 +46,7 @@ let serviceConfig = commonServiceConfig // { StateDirectory = "acme/.minica"; BindPaths = "/var/lib/acme/.minica:/tmp/ca"; + UMask = 0077; }; # Working directory will be /tmp @@ -54,8 +55,6 @@ let --ca-key ca/key.pem \ --ca-cert ca/cert.pem \ --domains selfsigned.local - - chmod 600 ca/* ''; }; @@ -152,7 +151,7 @@ let ); renewOpts = escapeShellArgs ( commonOpts - ++ [ "renew" "--reuse-key" ] + ++ [ "renew" ] ++ optionals data.ocspMustStaple [ "--must-staple" ] ++ data.extraLegoRenewFlags ); @@ -196,6 +195,7 @@ let serviceConfig = commonServiceConfig // { Group = data.group; + UMask = 0027; StateDirectory = "acme/${cert}"; @@ -220,10 +220,12 @@ let cat cert.pem chain.pem > fullchain.pem cat key.pem fullchain.pem > full.pem - chmod 640 * - # Group might change between runs, re-apply it chown 'acme:${data.group}' * + + # Default permissions make the files unreadable by group + anon + # Need to be readable by group + chmod 640 * ''; }; @@ -340,8 +342,6 @@ let fi mv domainhash.txt certificates/ - chmod 640 certificates/* - chmod -R u=rwX,g=,o= accounts/* # Group might change between runs, re-apply it chown 'acme:${data.group}' certificates/* @@ -357,6 +357,10 @@ let ln -sf fullchain.pem out/cert.pem cat out/key.pem out/fullchain.pem > out/full.pem fi + + # By default group will have no access to the cert files. + # This chmod will fix that. + chmod 640 out/* ''; }; }; diff --git a/nixos/modules/security/acme.xml b/nixos/modules/security/acme.xml index a78ff05f2ea..8249da948c6 100644 --- a/nixos/modules/security/acme.xml +++ b/nixos/modules/security/acme.xml @@ -194,7 +194,7 @@ services.httpd = { <para> This is useful if you want to generate a wildcard certificate, since ACME servers will only hand out wildcard certs over DNS validation. - There a number of supported DNS providers and servers you can utilise, + There are a number of supported DNS providers and servers you can utilise, see the <link xlink:href="https://go-acme.github.io/lego/dns/">lego docs</link> for provider/server specific configuration values. For the sake of these docs, we will provide a fully self-hosted example using bind. diff --git a/nixos/modules/security/pam.nix b/nixos/modules/security/pam.nix index b5bd22f6ba7..5699025601f 100644 --- a/nixos/modules/security/pam.nix +++ b/nixos/modules/security/pam.nix @@ -397,8 +397,6 @@ let "auth required pam_faillock.so"} ${optionalString (config.security.pam.enableSSHAgentAuth && cfg.sshAgentAuth) "auth sufficient ${pkgs.pam_ssh_agent_auth}/libexec/pam_ssh_agent_auth.so file=${lib.concatStringsSep ":" config.services.openssh.authorizedKeysFiles}"} - ${optionalString cfg.fprintAuth - "auth sufficient ${pkgs.fprintd}/lib/security/pam_fprintd.so"} ${let p11 = config.security.pam.p11; in optionalString cfg.p11Auth "auth ${p11.control} ${pkgs.pam_p11}/lib/security/pam_p11.so ${pkgs.opensc}/lib/opensc-pkcs11.so"} ${let u2f = config.security.pam.u2f; in optionalString cfg.u2fAuth @@ -409,6 +407,8 @@ let "auth requisite ${pkgs.oathToolkit}/lib/security/pam_oath.so window=${toString oath.window} usersfile=${toString oath.usersFile} digits=${toString oath.digits}"} ${let yubi = config.security.pam.yubico; in optionalString cfg.yubicoAuth "auth ${yubi.control} ${pkgs.yubico-pam}/lib/security/pam_yubico.so mode=${toString yubi.mode} ${optionalString (yubi.mode == "client") "id=${toString yubi.id}"} ${optionalString yubi.debug "debug"}"} + ${optionalString cfg.fprintAuth + "auth sufficient ${pkgs.fprintd}/lib/security/pam_fprintd.so"} '' + # Modules in this block require having the password set in PAM_AUTHTOK. # pam_unix is marked as 'sufficient' on NixOS which means nothing will run @@ -965,7 +965,7 @@ in mr ${pkgs.apparmor-pam}/lib/security/pam_apparmor.so, '' + optionalString (isEnabled (cfg: cfg.enableKwallet)) '' - mr ${pkgs.plasma5.kwallet-pam}/lib/security/pam_kwallet5.so, + mr ${pkgs.plasma5Packages.kwallet-pam}/lib/security/pam_kwallet5.so, '' + optionalString config.virtualisation.lxc.lxcfs.enable '' mr ${pkgs.lxc}/lib/security/pam_cgfs.so diff --git a/nixos/modules/security/pam_mount.nix b/nixos/modules/security/pam_mount.nix index 9a0143c155c..e25ace38f57 100644 --- a/nixos/modules/security/pam_mount.nix +++ b/nixos/modules/security/pam_mount.nix @@ -29,6 +29,28 @@ in xlink:href="http://pam-mount.sourceforge.net/pam_mount.conf.5.html" />. ''; }; + + additionalSearchPaths = mkOption { + type = types.listOf types.package; + default = []; + example = literalExample "[ pkgs.bindfs ]"; + description = '' + Additional programs to include in the search path of pam_mount. + Useful for example if you want to use some FUSE filesystems like bindfs. + ''; + }; + + fuseMountOptions = mkOption { + type = types.listOf types.str; + default = []; + example = literalExample '' + [ "nodev" "nosuid" "force-user=%(USER)" "gid=%(USERGID)" "perms=0700" "chmod-deny" "chown-deny" "chgrp-deny" ] + ''; + description = '' + Global mount options that apply to every FUSE volume. + You can define volume-specific options in the volume definitions. + ''; + }; }; }; @@ -60,11 +82,12 @@ in <!-- if activated, requires ofl from hxtools to be present --> <logout wait="0" hup="no" term="no" kill="no" /> <!-- set PATH variable for pam_mount module --> - <path>${pkgs.util-linux}/bin</path> + <path>${makeBinPath ([ pkgs.util-linux ] ++ cfg.additionalSearchPaths)}</path> <!-- create mount point if not present --> <mkmountpoint enable="1" remove="true" /> <!-- specify the binaries to be called --> + <fusemount>${pkgs.fuse}/bin/mount.fuse %(VOLUME) %(MNTPT) -o ${concatStringsSep "," (cfg.fuseMountOptions ++ [ "%(OPTIONS)" ])}</fusemount> <cryptmount>${pkgs.pam_mount}/bin/mount.crypt %(VOLUME) %(MNTPT)</cryptmount> <cryptumount>${pkgs.pam_mount}/bin/umount.crypt %(MNTPT)</cryptumount> <pmvarrun>${pkgs.pam_mount}/bin/pmvarrun -u %(USER) -o %(OPERATION)</pmvarrun> diff --git a/nixos/modules/security/systemd-confinement.nix b/nixos/modules/security/systemd-confinement.nix index afb81a2b56b..0a09a755e93 100644 --- a/nixos/modules/security/systemd-confinement.nix +++ b/nixos/modules/security/systemd-confinement.nix @@ -105,7 +105,7 @@ in { wantsAPIVFS = lib.mkDefault (config.confinement.mode == "full-apivfs"); in lib.mkIf config.confinement.enable { serviceConfig = { - RootDirectory = pkgs.runCommand rootName {} "mkdir \"$out\""; + RootDirectory = "/var/empty"; TemporaryFileSystem = "/"; PrivateMounts = lib.mkDefault true; diff --git a/nixos/modules/services/amqp/rabbitmq.nix b/nixos/modules/services/amqp/rabbitmq.nix index 646708e01c4..fc8a1bc3c23 100644 --- a/nixos/modules/services/amqp/rabbitmq.nix +++ b/nixos/modules/services/amqp/rabbitmq.nix @@ -57,7 +57,7 @@ in { description = '' Port on which RabbitMQ will listen for AMQP connections. ''; - type = types.int; + type = types.port; }; dataDir = mkOption { diff --git a/nixos/modules/services/audio/alsa.nix b/nixos/modules/services/audio/alsa.nix index aff3fe2ba42..0d743ed31da 100644 --- a/nixos/modules/services/audio/alsa.nix +++ b/nixos/modules/services/audio/alsa.nix @@ -5,7 +5,7 @@ with lib; let - inherit (pkgs) alsaUtils; + inherit (pkgs) alsa-utils; pulseaudioEnabled = config.hardware.pulseaudio.enable; @@ -88,13 +88,13 @@ in config = mkIf config.sound.enable { - environment.systemPackages = [ alsaUtils ]; + environment.systemPackages = [ alsa-utils ]; environment.etc = mkIf (!pulseaudioEnabled && config.sound.extraConfig != "") { "asound.conf".text = config.sound.extraConfig; }; # ALSA provides a udev rule for restoring volume settings. - services.udev.packages = [ alsaUtils ]; + services.udev.packages = [ alsa-utils ]; boot.kernelModules = optional config.sound.enableOSSEmulation "snd_pcm_oss"; @@ -107,7 +107,7 @@ in Type = "oneshot"; RemainAfterExit = true; ExecStart = "${pkgs.coreutils}/bin/mkdir -p /var/lib/alsa"; - ExecStop = "${alsaUtils}/sbin/alsactl store --ignore"; + ExecStop = "${alsa-utils}/sbin/alsactl store --ignore"; }; }; @@ -115,16 +115,16 @@ in enable = true; bindings = [ # "Mute" media key - { keys = [ 113 ]; events = [ "key" ]; command = "${alsaUtils}/bin/amixer -q set Master toggle"; } + { keys = [ 113 ]; events = [ "key" ]; command = "${alsa-utils}/bin/amixer -q set Master toggle"; } # "Lower Volume" media key - { keys = [ 114 ]; events = [ "key" "rep" ]; command = "${alsaUtils}/bin/amixer -q set Master ${config.sound.mediaKeys.volumeStep}- unmute"; } + { keys = [ 114 ]; events = [ "key" "rep" ]; command = "${alsa-utils}/bin/amixer -q set Master ${config.sound.mediaKeys.volumeStep}- unmute"; } # "Raise Volume" media key - { keys = [ 115 ]; events = [ "key" "rep" ]; command = "${alsaUtils}/bin/amixer -q set Master ${config.sound.mediaKeys.volumeStep}+ unmute"; } + { keys = [ 115 ]; events = [ "key" "rep" ]; command = "${alsa-utils}/bin/amixer -q set Master ${config.sound.mediaKeys.volumeStep}+ unmute"; } # "Mic Mute" media key - { keys = [ 190 ]; events = [ "key" ]; command = "${alsaUtils}/bin/amixer -q set Capture toggle"; } + { keys = [ 190 ]; events = [ "key" ]; command = "${alsa-utils}/bin/amixer -q set Capture toggle"; } ]; }; diff --git a/nixos/modules/services/audio/jack.nix b/nixos/modules/services/audio/jack.nix index f341b432f75..d0a95b87ee1 100644 --- a/nixos/modules/services/audio/jack.nix +++ b/nixos/modules/services/audio/jack.nix @@ -8,7 +8,7 @@ let pcmPlugin = cfg.jackd.enable && cfg.alsa.enable; loopback = cfg.jackd.enable && cfg.loopback.enable; - enable32BitAlsaPlugins = cfg.alsa.support32Bit && pkgs.stdenv.isx86_64 && pkgs.pkgsi686Linux.alsaLib != null; + enable32BitAlsaPlugins = cfg.alsa.support32Bit && pkgs.stdenv.isx86_64 && pkgs.pkgsi686Linux.alsa-lib != null; umaskNeeded = versionOlder cfg.jackd.package.version "1.9.12"; bridgeNeeded = versionAtLeast cfg.jackd.package.version "1.9.12"; @@ -129,9 +129,9 @@ in { (mkIf pcmPlugin { sound.extraConfig = '' pcm_type.jack { - libs.native = ${pkgs.alsaPlugins}/lib/alsa-lib/libasound_module_pcm_jack.so ; + libs.native = ${pkgs.alsa-plugins}/lib/alsa-lib/libasound_module_pcm_jack.so ; ${lib.optionalString enable32BitAlsaPlugins - "libs.32Bit = ${pkgs.pkgsi686Linux.alsaPlugins}/lib/alsa-lib/libasound_module_pcm_jack.so ;"} + "libs.32Bit = ${pkgs.pkgsi686Linux.alsa-plugins}/lib/alsa-lib/libasound_module_pcm_jack.so ;"} } pcm.!default { @func getenv @@ -234,7 +234,7 @@ in { environment = { systemPackages = [ cfg.jackd.package ]; - etc."alsa/conf.d/50-jack.conf".source = "${pkgs.alsaPlugins}/etc/alsa/conf.d/50-jack.conf"; + etc."alsa/conf.d/50-jack.conf".source = "${pkgs.alsa-plugins}/etc/alsa/conf.d/50-jack.conf"; variables.JACK_PROMISCUOUS_SERVER = "jackaudio"; }; diff --git a/nixos/modules/services/audio/roon-bridge.nix b/nixos/modules/services/audio/roon-bridge.nix new file mode 100644 index 00000000000..85273a2039c --- /dev/null +++ b/nixos/modules/services/audio/roon-bridge.nix @@ -0,0 +1,74 @@ +{ config, lib, pkgs, ... }: + +with lib; + +let + name = "roon-bridge"; + cfg = config.services.roon-bridge; +in { + options = { + services.roon-bridge = { + enable = mkEnableOption "Roon Bridge"; + openFirewall = mkOption { + type = types.bool; + default = false; + description = '' + Open ports in the firewall for the bridge. + + UDP: 9003 + TCP: 9100 - 9200 + ''; + }; + user = mkOption { + type = types.str; + default = "roon-bridge"; + description = '' + User to run the Roon bridge as. + ''; + }; + group = mkOption { + type = types.str; + default = "roon-bridge"; + description = '' + Group to run the Roon Bridge as. + ''; + }; + }; + }; + + config = mkIf cfg.enable { + systemd.services.roon-bridge = { + after = [ "network.target" ]; + description = "Roon Bridge"; + wantedBy = [ "multi-user.target" ]; + + environment.ROON_DATAROOT = "/var/lib/${name}"; + + serviceConfig = { + ExecStart = "${pkgs.roon-bridge}/start.sh"; + LimitNOFILE = 8192; + User = cfg.user; + Group = cfg.group; + StateDirectory = name; + }; + }; + + networking.firewall = mkIf cfg.openFirewall { + allowedTCPPortRanges = [ + { from = 9100; to = 9200; } + ]; + allowedUDPPorts = [ 9003 ]; + }; + + + users.groups.${cfg.group} = {}; + users.users.${cfg.user} = + if cfg.user == "roon-bridge" then { + isSystemUser = true; + description = "Roon Bridge user"; + group = cfg.group; + extraGroups = [ "audio" ]; + } + else {}; + }; +} diff --git a/nixos/modules/services/audio/slimserver.nix b/nixos/modules/services/audio/slimserver.nix index 8f94a2b4940..21632919699 100644 --- a/nixos/modules/services/audio/slimserver.nix +++ b/nixos/modules/services/audio/slimserver.nix @@ -63,6 +63,7 @@ in { description = "Slimserver daemon user"; home = cfg.dataDir; group = "slimserver"; + isSystemUser = true; }; groups.slimserver = {}; }; diff --git a/nixos/modules/services/backup/btrbk.nix b/nixos/modules/services/backup/btrbk.nix new file mode 100644 index 00000000000..a8ff71f609a --- /dev/null +++ b/nixos/modules/services/backup/btrbk.nix @@ -0,0 +1,220 @@ +{ config, pkgs, lib, ... }: +let + cfg = config.services.btrbk; + sshEnabled = cfg.sshAccess != [ ]; + serviceEnabled = cfg.instances != { }; + attr2Lines = attr: + let + pairs = lib.attrsets.mapAttrsToList (name: value: { inherit name value; }) attr; + isSubsection = value: + if builtins.isAttrs value then true + else if builtins.isString value then false + else throw "invalid type in btrbk config ${builtins.typeOf value}"; + sortedPairs = lib.lists.partition (x: isSubsection x.value) pairs; + in + lib.flatten ( + # non subsections go first + ( + map (pair: [ "${pair.name} ${pair.value}" ]) sortedPairs.wrong + ) + ++ # subsections go last + ( + map + ( + pair: + lib.mapAttrsToList + ( + childname: value: + [ "${pair.name} ${childname}" ] ++ (map (x: " " + x) (attr2Lines value)) + ) + pair.value + ) + sortedPairs.right + ) + ) + ; + addDefaults = settings: { backend = "btrfs-progs-sudo"; } // settings; + mkConfigFile = settings: lib.concatStringsSep "\n" (attr2Lines (addDefaults settings)); + mkTestedConfigFile = name: settings: + let + configFile = pkgs.writeText "btrbk-${name}.conf" (mkConfigFile settings); + in + pkgs.runCommand "btrbk-${name}-tested.conf" { } '' + mkdir foo + cp ${configFile} $out + if (set +o pipefail; ${pkgs.btrbk}/bin/btrbk -c $out ls foo 2>&1 | grep $out); + then + echo btrbk configuration is invalid + cat $out + exit 1 + fi; + ''; +in +{ + options = { + services.btrbk = { + extraPackages = lib.mkOption { + description = "Extra packages for btrbk, like compression utilities for <literal>stream_compress</literal>"; + type = lib.types.listOf lib.types.package; + default = [ ]; + example = lib.literalExample "[ pkgs.xz ]"; + }; + niceness = lib.mkOption { + description = "Niceness for local instances of btrbk. Also applies to remote ones connecting via ssh when positive."; + type = lib.types.ints.between (-20) 19; + default = 10; + }; + ioSchedulingClass = lib.mkOption { + description = "IO scheduling class for btrbk (see ionice(1) for a quick description). Applies to local instances, and remote ones connecting by ssh if set to idle."; + type = lib.types.enum [ "idle" "best-effort" "realtime" ]; + default = "best-effort"; + }; + instances = lib.mkOption { + description = "Set of btrbk instances. The instance named <literal>btrbk</literal> is the default one."; + type = with lib.types; + attrsOf ( + submodule { + options = { + onCalendar = lib.mkOption { + type = lib.types.str; + default = "daily"; + description = "How often this btrbk instance is started. See systemd.time(7) for more information about the format."; + }; + settings = lib.mkOption { + type = let t = lib.types.attrsOf (lib.types.either lib.types.str (t // { description = "instances of this type recursively"; })); in t; + default = { }; + example = { + snapshot_preserve_min = "2d"; + snapshot_preserve = "14d"; + volume = { + "/mnt/btr_pool" = { + target = "/mnt/btr_backup/mylaptop"; + subvolume = { + "rootfs" = { }; + "home" = { snapshot_create = "always"; }; + }; + }; + }; + }; + description = "configuration options for btrbk. Nested attrsets translate to subsections."; + }; + }; + } + ); + default = { }; + }; + sshAccess = lib.mkOption { + description = "SSH keys that should be able to make or push snapshots on this system remotely with btrbk"; + type = with lib.types; listOf ( + submodule { + options = { + key = lib.mkOption { + type = str; + description = "SSH public key allowed to login as user <literal>btrbk</literal> to run remote backups."; + }; + roles = lib.mkOption { + type = listOf (enum [ "info" "source" "target" "delete" "snapshot" "send" "receive" ]); + example = [ "source" "info" "send" ]; + description = "What actions can be performed with this SSH key. See ssh_filter_btrbk(1) for details"; + }; + }; + } + ); + default = [ ]; + }; + }; + + }; + config = lib.mkIf (sshEnabled || serviceEnabled) { + environment.systemPackages = [ pkgs.btrbk ] ++ cfg.extraPackages; + security.sudo.extraRules = [ + { + users = [ "btrbk" ]; + commands = [ + { command = "${pkgs.btrfs-progs}/bin/btrfs"; options = [ "NOPASSWD" ]; } + { command = "${pkgs.coreutils}/bin/mkdir"; options = [ "NOPASSWD" ]; } + { command = "${pkgs.coreutils}/bin/readlink"; options = [ "NOPASSWD" ]; } + # for ssh, they are not the same than the one hard coded in ${pkgs.btrbk} + { command = "/run/current-system/bin/btrfs"; options = [ "NOPASSWD" ]; } + { command = "/run/current-system/sw/bin/mkdir"; options = [ "NOPASSWD" ]; } + { command = "/run/current-system/sw/bin/readlink"; options = [ "NOPASSWD" ]; } + ]; + } + ]; + users.users.btrbk = { + isSystemUser = true; + # ssh needs a home directory + home = "/var/lib/btrbk"; + createHome = true; + shell = "${pkgs.bash}/bin/bash"; + group = "btrbk"; + openssh.authorizedKeys.keys = map + ( + v: + let + options = lib.concatMapStringsSep " " (x: "--" + x) v.roles; + ioniceClass = { + "idle" = 3; + "best-effort" = 2; + "realtime" = 1; + }.${cfg.ioSchedulingClass}; + in + ''command="${pkgs.util-linux}/bin/ionice -t -c ${toString ioniceClass} ${lib.optionalString (cfg.niceness >= 1) "${pkgs.coreutils}/bin/nice -n ${toString cfg.niceness}"} ${pkgs.btrbk}/share/btrbk/scripts/ssh_filter_btrbk.sh --sudo ${options}" ${v.key}'' + ) + cfg.sshAccess; + }; + users.groups.btrbk = { }; + systemd.tmpfiles.rules = [ + "d /var/lib/btrbk 0750 btrbk btrbk" + "d /var/lib/btrbk/.ssh 0700 btrbk btrbk" + "f /var/lib/btrbk/.ssh/config 0700 btrbk btrbk - StrictHostKeyChecking=accept-new" + ]; + environment.etc = lib.mapAttrs' + ( + name: instance: { + name = "btrbk/${name}.conf"; + value.source = mkTestedConfigFile name instance.settings; + } + ) + cfg.instances; + systemd.services = lib.mapAttrs' + ( + name: _: { + name = "btrbk-${name}"; + value = { + description = "Takes BTRFS snapshots and maintains retention policies."; + unitConfig.Documentation = "man:btrbk(1)"; + path = [ "/run/wrappers" ] ++ cfg.extraPackages; + serviceConfig = { + User = "btrbk"; + Group = "btrbk"; + Type = "oneshot"; + ExecStart = "${pkgs.btrbk}/bin/btrbk -c /etc/btrbk/${name}.conf run"; + Nice = cfg.niceness; + IOSchedulingClass = cfg.ioSchedulingClass; + StateDirectory = "btrbk"; + }; + }; + } + ) + cfg.instances; + + systemd.timers = lib.mapAttrs' + ( + name: instance: { + name = "btrbk-${name}"; + value = { + description = "Timer to take BTRFS snapshots and maintain retention policies."; + wantedBy = [ "timers.target" ]; + timerConfig = { + OnCalendar = instance.onCalendar; + AccuracySec = "10min"; + Persistent = true; + }; + }; + } + ) + cfg.instances; + }; + +} diff --git a/nixos/modules/services/backup/duplicati.nix b/nixos/modules/services/backup/duplicati.nix index 0ff720c5897..cf5aebdecd2 100644 --- a/nixos/modules/services/backup/duplicati.nix +++ b/nixos/modules/services/backup/duplicati.nix @@ -54,11 +54,13 @@ in }; }; - users.users.duplicati = lib.optionalAttrs (cfg.user == "duplicati") { - uid = config.ids.uids.duplicati; - home = "/var/lib/duplicati"; - createHome = true; - group = "duplicati"; + users.users = lib.optionalAttrs (cfg.user == "duplicati") { + duplicati = { + uid = config.ids.uids.duplicati; + home = "/var/lib/duplicati"; + createHome = true; + group = "duplicati"; + }; }; users.groups.duplicati.gid = config.ids.gids.duplicati; diff --git a/nixos/modules/services/backup/duplicity.nix b/nixos/modules/services/backup/duplicity.nix index 1f6883ed02b..6949fa8b995 100644 --- a/nixos/modules/services/backup/duplicity.nix +++ b/nixos/modules/services/backup/duplicity.nix @@ -157,7 +157,7 @@ in ${dup} cleanup ${target} --force ${extra} ${lib.optionalString (cfg.cleanup.maxAge != null) "${dup} remove-older-than ${lib.escapeShellArg cfg.cleanup.maxAge} ${target} --force ${extra}"} ${lib.optionalString (cfg.cleanup.maxFull != null) "${dup} remove-all-but-n-full ${toString cfg.cleanup.maxFull} ${target} --force ${extra}"} - ${lib.optionalString (cfg.cleanup.maxIncr != null) "${dup} remove-all-incr-but-n-full ${toString cfg.cleanup.maxIncr} ${target} --force ${extra}"} + ${lib.optionalString (cfg.cleanup.maxIncr != null) "${dup} remove-all-inc-of-but-n-full ${toString cfg.cleanup.maxIncr} ${target} --force ${extra}"} exec ${dup} ${if cfg.fullIfOlderThan == "always" then "full" else "incr"} ${lib.escapeShellArgs ( [ cfg.root cfg.targetUrl ] ++ concatMap (p: [ "--include" p ]) cfg.include diff --git a/nixos/modules/services/backup/mysql-backup.nix b/nixos/modules/services/backup/mysql-backup.nix index 506ded5e9e8..9fca2100273 100644 --- a/nixos/modules/services/backup/mysql-backup.nix +++ b/nixos/modules/services/backup/mysql-backup.nix @@ -4,7 +4,7 @@ with lib; let - inherit (pkgs) mysql gzip; + inherit (pkgs) mariadb gzip; cfg = config.services.mysqlBackup; defaultUser = "mysqlbackup"; @@ -20,7 +20,7 @@ let ''; backupDatabaseScript = db: '' dest="${cfg.location}/${db}.gz" - if ${mysql}/bin/mysqldump ${if cfg.singleTransaction then "--single-transaction" else ""} ${db} | ${gzip}/bin/gzip -c > $dest.tmp; then + if ${mariadb}/bin/mysqldump ${if cfg.singleTransaction then "--single-transaction" else ""} ${db} | ${gzip}/bin/gzip -c > $dest.tmp; then mv $dest.tmp $dest echo "Backed up to $dest" else diff --git a/nixos/modules/services/backup/postgresql-backup.nix b/nixos/modules/services/backup/postgresql-backup.nix index 9da2d522a68..f658eb756f7 100644 --- a/nixos/modules/services/backup/postgresql-backup.nix +++ b/nixos/modules/services/backup/postgresql-backup.nix @@ -14,15 +14,21 @@ let requires = [ "postgresql.service" ]; + path = [ pkgs.coreutils pkgs.gzip config.services.postgresql.package ]; + script = '' + set -e -o pipefail + umask 0077 # ensure backup is only readable by postgres user if [ -e ${cfg.location}/${db}.sql.gz ]; then - ${pkgs.coreutils}/bin/mv ${cfg.location}/${db}.sql.gz ${cfg.location}/${db}.prev.sql.gz + mv ${cfg.location}/${db}.sql.gz ${cfg.location}/${db}.prev.sql.gz fi ${dumpCmd} | \ - ${pkgs.gzip}/bin/gzip -c > ${cfg.location}/${db}.sql.gz + gzip -c > ${cfg.location}/${db}.in-progress.sql.gz + + mv ${cfg.location}/${db}.in-progress.sql.gz ${cfg.location}/${db}.sql.gz ''; serviceConfig = { @@ -113,12 +119,12 @@ in { }) (mkIf (cfg.enable && cfg.backupAll) { systemd.services.postgresqlBackup = - postgresqlBackupService "all" "${config.services.postgresql.package}/bin/pg_dumpall"; + postgresqlBackupService "all" "pg_dumpall"; }) (mkIf (cfg.enable && !cfg.backupAll) { systemd.services = listToAttrs (map (db: let - cmd = "${config.services.postgresql.package}/bin/pg_dump ${cfg.pgdumpOptions} ${db}"; + cmd = "pg_dump ${cfg.pgdumpOptions} ${db}"; in { name = "postgresqlBackup-${db}"; value = postgresqlBackupService db cmd; diff --git a/nixos/modules/services/backup/sanoid.nix b/nixos/modules/services/backup/sanoid.nix index 0472fb4ba1e..abc4def1c61 100644 --- a/nixos/modules/services/backup/sanoid.nix +++ b/nixos/modules/services/backup/sanoid.nix @@ -10,74 +10,51 @@ let description = "dataset/template options"; }; - # Default values from https://github.com/jimsalterjrs/sanoid/blob/master/sanoid.defaults.conf - commonOptions = { hourly = mkOption { description = "Number of hourly snapshots."; - type = types.ints.unsigned; - default = 48; + type = with types; nullOr ints.unsigned; + default = null; }; daily = mkOption { description = "Number of daily snapshots."; - type = types.ints.unsigned; - default = 90; + type = with types; nullOr ints.unsigned; + default = null; }; monthly = mkOption { description = "Number of monthly snapshots."; - type = types.ints.unsigned; - default = 6; + type = with types; nullOr ints.unsigned; + default = null; }; yearly = mkOption { description = "Number of yearly snapshots."; - type = types.ints.unsigned; - default = 0; + type = with types; nullOr ints.unsigned; + default = null; }; autoprune = mkOption { description = "Whether to automatically prune old snapshots."; - type = types.bool; - default = true; + type = with types; nullOr bool; + default = null; }; autosnap = mkOption { description = "Whether to automatically take snapshots."; - type = types.bool; - default = true; - }; - - settings = mkOption { - description = '' - Free-form settings for this template/dataset. See - <link xlink:href="https://github.com/jimsalterjrs/sanoid/blob/master/sanoid.defaults.conf"/> - for allowed values. - ''; - type = datasetSettingsType; - }; - }; - - commonConfig = config: { - settings = { - hourly = mkDefault config.hourly; - daily = mkDefault config.daily; - monthly = mkDefault config.monthly; - yearly = mkDefault config.yearly; - autoprune = mkDefault config.autoprune; - autosnap = mkDefault config.autosnap; + type = with types; nullOr bool; + default = null; }; }; - datasetOptions = { - useTemplate = mkOption { + datasetOptions = rec { + use_template = mkOption { description = "Names of the templates to use for this dataset."; - type = (types.listOf (types.enum (attrNames cfg.templates))) // { - description = "list of template names"; - }; + type = types.listOf (types.enum (attrNames cfg.templates)); default = []; }; + useTemplate = use_template; recursive = mkOption { description = "Whether to recursively snapshot dataset children."; @@ -85,19 +62,12 @@ let default = false; }; - processChildrenOnly = mkOption { + process_children_only = mkOption { description = "Whether to only snapshot child datasets if recursing."; type = types.bool; default = false; }; - }; - - datasetConfig = config: { - settings = { - use_template = mkDefault config.useTemplate; - recursive = mkDefault config.recursive; - process_children_only = mkDefault config.processChildrenOnly; - }; + processChildrenOnly = process_children_only; }; # Extract pool names from configured datasets @@ -109,11 +79,11 @@ let else generators.mkValueStringDefault {} v; mkKeyValue = k: v: if v == null then "" + else if k == "processChildrenOnly" then "" + else if k == "useTemplate" then "" else generators.mkKeyValueDefault { inherit mkValueString; } "=" k v; in generators.toINI { inherit mkKeyValue; } cfg.settings; - configDir = pkgs.writeTextDir "sanoid.conf" configFile; - in { # Interface @@ -135,19 +105,21 @@ in { }; datasets = mkOption { - type = types.attrsOf (types.submodule ({ config, ... }: { + type = types.attrsOf (types.submodule ({config, options, ...}: { + freeformType = datasetSettingsType; options = commonOptions // datasetOptions; - config = mkMerge [ (commonConfig config) (datasetConfig config) ]; + config.use_template = mkAliasDefinitions (mkDefault options.useTemplate or {}); + config.process_children_only = mkAliasDefinitions (mkDefault options.processChildrenOnly or {}); })); default = {}; description = "Datasets to snapshot."; }; templates = mkOption { - type = types.attrsOf (types.submodule ({ config, ... }: { + type = types.attrsOf (types.submodule { + freeformType = datasetSettingsType; options = commonOptions; - config = commonConfig config; - })); + }); default = {}; description = "Templates for datasets."; }; @@ -177,8 +149,8 @@ in { config = mkIf cfg.enable { services.sanoid.settings = mkMerge [ - (mapAttrs' (d: v: nameValuePair ("template_" + d) v.settings) cfg.templates) - (mapAttrs (d: v: v.settings) cfg.datasets) + (mapAttrs' (d: v: nameValuePair ("template_" + d) v) cfg.templates) + (mapAttrs (d: v: v) cfg.datasets) ]; systemd.services.sanoid = { @@ -191,7 +163,7 @@ in { ExecStart = lib.escapeShellArgs ([ "${pkgs.sanoid}/bin/sanoid" "--cron" - "--configdir" configDir + "--configdir" (pkgs.writeTextDir "sanoid.conf" configFile) ] ++ cfg.extraArgs); ExecStopPost = map (pool: lib.escapeShellArgs [ "+/run/booted-system/sw/bin/zfs" "unallow" "sanoid" pool diff --git a/nixos/modules/services/backup/syncoid.nix b/nixos/modules/services/backup/syncoid.nix index b764db1f14e..888ef20f642 100644 --- a/nixos/modules/services/backup/syncoid.nix +++ b/nixos/modules/services/backup/syncoid.nix @@ -5,14 +5,15 @@ with lib; let cfg = config.services.syncoid; - # Extract pool names of local datasets (ones that don't contain "@") that - # have the specified type (either "source" or "target") - getPools = type: unique (map (d: head (builtins.match "([^/]+).*" d)) ( - # Filter local datasets - filter (d: !hasInfix "@" d) - # Get datasets of the specified type - (catAttrs type (attrValues cfg.commands)) - )); + # Extract the pool name of a local dataset (any dataset not containing "@") + localPoolName = d: optionals (d != null) ( + let m = builtins.match "([^/@]+)[^@]*" d; in + optionals (m != null) m); + + # Escape as required by: https://www.freedesktop.org/software/systemd/man/systemd.unit.html + escapeUnitName = name: + lib.concatMapStrings (s: if lib.isList s then "-" else s) + (builtins.split "[^a-zA-Z0-9_.\\-]+" name); in { # Interface @@ -77,6 +78,14 @@ in { ''; }; + service = mkOption { + type = types.attrs; + default = {}; + description = '' + Systemd configuration common to all syncoid services. + ''; + }; + commands = mkOption { type = types.attrsOf (types.submodule ({ name, ... }: { options = { @@ -99,13 +108,7 @@ in { ''; }; - recursive = mkOption { - type = types.bool; - default = false; - description = '' - Whether to also transfer child datasets. - ''; - }; + recursive = mkEnableOption ''the transfer of child datasets''; sshKey = mkOption { type = types.nullOr types.path; @@ -145,6 +148,14 @@ in { ''; }; + service = mkOption { + type = types.attrs; + default = {}; + description = '' + Systemd configuration specific to this syncoid service. + ''; + }; + extraArgs = mkOption { type = types.listOf types.str; default = []; @@ -170,11 +181,15 @@ in { # Implementation config = mkIf cfg.enable { - users = { + users = { users = mkIf (cfg.user == "syncoid") { syncoid = { group = cfg.group; isSystemUser = true; + # For syncoid to be able to create /var/lib/syncoid/.ssh/ + # and to use custom ssh_config or known_hosts. + home = "/var/lib/syncoid"; + createHome = false; }; }; groups = mkIf (cfg.group == "syncoid") { @@ -182,35 +197,99 @@ in { }; }; - systemd.services.syncoid = { - description = "Syncoid ZFS synchronization service"; - script = concatMapStringsSep "\n" (c: lib.escapeShellArgs - ([ "${pkgs.sanoid}/bin/syncoid" ] - ++ (optionals c.useCommonArgs cfg.commonArgs) - ++ (optional c.recursive "-r") - ++ (optionals (c.sshKey != null) [ "--sshkey" c.sshKey ]) - ++ c.extraArgs - ++ [ "--sendoptions" c.sendOptions - "--recvoptions" c.recvOptions - "--no-privilege-elevation" - c.source c.target - ])) (attrValues cfg.commands); - after = [ "zfs.target" ]; - serviceConfig = { - ExecStartPre = let - allowCmd = permissions: pool: lib.escapeShellArgs [ - "+/run/booted-system/sw/bin/zfs" "allow" - cfg.user (concatStringsSep "," permissions) pool - ]; - in - (map (allowCmd [ "hold" "send" "snapshot" "destroy" ]) (getPools "source")) ++ - (map (allowCmd [ "create" "mount" "receive" "rollback" ]) (getPools "target")); - User = cfg.user; - Group = cfg.group; - }; - startAt = cfg.interval; - }; + systemd.services = mapAttrs' (name: c: + nameValuePair "syncoid-${escapeUnitName name}" (mkMerge [ + { description = "Syncoid ZFS synchronization from ${c.source} to ${c.target}"; + after = [ "zfs.target" ]; + startAt = cfg.interval; + # syncoid may need zpool to get feature@extensible_dataset + path = [ "/run/booted-system/sw/bin/" ]; + serviceConfig = { + ExecStartPre = + map (pool: lib.escapeShellArgs [ + "+/run/booted-system/sw/bin/zfs" "allow" + cfg.user "bookmark,hold,send,snapshot,destroy" pool + # Permissions snapshot and destroy are in case --no-sync-snap is not used + ]) (localPoolName c.source) ++ + map (pool: lib.escapeShellArgs [ + "+/run/booted-system/sw/bin/zfs" "allow" + cfg.user "create,mount,receive,rollback" pool + ]) (localPoolName c.target); + ExecStart = lib.escapeShellArgs ([ "${pkgs.sanoid}/bin/syncoid" ] + ++ optionals c.useCommonArgs cfg.commonArgs + ++ optional c.recursive "-r" + ++ optionals (c.sshKey != null) [ "--sshkey" c.sshKey ] + ++ c.extraArgs + ++ [ "--sendoptions" c.sendOptions + "--recvoptions" c.recvOptions + "--no-privilege-elevation" + c.source c.target + ]); + User = cfg.user; + Group = cfg.group; + StateDirectory = [ "syncoid" ]; + StateDirectoryMode = "700"; + # Prevent SSH control sockets of different syncoid services from interfering + PrivateTmp = true; + # Permissive access to /proc because syncoid + # calls ps(1) to detect ongoing `zfs receive`. + ProcSubset = "all"; + ProtectProc = "default"; + + # The following options are only for optimizing: + # systemd-analyze security | grep syncoid-'*' + AmbientCapabilities = ""; + CapabilityBoundingSet = ""; + DeviceAllow = ["/dev/zfs"]; + LockPersonality = true; + MemoryDenyWriteExecute = true; + NoNewPrivileges = true; + PrivateDevices = true; + PrivateMounts = true; + PrivateNetwork = mkDefault false; + PrivateUsers = true; + ProtectClock = true; + ProtectControlGroups = true; + ProtectHome = true; + ProtectHostname = true; + ProtectKernelLogs = true; + ProtectKernelModules = true; + ProtectKernelTunables = true; + ProtectSystem = "strict"; + RemoveIPC = true; + RestrictAddressFamilies = [ "AF_UNIX" "AF_INET" "AF_INET6" ]; + RestrictNamespaces = true; + RestrictRealtime = true; + RestrictSUIDSGID = true; + RootDirectory = "/run/syncoid/${escapeUnitName name}"; + RootDirectoryStartOnly = true; + BindPaths = [ "/dev/zfs" ]; + BindReadOnlyPaths = [ builtins.storeDir "/etc" "/run" "/bin/sh" ]; + # Avoid useless mounting of RootDirectory= in the own RootDirectory= of ExecStart='s mount namespace. + InaccessiblePaths = ["-+/run/syncoid/${escapeUnitName name}"]; + MountAPIVFS = true; + # Create RootDirectory= in the host's mount namespace. + RuntimeDirectory = [ "syncoid/${escapeUnitName name}" ]; + RuntimeDirectoryMode = "700"; + SystemCallFilter = [ + "@system-service" + # Groups in @system-service which do not contain a syscall listed by: + # perf stat -x, 2>perf.log -e 'syscalls:sys_enter_*' syncoid … + # awk >perf.syscalls -F "," '$1 > 0 {sub("syscalls:sys_enter_","",$3); print $3}' perf.log + # systemd-analyze syscall-filter | grep -v -e '#' | sed -e ':loop; /^[^ ]/N; s/\n //; t loop' | grep $(printf ' -e \\<%s\\>' $(cat perf.syscalls)) | cut -f 1 -d ' ' + "~@aio" "~@chown" "~@keyring" "~@memlock" "~@privileged" + "~@resources" "~@setuid" "~@sync" "~@timer" + ]; + SystemCallArchitectures = "native"; + # This is for BindPaths= and BindReadOnlyPaths= + # to allow traversal of directories they create in RootDirectory=. + UMask = "0066"; + }; + } + cfg.service + c.service + ])) cfg.commands; }; - meta.maintainers = with maintainers; [ lopsided98 ]; + meta.maintainers = with maintainers; [ julm lopsided98 ]; } diff --git a/nixos/modules/services/cluster/k3s/default.nix b/nixos/modules/services/cluster/k3s/default.nix index 5ab0286a38a..e5c51441690 100644 --- a/nixos/modules/services/cluster/k3s/default.nix +++ b/nixos/modules/services/cluster/k3s/default.nix @@ -35,10 +35,20 @@ in token = mkOption { type = types.str; - description = "The k3s token to use when connecting to the server. This option only makes sense for an agent."; + description = '' + The k3s token to use when connecting to the server. This option only makes sense for an agent. + WARNING: This option will expose store your token unencrypted world-readable in the nix store. + If this is undesired use the tokenFile option instead. + ''; default = ""; }; + tokenFile = mkOption { + type = types.nullOr types.path; + description = "File path containing k3s token to use when connecting to the server. This option only makes sense for an agent."; + default = null; + }; + docker = mkOption { type = types.bool; default = false; @@ -57,6 +67,12 @@ in default = false; description = "Only run the server. This option only makes sense for a server."; }; + + configPath = mkOption { + type = types.nullOr types.path; + default = null; + description = "File path containing the k3s YAML config. This is useful when the config is generated (for example on boot)."; + }; }; # implementation @@ -64,12 +80,12 @@ in config = mkIf cfg.enable { assertions = [ { - assertion = cfg.role == "agent" -> cfg.serverAddr != ""; - message = "serverAddr should be set if role is 'agent'"; + assertion = cfg.role == "agent" -> (cfg.configPath != null || cfg.serverAddr != ""); + message = "serverAddr or configPath (with 'server' key) should be set if role is 'agent'"; } { - assertion = cfg.role == "agent" -> cfg.token != ""; - message = "token should be set if role is 'agent'"; + assertion = cfg.role == "agent" -> cfg.configPath != null || cfg.tokenFile != null || cfg.token != ""; + message = "token or tokenFile or configPath (with 'token' or 'token-file' keys) should be set if role is 'agent'"; } ]; @@ -81,11 +97,14 @@ in # supporting it, or their bundled containerd systemd.enableUnifiedCgroupHierarchy = false; + environment.systemPackages = [ config.services.k3s.package ]; + systemd.services.k3s = { description = "k3s service"; after = [ "network.service" "firewall.service" ] ++ (optional cfg.docker "docker.service"); wants = [ "network.service" "firewall.service" ]; wantedBy = [ "multi-user.target" ]; + path = optional config.boot.zfs.enabled config.boot.zfs.package; serviceConfig = { # See: https://github.com/rancher/k3s/blob/dddbd16305284ae4bd14c0aade892412310d7edc/install.sh#L197 Type = if cfg.role == "agent" then "exec" else "notify"; @@ -102,7 +121,10 @@ in "${cfg.package}/bin/k3s ${cfg.role}" ] ++ (optional cfg.docker "--docker") ++ (optional cfg.disableAgent "--disable-agent") - ++ (optional (cfg.role == "agent") "--server ${cfg.serverAddr} --token ${cfg.token}") + ++ (optional (cfg.serverAddr != "") "--server ${cfg.serverAddr}") + ++ (optional (cfg.token != "") "--token ${cfg.token}") + ++ (optional (cfg.tokenFile != null) "--token-file ${cfg.tokenFile}") + ++ (optional (cfg.configPath != null) "--config ${cfg.configPath}") ++ [ cfg.extraFlags ] ); }; diff --git a/nixos/modules/services/cluster/kubernetes/default.nix b/nixos/modules/services/cluster/kubernetes/default.nix index 0dc3649237b..33d217ba60e 100644 --- a/nixos/modules/services/cluster/kubernetes/default.nix +++ b/nixos/modules/services/cluster/kubernetes/default.nix @@ -48,8 +48,9 @@ let cluster = "local"; user = name; }; - current-context = "local"; + name = "local"; }]; + current-context = "local"; }); caCert = secret "ca"; diff --git a/nixos/modules/services/cluster/kubernetes/pki.nix b/nixos/modules/services/cluster/kubernetes/pki.nix index 8de6a3ba0d8..d9311d3e3a0 100644 --- a/nixos/modules/services/cluster/kubernetes/pki.nix +++ b/nixos/modules/services/cluster/kubernetes/pki.nix @@ -189,6 +189,7 @@ in # manually paste it in place. Just symlink. # otherwise, create the target file, ready for users to insert the token + mkdir -p $(dirname ${certmgrAPITokenPath}) if [ -f "${cfsslAPITokenPath}" ]; then ln -fs "${cfsslAPITokenPath}" "${certmgrAPITokenPath}" else diff --git a/nixos/modules/services/cluster/kubernetes/proxy.nix b/nixos/modules/services/cluster/kubernetes/proxy.nix index 7aa449f9aa2..42729f54643 100644 --- a/nixos/modules/services/cluster/kubernetes/proxy.nix +++ b/nixos/modules/services/cluster/kubernetes/proxy.nix @@ -59,7 +59,7 @@ in description = "Kubernetes Proxy Service"; wantedBy = [ "kubernetes.target" ]; after = [ "kube-apiserver.service" ]; - path = with pkgs; [ iptables conntrack_tools ]; + path = with pkgs; [ iptables conntrack-tools ]; serviceConfig = { Slice = "kubernetes.slice"; ExecStart = ''${top.package}/bin/kube-proxy \ diff --git a/nixos/modules/services/continuous-integration/buildkite-agents.nix b/nixos/modules/services/continuous-integration/buildkite-agents.nix index 3dd1c40aaa4..b8982d757db 100644 --- a/nixos/modules/services/continuous-integration/buildkite-agents.nix +++ b/nixos/modules/services/continuous-integration/buildkite-agents.nix @@ -238,8 +238,7 @@ in in optionalString (cfg.privateSshKeyPath != null) '' mkdir -m 0700 -p "${sshDir}" - cp -f "${toString cfg.privateSshKeyPath}" "${sshDir}/id_rsa" - chmod 600 "${sshDir}"/id_rsa + install -m600 "${toString cfg.privateSshKeyPath}" "${sshDir}/id_rsa" '' + '' cat > "${cfg.dataDir}/buildkite-agent.cfg" <<EOF token="$(cat ${toString cfg.tokenPath})" diff --git a/nixos/modules/services/continuous-integration/hercules-ci-agent/common.nix b/nixos/modules/services/continuous-integration/hercules-ci-agent/common.nix index 2f0b573e872..70d85a97f3b 100644 --- a/nixos/modules/services/continuous-integration/hercules-ci-agent/common.nix +++ b/nixos/modules/services/continuous-integration/hercules-ci-agent/common.nix @@ -105,7 +105,7 @@ let pkgs.stdenv.mkDerivation { name = "hercules-ci-check-system-nix-src"; inherit (config.nix.package) src patches; - configurePhase = ":"; + dontConfigure = true; buildPhase = '' echo "Checking in-memory pathInfoCache expiry" if ! grep 'PathInfoCacheValue' src/libstore/store-api.hh >/dev/null; then diff --git a/nixos/modules/services/continuous-integration/jenkins/default.nix b/nixos/modules/services/continuous-integration/jenkins/default.nix index cdc3b4b5c58..889688a2685 100644 --- a/nixos/modules/services/continuous-integration/jenkins/default.nix +++ b/nixos/modules/services/continuous-integration/jenkins/default.nix @@ -2,6 +2,7 @@ with lib; let cfg = config.services.jenkins; + jenkinsUrl = "http://${cfg.listenAddress}:${toString cfg.port}${cfg.prefix}"; in { options = { services.jenkins = { @@ -141,14 +142,34 @@ in { Additional command line arguments to pass to the Java run time (as opposed to Jenkins). ''; }; + + withCLI = mkOption { + type = types.bool; + default = false; + description = '' + Whether to make the CLI available. + + More info about the CLI available at + <link xlink:href="https://www.jenkins.io/doc/book/managing/cli"> + https://www.jenkins.io/doc/book/managing/cli</link> . + ''; + }; }; }; config = mkIf cfg.enable { - # server references the dejavu fonts - environment.systemPackages = [ - pkgs.dejavu_fonts - ]; + environment = { + # server references the dejavu fonts + systemPackages = [ + pkgs.dejavu_fonts + ] ++ optional cfg.withCLI cfg.package; + + variables = {} + // optionalAttrs cfg.withCLI { + # Make it more convenient to use the `jenkins-cli`. + JENKINS_URL = jenkinsUrl; + }; + }; users.groups = optionalAttrs (cfg.group == "jenkins") { jenkins.gid = config.ids.gids.jenkins; @@ -215,7 +236,7 @@ in { ''; postStart = '' - until [[ $(${pkgs.curl.bin}/bin/curl -L -s --head -w '\n%{http_code}' http://${cfg.listenAddress}:${toString cfg.port}${cfg.prefix} | tail -n1) =~ ^(200|403)$ ]]; do + until [[ $(${pkgs.curl.bin}/bin/curl -L -s --head -w '\n%{http_code}' ${jenkinsUrl} | tail -n1) =~ ^(200|403)$ ]]; do sleep 1 done ''; diff --git a/nixos/modules/services/continuous-integration/jenkins/job-builder.nix b/nixos/modules/services/continuous-integration/jenkins/job-builder.nix index 5d1bfe4ec40..536d394b3fd 100644 --- a/nixos/modules/services/continuous-integration/jenkins/job-builder.nix +++ b/nixos/modules/services/continuous-integration/jenkins/job-builder.nix @@ -165,6 +165,42 @@ in { ''; in '' + joinByString() + { + local separator="$1" + shift + local first="$1" + shift + printf "%s" "$first" "''${@/#/$separator}" + } + + # Map a relative directory path in the output from + # jenkins-job-builder (jobname) to the layout expected by jenkins: + # each directory level gets prepended "jobs/". + getJenkinsJobDir() + { + IFS='/' read -ra input_dirs <<< "$1" + printf "jobs/" + joinByString "/jobs/" "''${input_dirs[@]}" + } + + # The inverse of getJenkinsJobDir (remove the "jobs/" prefixes) + getJobname() + { + IFS='/' read -ra input_dirs <<< "$1" + local i=0 + local nelem=''${#input_dirs[@]} + for e in "''${input_dirs[@]}"; do + if [ $((i % 2)) -eq 1 ]; then + printf "$e" + if [ $i -lt $(( nelem - 1 )) ]; then + printf "/" + fi + fi + i=$((i + 1)) + done + } + rm -rf ${jobBuilderOutputDir} cur_decl_jobs=/run/jenkins-job-builder/declarative-jobs rm -f "$cur_decl_jobs" @@ -172,27 +208,27 @@ in { # Create / update jobs mkdir -p ${jobBuilderOutputDir} for inputFile in ${yamlJobsFile} ${concatStringsSep " " jsonJobsFiles}; do - HOME="${jenkinsCfg.home}" "${pkgs.jenkins-job-builder}/bin/jenkins-jobs" --ignore-cache test -o "${jobBuilderOutputDir}" "$inputFile" + HOME="${jenkinsCfg.home}" "${pkgs.jenkins-job-builder}/bin/jenkins-jobs" --ignore-cache test --config-xml -o "${jobBuilderOutputDir}" "$inputFile" done - for file in "${jobBuilderOutputDir}/"*; do - test -f "$file" || continue - jobname="$(basename $file)" - jobdir="${jenkinsCfg.home}/jobs/$jobname" + find "${jobBuilderOutputDir}" -type f -name config.xml | while read -r f; do echo "$(dirname "$f")"; done | sort | while read -r dir; do + jobname="$(realpath --relative-to="${jobBuilderOutputDir}" "$dir")" + jenkinsjobname=$(getJenkinsJobDir "$jobname") + jenkinsjobdir="${jenkinsCfg.home}/$jenkinsjobname" echo "Creating / updating job \"$jobname\"" - mkdir -p "$jobdir" - touch "$jobdir/${ownerStamp}" - cp "$file" "$jobdir/config.xml" - echo "$jobname" >> "$cur_decl_jobs" + mkdir -p "$jenkinsjobdir" + touch "$jenkinsjobdir/${ownerStamp}" + cp "$dir"/config.xml "$jenkinsjobdir/config.xml" + echo "$jenkinsjobname" >> "$cur_decl_jobs" done # Remove stale jobs - for file in "${jenkinsCfg.home}"/jobs/*/${ownerStamp}; do - test -f "$file" || continue - jobdir="$(dirname $file)" - jobname="$(basename "$jobdir")" - grep --quiet --line-regexp "$jobname" "$cur_decl_jobs" 2>/dev/null && continue + find "${jenkinsCfg.home}" -type f -name "${ownerStamp}" | while read -r f; do echo "$(dirname "$f")"; done | sort --reverse | while read -r dir; do + jenkinsjobname="$(realpath --relative-to="${jenkinsCfg.home}" "$dir")" + grep --quiet --line-regexp "$jenkinsjobname" "$cur_decl_jobs" 2>/dev/null && continue + jobname=$(getJobname "$jenkinsjobname") echo "Deleting stale job \"$jobname\"" + jobdir="${jenkinsCfg.home}/$jenkinsjobname" rm -rf "$jobdir" done '' + (if cfg.accessUser != "" then reloadScript else ""); diff --git a/nixos/modules/services/databases/firebird.nix b/nixos/modules/services/databases/firebird.nix index ed47f647edd..0815487d4a1 100644 --- a/nixos/modules/services/databases/firebird.nix +++ b/nixos/modules/services/databases/firebird.nix @@ -43,17 +43,15 @@ in enable = mkEnableOption "the Firebird super server"; package = mkOption { - default = pkgs.firebirdSuper; - defaultText = "pkgs.firebirdSuper"; + default = pkgs.firebird; + defaultText = "pkgs.firebird"; type = types.package; - /* - Example: <code>package = pkgs.firebirdSuper.override { icu = - pkgs.icu; };</code> which is not recommended for compatibility - reasons. See comments at the firebirdSuper derivation - */ - + example = '' + <code>package = pkgs.firebird_3;</code> + ''; description = '' - Which firebird derivation to use. + Which Firebird package to be installed: <code>pkgs.firebird_3</code> + For SuperServer use override: <code>pkgs.firebird_3.override { superServer = true; };</code> ''; }; @@ -74,7 +72,7 @@ in }; baseDir = mkOption { - default = "/var/db/firebird"; # ubuntu is using /var/lib/firebird/2.1/data/.. ? + default = "/var/lib/firebird"; type = types.str; description = '' Location containing data/ and system/ directories. @@ -111,6 +109,14 @@ in cp ${firebird}/security2.fdb "${systemDir}" fi + if ! test -e "${systemDir}/security3.fdb"; then + cp ${firebird}/security3.fdb "${systemDir}" + fi + + if ! test -e "${systemDir}/security4.fdb"; then + cp ${firebird}/security4.fdb "${systemDir}" + fi + chmod -R 700 "${dataDir}" "${systemDir}" /var/log/firebird ''; diff --git a/nixos/modules/services/databases/mysql.nix b/nixos/modules/services/databases/mysql.nix index cf105daeb04..b801b5cce63 100644 --- a/nixos/modules/services/databases/mysql.nix +++ b/nixos/modules/services/databases/mysql.nix @@ -34,7 +34,7 @@ in package = mkOption { type = types.package; - example = literalExample "pkgs.mysql"; + example = literalExample "pkgs.mariadb"; description = " Which MySQL derivation to use. MariaDB packages are supported too. "; @@ -48,7 +48,7 @@ in }; port = mkOption { - type = types.int; + type = types.port; default = 3306; description = "Port of MySQL."; }; diff --git a/nixos/modules/services/databases/postgresql.nix b/nixos/modules/services/databases/postgresql.nix index effc9182472..fd4a195787f 100644 --- a/nixos/modules/services/databases/postgresql.nix +++ b/nixos/modules/services/databases/postgresql.nix @@ -293,7 +293,8 @@ in # Note: when changing the default, make it conditional on # ‘system.stateVersion’ to maintain compatibility with existing # systems! - mkDefault (if versionAtLeast config.system.stateVersion "20.03" then pkgs.postgresql_11 + mkDefault (if versionAtLeast config.system.stateVersion "21.11" then pkgs.postgresql_13 + else if versionAtLeast config.system.stateVersion "20.03" then pkgs.postgresql_11 else if versionAtLeast config.system.stateVersion "17.09" then pkgs.postgresql_9_6 else throw "postgresql_9_5 was removed, please upgrade your postgresql version."); diff --git a/nixos/modules/services/databases/redis.nix b/nixos/modules/services/databases/redis.nix index c4d51958e23..9c0740f28c9 100644 --- a/nixos/modules/services/databases/redis.nix +++ b/nixos/modules/services/databases/redis.nix @@ -52,7 +52,7 @@ in { }; port = mkOption { - type = types.int; + type = types.port; default = 6379; description = "The port for Redis to listen to."; }; diff --git a/nixos/modules/services/desktops/espanso.nix b/nixos/modules/services/desktops/espanso.nix index cd2eadf8816..4ef6724dda0 100644 --- a/nixos/modules/services/desktops/espanso.nix +++ b/nixos/modules/services/desktops/espanso.nix @@ -12,7 +12,6 @@ in { config = mkIf cfg.enable { systemd.user.services.espanso = { description = "Espanso daemon"; - path = with pkgs; [ espanso libnotify xclip ]; serviceConfig = { ExecStart = "${pkgs.espanso}/bin/espanso daemon"; Restart = "on-failure"; diff --git a/nixos/modules/services/desktops/pipewire/bluez-hardware.conf.json b/nixos/modules/services/desktops/pipewire/bluez-hardware.conf.json new file mode 100644 index 00000000000..7c527b29215 --- /dev/null +++ b/nixos/modules/services/desktops/pipewire/bluez-hardware.conf.json @@ -0,0 +1,197 @@ +{ + "bluez5.features.device": [ + { + "name": "Air 1 Plus", + "no-features": [ + "hw-volume-mic" + ] + }, + { + "name": "AirPods", + "no-features": [ + "msbc-alt1", + "msbc-alt1-rtl" + ] + }, + { + "name": "AirPods Pro", + "no-features": [ + "msbc-alt1", + "msbc-alt1-rtl" + ] + }, + { + "name": "AXLOIE Goin", + "no-features": [ + "msbc-alt1", + "msbc-alt1-rtl" + ] + }, + { + "name": "JBL Endurance RUN BT", + "no-features": [ + "msbc-alt1", + "msbc-alt1-rtl", + "sbc-xq" + ] + }, + { + "name": "JBL LIVE650BTNC" + }, + { + "name": "Soundcore Life P2-L", + "no-features": [ + "msbc-alt1", + "msbc-alt1-rtl" + ] + }, + { + "name": "Urbanista Stockholm Plus", + "no-features": [ + "msbc-alt1", + "msbc-alt1-rtl" + ] + }, + { + "address": "~^94:16:25:", + "no-features": [ + "hw-volume" + ] + }, + { + "address": "~^9c:64:8b:", + "no-features": [ + "hw-volume" + ] + }, + { + "address": "~^a0:e9:db:", + "no-features": [ + "hw-volume" + ] + }, + { + "address": "~^0c:a6:94:", + "no-features": [ + "hw-volume" + ] + }, + { + "address": "~^00:14:02:", + "no-features": [ + "hw-volume" + ] + }, + { + "address": "~^44:5e:f3:", + "no-features": [ + "hw-volume" + ] + }, + { + "address": "~^d4:9c:28:", + "no-features": [ + "hw-volume" + ] + }, + { + "address": "~^00:18:6b:", + "no-features": [ + "hw-volume" + ] + }, + { + "address": "~^b8:ad:3e:", + "no-features": [ + "hw-volume" + ] + }, + { + "address": "~^a0:e9:db:", + "no-features": [ + "hw-volume" + ] + }, + { + "address": "~^00:24:1c:", + "no-features": [ + "hw-volume" + ] + }, + { + "address": "~^00:11:b1:", + "no-features": [ + "hw-volume" + ] + }, + { + "address": "~^a4:15:66:", + "no-features": [ + "hw-volume" + ] + }, + { + "address": "~^00:14:f1:", + "no-features": [ + "hw-volume" + ] + }, + { + "address": "~^00:26:7e:", + "no-features": [ + "hw-volume" + ] + }, + { + "address": "~^90:03:b7:", + "no-features": [ + "hw-volume" + ] + } + ], + "bluez5.features.adapter": [ + { + "bus-type": "usb", + "vendor-id": "usb:0bda" + }, + { + "bus-type": "usb", + "no-features": [ + "msbc-alt1-rtl" + ] + }, + { + "no-features": [ + "msbc-alt1-rtl" + ] + } + ], + "bluez5.features.kernel": [ + { + "sysname": "Linux", + "release": "~^[0-4]\\.", + "no-features": [ + "msbc-alt1", + "msbc-alt1-rtl" + ] + }, + { + "sysname": "Linux", + "release": "~^5\\.[1-7]\\.", + "no-features": [ + "msbc-alt1", + "msbc-alt1-rtl" + ] + }, + { + "sysname": "Linux", + "release": "~^5\\.(8|9|10)\\.", + "no-features": [ + "msbc-alt1" + ] + }, + { + "no-features": [] + } + ] +} diff --git a/nixos/modules/services/desktops/pipewire/jack.conf.json b/nixos/modules/services/desktops/pipewire/jack.conf.json index a6bd3491785..e36e04fffcf 100644 --- a/nixos/modules/services/desktops/pipewire/jack.conf.json +++ b/nixos/modules/services/desktops/pipewire/jack.conf.json @@ -7,7 +7,7 @@ }, "context.modules": [ { - "name": "libpipewire-module-rtkit", + "name": "libpipewire-module-rt", "args": {}, "flags": [ "ifexists", diff --git a/nixos/modules/services/desktops/pipewire/pipewire-media-session.nix b/nixos/modules/services/desktops/pipewire/pipewire-media-session.nix index 17a2d49bb1f..41ab995e329 100644 --- a/nixos/modules/services/desktops/pipewire/pipewire-media-session.nix +++ b/nixos/modules/services/desktops/pipewire/pipewire-media-session.nix @@ -15,6 +15,7 @@ let defaults = { alsa-monitor = (builtins.fromJSON (builtins.readFile ./alsa-monitor.conf.json)); bluez-monitor = (builtins.fromJSON (builtins.readFile ./bluez-monitor.conf.json)); + bluez-hardware = (builtins.fromJSON (builtins.readFile ./bluez-hardware.conf.json)); media-session = (builtins.fromJSON (builtins.readFile ./media-session.conf.json)); v4l2-monitor = (builtins.fromJSON (builtins.readFile ./v4l2-monitor.conf.json)); }; @@ -22,6 +23,7 @@ let configs = { alsa-monitor = recursiveUpdate defaults.alsa-monitor cfg.config.alsa-monitor; bluez-monitor = recursiveUpdate defaults.bluez-monitor cfg.config.bluez-monitor; + bluez-hardware = defaults.bluez-hardware; media-session = recursiveUpdate defaults.media-session cfg.config.media-session; v4l2-monitor = recursiveUpdate defaults.v4l2-monitor cfg.config.v4l2-monitor; }; @@ -120,6 +122,10 @@ in { mkIf config.services.pipewire.pulse.enable { source = json.generate "bluez-monitor.conf" configs.bluez-monitor; }; + environment.etc."pipewire/media-session.d/bluez-hardware.conf" = + mkIf config.services.pipewire.pulse.enable { + source = json.generate "bluez-hardware.conf" configs.bluez-hardware; + }; environment.etc."pipewire/media-session.d/with-jack" = mkIf config.services.pipewire.jack.enable { diff --git a/nixos/modules/services/desktops/pipewire/pipewire.conf.json b/nixos/modules/services/desktops/pipewire/pipewire.conf.json index a9330f54f4f..a923ab4db23 100644 --- a/nixos/modules/services/desktops/pipewire/pipewire.conf.json +++ b/nixos/modules/services/desktops/pipewire/pipewire.conf.json @@ -74,7 +74,18 @@ "args": { "factory.name": "support.node.driver", "node.name": "Dummy-Driver", - "priority.driver": 8000 + "node.group": "pipewire.dummy", + "priority.driver": 20000 + } + }, + { + "factory": "spa-node-factory", + "args": { + "factory.name": "support.node.driver", + "node.name": "Freewheel-Driver", + "priority.driver": 19000, + "node.group": "pipewire.freewheel", + "node.freewheel": true } } ], diff --git a/nixos/modules/services/editors/infinoted.nix b/nixos/modules/services/editors/infinoted.nix index 10d868b7f16..3eb0753194d 100644 --- a/nixos/modules/services/editors/infinoted.nix +++ b/nixos/modules/services/editors/infinoted.nix @@ -51,7 +51,7 @@ in { }; port = mkOption { - type = types.int; + type = types.port; default = 6523; description = '' Port to listen on diff --git a/nixos/modules/services/games/terraria.nix b/nixos/modules/services/games/terraria.nix index 9e8e5ae8759..7312c7e6b63 100644 --- a/nixos/modules/services/games/terraria.nix +++ b/nixos/modules/services/games/terraria.nix @@ -42,7 +42,7 @@ in }; port = mkOption { - type = types.int; + type = types.port; default = 7777; description = '' Specifies the port to listen on. @@ -50,7 +50,7 @@ in }; maxPlayers = mkOption { - type = types.int; + type = types.ints.u8; default = 255; description = '' Sets the max number of players (between 1 and 255). diff --git a/nixos/modules/services/hardware/actkbd.nix b/nixos/modules/services/hardware/actkbd.nix index daa407ca1f0..f7770f85da3 100644 --- a/nixos/modules/services/hardware/actkbd.nix +++ b/nixos/modules/services/hardware/actkbd.nix @@ -75,7 +75,7 @@ in type = types.listOf (types.submodule bindingCfg); default = []; example = lib.literalExample '' - [ { keys = [ 113 ]; events = [ "key" ]; command = "''${pkgs.alsaUtils}/bin/amixer -q set Master toggle"; } + [ { keys = [ 113 ]; events = [ "key" ]; command = "''${pkgs.alsa-utils}/bin/amixer -q set Master toggle"; } ] ''; description = '' diff --git a/nixos/modules/services/hardware/auto-cpufreq.nix b/nixos/modules/services/hardware/auto-cpufreq.nix index 72c4eccaff7..f846476b30b 100644 --- a/nixos/modules/services/hardware/auto-cpufreq.nix +++ b/nixos/modules/services/hardware/auto-cpufreq.nix @@ -12,7 +12,13 @@ in { config = mkIf cfg.enable { environment.systemPackages = [ pkgs.auto-cpufreq ]; - systemd.packages = [ pkgs.auto-cpufreq ]; - systemd.services.auto-cpufreq.path = with pkgs; [ bash coreutils ]; + systemd = { + packages = [ pkgs.auto-cpufreq ]; + services.auto-cpufreq = { + # Workaround for https://github.com/NixOS/nixpkgs/issues/81138 + wantedBy = [ "multi-user.target" ]; + path = with pkgs; [ bash coreutils ]; + }; + }; }; } diff --git a/nixos/modules/services/hardware/ddccontrol.nix b/nixos/modules/services/hardware/ddccontrol.nix new file mode 100644 index 00000000000..766bf12ee9f --- /dev/null +++ b/nixos/modules/services/hardware/ddccontrol.nix @@ -0,0 +1,36 @@ +{ config +, lib +, pkgs +, ... +}: + +let + cfg = config.services.ddccontrol; +in + +{ + ###### interface + + options = { + services.ddccontrol = { + enable = lib.mkEnableOption "ddccontrol for controlling displays"; + }; + }; + + ###### implementation + + config = lib.mkIf cfg.enable { + # Give users access to the "gddccontrol" tool + environment.systemPackages = [ + pkgs.ddccontrol + ]; + + services.dbus.packages = [ + pkgs.ddccontrol + ]; + + systemd.packages = [ + pkgs.ddccontrol + ]; + }; +} diff --git a/nixos/modules/services/hardware/sane_extra_backends/brscan4_etc_files.nix b/nixos/modules/services/hardware/sane_extra_backends/brscan4_etc_files.nix index 556f6bbb419..9d083a615a2 100644 --- a/nixos/modules/services/hardware/sane_extra_backends/brscan4_etc_files.nix +++ b/nixos/modules/services/hardware/sane_extra_backends/brscan4_etc_files.nix @@ -54,8 +54,7 @@ stdenv.mkDerivation { ${addAllNetDev netDevices} ''; - installPhase = ":"; - + dontInstall = true; dontStrip = true; dontPatchELF = true; diff --git a/nixos/modules/services/hardware/sane_extra_backends/brscan5.nix b/nixos/modules/services/hardware/sane_extra_backends/brscan5.nix new file mode 100644 index 00000000000..89b5ff0e028 --- /dev/null +++ b/nixos/modules/services/hardware/sane_extra_backends/brscan5.nix @@ -0,0 +1,110 @@ +{ config, lib, pkgs, ... }: + +with lib; + +let + cfg = config.hardware.sane.brscan5; + + netDeviceList = attrValues cfg.netDevices; + + etcFiles = pkgs.callPackage ./brscan5_etc_files.nix { netDevices = netDeviceList; }; + + netDeviceOpts = { name, ... }: { + + options = { + + name = mkOption { + type = types.str; + description = '' + The friendly name you give to the network device. If undefined, + the name of attribute will be used. + ''; + + example = literalExample "office1"; + }; + + model = mkOption { + type = types.str; + description = '' + The model of the network device. + ''; + + example = literalExample "ADS-1200"; + }; + + ip = mkOption { + type = with types; nullOr str; + default = null; + description = '' + The ip address of the device. If undefined, you will have to + provide a nodename. + ''; + + example = literalExample "192.168.1.2"; + }; + + nodename = mkOption { + type = with types; nullOr str; + default = null; + description = '' + The node name of the device. If undefined, you will have to + provide an ip. + ''; + + example = literalExample "BRW0080927AFBCE"; + }; + + }; + + + config = + { name = mkDefault name; + }; + }; + +in + +{ + options = { + + hardware.sane.brscan5.enable = + mkEnableOption "the Brother brscan5 sane backend"; + + hardware.sane.brscan5.netDevices = mkOption { + default = {}; + example = + { office1 = { model = "MFC-7860DW"; ip = "192.168.1.2"; }; + office2 = { model = "MFC-7860DW"; nodename = "BRW0080927AFBCE"; }; + }; + type = with types; attrsOf (submodule netDeviceOpts); + description = '' + The list of network devices that will be registered against the brscan5 + sane backend. + ''; + }; + }; + + config = mkIf (config.hardware.sane.enable && cfg.enable) { + + hardware.sane.extraBackends = [ + pkgs.brscan5 + ]; + + environment.etc."opt/brother/scanner/brscan5" = + { source = "${etcFiles}/etc/opt/brother/scanner/brscan5"; }; + environment.etc."opt/brother/scanner/models" = + { source = "${etcFiles}/etc/opt/brother/scanner/brscan5/models"; }; + environment.etc."sane.d/dll.d/brother5.conf".source = "${pkgs.brscan5}/etc/sane.d/dll.d/brother.conf"; + + assertions = [ + { assertion = all (x: !(null != x.ip && null != x.nodename)) netDeviceList; + message = '' + When describing a network device as part of the attribute list + `hardware.sane.brscan5.netDevices`, only one of its `ip` or `nodename` + attribute should be specified, not both! + ''; + } + ]; + + }; +} diff --git a/nixos/modules/services/hardware/sane_extra_backends/brscan5_etc_files.nix b/nixos/modules/services/hardware/sane_extra_backends/brscan5_etc_files.nix new file mode 100644 index 00000000000..432f0316a4f --- /dev/null +++ b/nixos/modules/services/hardware/sane_extra_backends/brscan5_etc_files.nix @@ -0,0 +1,77 @@ +{ stdenv, lib, brscan5, netDevices ? [] }: + +/* + +Testing +------- +From nixpkgs repo + +No net devices: + +~~~ +nix-build -E 'let pkgs = import ./. {}; + brscan5-etc-files = pkgs.callPackage (import ./nixos/modules/services/hardware/sane_extra_backends/brscan5_etc_files.nix) {}; + in brscan5-etc-files' +~~~ + +Two net devices: + +~~~ +nix-build -E 'let pkgs = import ./. {}; + brscan5-etc-files = pkgs.callPackage (import ./nixos/modules/services/hardware/sane_extra_backends/brscan5_etc_files.nix) {}; + in brscan5-etc-files.override { + netDevices = [ + {name="a"; model="ADS-1200"; nodename="BRW0080927AFBCE";} + {name="b"; model="ADS-1200"; ip="192.168.1.2";} + ]; + }' +~~~ + +*/ + +let + + addNetDev = nd: '' + brsaneconfig5 -a \ + name="${nd.name}" \ + model="${nd.model}" \ + ${if (lib.hasAttr "nodename" nd && nd.nodename != null) then + ''nodename="${nd.nodename}"'' else + ''ip="${nd.ip}"''}''; + addAllNetDev = xs: lib.concatStringsSep "\n" (map addNetDev xs); +in + +stdenv.mkDerivation { + + name = "brscan5-etc-files"; + version = "1.2.6-0"; + src = "${brscan5}/opt/brother/scanner/brscan5"; + + nativeBuildInputs = [ brscan5 ]; + + dontConfigure = true; + + buildPhase = '' + TARGET_DIR="$out/etc/opt/brother/scanner/brscan5" + mkdir -p "$TARGET_DIR" + cp -rp "./models" "$TARGET_DIR" + cp -rp "./brscan5.ini" "$TARGET_DIR" + cp -rp "./brsanenetdevice.cfg" "$TARGET_DIR" + + export NIX_REDIRECTS="/etc/opt/brother/scanner/brscan5/=$TARGET_DIR/" + + printf '${addAllNetDev netDevices}\n' + + ${addAllNetDev netDevices} + ''; + + dontInstall = true; + + meta = with lib; { + description = "Brother brscan5 sane backend driver etc files"; + homepage = "https://www.brother.com"; + platforms = platforms.linux; + license = licenses.unfree; + maintainers = with maintainers; [ mattchrist ]; + }; +} diff --git a/nixos/modules/services/mail/mailman.nix b/nixos/modules/services/mail/mailman.nix index f75d6183c3e..831175d5625 100644 --- a/nixos/modules/services/mail/mailman.nix +++ b/nixos/modules/services/mail/mailman.nix @@ -333,6 +333,7 @@ in { before = [ "mailman.service" "mailman-web-setup.service" "mailman-uwsgi.service" "hyperkitty.service" ]; requiredBy = [ "mailman.service" "mailman-web-setup.service" "mailman-uwsgi.service" "hyperkitty.service" ]; path = with pkgs; [ jq ]; + serviceConfig.Type = "oneshot"; script = '' mailmanDir=/var/lib/mailman mailmanWebDir=/var/lib/mailman-web diff --git a/nixos/modules/services/mail/roundcube.nix b/nixos/modules/services/mail/roundcube.nix index ee7aa7e22fb..f9b63000473 100644 --- a/nixos/modules/services/mail/roundcube.nix +++ b/nixos/modules/services/mail/roundcube.nix @@ -7,7 +7,7 @@ let fpm = config.services.phpfpm.pools.roundcube; localDB = cfg.database.host == "localhost"; user = cfg.database.username; - phpWithPspell = pkgs.php.withExtensions ({ enabled, all }: [ all.pspell ] ++ enabled); + phpWithPspell = pkgs.php74.withExtensions ({ enabled, all }: [ all.pspell ] ++ enabled); in { options.services.roundcube = { diff --git a/nixos/modules/services/misc/bees.nix b/nixos/modules/services/misc/bees.nix index b0ed2d5c286..6b8cae84642 100644 --- a/nixos/modules/services/misc/bees.nix +++ b/nixos/modules/services/misc/bees.nix @@ -57,7 +57,7 @@ let }; options.extraOptions = mkOption { type = listOf str; - default = []; + default = [ ]; description = '' Extra command-line options passed to the daemon. See upstream bees documentation. ''; @@ -67,7 +67,8 @@ let }; }; -in { +in +{ options.services.beesd = { filesystems = mkOption { @@ -87,37 +88,42 @@ in { }; }; config = { - systemd.services = mapAttrs' (name: fs: nameValuePair "beesd@${name}" { - description = "Block-level BTRFS deduplication for %i"; - after = [ "sysinit.target" ]; + systemd.services = mapAttrs' + (name: fs: nameValuePair "beesd@${name}" { + description = "Block-level BTRFS deduplication for %i"; + after = [ "sysinit.target" ]; - serviceConfig = let - configOpts = [ - fs.spec - "verbosity=${toString fs.verbosity}" - "idxSizeMB=${toString fs.hashTableSizeMB}" - "workDir=${fs.workDir}" - ]; - configOptsStr = escapeShellArgs configOpts; - in { - # Values from https://github.com/Zygo/bees/blob/v0.6.1/scripts/beesd%40.service.in - ExecStart = "${pkgs.bees}/bin/bees-service-wrapper run ${configOptsStr} -- --no-timestamps ${escapeShellArgs fs.extraOptions}"; - ExecStopPost = "${pkgs.bees}/bin/bees-service-wrapper cleanup ${configOptsStr}"; - CPUAccounting = true; - CPUWeight = 12; - IOSchedulingClass = "idle"; - IOSchedulingPriority = 7; - IOWeight = 10; - KillMode = "control-group"; - KillSignal = "SIGTERM"; - MemoryAccounting = true; - Nice = 19; - Restart = "on-abnormal"; - StartupCPUWeight = 25; - StartupIOWeight = 25; - SyslogIdentifier = "bees"; # would otherwise be "bees-service-wrapper" - }; - wantedBy = ["multi-user.target"]; - }) cfg.filesystems; + serviceConfig = + let + configOpts = [ + fs.spec + "verbosity=${toString fs.verbosity}" + "idxSizeMB=${toString fs.hashTableSizeMB}" + "workDir=${fs.workDir}" + ]; + configOptsStr = escapeShellArgs configOpts; + in + { + # Values from https://github.com/Zygo/bees/blob/v0.6.5/scripts/beesd@.service.in + ExecStart = "${pkgs.bees}/bin/bees-service-wrapper run ${configOptsStr} -- --no-timestamps ${escapeShellArgs fs.extraOptions}"; + ExecStopPost = "${pkgs.bees}/bin/bees-service-wrapper cleanup ${configOptsStr}"; + CPUAccounting = true; + CPUSchedulingPolicy = "batch"; + CPUWeight = 12; + IOSchedulingClass = "idle"; + IOSchedulingPriority = 7; + IOWeight = 10; + KillMode = "control-group"; + KillSignal = "SIGTERM"; + MemoryAccounting = true; + Nice = 19; + Restart = "on-abnormal"; + StartupCPUWeight = 25; + StartupIOWeight = 25; + SyslogIdentifier = "beesd"; # would otherwise be "bees-service-wrapper" + }; + wantedBy = [ "multi-user.target" ]; + }) + cfg.filesystems; }; } diff --git a/nixos/modules/services/misc/clipcat.nix b/nixos/modules/services/misc/clipcat.nix new file mode 100644 index 00000000000..128bb9a89d6 --- /dev/null +++ b/nixos/modules/services/misc/clipcat.nix @@ -0,0 +1,31 @@ +{ config, lib, pkgs, ... }: + +with lib; + +let + cfg = config.services.clipcat; +in { + + options.services.clipcat= { + enable = mkEnableOption "Clipcat clipboard daemon"; + + package = mkOption { + type = types.package; + default = pkgs.clipcat; + defaultText = "pkgs.clipcat"; + description = "clipcat derivation to use."; + }; + }; + + config = mkIf cfg.enable { + systemd.user.services.clipcat = { + enable = true; + description = "clipcat daemon"; + wantedBy = [ "graphical-session.target" ]; + after = [ "graphical-session.target" ]; + serviceConfig.ExecStart = "${cfg.package}/bin/clipcatd --no-daemon"; + }; + + environment.systemPackages = [ cfg.package ]; + }; +} diff --git a/nixos/modules/services/misc/docker-registry.nix b/nixos/modules/services/misc/docker-registry.nix index 1c2e2cc5359..e212f581c28 100644 --- a/nixos/modules/services/misc/docker-registry.nix +++ b/nixos/modules/services/misc/docker-registry.nix @@ -58,7 +58,7 @@ in { port = mkOption { description = "Docker registry port to bind to."; default = 5000; - type = types.int; + type = types.port; }; storagePath = mkOption { diff --git a/nixos/modules/services/misc/etcd.nix b/nixos/modules/services/misc/etcd.nix index 32360d43768..eb266f043eb 100644 --- a/nixos/modules/services/misc/etcd.nix +++ b/nixos/modules/services/misc/etcd.nix @@ -184,7 +184,7 @@ in { }; }; - environment.systemPackages = [ pkgs.etcdctl ]; + environment.systemPackages = [ pkgs.etcd ]; users.users.etcd = { uid = config.ids.uids.etcd; diff --git a/nixos/modules/services/misc/geoip-updater.nix b/nixos/modules/services/misc/geoip-updater.nix deleted file mode 100644 index baf0a8d73d1..00000000000 --- a/nixos/modules/services/misc/geoip-updater.nix +++ /dev/null @@ -1,306 +0,0 @@ -{ config, lib, pkgs, ... }: - -with lib; - -let - cfg = config.services.geoip-updater; - - dbBaseUrl = "https://geolite.maxmind.com/download/geoip/database"; - - randomizedTimerDelaySec = "3600"; - - # Use writeScriptBin instead of writeScript, so that argv[0] (logged to the - # journal) doesn't include the long nix store path hash. (Prefixing the - # ExecStart= command with '@' doesn't work because we start a shell (new - # process) that creates a new argv[0].) - geoip-updater = pkgs.writeScriptBin "geoip-updater" '' - #!${pkgs.runtimeShell} - skipExisting=0 - debug() - { - echo "<7>$@" - } - info() - { - echo "<6>$@" - } - error() - { - echo "<3>$@" - } - die() - { - error "$@" - exit 1 - } - waitNetworkOnline() - { - ret=1 - for i in $(seq 6); do - curl_out=$("${pkgs.curl.bin}/bin/curl" \ - --silent --fail --show-error --max-time 60 "${dbBaseUrl}" 2>&1) - if [ $? -eq 0 ]; then - debug "Server is reachable (try $i)" - ret=0 - break - else - debug "Server is unreachable (try $i): $curl_out" - sleep 10 - fi - done - return $ret - } - dbFnameTmp() - { - dburl=$1 - echo "${cfg.databaseDir}/.$(basename "$dburl")" - } - dbFnameTmpDecompressed() - { - dburl=$1 - echo "${cfg.databaseDir}/.$(basename "$dburl")" | sed 's/\.\(gz\|xz\)$//' - } - dbFname() - { - dburl=$1 - echo "${cfg.databaseDir}/$(basename "$dburl")" | sed 's/\.\(gz\|xz\)$//' - } - downloadDb() - { - dburl=$1 - curl_out=$("${pkgs.curl.bin}/bin/curl" \ - --silent --fail --show-error --max-time 900 -L -o "$(dbFnameTmp "$dburl")" "$dburl" 2>&1) - if [ $? -ne 0 ]; then - error "Failed to download $dburl: $curl_out" - return 1 - fi - } - decompressDb() - { - fn=$(dbFnameTmp "$1") - ret=0 - case "$fn" in - *.gz) - cmd_out=$("${pkgs.gzip}/bin/gzip" --decompress --force "$fn" 2>&1) - ;; - *.xz) - cmd_out=$("${pkgs.xz.bin}/bin/xz" --decompress --force "$fn" 2>&1) - ;; - *) - cmd_out=$(echo "File \"$fn\" is neither a .gz nor .xz file") - false - ;; - esac - if [ $? -ne 0 ]; then - error "$cmd_out" - ret=1 - fi - } - atomicRename() - { - dburl=$1 - mv "$(dbFnameTmpDecompressed "$dburl")" "$(dbFname "$dburl")" - } - removeIfNotInConfig() - { - # Arg 1 is the full path of an installed DB. - # If the corresponding database is not specified in the NixOS config we - # remove it. - db=$1 - for cdb in ${lib.concatStringsSep " " cfg.databases}; do - confDb=$(echo "$cdb" | sed 's/\.\(gz\|xz\)$//') - if [ "$(basename "$db")" = "$(basename "$confDb")" ]; then - return 0 - fi - done - rm "$db" - if [ $? -eq 0 ]; then - debug "Removed $(basename "$db") (not listed in services.geoip-updater.databases)" - else - error "Failed to remove $db" - fi - } - removeUnspecifiedDbs() - { - for f in "${cfg.databaseDir}/"*; do - test -f "$f" || continue - case "$f" in - *.dat|*.mmdb|*.csv) - removeIfNotInConfig "$f" - ;; - *) - debug "Not removing \"$f\" (unknown file extension)" - ;; - esac - done - } - downloadAndInstall() - { - dburl=$1 - if [ "$skipExisting" -eq 1 -a -f "$(dbFname "$dburl")" ]; then - debug "Skipping existing file: $(dbFname "$dburl")" - return 0 - fi - downloadDb "$dburl" || return 1 - decompressDb "$dburl" || return 1 - atomicRename "$dburl" || return 1 - info "Updated $(basename "$(dbFname "$dburl")")" - } - for arg in "$@"; do - case "$arg" in - --skip-existing) - skipExisting=1 - info "Option --skip-existing is set: not updating existing databases" - ;; - *) - error "Unknown argument: $arg";; - esac - done - waitNetworkOnline || die "Network is down (${dbBaseUrl} is unreachable)" - test -d "${cfg.databaseDir}" || die "Database directory (${cfg.databaseDir}) doesn't exist" - debug "Starting update of GeoIP databases in ${cfg.databaseDir}" - all_ret=0 - for db in ${lib.concatStringsSep " \\\n " cfg.databases}; do - downloadAndInstall "${dbBaseUrl}/$db" || all_ret=1 - done - removeUnspecifiedDbs || all_ret=1 - if [ $all_ret -eq 0 ]; then - info "Completed GeoIP database update in ${cfg.databaseDir}" - else - error "Completed GeoIP database update in ${cfg.databaseDir}, with error(s)" - fi - # Hack to work around systemd journal race: - # https://github.com/systemd/systemd/issues/2913 - sleep 2 - exit $all_ret - ''; - -in - -{ - options = { - services.geoip-updater = { - enable = mkOption { - default = false; - type = types.bool; - description = '' - Whether to enable periodic downloading of GeoIP databases from - maxmind.com. You might want to enable this if you, for instance, use - ntopng or Wireshark. - ''; - }; - - interval = mkOption { - type = types.str; - default = "weekly"; - description = '' - Update the GeoIP databases at this time / interval. - The format is described in - <citerefentry><refentrytitle>systemd.time</refentrytitle> - <manvolnum>7</manvolnum></citerefentry>. - To prevent load spikes on maxmind.com, the timer interval is - randomized by an additional delay of ${randomizedTimerDelaySec} - seconds. Setting a shorter interval than this is not recommended. - ''; - }; - - databaseDir = mkOption { - type = types.path; - default = "/var/lib/geoip-databases"; - description = '' - Directory that will contain GeoIP databases. - ''; - }; - - databases = mkOption { - type = types.listOf types.str; - default = [ - "GeoLiteCountry/GeoIP.dat.gz" - "GeoIPv6.dat.gz" - "GeoLiteCity.dat.xz" - "GeoLiteCityv6-beta/GeoLiteCityv6.dat.gz" - "asnum/GeoIPASNum.dat.gz" - "asnum/GeoIPASNumv6.dat.gz" - "GeoLite2-Country.mmdb.gz" - "GeoLite2-City.mmdb.gz" - ]; - description = '' - Which GeoIP databases to update. The full URL is ${dbBaseUrl}/ + - <literal>the_database</literal>. - ''; - }; - - }; - - }; - - config = mkIf cfg.enable { - - assertions = [ - { assertion = (builtins.filter - (x: builtins.match ".*\\.(gz|xz)$" x == null) cfg.databases) == []; - message = '' - services.geoip-updater.databases supports only .gz and .xz databases. - - Current value: - ${toString cfg.databases} - - Offending element(s): - ${toString (builtins.filter (x: builtins.match ".*\\.(gz|xz)$" x == null) cfg.databases)}; - ''; - } - ]; - - users.users.geoip = { - group = "root"; - description = "GeoIP database updater"; - uid = config.ids.uids.geoip; - }; - - systemd.timers.geoip-updater = - { description = "GeoIP Updater Timer"; - partOf = [ "geoip-updater.service" ]; - wantedBy = [ "timers.target" ]; - timerConfig.OnCalendar = cfg.interval; - timerConfig.Persistent = "true"; - timerConfig.RandomizedDelaySec = randomizedTimerDelaySec; - }; - - systemd.services.geoip-updater = { - description = "GeoIP Updater"; - after = [ "network-online.target" "nss-lookup.target" ]; - wants = [ "network-online.target" ]; - preStart = '' - mkdir -p "${cfg.databaseDir}" - chmod 755 "${cfg.databaseDir}" - chown geoip:root "${cfg.databaseDir}" - ''; - serviceConfig = { - ExecStart = "${geoip-updater}/bin/geoip-updater"; - User = "geoip"; - PermissionsStartOnly = true; - }; - }; - - systemd.services.geoip-updater-setup = { - description = "GeoIP Updater Setup"; - after = [ "network-online.target" "nss-lookup.target" ]; - wants = [ "network-online.target" ]; - wantedBy = [ "multi-user.target" ]; - conflicts = [ "geoip-updater.service" ]; - preStart = '' - mkdir -p "${cfg.databaseDir}" - chmod 755 "${cfg.databaseDir}" - chown geoip:root "${cfg.databaseDir}" - ''; - serviceConfig = { - ExecStart = "${geoip-updater}/bin/geoip-updater --skip-existing"; - User = "geoip"; - PermissionsStartOnly = true; - # So it won't be (needlessly) restarted: - RemainAfterExit = true; - }; - }; - - }; -} diff --git a/nixos/modules/services/misc/geoipupdate.nix b/nixos/modules/services/misc/geoipupdate.nix new file mode 100644 index 00000000000..3211d4d88e4 --- /dev/null +++ b/nixos/modules/services/misc/geoipupdate.nix @@ -0,0 +1,187 @@ +{ config, lib, pkgs, ... }: + +let + cfg = config.services.geoipupdate; +in +{ + imports = [ + (lib.mkRemovedOptionModule [ "services" "geoip-updater" ] "services.geoip-updater has been removed, use services.geoipupdate instead.") + ]; + + options = { + services.geoipupdate = { + enable = lib.mkEnableOption '' + periodic downloading of GeoIP databases using + <productname>geoipupdate</productname>. + ''; + + interval = lib.mkOption { + type = lib.types.str; + default = "weekly"; + description = '' + Update the GeoIP databases at this time / interval. + The format is described in + <citerefentry><refentrytitle>systemd.time</refentrytitle> + <manvolnum>7</manvolnum></citerefentry>. + ''; + }; + + settings = lib.mkOption { + description = '' + <productname>geoipupdate</productname> configuration + options. See + <link xlink:href="https://github.com/maxmind/geoipupdate/blob/main/doc/GeoIP.conf.md" /> + for a full list of available options. + ''; + type = lib.types.submodule { + freeformType = + with lib.types; + let + type = oneOf [str int bool]; + in + attrsOf (either type (listOf type)); + + options = { + + AccountID = lib.mkOption { + type = lib.types.int; + description = '' + Your MaxMind account ID. + ''; + }; + + EditionIDs = lib.mkOption { + type = with lib.types; listOf (either str int); + example = [ + "GeoLite2-ASN" + "GeoLite2-City" + "GeoLite2-Country" + ]; + description = '' + List of database edition IDs. This includes new string + IDs like <literal>GeoIP2-City</literal> and old + numeric IDs like <literal>106</literal>. + ''; + }; + + LicenseKey = lib.mkOption { + type = lib.types.path; + description = '' + A file containing the <productname>MaxMind</productname> + license key. + ''; + }; + + DatabaseDirectory = lib.mkOption { + type = lib.types.path; + default = "/var/lib/GeoIP"; + example = "/run/GeoIP"; + description = '' + The directory to store the database files in. The + directory will be automatically created, the owner + changed to <literal>geoip</literal> and permissions + set to world readable. This applies if the directory + already exists as well, so don't use a directory with + sensitive contents. + ''; + }; + + }; + }; + }; + }; + + }; + + config = lib.mkIf cfg.enable { + + services.geoipupdate.settings = { + LockFile = "/run/geoipupdate/.lock"; + }; + + systemd.services.geoipupdate-create-db-dir = { + serviceConfig.Type = "oneshot"; + script = '' + mkdir -p ${cfg.settings.DatabaseDirectory} + chmod 0755 ${cfg.settings.DatabaseDirectory} + ''; + }; + + systemd.services.geoipupdate = { + description = "GeoIP Updater"; + requires = [ "geoipupdate-create-db-dir.service" ]; + after = [ + "geoipupdate-create-db-dir.service" + "network-online.target" + "nss-lookup.target" + ]; + wants = [ "network-online.target" ]; + startAt = cfg.interval; + serviceConfig = { + ExecStartPre = + let + geoipupdateKeyValue = lib.generators.toKeyValue { + mkKeyValue = lib.flip lib.generators.mkKeyValueDefault " " rec { + mkValueString = v: with builtins; + if isInt v then toString v + else if isString v then v + else if true == v then "1" + else if false == v then "0" + else if isList v then lib.concatMapStringsSep " " mkValueString v + else throw "unsupported type ${typeOf v}: ${(lib.generators.toPretty {}) v}"; + }; + }; + + geoipupdateConf = pkgs.writeText "geoipupdate.conf" (geoipupdateKeyValue cfg.settings); + + script = '' + chown geoip "${cfg.settings.DatabaseDirectory}" + + cp ${geoipupdateConf} /run/geoipupdate/GeoIP.conf + ${pkgs.replace-secret}/bin/replace-secret '${cfg.settings.LicenseKey}' \ + '${cfg.settings.LicenseKey}' \ + /run/geoipupdate/GeoIP.conf + ''; + in + "+${pkgs.writeShellScript "start-pre-full-privileges" script}"; + ExecStart = "${pkgs.geoipupdate}/bin/geoipupdate -f /run/geoipupdate/GeoIP.conf"; + User = "geoip"; + DynamicUser = true; + ReadWritePaths = cfg.settings.DatabaseDirectory; + RuntimeDirectory = "geoipupdate"; + RuntimeDirectoryMode = 0700; + CapabilityBoundingSet = ""; + PrivateDevices = true; + PrivateMounts = true; + PrivateUsers = true; + ProtectClock = true; + ProtectControlGroups = true; + ProtectHome = true; + ProtectHostname = true; + ProtectKernelLogs = true; + ProtectKernelModules = true; + ProtectKernelTunables = true; + ProtectProc = "invisible"; + ProcSubset = "pid"; + SystemCallFilter = [ "@system-service" "~@privileged" "~@resources" ]; + RestrictAddressFamilies = [ "AF_INET" "AF_INET6" ]; + RestrictRealtime = true; + RestrictNamespaces = true; + MemoryDenyWriteExecute = true; + LockPersonality = true; + SystemCallArchitectures = "native"; + }; + }; + + systemd.timers.geoipupdate-initial-run = { + wantedBy = [ "timers.target" ]; + unitConfig.ConditionPathExists = "!${cfg.settings.DatabaseDirectory}"; + timerConfig = { + Unit = "geoipupdate.service"; + OnActiveSec = 0; + }; + }; + }; + + meta.maintainers = [ lib.maintainers.talyz ]; +} diff --git a/nixos/modules/services/misc/gitea.nix b/nixos/modules/services/misc/gitea.nix index 95369ff7ee4..b6c1ca3e61a 100644 --- a/nixos/modules/services/misc/gitea.nix +++ b/nixos/modules/services/misc/gitea.nix @@ -82,7 +82,7 @@ in }; port = mkOption { - type = types.int; + type = types.port; default = (if !usePostgresql then 3306 else pg.port); description = "Database host port."; }; diff --git a/nixos/modules/services/misc/gitlab.nix b/nixos/modules/services/misc/gitlab.nix index 253d87537cf..1514cc0665d 100644 --- a/nixos/modules/services/misc/gitlab.nix +++ b/nixos/modules/services/misc/gitlab.nix @@ -10,7 +10,7 @@ let postgresqlPackage = if config.services.postgresql.enable then config.services.postgresql.package else - pkgs.postgresql; + pkgs.postgresql_12; gitlabSocket = "${cfg.statePath}/tmp/sockets/gitlab.socket"; gitalySocket = "${cfg.statePath}/tmp/sockets/gitaly.socket"; @@ -140,12 +140,20 @@ let port = 3807; }; }; + registry = lib.optionalAttrs cfg.registry.enable { + enabled = true; + host = cfg.registry.externalAddress; + port = cfg.registry.externalPort; + key = cfg.registry.keyFile; + api_url = "http://${config.services.dockerRegistry.listenAddress}:${toString config.services.dockerRegistry.port}/"; + issuer = "gitlab-issuer"; + }; extra = {}; uploads.storage_path = cfg.statePath; }; }; - gitlabEnv = { + gitlabEnv = cfg.packages.gitlab.gitlabEnv // { HOME = "${cfg.statePath}/home"; PUMA_PATH = "${cfg.statePath}/"; GITLAB_PATH = "${cfg.packages.gitlab}/share/gitlab/"; @@ -156,7 +164,7 @@ let prometheus_multiproc_dir = "/run/gitlab"; RAILS_ENV = "production"; MALLOC_ARENA_MAX = "2"; - }; + } // cfg.extraEnv; gitlab-rake = pkgs.stdenv.mkDerivation { name = "gitlab-rake"; @@ -277,6 +285,14 @@ in { ''; }; + extraEnv = mkOption { + type = types.attrsOf types.str; + default = {}; + description = '' + Additional environment variables for the GitLab environment. + ''; + }; + backup.startAt = mkOption { type = with types; either str (listOf str); default = []; @@ -462,7 +478,7 @@ in { }; port = mkOption { - type = types.int; + type = types.port; default = 8080; description = '' GitLab server port for copy-paste URLs, e.g. 80 or 443 if you're @@ -508,6 +524,58 @@ in { ''; }; + registry = { + enable = mkOption { + type = types.bool; + default = false; + description = "Enable GitLab container registry."; + }; + host = mkOption { + type = types.str; + default = config.services.gitlab.host; + description = "GitLab container registry host name."; + }; + port = mkOption { + type = types.int; + default = 4567; + description = "GitLab container registry port."; + }; + certFile = mkOption { + type = types.path; + default = null; + description = "Path to GitLab container registry certificate."; + }; + keyFile = mkOption { + type = types.path; + default = null; + description = "Path to GitLab container registry certificate-key."; + }; + defaultForProjects = mkOption { + type = types.bool; + default = cfg.registry.enable; + description = "If GitLab container registry should be enabled by default for projects."; + }; + issuer = mkOption { + type = types.str; + default = "gitlab-issuer"; + description = "GitLab container registry issuer."; + }; + serviceName = mkOption { + type = types.str; + default = "container_registry"; + description = "GitLab container registry service name."; + }; + externalAddress = mkOption { + type = types.str; + default = ""; + description = "External address used to access registry from the internet"; + }; + externalPort = mkOption { + type = types.int; + description = "External port used to access registry from the internet"; + }; + }; + smtp = { enable = mkOption { type = types.bool; @@ -841,6 +909,10 @@ in { assertion = cfg.secrets.jwsFile != null; message = "services.gitlab.secrets.jwsFile must be set!"; } + { + assertion = versionAtLeast postgresqlPackage.version "12.0.0"; + message = "PostgreSQL >=12 is required to run GitLab 14. Follow the instructions in the manual section for upgrading PostgreSQL here: https://nixos.org/manual/nixos/stable/index.html#module-services-postgres-upgrading"; + } ]; environment.systemPackages = [ pkgs.git gitlab-rake gitlab-rails cfg.packages.gitlab-shell ]; @@ -901,6 +973,44 @@ in { }; }; + systemd.services.gitlab-registry-cert = optionalAttrs cfg.registry.enable { + path = with pkgs; [ openssl ]; + + script = '' + mkdir -p $(dirname ${cfg.registry.keyFile}) + mkdir -p $(dirname ${cfg.registry.certFile}) + openssl req -nodes -newkey rsa:4096 -keyout ${cfg.registry.keyFile} -out /tmp/registry-auth.csr -subj "/CN=${cfg.registry.issuer}" + openssl x509 -in /tmp/registry-auth.csr -out ${cfg.registry.certFile} -req -signkey ${cfg.registry.keyFile} -days 3650 + chown ${cfg.user}:${cfg.group} $(dirname ${cfg.registry.keyFile}) + chown ${cfg.user}:${cfg.group} $(dirname ${cfg.registry.certFile}) + chown ${cfg.user}:${cfg.group} ${cfg.registry.keyFile} + chown ${cfg.user}:${cfg.group} ${cfg.registry.certFile} + ''; + + serviceConfig = { + ConditionPathExists = "!${cfg.registry.certFile}"; + }; + }; + + # Ensure Docker Registry launches after the certificate generation job + systemd.services.docker-registry = optionalAttrs cfg.registry.enable { + wants = [ "gitlab-registry-cert.service" ]; + }; + + # Enable Docker Registry, if GitLab-Container Registry is enabled + services.dockerRegistry = optionalAttrs cfg.registry.enable { + enable = true; + enableDelete = true; # This must be true, otherwise GitLab won't manage it correctly + extraConfig = { + auth.token = { + realm = "http${if cfg.https == true then "s" else ""}://${cfg.host}/jwt/auth"; + service = cfg.registry.serviceName; + issuer = cfg.registry.issuer; + rootcertbundle = cfg.registry.certFile; + }; + }; + }; + # Use postfix to send out mails. services.postfix.enable = mkDefault (cfg.smtp.enable && cfg.smtp.address == "localhost"); diff --git a/nixos/modules/services/misc/gpsd.nix b/nixos/modules/services/misc/gpsd.nix index f954249942a..fafea10daba 100644 --- a/nixos/modules/services/misc/gpsd.nix +++ b/nixos/modules/services/misc/gpsd.nix @@ -62,7 +62,7 @@ in }; port = mkOption { - type = types.int; + type = types.port; default = 2947; description = '' The port where to listen for TCP connections. diff --git a/nixos/modules/services/misc/home-assistant.nix b/nixos/modules/services/misc/home-assistant.nix index 1e33381de24..dcd825bba43 100644 --- a/nixos/modules/services/misc/home-assistant.nix +++ b/nixos/modules/services/misc/home-assistant.nix @@ -66,7 +66,9 @@ in { meta.maintainers = teams.home-assistant.members; options.services.home-assistant = { - enable = mkEnableOption "Home Assistant"; + # Running home-assistant on NixOS is considered an installation method that is unsupported by the upstream project. + # https://github.com/home-assistant/architecture/blob/master/adr/0012-define-supported-installation-method.md#decision + enable = mkEnableOption "Home Assistant. Please note that this installation method is unsupported upstream"; configDir = mkOption { default = "/var/lib/hass"; @@ -266,6 +268,53 @@ in { "CAP_NET_BIND_SERVICE" "CAP_NET_RAW" ])); + componentsUsingBluetooth = [ + # Components that require the AF_BLUETOOTH address family + "bluetooth_tracker" + "bluetooth_le_tracker" + ]; + componentsUsingSerialDevices = [ + # Components that require access to serial devices (/dev/tty*) + # List generated from home-assistant documentation: + # git clone https://github.com/home-assistant/home-assistant.io/ + # cd source/_integrations + # rg "/dev/tty" -l | cut -d'/' -f3 | cut -d'.' -f1 | sort + # And then extended by references found in the source code, these + # mostly the ones using config flows already. + "acer_projector" + "alarmdecoder" + "arduino" + "blackbird" + "dsmr" + "edl21" + "elkm1" + "elv" + "enocean" + "firmata" + "flexit" + "gpsd" + "insteon" + "kwb" + "lacrosse" + "mhz19" + "modbus" + "modem_callerid" + "mysensors" + "nad" + "numato" + "rflink" + "rfxtrx" + "scsgate" + "serial" + "serial_pm" + "sms" + "upb" + "velbus" + "w800rf32" + "xbee" + "zha" + "zwave" + ]; in { ExecStart = "${package}/bin/hass --runner --config '${cfg.configDir}'"; ExecReload = "${pkgs.coreutils}/bin/kill -HUP $MAINPID"; @@ -279,11 +328,11 @@ in { # Hardening AmbientCapabilities = capabilities; CapabilityBoundingSet = capabilities; - DeviceAllow = [ + DeviceAllow = (optionals (any useComponent componentsUsingSerialDevices) [ "char-ttyACM rw" "char-ttyAMA rw" "char-ttyUSB rw" - ]; + ]); DevicePolicy = "closed"; LockPersonality = true; MemoryDenyWriteExecute = true; @@ -312,13 +361,15 @@ in { "AF_INET6" "AF_NETLINK" "AF_UNIX" - ] ++ optionals (useComponent "bluetooth_tracker" || useComponent "bluetooth_le_tracker") [ + ] ++ optionals (any useComponent componentsUsingBluetooth) [ "AF_BLUETOOTH" ]; RestrictNamespaces = true; RestrictRealtime = true; RestrictSUIDSGID = true; - SupplementaryGroups = [ "dialout" ]; + SupplementaryGroups = optionals (any useComponent componentsUsingSerialDevices) [ + "dialout" + ]; SystemCallArchitectures = "native"; SystemCallFilter = [ "@system-service" diff --git a/nixos/modules/services/misc/klipper.nix b/nixos/modules/services/misc/klipper.nix index 2f04c011a65..909408225e0 100644 --- a/nixos/modules/services/misc/klipper.nix +++ b/nixos/modules/services/misc/klipper.nix @@ -2,8 +2,13 @@ with lib; let cfg = config.services.klipper; - package = pkgs.klipper; - format = pkgs.formats.ini { mkKeyValue = generators.mkKeyValueDefault {} ":"; }; + format = pkgs.formats.ini { + # https://github.com/NixOS/nixpkgs/pull/121613#issuecomment-885241996 + listToValue = l: + if builtins.length l == 1 then generators.mkValueStringDefault {} (head l) + else lib.concatMapStrings (s: "\n ${generators.mkValueStringDefault {} s}") l; + mkKeyValue = generators.mkKeyValueDefault {} ":"; + }; in { ##### interface @@ -11,12 +16,51 @@ in services.klipper = { enable = mkEnableOption "Klipper, the 3D printer firmware"; + package = mkOption { + type = types.package; + default = pkgs.klipper; + description = "The Klipper package."; + }; + + inputTTY = mkOption { + type = types.path; + default = "/run/klipper/tty"; + description = "Path of the virtual printer symlink to create."; + }; + + apiSocket = mkOption { + type = types.nullOr types.path; + default = null; + example = "/run/klipper/api"; + description = "Path of the API socket to create."; + }; + octoprintIntegration = mkOption { type = types.bool; default = false; description = "Allows Octoprint to control Klipper."; }; + user = mkOption { + type = types.nullOr types.str; + default = null; + description = '' + User account under which Klipper runs. + + If null is specified (default), a temporary user will be created by systemd. + ''; + }; + + group = mkOption { + type = types.nullOr types.str; + default = null; + description = '' + Group account under which Klipper runs. + + If null is specified (default), a temporary user will be created by systemd. + ''; + }; + settings = mkOption { type = format.type; default = { }; @@ -30,26 +74,40 @@ in ##### implementation config = mkIf cfg.enable { - assertions = [{ - assertion = cfg.octoprintIntegration -> config.services.octoprint.enable; - message = "Option klipper.octoprintIntegration requires Octoprint to be enabled on this system. Please enable services.octoprint to use it."; - }]; + assertions = [ + { + assertion = cfg.octoprintIntegration -> config.services.octoprint.enable; + message = "Option klipper.octoprintIntegration requires Octoprint to be enabled on this system. Please enable services.octoprint to use it."; + } + { + assertion = cfg.user != null -> cfg.group != null; + message = "Option klipper.group is not set when a user is specified."; + } + ]; environment.etc."klipper.cfg".source = format.generate "klipper.cfg" cfg.settings; - systemd.services.klipper = { + services.klipper = mkIf cfg.octoprintIntegration { + user = config.services.octoprint.user; + group = config.services.octoprint.group; + }; + + systemd.services.klipper = let + klippyArgs = "--input-tty=${cfg.inputTTY}" + + optionalString (cfg.apiSocket != null) " --api-server=${cfg.apiSocket}"; + in { description = "Klipper 3D Printer Firmware"; wantedBy = [ "multi-user.target" ]; after = [ "network.target" ]; serviceConfig = { - ExecStart = "${package}/lib/klipper/klippy.py --input-tty=/run/klipper/tty /etc/klipper.cfg"; + ExecStart = "${cfg.package}/lib/klipper/klippy.py ${klippyArgs} /etc/klipper.cfg"; RuntimeDirectory = "klipper"; SupplementaryGroups = [ "dialout" ]; - WorkingDirectory = "${package}/lib"; - } // (if cfg.octoprintIntegration then { - Group = config.services.octoprint.group; - User = config.services.octoprint.user; + WorkingDirectory = "${cfg.package}/lib"; + } // (if cfg.user != null then { + Group = cfg.group; + User = cfg.user; } else { DynamicUser = true; User = "klipper"; diff --git a/nixos/modules/services/misc/leaps.nix b/nixos/modules/services/misc/leaps.nix index ef89d3e64d0..f797218522c 100644 --- a/nixos/modules/services/misc/leaps.nix +++ b/nixos/modules/services/misc/leaps.nix @@ -11,7 +11,7 @@ in services.leaps = { enable = mkEnableOption "leaps"; port = mkOption { - type = types.int; + type = types.port; default = 8080; description = "A port where leaps listens for incoming http requests"; }; diff --git a/nixos/modules/services/misc/matrix-synapse.nix b/nixos/modules/services/misc/matrix-synapse.nix index dff58745304..3c734a94819 100644 --- a/nixos/modules/services/misc/matrix-synapse.nix +++ b/nixos/modules/services/misc/matrix-synapse.nix @@ -143,6 +143,13 @@ in { List of additional Matrix plugins to make available. ''; }; + withJemalloc = mkOption { + type = types.bool; + default = false; + description = '' + Whether to preload jemalloc to reduce memory fragmentation and overall usage. + ''; + }; no_tls = mkOption { type = types.bool; default = false; @@ -231,7 +238,7 @@ in { type = types.listOf (types.submodule { options = { port = mkOption { - type = types.int; + type = types.port; example = 8448; description = '' The port to listen for HTTP(S) requests on. @@ -720,7 +727,11 @@ in { --keys-directory ${cfg.dataDir} \ --generate-keys ''; - environment.PYTHONPATH = makeSearchPathOutput "lib" cfg.package.python.sitePackages [ pluginsEnv ]; + environment = { + PYTHONPATH = makeSearchPathOutput "lib" cfg.package.python.sitePackages [ pluginsEnv ]; + } // optionalAttrs (cfg.withJemalloc) { + LD_PRELOAD = "${pkgs.jemalloc}/lib/libjemalloc.so"; + }; serviceConfig = { Type = "notify"; User = "matrix-synapse"; diff --git a/nixos/modules/services/misc/mwlib.nix b/nixos/modules/services/misc/mwlib.nix index 6b41b552a86..8dd17c06c0b 100644 --- a/nixos/modules/services/misc/mwlib.nix +++ b/nixos/modules/services/misc/mwlib.nix @@ -34,7 +34,7 @@ in port = mkOption { default = 8899; - type = types.int; + type = types.port; description = "Specify port to listen on."; }; # nserve.port @@ -68,7 +68,7 @@ in port = mkOption { default = 14311; - type = types.int; + type = types.port; description = "Specify port to listen on."; }; # qserve.port @@ -137,7 +137,7 @@ in port = mkOption { default = 8898; - type = types.int; + type = types.port; description = "Port to listen to when serving files from cache."; }; # nslave.http.port diff --git a/nixos/modules/services/misc/octoprint.nix b/nixos/modules/services/misc/octoprint.nix index 5a64946f9f6..c926d889b37 100644 --- a/nixos/modules/services/misc/octoprint.nix +++ b/nixos/modules/services/misc/octoprint.nix @@ -40,7 +40,7 @@ in }; port = mkOption { - type = types.int; + type = types.port; default = 5000; description = '' Port to bind OctoPrint to. diff --git a/nixos/modules/services/misc/paperless.nix b/nixos/modules/services/misc/paperless.nix index bfaf760fb83..43730b80eb2 100644 --- a/nixos/modules/services/misc/paperless.nix +++ b/nixos/modules/services/misc/paperless.nix @@ -67,7 +67,7 @@ in }; port = mkOption { - type = types.int; + type = types.port; default = 28981; description = "Server port to listen on."; }; diff --git a/nixos/modules/services/misc/redmine.nix b/nixos/modules/services/misc/redmine.nix index e0055576d6f..66c8e558fb0 100644 --- a/nixos/modules/services/misc/redmine.nix +++ b/nixos/modules/services/misc/redmine.nix @@ -71,7 +71,7 @@ in }; port = mkOption { - type = types.int; + type = types.port; default = 3000; description = "Port on which Redmine is ran."; }; diff --git a/nixos/modules/services/misc/sdrplay.nix b/nixos/modules/services/misc/sdrplay.nix new file mode 100644 index 00000000000..2801108f082 --- /dev/null +++ b/nixos/modules/services/misc/sdrplay.nix @@ -0,0 +1,35 @@ +{ config, lib, pkgs, ... }: +with lib; +{ + options.services.sdrplayApi = { + enable = mkOption { + default = false; + example = true; + description = '' + Whether to enable the SDRplay API service and udev rules. + + <note><para> + To enable integration with SoapySDR and GUI applications like gqrx create an overlay containing + <literal>soapysdr-with-plugins = super.soapysdr.override { extraPackages = [ super.soapysdrplay ]; };</literal> + </para></note> + ''; + type = lib.types.bool; + }; + }; + + config = mkIf config.services.sdrplayApi.enable { + systemd.services.sdrplayApi = { + description = "SDRplay API Service"; + after = [ "network.target" ]; + wantedBy = [ "multi-user.target" ]; + serviceConfig = { + ExecStart = "${pkgs.sdrplay}/bin/sdrplay_apiService"; + DynamicUser = true; + Restart = "on-failure"; + RestartSec = "1s"; + }; + }; + services.udev.packages = [ pkgs.sdrplay ]; + + }; +} diff --git a/nixos/modules/services/misc/sourcehut/builds.nix b/nixos/modules/services/misc/sourcehut/builds.nix new file mode 100644 index 00000000000..a17a1010dbf --- /dev/null +++ b/nixos/modules/services/misc/sourcehut/builds.nix @@ -0,0 +1,234 @@ +{ config, lib, pkgs, ... }: + +with lib; +let + cfg = config.services.sourcehut; + scfg = cfg.builds; + rcfg = config.services.redis; + iniKey = "builds.sr.ht"; + + drv = pkgs.sourcehut.buildsrht; +in +{ + options.services.sourcehut.builds = { + user = mkOption { + type = types.str; + default = "buildsrht"; + description = '' + User for builds.sr.ht. + ''; + }; + + port = mkOption { + type = types.port; + default = 5002; + description = '' + Port on which the "builds" module should listen. + ''; + }; + + database = mkOption { + type = types.str; + default = "builds.sr.ht"; + description = '' + PostgreSQL database name for builds.sr.ht. + ''; + }; + + statePath = mkOption { + type = types.path; + default = "${cfg.statePath}/buildsrht"; + description = '' + State path for builds.sr.ht. + ''; + }; + + enableWorker = mkOption { + type = types.bool; + default = false; + description = '' + Run workers for builds.sr.ht. + ''; + }; + + images = mkOption { + type = types.attrsOf (types.attrsOf (types.attrsOf types.package)); + default = { }; + example = lib.literalExample ''(let + # Pinning unstable to allow usage with flakes and limit rebuilds. + pkgs_unstable = builtins.fetchGit { + url = "https://github.com/NixOS/nixpkgs"; + rev = "ff96a0fa5635770390b184ae74debea75c3fd534"; + ref = "nixos-unstable"; + }; + image_from_nixpkgs = pkgs_unstable: (import ("${pkgs.sourcehut.buildsrht}/lib/images/nixos/image.nix") { + pkgs = (import pkgs_unstable {}); + }); + in + { + nixos.unstable.x86_64 = image_from_nixpkgs pkgs_unstable; + } + )''; + description = '' + Images for builds.sr.ht. Each package should be distro.release.arch and point to a /nix/store/package/root.img.qcow2. + ''; + }; + + }; + + config = with scfg; let + image_dirs = lib.lists.flatten ( + lib.attrsets.mapAttrsToList + (distro: revs: + lib.attrsets.mapAttrsToList + (rev: archs: + lib.attrsets.mapAttrsToList + (arch: image: + pkgs.runCommandNoCC "buildsrht-images" { } '' + mkdir -p $out/${distro}/${rev}/${arch} + ln -s ${image}/*.qcow2 $out/${distro}/${rev}/${arch}/root.img.qcow2 + '') + archs) + revs) + scfg.images); + image_dir_pre = pkgs.symlinkJoin { + name = "builds.sr.ht-worker-images-pre"; + paths = image_dirs ++ [ + "${pkgs.sourcehut.buildsrht}/lib/images" + ]; + }; + image_dir = pkgs.runCommandNoCC "builds.sr.ht-worker-images" { } '' + mkdir -p $out/images + cp -Lr ${image_dir_pre}/* $out/images + ''; + in + lib.mkIf (cfg.enable && elem "builds" cfg.services) { + users = { + users = { + "${user}" = { + isSystemUser = true; + group = user; + extraGroups = lib.optionals cfg.builds.enableWorker [ "docker" ]; + description = "builds.sr.ht user"; + }; + }; + + groups = { + "${user}" = { }; + }; + }; + + services.postgresql = { + authentication = '' + local ${database} ${user} trust + ''; + ensureDatabases = [ database ]; + ensureUsers = [ + { + name = user; + ensurePermissions = { "DATABASE \"${database}\"" = "ALL PRIVILEGES"; }; + } + ]; + }; + + systemd = { + tmpfiles.rules = [ + "d ${statePath} 0755 ${user} ${user} -" + ] ++ (lib.optionals cfg.builds.enableWorker + [ "d ${statePath}/logs 0775 ${user} ${user} - -" ] + ); + + services = { + buildsrht = import ./service.nix { inherit config pkgs lib; } scfg drv iniKey + { + after = [ "postgresql.service" "network.target" ]; + requires = [ "postgresql.service" ]; + wantedBy = [ "multi-user.target" ]; + + description = "builds.sr.ht website service"; + + serviceConfig.ExecStart = "${cfg.python}/bin/gunicorn ${drv.pname}.app:app -b ${cfg.address}:${toString port}"; + + # Hack to bypass this hack: https://git.sr.ht/~sircmpwn/core.sr.ht/tree/master/item/srht-update-profiles#L6 + } // { preStart = " "; }; + + buildsrht-worker = { + enable = scfg.enableWorker; + after = [ "postgresql.service" "network.target" ]; + requires = [ "postgresql.service" ]; + wantedBy = [ "multi-user.target" ]; + partOf = [ "buildsrht.service" ]; + description = "builds.sr.ht worker service"; + path = [ pkgs.openssh pkgs.docker ]; + preStart = let qemuPackage = pkgs.qemu_kvm; + in '' + if [[ "$(docker images -q qemu:latest 2> /dev/null)" == "" || "$(cat ${statePath}/docker-image-qemu 2> /dev/null || true)" != "${qemuPackage.version}" ]]; then + # Create and import qemu:latest image for docker + ${ + pkgs.dockerTools.streamLayeredImage { + name = "qemu"; + tag = "latest"; + contents = [ qemuPackage ]; + } + } | docker load + # Mark down current package version + printf "%s" "${qemuPackage.version}" > ${statePath}/docker-image-qemu + fi + ''; + serviceConfig = { + Type = "simple"; + User = user; + Group = "nginx"; + Restart = "always"; + }; + serviceConfig.ExecStart = "${pkgs.sourcehut.buildsrht}/bin/builds.sr.ht-worker"; + }; + }; + }; + + services.sourcehut.settings = { + # URL builds.sr.ht is being served at (protocol://domain) + "builds.sr.ht".origin = mkDefault "http://builds.${cfg.originBase}"; + # Address and port to bind the debug server to + "builds.sr.ht".debug-host = mkDefault "0.0.0.0"; + "builds.sr.ht".debug-port = mkDefault port; + # Configures the SQLAlchemy connection string for the database. + "builds.sr.ht".connection-string = mkDefault "postgresql:///${database}?user=${user}&host=/var/run/postgresql"; + # Set to "yes" to automatically run migrations on package upgrade. + "builds.sr.ht".migrate-on-upgrade = mkDefault "yes"; + # builds.sr.ht's OAuth client ID and secret for meta.sr.ht + # Register your client at meta.example.org/oauth + "builds.sr.ht".oauth-client-id = mkDefault null; + "builds.sr.ht".oauth-client-secret = mkDefault null; + # The redis connection used for the celery worker + "builds.sr.ht".redis = mkDefault "redis://${rcfg.bind}:${toString rcfg.port}/3"; + # The shell used for ssh + "builds.sr.ht".shell = mkDefault "runner-shell"; + # Register the builds.sr.ht dispatcher + "git.sr.ht::dispatch".${builtins.unsafeDiscardStringContext "${pkgs.sourcehut.buildsrht}/bin/buildsrht-keys"} = mkDefault "${user}:${user}"; + + # Location for build logs, images, and control command + } // lib.attrsets.optionalAttrs scfg.enableWorker { + # Default worker stores logs that are accessible via this address:port + "builds.sr.ht::worker".name = mkDefault "127.0.0.1:5020"; + "builds.sr.ht::worker".buildlogs = mkDefault "${scfg.statePath}/logs"; + "builds.sr.ht::worker".images = mkDefault "${image_dir}/images"; + "builds.sr.ht::worker".controlcmd = mkDefault "${image_dir}/images/control"; + "builds.sr.ht::worker".timeout = mkDefault "3m"; + }; + + services.nginx.virtualHosts."logs.${cfg.originBase}" = + if scfg.enableWorker then { + listen = with builtins; let address = split ":" cfg.settings."builds.sr.ht::worker".name; + in [{ addr = elemAt address 0; port = lib.toInt (elemAt address 2); }]; + locations."/logs".root = "${scfg.statePath}"; + } else { }; + + services.nginx.virtualHosts."builds.${cfg.originBase}" = { + forceSSL = true; + locations."/".proxyPass = "http://${cfg.address}:${toString port}"; + locations."/query".proxyPass = "http://${cfg.address}:${toString (port + 100)}"; + locations."/static".root = "${pkgs.sourcehut.buildsrht}/${pkgs.sourcehut.python.sitePackages}/buildsrht"; + }; + }; +} diff --git a/nixos/modules/services/misc/sourcehut/default.nix b/nixos/modules/services/misc/sourcehut/default.nix new file mode 100644 index 00000000000..9c812d6b043 --- /dev/null +++ b/nixos/modules/services/misc/sourcehut/default.nix @@ -0,0 +1,198 @@ +{ config, pkgs, lib, ... }: + +with lib; +let + cfg = config.services.sourcehut; + cfgIni = cfg.settings; + settingsFormat = pkgs.formats.ini { }; + + # Specialized python containing all the modules + python = pkgs.sourcehut.python.withPackages (ps: with ps; [ + gunicorn + # Sourcehut services + srht + buildsrht + dispatchsrht + gitsrht + hgsrht + hubsrht + listssrht + mansrht + metasrht + pastesrht + todosrht + ]); +in +{ + imports = + [ + ./git.nix + ./hg.nix + ./hub.nix + ./todo.nix + ./man.nix + ./meta.nix + ./paste.nix + ./builds.nix + ./lists.nix + ./dispatch.nix + (mkRemovedOptionModule [ "services" "sourcehut" "nginx" "enable" ] '' + The sourcehut module supports `nginx` as a local reverse-proxy by default and doesn't + support other reverse-proxies officially. + + However it's possible to use an alternative reverse-proxy by + + * disabling nginx + * adjusting the relevant settings for server addresses and ports directly + + Further details about this can be found in the `Sourcehut`-section of the NixOS-manual. + '') + ]; + + options.services.sourcehut = { + enable = mkOption { + type = types.bool; + default = false; + description = '' + Enable sourcehut - git hosting, continuous integration, mailing list, ticket tracking, + task dispatching, wiki and account management services + ''; + }; + + services = mkOption { + type = types.nonEmptyListOf (types.enum [ "builds" "dispatch" "git" "hub" "hg" "lists" "man" "meta" "paste" "todo" ]); + default = [ "man" "meta" "paste" ]; + example = [ "builds" "dispatch" "git" "hub" "hg" "lists" "man" "meta" "paste" "todo" ]; + description = '' + Services to enable on the sourcehut network. + ''; + }; + + originBase = mkOption { + type = types.str; + default = with config.networking; hostName + lib.optionalString (domain != null) ".${domain}"; + description = '' + Host name used by reverse-proxy and for default settings. Will host services at git."''${originBase}". For example: git.sr.ht + ''; + }; + + address = mkOption { + type = types.str; + default = "127.0.0.1"; + description = '' + Address to bind to. + ''; + }; + + python = mkOption { + internal = true; + type = types.package; + default = python; + description = '' + The python package to use. It should contain references to the *srht modules and also + gunicorn. + ''; + }; + + statePath = mkOption { + type = types.path; + default = "/var/lib/sourcehut"; + description = '' + Root state path for the sourcehut network. If left as the default value + this directory will automatically be created before the sourcehut server + starts, otherwise the sysadmin is responsible for ensuring the + directory exists with appropriate ownership and permissions. + ''; + }; + + settings = mkOption { + type = lib.types.submodule { + freeformType = settingsFormat.type; + }; + default = { }; + description = '' + The configuration for the sourcehut network. + ''; + }; + }; + + config = mkIf cfg.enable { + assertions = + [ + { + assertion = with cfgIni.webhooks; private-key != null && stringLength private-key == 44; + message = "The webhook's private key must be defined and of a 44 byte length."; + } + + { + assertion = hasAttrByPath [ "meta.sr.ht" "origin" ] cfgIni && cfgIni."meta.sr.ht".origin != null; + message = "meta.sr.ht's origin must be defined."; + } + ]; + + virtualisation.docker.enable = true; + environment.etc."sr.ht/config.ini".source = + settingsFormat.generate "sourcehut-config.ini" (mapAttrsRecursive + ( + path: v: if v == null then "" else v + ) + cfg.settings); + + environment.systemPackages = [ pkgs.sourcehut.coresrht ]; + + # PostgreSQL server + services.postgresql.enable = mkOverride 999 true; + # Mail server + services.postfix.enable = mkOverride 999 true; + # Cron daemon + services.cron.enable = mkOverride 999 true; + # Redis server + services.redis.enable = mkOverride 999 true; + services.redis.bind = mkOverride 999 "127.0.0.1"; + + services.sourcehut.settings = { + # The name of your network of sr.ht-based sites + "sr.ht".site-name = mkDefault "sourcehut"; + # The top-level info page for your site + "sr.ht".site-info = mkDefault "https://sourcehut.org"; + # {{ site-name }}, {{ site-blurb }} + "sr.ht".site-blurb = mkDefault "the hacker's forge"; + # If this != production, we add a banner to each page + "sr.ht".environment = mkDefault "development"; + # Contact information for the site owners + "sr.ht".owner-name = mkDefault "Drew DeVault"; + "sr.ht".owner-email = mkDefault "sir@cmpwn.com"; + # The source code for your fork of sr.ht + "sr.ht".source-url = mkDefault "https://git.sr.ht/~sircmpwn/srht"; + # A secret key to encrypt session cookies with + "sr.ht".secret-key = mkDefault null; + "sr.ht".global-domain = mkDefault null; + + # Outgoing SMTP settings + mail.smtp-host = mkDefault null; + mail.smtp-port = mkDefault null; + mail.smtp-user = mkDefault null; + mail.smtp-password = mkDefault null; + mail.smtp-from = mkDefault null; + # Application exceptions are emailed to this address + mail.error-to = mkDefault null; + mail.error-from = mkDefault null; + # Your PGP key information (DO NOT mix up pub and priv here) + # You must remove the password from your secret key, if present. + # You can do this with gpg --edit-key [key-id], then use the passwd + # command and do not enter a new password. + mail.pgp-privkey = mkDefault null; + mail.pgp-pubkey = mkDefault null; + mail.pgp-key-id = mkDefault null; + + # base64-encoded Ed25519 key for signing webhook payloads. This should be + # consistent for all *.sr.ht sites, as we'll use this key to verify signatures + # from other sites in your network. + # + # Use the srht-webhook-keygen command to generate a key. + webhooks.private-key = mkDefault null; + }; + }; + meta.doc = ./sourcehut.xml; + meta.maintainers = with maintainers; [ tomberek ]; +} diff --git a/nixos/modules/services/misc/sourcehut/dispatch.nix b/nixos/modules/services/misc/sourcehut/dispatch.nix new file mode 100644 index 00000000000..a9db17bebe8 --- /dev/null +++ b/nixos/modules/services/misc/sourcehut/dispatch.nix @@ -0,0 +1,125 @@ +{ config, lib, pkgs, ... }: + +with lib; +let + cfg = config.services.sourcehut; + cfgIni = cfg.settings; + scfg = cfg.dispatch; + iniKey = "dispatch.sr.ht"; + + drv = pkgs.sourcehut.dispatchsrht; +in +{ + options.services.sourcehut.dispatch = { + user = mkOption { + type = types.str; + default = "dispatchsrht"; + description = '' + User for dispatch.sr.ht. + ''; + }; + + port = mkOption { + type = types.port; + default = 5005; + description = '' + Port on which the "dispatch" module should listen. + ''; + }; + + database = mkOption { + type = types.str; + default = "dispatch.sr.ht"; + description = '' + PostgreSQL database name for dispatch.sr.ht. + ''; + }; + + statePath = mkOption { + type = types.path; + default = "${cfg.statePath}/dispatchsrht"; + description = '' + State path for dispatch.sr.ht. + ''; + }; + }; + + config = with scfg; lib.mkIf (cfg.enable && elem "dispatch" cfg.services) { + + users = { + users = { + "${user}" = { + isSystemUser = true; + group = user; + description = "dispatch.sr.ht user"; + }; + }; + + groups = { + "${user}" = { }; + }; + }; + + services.postgresql = { + authentication = '' + local ${database} ${user} trust + ''; + ensureDatabases = [ database ]; + ensureUsers = [ + { + name = user; + ensurePermissions = { "DATABASE \"${database}\"" = "ALL PRIVILEGES"; }; + } + ]; + }; + + systemd = { + tmpfiles.rules = [ + "d ${statePath} 0750 ${user} ${user} -" + ]; + + services.dispatchsrht = import ./service.nix { inherit config pkgs lib; } scfg drv iniKey { + after = [ "postgresql.service" "network.target" ]; + requires = [ "postgresql.service" ]; + wantedBy = [ "multi-user.target" ]; + + description = "dispatch.sr.ht website service"; + + serviceConfig.ExecStart = "${cfg.python}/bin/gunicorn ${drv.pname}.app:app -b ${cfg.address}:${toString port}"; + }; + }; + + services.sourcehut.settings = { + # URL dispatch.sr.ht is being served at (protocol://domain) + "dispatch.sr.ht".origin = mkDefault "http://dispatch.${cfg.originBase}"; + # Address and port to bind the debug server to + "dispatch.sr.ht".debug-host = mkDefault "0.0.0.0"; + "dispatch.sr.ht".debug-port = mkDefault port; + # Configures the SQLAlchemy connection string for the database. + "dispatch.sr.ht".connection-string = mkDefault "postgresql:///${database}?user=${user}&host=/var/run/postgresql"; + # Set to "yes" to automatically run migrations on package upgrade. + "dispatch.sr.ht".migrate-on-upgrade = mkDefault "yes"; + # dispatch.sr.ht's OAuth client ID and secret for meta.sr.ht + # Register your client at meta.example.org/oauth + "dispatch.sr.ht".oauth-client-id = mkDefault null; + "dispatch.sr.ht".oauth-client-secret = mkDefault null; + + # Github Integration + "dispatch.sr.ht::github".oauth-client-id = mkDefault null; + "dispatch.sr.ht::github".oauth-client-secret = mkDefault null; + + # Gitlab Integration + "dispatch.sr.ht::gitlab".enabled = mkDefault null; + "dispatch.sr.ht::gitlab".canonical-upstream = mkDefault "gitlab.com"; + "dispatch.sr.ht::gitlab".repo-cache = mkDefault "./repo-cache"; + # "dispatch.sr.ht::gitlab"."gitlab.com" = mkDefault "GitLab:application id:secret"; + }; + + services.nginx.virtualHosts."dispatch.${cfg.originBase}" = { + forceSSL = true; + locations."/".proxyPass = "http://${cfg.address}:${toString port}"; + locations."/query".proxyPass = "http://${cfg.address}:${toString (port + 100)}"; + locations."/static".root = "${pkgs.sourcehut.dispatchsrht}/${pkgs.sourcehut.python.sitePackages}/dispatchsrht"; + }; + }; +} diff --git a/nixos/modules/services/misc/sourcehut/git.nix b/nixos/modules/services/misc/sourcehut/git.nix new file mode 100644 index 00000000000..99b9aec0612 --- /dev/null +++ b/nixos/modules/services/misc/sourcehut/git.nix @@ -0,0 +1,214 @@ +{ config, lib, pkgs, ... }: + +with lib; +let + cfg = config.services.sourcehut; + scfg = cfg.git; + iniKey = "git.sr.ht"; + + rcfg = config.services.redis; + drv = pkgs.sourcehut.gitsrht; +in +{ + options.services.sourcehut.git = { + user = mkOption { + type = types.str; + visible = false; + internal = true; + readOnly = true; + default = "git"; + description = '' + User for git.sr.ht. + ''; + }; + + port = mkOption { + type = types.port; + default = 5001; + description = '' + Port on which the "git" module should listen. + ''; + }; + + database = mkOption { + type = types.str; + default = "git.sr.ht"; + description = '' + PostgreSQL database name for git.sr.ht. + ''; + }; + + statePath = mkOption { + type = types.path; + default = "${cfg.statePath}/gitsrht"; + description = '' + State path for git.sr.ht. + ''; + }; + + package = mkOption { + type = types.package; + default = pkgs.git; + example = literalExample "pkgs.gitFull"; + description = '' + Git package for git.sr.ht. This can help silence collisions. + ''; + }; + }; + + config = with scfg; lib.mkIf (cfg.enable && elem "git" cfg.services) { + # sshd refuses to run with `Unsafe AuthorizedKeysCommand ... bad ownership or modes for directory /nix/store` + environment.etc."ssh/gitsrht-dispatch" = { + mode = "0755"; + text = '' + #! ${pkgs.stdenv.shell} + ${cfg.python}/bin/gitsrht-dispatch "$@" + ''; + }; + + # Needs this in the $PATH when sshing into the server + environment.systemPackages = [ cfg.git.package ]; + + users = { + users = { + "${user}" = { + isSystemUser = true; + group = user; + # https://stackoverflow.com/questions/22314298/git-push-results-in-fatal-protocol-error-bad-line-length-character-this + # Probably could use gitsrht-shell if output is restricted to just parameters... + shell = pkgs.bash; + description = "git.sr.ht user"; + }; + }; + + groups = { + "${user}" = { }; + }; + }; + + services = { + cron.systemCronJobs = [ "*/20 * * * * ${cfg.python}/bin/gitsrht-periodic" ]; + fcgiwrap.enable = true; + + openssh.authorizedKeysCommand = ''/etc/ssh/gitsrht-dispatch "%u" "%h" "%t" "%k"''; + openssh.authorizedKeysCommandUser = "root"; + openssh.extraConfig = '' + PermitUserEnvironment SRHT_* + ''; + + postgresql = { + authentication = '' + local ${database} ${user} trust + ''; + ensureDatabases = [ database ]; + ensureUsers = [ + { + name = user; + ensurePermissions = { "DATABASE \"${database}\"" = "ALL PRIVILEGES"; }; + } + ]; + }; + }; + + systemd = { + tmpfiles.rules = [ + # /var/log is owned by root + "f /var/log/git-srht-shell 0644 ${user} ${user} -" + + "d ${statePath} 0750 ${user} ${user} -" + "d ${cfg.settings."${iniKey}".repos} 2755 ${user} ${user} -" + ]; + + services = { + gitsrht = import ./service.nix { inherit config pkgs lib; } scfg drv iniKey { + after = [ "redis.service" "postgresql.service" "network.target" ]; + requires = [ "redis.service" "postgresql.service" ]; + wantedBy = [ "multi-user.target" ]; + + # Needs internally to create repos at the very least + path = [ pkgs.git ]; + description = "git.sr.ht website service"; + + serviceConfig.ExecStart = "${cfg.python}/bin/gunicorn ${drv.pname}.app:app -b ${cfg.address}:${toString port}"; + }; + + gitsrht-webhooks = { + after = [ "postgresql.service" "network.target" ]; + requires = [ "postgresql.service" ]; + wantedBy = [ "multi-user.target" ]; + + description = "git.sr.ht webhooks service"; + serviceConfig = { + Type = "simple"; + User = user; + Restart = "always"; + }; + + serviceConfig.ExecStart = "${cfg.python}/bin/celery -A ${drv.pname}.webhooks worker --loglevel=info"; + }; + }; + }; + + services.sourcehut.settings = { + # URL git.sr.ht is being served at (protocol://domain) + "git.sr.ht".origin = mkDefault "http://git.${cfg.originBase}"; + # Address and port to bind the debug server to + "git.sr.ht".debug-host = mkDefault "0.0.0.0"; + "git.sr.ht".debug-port = mkDefault port; + # Configures the SQLAlchemy connection string for the database. + "git.sr.ht".connection-string = mkDefault "postgresql:///${database}?user=${user}&host=/var/run/postgresql"; + # Set to "yes" to automatically run migrations on package upgrade. + "git.sr.ht".migrate-on-upgrade = mkDefault "yes"; + # The redis connection used for the webhooks worker + "git.sr.ht".webhooks = mkDefault "redis://${rcfg.bind}:${toString rcfg.port}/1"; + + # A post-update script which is installed in every git repo. + "git.sr.ht".post-update-script = mkDefault "${pkgs.sourcehut.gitsrht}/bin/gitsrht-update-hook"; + + # git.sr.ht's OAuth client ID and secret for meta.sr.ht + # Register your client at meta.example.org/oauth + "git.sr.ht".oauth-client-id = mkDefault null; + "git.sr.ht".oauth-client-secret = mkDefault null; + # Path to git repositories on disk + "git.sr.ht".repos = mkDefault "/var/lib/git"; + + "git.sr.ht".outgoing-domain = mkDefault "http://git.${cfg.originBase}"; + + # The authorized keys hook uses this to dispatch to various handlers + # The format is a program to exec into as the key, and the user to match as the + # value. When someone tries to log in as this user, this program is executed + # and is expected to omit an AuthorizedKeys file. + # + # Discard of the string context is in order to allow derivation-derived strings. + # This is safe if the relevant package is installed which will be the case if the setting is utilized. + "git.sr.ht::dispatch".${builtins.unsafeDiscardStringContext "${pkgs.sourcehut.gitsrht}/bin/gitsrht-keys"} = mkDefault "${user}:${user}"; + }; + + services.nginx.virtualHosts."git.${cfg.originBase}" = { + forceSSL = true; + locations."/".proxyPass = "http://${cfg.address}:${toString port}"; + locations."/query".proxyPass = "http://${cfg.address}:${toString (port + 100)}"; + locations."/static".root = "${pkgs.sourcehut.gitsrht}/${pkgs.sourcehut.python.sitePackages}/gitsrht"; + extraConfig = '' + location = /authorize { + proxy_pass http://${cfg.address}:${toString port}; + proxy_pass_request_body off; + proxy_set_header Content-Length ""; + proxy_set_header X-Original-URI $request_uri; + } + location ~ ^/([^/]+)/([^/]+)/(HEAD|info/refs|objects/info/.*|git-upload-pack).*$ { + auth_request /authorize; + root /var/lib/git; + fastcgi_pass unix:/run/fcgiwrap.sock; + fastcgi_param SCRIPT_FILENAME ${pkgs.git}/bin/git-http-backend; + fastcgi_param PATH_INFO $uri; + fastcgi_param GIT_PROJECT_ROOT $document_root; + fastcgi_read_timeout 500s; + include ${pkgs.nginx}/conf/fastcgi_params; + gzip off; + } + ''; + + }; + }; +} diff --git a/nixos/modules/services/misc/sourcehut/hg.nix b/nixos/modules/services/misc/sourcehut/hg.nix new file mode 100644 index 00000000000..5cd36bb0455 --- /dev/null +++ b/nixos/modules/services/misc/sourcehut/hg.nix @@ -0,0 +1,173 @@ +{ config, lib, pkgs, ... }: + +with lib; +let + cfg = config.services.sourcehut; + scfg = cfg.hg; + iniKey = "hg.sr.ht"; + + rcfg = config.services.redis; + drv = pkgs.sourcehut.hgsrht; +in +{ + options.services.sourcehut.hg = { + user = mkOption { + type = types.str; + internal = true; + readOnly = true; + default = "hg"; + description = '' + User for hg.sr.ht. + ''; + }; + + port = mkOption { + type = types.port; + default = 5010; + description = '' + Port on which the "hg" module should listen. + ''; + }; + + database = mkOption { + type = types.str; + default = "hg.sr.ht"; + description = '' + PostgreSQL database name for hg.sr.ht. + ''; + }; + + statePath = mkOption { + type = types.path; + default = "${cfg.statePath}/hgsrht"; + description = '' + State path for hg.sr.ht. + ''; + }; + + cloneBundles = mkOption { + type = types.bool; + default = false; + description = '' + Generate clonebundles (which require more disk space but dramatically speed up cloning large repositories). + ''; + }; + }; + + config = with scfg; lib.mkIf (cfg.enable && elem "hg" cfg.services) { + # In case it ever comes into being + environment.etc."ssh/hgsrht-dispatch" = { + mode = "0755"; + text = '' + #! ${pkgs.stdenv.shell} + ${cfg.python}/bin/gitsrht-dispatch $@ + ''; + }; + + environment.systemPackages = [ pkgs.mercurial ]; + + users = { + users = { + "${user}" = { + isSystemUser = true; + group = user; + # Assuming hg.sr.ht needs this too + shell = pkgs.bash; + description = "hg.sr.ht user"; + }; + }; + + groups = { + "${user}" = { }; + }; + }; + + services = { + cron.systemCronJobs = [ "*/20 * * * * ${cfg.python}/bin/hgsrht-periodic" ] + ++ optional cloneBundles "0 * * * * ${cfg.python}/bin/hgsrht-clonebundles"; + + openssh.authorizedKeysCommand = ''/etc/ssh/hgsrht-dispatch "%u" "%h" "%t" "%k"''; + openssh.authorizedKeysCommandUser = "root"; + openssh.extraConfig = '' + PermitUserEnvironment SRHT_* + ''; + + postgresql = { + authentication = '' + local ${database} ${user} trust + ''; + ensureDatabases = [ database ]; + ensureUsers = [ + { + name = user; + ensurePermissions = { "DATABASE \"${database}\"" = "ALL PRIVILEGES"; }; + } + ]; + }; + }; + + systemd = { + tmpfiles.rules = [ + # /var/log is owned by root + "f /var/log/hg-srht-shell 0644 ${user} ${user} -" + + "d ${statePath} 0750 ${user} ${user} -" + "d ${cfg.settings."${iniKey}".repos} 2755 ${user} ${user} -" + ]; + + services.hgsrht = import ./service.nix { inherit config pkgs lib; } scfg drv iniKey { + after = [ "redis.service" "postgresql.service" "network.target" ]; + requires = [ "redis.service" "postgresql.service" ]; + wantedBy = [ "multi-user.target" ]; + + path = [ pkgs.mercurial ]; + description = "hg.sr.ht website service"; + + serviceConfig.ExecStart = "${cfg.python}/bin/gunicorn ${drv.pname}.app:app -b ${cfg.address}:${toString port}"; + }; + }; + + services.sourcehut.settings = { + # URL hg.sr.ht is being served at (protocol://domain) + "hg.sr.ht".origin = mkDefault "http://hg.${cfg.originBase}"; + # Address and port to bind the debug server to + "hg.sr.ht".debug-host = mkDefault "0.0.0.0"; + "hg.sr.ht".debug-port = mkDefault port; + # Configures the SQLAlchemy connection string for the database. + "hg.sr.ht".connection-string = mkDefault "postgresql:///${database}?user=${user}&host=/var/run/postgresql"; + # The redis connection used for the webhooks worker + "hg.sr.ht".webhooks = mkDefault "redis://${rcfg.bind}:${toString rcfg.port}/1"; + # A post-update script which is installed in every mercurial repo. + "hg.sr.ht".changegroup-script = mkDefault "${cfg.python}/bin/hgsrht-hook-changegroup"; + # hg.sr.ht's OAuth client ID and secret for meta.sr.ht + # Register your client at meta.example.org/oauth + "hg.sr.ht".oauth-client-id = mkDefault null; + "hg.sr.ht".oauth-client-secret = mkDefault null; + # Path to mercurial repositories on disk + "hg.sr.ht".repos = mkDefault "/var/lib/hg"; + # Path to the srht mercurial extension + # (defaults to where the hgsrht code is) + # "hg.sr.ht".srhtext = mkDefault null; + # .hg/store size (in MB) past which the nightly job generates clone bundles. + # "hg.sr.ht".clone_bundle_threshold = mkDefault 50; + # Path to hg-ssh (if not in $PATH) + # "hg.sr.ht".hg_ssh = mkDefault /path/to/hg-ssh; + + # The authorized keys hook uses this to dispatch to various handlers + # The format is a program to exec into as the key, and the user to match as the + # value. When someone tries to log in as this user, this program is executed + # and is expected to omit an AuthorizedKeys file. + # + # Uncomment the relevant lines to enable the various sr.ht dispatchers. + "hg.sr.ht::dispatch"."/run/current-system/sw/bin/hgsrht-keys" = mkDefault "${user}:${user}"; + }; + + # TODO: requires testing and addition of hg-specific requirements + services.nginx.virtualHosts."hg.${cfg.originBase}" = { + forceSSL = true; + locations."/".proxyPass = "http://${cfg.address}:${toString port}"; + locations."/query".proxyPass = "http://${cfg.address}:${toString (port + 100)}"; + locations."/static".root = "${pkgs.sourcehut.hgsrht}/${pkgs.sourcehut.python.sitePackages}/hgsrht"; + }; + }; +} diff --git a/nixos/modules/services/misc/sourcehut/hub.nix b/nixos/modules/services/misc/sourcehut/hub.nix new file mode 100644 index 00000000000..be3ea21011c --- /dev/null +++ b/nixos/modules/services/misc/sourcehut/hub.nix @@ -0,0 +1,118 @@ +{ config, lib, pkgs, ... }: + +with lib; +let + cfg = config.services.sourcehut; + cfgIni = cfg.settings; + scfg = cfg.hub; + iniKey = "hub.sr.ht"; + + drv = pkgs.sourcehut.hubsrht; +in +{ + options.services.sourcehut.hub = { + user = mkOption { + type = types.str; + default = "hubsrht"; + description = '' + User for hub.sr.ht. + ''; + }; + + port = mkOption { + type = types.port; + default = 5014; + description = '' + Port on which the "hub" module should listen. + ''; + }; + + database = mkOption { + type = types.str; + default = "hub.sr.ht"; + description = '' + PostgreSQL database name for hub.sr.ht. + ''; + }; + + statePath = mkOption { + type = types.path; + default = "${cfg.statePath}/hubsrht"; + description = '' + State path for hub.sr.ht. + ''; + }; + }; + + config = with scfg; lib.mkIf (cfg.enable && elem "hub" cfg.services) { + users = { + users = { + "${user}" = { + isSystemUser = true; + group = user; + description = "hub.sr.ht user"; + }; + }; + + groups = { + "${user}" = { }; + }; + }; + + services.postgresql = { + authentication = '' + local ${database} ${user} trust + ''; + ensureDatabases = [ database ]; + ensureUsers = [ + { + name = user; + ensurePermissions = { "DATABASE \"${database}\"" = "ALL PRIVILEGES"; }; + } + ]; + }; + + systemd = { + tmpfiles.rules = [ + "d ${statePath} 0750 ${user} ${user} -" + ]; + + services.hubsrht = import ./service.nix { inherit config pkgs lib; } scfg drv iniKey { + after = [ "postgresql.service" "network.target" ]; + requires = [ "postgresql.service" ]; + wantedBy = [ "multi-user.target" ]; + + description = "hub.sr.ht website service"; + + serviceConfig.ExecStart = "${cfg.python}/bin/gunicorn ${drv.pname}.app:app -b ${cfg.address}:${toString port}"; + }; + }; + + services.sourcehut.settings = { + # URL hub.sr.ht is being served at (protocol://domain) + "hub.sr.ht".origin = mkDefault "http://hub.${cfg.originBase}"; + # Address and port to bind the debug server to + "hub.sr.ht".debug-host = mkDefault "0.0.0.0"; + "hub.sr.ht".debug-port = mkDefault port; + # Configures the SQLAlchemy connection string for the database. + "hub.sr.ht".connection-string = mkDefault "postgresql:///${database}?user=${user}&host=/var/run/postgresql"; + # Set to "yes" to automatically run migrations on package upgrade. + "hub.sr.ht".migrate-on-upgrade = mkDefault "yes"; + # hub.sr.ht's OAuth client ID and secret for meta.sr.ht + # Register your client at meta.example.org/oauth + "hub.sr.ht".oauth-client-id = mkDefault null; + "hub.sr.ht".oauth-client-secret = mkDefault null; + }; + + services.nginx.virtualHosts."${cfg.originBase}" = { + forceSSL = true; + locations."/".proxyPass = "http://${cfg.address}:${toString port}"; + locations."/query".proxyPass = "http://${cfg.address}:${toString (port + 100)}"; + locations."/static".root = "${pkgs.sourcehut.hubsrht}/${pkgs.sourcehut.python.sitePackages}/hubsrht"; + }; + services.nginx.virtualHosts."hub.${cfg.originBase}" = { + globalRedirect = "${cfg.originBase}"; + forceSSL = true; + }; + }; +} diff --git a/nixos/modules/services/misc/sourcehut/lists.nix b/nixos/modules/services/misc/sourcehut/lists.nix new file mode 100644 index 00000000000..7b1fe9fd463 --- /dev/null +++ b/nixos/modules/services/misc/sourcehut/lists.nix @@ -0,0 +1,185 @@ +# Email setup is fairly involved, useful references: +# https://drewdevault.com/2018/08/05/Local-mail-server.html + +{ config, lib, pkgs, ... }: + +with lib; +let + cfg = config.services.sourcehut; + cfgIni = cfg.settings; + scfg = cfg.lists; + iniKey = "lists.sr.ht"; + + rcfg = config.services.redis; + drv = pkgs.sourcehut.listssrht; +in +{ + options.services.sourcehut.lists = { + user = mkOption { + type = types.str; + default = "listssrht"; + description = '' + User for lists.sr.ht. + ''; + }; + + port = mkOption { + type = types.port; + default = 5006; + description = '' + Port on which the "lists" module should listen. + ''; + }; + + database = mkOption { + type = types.str; + default = "lists.sr.ht"; + description = '' + PostgreSQL database name for lists.sr.ht. + ''; + }; + + statePath = mkOption { + type = types.path; + default = "${cfg.statePath}/listssrht"; + description = '' + State path for lists.sr.ht. + ''; + }; + }; + + config = with scfg; lib.mkIf (cfg.enable && elem "lists" cfg.services) { + users = { + users = { + "${user}" = { + isSystemUser = true; + group = user; + extraGroups = [ "postfix" ]; + description = "lists.sr.ht user"; + }; + }; + groups = { + "${user}" = { }; + }; + }; + + services.postgresql = { + authentication = '' + local ${database} ${user} trust + ''; + ensureDatabases = [ database ]; + ensureUsers = [ + { + name = user; + ensurePermissions = { "DATABASE \"${database}\"" = "ALL PRIVILEGES"; }; + } + ]; + }; + + systemd = { + tmpfiles.rules = [ + "d ${statePath} 0750 ${user} ${user} -" + ]; + + services = { + listssrht = import ./service.nix { inherit config pkgs lib; } scfg drv iniKey { + after = [ "postgresql.service" "network.target" ]; + requires = [ "postgresql.service" ]; + wantedBy = [ "multi-user.target" ]; + + description = "lists.sr.ht website service"; + + serviceConfig.ExecStart = "${cfg.python}/bin/gunicorn ${drv.pname}.app:app -b ${cfg.address}:${toString port}"; + }; + + listssrht-process = { + after = [ "postgresql.service" "network.target" ]; + requires = [ "postgresql.service" ]; + wantedBy = [ "multi-user.target" ]; + + description = "lists.sr.ht process service"; + serviceConfig = { + Type = "simple"; + User = user; + Restart = "always"; + ExecStart = "${cfg.python}/bin/celery -A ${drv.pname}.process worker --loglevel=info"; + }; + }; + + listssrht-lmtp = { + after = [ "postgresql.service" "network.target" ]; + requires = [ "postgresql.service" ]; + wantedBy = [ "multi-user.target" ]; + + description = "lists.sr.ht process service"; + serviceConfig = { + Type = "simple"; + User = user; + Restart = "always"; + ExecStart = "${cfg.python}/bin/listssrht-lmtp"; + }; + }; + + + listssrht-webhooks = { + after = [ "postgresql.service" "network.target" ]; + requires = [ "postgresql.service" ]; + wantedBy = [ "multi-user.target" ]; + + description = "lists.sr.ht webhooks service"; + serviceConfig = { + Type = "simple"; + User = user; + Restart = "always"; + ExecStart = "${cfg.python}/bin/celery -A ${drv.pname}.webhooks worker --loglevel=info"; + }; + }; + }; + }; + + services.sourcehut.settings = { + # URL lists.sr.ht is being served at (protocol://domain) + "lists.sr.ht".origin = mkDefault "http://lists.${cfg.originBase}"; + # Address and port to bind the debug server to + "lists.sr.ht".debug-host = mkDefault "0.0.0.0"; + "lists.sr.ht".debug-port = mkDefault port; + # Configures the SQLAlchemy connection string for the database. + "lists.sr.ht".connection-string = mkDefault "postgresql:///${database}?user=${user}&host=/var/run/postgresql"; + # Set to "yes" to automatically run migrations on package upgrade. + "lists.sr.ht".migrate-on-upgrade = mkDefault "yes"; + # lists.sr.ht's OAuth client ID and secret for meta.sr.ht + # Register your client at meta.example.org/oauth + "lists.sr.ht".oauth-client-id = mkDefault null; + "lists.sr.ht".oauth-client-secret = mkDefault null; + # Outgoing email for notifications generated by users + "lists.sr.ht".notify-from = mkDefault "CHANGEME@example.org"; + # The redis connection used for the webhooks worker + "lists.sr.ht".webhooks = mkDefault "redis://${rcfg.bind}:${toString rcfg.port}/2"; + # The redis connection used for the celery worker + "lists.sr.ht".redis = mkDefault "redis://${rcfg.bind}:${toString rcfg.port}/4"; + # Network-key + "lists.sr.ht".network-key = mkDefault null; + # Allow creation + "lists.sr.ht".allow-new-lists = mkDefault "no"; + # Posting Domain + "lists.sr.ht".posting-domain = mkDefault "lists.${cfg.originBase}"; + + # Path for the lmtp daemon's unix socket. Direct incoming mail to this socket. + # Alternatively, specify IP:PORT and an SMTP server will be run instead. + "lists.sr.ht::worker".sock = mkDefault "/tmp/lists.sr.ht-lmtp.sock"; + # The lmtp daemon will make the unix socket group-read/write for users in this + # group. + "lists.sr.ht::worker".sock-group = mkDefault "postfix"; + "lists.sr.ht::worker".reject-url = mkDefault "https://man.sr.ht/lists.sr.ht/etiquette.md"; + "lists.sr.ht::worker".reject-mimetypes = mkDefault "text/html"; + + }; + + services.nginx.virtualHosts."lists.${cfg.originBase}" = { + forceSSL = true; + locations."/".proxyPass = "http://${cfg.address}:${toString port}"; + locations."/query".proxyPass = "http://${cfg.address}:${toString (port + 100)}"; + locations."/static".root = "${pkgs.sourcehut.listssrht}/${pkgs.sourcehut.python.sitePackages}/listssrht"; + }; + }; +} diff --git a/nixos/modules/services/misc/sourcehut/man.nix b/nixos/modules/services/misc/sourcehut/man.nix new file mode 100644 index 00000000000..7693396d187 --- /dev/null +++ b/nixos/modules/services/misc/sourcehut/man.nix @@ -0,0 +1,122 @@ +{ config, lib, pkgs, ... }: + +with lib; +let + cfg = config.services.sourcehut; + cfgIni = cfg.settings; + scfg = cfg.man; + iniKey = "man.sr.ht"; + + drv = pkgs.sourcehut.mansrht; +in +{ + options.services.sourcehut.man = { + user = mkOption { + type = types.str; + default = "mansrht"; + description = '' + User for man.sr.ht. + ''; + }; + + port = mkOption { + type = types.port; + default = 5004; + description = '' + Port on which the "man" module should listen. + ''; + }; + + database = mkOption { + type = types.str; + default = "man.sr.ht"; + description = '' + PostgreSQL database name for man.sr.ht. + ''; + }; + + statePath = mkOption { + type = types.path; + default = "${cfg.statePath}/mansrht"; + description = '' + State path for man.sr.ht. + ''; + }; + }; + + config = with scfg; lib.mkIf (cfg.enable && elem "man" cfg.services) { + assertions = + [ + { + assertion = hasAttrByPath [ "git.sr.ht" "oauth-client-id" ] cfgIni; + message = "man.sr.ht needs access to git.sr.ht."; + } + ]; + + users = { + users = { + "${user}" = { + isSystemUser = true; + group = user; + description = "man.sr.ht user"; + }; + }; + + groups = { + "${user}" = { }; + }; + }; + + services.postgresql = { + authentication = '' + local ${database} ${user} trust + ''; + ensureDatabases = [ database ]; + ensureUsers = [ + { + name = user; + ensurePermissions = { "DATABASE \"${database}\"" = "ALL PRIVILEGES"; }; + } + ]; + }; + + systemd = { + tmpfiles.rules = [ + "d ${statePath} 0750 ${user} ${user} -" + ]; + + services.mansrht = import ./service.nix { inherit config pkgs lib; } scfg drv iniKey { + after = [ "postgresql.service" "network.target" ]; + requires = [ "postgresql.service" ]; + wantedBy = [ "multi-user.target" ]; + + description = "man.sr.ht website service"; + + serviceConfig.ExecStart = "${cfg.python}/bin/gunicorn ${drv.pname}.app:app -b ${cfg.address}:${toString port}"; + }; + }; + + services.sourcehut.settings = { + # URL man.sr.ht is being served at (protocol://domain) + "man.sr.ht".origin = mkDefault "http://man.${cfg.originBase}"; + # Address and port to bind the debug server to + "man.sr.ht".debug-host = mkDefault "0.0.0.0"; + "man.sr.ht".debug-port = mkDefault port; + # Configures the SQLAlchemy connection string for the database. + "man.sr.ht".connection-string = mkDefault "postgresql:///${database}?user=${user}&host=/var/run/postgresql"; + # Set to "yes" to automatically run migrations on package upgrade. + "man.sr.ht".migrate-on-upgrade = mkDefault "yes"; + # man.sr.ht's OAuth client ID and secret for meta.sr.ht + # Register your client at meta.example.org/oauth + "man.sr.ht".oauth-client-id = mkDefault null; + "man.sr.ht".oauth-client-secret = mkDefault null; + }; + + services.nginx.virtualHosts."man.${cfg.originBase}" = { + forceSSL = true; + locations."/".proxyPass = "http://${cfg.address}:${toString port}"; + locations."/query".proxyPass = "http://${cfg.address}:${toString (port + 100)}"; + locations."/static".root = "${pkgs.sourcehut.mansrht}/${pkgs.sourcehut.python.sitePackages}/mansrht"; + }; + }; +} diff --git a/nixos/modules/services/misc/sourcehut/meta.nix b/nixos/modules/services/misc/sourcehut/meta.nix new file mode 100644 index 00000000000..56127a824eb --- /dev/null +++ b/nixos/modules/services/misc/sourcehut/meta.nix @@ -0,0 +1,211 @@ +{ config, lib, pkgs, ... }: + +with lib; +let + cfg = config.services.sourcehut; + cfgIni = cfg.settings; + scfg = cfg.meta; + iniKey = "meta.sr.ht"; + + rcfg = config.services.redis; + drv = pkgs.sourcehut.metasrht; +in +{ + options.services.sourcehut.meta = { + user = mkOption { + type = types.str; + default = "metasrht"; + description = '' + User for meta.sr.ht. + ''; + }; + + port = mkOption { + type = types.port; + default = 5000; + description = '' + Port on which the "meta" module should listen. + ''; + }; + + database = mkOption { + type = types.str; + default = "meta.sr.ht"; + description = '' + PostgreSQL database name for meta.sr.ht. + ''; + }; + + statePath = mkOption { + type = types.path; + default = "${cfg.statePath}/metasrht"; + description = '' + State path for meta.sr.ht. + ''; + }; + }; + + config = with scfg; lib.mkIf (cfg.enable && elem "meta" cfg.services) { + assertions = + [ + { + assertion = with cfgIni."meta.sr.ht::billing"; enabled == "yes" -> (stripe-public-key != null && stripe-secret-key != null); + message = "If meta.sr.ht::billing is enabled, the keys should be defined."; + } + ]; + + users = { + users = { + ${user} = { + isSystemUser = true; + group = user; + description = "meta.sr.ht user"; + }; + }; + + groups = { + "${user}" = { }; + }; + }; + + services.cron.systemCronJobs = [ "0 0 * * * ${cfg.python}/bin/metasrht-daily" ]; + services.postgresql = { + authentication = '' + local ${database} ${user} trust + ''; + ensureDatabases = [ database ]; + ensureUsers = [ + { + name = user; + ensurePermissions = { "DATABASE \"${database}\"" = "ALL PRIVILEGES"; }; + } + ]; + }; + + systemd = { + tmpfiles.rules = [ + "d ${statePath} 0750 ${user} ${user} -" + ]; + + services = { + metasrht = import ./service.nix { inherit config pkgs lib; } scfg drv iniKey { + after = [ "postgresql.service" "network.target" ]; + requires = [ "postgresql.service" ]; + wantedBy = [ "multi-user.target" ]; + + description = "meta.sr.ht website service"; + + preStart = '' + # Configure client(s) as "preauthorized" + ${concatMapStringsSep "\n\n" + (attr: '' + if ! test -e "${statePath}/${attr}.oauth" || [ "$(cat ${statePath}/${attr}.oauth)" != "${cfgIni."${attr}".oauth-client-id}" ]; then + # Configure ${attr}'s OAuth client as "preauthorized" + psql ${database} \ + -c "UPDATE oauthclient SET preauthorized = true WHERE client_id = '${cfgIni."${attr}".oauth-client-id}'" + + printf "%s" "${cfgIni."${attr}".oauth-client-id}" > "${statePath}/${attr}.oauth" + fi + '') + (builtins.attrNames (filterAttrs + (k: v: !(hasInfix "::" k) && builtins.hasAttr "oauth-client-id" v && v.oauth-client-id != null) + cfg.settings))} + ''; + + serviceConfig.ExecStart = "${cfg.python}/bin/gunicorn ${drv.pname}.app:app -b ${cfg.address}:${toString port}"; + }; + + metasrht-api = import ./service.nix { inherit config pkgs lib; } scfg drv iniKey { + after = [ "postgresql.service" "network.target" ]; + requires = [ "postgresql.service" ]; + wantedBy = [ "multi-user.target" ]; + + description = "meta.sr.ht api service"; + + preStart = '' + # Configure client(s) as "preauthorized" + ${concatMapStringsSep "\n\n" + (attr: '' + if ! test -e "${statePath}/${attr}.oauth" || [ "$(cat ${statePath}/${attr}.oauth)" != "${cfgIni."${attr}".oauth-client-id}" ]; then + # Configure ${attr}'s OAuth client as "preauthorized" + psql ${database} \ + -c "UPDATE oauthclient SET preauthorized = true WHERE client_id = '${cfgIni."${attr}".oauth-client-id}'" + + printf "%s" "${cfgIni."${attr}".oauth-client-id}" > "${statePath}/${attr}.oauth" + fi + '') + (builtins.attrNames (filterAttrs + (k: v: !(hasInfix "::" k) && builtins.hasAttr "oauth-client-id" v && v.oauth-client-id != null) + cfg.settings))} + ''; + + serviceConfig.ExecStart = "${pkgs.sourcehut.metasrht}/bin/metasrht-api -b :${toString (port + 100)}"; + }; + + metasrht-webhooks = { + after = [ "postgresql.service" "network.target" ]; + requires = [ "postgresql.service" ]; + wantedBy = [ "multi-user.target" ]; + + description = "meta.sr.ht webhooks service"; + serviceConfig = { + Type = "simple"; + User = user; + Restart = "always"; + ExecStart = "${cfg.python}/bin/celery -A ${drv.pname}.webhooks worker --loglevel=info"; + }; + + }; + }; + }; + + services.sourcehut.settings = { + # URL meta.sr.ht is being served at (protocol://domain) + "meta.sr.ht".origin = mkDefault "https://meta.${cfg.originBase}"; + # Address and port to bind the debug server to + "meta.sr.ht".debug-host = mkDefault "0.0.0.0"; + "meta.sr.ht".debug-port = mkDefault port; + # Configures the SQLAlchemy connection string for the database. + "meta.sr.ht".connection-string = mkDefault "postgresql:///${database}?user=${user}&host=/var/run/postgresql"; + # Set to "yes" to automatically run migrations on package upgrade. + "meta.sr.ht".migrate-on-upgrade = mkDefault "yes"; + # If "yes", the user will be sent the stock sourcehut welcome emails after + # signup (requires cron to be configured properly). These are specific to the + # sr.ht instance so you probably want to patch these before enabling this. + "meta.sr.ht".welcome-emails = mkDefault "no"; + + # The redis connection used for the webhooks worker + "meta.sr.ht".webhooks = mkDefault "redis://${rcfg.bind}:${toString rcfg.port}/6"; + + # If "no", public registration will not be permitted. + "meta.sr.ht::settings".registration = mkDefault "no"; + # Where to redirect new users upon registration + "meta.sr.ht::settings".onboarding-redirect = mkDefault "https://meta.${cfg.originBase}"; + # How many invites each user is issued upon registration (only applicable if + # open registration is disabled) + "meta.sr.ht::settings".user-invites = mkDefault 5; + + # Origin URL for API, 100 more than web + "meta.sr.ht".api-origin = mkDefault "http://localhost:5100"; + + # You can add aliases for the client IDs of commonly used OAuth clients here. + # + # Example: + "meta.sr.ht::aliases" = mkDefault { }; + # "meta.sr.ht::aliases"."git.sr.ht" = 12345; + + # "yes" to enable the billing system + "meta.sr.ht::billing".enabled = mkDefault "no"; + # Get your keys at https://dashboard.stripe.com/account/apikeys + "meta.sr.ht::billing".stripe-public-key = mkDefault null; + "meta.sr.ht::billing".stripe-secret-key = mkDefault null; + }; + + services.nginx.virtualHosts."meta.${cfg.originBase}" = { + forceSSL = true; + locations."/".proxyPass = "http://${cfg.address}:${toString port}"; + locations."/query".proxyPass = "http://${cfg.address}:${toString (port + 100)}"; + locations."/static".root = "${pkgs.sourcehut.metasrht}/${pkgs.sourcehut.python.sitePackages}/metasrht"; + }; + }; +} diff --git a/nixos/modules/services/misc/sourcehut/paste.nix b/nixos/modules/services/misc/sourcehut/paste.nix new file mode 100644 index 00000000000..b2d5151969e --- /dev/null +++ b/nixos/modules/services/misc/sourcehut/paste.nix @@ -0,0 +1,133 @@ +{ config, lib, pkgs, ... }: + +with lib; +let + cfg = config.services.sourcehut; + cfgIni = cfg.settings; + scfg = cfg.paste; + iniKey = "paste.sr.ht"; + + rcfg = config.services.redis; + drv = pkgs.sourcehut.pastesrht; +in +{ + options.services.sourcehut.paste = { + user = mkOption { + type = types.str; + default = "pastesrht"; + description = '' + User for paste.sr.ht. + ''; + }; + + port = mkOption { + type = types.port; + default = 5011; + description = '' + Port on which the "paste" module should listen. + ''; + }; + + database = mkOption { + type = types.str; + default = "paste.sr.ht"; + description = '' + PostgreSQL database name for paste.sr.ht. + ''; + }; + + statePath = mkOption { + type = types.path; + default = "${cfg.statePath}/pastesrht"; + description = '' + State path for pastesrht.sr.ht. + ''; + }; + }; + + config = with scfg; lib.mkIf (cfg.enable && elem "paste" cfg.services) { + users = { + users = { + "${user}" = { + isSystemUser = true; + group = user; + description = "paste.sr.ht user"; + }; + }; + + groups = { + "${user}" = { }; + }; + }; + + services.postgresql = { + authentication = '' + local ${database} ${user} trust + ''; + ensureDatabases = [ database ]; + ensureUsers = [ + { + name = user; + ensurePermissions = { "DATABASE \"${database}\"" = "ALL PRIVILEGES"; }; + } + ]; + }; + + systemd = { + tmpfiles.rules = [ + "d ${statePath} 0750 ${user} ${user} -" + ]; + + services = { + pastesrht = import ./service.nix { inherit config pkgs lib; } scfg drv iniKey { + after = [ "postgresql.service" "network.target" ]; + requires = [ "postgresql.service" ]; + wantedBy = [ "multi-user.target" ]; + + description = "paste.sr.ht website service"; + + serviceConfig.ExecStart = "${cfg.python}/bin/gunicorn ${drv.pname}.app:app -b ${cfg.address}:${toString port}"; + }; + + pastesrht-webhooks = { + after = [ "postgresql.service" "network.target" ]; + requires = [ "postgresql.service" ]; + wantedBy = [ "multi-user.target" ]; + + description = "paste.sr.ht webhooks service"; + serviceConfig = { + Type = "simple"; + User = user; + Restart = "always"; + ExecStart = "${cfg.python}/bin/celery -A ${drv.pname}.webhooks worker --loglevel=info"; + }; + + }; + }; + }; + + services.sourcehut.settings = { + # URL paste.sr.ht is being served at (protocol://domain) + "paste.sr.ht".origin = mkDefault "http://paste.${cfg.originBase}"; + # Address and port to bind the debug server to + "paste.sr.ht".debug-host = mkDefault "0.0.0.0"; + "paste.sr.ht".debug-port = mkDefault port; + # Configures the SQLAlchemy connection string for the database. + "paste.sr.ht".connection-string = mkDefault "postgresql:///${database}?user=${user}&host=/var/run/postgresql"; + # Set to "yes" to automatically run migrations on package upgrade. + "paste.sr.ht".migrate-on-upgrade = mkDefault "yes"; + # paste.sr.ht's OAuth client ID and secret for meta.sr.ht + # Register your client at meta.example.org/oauth + "paste.sr.ht".oauth-client-id = mkDefault null; + "paste.sr.ht".oauth-client-secret = mkDefault null; + "paste.sr.ht".webhooks = mkDefault "redis://${rcfg.bind}:${toString rcfg.port}/5"; + }; + + services.nginx.virtualHosts."paste.${cfg.originBase}" = { + forceSSL = true; + locations."/".proxyPass = "http://${cfg.address}:${toString port}"; + locations."/query".proxyPass = "http://${cfg.address}:${toString (port + 100)}"; + locations."/static".root = "${pkgs.sourcehut.pastesrht}/${pkgs.sourcehut.python.sitePackages}/pastesrht"; + }; + }; +} diff --git a/nixos/modules/services/misc/sourcehut/service.nix b/nixos/modules/services/misc/sourcehut/service.nix new file mode 100644 index 00000000000..65b4ad020f9 --- /dev/null +++ b/nixos/modules/services/misc/sourcehut/service.nix @@ -0,0 +1,66 @@ +{ config, pkgs, lib }: +serviceCfg: serviceDrv: iniKey: attrs: +let + cfg = config.services.sourcehut; + cfgIni = cfg.settings."${iniKey}"; + pgSuperUser = config.services.postgresql.superUser; + + setupDB = pkgs.writeScript "${serviceDrv.pname}-gen-db" '' + #! ${cfg.python}/bin/python + from ${serviceDrv.pname}.app import db + db.create() + ''; +in +with serviceCfg; with lib; recursiveUpdate +{ + environment.HOME = statePath; + path = [ config.services.postgresql.package ] ++ (attrs.path or [ ]); + restartTriggers = [ config.environment.etc."sr.ht/config.ini".source ]; + serviceConfig = { + Type = "simple"; + User = user; + Group = user; + Restart = "always"; + WorkingDirectory = statePath; + } // (if (cfg.statePath == "/var/lib/sourcehut/${serviceDrv.pname}") then { + StateDirectory = [ "sourcehut/${serviceDrv.pname}" ]; + } else {}) + ; + + preStart = '' + if ! test -e ${statePath}/db; then + # Setup the initial database + ${setupDB} + + # Set the initial state of the database for future database upgrades + if test -e ${cfg.python}/bin/${serviceDrv.pname}-migrate; then + # Run alembic stamp head once to tell alembic the schema is up-to-date + ${cfg.python}/bin/${serviceDrv.pname}-migrate stamp head + fi + + printf "%s" "${serviceDrv.version}" > ${statePath}/db + fi + + # Update copy of each users' profile to the latest + # See https://lists.sr.ht/~sircmpwn/sr.ht-admins/<20190302181207.GA13778%40cirno.my.domain> + if ! test -e ${statePath}/webhook; then + # Update ${iniKey}'s users' profile copy to the latest + ${cfg.python}/bin/srht-update-profiles ${iniKey} + + touch ${statePath}/webhook + fi + + ${optionalString (builtins.hasAttr "migrate-on-upgrade" cfgIni && cfgIni.migrate-on-upgrade == "yes") '' + if [ "$(cat ${statePath}/db)" != "${serviceDrv.version}" ]; then + # Manage schema migrations using alembic + ${cfg.python}/bin/${serviceDrv.pname}-migrate -a upgrade head + + # Mark down current package version + printf "%s" "${serviceDrv.version}" > ${statePath}/db + fi + ''} + + ${attrs.preStart or ""} + ''; +} + (builtins.removeAttrs attrs [ "path" "preStart" ]) diff --git a/nixos/modules/services/misc/sourcehut/sourcehut.xml b/nixos/modules/services/misc/sourcehut/sourcehut.xml new file mode 100644 index 00000000000..ab9a8c6cb4b --- /dev/null +++ b/nixos/modules/services/misc/sourcehut/sourcehut.xml @@ -0,0 +1,115 @@ +<chapter xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + version="5.0" + xml:id="module-services-sourcehut"> + <title>Sourcehut</title> + <para> + <link xlink:href="https://sr.ht.com/">Sourcehut</link> is an open-source, + self-hostable software development platform. The server setup can be automated using + <link linkend="opt-services.sourcehut.enable">services.sourcehut</link>. + </para> + + <section xml:id="module-services-sourcehut-basic-usage"> + <title>Basic usage</title> + <para> + Sourcehut is a Python and Go based set of applications. + <literal><link linkend="opt-services.sourcehut.enable">services.sourcehut</link></literal> + by default will use + <literal><link linkend="opt-services.nginx.enable">services.nginx</link></literal>, + <literal><link linkend="opt-services.nginx.enable">services.redis</link></literal>, + <literal><link linkend="opt-services.nginx.enable">services.cron</link></literal>, + and + <literal><link linkend="opt-services.postgresql.enable">services.postgresql</link></literal>. + </para> + + <para> + A very basic configuration may look like this: +<programlisting> +{ pkgs, ... }: +let + fqdn = + let + join = hostName: domain: hostName + optionalString (domain != null) ".${domain}"; + in join config.networking.hostName config.networking.domain; +in { + + networking = { + <link linkend="opt-networking.hostName">hostName</link> = "srht"; + <link linkend="opt-networking.domain">domain</link> = "tld"; + <link linkend="opt-networking.firewall.allowedTCPPorts">firewall.allowedTCPPorts</link> = [ 22 80 443 ]; + }; + + services.sourcehut = { + <link linkend="opt-services.sourcehut.enable">enable</link> = true; + <link linkend="opt-services.sourcehut.originBase">originBase</link> = fqdn; + <link linkend="opt-services.sourcehut.services">services</link> = [ "meta" "man" "git" ]; + <link linkend="opt-services.sourcehut.settings">settings</link> = { + "sr.ht" = { + environment = "production"; + global-domain = fqdn; + origin = "https://${fqdn}"; + # Produce keys with srht-keygen from <package>sourcehut.coresrht</package>. + network-key = "SECRET"; + service-key = "SECRET"; + }; + webhooks.private-key= "SECRET"; + }; + }; + + <link linkend="opt-security.acme.certs._name_.extraDomainNames">security.acme.certs."${fqdn}".extraDomainNames</link> = [ + "meta.${fqdn}" + "man.${fqdn}" + "git.${fqdn}" + ]; + + services.nginx = { + <link linkend="opt-services.nginx.enable">enable</link> = true; + # only recommendedProxySettings are strictly required, but the rest make sense as well. + <link linkend="opt-services.nginx.recommendedTlsSettings">recommendedTlsSettings</link> = true; + <link linkend="opt-services.nginx.recommendedOptimisation">recommendedOptimisation</link> = true; + <link linkend="opt-services.nginx.recommendedGzipSettings">recommendedGzipSettings</link> = true; + <link linkend="opt-services.nginx.recommendedProxySettings">recommendedProxySettings</link> = true; + + # Settings to setup what certificates are used for which endpoint. + <link linkend="opt-services.nginx.virtualHosts">virtualHosts</link> = { + <link linkend="opt-services.nginx.virtualHosts._name_.enableACME">"${fqdn}".enableACME</link> = true; + <link linkend="opt-services.nginx.virtualHosts._name_.useACMEHost">"meta.${fqdn}".useACMEHost</link> = fqdn: + <link linkend="opt-services.nginx.virtualHosts._name_.useACMEHost">"man.${fqdn}".useACMEHost</link> = fqdn: + <link linkend="opt-services.nginx.virtualHosts._name_.useACMEHost">"git.${fqdn}".useACMEHost</link> = fqdn: + }; + }; +} +</programlisting> + </para> + + <para> + The <literal>hostName</literal> option is used internally to configure the nginx + reverse-proxy. The <literal>settings</literal> attribute set is + used by the configuration generator and the result is placed in <literal>/etc/sr.ht/config.ini</literal>. + </para> + </section> + + <section xml:id="module-services-sourcehut-configuration"> + <title>Configuration</title> + + <para> + All configuration parameters are also stored in + <literal>/etc/sr.ht/config.ini</literal> which is generated by + the module and linked from the store to ensure that all values from <literal>config.ini</literal> + can be modified by the module. + </para> + + </section> + + <section xml:id="module-services-sourcehut-httpd"> + <title>Using an alternative webserver as reverse-proxy (e.g. <literal>httpd</literal>)</title> + <para> + By default, <package>nginx</package> is used as reverse-proxy for <package>sourcehut</package>. + However, it's possible to use e.g. <package>httpd</package> by explicitly disabling + <package>nginx</package> using <xref linkend="opt-services.nginx.enable" /> and fixing the + <literal>settings</literal>. + </para> +</section> + +</chapter> diff --git a/nixos/modules/services/misc/sourcehut/todo.nix b/nixos/modules/services/misc/sourcehut/todo.nix new file mode 100644 index 00000000000..aec773b0669 --- /dev/null +++ b/nixos/modules/services/misc/sourcehut/todo.nix @@ -0,0 +1,161 @@ +{ config, lib, pkgs, ... }: + +with lib; +let + cfg = config.services.sourcehut; + cfgIni = cfg.settings; + scfg = cfg.todo; + iniKey = "todo.sr.ht"; + + rcfg = config.services.redis; + drv = pkgs.sourcehut.todosrht; +in +{ + options.services.sourcehut.todo = { + user = mkOption { + type = types.str; + default = "todosrht"; + description = '' + User for todo.sr.ht. + ''; + }; + + port = mkOption { + type = types.port; + default = 5003; + description = '' + Port on which the "todo" module should listen. + ''; + }; + + database = mkOption { + type = types.str; + default = "todo.sr.ht"; + description = '' + PostgreSQL database name for todo.sr.ht. + ''; + }; + + statePath = mkOption { + type = types.path; + default = "${cfg.statePath}/todosrht"; + description = '' + State path for todo.sr.ht. + ''; + }; + }; + + config = with scfg; lib.mkIf (cfg.enable && elem "todo" cfg.services) { + users = { + users = { + "${user}" = { + isSystemUser = true; + group = user; + extraGroups = [ "postfix" ]; + description = "todo.sr.ht user"; + }; + }; + groups = { + "${user}" = { }; + }; + }; + + services.postgresql = { + authentication = '' + local ${database} ${user} trust + ''; + ensureDatabases = [ database ]; + ensureUsers = [ + { + name = user; + ensurePermissions = { "DATABASE \"${database}\"" = "ALL PRIVILEGES"; }; + } + ]; + }; + + systemd = { + tmpfiles.rules = [ + "d ${statePath} 0750 ${user} ${user} -" + ]; + + services = { + todosrht = import ./service.nix { inherit config pkgs lib; } scfg drv iniKey { + after = [ "postgresql.service" "network.target" ]; + requires = [ "postgresql.service" ]; + wantedBy = [ "multi-user.target" ]; + + description = "todo.sr.ht website service"; + + serviceConfig.ExecStart = "${cfg.python}/bin/gunicorn ${drv.pname}.app:app -b ${cfg.address}:${toString port}"; + }; + + todosrht-lmtp = { + after = [ "postgresql.service" "network.target" ]; + bindsTo = [ "postgresql.service" ]; + wantedBy = [ "multi-user.target" ]; + + description = "todo.sr.ht process service"; + serviceConfig = { + Type = "simple"; + User = user; + Restart = "always"; + ExecStart = "${cfg.python}/bin/todosrht-lmtp"; + }; + }; + + todosrht-webhooks = { + after = [ "postgresql.service" "network.target" ]; + requires = [ "postgresql.service" ]; + wantedBy = [ "multi-user.target" ]; + + description = "todo.sr.ht webhooks service"; + serviceConfig = { + Type = "simple"; + User = user; + Restart = "always"; + ExecStart = "${cfg.python}/bin/celery -A ${drv.pname}.webhooks worker --loglevel=info"; + }; + + }; + }; + }; + + services.sourcehut.settings = { + # URL todo.sr.ht is being served at (protocol://domain) + "todo.sr.ht".origin = mkDefault "http://todo.${cfg.originBase}"; + # Address and port to bind the debug server to + "todo.sr.ht".debug-host = mkDefault "0.0.0.0"; + "todo.sr.ht".debug-port = mkDefault port; + # Configures the SQLAlchemy connection string for the database. + "todo.sr.ht".connection-string = mkDefault "postgresql:///${database}?user=${user}&host=/var/run/postgresql"; + # Set to "yes" to automatically run migrations on package upgrade. + "todo.sr.ht".migrate-on-upgrade = mkDefault "yes"; + # todo.sr.ht's OAuth client ID and secret for meta.sr.ht + # Register your client at meta.example.org/oauth + "todo.sr.ht".oauth-client-id = mkDefault null; + "todo.sr.ht".oauth-client-secret = mkDefault null; + # Outgoing email for notifications generated by users + "todo.sr.ht".notify-from = mkDefault "CHANGEME@example.org"; + # The redis connection used for the webhooks worker + "todo.sr.ht".webhooks = mkDefault "redis://${rcfg.bind}:${toString rcfg.port}/1"; + # Network-key + "todo.sr.ht".network-key = mkDefault null; + + # Path for the lmtp daemon's unix socket. Direct incoming mail to this socket. + # Alternatively, specify IP:PORT and an SMTP server will be run instead. + "todo.sr.ht::mail".sock = mkDefault "/tmp/todo.sr.ht-lmtp.sock"; + # The lmtp daemon will make the unix socket group-read/write for users in this + # group. + "todo.sr.ht::mail".sock-group = mkDefault "postfix"; + + "todo.sr.ht::mail".posting-domain = mkDefault "todo.${cfg.originBase}"; + }; + + services.nginx.virtualHosts."todo.${cfg.originBase}" = { + forceSSL = true; + locations."/".proxyPass = "http://${cfg.address}:${toString port}"; + locations."/query".proxyPass = "http://${cfg.address}:${toString (port + 100)}"; + locations."/static".root = "${pkgs.sourcehut.todosrht}/${pkgs.sourcehut.python.sitePackages}/todosrht"; + }; + }; +} diff --git a/nixos/modules/services/misc/subsonic.nix b/nixos/modules/services/misc/subsonic.nix index 152917d345c..e17a98a5e1d 100644 --- a/nixos/modules/services/misc/subsonic.nix +++ b/nixos/modules/services/misc/subsonic.nix @@ -28,7 +28,7 @@ let cfg = config.services.subsonic; in { }; port = mkOption { - type = types.int; + type = types.port; default = 4040; description = '' The port on which Subsonic will listen for @@ -37,7 +37,7 @@ let cfg = config.services.subsonic; in { }; httpsPort = mkOption { - type = types.int; + type = types.port; default = 0; description = '' The port on which Subsonic will listen for diff --git a/nixos/modules/services/misc/synergy.nix b/nixos/modules/services/misc/synergy.nix index 7990a9f6f4c..d6cd5d7f0d6 100644 --- a/nixos/modules/services/misc/synergy.nix +++ b/nixos/modules/services/misc/synergy.nix @@ -70,6 +70,26 @@ in type = types.bool; description = "Whether the Synergy server should be started automatically."; }; + tls = { + enable = mkOption { + type = types.bool; + default = false; + description = '' + Whether TLS encryption should be used. + + Using this requires a TLS certificate that can be + generated by starting the Synergy GUI once and entering + a valid product key. + ''; + }; + + cert = mkOption { + type = types.nullOr types.str; + default = null; + example = "~/.synergy/SSL/Synergy.pem"; + description = "The TLS certificate to use for encryption."; + }; + }; }; }; @@ -95,7 +115,7 @@ in description = "Synergy server"; wantedBy = optional cfgS.autoStart "graphical-session.target"; path = [ pkgs.synergy ]; - serviceConfig.ExecStart = ''${pkgs.synergy}/bin/synergys -c ${cfgS.configFile} -f ${optionalString (cfgS.address != "") "-a ${cfgS.address}"} ${optionalString (cfgS.screenName != "") "-n ${cfgS.screenName}" }''; + serviceConfig.ExecStart = ''${pkgs.synergy}/bin/synergys -c ${cfgS.configFile} -f${optionalString (cfgS.address != "") " -a ${cfgS.address}"}${optionalString (cfgS.screenName != "") " -n ${cfgS.screenName}"}${optionalString cfgS.tls.enable " --enable-crypto"}${optionalString (cfgS.tls.cert != null) (" --tls-cert=${cfgS.tls.cert}")}''; serviceConfig.Restart = "on-failure"; }; }) diff --git a/nixos/modules/services/monitoring/grafana.nix b/nixos/modules/services/monitoring/grafana.nix index 4ebde6f9b10..e0b2624b6ca 100644 --- a/nixos/modules/services/monitoring/grafana.nix +++ b/nixos/modules/services/monitoring/grafana.nix @@ -94,7 +94,7 @@ let description = "Name of the datasource. Required."; }; type = mkOption { - type = types.enum ["graphite" "prometheus" "cloudwatch" "elasticsearch" "influxdb" "opentsdb" "mysql" "mssql" "postgres" "loki"]; + type = types.str; description = "Datasource type. Required."; }; access = mkOption { @@ -292,7 +292,7 @@ in { port = mkOption { description = "Listening port."; default = 3000; - type = types.int; + type = types.port; }; socket = mkOption { @@ -337,11 +337,16 @@ in { defaultText = "pkgs.grafana"; type = types.package; }; + declarativePlugins = mkOption { type = with types; nullOr (listOf path); default = null; description = "If non-null, then a list of packages containing Grafana plugins to install. If set, plugins cannot be manually installed."; example = literalExample "with pkgs.grafanaPlugins; [ grafana-piechart-panel ]"; + # Make sure each plugin is added only once; otherwise building + # the link farm fails, since the same path is added multiple + # times. + apply = x: if isList x then lib.unique x else x; }; dataDir = mkOption { @@ -635,20 +640,28 @@ in { QT_QPA_PLATFORM = "offscreen"; } // mapAttrs' (n: v: nameValuePair "GF_${n}" (toString v)) envOptions; script = '' + set -o errexit -o pipefail -o nounset -o errtrace + shopt -s inherit_errexit + ${optionalString (cfg.auth.google.clientSecretFile != null) '' - export GF_AUTH_GOOGLE_CLIENT_SECRET="$(cat ${escapeShellArg cfg.auth.google.clientSecretFile})" + GF_AUTH_GOOGLE_CLIENT_SECRET="$(<${escapeShellArg cfg.auth.google.clientSecretFile})" + export GF_AUTH_GOOGLE_CLIENT_SECRET ''} ${optionalString (cfg.database.passwordFile != null) '' - export GF_DATABASE_PASSWORD="$(cat ${escapeShellArg cfg.database.passwordFile})" + GF_DATABASE_PASSWORD="$(<${escapeShellArg cfg.database.passwordFile})" + export GF_DATABASE_PASSWORD ''} ${optionalString (cfg.security.adminPasswordFile != null) '' - export GF_SECURITY_ADMIN_PASSWORD="$(cat ${escapeShellArg cfg.security.adminPasswordFile})" + GF_SECURITY_ADMIN_PASSWORD="$(<${escapeShellArg cfg.security.adminPasswordFile})" + export GF_SECURITY_ADMIN_PASSWORD ''} ${optionalString (cfg.security.secretKeyFile != null) '' - export GF_SECURITY_SECRET_KEY="$(cat ${escapeShellArg cfg.security.secretKeyFile})" + GF_SECURITY_SECRET_KEY="$(<${escapeShellArg cfg.security.secretKeyFile})" + export GF_SECURITY_SECRET_KEY ''} ${optionalString (cfg.smtp.passwordFile != null) '' - export GF_SMTP_PASSWORD="$(cat ${escapeShellArg cfg.smtp.passwordFile})" + GF_SMTP_PASSWORD="$(<${escapeShellArg cfg.smtp.passwordFile})" + export GF_SMTP_PASSWORD ''} ${optionalString cfg.provision.enable '' export GF_PATHS_PROVISIONING=${provisionConfDir}; diff --git a/nixos/modules/services/monitoring/metricbeat.nix b/nixos/modules/services/monitoring/metricbeat.nix new file mode 100644 index 00000000000..b285559eaa9 --- /dev/null +++ b/nixos/modules/services/monitoring/metricbeat.nix @@ -0,0 +1,152 @@ +{ config, lib, pkgs, ... }: + +let + inherit (lib) + attrValues + literalExample + mkEnableOption + mkIf + mkOption + types + ; + cfg = config.services.metricbeat; + + settingsFormat = pkgs.formats.yaml {}; + +in +{ + options = { + + services.metricbeat = { + + enable = mkEnableOption "metricbeat"; + + package = mkOption { + type = types.package; + default = pkgs.metricbeat; + defaultText = literalExample "pkgs.metricbeat"; + example = literalExample "pkgs.metricbeat7"; + description = '' + The metricbeat package to use + ''; + }; + + modules = mkOption { + description = '' + Metricbeat modules are responsible for reading metrics from the various sources. + + This is like <literal>services.metricbeat.settings.metricbeat.modules</literal>, + but structured as an attribute set. This has the benefit that multiple + NixOS modules can contribute settings to a single metricbeat module. + + A module can be specified multiple times by choosing a different <literal><name></literal> + for each, but setting <xref linkend="opt-services.metricbeat.modules._name_.module"/> to the same value. + + See <link xlink:href="https://www.elastic.co/guide/en/beats/metricbeat/current/metricbeat-modules.html"/>. + ''; + default = {}; + type = types.attrsOf (types.submodule ({ name, ... }: { + freeformType = settingsFormat.type; + options = { + module = mkOption { + type = types.str; + default = name; + defaultText = literalExample ''<name>''; + description = '' + The name of the module. + + Look for the value after <literal>module:</literal> on the individual + module pages linked from <link xlink:href="https://www.elastic.co/guide/en/beats/metricbeat/current/metricbeat-modules.html"/>. + ''; + }; + }; + })); + example = { + system = { + metricsets = ["cpu" "load" "memory" "network" "process" "process_summary" "uptime" "socket_summary"]; + enabled = true; + period = "10s"; + processes = [".*"]; + cpu.metrics = ["percentages" "normalized_percentages"]; + core.metrics = ["percentages"]; + }; + }; + }; + + settings = mkOption { + type = types.submodule { + freeformType = settingsFormat.type; + options = { + + name = mkOption { + type = types.str; + default = ""; + description = '' + Name of the beat. Defaults to the hostname. + See <link xlink:href="https://www.elastic.co/guide/en/beats/metricbeat/current/configuration-general-options.html#_name"/>. + ''; + }; + + tags = mkOption { + type = types.listOf types.str; + default = []; + description = '' + Tags to place on the shipped metrics. + See <link xlink:href="https://www.elastic.co/guide/en/beats/metricbeat/current/configuration-general-options.html#_tags_2"/>. + ''; + }; + + metricbeat.modules = mkOption { + type = types.listOf settingsFormat.type; + default = []; + internal = true; + description = '' + The metric collecting modules. Use <xref linkend="opt-services.metricbeat.modules"/> instead. + + See <link xlink:href="https://www.elastic.co/guide/en/beats/metricbeat/current/metricbeat-modules.html"/>. + ''; + }; + }; + }; + default = {}; + description = '' + Configuration for metricbeat. See <link xlink:href="https://www.elastic.co/guide/en/beats/metricbeat/current/configuring-howto-metricbeat.html"/> for supported values. + ''; + }; + + }; + }; + + config = mkIf cfg.enable { + + assertions = [ + { + # empty modules would cause a failure at runtime + assertion = cfg.settings.metricbeat.modules != []; + message = "services.metricbeat: You must configure one or more modules."; + } + ]; + + services.metricbeat.settings.metricbeat.modules = attrValues cfg.modules; + + systemd.services.metricbeat = { + description = "metricbeat metrics shipper"; + wantedBy = [ "multi-user.target" ]; + serviceConfig = { + ExecStart = '' + ${cfg.package}/bin/metricbeat \ + -c ${settingsFormat.generate "metricbeat.yml" cfg.settings} \ + --path.data $STATE_DIRECTORY \ + --path.logs $LOGS_DIRECTORY \ + ; + ''; + Restart = "always"; + DynamicUser = true; + ProtectSystem = "strict"; + ProtectHome = "tmpfs"; + StateDirectory = "metricbeat"; + LogsDirectory = "metricbeat"; + }; + }; + }; +} diff --git a/nixos/modules/services/monitoring/prometheus/default.nix b/nixos/modules/services/monitoring/prometheus/default.nix index e08f23d8eb0..3be247ffb24 100644 --- a/nixos/modules/services/monitoring/prometheus/default.nix +++ b/nixos/modules/services/monitoring/prometheus/default.nix @@ -323,15 +323,13 @@ let HTTP username ''; }; - password = mkOption { - type = types.str; - description = '' - HTTP password - ''; - }; + password = mkOpt types.str "HTTP password"; + password_file = mkOpt types.str "HTTP password file"; }; }) '' - Optional http login credentials for metrics scraping. + Sets the `Authorization` header on every scrape request with the + configured username and password. + password and password_file are mutually exclusive. ''; bearer_token = mkOpt types.str '' @@ -945,6 +943,7 @@ in { RuntimeDirectoryMode = "0700"; WorkingDirectory = workingDir; StateDirectory = cfg.stateDir; + StateDirectoryMode = "0700"; }; }; }; diff --git a/nixos/modules/services/monitoring/prometheus/exporters.nix b/nixos/modules/services/monitoring/prometheus/exporters.nix index 9fcfe7b52e0..d648de6a414 100644 --- a/nixos/modules/services/monitoring/prometheus/exporters.nix +++ b/nixos/modules/services/monitoring/prometheus/exporters.nix @@ -27,6 +27,7 @@ let "bird" "bitcoin" "blackbox" + "buildkite-agent" "collectd" "dnsmasq" "domain" @@ -51,10 +52,12 @@ let "pihole" "postfix" "postgres" + "process" "py-air-control" "redis" "rspamd" "rtl_433" + "script" "snmp" "smokeping" "sql" @@ -178,7 +181,7 @@ let serviceConfig.PrivateTmp = mkDefault true; serviceConfig.WorkingDirectory = mkDefault /tmp; serviceConfig.DynamicUser = mkDefault enableDynamicUser; - serviceConfig.User = conf.user; + serviceConfig.User = mkDefault conf.user; serviceConfig.Group = conf.group; } serviceOpts ]); }; diff --git a/nixos/modules/services/monitoring/prometheus/exporters/buildkite-agent.nix b/nixos/modules/services/monitoring/prometheus/exporters/buildkite-agent.nix new file mode 100644 index 00000000000..7557480ac06 --- /dev/null +++ b/nixos/modules/services/monitoring/prometheus/exporters/buildkite-agent.nix @@ -0,0 +1,64 @@ +{ config, lib, pkgs, options }: + +with lib; + +let + cfg = config.services.prometheus.exporters.buildkite-agent; +in +{ + port = 9876; + extraOpts = { + tokenPath = mkOption { + type = types.nullOr types.path; + apply = final: if final == null then null else toString final; + description = '' + The token from your Buildkite "Agents" page. + + A run-time path to the token file, which is supposed to be provisioned + outside of Nix store. + ''; + }; + interval = mkOption { + type = types.str; + default = "30s"; + example = "1min"; + description = '' + How often to update metrics. + ''; + }; + endpoint = mkOption { + type = types.str; + default = "https://agent.buildkite.com/v3"; + description = '' + The Buildkite Agent API endpoint. + ''; + }; + queues = mkOption { + type = with types; nullOr (listOf str); + default = null; + example = literalExample ''[ "my-queue1" "my-queue2" ]''; + description = '' + Which specific queues to process. + ''; + }; + }; + serviceOpts = { + script = + let + queues = concatStringsSep " " (map (q: "-queue ${q}") cfg.queues); + in + '' + export BUILDKITE_AGENT_TOKEN="$(cat ${toString cfg.tokenPath})" + exec ${pkgs.buildkite-agent-metrics}/bin/buildkite-agent-metrics \ + -backend prometheus \ + -interval ${cfg.interval} \ + -endpoint ${cfg.endpoint} \ + ${optionalString (cfg.queues != null) queues} \ + -prometheus-addr "${cfg.listenAddress}:${toString cfg.port}" ${concatStringsSep " " cfg.extraFlags} + ''; + serviceConfig = { + DynamicUser = false; + RuntimeDirectory = "buildkite-agent-metrics"; + }; + }; +} diff --git a/nixos/modules/services/monitoring/prometheus/exporters/dovecot.nix b/nixos/modules/services/monitoring/prometheus/exporters/dovecot.nix index aba3533e439..472652fe8a7 100644 --- a/nixos/modules/services/monitoring/prometheus/exporters/dovecot.nix +++ b/nixos/modules/services/monitoring/prometheus/exporters/dovecot.nix @@ -35,13 +35,28 @@ in { <xref linkend="opt-services.prometheus.exporters.dovecot.enable" /> = true; <xref linkend="opt-services.prometheus.exporters.dovecot.socketPath" /> = "/var/run/dovecot2/old-stats"; + <xref linkend="opt-services.dovecot2.mailPlugins.globally.enable" /> = [ "old_stats" ]; <xref linkend="opt-services.dovecot2.extraConfig" /> = ''' - mail_plugins = $mail_plugins old_stats service old-stats { unix_listener old-stats { user = dovecot-exporter group = dovecot-exporter + mode = 0660 } + fifo_listener old-stats-mail { + mode = 0660 + user = dovecot + group = dovecot + } + fifo_listener old-stats-user { + mode = 0660 + user = dovecot + group = dovecot + } + } + plugin { + old_stats_refresh = 30 secs + old_stats_track_cmds = yes } '''; } diff --git a/nixos/modules/services/monitoring/prometheus/exporters/kea.nix b/nixos/modules/services/monitoring/prometheus/exporters/kea.nix index b6cd89c3866..9677281f877 100644 --- a/nixos/modules/services/monitoring/prometheus/exporters/kea.nix +++ b/nixos/modules/services/monitoring/prometheus/exporters/kea.nix @@ -26,6 +26,7 @@ in { }; serviceOpts = { serviceConfig = { + User = "kea"; ExecStart = '' ${pkgs.prometheus-kea-exporter}/bin/kea-exporter \ --address ${cfg.listenAddress} \ diff --git a/nixos/modules/services/monitoring/prometheus/exporters/mail.nix b/nixos/modules/services/monitoring/prometheus/exporters/mail.nix index 18c5c4dd162..7e196149fbb 100644 --- a/nixos/modules/services/monitoring/prometheus/exporters/mail.nix +++ b/nixos/modules/services/monitoring/prometheus/exporters/mail.nix @@ -112,6 +112,24 @@ let ''; description = '' List of servers that should be probed. + + <emphasis>Note:</emphasis> if your mailserver has <citerefentry> + <refentrytitle>rspamd</refentrytitle><manvolnum>8</manvolnum></citerefentry> configured, + it can happen that emails from this exporter are marked as spam. + + It's possible to work around the issue with a config like this: + <programlisting> + { + <link linkend="opt-services.rspamd.locals._name_.text">services.rspamd.locals."multimap.conf".text</link> = ''' + ALLOWLIST_PROMETHEUS { + filter = "email:domain:tld"; + type = "from"; + map = "''${pkgs.writeText "allowmap" "domain.tld"}"; + score = -100.0; + } + '''; + } + </programlisting> ''; }; }; diff --git a/nixos/modules/services/monitoring/prometheus/exporters/process.nix b/nixos/modules/services/monitoring/prometheus/exporters/process.nix new file mode 100644 index 00000000000..e3b3d18367f --- /dev/null +++ b/nixos/modules/services/monitoring/prometheus/exporters/process.nix @@ -0,0 +1,48 @@ +{ config, lib, pkgs, options }: + +with lib; + +let + cfg = config.services.prometheus.exporters.process; + configFile = pkgs.writeText "process-exporter.yaml" (builtins.toJSON cfg.settings); +in +{ + port = 9256; + extraOpts = { + settings.process_names = mkOption { + type = types.listOf types.anything; + default = {}; + example = literalExample '' + { + process_names = [ + # Remove nix store path from process name + { name = "{{.Matches.Wrapped}} {{ .Matches.Args }}"; cmdline = [ "^/nix/store[^ ]*/(?P<Wrapped>[^ /]*) (?P<Args>.*)" ]; } + ]; + } + ''; + description = '' + All settings expressed as an Nix attrset. + + Check the official documentation for the corresponding YAML + settings that can all be used here: <link xlink:href="https://github.com/ncabatoff/process-exporter" /> + ''; + }; + }; + serviceOpts = { + serviceConfig = { + DynamicUser = false; + ExecStart = '' + ${pkgs.prometheus-process-exporter}/bin/process-exporter \ + --web.listen-address ${cfg.listenAddress}:${toString cfg.port} \ + --config.path ${configFile} \ + ${concatStringsSep " \\\n " cfg.extraFlags} + ''; + NoNewPrivileges = true; + ProtectHome = true; + ProtectSystem = true; + ProtectKernelTunables = true; + ProtectKernelModules = true; + ProtectControlGroups = true; + }; + }; +} diff --git a/nixos/modules/services/monitoring/prometheus/exporters/rspamd.nix b/nixos/modules/services/monitoring/prometheus/exporters/rspamd.nix index d95e5ed9e83..994670a376e 100644 --- a/nixos/modules/services/monitoring/prometheus/exporters/rspamd.nix +++ b/nixos/modules/services/monitoring/prometheus/exporters/rspamd.nix @@ -5,21 +5,19 @@ with lib; let cfg = config.services.prometheus.exporters.rspamd; - prettyJSON = conf: - pkgs.runCommand "rspamd-exporter-config.yml" { } '' - echo '${builtins.toJSON conf}' | ${pkgs.buildPackages.jq}/bin/jq '.' > $out - ''; + mkFile = conf: + pkgs.writeText "rspamd-exporter-config.yml" (builtins.toJSON conf); generateConfig = extraLabels: { metrics = (map (path: { - name = "rspamd_${replaceStrings [ "." " " ] [ "_" "_" ] path}"; + name = "rspamd_${replaceStrings [ "[" "." " " "]" "\\" "'" ] [ "_" "_" "_" "" "" "" ] path}"; path = "{ .${path} }"; labels = extraLabels; }) [ - "actions.'add header'" - "actions.'no action'" - "actions.'rewrite subject'" - "actions.'soft reject'" + "actions['add\\ header']" + "actions['no\\ action']" + "actions['rewrite\\ subject']" + "actions['soft\\ reject']" "actions.greylist" "actions.reject" "bytes_allocated" @@ -40,18 +38,18 @@ let ]) ++ [{ name = "rspamd_statfiles"; type = "object"; - path = "$.statfiles[*]"; + path = "{.statfiles[*]}"; labels = recursiveUpdate { - symbol = "$.symbol"; - type = "$.type"; + symbol = "{.symbol}"; + type = "{.type}"; } extraLabels; values = { - revision = "$.revision"; - size = "$.size"; - total = "$.total"; - used = "$.used"; - languages = "$.languages"; - users = "$.users"; + revision = "{.revision}"; + size = "{.size}"; + total = "{.total}"; + used = "{.used}"; + languages = "{.languages}"; + users = "{.users}"; }; }]; }; @@ -76,7 +74,7 @@ in }; serviceOpts.serviceConfig.ExecStart = '' ${pkgs.prometheus-json-exporter}/bin/json_exporter \ - --config.file ${prettyJSON (generateConfig cfg.extraLabels)} \ + --config.file ${mkFile (generateConfig cfg.extraLabels)} \ --web.listen-address "${cfg.listenAddress}:${toString cfg.port}" \ ${concatStringsSep " \\\n " cfg.extraFlags} ''; diff --git a/nixos/modules/services/monitoring/prometheus/exporters/script.nix b/nixos/modules/services/monitoring/prometheus/exporters/script.nix new file mode 100644 index 00000000000..104ab859f2e --- /dev/null +++ b/nixos/modules/services/monitoring/prometheus/exporters/script.nix @@ -0,0 +1,64 @@ +{ config, lib, pkgs, options }: + +with lib; + +let + cfg = config.services.prometheus.exporters.script; + configFile = pkgs.writeText "script-exporter.yaml" (builtins.toJSON cfg.settings); +in +{ + port = 9172; + extraOpts = { + settings.scripts = mkOption { + type = with types; listOf (submodule { + options = { + name = mkOption { + type = str; + example = "sleep"; + description = "Name of the script."; + }; + script = mkOption { + type = str; + example = "sleep 5"; + description = "Shell script to execute when metrics are requested."; + }; + timeout = mkOption { + type = nullOr int; + default = null; + example = 60; + description = "Optional timeout for the script in seconds."; + }; + }; + }); + example = literalExample '' + { + scripts = [ + { name = "sleep"; script = "sleep 5"; } + ]; + } + ''; + description = '' + All settings expressed as an Nix attrset. + + Check the official documentation for the corresponding YAML + settings that can all be used here: <link xlink:href="https://github.com/adhocteam/script_exporter#sample-configuration" /> + ''; + }; + }; + serviceOpts = { + serviceConfig = { + ExecStart = '' + ${pkgs.prometheus-script-exporter}/bin/script_exporter \ + --web.listen-address ${cfg.listenAddress}:${toString cfg.port} \ + --config.file ${configFile} \ + ${concatStringsSep " \\\n " cfg.extraFlags} + ''; + NoNewPrivileges = true; + ProtectHome = true; + ProtectSystem = "strict"; + ProtectKernelTunables = true; + ProtectKernelModules = true; + ProtectControlGroups = true; + }; + }; +} diff --git a/nixos/modules/services/monitoring/telegraf.nix b/nixos/modules/services/monitoring/telegraf.nix index bc30ca3b77c..4046260c164 100644 --- a/nixos/modules/services/monitoring/telegraf.nix +++ b/nixos/modules/services/monitoring/telegraf.nix @@ -25,10 +25,9 @@ in { default = []; example = "/run/keys/telegraf.env"; description = '' - File to load as environment file. Environment variables - from this file will be interpolated into the config file - using envsubst with this syntax: - <literal>$ENVIRONMENT ''${VARIABLE}</literal> + File to load as environment file. Environment variables from this file + will be interpolated into the config file using envsubst with this + syntax: <literal>$ENVIRONMENT</literal> or <literal>''${VARIABLE}</literal>. This is useful to avoid putting secrets into the nix store. ''; }; @@ -73,6 +72,7 @@ in { ExecReload="${pkgs.coreutils}/bin/kill -HUP $MAINPID"; RuntimeDirectory = "telegraf"; User = "telegraf"; + Group = "telegraf"; Restart = "on-failure"; # for ping probes AmbientCapabilities = [ "CAP_NET_RAW" ]; @@ -81,7 +81,10 @@ in { users.users.telegraf = { uid = config.ids.uids.telegraf; + group = "telegraf"; description = "telegraf daemon user"; }; + + users.groups.telegraf = {}; }; } diff --git a/nixos/modules/services/monitoring/zabbix-agent.nix b/nixos/modules/services/monitoring/zabbix-agent.nix index e7dd9e3393d..7eb6449e384 100644 --- a/nixos/modules/services/monitoring/zabbix-agent.nix +++ b/nixos/modules/services/monitoring/zabbix-agent.nix @@ -157,7 +157,10 @@ in wantedBy = [ "multi-user.target" ]; - path = [ "/run/wrappers" ] ++ cfg.extraPackages; + # https://www.zabbix.com/documentation/current/manual/config/items/userparameters + # > User parameters are commands executed by Zabbix agent. + # > /bin/sh is used as a command line interpreter under UNIX operating systems. + path = with pkgs; [ bash "/run/wrappers" ] ++ cfg.extraPackages; serviceConfig = { ExecStart = "@${cfg.package}/sbin/zabbix_agentd zabbix_agentd -f --config ${configFile}"; diff --git a/nixos/modules/services/network-filesystems/davfs2.nix b/nixos/modules/services/network-filesystems/davfs2.nix index 4b6f85e4a2c..8cf314fe63a 100644 --- a/nixos/modules/services/network-filesystems/davfs2.nix +++ b/nixos/modules/services/network-filesystems/davfs2.nix @@ -70,6 +70,24 @@ in }; }; + security.wrappers."mount.davfs" = { + program = "mount.davfs"; + source = "${pkgs.davfs2}/bin/mount.davfs"; + owner = "root"; + group = cfg.davGroup; + setuid = true; + permissions = "u+rx,g+x"; + }; + + security.wrappers."umount.davfs" = { + program = "umount.davfs"; + source = "${pkgs.davfs2}/bin/umount.davfs"; + owner = "root"; + group = cfg.davGroup; + setuid = true; + permissions = "u+rx,g+x"; + }; + }; } diff --git a/nixos/modules/services/network-filesystems/ipfs.nix b/nixos/modules/services/network-filesystems/ipfs.nix index 6d8dfcce933..2748571be1f 100644 --- a/nixos/modules/services/network-filesystems/ipfs.nix +++ b/nixos/modules/services/network-filesystems/ipfs.nix @@ -231,9 +231,9 @@ in { } fi '' + optionalString cfg.autoMount '' - ipfs --local config Mounts.FuseAllowOther --json true - ipfs --local config Mounts.IPFS ${cfg.ipfsMountDir} - ipfs --local config Mounts.IPNS ${cfg.ipnsMountDir} + ipfs --offline config Mounts.FuseAllowOther --json true + ipfs --offline config Mounts.IPFS ${cfg.ipfsMountDir} + ipfs --offline config Mounts.IPNS ${cfg.ipnsMountDir} '' + concatStringsSep "\n" (collect isString (mapAttrsRecursive @@ -243,7 +243,7 @@ in { read value <<EOF ${builtins.toJSON value} EOF - ipfs --local config --json "${concatStringsSep "." path}" "$value" + ipfs --offline config --json "${concatStringsSep "." path}" "$value" '') ({ Addresses.API = cfg.apiAddress; Addresses.Gateway = cfg.gatewayAddress; diff --git a/nixos/modules/services/networking/avahi-daemon.nix b/nixos/modules/services/networking/avahi-daemon.nix index 0b7d5575c11..020a817f259 100644 --- a/nixos/modules/services/networking/avahi-daemon.nix +++ b/nixos/modules/services/networking/avahi-daemon.nix @@ -240,8 +240,8 @@ in system.nssModules = optional cfg.nssmdns pkgs.nssmdns; system.nssDatabases.hosts = optionals cfg.nssmdns (mkMerge [ - (mkOrder 900 [ "mdns_minimal [NOTFOUND=return]" ]) # must be before resolve - (mkOrder 1501 [ "mdns" ]) # 1501 to ensure it's after dns + (mkBefore [ "mdns_minimal [NOTFOUND=return]" ]) # before resolve + (mkAfter [ "mdns" ]) # after dns ]); environment.systemPackages = [ pkgs.avahi ]; diff --git a/nixos/modules/services/networking/babeld.nix b/nixos/modules/services/networking/babeld.nix index 5e14283179a..aae6f1498a4 100644 --- a/nixos/modules/services/networking/babeld.nix +++ b/nixos/modules/services/networking/babeld.nix @@ -104,6 +104,7 @@ in ExecStart = "${pkgs.babeld}/bin/babeld -c ${configFile} -I /run/babeld/babeld.pid -S /var/lib/babeld/state"; AmbientCapabilities = [ "CAP_NET_ADMIN" ]; CapabilityBoundingSet = [ "CAP_NET_ADMIN" ]; + DevicePolicy = "closed"; DynamicUser = true; IPAddressAllow = [ "fe80::/64" "ff00::/8" "::1/128" "127.0.0.0/8" ]; IPAddressDeny = "any"; @@ -123,12 +124,17 @@ in RemoveIPC = true; ProtectHome = true; ProtectHostname = true; + ProtectProc = "invisible"; PrivateMounts = true; PrivateTmp = true; PrivateDevices = true; PrivateUsers = false; # kernel_route(ADD): Operation not permitted + ProcSubset = "pid"; SystemCallArchitectures = "native"; - SystemCallFilter = [ "@system-service" ]; + SystemCallFilter = [ + "@system-service" + "~@privileged @resources" + ]; UMask = "0177"; RuntimeDirectory = "babeld"; StateDirectory = "babeld"; diff --git a/nixos/modules/services/networking/bind.nix b/nixos/modules/services/networking/bind.nix index 20eef2c3455..480d5a184f2 100644 --- a/nixos/modules/services/networking/bind.nix +++ b/nixos/modules/services/networking/bind.nix @@ -6,6 +6,8 @@ let cfg = config.services.bind; + bindPkg = config.services.bind.package; + bindUser = "named"; bindZoneCoerce = list: builtins.listToAttrs (lib.forEach list (zone: { name = zone.name; value = zone; })); @@ -59,7 +61,7 @@ let blackhole { badnetworks; }; forward first; forwarders { ${concatMapStrings (entry: " ${entry}; ") cfg.forwarders} }; - directory "/run/named"; + directory "${cfg.directory}"; pid-file "/run/named/named.pid"; ${cfg.extraOptions} }; @@ -104,6 +106,14 @@ in enable = mkEnableOption "BIND domain name server"; + + package = mkOption { + type = types.package; + default = pkgs.bind; + defaultText = "pkgs.bind"; + description = "The BIND package to use."; + }; + cacheNetworks = mkOption { default = [ "127.0.0.0/24" ]; type = types.listOf types.str; @@ -156,6 +166,12 @@ in "; }; + directory = mkOption { + type = types.str; + default = "/run/named"; + description = "Working directory of BIND."; + }; + zones = mkOption { default = [ ]; type = with types; coercedTo (listOf attrs) bindZoneCoerce (attrsOf (types.submodule bindZoneOptions)); @@ -225,17 +241,20 @@ in preStart = '' mkdir -m 0755 -p /etc/bind if ! [ -f "/etc/bind/rndc.key" ]; then - ${pkgs.bind.out}/sbin/rndc-confgen -c /etc/bind/rndc.key -u ${bindUser} -a -A hmac-sha256 2>/dev/null + ${bindPkg.out}/sbin/rndc-confgen -c /etc/bind/rndc.key -u ${bindUser} -a -A hmac-sha256 2>/dev/null fi ${pkgs.coreutils}/bin/mkdir -p /run/named chown ${bindUser} /run/named + + ${pkgs.coreutils}/bin/mkdir -p ${cfg.directory} + chown ${bindUser} ${cfg.directory} ''; serviceConfig = { - ExecStart = "${pkgs.bind.out}/sbin/named -u ${bindUser} ${optionalString cfg.ipv4Only "-4"} -c ${cfg.configFile} -f"; - ExecReload = "${pkgs.bind.out}/sbin/rndc -k '/etc/bind/rndc.key' reload"; - ExecStop = "${pkgs.bind.out}/sbin/rndc -k '/etc/bind/rndc.key' stop"; + ExecStart = "${bindPkg.out}/sbin/named -u ${bindUser} ${optionalString cfg.ipv4Only "-4"} -c ${cfg.configFile} -f"; + ExecReload = "${bindPkg.out}/sbin/rndc -k '/etc/bind/rndc.key' reload"; + ExecStop = "${bindPkg.out}/sbin/rndc -k '/etc/bind/rndc.key' stop"; }; unitConfig.Documentation = "man:named(8)"; diff --git a/nixos/modules/services/networking/corerad.nix b/nixos/modules/services/networking/corerad.nix index 4acdd1d69cc..e76ba9a2d00 100644 --- a/nixos/modules/services/networking/corerad.nix +++ b/nixos/modules/services/networking/corerad.nix @@ -37,7 +37,7 @@ in { } ''; description = '' - Configuration for CoreRAD, see <link xlink:href="https://github.com/mdlayher/corerad/blob/master/internal/config/default.toml"/> + Configuration for CoreRAD, see <link xlink:href="https://github.com/mdlayher/corerad/blob/main/internal/config/reference.toml"/> for supported values. Ignored if configFile is set. ''; }; diff --git a/nixos/modules/services/networking/coturn.nix b/nixos/modules/services/networking/coturn.nix index 1bfbc307c59..5f7d2893ae2 100644 --- a/nixos/modules/services/networking/coturn.nix +++ b/nixos/modules/services/networking/coturn.nix @@ -16,6 +16,7 @@ ${lib.optionalString cfg.lt-cred-mech "lt-cred-mech"} ${lib.optionalString cfg.no-auth "no-auth"} ${lib.optionalString cfg.use-auth-secret "use-auth-secret"} ${lib.optionalString (cfg.static-auth-secret != null) ("static-auth-secret=${cfg.static-auth-secret}")} +${lib.optionalString (cfg.static-auth-secret-file != null) ("static-auth-secret=#static-auth-secret#")} realm=${cfg.realm} ${lib.optionalString cfg.no-udp "no-udp"} ${lib.optionalString cfg.no-tcp "no-tcp"} @@ -182,6 +183,13 @@ in { by a separate program, so this is why that other mode is 'dynamic'. ''; }; + static-auth-secret-file = mkOption { + type = types.nullOr types.str; + default = null; + description = '' + Path to the file containing the static authentication secret. + ''; + }; realm = mkOption { type = types.str; default = config.networking.hostName; @@ -293,42 +301,63 @@ in { }; }; - config = mkIf cfg.enable { - users.users.turnserver = - { uid = config.ids.uids.turnserver; - description = "coturn TURN server user"; - }; - users.groups.turnserver = - { gid = config.ids.gids.turnserver; - members = [ "turnserver" ]; - }; + config = mkIf cfg.enable (mkMerge ([ + { assertions = [ + { assertion = cfg.static-auth-secret != null -> cfg.static-auth-secret-file == null ; + message = "static-auth-secret and static-auth-secret-file cannot be set at the same time"; + } + ];} - systemd.services.coturn = { - description = "coturn TURN server"; - after = [ "network-online.target" ]; - wants = [ "network-online.target" ]; - wantedBy = [ "multi-user.target" ]; + { + users.users.turnserver = + { uid = config.ids.uids.turnserver; + description = "coturn TURN server user"; + }; + users.groups.turnserver = + { gid = config.ids.gids.turnserver; + members = [ "turnserver" ]; + }; - unitConfig = { - Documentation = "man:coturn(1) man:turnadmin(1) man:turnserver(1)"; - }; + systemd.services.coturn = let + runConfig = "/run/coturn/turnserver.cfg"; + in { + description = "coturn TURN server"; + after = [ "network-online.target" ]; + wants = [ "network-online.target" ]; + wantedBy = [ "multi-user.target" ]; - serviceConfig = { - Type = "simple"; - ExecStart = "${pkgs.coturn}/bin/turnserver -c ${configFile}"; - RuntimeDirectory = "turnserver"; - User = "turnserver"; - Group = "turnserver"; - AmbientCapabilities = - mkIf ( - cfg.listening-port < 1024 || - cfg.alt-listening-port < 1024 || - cfg.tls-listening-port < 1024 || - cfg.alt-tls-listening-port < 1024 || - cfg.min-port < 1024 - ) "cap_net_bind_service"; - Restart = "on-abort"; - }; - }; - }; + unitConfig = { + Documentation = "man:coturn(1) man:turnadmin(1) man:turnserver(1)"; + }; + + preStart = '' + cat ${configFile} > ${runConfig} + ${optionalString (cfg.static-auth-secret-file != null) '' + STATIC_AUTH_SECRET="$(head -n1 ${cfg.static-auth-secret-file} || :)" + sed -e "s,#static-auth-secret#,$STATIC_AUTH_SECRET,g" \ + -i ${runConfig} + '' } + chmod 640 ${runConfig} + ''; + serviceConfig = { + Type = "simple"; + ExecStart = "${pkgs.coturn}/bin/turnserver -c ${runConfig}"; + RuntimeDirectory = "turnserver"; + User = "turnserver"; + Group = "turnserver"; + AmbientCapabilities = + mkIf ( + cfg.listening-port < 1024 || + cfg.alt-listening-port < 1024 || + cfg.tls-listening-port < 1024 || + cfg.alt-tls-listening-port < 1024 || + cfg.min-port < 1024 + ) "cap_net_bind_service"; + Restart = "on-abort"; + }; + }; + systemd.tmpfiles.rules = [ + "d /run/coturn 0700 turnserver turnserver - -" + ]; + }])); } diff --git a/nixos/modules/services/networking/ddclient.nix b/nixos/modules/services/networking/ddclient.nix index 053efe71270..7820eedd932 100644 --- a/nixos/modules/services/networking/ddclient.nix +++ b/nixos/modules/services/networking/ddclient.nix @@ -18,6 +18,7 @@ let ${lib.optionalString (cfg.zone != "") "zone=${cfg.zone}"} ssl=${boolToStr cfg.ssl} wildcard=YES + ipv6=${boolToStr cfg.ipv6} quiet=${boolToStr cfg.quiet} verbose=${boolToStr cfg.verbose} ${cfg.extraConfig} @@ -116,7 +117,15 @@ with lib; default = true; type = bool; description = '' - Whether to use to use SSL/TLS to connect to dynamic DNS provider. + Whether to use SSL/TLS to connect to dynamic DNS provider. + ''; + }; + + ipv6 = mkOption { + default = false; + type = bool; + description = '' + Whether to use IPv6. ''; }; diff --git a/nixos/modules/services/networking/firefox/sync-server.nix b/nixos/modules/services/networking/firefox/sync-server.nix index 6842aa73561..24f76864953 100644 --- a/nixos/modules/services/networking/firefox/sync-server.nix +++ b/nixos/modules/services/networking/firefox/sync-server.nix @@ -67,7 +67,7 @@ in }; listen.port = mkOption { - type = types.int; + type = types.port; default = 5000; description = '' Port on which the sync server listen to. diff --git a/nixos/modules/services/networking/gale.nix b/nixos/modules/services/networking/gale.nix deleted file mode 100644 index cb954fd836b..00000000000 --- a/nixos/modules/services/networking/gale.nix +++ /dev/null @@ -1,181 +0,0 @@ -{ config, lib, pkgs, ... }: - -with lib; - -let - cfg = config.services.gale; - # we convert the path to a string to avoid it being copied to the nix store, - # otherwise users could read the private key as all files in the store are - # world-readable - keyPath = toString cfg.keyPath; - # ...but we refer to the pubkey file using a path so that we can ensure the - # config gets rebuilt if the public key changes (we can assume the private key - # will never change without the public key having changed) - gpubFile = cfg.keyPath + "/${cfg.domain}.gpub"; - home = "/var/lib/gale"; - keysPrepared = cfg.keyPath != null && lib.pathExists cfg.keyPath; -in -{ - options = { - services.gale = { - enable = mkEnableOption "the Gale messaging daemon"; - - user = mkOption { - default = "gale"; - type = types.str; - description = "Username for the Gale daemon."; - }; - - group = mkOption { - default = "gale"; - type = types.str; - description = "Group name for the Gale daemon."; - }; - - setuidWrapper = mkOption { - default = null; - description = "Configuration for the Gale gksign setuid wrapper."; - }; - - domain = mkOption { - default = ""; - type = types.str; - description = "Domain name for the Gale system."; - }; - - keyPath = mkOption { - default = null; - type = types.nullOr types.path; - description = '' - Directory containing the key pair for this Gale domain. The expected - filename will be taken from the domain option with ".gpri" and ".gpub" - appended. - ''; - }; - - extraConfig = mkOption { - type = types.lines; - default = ""; - description = '' - Additional text to be added to <filename>/etc/gale/conf</filename>. - ''; - }; - }; - }; - - config = mkMerge [ - (mkIf cfg.enable { - assertions = [{ - assertion = cfg.domain != ""; - message = "A domain must be set for Gale."; - }]; - - warnings = mkIf (!keysPrepared) [ - "You must run gale-install in order to generate a domain key." - ]; - - system.activationScripts.gale = mkIf cfg.enable ( - stringAfter [ "users" "groups" ] '' - chmod 755 ${home} - mkdir -m 0777 -p ${home}/auth/cache - mkdir -m 1777 -p ${home}/auth/local # GALE_DOMAIN.gpub - mkdir -m 0700 -p ${home}/auth/private # ROOT.gpub - mkdir -m 0755 -p ${home}/auth/trusted # ROOT - mkdir -m 0700 -p ${home}/.gale - mkdir -m 0700 -p ${home}/.gale/auth - mkdir -m 0700 -p ${home}/.gale/auth/private # GALE_DOMAIN.gpri - - ln -sf ${pkgs.gale}/etc/gale/auth/trusted/ROOT "${home}/auth/trusted/ROOT" - chown ${cfg.user}:${cfg.group} ${home} ${home}/auth ${home}/auth/* - chown ${cfg.user}:${cfg.group} ${home}/.gale ${home}/.gale/auth ${home}/.gale/auth/private - '' - ); - - environment = { - etc = { - "gale/auth".source = home + "/auth"; # symlink /var/lib/gale/auth - "gale/conf".text = '' - GALE_USER ${cfg.user} - GALE_DOMAIN ${cfg.domain} - ${cfg.extraConfig} - ''; - }; - - systemPackages = [ pkgs.gale ]; - }; - - users.users.${cfg.user} = { - description = "Gale daemon"; - uid = config.ids.uids.gale; - group = cfg.group; - home = home; - createHome = true; - }; - - users.groups = [{ - name = cfg.group; - gid = config.ids.gids.gale; - }]; - }) - (mkIf (cfg.enable && keysPrepared) { - assertions = [ - { - assertion = cfg.keyPath != null - && lib.pathExists (cfg.keyPath + "/${cfg.domain}.gpub"); - message = "Couldn't find a Gale public key for ${cfg.domain}."; - } - { - assertion = cfg.keyPath != null - && lib.pathExists (cfg.keyPath + "/${cfg.domain}.gpri"); - message = "Couldn't find a Gale private key for ${cfg.domain}."; - } - ]; - - services.gale.setuidWrapper = { - program = "gksign"; - source = "${pkgs.gale}/bin/gksign"; - owner = cfg.user; - group = cfg.group; - setuid = true; - setgid = false; - }; - - security.wrappers.gksign = cfg.setuidWrapper; - - systemd.services.gale-galed = { - description = "Gale messaging daemon"; - wantedBy = [ "multi-user.target" ]; - wants = [ "gale-gdomain.service" ]; - after = [ "network.target" ]; - - preStart = '' - install -m 0640 -o ${cfg.user} -g ${cfg.group} ${keyPath}/${cfg.domain}.gpri "${home}/.gale/auth/private/" - install -m 0644 -o ${cfg.user} -g ${cfg.group} ${gpubFile} "${home}/.gale/auth/private/${cfg.domain}.gpub" - install -m 0644 -o ${cfg.user} -g ${cfg.group} ${gpubFile} "${home}/auth/local/${cfg.domain}.gpub" - ''; - - serviceConfig = { - Type = "forking"; - ExecStart = "@${pkgs.gale}/bin/galed galed"; - User = cfg.user; - Group = cfg.group; - PermissionsStartOnly = true; - }; - }; - - systemd.services.gale-gdomain = { - description = "Gale AKD daemon"; - wantedBy = [ "multi-user.target" ]; - requires = [ "gale-galed.service" ]; - after = [ "gale-galed.service" ]; - - serviceConfig = { - Type = "forking"; - ExecStart = "@${pkgs.gale}/bin/gdomain gdomain"; - User = cfg.user; - Group = cfg.group; - }; - }; - }) - ]; -} diff --git a/nixos/modules/services/networking/git-daemon.nix b/nixos/modules/services/networking/git-daemon.nix index 52c895215fb..98f80dd4bc4 100644 --- a/nixos/modules/services/networking/git-daemon.nix +++ b/nixos/modules/services/networking/git-daemon.nix @@ -74,7 +74,7 @@ in }; port = mkOption { - type = types.int; + type = types.port; default = 9418; description = "Port to listen on."; }; diff --git a/nixos/modules/services/networking/globalprotect-vpn.nix b/nixos/modules/services/networking/globalprotect-vpn.nix new file mode 100644 index 00000000000..367a42687e1 --- /dev/null +++ b/nixos/modules/services/networking/globalprotect-vpn.nix @@ -0,0 +1,43 @@ +{ config, lib, pkgs, ... }: + +with lib; + +let + cfg = config.services.globalprotect; + + execStart = if cfg.csdWrapper == null then + "${pkgs.globalprotect-openconnect}/bin/gpservice" + else + "${pkgs.globalprotect-openconnect}/bin/gpservice --csd-wrapper=${cfg.csdWrapper}"; +in + +{ + options.services.globalprotect = { + enable = mkEnableOption "globalprotect"; + + csdWrapper = mkOption { + description = '' + A script that will produce a Host Integrity Protection (HIP) report, + as described at <link xlink:href="https://www.infradead.org/openconnect/hip.html" /> + ''; + default = null; + example = literalExample "\${pkgs.openconnect}/libexec/openconnect/hipreport.sh"; + type = types.nullOr types.path; + }; + }; + + config = mkIf cfg.enable { + services.dbus.packages = [ pkgs.globalprotect-openconnect ]; + + systemd.services.gpservice = { + description = "GlobalProtect openconnect DBus service"; + serviceConfig = { + Type="dbus"; + BusName="com.yuezk.qt.GPService"; + ExecStart=execStart; + }; + wantedBy = [ "multi-user.target" ]; + after = [ "network.target" ]; + }; + }; +} diff --git a/nixos/modules/services/networking/go-neb.nix b/nixos/modules/services/networking/go-neb.nix index 991ae38f30a..765834fad83 100644 --- a/nixos/modules/services/networking/go-neb.nix +++ b/nixos/modules/services/networking/go-neb.nix @@ -5,7 +5,8 @@ with lib; let cfg = config.services.go-neb; - configFile = pkgs.writeText "config.yml" (builtins.toJSON cfg.config); + settingsFormat = pkgs.formats.yaml {}; + configFile = settingsFormat.generate "config.yaml" cfg.config; in { options.services.go-neb = { enable = mkEnableOption "Extensible matrix bot written in Go"; @@ -16,13 +17,26 @@ in { default = ":4050"; }; + secretFile = mkOption { + type = types.nullOr types.path; + default = null; + example = "/run/keys/go-neb.env"; + description = '' + Environment variables from this file will be interpolated into the + final config file using envsubst with this syntax: <literal>$ENVIRONMENT</literal> + or <literal>''${VARIABLE}</literal>. + The file should contain lines formatted as <literal>SECRET_VAR=SECRET_VALUE</literal>. + This is useful to avoid putting secrets into the nix store. + ''; + }; + baseUrl = mkOption { type = types.str; description = "Public-facing endpoint that can receive webhooks."; }; config = mkOption { - type = types.uniq types.attrs; + inherit (settingsFormat) type; description = '' Your <filename>config.yaml</filename> as a Nix attribute set. See <link xlink:href="https://github.com/matrix-org/go-neb/blob/master/config.sample.yaml">config.sample.yaml</link> @@ -32,18 +46,30 @@ in { }; config = mkIf cfg.enable { - systemd.services.go-neb = { + systemd.services.go-neb = let + finalConfigFile = if cfg.secretFile == null then configFile else "/var/run/go-neb/config.yaml"; + in { description = "Extensible matrix bot written in Go"; after = [ "network.target" ]; wantedBy = [ "multi-user.target" ]; environment = { BASE_URL = cfg.baseUrl; BIND_ADDRESS = cfg.bindAddress; - CONFIG_FILE = configFile; + CONFIG_FILE = finalConfigFile; }; serviceConfig = { + ExecStartPre = lib.optional (cfg.secretFile != null) + (pkgs.writeShellScript "pre-start" '' + umask 077 + export $(xargs < ${cfg.secretFile}) + ${pkgs.envsubst}/bin/envsubst -i "${configFile}" > ${finalConfigFile} + chown go-neb ${finalConfigFile} + ''); + PermissionsStartOnly = true; + RuntimeDirectory = "go-neb"; ExecStart = "${pkgs.go-neb}/bin/go-neb"; + User = "go-neb"; DynamicUser = true; }; }; diff --git a/nixos/modules/services/networking/iwd.nix b/nixos/modules/services/networking/iwd.nix index 99e5e78badd..8835f7f9372 100644 --- a/nixos/modules/services/networking/iwd.nix +++ b/nixos/modules/services/networking/iwd.nix @@ -4,8 +4,31 @@ with lib; let cfg = config.networking.wireless.iwd; + ini = pkgs.formats.ini { }; + configFile = ini.generate "main.conf" cfg.settings; in { - options.networking.wireless.iwd.enable = mkEnableOption "iwd"; + options.networking.wireless.iwd = { + enable = mkEnableOption "iwd"; + + settings = mkOption { + type = ini.type; + default = { }; + + example = { + Settings.AutoConnect = true; + + Network = { + EnableIPv6 = true; + RoutePriorityOffset = 300; + }; + }; + + description = '' + Options passed to iwd. + See <link xlink:href="https://iwd.wiki.kernel.org/networkconfigurationsettings">here</link> for supported options. + ''; + }; + }; config = mkIf cfg.enable { assertions = [{ @@ -15,6 +38,8 @@ in { ''; }]; + environment.etc."iwd/main.conf".source = configFile; + # for iwctl environment.systemPackages = [ pkgs.iwd ]; @@ -27,7 +52,10 @@ in { linkConfig.NamePolicy = "keep kernel"; }; - systemd.services.iwd.wantedBy = [ "multi-user.target" ]; + systemd.services.iwd = { + wantedBy = [ "multi-user.target" ]; + restartTriggers = [ configFile ]; + }; }; meta.maintainers = with lib.maintainers; [ mic92 dtzWill ]; diff --git a/nixos/modules/services/networking/kea.nix b/nixos/modules/services/networking/kea.nix new file mode 100644 index 00000000000..72773b83a49 --- /dev/null +++ b/nixos/modules/services/networking/kea.nix @@ -0,0 +1,361 @@ +{ config +, lib +, pkgs +, ... +}: + +with lib; + +let + cfg = config.services.kea; + + format = pkgs.formats.json {}; + + ctrlAgentConfig = format.generate "kea-ctrl-agent.conf" { + Control-agent = cfg.ctrl-agent.settings; + }; + dhcp4Config = format.generate "kea-dhcp4.conf" { + Dhcp4 = cfg.dhcp4.settings; + }; + dhcp6Config = format.generate "kea-dhcp6.conf" { + Dhcp6 = cfg.dhcp6.settings; + }; + dhcpDdnsConfig = format.generate "kea-dhcp-ddns.conf" { + DhcpDdns = cfg.dhcp-ddns.settings; + }; + + package = pkgs.kea; +in +{ + options.services.kea = with types; { + ctrl-agent = mkOption { + description = '' + Kea Control Agent configuration + ''; + default = {}; + type = submodule { + options = { + enable = mkEnableOption "Kea Control Agent"; + + extraArgs = mkOption { + type = listOf str; + default = []; + description = '' + List of additonal arguments to pass to the daemon. + ''; + }; + + settings = mkOption { + type = format.type; + default = null; + description = '' + Kea Control Agent configuration as an attribute set, see <link xlink:href="https://kea.readthedocs.io/en/kea-${package.version}/arm/agent.html"/>. + ''; + }; + }; + }; + }; + + dhcp4 = mkOption { + description = '' + DHCP4 Server configuration + ''; + default = {}; + type = submodule { + options = { + enable = mkEnableOption "Kea DHCP4 server"; + + extraArgs = mkOption { + type = listOf str; + default = []; + description = '' + List of additonal arguments to pass to the daemon. + ''; + }; + + settings = mkOption { + type = format.type; + default = null; + example = { + valid-lifetime = 4000; + renew-timer = 1000; + rebind-timer = 2000; + interfaces-config = { + interfaces = [ + "eth0" + ]; + }; + lease-database = { + type = "memfile"; + persist = true; + name = "/var/lib/kea/dhcp4.leases"; + }; + subnet4 = [ { + subnet = "192.0.2.0/24"; + pools = [ { + pool = "192.0.2.100 - 192.0.2.240"; + } ]; + } ]; + }; + description = '' + Kea DHCP4 configuration as an attribute set, see <link xlink:href="https://kea.readthedocs.io/en/kea-${package.version}/arm/dhcp4-srv.html"/>. + ''; + }; + }; + }; + }; + + dhcp6 = mkOption { + description = '' + DHCP6 Server configuration + ''; + default = {}; + type = submodule { + options = { + enable = mkEnableOption "Kea DHCP6 server"; + + extraArgs = mkOption { + type = listOf str; + default = []; + description = '' + List of additonal arguments to pass to the daemon. + ''; + }; + + settings = mkOption { + type = format.type; + default = null; + example = { + valid-lifetime = 4000; + renew-timer = 1000; + rebind-timer = 2000; + preferred-lifetime = 3000; + interfaces-config = { + interfaces = [ + "eth0" + ]; + }; + lease-database = { + type = "memfile"; + persist = true; + name = "/var/lib/kea/dhcp6.leases"; + }; + subnet6 = [ { + subnet = "2001:db8:1::/64"; + pools = [ { + pool = "2001:db8:1::1-2001:db8:1::ffff"; + } ]; + } ]; + }; + description = '' + Kea DHCP6 configuration as an attribute set, see <link xlink:href="https://kea.readthedocs.io/en/kea-${package.version}/arm/dhcp6-srv.html"/>. + ''; + }; + }; + }; + }; + + dhcp-ddns = mkOption { + description = '' + Kea DHCP-DDNS configuration + ''; + default = {}; + type = submodule { + options = { + enable = mkEnableOption "Kea DDNS server"; + + extraArgs = mkOption { + type = listOf str; + default = []; + description = '' + List of additonal arguments to pass to the daemon. + ''; + }; + + settings = mkOption { + type = format.type; + default = null; + example = { + ip-address = "127.0.0.1"; + port = 53001; + dns-server-timeout = 100; + ncr-protocol = "UDP"; + ncr-format = "JSON"; + tsig-keys = [ ]; + forward-ddns = { + ddns-domains = [ ]; + }; + reverse-ddns = { + ddns-domains = [ ]; + }; + }; + description = '' + Kea DHCP-DDNS configuration as an attribute set, see <link xlink:href="https://kea.readthedocs.io/en/kea-${package.version}/arm/ddns.html"/>. + ''; + }; + }; + }; + }; + }; + + config = let + commonServiceConfig = { + ExecReload = "${pkgs.coreutils}/bin/kill -HUP $MAINPID"; + DynamicUser = true; + User = "kea"; + ConfigurationDirectory = "kea"; + RuntimeDirectory = "kea"; + StateDirectory = "kea"; + UMask = "0077"; + }; + in mkIf (cfg.ctrl-agent.enable || cfg.dhcp4.enable || cfg.dhcp6.enable || cfg.dhcp-ddns.enable) (mkMerge [ + { + environment.systemPackages = [ package ]; + } + + (mkIf cfg.ctrl-agent.enable { + + environment.etc."kea/ctrl-agent.conf".source = ctrlAgentConfig; + + systemd.services.kea-ctrl-agent = { + description = "Kea Control Agent"; + documentation = [ + "man:kea-ctrl-agent(8)" + "https://kea.readthedocs.io/en/kea-${package.version}/arm/agent.html" + ]; + + after = [ + "network-online.target" + "time-sync.target" + ]; + wantedBy = [ + "kea-dhcp4-server.service" + "kea-dhcp6-server.service" + "kea-dhcp-ddns-server.service" + ]; + + environment = { + KEA_PIDFILE_DIR = "/run/kea"; + }; + + serviceConfig = { + ExecStart = "${package}/bin/kea-ctrl-agent -c /etc/kea/ctrl-agent.conf ${lib.escapeShellArgs cfg.dhcp4.extraArgs}"; + KillMode = "process"; + Restart = "on-failure"; + } // commonServiceConfig; + }; + }) + + (mkIf cfg.dhcp4.enable { + + environment.etc."kea/dhcp4-server.conf".source = dhcp4Config; + + systemd.services.kea-dhcp4-server = { + description = "Kea DHCP4 Server"; + documentation = [ + "man:kea-dhcp4(8)" + "https://kea.readthedocs.io/en/kea-${package.version}/arm/dhcp4-srv.html" + ]; + + after = [ + "network-online.target" + "time-sync.target" + ]; + wantedBy = [ + "multi-user.target" + ]; + + environment = { + KEA_PIDFILE_DIR = "/run/kea"; + }; + + serviceConfig = { + ExecStart = "${package}/bin/kea-dhcp4 -c /etc/kea/dhcp4-server.conf ${lib.escapeShellArgs cfg.dhcp4.extraArgs}"; + # Kea does not request capabilities by itself + AmbientCapabilities = [ + "CAP_NET_BIND_SERVICE" + "CAP_NET_RAW" + ]; + CapabilityBoundingSet = [ + "CAP_NET_BIND_SERVICE" + "CAP_NET_RAW" + ]; + } // commonServiceConfig; + }; + }) + + (mkIf cfg.dhcp6.enable { + + environment.etc."kea/dhcp6-server.conf".source = dhcp6Config; + + systemd.services.kea-dhcp6-server = { + description = "Kea DHCP6 Server"; + documentation = [ + "man:kea-dhcp6(8)" + "https://kea.readthedocs.io/en/kea-${package.version}/arm/dhcp6-srv.html" + ]; + + after = [ + "network-online.target" + "time-sync.target" + ]; + wantedBy = [ + "multi-user.target" + ]; + + environment = { + KEA_PIDFILE_DIR = "/run/kea"; + }; + + serviceConfig = { + ExecStart = "${package}/bin/kea-dhcp6 -c /etc/kea/dhcp6-server.conf ${lib.escapeShellArgs cfg.dhcp6.extraArgs}"; + # Kea does not request capabilities by itself + AmbientCapabilities = [ + "CAP_NET_BIND_SERVICE" + ]; + CapabilityBoundingSet = [ + "CAP_NET_BIND_SERVICE" + ]; + } // commonServiceConfig; + }; + }) + + (mkIf cfg.dhcp-ddns.enable { + + environment.etc."kea/dhcp-ddns.conf".source = dhcpDdnsConfig; + + systemd.services.kea-dhcp-ddns-server = { + description = "Kea DHCP-DDNS Server"; + documentation = [ + "man:kea-dhcp-ddns(8)" + "https://kea.readthedocs.io/en/kea-${package.version}/arm/ddns.html" + ]; + + after = [ + "network-online.target" + "time-sync.target" + ]; + wantedBy = [ + "multi-user.target" + ]; + + environment = { + KEA_PIDFILE_DIR = "/run/kea"; + }; + + serviceConfig = { + ExecStart = "${package}/bin/kea-dhcp-ddns -c /etc/kea/dhcp-ddns.conf ${lib.escapeShellArgs cfg.dhcp-ddns.extraArgs}"; + AmbientCapabilites = [ + "CAP_NET_BIND_SERVICE" + ]; + CapabilityBoundingSet = [ + "CAP_NET_BIND_SERVICE" + ]; + } // commonServiceConfig; + }; + }) + + ]); + + meta.maintainers = with maintainers; [ hexa ]; +} diff --git a/nixos/modules/services/networking/matterbridge.nix b/nixos/modules/services/networking/matterbridge.nix index b8b4f37c84a..9186eee26ab 100644 --- a/nixos/modules/services/networking/matterbridge.nix +++ b/nixos/modules/services/networking/matterbridge.nix @@ -38,8 +38,8 @@ in # Use services.matterbridge.configPath instead. [irc] - [irc.freenode] - Server="irc.freenode.net:6667" + [irc.libera] + Server="irc.libera.chat:6667" Nick="matterbot" [mattermost] @@ -55,7 +55,7 @@ in name="gateway1" enable=true [[gateway.inout]] - account="irc.freenode" + account="irc.libera" channel="#testing" [[gateway.inout]] diff --git a/nixos/modules/services/networking/monero.nix b/nixos/modules/services/networking/monero.nix index 952d1d47ca6..9a9084e4ce1 100644 --- a/nixos/modules/services/networking/monero.nix +++ b/nixos/modules/services/networking/monero.nix @@ -110,7 +110,7 @@ in }; rpc.port = mkOption { - type = types.int; + type = types.port; default = 18081; description = '' Port the RPC server will bind to. diff --git a/nixos/modules/services/networking/murmur.nix b/nixos/modules/services/networking/murmur.nix index b03630208df..f8bb878ec65 100644 --- a/nixos/modules/services/networking/murmur.nix +++ b/nixos/modules/services/networking/murmur.nix @@ -98,7 +98,7 @@ in }; port = mkOption { - type = types.int; + type = types.port; default = 64738; description = "Ports to bind to (UDP and TCP)."; }; diff --git a/nixos/modules/services/networking/namecoind.nix b/nixos/modules/services/networking/namecoind.nix index 4966ed2cac8..8f7a5123f7e 100644 --- a/nixos/modules/services/networking/namecoind.nix +++ b/nixos/modules/services/networking/namecoind.nix @@ -105,7 +105,7 @@ in }; rpc.port = mkOption { - type = types.int; + type = types.port; default = 8332; description = '' Port the RPC server will bind to. diff --git a/nixos/modules/services/networking/nar-serve.nix b/nixos/modules/services/networking/nar-serve.nix index ddd42fa0107..745138186a2 100644 --- a/nixos/modules/services/networking/nar-serve.nix +++ b/nixos/modules/services/networking/nar-serve.nix @@ -13,7 +13,7 @@ in enable = mkEnableOption "Serve NAR file contents via HTTP"; port = mkOption { - type = types.int; + type = types.port; default = 8383; description = '' Port number where nar-serve will listen on. diff --git a/nixos/modules/services/networking/networkmanager.nix b/nixos/modules/services/networking/networkmanager.nix index 135f29be58c..064018057cd 100644 --- a/nixos/modules/services/networking/networkmanager.nix +++ b/nixos/modules/services/networking/networkmanager.nix @@ -22,36 +22,51 @@ let enableIwd = cfg.wifi.backend == "iwd"; - configFile = pkgs.writeText "NetworkManager.conf" '' - [main] - plugins=keyfile - dhcp=${cfg.dhcp} - dns=${cfg.dns} - # If resolvconf is disabled that means that resolv.conf is managed by some other module. - rc-manager=${if config.networking.resolvconf.enable then "resolvconf" else "unmanaged"} - - [keyfile] - ${optionalString (cfg.unmanaged != []) - ''unmanaged-devices=${lib.concatStringsSep ";" cfg.unmanaged}''} - - [logging] - level=${cfg.logLevel} - audit=${lib.boolToString config.security.audit.enable} - - [connection] - ipv6.ip6-privacy=2 - ethernet.cloned-mac-address=${cfg.ethernet.macAddress} - wifi.cloned-mac-address=${cfg.wifi.macAddress} - ${optionalString (cfg.wifi.powersave != null) - ''wifi.powersave=${if cfg.wifi.powersave then "3" else "2"}''} - - [device] - wifi.scan-rand-mac-address=${if cfg.wifi.scanRandMacAddress then "yes" else "no"} - wifi.backend=${cfg.wifi.backend} - - ${cfg.extraConfig} + mkValue = v: + if v == true then "yes" + else if v == false then "no" + else if lib.isInt v then toString v + else v; + + mkSection = name: attrs: '' + [${name}] + ${ + lib.concatStringsSep "\n" + (lib.mapAttrsToList + (k: v: "${k}=${mkValue v}") + (lib.filterAttrs + (k: v: v != null) + attrs)) + } ''; + configFile = pkgs.writeText "NetworkManager.conf" (lib.concatStringsSep "\n" [ + (mkSection "main" { + plugins = "keyfile"; + dhcp = cfg.dhcp; + dns = cfg.dns; + # If resolvconf is disabled that means that resolv.conf is managed by some other module. + rc-manager = + if config.networking.resolvconf.enable then "resolvconf" + else "unmanaged"; + }) + (mkSection "keyfile" { + unmanaged-devices = + if cfg.unmanaged == [] then null + else lib.concatStringsSep ";" cfg.unmanaged; + }) + (mkSection "logging" { + audit = config.security.audit.enable; + level = cfg.logLevel; + }) + (mkSection "connection" cfg.connectionConfig) + (mkSection "device" { + "wifi.scan-rand-mac-address" = cfg.wifi.scanRandMacAddress; + "wifi.backend" = cfg.wifi.backend; + }) + cfg.extraConfig + ]); + /* [network-manager] Identity=unix-group:networkmanager @@ -154,6 +169,28 @@ in { ''; }; + connectionConfig = mkOption { + type = with types; attrsOf (nullOr (oneOf [ + bool + int + str + ])); + default = {}; + description = '' + Configuration for the [connection] section of NetworkManager.conf. + Refer to + <link xlink:href="https://developer.gnome.org/NetworkManager/stable/NetworkManager.conf.html"> + https://developer.gnome.org/NetworkManager/stable/NetworkManager.conf.html#id-1.2.3.11 + </link> + or + <citerefentry> + <refentrytitle>NetworkManager.conf</refentrytitle> + <manvolnum>5</manvolnum> + </citerefentry> + for more information. + ''; + }; + extraConfig = mkOption { type = types.lines; default = ""; @@ -482,6 +519,18 @@ in { (mkIf enableIwd { wireless.iwd.enable = true; }) + + { + networkmanager.connectionConfig = { + "ipv6.ip6-privacy" = 2; + "ethernet.cloned-mac-address" = cfg.ethernet.macAddress; + "wifi.cloned-mac-address" = cfg.wifi.macAddress; + "wifi.powersave" = + if cfg.wifi.powersave == null then null + else if cfg.wifi.powersave then 3 + else 2; + }; + } ]; boot.kernelModules = [ "ctr" ]; diff --git a/nixos/modules/services/networking/nix-serve.nix b/nixos/modules/services/networking/nix-serve.nix index 347d87b3f38..7fc145f2303 100644 --- a/nixos/modules/services/networking/nix-serve.nix +++ b/nixos/modules/services/networking/nix-serve.nix @@ -11,7 +11,7 @@ in enable = mkEnableOption "nix-serve, the standalone Nix binary cache server"; port = mkOption { - type = types.int; + type = types.port; default = 5000; description = '' Port number where nix-serve will listen on. @@ -69,13 +69,9 @@ in ExecStart = "${pkgs.nix-serve}/bin/nix-serve " + "--listen ${cfg.bindAddress}:${toString cfg.port} ${cfg.extraParams}"; User = "nix-serve"; - Group = "nogroup"; + Group = "nix-serve"; + DynamicUser = true; }; }; - - users.users.nix-serve = { - description = "Nix-serve user"; - uid = config.ids.uids.nix-serve; - }; }; } diff --git a/nixos/modules/services/networking/pleroma.nix b/nixos/modules/services/networking/pleroma.nix index 2687230a158..bd75083a4a7 100644 --- a/nixos/modules/services/networking/pleroma.nix +++ b/nixos/modules/services/networking/pleroma.nix @@ -8,7 +8,7 @@ in { package = mkOption { type = types.package; - default = pkgs.pleroma-otp; + default = pkgs.pleroma; description = "Pleroma package to use."; }; diff --git a/nixos/modules/services/networking/pppd.nix b/nixos/modules/services/networking/pppd.nix index c1cbdb46176..37f44f07ac4 100644 --- a/nixos/modules/services/networking/pppd.nix +++ b/nixos/modules/services/networking/pppd.nix @@ -82,13 +82,21 @@ in LD_PRELOAD = "${pkgs.libredirect}/lib/libredirect.so"; NIX_REDIRECTS = "/var/run=/run/pppd"; }; - serviceConfig = { + serviceConfig = let + capabilities = [ + "CAP_BPF" + "CAP_SYS_TTY_CONFIG" + "CAP_NET_ADMIN" + "CAP_NET_RAW" + ]; + in + { ExecStart = "${getBin cfg.package}/sbin/pppd call ${peerCfg.name} nodetach nolog"; Restart = "always"; RestartSec = 5; - AmbientCapabilities = "CAP_SYS_TTY_CONFIG CAP_NET_ADMIN CAP_NET_RAW CAP_SYS_ADMIN"; - CapabilityBoundingSet = "CAP_SYS_TTY_CONFIG CAP_NET_ADMIN CAP_NET_RAW CAP_SYS_ADMIN"; + AmbientCapabilities = capabilities; + CapabilityBoundingSet = capabilities; KeyringMode = "private"; LockPersonality = true; MemoryDenyWriteExecute = true; @@ -103,7 +111,17 @@ in ProtectKernelTunables = false; ProtectSystem = "strict"; RemoveIPC = true; - RestrictAddressFamilies = "AF_PACKET AF_UNIX AF_PPPOX AF_ATMPVC AF_ATMSVC AF_INET AF_INET6 AF_IPX"; + RestrictAddressFamilies = [ + "AF_ATMPVC" + "AF_ATMSVC" + "AF_INET" + "AF_INET6" + "AF_IPX" + "AF_NETLINK" + "AF_PACKET" + "AF_PPPOX" + "AF_UNIX" + ]; RestrictNamespaces = true; RestrictRealtime = true; RestrictSUIDSGID = true; diff --git a/nixos/modules/services/networking/smartdns.nix b/nixos/modules/services/networking/smartdns.nix index f1888af7041..f84c727f034 100644 --- a/nixos/modules/services/networking/smartdns.nix +++ b/nixos/modules/services/networking/smartdns.nix @@ -54,6 +54,7 @@ in { systemd.packages = [ pkgs.smartdns ]; systemd.services.smartdns.wantedBy = [ "multi-user.target" ]; + systemd.services.smartdns.restartTriggers = [ confFile ]; environment.etc."smartdns/smartdns.conf".source = confFile; environment.etc."default/smartdns".source = "${pkgs.smartdns}/etc/default/smartdns"; diff --git a/nixos/modules/services/networking/solanum.nix b/nixos/modules/services/networking/solanum.nix index b6496fb8b35..dc066a24549 100644 --- a/nixos/modules/services/networking/solanum.nix +++ b/nixos/modules/services/networking/solanum.nix @@ -2,7 +2,7 @@ let inherit (lib) mkEnableOption mkIf mkOption types; - inherit (pkgs) solanum; + inherit (pkgs) solanum util-linux; cfg = config.services.solanum; configFile = pkgs.writeText "solanum.conf" cfg.config; @@ -78,12 +78,20 @@ in config = mkIf cfg.enable (lib.mkMerge [ { + + environment.etc."solanum/ircd.conf".source = configFile; + systemd.services.solanum = { description = "Solanum IRC daemon"; after = [ "network.target" ]; wantedBy = [ "multi-user.target" ]; + reloadIfChanged = true; + restartTriggers = [ + configFile + ]; serviceConfig = { - ExecStart = "${solanum}/bin/solanum -foreground -logfile /dev/stdout -configfile ${configFile} -pidfile /run/solanum/ircd.pid"; + ExecStart = "${solanum}/bin/solanum -foreground -logfile /dev/stdout -configfile /etc/solanum/ircd.conf -pidfile /run/solanum/ircd.pid"; + ExecReload = "${util-linux}/bin/kill -HUP $MAINPID"; DynamicUser = true; User = "solanum"; StateDirectory = "solanum"; diff --git a/nixos/modules/services/networking/ssh/sshd.nix b/nixos/modules/services/networking/ssh/sshd.nix index 3cc77e4cb93..2c96b94ca43 100644 --- a/nixos/modules/services/networking/ssh/sshd.nix +++ b/nixos/modules/services/networking/ssh/sshd.nix @@ -41,6 +41,10 @@ let Warning: If you are using <literal>NixOps</literal> then don't use this option since it will replace the key required for deployment via ssh. ''; + example = [ + "ssh-rsa AAAAB3NzaC1yc2etc/etc/etcjwrsh8e596z6J0l7 example@host" + "ssh-ed25519 AAAAC3NzaCetcetera/etceteraJZMfk3QPfQ foo@bar" + ]; }; keyFiles = mkOption { @@ -122,6 +126,15 @@ in ''; }; + sftpServerExecutable = mkOption { + type = types.str; + example = "internal-sftp"; + description = '' + The sftp server executable. Can be a path or "internal-sftp" to use + the sftp server built into the sshd binary. + ''; + }; + sftpFlags = mkOption { type = with types; listOf str; default = []; @@ -243,7 +256,17 @@ in authorizedKeysFiles = mkOption { type = types.listOf types.str; default = []; - description = "Files from which authorized keys are read."; + description = '' + Specify the rules for which files to read on the host. + + This is an advanced option. If you're looking to configure user + keys, you can generally use <xref linkend="opt-users.users._name_.openssh.authorizedKeys.keys"/> + or <xref linkend="opt-users.users._name_.openssh.authorizedKeys.keyFiles"/>. + + These are paths relative to the host root file system or home + directories and they are subject to certain token expansion rules. + See AuthorizedKeysFile in man sshd_config for details. + ''; }; authorizedKeysCommand = mkOption { @@ -328,15 +351,12 @@ in logLevel = mkOption { type = types.enum [ "QUIET" "FATAL" "ERROR" "INFO" "VERBOSE" "DEBUG" "DEBUG1" "DEBUG2" "DEBUG3" ]; - default = "VERBOSE"; + default = "INFO"; # upstream default description = '' Gives the verbosity level that is used when logging messages from sshd(8). The possible values are: - QUIET, FATAL, ERROR, INFO, VERBOSE, DEBUG, DEBUG1, DEBUG2, and DEBUG3. The default is VERBOSE. DEBUG and DEBUG1 + QUIET, FATAL, ERROR, INFO, VERBOSE, DEBUG, DEBUG1, DEBUG2, and DEBUG3. The default is INFO. DEBUG and DEBUG1 are equivalent. DEBUG2 and DEBUG3 each specify higher levels of debugging output. Logging with a DEBUG level violates the privacy of users and is not recommended. - - LogLevel VERBOSE logs user's key fingerprint on login. - Needed to have a clear audit track of which key was used to log in. ''; }; @@ -386,6 +406,7 @@ in }; services.openssh.moduliFile = mkDefault "${cfgc.package}/etc/ssh/moduli"; + services.openssh.sftpServerExecutable = mkDefault "${cfgc.package}/libexec/sftp-server"; environment.etc = authKeysFiles // { "ssh/moduli".source = cfg.moduliFile; @@ -432,6 +453,7 @@ in { ExecStart = (optionalString cfg.startWhenNeeded "-") + "${cfgc.package}/bin/sshd " + (optionalString cfg.startWhenNeeded "-i ") + + "-D " + # don't detach into a daemon process "-f /etc/ssh/sshd_config"; KillMode = "process"; } // (if cfg.startWhenNeeded then { @@ -505,7 +527,7 @@ in ''} ${optionalString cfg.allowSFTP '' - Subsystem sftp ${cfgc.package}/libexec/sftp-server ${concatStringsSep " " cfg.sftpFlags} + Subsystem sftp ${cfg.sftpServerExecutable} ${concatStringsSep " " cfg.sftpFlags} ''} PermitRootLogin ${cfg.permitRootLogin} diff --git a/nixos/modules/services/networking/tailscale.nix b/nixos/modules/services/networking/tailscale.nix index 9a28a266a92..3f88ff53dff 100644 --- a/nixos/modules/services/networking/tailscale.nix +++ b/nixos/modules/services/networking/tailscale.nix @@ -15,6 +15,12 @@ in { description = "The port to listen on for tunnel traffic (0=autoselect)."; }; + interfaceName = mkOption { + type = types.str; + default = "tailscale0"; + description = ''The interface name for tunnel traffic. Use "userspace-networking" (beta) to not use TUN.''; + }; + package = mkOption { type = types.package; default = pkgs.tailscale; @@ -28,8 +34,11 @@ in { systemd.packages = [ cfg.package ]; systemd.services.tailscaled = { wantedBy = [ "multi-user.target" ]; - path = [ pkgs.openresolv ]; - serviceConfig.Environment = "PORT=${toString cfg.port}"; + path = [ pkgs.openresolv pkgs.procps ]; + serviceConfig.Environment = [ + "PORT=${toString cfg.port}" + ''"FLAGS=--tun ${lib.escapeShellArg cfg.interfaceName}"'' + ]; }; }; } diff --git a/nixos/modules/services/networking/ucarp.nix b/nixos/modules/services/networking/ucarp.nix new file mode 100644 index 00000000000..9b19a19687b --- /dev/null +++ b/nixos/modules/services/networking/ucarp.nix @@ -0,0 +1,183 @@ +{ config, lib, pkgs, ... }: + +with lib; + +let + cfg = config.networking.ucarp; + + ucarpExec = concatStringsSep " " ( + [ + "${cfg.package}/bin/ucarp" + "--interface=${cfg.interface}" + "--srcip=${cfg.srcIp}" + "--vhid=${toString cfg.vhId}" + "--passfile=${cfg.passwordFile}" + "--addr=${cfg.addr}" + "--advbase=${toString cfg.advBase}" + "--advskew=${toString cfg.advSkew}" + "--upscript=${cfg.upscript}" + "--downscript=${cfg.downscript}" + "--deadratio=${toString cfg.deadratio}" + ] + ++ (optional cfg.preempt "--preempt") + ++ (optional cfg.neutral "--neutral") + ++ (optional cfg.shutdown "--shutdown") + ++ (optional cfg.ignoreIfState "--ignoreifstate") + ++ (optional cfg.noMcast "--nomcast") + ++ (optional (cfg.extraParam != null) "--xparam=${cfg.extraParam}") + ); +in { + options.networking.ucarp = { + enable = mkEnableOption "ucarp, userspace implementation of CARP"; + + interface = mkOption { + type = types.str; + description = "Network interface to bind to."; + example = "eth0"; + }; + + srcIp = mkOption { + type = types.str; + description = "Source (real) IP address of this host."; + }; + + vhId = mkOption { + type = types.ints.between 1 255; + description = "Virtual IP identifier shared between CARP hosts."; + example = 1; + }; + + passwordFile = mkOption { + type = types.str; + description = "File containing shared password between CARP hosts."; + example = "/run/keys/ucarp-password"; + }; + + preempt = mkOption { + type = types.bool; + description = '' + Enable preemptive failover. + Thus, this host becomes the CARP master as soon as possible. + ''; + default = false; + }; + + neutral = mkOption { + type = types.bool; + description = "Do not run downscript at start if the host is the backup."; + default = false; + }; + + addr = mkOption { + type = types.str; + description = "Virtual shared IP address."; + }; + + advBase = mkOption { + type = types.ints.unsigned; + description = "Advertisement frequency in seconds."; + default = 1; + }; + + advSkew = mkOption { + type = types.ints.unsigned; + description = "Advertisement skew in seconds."; + default = 0; + }; + + upscript = mkOption { + type = types.path; + description = '' + Command to run after become master, the interface name, virtual address + and optional extra parameters are passed as arguments. + ''; + example = '' + pkgs.writeScript "upscript" ''' + #!/bin/sh + $\{pkgs.iproute2\}/bin/ip addr add "$2"/24 dev "$1" + '''; + ''; + }; + + downscript = mkOption { + type = types.path; + description = '' + Command to run after become backup, the interface name, virtual address + and optional extra parameters are passed as arguments. + ''; + example = '' + pkgs.writeScript "downscript" ''' + #!/bin/sh + $\{pkgs.iproute2\}/bin/ip addr del "$2"/24 dev "$1" + '''; + ''; + }; + + deadratio = mkOption { + type = types.ints.unsigned; + description = "Ratio to consider a host as dead."; + default = 3; + }; + + shutdown = mkOption { + type = types.bool; + description = "Call downscript at exit."; + default = false; + }; + + ignoreIfState = mkOption { + type = types.bool; + description = "Ignore interface state, e.g., down or no carrier."; + default = false; + }; + + noMcast = mkOption { + type = types.bool; + description = "Use broadcast instead of multicast advertisements."; + default = false; + }; + + extraParam = mkOption { + type = types.nullOr types.str; + description = "Extra parameter to pass to the up/down scripts."; + default = null; + }; + + package = mkOption { + type = types.package; + description = '' + Package that should be used for ucarp. + + Please note that the default package, pkgs.ucarp, has not received any + upstream updates for a long time and can be considered as unmaintained. + ''; + default = pkgs.ucarp; + defaultText = "pkgs.ucarp"; + }; + }; + + config = mkIf cfg.enable { + systemd.services.ucarp = { + description = "ucarp, userspace implementation of CARP"; + + wantedBy = [ "multi-user.target" ]; + after = [ "network.target" ]; + + serviceConfig = { + Type = "exec"; + ExecStart = ucarpExec; + + ProtectSystem = "strict"; + ProtectHome = true; + PrivateTmp = true; + ProtectClock = true; + ProtectKernelModules = true; + ProtectControlGroups = true; + MemoryDenyWriteExecute = true; + RestrictRealtime = true; + }; + }; + }; + + meta.maintainers = with lib.maintainers; [ oxzi ]; +} diff --git a/nixos/modules/services/networking/unbound.nix b/nixos/modules/services/networking/unbound.nix index 09aef9a1dcf..6d7178047ea 100644 --- a/nixos/modules/services/networking/unbound.nix +++ b/nixos/modules/services/networking/unbound.nix @@ -21,7 +21,15 @@ let )) else throw (traceSeq v "services.unbound.settings: unexpected type"); - confFile = pkgs.writeText "unbound.conf" (concatStringsSep "\n" ((mapAttrsToList (toConf "") cfg.settings) ++ [""])); + confNoServer = concatStringsSep "\n" ((mapAttrsToList (toConf "") (builtins.removeAttrs cfg.settings [ "server" ])) ++ [""]); + confServer = concatStringsSep "\n" (mapAttrsToList (toConf " ") (builtins.removeAttrs cfg.settings.server [ "define-tag" ])); + + confFile = pkgs.writeText "unbound.conf" '' + server: + ${optionalString (cfg.settings.server.define-tag != "") (toOption " " "define-tag" cfg.settings.server.define-tag)} + ${confServer} + ${confNoServer} + ''; rootTrustAnchorFile = "${cfg.stateDir}/root.key"; @@ -170,6 +178,7 @@ in { # prevent race conditions on system startup when interfaces are not yet # configured ip-freebind = mkDefault true; + define-tag = mkDefault ""; }; remote-control = { control-enable = mkDefault false; diff --git a/nixos/modules/services/networking/wireguard.nix b/nixos/modules/services/networking/wireguard.nix index 471f4bf8b33..2b51770a5aa 100644 --- a/nixos/modules/services/networking/wireguard.nix +++ b/nixos/modules/services/networking/wireguard.nix @@ -244,17 +244,6 @@ let }; - generatePathUnit = name: values: - assert (values.privateKey == null); - assert (values.privateKeyFile != null); - nameValuePair "wireguard-${name}" - { - description = "WireGuard Tunnel - ${name} - Private Key"; - requiredBy = [ "wireguard-${name}.service" ]; - before = [ "wireguard-${name}.service" ]; - pathConfig.PathExists = values.privateKeyFile; - }; - generateKeyServiceUnit = name: values: assert values.generatePrivateKeyFile; nameValuePair "wireguard-${name}-key" @@ -509,9 +498,6 @@ in // (mapAttrs' generateKeyServiceUnit (filterAttrs (name: value: value.generatePrivateKeyFile) cfg.interfaces)); - systemd.paths = mapAttrs' generatePathUnit - (filterAttrs (name: value: value.privateKeyFile != null) cfg.interfaces); - }); } diff --git a/nixos/modules/services/networking/wpa_supplicant.nix b/nixos/modules/services/networking/wpa_supplicant.nix index 8a0685c3d96..c0a4ce40760 100644 --- a/nixos/modules/services/networking/wpa_supplicant.nix +++ b/nixos/modules/services/networking/wpa_supplicant.nix @@ -42,6 +42,11 @@ in { description = '' The interfaces <command>wpa_supplicant</command> will use. If empty, it will automatically use all wireless interfaces. + <warning><para> + The automatic discovery of interfaces does not work reliably on boot: + it may fail and leave the system without network. When possible, specify + a known interface name. + </para></warning> ''; }; @@ -225,6 +230,14 @@ in { message = ''options networking.wireless."${name}".{psk,pskRaw,auth} are mutually exclusive''; }); + warnings = + optional (cfg.interfaces == [] && config.systemd.services.wpa_supplicant.wantedBy != []) + '' + No network interfaces for wpa_supplicant have been configured: the service + may randomly fail to start at boot. You should specify at least one using the option + networking.wireless.interfaces. + ''; + environment.systemPackages = [ package ]; services.dbus.packages = [ package ]; diff --git a/nixos/modules/programs/x2goserver.nix b/nixos/modules/services/networking/x2goserver.nix index 05707a56542..48020fc1cec 100644 --- a/nixos/modules/programs/x2goserver.nix +++ b/nixos/modules/services/networking/x2goserver.nix @@ -3,7 +3,7 @@ with lib; let - cfg = config.programs.x2goserver; + cfg = config.services.x2goserver; defaults = { superenicer = { enable = cfg.superenicer.enable; }; @@ -17,7 +17,11 @@ let ''; in { - options.programs.x2goserver = { + imports = [ + (mkRenamedOptionModule [ "programs" "x2goserver" ] [ "services" "x2goserver" ]) + ]; + + options.services.x2goserver = { enable = mkEnableOption "x2goserver" // { description = '' Enables the x2goserver module. @@ -63,6 +67,14 @@ in { config = mkIf cfg.enable { + # x2goserver can run X11 program even if "services.xserver.enable = false" + xdg = { + autostart.enable = true; + menus.enable = true; + mime.enable = true; + icons.enable = true; + }; + environment.systemPackages = [ pkgs.x2goserver ]; users.groups.x2go = {}; diff --git a/nixos/modules/services/networking/xrdp.nix b/nixos/modules/services/networking/xrdp.nix index b7dd1c5d99d..9be7c3233e2 100644 --- a/nixos/modules/services/networking/xrdp.nix +++ b/nixos/modules/services/networking/xrdp.nix @@ -61,6 +61,12 @@ in ''; }; + openFirewall = mkOption { + default = false; + type = types.bool; + description = "Whether to open the firewall for the specified RDP port."; + }; + sslKey = mkOption { type = types.str; default = "/etc/xrdp/key.pem"; @@ -99,6 +105,8 @@ in config = mkIf cfg.enable { + networking.firewall.allowedTCPPorts = mkIf cfg.openFirewall [ cfg.port ]; + # xrdp can run X11 program even if "services.xserver.enable = false" xdg = { autostart.enable = true; diff --git a/nixos/modules/services/networking/znc/default.nix b/nixos/modules/services/networking/znc/default.nix index aa79ed27dce..b872b99976c 100644 --- a/nixos/modules/services/networking/znc/default.nix +++ b/nixos/modules/services/networking/znc/default.nix @@ -133,8 +133,8 @@ in Nick = "paul"; AltNick = "paul1"; LoadModule = [ "chansaver" "controlpanel" ]; - Network.freenode = { - Server = "chat.freenode.net +6697"; + Network.libera = { + Server = "irc.libera.chat +6697"; LoadModule = [ "simple_away" ]; Chan = { "#nixos" = { Detached = false; }; diff --git a/nixos/modules/services/networking/znc/options.nix b/nixos/modules/services/networking/znc/options.nix index 7a43b45fabb..be9dc78c86d 100644 --- a/nixos/modules/services/networking/znc/options.nix +++ b/nixos/modules/services/networking/znc/options.nix @@ -11,7 +11,7 @@ let server = mkOption { type = types.str; - example = "chat.freenode.net"; + example = "irc.libera.chat"; description = '' IRC server address. ''; @@ -150,8 +150,8 @@ in ''; example = literalExample '' { - "freenode" = { - server = "chat.freenode.net"; + "libera" = { + server = "irc.libera.chat"; port = 6697; useSSL = true; modules = [ "simple_away" ]; diff --git a/nixos/modules/services/security/fail2ban.nix b/nixos/modules/services/security/fail2ban.nix index 0c24972823d..499d3466750 100644 --- a/nixos/modules/services/security/fail2ban.nix +++ b/nixos/modules/services/security/fail2ban.nix @@ -45,7 +45,12 @@ in enable = mkOption { default = false; type = types.bool; - description = "Whether to enable the fail2ban service."; + description = '' + Whether to enable the fail2ban service. + + See the documentation of <option>services.fail2ban.jails</option> + for what jails are enabled by default. + ''; }; package = mkOption { @@ -221,6 +226,15 @@ in defined in <filename>/etc/fail2ban/action.d</filename>, while filters are defined in <filename>/etc/fail2ban/filter.d</filename>. + + NixOS comes with a default <literal>sshd</literal> jail; + for it to work well, + <option>services.openssh.logLevel</option> should be set to + <literal>"VERBOSE"</literal> or higher so that fail2ban + can observe failed login attempts. + This module sets it to <literal>"VERBOSE"</literal> if + not set otherwise, so enabling fail2ban can make SSH logs + more verbose. ''; }; @@ -257,7 +271,6 @@ in partOf = optional config.networking.firewall.enable "firewall.service"; restartTriggers = [ fail2banConf jailConf pathsConf ]; - reloadIfChanged = true; path = [ cfg.package cfg.packageFirewall pkgs.iproute2 ] ++ cfg.extraPackages; @@ -314,6 +327,9 @@ in banaction_allports = ${cfg.banaction-allports} ''; # Block SSH if there are too many failing connection attempts. + # Benefits from verbose sshd logging to observe failed login attempts, + # so we set that here unless the user overrode it. + services.openssh.logLevel = lib.mkDefault "VERBOSE"; services.fail2ban.jails.sshd = mkDefault '' enabled = true port = ${concatMapStringsSep "," (p: toString p) config.services.openssh.ports} diff --git a/nixos/modules/services/security/hockeypuck.nix b/nixos/modules/services/security/hockeypuck.nix new file mode 100644 index 00000000000..686634c8add --- /dev/null +++ b/nixos/modules/services/security/hockeypuck.nix @@ -0,0 +1,104 @@ +{ config, lib, pkgs, ... }: + +let + cfg = config.services.hockeypuck; + settingsFormat = pkgs.formats.toml { }; +in { + meta.maintainers = with lib.maintainers; [ etu ]; + + options.services.hockeypuck = { + enable = lib.mkEnableOption "Hockeypuck OpenPGP Key Server"; + + port = lib.mkOption { + default = 11371; + type = lib.types.port; + description = "HKP port to listen on."; + }; + + settings = lib.mkOption { + type = settingsFormat.type; + default = { }; + example = lib.literalExample '' + { + hockeypuck = { + loglevel = "INFO"; + logfile = "/var/log/hockeypuck/hockeypuck.log"; + indexTemplate = "''${pkgs.hockeypuck-web}/share/templates/index.html.tmpl"; + vindexTemplate = "''${pkgs.hockeypuck-web}/share/templates/index.html.tmpl"; + statsTemplate = "''${pkgs.hockeypuck-web}/share/templates/stats.html.tmpl"; + webroot = "''${pkgs.hockeypuck-web}/share/webroot"; + + hkp.bind = ":''${toString cfg.port}"; + + openpgp.db = { + driver = "postgres-jsonb"; + dsn = "database=hockeypuck host=/var/run/postgresql sslmode=disable"; + }; + }; + } + ''; + description = '' + Configuration file for hockeypuck, here you can override + certain settings (<literal>loglevel</literal> and + <literal>openpgp.db.dsn</literal>) by just setting those values. + + For other settings you need to use lib.mkForce to override them. + + This service doesn't provision or enable postgres on your + system, it rather assumes that you enable postgres and create + the database yourself. + + Example: + <literal> + services.postgresql = { + enable = true; + ensureDatabases = [ "hockeypuck" ]; + ensureUsers = [{ + name = "hockeypuck"; + ensurePermissions."DATABASE hockeypuck" = "ALL PRIVILEGES"; + }]; + }; + </literal> + ''; + }; + }; + + config = lib.mkIf cfg.enable { + services.hockeypuck.settings.hockeypuck = { + loglevel = lib.mkDefault "INFO"; + logfile = "/var/log/hockeypuck/hockeypuck.log"; + indexTemplate = "${pkgs.hockeypuck-web}/share/templates/index.html.tmpl"; + vindexTemplate = "${pkgs.hockeypuck-web}/share/templates/index.html.tmpl"; + statsTemplate = "${pkgs.hockeypuck-web}/share/templates/stats.html.tmpl"; + webroot = "${pkgs.hockeypuck-web}/share/webroot"; + + hkp.bind = ":${toString cfg.port}"; + + openpgp.db = { + driver = "postgres-jsonb"; + dsn = lib.mkDefault "database=hockeypuck host=/var/run/postgresql sslmode=disable"; + }; + }; + + users.users.hockeypuck = { + isSystemUser = true; + description = "Hockeypuck user"; + }; + + systemd.services.hockeypuck = { + description = "Hockeypuck OpenPGP Key Server"; + after = [ "network.target" "postgresql.target" ]; + wantedBy = [ "multi-user.target" ]; + serviceConfig = { + WorkingDirectory = "/var/lib/hockeypuck"; + User = "hockeypuck"; + ExecStart = "${pkgs.hockeypuck}/bin/hockeypuck -config ${settingsFormat.generate "config.toml" cfg.settings}"; + Restart = "always"; + RestartSec = "5s"; + LogsDirectory = "hockeypuck"; + LogsDirectoryMode = "0755"; + StateDirectory = "hockeypuck"; + }; + }; + }; +} diff --git a/nixos/modules/services/security/privacyidea.nix b/nixos/modules/services/security/privacyidea.nix index 2696dca4c76..63271848e94 100644 --- a/nixos/modules/services/security/privacyidea.nix +++ b/nixos/modules/services/security/privacyidea.nix @@ -7,7 +7,7 @@ let uwsgi = pkgs.uwsgi.override { plugins = [ "python3" ]; }; python = uwsgi.python3; - penv = python.withPackages (ps: [ ps.privacyidea ]); + penv = python.withPackages (const [ pkgs.privacyidea ]); logCfg = pkgs.writeText "privacyidea-log.cfg" '' [formatters] keys=detail @@ -194,7 +194,7 @@ in (mkIf cfg.enable { - environment.systemPackages = [ python.pkgs.privacyidea ]; + environment.systemPackages = [ pkgs.privacyidea ]; services.postgresql.enable = mkDefault true; diff --git a/nixos/modules/services/security/bitwarden_rs/backup.sh b/nixos/modules/services/security/vaultwarden/backup.sh index 264a7da9cbb..2a3de0ab1de 100644 --- a/nixos/modules/services/security/bitwarden_rs/backup.sh +++ b/nixos/modules/services/security/vaultwarden/backup.sh @@ -1,6 +1,6 @@ #!/usr/bin/env bash -# Based on: https://github.com/dani-garcia/bitwarden_rs/wiki/Backing-up-your-vault +# Based on: https://github.com/dani-garcia/vaultwarden/wiki/Backing-up-your-vault if ! mkdir -p "$BACKUP_FOLDER"; then echo "Could not create backup folder '$BACKUP_FOLDER'" >&2 exit 1 diff --git a/nixos/modules/services/security/bitwarden_rs/default.nix b/nixos/modules/services/security/vaultwarden/default.nix index bed59dbf821..d28ea61e66a 100644 --- a/nixos/modules/services/security/bitwarden_rs/default.nix +++ b/nixos/modules/services/security/vaultwarden/default.nix @@ -3,9 +3,9 @@ with lib; let - cfg = config.services.bitwarden_rs; - user = config.users.users.bitwarden_rs.name; - group = config.users.groups.bitwarden_rs.name; + cfg = config.services.vaultwarden; + user = config.users.users.vaultwarden.name; + group = config.users.groups.vaultwarden.name; # Convert name from camel case (e.g. disable2FARemember) to upper case snake case (e.g. DISABLE_2FA_REMEMBER). nameToEnvVar = name: @@ -26,22 +26,26 @@ let if value != null then [ (nameValuePair (nameToEnvVar name) (if isBool value then boolToString value else toString value)) ] else [] ) cfg.config)); in { DATA_FOLDER = "/var/lib/bitwarden_rs"; } // optionalAttrs (!(configEnv ? WEB_VAULT_ENABLED) || configEnv.WEB_VAULT_ENABLED == "true") { - WEB_VAULT_FOLDER = "${pkgs.bitwarden_rs-vault}/share/bitwarden_rs/vault"; + WEB_VAULT_FOLDER = "${cfg.webVaultPackage}/share/vaultwarden/vault"; } // configEnv; - configFile = pkgs.writeText "bitwarden_rs.env" (concatStrings (mapAttrsToList (name: value: "${name}=${value}\n") configEnv)); + configFile = pkgs.writeText "vaultwarden.env" (concatStrings (mapAttrsToList (name: value: "${name}=${value}\n") configEnv)); - bitwarden_rs = pkgs.bitwarden_rs.override { inherit (cfg) dbBackend; }; + vaultwarden = cfg.package.override { inherit (cfg) dbBackend; }; in { - options.services.bitwarden_rs = with types; { - enable = mkEnableOption "bitwarden_rs"; + imports = [ + (mkRenamedOptionModule [ "services" "bitwarden_rs" ] [ "services" "vaultwarden" ]) + ]; + + options.services.vaultwarden = with types; { + enable = mkEnableOption "vaultwarden"; dbBackend = mkOption { type = enum [ "sqlite" "mysql" "postgresql" ]; default = "sqlite"; description = '' - Which database backend bitwarden_rs will be using. + Which database backend vaultwarden will be using. ''; }; @@ -49,7 +53,7 @@ in { type = nullOr str; default = null; description = '' - The directory under which bitwarden_rs will backup its persistent data. + The directory under which vaultwarden will backup its persistent data. ''; }; @@ -65,7 +69,7 @@ in { } ''; description = '' - The configuration of bitwarden_rs is done through environment variables, + The configuration of vaultwarden is done through environment variables, therefore the names are converted from camel case (e.g. disable2FARemember) to upper case snake case (e.g. DISABLE_2FA_REMEMBER). In this conversion digits (0-9) are handled just like upper case characters, @@ -75,17 +79,17 @@ in { This allows working around any potential future conflicting naming conventions. Based on the attributes passed to this config option an environment file will be generated - that is passed to bitwarden_rs's systemd service. + that is passed to vaultwarden's systemd service. The available configuration options can be found in - <link xlink:href="https://github.com/dani-garcia/bitwarden_rs/blob/${bitwarden_rs.version}/.env.template">the environment template file</link>. + <link xlink:href="https://github.com/dani-garcia/vaultwarden/blob/${vaultwarden.version}/.env.template">the environment template file</link>. ''; }; environmentFile = mkOption { type = with types; nullOr path; default = null; - example = "/root/bitwarden_rs.env"; + example = "/root/vaultwarden.env"; description = '' Additional environment file as defined in <citerefentry> <refentrytitle>systemd.exec</refentrytitle><manvolnum>5</manvolnum> @@ -95,9 +99,23 @@ in { may be passed to the service without adding them to the world-readable Nix store. Note that this file needs to be available on the host on which - <literal>bitwarden_rs</literal> is running. + <literal>vaultwarden</literal> is running. ''; }; + + package = mkOption { + type = package; + default = pkgs.vaultwarden; + defaultText = "pkgs.vaultwarden"; + description = "Vaultwarden package to use."; + }; + + webVaultPackage = mkOption { + type = package; + default = pkgs.vaultwarden-vault; + defaultText = "pkgs.vaultwarden-vault"; + description = "Web vault package to use."; + }; }; config = mkIf cfg.enable { @@ -106,20 +124,21 @@ in { message = "Backups for database backends other than sqlite will need customization"; } ]; - users.users.bitwarden_rs = { + users.users.vaultwarden = { inherit group; isSystemUser = true; }; - users.groups.bitwarden_rs = { }; + users.groups.vaultwarden = { }; - systemd.services.bitwarden_rs = { + systemd.services.vaultwarden = { + aliases = [ "bitwarden_rs" ]; after = [ "network.target" ]; path = with pkgs; [ openssl ]; serviceConfig = { User = user; Group = group; EnvironmentFile = [ configFile ] ++ optional (cfg.environmentFile != null) cfg.environmentFile; - ExecStart = "${bitwarden_rs}/bin/bitwarden_rs"; + ExecStart = "${vaultwarden}/bin/vaultwarden"; LimitNOFILE = "1048576"; PrivateTmp = "true"; PrivateDevices = "true"; @@ -131,15 +150,16 @@ in { wantedBy = [ "multi-user.target" ]; }; - systemd.services.backup-bitwarden_rs = mkIf (cfg.backupDir != null) { - description = "Backup bitwarden_rs"; + systemd.services.backup-vaultwarden = mkIf (cfg.backupDir != null) { + aliases = [ "backup-bitwarden_rs" ]; + description = "Backup vaultwarden"; environment = { DATA_FOLDER = "/var/lib/bitwarden_rs"; BACKUP_FOLDER = cfg.backupDir; }; path = with pkgs; [ sqlite ]; serviceConfig = { - SyslogIdentifier = "backup-bitwarden_rs"; + SyslogIdentifier = "backup-vaultwarden"; Type = "oneshot"; User = mkDefault user; Group = mkDefault group; @@ -148,12 +168,13 @@ in { wantedBy = [ "multi-user.target" ]; }; - systemd.timers.backup-bitwarden_rs = mkIf (cfg.backupDir != null) { - description = "Backup bitwarden_rs on time"; + systemd.timers.backup-vaultwarden = mkIf (cfg.backupDir != null) { + aliases = [ "backup-bitwarden_rs" ]; + description = "Backup vaultwarden on time"; timerConfig = { OnCalendar = mkDefault "23:00"; Persistent = "true"; - Unit = "backup-bitwarden_rs.service"; + Unit = "backup-vaultwarden.service"; }; wantedBy = [ "multi-user.target" ]; }; diff --git a/nixos/modules/services/system/self-deploy.nix b/nixos/modules/services/system/self-deploy.nix index 3c82ed4fc59..33d15e08f4a 100644 --- a/nixos/modules/services/system/self-deploy.nix +++ b/nixos/modules/services/system/self-deploy.nix @@ -37,7 +37,9 @@ in }; nixAttribute = lib.mkOption { - type = lib.types.str; + type = with lib.types; nullOr str; + + default = null; description = '' Attribute of `nixFile` that builds the current system. diff --git a/nixos/modules/services/ttys/getty.nix b/nixos/modules/services/ttys/getty.nix index 2480e681de8..7cf2ff87da2 100644 --- a/nixos/modules/services/ttys/getty.nix +++ b/nixos/modules/services/ttys/getty.nix @@ -6,7 +6,7 @@ let cfg = config.services.getty; baseArgs = [ - "--login-program" "${pkgs.shadow}/bin/login" + "--login-program" "${cfg.loginProgram}" ] ++ optionals (cfg.autologinUser != null) [ "--autologin" cfg.autologinUser ] ++ optionals (cfg.loginOptions != null) [ @@ -39,6 +39,14 @@ in ''; }; + loginProgram = mkOption { + type = types.path; + default = "${pkgs.shadow}/bin/login"; + description = '' + Path to the login binary executed by agetty. + ''; + }; + loginOptions = mkOption { type = types.nullOr types.str; default = null; @@ -118,7 +126,7 @@ in let speeds = concatStringsSep "," (map toString config.services.getty.serialSpeed); in { serviceConfig.ExecStart = [ "" # override upstream default with an empty ExecStart - (gettyCmd "%I ${speeds} $TERM") + (gettyCmd "%I --keep-baud ${speeds} $TERM") ]; restartIfChanged = false; }; diff --git a/nixos/modules/services/video/epgstation/default.nix b/nixos/modules/services/video/epgstation/default.nix index 8d6d431fa55..b13393c8983 100644 --- a/nixos/modules/services/video/epgstation/default.nix +++ b/nixos/modules/services/video/epgstation/default.nix @@ -27,7 +27,7 @@ let # NOTE: Use password authentication, since mysqljs does not yet support auth_socket if [ ! -e /var/lib/epgstation/db-created ]; then - ${pkgs.mysql}/bin/mysql -e \ + ${pkgs.mariadb}/bin/mysql -e \ "GRANT ALL ON \`${cfg.database.name}\`.* TO '${username}'@'localhost' IDENTIFIED by '$DB_PASSWORD';" touch /var/lib/epgstation/db-created fi @@ -224,7 +224,7 @@ in services.mysql = { enable = mkDefault true; - package = mkDefault pkgs.mysql; + package = mkDefault pkgs.mariadb; ensureDatabases = [ cfg.database.name ]; # FIXME: enable once mysqljs supports auth_socket # ensureUsers = [ { diff --git a/nixos/modules/services/video/unifi-video.nix b/nixos/modules/services/video/unifi-video.nix new file mode 100644 index 00000000000..d4c0268ed66 --- /dev/null +++ b/nixos/modules/services/video/unifi-video.nix @@ -0,0 +1,265 @@ +{ config, lib, pkgs, utils, ... }: +with lib; +let + cfg = config.services.unifi-video; + mainClass = "com.ubnt.airvision.Main"; + cmd = '' + ${pkgs.jsvc}/bin/jsvc \ + -cwd ${stateDir} \ + -debug \ + -verbose:class \ + -nodetach \ + -user unifi-video \ + -home ${cfg.jrePackage}/lib/openjdk \ + -cp ${pkgs.commonsDaemon}/share/java/commons-daemon-1.2.4.jar:${stateDir}/lib/airvision.jar \ + -pidfile ${cfg.pidFile} \ + -procname unifi-video \ + -Djava.security.egd=file:/dev/./urandom \ + -Xmx${cfg.maximumJavaHeapSize}M \ + -Xss512K \ + -XX:+UseG1GC \ + -XX:+UseStringDeduplication \ + -XX:MaxMetaspaceSize=768M \ + -Djava.library.path=${stateDir}/lib \ + -Djava.awt.headless=true \ + -Djavax.net.ssl.trustStore=${stateDir}/etc/ufv-truststore \ + -Dfile.encoding=UTF-8 \ + -Dav.tempdir=/var/cache/unifi-video + ''; + + mongoConf = pkgs.writeTextFile { + name = "mongo.conf"; + executable = false; + text = '' + # for documentation of all options, see http://docs.mongodb.org/manual/reference/configuration-options/ + + storage: + dbPath: ${cfg.dataDir}/db + journal: + enabled: true + syncPeriodSecs: 60 + + systemLog: + destination: file + logAppend: true + path: ${stateDir}/logs/mongod.log + + net: + port: 7441 + bindIp: 127.0.0.1 + http: + enabled: false + + operationProfiling: + slowOpThresholdMs: 500 + mode: off + ''; + }; + + + mongoWtConf = pkgs.writeTextFile { + name = "mongowt.conf"; + executable = false; + text = '' + # for documentation of all options, see: + # http://docs.mongodb.org/manual/reference/configuration-options/ + + storage: + dbPath: ${cfg.dataDir}/db-wt + journal: + enabled: true + wiredTiger: + engineConfig: + cacheSizeGB: 1 + + systemLog: + destination: file + logAppend: true + path: logs/mongod.log + + net: + port: 7441 + bindIp: 127.0.0.1 + + operationProfiling: + slowOpThresholdMs: 500 + mode: off + ''; + }; + + stateDir = "/var/lib/unifi-video"; + +in + { + + options.services.unifi-video = { + enable = mkOption { + type = types.bool; + default = false; + description = '' + Whether or not to enable the unifi-video service. + ''; + }; + + jrePackage = mkOption { + type = types.package; + default = pkgs.jre8; + defaultText = "pkgs.jre8"; + description = '' + The JRE package to use. Check the release notes to ensure it is supported. + ''; + }; + + unifiVideoPackage = mkOption { + type = types.package; + default = pkgs.unifi-video; + defaultText = "pkgs.unifi-video"; + description = '' + The unifi-video package to use. + ''; + }; + + mongodbPackage = mkOption { + type = types.package; + default = pkgs.mongodb-4_0; + defaultText = "pkgs.mongodb"; + description = '' + The mongodb package to use. + ''; + }; + + logDir = mkOption { + type = types.str; + default = "${stateDir}/logs"; + description = '' + Where to store the logs. + ''; + }; + + dataDir = mkOption { + type = types.str; + default = "${stateDir}/data"; + description = '' + Where to store the database and other data. + ''; + }; + + openPorts = mkOption { + type = types.bool; + default = true; + description = '' + Whether or not to open the required ports on the firewall. + ''; + }; + + maximumJavaHeapSize = mkOption { + type = types.nullOr types.int; + default = 1024; + example = 4096; + description = '' + Set the maximimum heap size for the JVM in MB. + ''; + }; + + pidFile = mkOption { + type = types.path; + default = "${cfg.dataDir}/unifi-video.pid"; + description = "Location of unifi-video pid file."; + }; + +}; + +config = mkIf cfg.enable { + users = { + users.unifi-video = { + description = "UniFi Video controller daemon user"; + home = stateDir; + group = "unifi-video"; + isSystemUser = true; + }; + groups.unifi-video = {}; + }; + + networking.firewall = mkIf cfg.openPorts { + # https://help.ui.com/hc/en-us/articles/217875218-UniFi-Video-Ports-Used + allowedTCPPorts = [ + 7080 # HTTP portal + 7443 # HTTPS portal + 7445 # Video over HTTP (mobile app) + 7446 # Video over HTTPS (mobile app) + 7447 # RTSP via the controller + 7442 # Camera management from cameras to NVR over WAN + ]; + allowedUDPPorts = [ + 6666 # Inbound camera streams sent over WAN + ]; + }; + + systemd.tmpfiles.rules = [ + "d '${stateDir}' 0700 unifi-video unifi-video - -" + "d '/var/cache/unifi-video' 0700 unifi-video unifi-video - -" + + "d '${stateDir}/logs' 0700 unifi-video unifi-video - -" + "C '${stateDir}/etc' 0700 unifi-video unifi-video - ${pkgs.unifi-video}/lib/unifi-video/etc" + "C '${stateDir}/webapps' 0700 unifi-video unifi-video - ${pkgs.unifi-video}/lib/unifi-video/webapps" + "C '${stateDir}/email' 0700 unifi-video unifi-video - ${pkgs.unifi-video}/lib/unifi-video/email" + "C '${stateDir}/fw' 0700 unifi-video unifi-video - ${pkgs.unifi-video}/lib/unifi-video/fw" + "C '${stateDir}/lib' 0700 unifi-video unifi-video - ${pkgs.unifi-video}/lib/unifi-video/lib" + + "d '${stateDir}/data' 0700 unifi-video unifi-video - -" + "d '${stateDir}/data/db' 0700 unifi-video unifi-video - -" + "C '${stateDir}/data/system.properties' 0700 unifi-video unifi-video - ${pkgs.unifi-video}/lib/unifi-video/etc/system.properties" + + "d '${stateDir}/bin' 0700 unifi-video unifi-video - -" + "f '${stateDir}/bin/evostreamms' 0700 unifi-video unifi-video - ${pkgs.unifi-video}/lib/unifi-video/bin/evostreamms" + "f '${stateDir}/bin/libavcodec.so.54' 0700 unifi-video unifi-video - ${pkgs.unifi-video}/lib/unifi-video/bin/libavcodec.so.54" + "f '${stateDir}/bin/libavformat.so.54' 0700 unifi-video unifi-video - ${pkgs.unifi-video}/lib/unifi-video/bin/libavformat.so.54" + "f '${stateDir}/bin/libavutil.so.52' 0700 unifi-video unifi-video - ${pkgs.unifi-video}/lib/unifi-video/bin/libavutil.so.52" + "f '${stateDir}/bin/ubnt.avtool' 0700 unifi-video unifi-video - ${pkgs.unifi-video}/lib/unifi-video/bin/ubnt.avtool" + "f '${stateDir}/bin/ubnt.updater' 0700 unifi-video unifi-video - ${pkgs.unifi-video}/lib/unifi-video/bin/ubnt.updater" + "C '${stateDir}/bin/mongo' 0700 unifi-video unifi-video - ${cfg.mongodbPackage}/bin/mongo" + "C '${stateDir}/bin/mongod' 0700 unifi-video unifi-video - ${cfg.mongodbPackage}/bin/mongod" + "C '${stateDir}/bin/mongoperf' 0700 unifi-video unifi-video - ${cfg.mongodbPackage}/bin/mongoperf" + "C '${stateDir}/bin/mongos' 0700 unifi-video unifi-video - ${cfg.mongodbPackage}/bin/mongos" + + "d '${stateDir}/conf' 0700 unifi-video unifi-video - -" + "C '${stateDir}/conf/evostream' 0700 unifi-video unifi-video - ${pkgs.unifi-video}/lib/unifi-video/conf/evostream" + "Z '${stateDir}/conf/evostream' 0700 unifi-video unifi-video - -" + "L+ '${stateDir}/conf/mongodv3.0+.conf' 0700 unifi-video unifi-video - ${mongoConf}" + "L+ '${stateDir}/conf/mongodv3.6+.conf' 0700 unifi-video unifi-video - ${mongoConf}" + "L+ '${stateDir}/conf/mongod-wt.conf' 0700 unifi-video unifi-video - ${mongoWtConf}" + "L+ '${stateDir}/conf/catalina.policy' 0700 unifi-video unifi-video - ${pkgs.unifi-video}/lib/unifi-video/conf/catalina.policy" + "L+ '${stateDir}/conf/catalina.properties' 0700 unifi-video unifi-video - ${pkgs.unifi-video}/lib/unifi-video/conf/catalina.properties" + "L+ '${stateDir}/conf/context.xml' 0700 unifi-video unifi-video - ${pkgs.unifi-video}/lib/unifi-video/conf/context.xml" + "L+ '${stateDir}/conf/logging.properties' 0700 unifi-video unifi-video - ${pkgs.unifi-video}/lib/unifi-video/conf/logging.properties" + "L+ '${stateDir}/conf/server.xml' 0700 unifi-video unifi-video - ${pkgs.unifi-video}/lib/unifi-video/conf/server.xml" + "L+ '${stateDir}/conf/tomcat-users.xml' 0700 unifi-video unifi-video - ${pkgs.unifi-video}/lib/unifi-video/conf/tomcat-users.xml" + "L+ '${stateDir}/conf/web.xml' 0700 unifi-video unifi-video - ${pkgs.unifi-video}/lib/unifi-video/conf/web.xml" + + ]; + + systemd.services.unifi-video = { + description = "UniFi Video NVR daemon"; + wantedBy = [ "multi-user.target" ]; + after = [ "network.target" ] ; + unitConfig.RequiresMountsFor = stateDir; + # Make sure package upgrades trigger a service restart + restartTriggers = [ cfg.unifiVideoPackage cfg.mongodbPackage ]; + path = with pkgs; [ gawk coreutils busybox which jre8 lsb-release libcap util-linux ]; + serviceConfig = { + Type = "simple"; + ExecStart = "${(removeSuffix "\n" cmd)} ${mainClass} start"; + ExecStop = "${(removeSuffix "\n" cmd)} stop ${mainClass} stop"; + Restart = "on-failure"; + UMask = "0077"; + User = "unifi-video"; + WorkingDirectory = "${stateDir}"; + }; + }; + + }; + + meta = { + maintainers = with lib.maintainers; [ rsynnest ]; + }; +} diff --git a/nixos/modules/services/web-apps/discourse.nix b/nixos/modules/services/web-apps/discourse.nix index 0e2e182ffe9..8d5302ba267 100644 --- a/nixos/modules/services/web-apps/discourse.nix +++ b/nixos/modules/services/web-apps/discourse.nix @@ -5,11 +5,16 @@ let cfg = config.services.discourse; + # Keep in sync with https://github.com/discourse/discourse_docker/blob/master/image/base/Dockerfile#L5 + upstreamPostgresqlVersion = lib.getVersion pkgs.postgresql_13; + postgresqlPackage = if config.services.postgresql.enable then config.services.postgresql.package else pkgs.postgresql; + postgresqlVersion = lib.getVersion postgresqlPackage; + # We only want to create a database if we're actually going to connect to it. databaseActuallyCreateLocally = cfg.database.createLocally && cfg.database.host == null; @@ -25,6 +30,9 @@ in package = lib.mkOption { type = lib.types.package; default = pkgs.discourse; + apply = p: p.override { + plugins = lib.unique (p.enabledPlugins ++ cfg.plugins); + }; defaultText = "pkgs.discourse"; description = '' The discourse package to use. @@ -263,6 +271,17 @@ in Discourse database user. ''; }; + + ignorePostgresqlVersion = lib.mkOption { + type = lib.types.bool; + default = false; + description = '' + Whether to allow other versions of PostgreSQL than the + recommended one. Only effective when + <option>services.discourse.database.createLocally</option> + is enabled. + ''; + }; }; redis = { @@ -340,7 +359,7 @@ in }; port = lib.mkOption { - type = lib.types.int; + type = lib.types.port; default = 25; description = '' The port of the SMTP server Discourse should use to @@ -398,6 +417,14 @@ in How OpenSSL checks the certificate, see http://api.rubyonrails.org/classes/ActionMailer/Base.html ''; }; + + forceTLS = lib.mkOption { + type = lib.types.bool; + default = false; + description = '' + Force implicit TLS as per RFC 8314 3.3. + ''; + }; }; incoming = { @@ -448,21 +475,16 @@ in plugins = lib.mkOption { type = lib.types.listOf lib.types.package; default = []; - example = '' - [ - (pkgs.fetchFromGitHub { - owner = "discourse"; - repo = "discourse-spoiler-alert"; - rev = "e200cfa571d252cab63f3d30d619b370986e4cee"; - sha256 = "0ya69ix5g77wz4c9x9gmng6l25ghb5xxlx3icr6jam16q14dzc33"; - }) + example = lib.literalExample '' + with config.services.discourse.package.plugins; [ + discourse-canned-replies + discourse-github ]; ''; description = '' - <productname>Discourse</productname> plugins to install as a - list of derivations. As long as a plugin supports the - standard install method, packaging it should only require - fetching its source with an appropriate fetcher. + Plugins to install as part of + <productname>Discourse</productname>, expressed as a list of + derivations. ''; }; @@ -497,6 +519,12 @@ in assertion = cfg.hostname != ""; message = "Could not automatically determine hostname, set service.discourse.hostname manually."; } + { + assertion = cfg.database.ignorePostgresqlVersion || (databaseActuallyCreateLocally -> upstreamPostgresqlVersion == postgresqlVersion); + message = "The PostgreSQL version recommended for use with Discourse is ${upstreamPostgresqlVersion}, you're using ${postgresqlVersion}. " + + "Either update your PostgreSQL package to the correct version or set services.discourse.database.ignorePostgresqlVersion. " + + "See https://nixos.org/manual/nixos/stable/index.html#module-postgresql for details on how to upgrade PostgreSQL."; + } ]; @@ -530,6 +558,7 @@ in smtp_authentication = cfg.mail.outgoing.authentication; smtp_enable_start_tls = cfg.mail.outgoing.enableStartTLSAuto; smtp_openssl_verify_mode = cfg.mail.outgoing.opensslVerifyMode; + smtp_force_tls = cfg.mail.outgoing.forceTLS; load_mini_profiler = true; mini_profiler_snapshots_period = 0; @@ -542,8 +571,8 @@ in redis_host = cfg.redis.host; redis_port = 6379; - redis_slave_host = null; - redis_slave_port = 6379; + redis_replica_host = null; + redis_replica_port = 6379; redis_db = cfg.redis.dbNumber; redis_password = cfg.redis.passwordFile; redis_skip_client_commands = false; @@ -552,8 +581,8 @@ in message_bus_redis_enabled = false; message_bus_redis_host = "localhost"; message_bus_redis_port = 6379; - message_bus_redis_slave_host = null; - message_bus_redis_slave_port = 6379; + message_bus_redis_replica_host = null; + message_bus_redis_replica_port = 6379; message_bus_redis_db = 0; message_bus_redis_password = null; message_bus_redis_skip_client_commands = false; @@ -606,6 +635,7 @@ in allowed_theme_repos = null; enable_email_sync_demon = false; max_digests_enqueued_per_30_mins_per_site = 10000; + cluster_name = null; }; services.redis.enable = lib.mkDefault (cfg.redis.host == "localhost"); @@ -667,6 +697,7 @@ in environment = cfg.package.runtimeEnv // { UNICORN_TIMEOUT = builtins.toString cfg.unicornTimeout; UNICORN_SIDEKIQS = builtins.toString cfg.sidekiqProcesses; + MALLOC_ARENA_MAX = "2"; }; preStart = @@ -698,8 +729,6 @@ in cp -r ${cfg.package}/share/discourse/config.dist/* /run/discourse/config/ cp -r ${cfg.package}/share/discourse/public.dist/* /run/discourse/public/ - cp -r ${cfg.package}/share/discourse/plugins.dist/* /run/discourse/plugins/ - ${lib.concatMapStringsSep "\n" (p: "ln -sf ${p} /run/discourse/plugins/") cfg.plugins} ln -sf /var/lib/discourse/uploads /run/discourse/public/uploads ln -sf /var/lib/discourse/backups /run/discourse/public/backups diff --git a/nixos/modules/services/web-apps/discourse.xml b/nixos/modules/services/web-apps/discourse.xml index bae56242321..1d6866e7b35 100644 --- a/nixos/modules/services/web-apps/discourse.xml +++ b/nixos/modules/services/web-apps/discourse.xml @@ -262,9 +262,31 @@ services.discourse = { <para> You can install <productname>Discourse</productname> plugins using the <xref linkend="opt-services.discourse.plugins" /> - option. As long as a plugin supports the standard install - method, packaging it should only require fetching its source - with an appropriate fetcher. + option. Pre-packaged plugins are provided in + <literal><your_discourse_package_here>.plugins</literal>. If + you want the full suite of plugins provided through + <literal>nixpkgs</literal>, you can also set the <xref + linkend="opt-services.discourse.package" /> option to + <literal>pkgs.discourseAllPlugins</literal>. + </para> + + <para> + Plugins can be built with the + <literal><your_discourse_package_here>.mkDiscoursePlugin</literal> + function. Normally, it should suffice to provide a + <literal>name</literal> and <literal>src</literal> attribute. If + the plugin has Ruby dependencies, however, they need to be + packaged in accordance with the <link + xlink:href="https://nixos.org/manual/nixpkgs/stable/#developing-with-ruby">Developing + with Ruby</link> section of the Nixpkgs manual and the + appropriate gem options set in <literal>bundlerEnvArgs</literal> + (normally <literal>gemdir</literal> is sufficient). A plugin's + Ruby dependencies are listed in its + <filename>plugin.rb</filename> file as function calls to + <literal>gem</literal>. To construct the corresponding + <filename>Gemfile</filename>, run <command>bundle + init</command>, then add the <literal>gem</literal> lines to it + verbatim. </para> <para> @@ -280,7 +302,10 @@ services.discourse = { <para> For example, to add the <link xlink:href="https://github.com/discourse/discourse-spoiler-alert">discourse-spoiler-alert</link> - plugin and disable it by default: + and <link + xlink:href="https://github.com/discourse/discourse-solved">discourse-solved</link> + plugins, and disable <literal>discourse-spoiler-alert</literal> + by default: <programlisting> services.discourse = { @@ -301,13 +326,9 @@ services.discourse = { <link linkend="opt-services.discourse.mail.outgoing.passwordFile">passwordFile</link> = "/path/to/smtp_password_file"; }; <link linkend="opt-services.discourse.mail.incoming.enable">mail.incoming.enable</link> = true; - <link linkend="opt-services.discourse.mail.incoming.enable">plugins</link> = [ - (pkgs.fetchFromGitHub { - owner = "discourse"; - repo = "discourse-spoiler-alert"; - rev = "e200cfa571d252cab63f3d30d619b370986e4cee"; - sha256 = "0ya69ix5g77wz4c9x9gmng6l25ghb5xxlx3icr6jam16q14dzc33"; - }) + <link linkend="opt-services.discourse.mail.incoming.enable">plugins</link> = with config.services.discourse.package.plugins; [ + discourse-spoiler-alert + discourse-solved ]; <link linkend="opt-services.discourse.siteSettings">siteSettings</link> = { plugins = { diff --git a/nixos/modules/services/web-apps/engelsystem.nix b/nixos/modules/services/web-apps/engelsystem.nix index 2e755ae9d52..b87fecae65f 100644 --- a/nixos/modules/services/web-apps/engelsystem.nix +++ b/nixos/modules/services/web-apps/engelsystem.nix @@ -89,7 +89,7 @@ in { # create database services.mysql = mkIf cfg.createDatabase { enable = true; - package = mkDefault pkgs.mysql; + package = mkDefault pkgs.mariadb; ensureUsers = [{ name = "engelsystem"; ensurePermissions = { "engelsystem.*" = "ALL PRIVILEGES"; }; diff --git a/nixos/modules/services/web-apps/icingaweb2/icingaweb2.nix b/nixos/modules/services/web-apps/icingaweb2/icingaweb2.nix index eea49bda283..f8f0854f1bc 100644 --- a/nixos/modules/services/web-apps/icingaweb2/icingaweb2.nix +++ b/nixos/modules/services/web-apps/icingaweb2/icingaweb2.nix @@ -23,6 +23,16 @@ in { ''; }; + libraryPaths = mkOption { + type = attrsOf package; + default = { }; + description = '' + Libraries to add to the Icingaweb2 library path. + The name of the attribute is the name of the library, the value + is the package to add. + ''; + }; + virtualHost = mkOption { type = nullOr str; default = "icingaweb2"; @@ -167,6 +177,9 @@ in { services.phpfpm.pools = mkIf (cfg.pool == "${poolName}") { ${poolName} = { user = "icingaweb2"; + phpEnv = { + ICINGAWEB_LIBDIR = toString (pkgs.linkFarm "icingaweb2-libdir" (mapAttrsToList (name: path: { inherit name path; }) cfg.libraryPaths)); + }; phpPackage = pkgs.php.withExtensions ({ enabled, all }: [ all.imagick ] ++ enabled); phpOptions = '' date.timezone = "${cfg.timezone}" @@ -184,6 +197,11 @@ in { }; }; + services.icingaweb2.libraryPaths = { + ipl = pkgs.icingaweb2-ipl; + thirdparty = pkgs.icingaweb2-thirdparty; + }; + systemd.services."phpfpm-${poolName}".serviceConfig.ReadWritePaths = [ "/etc/icingaweb2" ]; services.nginx = { diff --git a/nixos/modules/services/web-apps/jitsi-meet.nix b/nixos/modules/services/web-apps/jitsi-meet.nix index 2df762882fa..997604754e4 100644 --- a/nixos/modules/services/web-apps/jitsi-meet.nix +++ b/nixos/modules/services/web-apps/jitsi-meet.nix @@ -186,9 +186,10 @@ in } ]; extraModules = [ "pubsub" ]; + extraPluginPaths = [ "${pkgs.jitsi-meet-prosody}/share/prosody-plugins" ]; extraConfig = mkAfter '' - Component "focus.${cfg.hostName}" - component_secret = os.getenv("JICOFO_COMPONENT_SECRET") + Component "focus.${cfg.hostName}" "client_proxy" + target_address = "focus@auth.${cfg.hostName}" ''; virtualHosts.${cfg.hostName} = { enabled = true; @@ -254,6 +255,7 @@ in + optionalString cfg.prosody.enable '' ${config.services.prosody.package}/bin/prosodyctl register focus auth.${cfg.hostName} "$(cat /var/lib/jitsi-meet/jicofo-user-secret)" ${config.services.prosody.package}/bin/prosodyctl register jvb auth.${cfg.hostName} "$(cat ${videobridgeSecret})" + ${config.services.prosody.package}/bin/prosodyctl mod_roster_command subscribe focus.${cfg.hostName} focus@auth.${cfg.hostName} # generate self-signed certificates if [ ! -f /var/lib/jitsi-meet.crt ]; then diff --git a/nixos/modules/services/web-apps/keycloak.nix b/nixos/modules/services/web-apps/keycloak.nix index f0b9e60116d..dc66c296656 100644 --- a/nixos/modules/services/web-apps/keycloak.nix +++ b/nixos/modules/services/web-apps/keycloak.nix @@ -728,7 +728,7 @@ in services.postgresql.enable = lib.mkDefault createLocalPostgreSQL; services.mysql.enable = lib.mkDefault createLocalMySQL; - services.mysql.package = lib.mkIf createLocalMySQL pkgs.mysql; + services.mysql.package = lib.mkIf createLocalMySQL pkgs.mariadb; }; meta.doc = ./keycloak.xml; diff --git a/nixos/modules/services/web-apps/matomo.nix b/nixos/modules/services/web-apps/matomo.nix index 75da474dc44..79a0354e22b 100644 --- a/nixos/modules/services/web-apps/matomo.nix +++ b/nixos/modules/services/web-apps/matomo.nix @@ -77,6 +77,16 @@ in { ''; }; + periodicArchiveProcessingUrl = mkOption { + type = types.str; + default = "${user}.${fqdn}"; + example = "matomo.yourdomain.org"; + description = '' + URL of the host, without https prefix. By default, this is ${user}.${fqdn}, but you may want to change it if you + run Matomo on a different URL than matomo.yourdomain. + ''; + }; + nginx = mkOption { type = types.nullOr (types.submodule ( recursiveUpdate @@ -190,7 +200,7 @@ in { UMask = "0007"; CPUSchedulingPolicy = "idle"; IOSchedulingClass = "idle"; - ExecStart = "${cfg.package}/bin/matomo-console core:archive --url=https://${user}.${fqdn}"; + ExecStart = "${cfg.package}/bin/matomo-console core:archive --url=https://${cfg.periodicArchiveProcessingUrl}"; }; }; diff --git a/nixos/modules/services/web-apps/nextcloud.nix b/nixos/modules/services/web-apps/nextcloud.nix index 545deaa905f..5e15aaba096 100644 --- a/nixos/modules/services/web-apps/nextcloud.nix +++ b/nixos/modules/services/web-apps/nextcloud.nix @@ -92,7 +92,7 @@ in { package = mkOption { type = types.package; description = "Which package to use for the Nextcloud instance."; - relatedPackages = [ "nextcloud19" "nextcloud20" "nextcloud21" ]; + relatedPackages = [ "nextcloud20" "nextcloud21" "nextcloud22" ]; }; maxUploadSize = mkOption { @@ -385,7 +385,7 @@ in { ]; warnings = let - latest = 21; + latest = 22; upgradeWarning = major: nixos: '' A legacy Nextcloud install (from before NixOS ${nixos}) may be installed. @@ -403,9 +403,9 @@ in { Using config.services.nextcloud.poolConfig is deprecated and will become unsupported in a future release. Please migrate your configuration to config.services.nextcloud.poolSettings. '') - ++ (optional (versionOlder cfg.package.version "19") (upgradeWarning 18 "20.09")) ++ (optional (versionOlder cfg.package.version "20") (upgradeWarning 19 "21.05")) - ++ (optional (versionOlder cfg.package.version "21") (upgradeWarning 20 "21.05")); + ++ (optional (versionOlder cfg.package.version "21") (upgradeWarning 20 "21.05")) + ++ (optional (versionOlder cfg.package.version "22") (upgradeWarning 21 "21.11")); services.nextcloud.package = with pkgs; mkDefault ( @@ -415,13 +415,13 @@ in { nextcloud defined in an overlay, please set `services.nextcloud.package` to `pkgs.nextcloud`. '' - else if versionOlder stateVersion "20.09" then nextcloud18 # 21.03 will not be an official release - it was instead 21.05. # This versionOlder statement remains set to 21.03 for backwards compatibility. # See https://github.com/NixOS/nixpkgs/pull/108899 and # https://github.com/NixOS/rfcs/blob/master/rfcs/0080-nixos-release-schedule.md. else if versionOlder stateVersion "21.03" then nextcloud19 - else nextcloud21 + else if versionOlder stateVersion "21.11" then nextcloud21 + else nextcloud22 ); } @@ -616,9 +616,7 @@ in { services.nginx.enable = mkDefault true; - services.nginx.virtualHosts.${cfg.hostName} = let - major = toInt (versions.major cfg.package.version); - in { + services.nginx.virtualHosts.${cfg.hostName} = { root = cfg.package; locations = { "= /robots.txt" = { @@ -701,7 +699,6 @@ in { }; extraConfig = '' index index.php index.html /index.php$request_uri; - expires 1m; add_header X-Content-Type-Options nosniff; add_header X-XSS-Protection "1; mode=block"; add_header X-Robots-Tag none; diff --git a/nixos/modules/services/web-apps/nextcloud.xml b/nixos/modules/services/web-apps/nextcloud.xml index 83a6f68edcb..3af37b15dd5 100644 --- a/nixos/modules/services/web-apps/nextcloud.xml +++ b/nixos/modules/services/web-apps/nextcloud.xml @@ -11,7 +11,7 @@ desktop client is packaged at <literal>pkgs.nextcloud-client</literal>. </para> <para> - The current default by NixOS is <package>nextcloud21</package> which is also the latest + The current default by NixOS is <package>nextcloud22</package> which is also the latest major version available. </para> <section xml:id="module-services-nextcloud-basic-usage"> diff --git a/nixos/modules/services/web-apps/plausible.nix b/nixos/modules/services/web-apps/plausible.nix new file mode 100644 index 00000000000..b56848b79d2 --- /dev/null +++ b/nixos/modules/services/web-apps/plausible.nix @@ -0,0 +1,285 @@ +{ lib, pkgs, config, ... }: + +with lib; + +let + cfg = config.services.plausible; + + # FIXME consider using LoadCredential as soon as it actually works. + envSecrets = '' + ADMIN_USER_PWD="$(<${cfg.adminUser.passwordFile})" + export ADMIN_USER_PWD # separate export to make `set -e` work + + SECRET_KEY_BASE="$(<${cfg.server.secretKeybaseFile})" + export SECRET_KEY_BASE # separate export to make `set -e` work + + ${optionalString (cfg.mail.smtp.passwordFile != null) '' + SMTP_USER_PWD="$(<${cfg.mail.smtp.passwordFile})" + export SMTP_USER_PWD # separate export to make `set -e` work + ''} + ''; +in { + options.services.plausible = { + enable = mkEnableOption "plausible"; + + adminUser = { + name = mkOption { + default = "admin"; + type = types.str; + description = '' + Name of the admin user that plausible will created on initial startup. + ''; + }; + + email = mkOption { + type = types.str; + example = "admin@localhost"; + description = '' + Email-address of the admin-user. + ''; + }; + + passwordFile = mkOption { + type = types.either types.str types.path; + description = '' + Path to the file which contains the password of the admin user. + ''; + }; + + activate = mkEnableOption "activating the freshly created admin-user"; + }; + + database = { + clickhouse = { + setup = mkEnableOption "creating a clickhouse instance" // { default = true; }; + url = mkOption { + default = "http://localhost:8123/default"; + type = types.str; + description = '' + The URL to be used to connect to <package>clickhouse</package>. + ''; + }; + }; + postgres = { + setup = mkEnableOption "creating a postgresql instance" // { default = true; }; + dbname = mkOption { + default = "plausible"; + type = types.str; + description = '' + Name of the database to use. + ''; + }; + socket = mkOption { + default = "/run/postgresql"; + type = types.str; + description = '' + Path to the UNIX domain-socket to communicate with <package>postgres</package>. + ''; + }; + }; + }; + + server = { + disableRegistration = mkOption { + default = true; + type = types.bool; + description = '' + Whether to prohibit creating an account in plausible's UI. + ''; + }; + secretKeybaseFile = mkOption { + type = types.either types.path types.str; + description = '' + Path to the secret used by the <literal>phoenix</literal>-framework. Instructions + how to generate one are documented in the + <link xlink:href="https://hexdocs.pm/phoenix/Mix.Tasks.Phx.Gen.Secret.html#content"> + framework docs</link>. + ''; + }; + port = mkOption { + default = 8000; + type = types.port; + description = '' + Port where the service should be available. + ''; + }; + baseUrl = mkOption { + type = types.str; + description = '' + Public URL where plausible is available. + + Note that <literal>/path</literal> components are currently ignored: + <link xlink:href="https://github.com/plausible/analytics/issues/1182"> + https://github.com/plausible/analytics/issues/1182 + </link>. + ''; + }; + }; + + mail = { + email = mkOption { + default = "hello@plausible.local"; + type = types.str; + description = '' + The email id to use for as <emphasis>from</emphasis> address of all communications + from Plausible. + ''; + }; + smtp = { + hostAddr = mkOption { + default = "localhost"; + type = types.str; + description = '' + The host address of your smtp server. + ''; + }; + hostPort = mkOption { + default = 25; + type = types.port; + description = '' + The port of your smtp server. + ''; + }; + user = mkOption { + default = null; + type = types.nullOr types.str; + description = '' + The username/email in case SMTP auth is enabled. + ''; + }; + passwordFile = mkOption { + default = null; + type = with types; nullOr (either str path); + description = '' + The path to the file with the password in case SMTP auth is enabled. + ''; + }; + enableSSL = mkEnableOption "SSL when connecting to the SMTP server"; + retries = mkOption { + type = types.ints.unsigned; + default = 2; + description = '' + Number of retries to make until mailer gives up. + ''; + }; + }; + }; + }; + + config = mkIf cfg.enable { + assertions = [ + { assertion = cfg.adminUser.activate -> cfg.database.postgres.setup; + message = '' + Unable to automatically activate the admin-user if no locally managed DB for + postgres (`services.plausible.database.postgres.setup') is enabled! + ''; + } + ]; + + services.postgresql = mkIf cfg.database.postgres.setup { + enable = true; + }; + + services.clickhouse = mkIf cfg.database.clickhouse.setup { + enable = true; + }; + + systemd.services = mkMerge [ + { + plausible = { + inherit (pkgs.plausible.meta) description; + documentation = [ "https://plausible.io/docs/self-hosting" ]; + wantedBy = [ "multi-user.target" ]; + after = optional cfg.database.postgres.setup "plausible-postgres.service"; + requires = optional cfg.database.clickhouse.setup "clickhouse.service" + ++ optionals cfg.database.postgres.setup [ + "postgresql.service" + "plausible-postgres.service" + ]; + + environment = { + # NixOS specific option to avoid that it's trying to write into its store-path. + # See also https://github.com/lau/tzdata#data-directory-and-releases + TZDATA_DIR = "/var/lib/plausible/elixir_tzdata"; + + # Configuration options from + # https://plausible.io/docs/self-hosting-configuration + PORT = toString cfg.server.port; + DISABLE_REGISTRATION = boolToString cfg.server.disableRegistration; + + RELEASE_TMP = "/var/lib/plausible/tmp"; + + ADMIN_USER_NAME = cfg.adminUser.name; + ADMIN_USER_EMAIL = cfg.adminUser.email; + + DATABASE_SOCKET_DIR = cfg.database.postgres.socket; + DATABASE_NAME = cfg.database.postgres.dbname; + CLICKHOUSE_DATABASE_URL = cfg.database.clickhouse.url; + + BASE_URL = cfg.server.baseUrl; + + MAILER_EMAIL = cfg.mail.email; + SMTP_HOST_ADDR = cfg.mail.smtp.hostAddr; + SMTP_HOST_PORT = toString cfg.mail.smtp.hostPort; + SMTP_RETRIES = toString cfg.mail.smtp.retries; + SMTP_HOST_SSL_ENABLED = boolToString cfg.mail.smtp.enableSSL; + + SELFHOST = "true"; + } // (optionalAttrs (cfg.mail.smtp.user != null) { + SMTP_USER_NAME = cfg.mail.smtp.user; + }); + + path = [ pkgs.plausible ] + ++ optional cfg.database.postgres.setup config.services.postgresql.package; + + serviceConfig = { + DynamicUser = true; + PrivateTmp = true; + WorkingDirectory = "/var/lib/plausible"; + StateDirectory = "plausible"; + ExecStartPre = "@${pkgs.writeShellScript "plausible-setup" '' + set -eu -o pipefail + ${envSecrets} + ${pkgs.plausible}/createdb.sh + ${pkgs.plausible}/migrate.sh + ${optionalString cfg.adminUser.activate '' + if ! ${pkgs.plausible}/init-admin.sh | grep 'already exists'; then + psql -d plausible <<< "UPDATE users SET email_verified=true;" + fi + ''} + ''} plausible-setup"; + ExecStart = "@${pkgs.writeShellScript "plausible" '' + set -eu -o pipefail + ${envSecrets} + plausible start + ''} plausible"; + }; + }; + } + (mkIf cfg.database.postgres.setup { + # `plausible' requires the `citext'-extension. + plausible-postgres = { + after = [ "postgresql.service" ]; + bindsTo = [ "postgresql.service" ]; + requiredBy = [ "plausible.service" ]; + partOf = [ "plausible.service" ]; + serviceConfig.Type = "oneshot"; + unitConfig.ConditionPathExists = "!/var/lib/plausible/.db-setup"; + script = '' + mkdir -p /var/lib/plausible/ + PSQL() { + /run/wrappers/bin/sudo -Hu postgres ${config.services.postgresql.package}/bin/psql --port=5432 "$@" + } + PSQL -tAc "CREATE ROLE plausible WITH LOGIN;" + PSQL -tAc "CREATE DATABASE plausible WITH OWNER plausible;" + PSQL -d plausible -tAc "CREATE EXTENSION IF NOT EXISTS citext;" + touch /var/lib/plausible/.db-setup + ''; + }; + }) + ]; + }; + + meta.maintainers = with maintainers; [ ma27 ]; + meta.doc = ./plausible.xml; +} diff --git a/nixos/modules/services/web-apps/plausible.xml b/nixos/modules/services/web-apps/plausible.xml new file mode 100644 index 00000000000..92a571b9fbd --- /dev/null +++ b/nixos/modules/services/web-apps/plausible.xml @@ -0,0 +1,51 @@ +<chapter xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + version="5.0" + xml:id="module-services-plausible"> + <title>Plausible</title> + <para> + <link xlink:href="https://plausible.io/">Plausible</link> is a privacy-friendly alternative to + Google analytics. + </para> + <section xml:id="module-services-plausible-basic-usage"> + <title>Basic Usage</title> + <para> + At first, a secret key is needed to be generated. This can be done with e.g. + <screen><prompt>$ </prompt>openssl rand -base64 64</screen> + </para> + <para> + After that, <package>plausible</package> can be deployed like this: +<programlisting>{ + services.plausible = { + <link linkend="opt-services.plausible.enable">enable</link> = true; + adminUser = { + <link linkend="opt-services.plausible.adminUser.activate">activate</link> = true; <co xml:id='ex-plausible-cfg-activate' /> + <link linkend="opt-services.plausible.adminUser.email">email</link> = "admin@localhost"; + <link linkend="opt-services.plausible.adminUser.passwordFile">passwordFile</link> = "/run/secrets/plausible-admin-pwd"; + }; + server = { + <link linkend="opt-services.plausible.server.baseUrl">baseUrl</link> = "http://analytics.example.org"; + <link linkend="opt-services.plausible.server.secretKeybaseFile">secretKeybaseFile</link> = "/run/secrets/plausible-secret-key-base"; <co xml:id='ex-plausible-cfg-secretbase' /> + }; + }; +}</programlisting> + <calloutlist> + <callout arearefs='ex-plausible-cfg-activate'> + <para> + <varname>activate</varname> is used to skip the email verification of the admin-user that's + automatically created by <package>plausible</package>. This is only supported if + <package>postgresql</package> is configured by the module. This is done by default, but + can be turned off with <xref linkend="opt-services.plausible.database.postgres.setup" />. + </para> + </callout> + <callout arearefs='ex-plausible-cfg-secretbase'> + <para> + <varname>secretKeybaseFile</varname> is a path to the file which contains the secret generated + with <package>openssl</package> as described above. + </para> + </callout> + </calloutlist> + </para> + </section> +</chapter> diff --git a/nixos/modules/services/web-apps/trilium.nix b/nixos/modules/services/web-apps/trilium.nix index 3a6ea02676a..35383c992fe 100644 --- a/nixos/modules/services/web-apps/trilium.nix +++ b/nixos/modules/services/web-apps/trilium.nix @@ -9,6 +9,7 @@ let # Disable automatically generating desktop icon noDesktopIcon=true + noBackup=${lib.boolToString cfg.noBackup} [Network] # host setting is relevant only for web deployments - set the host on which the server will listen @@ -28,7 +29,7 @@ in type = types.str; default = "/var/lib/trilium"; description = '' - The directory storing the nodes database and the configuration. + The directory storing the notes database and the configuration. ''; }; @@ -40,6 +41,14 @@ in ''; }; + noBackup = mkOption { + type = types.bool; + default = false; + description = '' + Disable periodic database backups. + ''; + }; + host = mkOption { type = types.str; default = "127.0.0.1"; @@ -85,7 +94,7 @@ in config = lib.mkIf cfg.enable (lib.mkMerge [ { - meta.maintainers = with lib.maintainers; [ ]; + meta.maintainers = with lib.maintainers; [ fliegendewurst ]; users.groups.trilium = {}; users.users.trilium = { diff --git a/nixos/modules/services/web-apps/tt-rss.nix b/nixos/modules/services/web-apps/tt-rss.nix index 6a29f10d119..b78487cc928 100644 --- a/nixos/modules/services/web-apps/tt-rss.nix +++ b/nixos/modules/services/web-apps/tt-rss.nix @@ -644,7 +644,7 @@ let services.mysql = mkIf mysqlLocal { enable = true; - package = mkDefault pkgs.mysql; + package = mkDefault pkgs.mariadb; ensureDatabases = [ cfg.database.name ]; ensureUsers = [ { diff --git a/nixos/modules/services/web-apps/vikunja.nix b/nixos/modules/services/web-apps/vikunja.nix new file mode 100644 index 00000000000..b0b6eb6df17 --- /dev/null +++ b/nixos/modules/services/web-apps/vikunja.nix @@ -0,0 +1,145 @@ +{ pkgs, lib, config, ... }: + +with lib; + +let + cfg = config.services.vikunja; + format = pkgs.formats.yaml {}; + configFile = format.generate "config.yaml" cfg.settings; + useMysql = cfg.database.type == "mysql"; + usePostgresql = cfg.database.type == "postgres"; +in { + options.services.vikunja = with lib; { + enable = mkEnableOption "vikunja service"; + package-api = mkOption { + default = pkgs.vikunja-api; + type = types.package; + defaultText = "pkgs.vikunja-api"; + description = "vikunja-api derivation to use."; + }; + package-frontend = mkOption { + default = pkgs.vikunja-frontend; + type = types.package; + defaultText = "pkgs.vikunja-frontend"; + description = "vikunja-frontend derivation to use."; + }; + environmentFiles = mkOption { + type = types.listOf types.path; + default = [ ]; + description = '' + List of environment files set in the vikunja systemd service. + For example passwords should be set in one of these files. + ''; + }; + setupNginx = mkOption { + type = types.bool; + default = config.services.nginx.enable; + defaultText = "config.services.nginx.enable"; + description = '' + Whether to setup NGINX. + Further nginx configuration can be done by changing + <option>services.nginx.virtualHosts.<frontendHostname></option>. + This does not enable TLS or ACME by default. To enable this, set the + <option>services.nginx.virtualHosts.<frontendHostname>.enableACME</option> to + <literal>true</literal> and if appropriate do the same for + <option>services.nginx.virtualHosts.<frontendHostname>.forceSSL</option>. + ''; + }; + frontendScheme = mkOption { + type = types.enum [ "http" "https" ]; + description = '' + Whether the site is available via http or https. + This does not configure https or ACME in nginx! + ''; + }; + frontendHostname = mkOption { + type = types.str; + description = "The Hostname under which the frontend is running."; + }; + + settings = mkOption { + type = format.type; + default = {}; + description = '' + Vikunja configuration. Refer to + <link xlink:href="https://vikunja.io/docs/config-options/"/> + for details on supported values. + ''; + }; + database = { + type = mkOption { + type = types.enum [ "sqlite" "mysql" "postgres" ]; + example = "postgres"; + default = "sqlite"; + description = "Database engine to use."; + }; + host = mkOption { + type = types.str; + default = "localhost"; + description = "Database host address. Can also be a socket."; + }; + user = mkOption { + type = types.str; + default = "vikunja"; + description = "Database user."; + }; + database = mkOption { + type = types.str; + default = "vikunja"; + description = "Database name."; + }; + path = mkOption { + type = types.str; + default = "/var/lib/vikunja/vikunja.db"; + description = "Path to the sqlite3 database file."; + }; + }; + }; + config = lib.mkIf cfg.enable { + services.vikunja.settings = { + database = { + inherit (cfg.database) type host user database path; + }; + service = { + frontendurl = "${cfg.frontendScheme}://${cfg.frontendHostname}/"; + }; + files = { + basepath = "/var/lib/vikunja/files"; + }; + }; + + systemd.services.vikunja-api = { + description = "vikunja-api"; + after = [ "network.target" ] ++ lib.optional usePostgresql "postgresql.service" ++ lib.optional useMysql "mysql.service"; + wantedBy = [ "multi-user.target" ]; + path = [ cfg.package-api ]; + restartTriggers = [ configFile ]; + + serviceConfig = { + Type = "simple"; + DynamicUser = true; + StateDirectory = "vikunja"; + ExecStart = "${cfg.package-api}/bin/vikunja"; + Restart = "always"; + EnvironmentFile = cfg.environmentFiles; + }; + }; + + services.nginx.virtualHosts."${cfg.frontendHostname}" = mkIf cfg.setupNginx { + locations = { + "/" = { + root = cfg.package-frontend; + tryFiles = "try_files $uri $uri/ /"; + }; + "~* ^/(api|dav|\\.well-known)/" = { + proxyPass = "http://localhost:3456"; + extraConfig = '' + client_max_body_size 20M; + ''; + }; + }; + }; + + environment.etc."vikunja/config.yaml".source = configFile; + }; +} diff --git a/nixos/modules/services/web-apps/wordpress.nix b/nixos/modules/services/web-apps/wordpress.nix index f251cfe32db..6f1ef815bc4 100644 --- a/nixos/modules/services/web-apps/wordpress.nix +++ b/nixos/modules/services/web-apps/wordpress.nix @@ -3,13 +3,18 @@ let inherit (lib) mkDefault mkEnableOption mkForce mkIf mkMerge mkOption types; inherit (lib) any attrValues concatMapStringsSep flatten literalExample; - inherit (lib) mapAttrs mapAttrs' mapAttrsToList nameValuePair optional optionalAttrs optionalString; + inherit (lib) filterAttrs mapAttrs mapAttrs' mapAttrsToList nameValuePair optional optionalAttrs optionalString; - eachSite = config.services.wordpress; + cfg = migrateOldAttrs config.services.wordpress; + eachSite = cfg.sites; user = "wordpress"; - group = config.services.httpd.group; + webserver = config.services.${cfg.webserver}; stateDir = hostName: "/var/lib/wordpress/${hostName}"; + # Migrate config.services.wordpress.<hostName> to config.services.wordpress.sites.<hostName> + oldSites = filterAttrs (o: _: o != "sites" && o != "webserver"); + migrateOldAttrs = cfg: cfg // { sites = cfg.sites // oldSites cfg; }; + pkg = hostName: cfg: pkgs.stdenv.mkDerivation rec { pname = "wordpress-${hostName}"; version = src.version; @@ -61,8 +66,10 @@ let ?> ''; - secretsVars = [ "AUTH_KEY" "SECURE_AUTH_KEY" "LOOGGED_IN_KEY" "NONCE_KEY" "AUTH_SALT" "SECURE_AUTH_SALT" "LOGGED_IN_SALT" "NONCE_SALT" ]; + secretsVars = [ "AUTH_KEY" "SECURE_AUTH_KEY" "LOGGED_IN_KEY" "NONCE_KEY" "AUTH_SALT" "SECURE_AUTH_SALT" "LOGGED_IN_SALT" "NONCE_SALT" ]; secretsScript = hostStateDir: '' + # The match in this line is not a typo, see https://github.com/NixOS/nixpkgs/pull/124839 + grep -q "LOOGGED_IN_KEY" "${hostStateDir}/secret-keys.php" && rm "${hostStateDir}/secret-keys.php" if ! test -e "${hostStateDir}/secret-keys.php"; then umask 0177 echo "<?php" >> "${hostStateDir}/secret-keys.php" @@ -259,21 +266,48 @@ in # interface options = { services.wordpress = mkOption { - type = types.attrsOf (types.submodule siteOpts); + type = types.submodule { + # Used to support old interface + freeformType = types.attrsOf (types.submodule siteOpts); + + # New interface + options.sites = mkOption { + type = types.attrsOf (types.submodule siteOpts); + default = {}; + description = "Specification of one or more WordPress sites to serve"; + }; + + options.webserver = mkOption { + type = types.enum [ "httpd" "nginx" ]; + default = "httpd"; + description = '' + Whether to use apache2 or nginx for virtual host management. + + Further nginx configuration can be done by adapting <literal>services.nginx.virtualHosts.<name></literal>. + See <xref linkend="opt-services.nginx.virtualHosts"/> for further information. + + Further apache2 configuration can be done by adapting <literal>services.httpd.virtualHosts.<name></literal>. + See <xref linkend="opt-services.httpd.virtualHosts"/> for further information. + ''; + }; + }; default = {}; - description = "Specification of one or more WordPress sites to serve via Apache."; + description = "Wordpress configuration"; }; + }; # implementation - config = mkIf (eachSite != {}) { + config = mkIf (eachSite != {}) (mkMerge [{ assertions = mapAttrsToList (hostName: cfg: { assertion = cfg.database.createLocally -> cfg.database.user == user; - message = "services.wordpress.${hostName}.database.user must be ${user} if the database is to be automatically provisioned"; + message = ''services.wordpress.sites."${hostName}".database.user must be ${user} if the database is to be automatically provisioned''; } ) eachSite; + warnings = mapAttrsToList (hostName: _: ''services.wordpress."${hostName}" is deprecated use services.wordpress.sites."${hostName}"'') (oldSites cfg); + services.mysql = mkIf (any (v: v.database.createLocally) (attrValues eachSite)) { enable = true; package = mkDefault pkgs.mariadb; @@ -287,14 +321,18 @@ in services.phpfpm.pools = mapAttrs' (hostName: cfg: ( nameValuePair "wordpress-${hostName}" { - inherit user group; + inherit user; + group = webserver.group; settings = { - "listen.owner" = config.services.httpd.user; - "listen.group" = config.services.httpd.group; + "listen.owner" = webserver.user; + "listen.group" = webserver.group; } // cfg.poolConfig; } )) eachSite; + } + + (mkIf (cfg.webserver == "httpd") { services.httpd = { enable = true; extraModules = [ "proxy_fcgi" ]; @@ -330,11 +368,13 @@ in ''; } ]) eachSite; }; + }) + { systemd.tmpfiles.rules = flatten (mapAttrsToList (hostName: cfg: [ - "d '${stateDir hostName}' 0750 ${user} ${group} - -" - "d '${cfg.uploadsDir}' 0750 ${user} ${group} - -" - "Z '${cfg.uploadsDir}' 0750 ${user} ${group} - -" + "d '${stateDir hostName}' 0750 ${user} ${webserver.group} - -" + "d '${cfg.uploadsDir}' 0750 ${user} ${webserver.group} - -" + "Z '${cfg.uploadsDir}' 0750 ${user} ${webserver.group} - -" ]) eachSite); systemd.services = mkMerge [ @@ -348,7 +388,7 @@ in serviceConfig = { Type = "oneshot"; User = user; - Group = group; + Group = webserver.group; }; })) eachSite) @@ -358,9 +398,65 @@ in ]; users.users.${user} = { - group = group; + group = webserver.group; isSystemUser = true; }; + } - }; + (mkIf (cfg.webserver == "nginx") { + services.nginx = { + enable = true; + virtualHosts = mapAttrs (hostName: cfg: { + serverName = mkDefault hostName; + root = "${pkg hostName cfg}/share/wordpress"; + extraConfig = '' + index index.php; + ''; + locations = { + "/" = { + priority = 200; + extraConfig = '' + try_files $uri $uri/ /index.php$is_args$args; + ''; + }; + "~ \\.php$" = { + priority = 500; + extraConfig = '' + fastcgi_split_path_info ^(.+\.php)(/.+)$; + fastcgi_pass unix:${config.services.phpfpm.pools."wordpress-${hostName}".socket}; + fastcgi_index index.php; + include "${config.services.nginx.package}/conf/fastcgi.conf"; + fastcgi_param PATH_INFO $fastcgi_path_info; + fastcgi_param PATH_TRANSLATED $document_root$fastcgi_path_info; + # Mitigate https://httpoxy.org/ vulnerabilities + fastcgi_param HTTP_PROXY ""; + fastcgi_intercept_errors off; + fastcgi_buffer_size 16k; + fastcgi_buffers 4 16k; + fastcgi_connect_timeout 300; + fastcgi_send_timeout 300; + fastcgi_read_timeout 300; + ''; + }; + "~ /\\." = { + priority = 800; + extraConfig = "deny all;"; + }; + "~* /(?:uploads|files)/.*\\.php$" = { + priority = 900; + extraConfig = "deny all;"; + }; + "~* \\.(js|css|png|jpg|jpeg|gif|ico)$" = { + priority = 1000; + extraConfig = '' + expires max; + log_not_found off; + ''; + }; + }; + }) eachSite; + }; + }) + + ]); } diff --git a/nixos/modules/services/web-servers/apache-httpd/default.nix b/nixos/modules/services/web-servers/apache-httpd/default.nix index a7b93c9c459..df7035c03cc 100644 --- a/nixos/modules/services/web-servers/apache-httpd/default.nix +++ b/nixos/modules/services/web-servers/apache-httpd/default.nix @@ -202,7 +202,7 @@ let let documentRoot = if hostOpts.documentRoot != null then hostOpts.documentRoot - else pkgs.runCommand "empty" { preferLocalBuild = true; } "mkdir -p $out" + else pkgs.emptyDirectory ; mkLocations = locations: concatStringsSep "\n" (map (config: '' diff --git a/nixos/modules/services/web-servers/darkhttpd.nix b/nixos/modules/services/web-servers/darkhttpd.nix index d6649fd472d..f6b693139a1 100644 --- a/nixos/modules/services/web-servers/darkhttpd.nix +++ b/nixos/modules/services/web-servers/darkhttpd.nix @@ -19,7 +19,7 @@ in { port = mkOption { default = 80; - type = ints.u16; + type = types.port; description = '' Port to listen on. Pass 0 to let the system choose any free port for you. diff --git a/nixos/modules/services/web-servers/lighttpd/default.nix b/nixos/modules/services/web-servers/lighttpd/default.nix index d1cb8a8dc25..7a691aa7891 100644 --- a/nixos/modules/services/web-servers/lighttpd/default.nix +++ b/nixos/modules/services/web-servers/lighttpd/default.nix @@ -134,7 +134,7 @@ in port = mkOption { default = 80; - type = types.int; + type = types.port; description = '' TCP port number for lighttpd to bind to. ''; diff --git a/nixos/modules/services/web-servers/minio.nix b/nixos/modules/services/web-servers/minio.nix index 381a55faff1..d075449012f 100644 --- a/nixos/modules/services/web-servers/minio.nix +++ b/nixos/modules/services/web-servers/minio.nix @@ -4,6 +4,11 @@ with lib; let cfg = config.services.minio; + + legacyCredentials = cfg: pkgs.writeText "minio-legacy-credentials" '' + MINIO_ROOT_USER=${cfg.accessKey} + MINIO_ROOT_PASSWORD=${cfg.secretKey} + ''; in { meta.maintainers = [ maintainers.bachp ]; @@ -49,6 +54,17 @@ in ''; }; + rootCredentialsFile = mkOption { + type = types.nullOr types.path; + default = null; + description = '' + File containing the MINIO_ROOT_USER, default is "minioadmin", and + MINIO_ROOT_PASSWORD (length >= 8), default is "minioadmin"; in the format of + an EnvironmentFile=, as described by systemd.exec(5). + ''; + example = "/etc/nixos/minio-root-credentials"; + }; + region = mkOption { default = "us-east-1"; type = types.str; @@ -72,6 +88,8 @@ in }; config = mkIf cfg.enable { + warnings = optional ((cfg.accessKey != "") || (cfg.secretKey != "")) "services.minio.`accessKey` and services.minio.`secretKey` are deprecated, please use services.minio.`rootCredentialsFile` instead."; + systemd.tmpfiles.rules = [ "d '${cfg.configDir}' - minio minio - -" ] ++ (map (x: "d '" + x + "' - minio minio - - ") cfg.dataDir); @@ -86,14 +104,13 @@ in User = "minio"; Group = "minio"; LimitNOFILE = 65536; + EnvironmentFile = if (cfg.rootCredentialsFile != null) then cfg.rootCredentialsFile + else if ((cfg.accessKey != "") || (cfg.secretKey != "")) then (legacyCredentials cfg) + else null; }; environment = { MINIO_REGION = "${cfg.region}"; MINIO_BROWSER = "${if cfg.browser then "on" else "off"}"; - } // optionalAttrs (cfg.accessKey != "") { - MINIO_ACCESS_KEY = "${cfg.accessKey}"; - } // optionalAttrs (cfg.secretKey != "") { - MINIO_SECRET_KEY = "${cfg.secretKey}"; }; }; diff --git a/nixos/modules/services/web-servers/nginx/vhost-options.nix b/nixos/modules/services/web-servers/nginx/vhost-options.nix index 1c7d4024479..bc18bcaa7b3 100644 --- a/nixos/modules/services/web-servers/nginx/vhost-options.nix +++ b/nixos/modules/services/web-servers/nginx/vhost-options.nix @@ -169,7 +169,7 @@ with lib; description = '' Whether to enable HTTP 3. This requires using <literal>pkgs.nginxQuic</literal> package - which can be achived by setting <literal>services.nginx.package = pkgs.nginxQuic;</literal>. + which can be achieved by setting <literal>services.nginx.package = pkgs.nginxQuic;</literal>. Note that HTTP 3 support is experimental and *not* yet recommended for production. Read more at https://quic.nginx.org/ diff --git a/nixos/modules/services/web-servers/ttyd.nix b/nixos/modules/services/web-servers/ttyd.nix index 01a01d97a23..68d55ee6ffd 100644 --- a/nixos/modules/services/web-servers/ttyd.nix +++ b/nixos/modules/services/web-servers/ttyd.nix @@ -33,7 +33,7 @@ in enable = mkEnableOption "ttyd daemon"; port = mkOption { - type = types.int; + type = types.port; default = 7681; description = "Port to listen on (use 0 for random port)"; }; diff --git a/nixos/modules/services/x11/desktop-managers/cinnamon.nix b/nixos/modules/services/x11/desktop-managers/cinnamon.nix index 101c64c7b3e..d201c1a5334 100644 --- a/nixos/modules/services/x11/desktop-managers/cinnamon.nix +++ b/nixos/modules/services/x11/desktop-managers/cinnamon.nix @@ -198,6 +198,7 @@ in environment.systemPackages = (with pkgs // pkgs.gnome // pkgs.cinnamon; pkgs.gnome.removePackagesByName [ # cinnamon team apps + bulky blueberry warpinator diff --git a/nixos/modules/services/x11/desktop-managers/gnome.nix b/nixos/modules/services/x11/desktop-managers/gnome.nix index bacada9cbe7..b0859321a52 100644 --- a/nixos/modules/services/x11/desktop-managers/gnome.nix +++ b/nixos/modules/services/x11/desktop-managers/gnome.nix @@ -56,6 +56,12 @@ let ''; flashbackEnabled = cfg.flashback.enableMetacity || length cfg.flashback.customSessions > 0; + flashbackWms = optional cfg.flashback.enableMetacity { + wmName = "metacity"; + wmLabel = "Metacity"; + wmCommand = "${pkgs.gnome.metacity}/bin/metacity"; + enableGnomePanel = true; + } ++ cfg.flashback.customSessions; notExcluded = pkg: mkDefault (!(lib.elem pkg config.environment.gnome.excludePackages)); @@ -174,7 +180,7 @@ in enable = mkOption { type = types.bool; default = false; - description = "Enable Gnome 3 desktop manager."; + description = "Enable GNOME desktop manager."; }; sessionPath = mkOption { @@ -222,14 +228,14 @@ in type = types.listOf (types.submodule { options = { wmName = mkOption { - type = types.str; - description = "The filename-compatible name of the window manager to use."; + type = types.strMatching "[a-zA-Z0-9_-]+"; + description = "A unique identifier for the window manager."; example = "xmonad"; }; wmLabel = mkOption { type = types.str; - description = "The pretty name of the window manager to use."; + description = "The name of the window manager to show in the session chooser."; example = "XMonad"; }; @@ -238,11 +244,29 @@ in description = "The executable of the window manager to use."; example = "\${pkgs.haskellPackages.xmonad}/bin/xmonad"; }; + + enableGnomePanel = mkOption { + type = types.bool; + default = true; + example = "false"; + description = "Whether to enable the GNOME panel in this session."; + }; }; }); default = []; description = "Other GNOME Flashback sessions to enable."; }; + + panelModulePackages = mkOption { + default = [ pkgs.gnome.gnome-applets ]; + type = types.listOf types.path; + description = '' + Packages containing modules that should be made available to <literal>gnome-panel</literal> (usually for applets). + + If you're packaging something to use here, please install the modules in <literal>$out/lib/gnome-panel/modules</literal>. + ''; + example = literalExample "[ pkgs.gnome.gnome-applets ]"; + }; }; }; @@ -259,7 +283,7 @@ in (mkIf (cfg.enable || flashbackEnabled) { # Seed our configuration into nixos-generate-config system.nixos-generate-config.desktopConfiguration = ['' - # Enable the GNOME 3 Desktop Environment. + # Enable the GNOME Desktop Environment. services.xserver.displayManager.gdm.enable = true; services.xserver.desktopManager.gnome.enable = true; '']; @@ -295,14 +319,19 @@ in }) (mkIf flashbackEnabled { - services.xserver.displayManager.sessionPackages = map - (wm: pkgs.gnome.gnome-flashback.mkSessionForWm { - inherit (wm) wmName wmLabel wmCommand; - }) (optional cfg.flashback.enableMetacity { - wmName = "metacity"; - wmLabel = "Metacity"; - wmCommand = "${pkgs.gnome.metacity}/bin/metacity"; - } ++ cfg.flashback.customSessions); + services.xserver.displayManager.sessionPackages = + let + wmNames = map (wm: wm.wmName) flashbackWms; + namesAreUnique = lib.unique wmNames == wmNames; + in + assert (assertMsg namesAreUnique "Flashback WM names must be unique."); + map + (wm: + pkgs.gnome.gnome-flashback.mkSessionForWm { + inherit (wm) wmName wmLabel wmCommand enableGnomePanel; + inherit (cfg.flashback) panelModulePackages; + } + ) flashbackWms; security.pam.services.gnome-flashback = { enableGnomeKeyring = true; @@ -310,15 +339,12 @@ in systemd.packages = with pkgs.gnome; [ gnome-flashback - ] ++ (map - (wm: gnome-flashback.mkSystemdTargetForWm { - inherit (wm) wmName; - }) cfg.flashback.customSessions); - - # gnome-panel needs these for menu applet - environment.sessionVariables.XDG_DATA_DIRS = [ "${pkgs.gnome.gnome-flashback}/share" ]; - # TODO: switch to sessionVariables (resolve conflict) - environment.variables.XDG_CONFIG_DIRS = [ "${pkgs.gnome.gnome-flashback}/etc/xdg" ]; + ] ++ map gnome-flashback.mkSystemdTargetForWm flashbackWms; + + # gnome-panel needs these for menu applet + environment.sessionVariables.XDG_DATA_DIRS = [ "${pkgs.gnome.gnome-flashback}/share" ]; + # TODO: switch to sessionVariables (resolve conflict) + environment.variables.XDG_CONFIG_DIRS = [ "${pkgs.gnome.gnome-flashback}/etc/xdg" ]; }) (mkIf serviceCfg.core-os-services.enable { diff --git a/nixos/modules/services/x11/desktop-managers/gnome.xml b/nixos/modules/services/x11/desktop-managers/gnome.xml index 624d5c894e7..6c53bacacb3 100644 --- a/nixos/modules/services/x11/desktop-managers/gnome.xml +++ b/nixos/modules/services/x11/desktop-managers/gnome.xml @@ -120,6 +120,7 @@ wmName = "xmonad"; wmLabel = "XMonad"; wmCommand = "${pkgs.haskellPackages.xmonad}/bin/xmonad"; + enableGnomePanel = false; } ]; </programlisting> diff --git a/nixos/modules/services/x11/display-managers/gdm.nix b/nixos/modules/services/x11/display-managers/gdm.nix index e1b9a21eb9f..ef9ec438cc1 100644 --- a/nixos/modules/services/x11/display-managers/gdm.nix +++ b/nixos/modules/services/x11/display-managers/gdm.nix @@ -99,7 +99,8 @@ in autoSuspend = mkOption { default = true; description = '' - Suspend the machine after inactivity. + On the GNOME Display Manager login screen, suspend the machine after inactivity. + (Does not affect automatic suspend while logged in, or at lock screen.) ''; type = types.bool; }; diff --git a/nixos/modules/services/x11/hardware/libinput.nix b/nixos/modules/services/x11/hardware/libinput.nix index 9b0757153cc..439708bc47e 100644 --- a/nixos/modules/services/x11/hardware/libinput.nix +++ b/nixos/modules/services/x11/hardware/libinput.nix @@ -188,27 +188,27 @@ let cfg = config.services.xserver.libinput; }; mkX11ConfigForDevice = deviceType: matchIs: '' - Identifier "libinput ${deviceType} configuration" - MatchDriver "libinput" - MatchIs${matchIs} "${xorgBool true}" - ${optionalString (cfg.${deviceType}.dev != null) ''MatchDevicePath "${cfg.${deviceType}.dev}"''} - Option "AccelProfile" "${cfg.${deviceType}.accelProfile}" - ${optionalString (cfg.${deviceType}.accelSpeed != null) ''Option "AccelSpeed" "${cfg.${deviceType}.accelSpeed}"''} - ${optionalString (cfg.${deviceType}.buttonMapping != null) ''Option "ButtonMapping" "${cfg.${deviceType}.buttonMapping}"''} - ${optionalString (cfg.${deviceType}.calibrationMatrix != null) ''Option "CalibrationMatrix" "${cfg.${deviceType}.calibrationMatrix}"''} - ${optionalString (cfg.${deviceType}.clickMethod != null) ''Option "ClickMethod" "${cfg.${deviceType}.clickMethod}"''} - Option "LeftHanded" "${xorgBool cfg.${deviceType}.leftHanded}" - Option "MiddleEmulation" "${xorgBool cfg.${deviceType}.middleEmulation}" - Option "NaturalScrolling" "${xorgBool cfg.${deviceType}.naturalScrolling}" - ${optionalString (cfg.${deviceType}.scrollButton != null) ''Option "ScrollButton" "${toString cfg.${deviceType}.scrollButton}"''} - Option "ScrollMethod" "${cfg.${deviceType}.scrollMethod}" - Option "HorizontalScrolling" "${xorgBool cfg.${deviceType}.horizontalScrolling}" - Option "SendEventsMode" "${cfg.${deviceType}.sendEventsMode}" - Option "Tapping" "${xorgBool cfg.${deviceType}.tapping}" - Option "TappingDragLock" "${xorgBool cfg.${deviceType}.tappingDragLock}" - Option "DisableWhileTyping" "${xorgBool cfg.${deviceType}.disableWhileTyping}" - ${cfg.${deviceType}.additionalOptions} - ''; + Identifier "libinput ${deviceType} configuration" + MatchDriver "libinput" + MatchIs${matchIs} "${xorgBool true}" + ${optionalString (cfg.${deviceType}.dev != null) ''MatchDevicePath "${cfg.${deviceType}.dev}"''} + Option "AccelProfile" "${cfg.${deviceType}.accelProfile}" + ${optionalString (cfg.${deviceType}.accelSpeed != null) ''Option "AccelSpeed" "${cfg.${deviceType}.accelSpeed}"''} + ${optionalString (cfg.${deviceType}.buttonMapping != null) ''Option "ButtonMapping" "${cfg.${deviceType}.buttonMapping}"''} + ${optionalString (cfg.${deviceType}.calibrationMatrix != null) ''Option "CalibrationMatrix" "${cfg.${deviceType}.calibrationMatrix}"''} + ${optionalString (cfg.${deviceType}.clickMethod != null) ''Option "ClickMethod" "${cfg.${deviceType}.clickMethod}"''} + Option "LeftHanded" "${xorgBool cfg.${deviceType}.leftHanded}" + Option "MiddleEmulation" "${xorgBool cfg.${deviceType}.middleEmulation}" + Option "NaturalScrolling" "${xorgBool cfg.${deviceType}.naturalScrolling}" + ${optionalString (cfg.${deviceType}.scrollButton != null) ''Option "ScrollButton" "${toString cfg.${deviceType}.scrollButton}"''} + Option "ScrollMethod" "${cfg.${deviceType}.scrollMethod}" + Option "HorizontalScrolling" "${xorgBool cfg.${deviceType}.horizontalScrolling}" + Option "SendEventsMode" "${cfg.${deviceType}.sendEventsMode}" + Option "Tapping" "${xorgBool cfg.${deviceType}.tapping}" + Option "TappingDragLock" "${xorgBool cfg.${deviceType}.tappingDragLock}" + Option "DisableWhileTyping" "${xorgBool cfg.${deviceType}.disableWhileTyping}" + ${cfg.${deviceType}.additionalOptions} + ''; in { imports = diff --git a/nixos/modules/services/x11/window-managers/fvwm.nix b/nixos/modules/services/x11/window-managers/fvwm.nix index 9a51b9cd660..e283886ecc4 100644 --- a/nixos/modules/services/x11/window-managers/fvwm.nix +++ b/nixos/modules/services/x11/window-managers/fvwm.nix @@ -4,7 +4,7 @@ with lib; let cfg = config.services.xserver.windowManager.fvwm; - fvwm = pkgs.fvwm.override { gestures = cfg.gestures; }; + fvwm = pkgs.fvwm.override { enableGestures = cfg.gestures; }; in { diff --git a/nixos/modules/services/x11/xserver.nix b/nixos/modules/services/x11/xserver.nix index 4dde4476d2c..37e004ae80a 100644 --- a/nixos/modules/services/x11/xserver.nix +++ b/nixos/modules/services/x11/xserver.nix @@ -81,13 +81,7 @@ let monitors = forEach xrandrHeads (h: '' Option "monitor-${h.config.output}" "${h.name}" ''); - # First option is indented through the space in the config but any - # subsequent options aren't so we need to apply indentation to - # them here - monitorsIndented = if length monitors > 1 - then singleton (head monitors) ++ map (m: " " + m) (tail monitors) - else monitors; - in concatStrings monitorsIndented; + in concatStrings monitors; # Here we chain every monitor from the left to right, so we have: # m4 right of m3 right of m2 right of m1 .----.----.----.----. @@ -138,10 +132,15 @@ let echo '${cfg.filesSection}' >> $out echo 'EndSection' >> $out + echo >> $out echo "$config" >> $out ''; # */ + prefixStringLines = prefix: str: + concatMapStringsSep "\n" (line: prefix + line) (splitString "\n" str); + + indent = prefixStringLines " "; in { @@ -358,6 +357,13 @@ in description = '' The contents of the configuration file of the X server (<filename>xorg.conf</filename>). + + This option is set by multiple modules, and the configs are + concatenated together. + + In Xorg configs the last config entries take precedence, + so you may want to use <literal>lib.mkAfter</literal> on this option + to override NixOS's defaults. ''; }; @@ -736,29 +742,29 @@ in Section "ServerFlags" Option "AllowMouseOpenFail" "on" Option "DontZap" "${if cfg.enableCtrlAltBackspace then "off" else "on"}" - ${cfg.serverFlagsSection} + ${indent cfg.serverFlagsSection} EndSection Section "Module" - ${cfg.moduleSection} + ${indent cfg.moduleSection} EndSection Section "Monitor" Identifier "Monitor[0]" - ${cfg.monitorSection} + ${indent cfg.monitorSection} EndSection # Additional "InputClass" sections - ${flip concatMapStrings cfg.inputClassSections (inputClassSection: '' - Section "InputClass" - ${inputClassSection} - EndSection + ${flip (concatMapStringsSep "\n") cfg.inputClassSections (inputClassSection: '' + Section "InputClass" + ${indent inputClassSection} + EndSection '')} Section "ServerLayout" Identifier "Layout[all]" - ${cfg.serverLayoutSection} + ${indent cfg.serverLayoutSection} # Reference the Screen sections for each driver. This will # cause the X server to try each in turn. ${flip concatMapStrings (filter (d: d.display) cfg.drivers) (d: '' @@ -781,9 +787,9 @@ in Identifier "Device-${driver.name}[0]" Driver "${driver.driverName or driver.name}" ${if cfg.useGlamor then ''Option "AccelMethod" "glamor"'' else ""} - ${cfg.deviceSection} - ${driver.deviceSection or ""} - ${xrandrDeviceSection} + ${indent cfg.deviceSection} + ${indent (driver.deviceSection or "")} + ${indent xrandrDeviceSection} EndSection ${optionalString driver.display '' @@ -794,18 +800,22 @@ in Monitor "Monitor[0]" ''} - ${cfg.screenSection} - ${driver.screenSection or ""} + ${indent cfg.screenSection} + ${indent (driver.screenSection or "")} ${optionalString (cfg.defaultDepth != 0) '' DefaultDepth ${toString cfg.defaultDepth} ''} ${optionalString - (driver.name != "virtualbox" && + ( + driver.name != "virtualbox" + && (cfg.resolutions != [] || cfg.extraDisplaySettings != "" || - cfg.virtualScreen != null)) + cfg.virtualScreen != null + ) + ) (let f = depth: '' @@ -813,7 +823,7 @@ in Depth ${toString depth} ${optionalString (cfg.resolutions != []) "Modes ${concatMapStrings (res: ''"${toString res.x}x${toString res.y}"'') cfg.resolutions}"} - ${cfg.extraDisplaySettings} + ${indent cfg.extraDisplaySettings} ${optionalString (cfg.virtualScreen != null) "Virtual ${toString cfg.virtualScreen.x} ${toString cfg.virtualScreen.y}"} EndSubSection diff --git a/nixos/modules/system/activation/top-level.nix b/nixos/modules/system/activation/top-level.nix index 6751ca3f2ee..4e2f25cd27f 100644 --- a/nixos/modules/system/activation/top-level.nix +++ b/nixos/modules/system/activation/top-level.nix @@ -13,7 +13,7 @@ let # !!! fix this children = mapAttrs (childName: childConfig: (import ../../../lib/eval-config.nix { - inherit baseModules specialArgs; + inherit lib baseModules specialArgs; system = config.nixpkgs.initialSystem; modules = (optionals childConfig.inheritParentConfig modules) diff --git a/nixos/modules/system/boot/kernel.nix b/nixos/modules/system/boot/kernel.nix index 363d8e47a0f..1a6a9d99d5b 100644 --- a/nixos/modules/system/boot/kernel.nix +++ b/nixos/modules/system/boot/kernel.nix @@ -38,11 +38,11 @@ in default = pkgs.linuxPackages; type = types.unspecified // { merge = mergeEqualOption; }; apply = kernelPackages: kernelPackages.extend (self: super: { - kernel = super.kernel.override { + kernel = super.kernel.override (originalArgs: { inherit randstructSeed; - kernelPatches = super.kernel.kernelPatches ++ kernelPatches; + kernelPatches = (originalArgs.kernelPatches or []) ++ kernelPatches; features = lib.recursiveUpdate super.kernel.features features; - }; + }); }); # We don't want to evaluate all of linuxPackages for the manual # - some of it might not even evaluate correctly. diff --git a/nixos/modules/system/boot/loader/systemd-boot/systemd-boot-builder.py b/nixos/modules/system/boot/loader/systemd-boot/systemd-boot-builder.py index 63e01dd054a..7134b432163 100644 --- a/nixos/modules/system/boot/loader/systemd-boot/systemd-boot-builder.py +++ b/nixos/modules/system/boot/loader/systemd-boot/systemd-boot-builder.py @@ -61,7 +61,7 @@ def write_loader_conf(profile: Optional[str], generation: int) -> None: def profile_path(profile: Optional[str], generation: int, name: str) -> str: - return os.readlink("%s/%s" % (system_dir(profile, generation), name)) + return os.path.realpath("%s/%s" % (system_dir(profile, generation), name)) def copy_from_profile(profile: Optional[str], generation: int, name: str, dry_run: bool = False) -> str: diff --git a/nixos/modules/system/boot/luksroot.nix b/nixos/modules/system/boot/luksroot.nix index fa14d86e253..f87d3b07a36 100644 --- a/nixos/modules/system/boot/luksroot.nix +++ b/nixos/modules/system/boot/luksroot.nix @@ -140,24 +140,27 @@ let umount /crypt-ramfs 2>/dev/null ''; - openCommand = name': { name, device, header, keyFile, keyFileSize, keyFileOffset, allowDiscards, yubikey, gpgCard, fido2, fallbackToPassword, preOpenCommands, postOpenCommands,... }: assert name' == name; + openCommand = name: dev: assert name == dev.name; let - csopen = "cryptsetup luksOpen ${device} ${name} ${optionalString allowDiscards "--allow-discards"} ${optionalString (header != null) "--header=${header}"}"; - cschange = "cryptsetup luksChangeKey ${device} ${optionalString (header != null) "--header=${header}"}"; + csopen = "cryptsetup luksOpen ${dev.device} ${dev.name}" + + optionalString dev.allowDiscards " --allow-discards" + + optionalString dev.bypassWorkqueues " --perf-no_read_workqueue --perf-no_write_workqueue" + + optionalString (dev.header != null) " --header=${dev.header}"; + cschange = "cryptsetup luksChangeKey ${dev.device} ${optionalString (dev.header != null) "--header=${dev.header}"}"; in '' # Wait for luksRoot (and optionally keyFile and/or header) to appear, e.g. # if on a USB drive. - wait_target "device" ${device} || die "${device} is unavailable" + wait_target "device" ${dev.device} || die "${dev.device} is unavailable" - ${optionalString (header != null) '' - wait_target "header" ${header} || die "${header} is unavailable" + ${optionalString (dev.header != null) '' + wait_target "header" ${dev.header} || die "${dev.header} is unavailable" ''} do_open_passphrase() { local passphrase while true; do - echo -n "Passphrase for ${device}: " + echo -n "Passphrase for ${dev.device}: " passphrase= while true; do if [ -e /crypt-ramfs/passphrase ]; then @@ -166,7 +169,7 @@ let break else # ask cryptsetup-askpass - echo -n "${device}" > /crypt-ramfs/device + echo -n "${dev.device}" > /crypt-ramfs/device # and try reading it from /dev/console with a timeout IFS= read -t 1 -r passphrase @@ -182,7 +185,7 @@ let fi fi done - echo -n "Verifying passphrase for ${device}..." + echo -n "Verifying passphrase for ${dev.device}..." echo -n "$passphrase" | ${csopen} --key-file=- if [ $? == 0 ]; then echo " - success" @@ -202,13 +205,13 @@ let # LUKS open_normally() { - ${if (keyFile != null) then '' - if wait_target "key file" ${keyFile}; then - ${csopen} --key-file=${keyFile} \ - ${optionalString (keyFileSize != null) "--keyfile-size=${toString keyFileSize}"} \ - ${optionalString (keyFileOffset != null) "--keyfile-offset=${toString keyFileOffset}"} + ${if (dev.keyFile != null) then '' + if wait_target "key file" ${dev.keyFile}; then + ${csopen} --key-file=${dev.keyFile} \ + ${optionalString (dev.keyFileSize != null) "--keyfile-size=${toString dev.keyFileSize}"} \ + ${optionalString (dev.keyFileOffset != null) "--keyfile-offset=${toString dev.keyFileOffset}"} else - ${if fallbackToPassword then "echo" else "die"} "${keyFile} is unavailable" + ${if dev.fallbackToPassword then "echo" else "die"} "${dev.keyFile} is unavailable" echo " - failing back to interactive password prompt" do_open_passphrase fi @@ -217,7 +220,7 @@ let ''} } - ${optionalString (luks.yubikeySupport && (yubikey != null)) '' + ${optionalString (luks.yubikeySupport && (dev.yubikey != null)) '' # YubiKey rbtohex() { ( od -An -vtx1 | tr -d ' \n' ) @@ -243,16 +246,16 @@ let local new_response local new_k_luks - mount -t ${yubikey.storage.fsType} ${yubikey.storage.device} /crypt-storage || \ + mount -t ${dev.yubikey.storage.fsType} ${dev.yubikey.storage.device} /crypt-storage || \ die "Failed to mount YubiKey salt storage device" - salt="$(cat /crypt-storage${yubikey.storage.path} | sed -n 1p | tr -d '\n')" - iterations="$(cat /crypt-storage${yubikey.storage.path} | sed -n 2p | tr -d '\n')" + salt="$(cat /crypt-storage${dev.yubikey.storage.path} | sed -n 1p | tr -d '\n')" + iterations="$(cat /crypt-storage${dev.yubikey.storage.path} | sed -n 2p | tr -d '\n')" challenge="$(echo -n $salt | openssl-wrap dgst -binary -sha512 | rbtohex)" - response="$(ykchalresp -${toString yubikey.slot} -x $challenge 2>/dev/null)" + response="$(ykchalresp -${toString dev.yubikey.slot} -x $challenge 2>/dev/null)" for try in $(seq 3); do - ${optionalString yubikey.twoFactor '' + ${optionalString dev.yubikey.twoFactor '' echo -n "Enter two-factor passphrase: " k_user= while true; do @@ -278,9 +281,9 @@ let ''} if [ ! -z "$k_user" ]; then - k_luks="$(echo -n $k_user | pbkdf2-sha512 ${toString yubikey.keyLength} $iterations $response | rbtohex)" + k_luks="$(echo -n $k_user | pbkdf2-sha512 ${toString dev.yubikey.keyLength} $iterations $response | rbtohex)" else - k_luks="$(echo | pbkdf2-sha512 ${toString yubikey.keyLength} $iterations $response | rbtohex)" + k_luks="$(echo | pbkdf2-sha512 ${toString dev.yubikey.keyLength} $iterations $response | rbtohex)" fi echo -n "$k_luks" | hextorb | ${csopen} --key-file=- @@ -302,7 +305,7 @@ let [ "$opened" == false ] && die "Maximum authentication errors reached" echo -n "Gathering entropy for new salt (please enter random keys to generate entropy if this blocks for long)..." - for i in $(seq ${toString yubikey.saltLength}); do + for i in $(seq ${toString dev.yubikey.saltLength}); do byte="$(dd if=/dev/random bs=1 count=1 2>/dev/null | rbtohex)"; new_salt="$new_salt$byte"; echo -n . @@ -310,25 +313,25 @@ let echo "ok" new_iterations="$iterations" - ${optionalString (yubikey.iterationStep > 0) '' - new_iterations="$(($new_iterations + ${toString yubikey.iterationStep}))" + ${optionalString (dev.yubikey.iterationStep > 0) '' + new_iterations="$(($new_iterations + ${toString dev.yubikey.iterationStep}))" ''} new_challenge="$(echo -n $new_salt | openssl-wrap dgst -binary -sha512 | rbtohex)" - new_response="$(ykchalresp -${toString yubikey.slot} -x $new_challenge 2>/dev/null)" + new_response="$(ykchalresp -${toString dev.yubikey.slot} -x $new_challenge 2>/dev/null)" if [ ! -z "$k_user" ]; then - new_k_luks="$(echo -n $k_user | pbkdf2-sha512 ${toString yubikey.keyLength} $new_iterations $new_response | rbtohex)" + new_k_luks="$(echo -n $k_user | pbkdf2-sha512 ${toString dev.yubikey.keyLength} $new_iterations $new_response | rbtohex)" else - new_k_luks="$(echo | pbkdf2-sha512 ${toString yubikey.keyLength} $new_iterations $new_response | rbtohex)" + new_k_luks="$(echo | pbkdf2-sha512 ${toString dev.yubikey.keyLength} $new_iterations $new_response | rbtohex)" fi echo -n "$new_k_luks" | hextorb > /crypt-ramfs/new_key echo -n "$k_luks" | hextorb | ${cschange} --key-file=- /crypt-ramfs/new_key if [ $? == 0 ]; then - echo -ne "$new_salt\n$new_iterations" > /crypt-storage${yubikey.storage.path} + echo -ne "$new_salt\n$new_iterations" > /crypt-storage${dev.yubikey.storage.path} else echo "Warning: Could not update LUKS key, current challenge persists!" fi @@ -338,7 +341,7 @@ let } open_with_hardware() { - if wait_yubikey ${toString yubikey.gracePeriod}; then + if wait_yubikey ${toString dev.yubikey.gracePeriod}; then do_open_yubikey else echo "No YubiKey found, falling back to non-YubiKey open procedure" @@ -347,7 +350,7 @@ let } ''} - ${optionalString (luks.gpgSupport && (gpgCard != null)) '' + ${optionalString (luks.gpgSupport && (dev.gpgCard != null)) '' do_open_gpg_card() { # Make all of these local to this function @@ -355,12 +358,12 @@ let local pin local opened - gpg --import /gpg-keys/${device}/pubkey.asc > /dev/null 2> /dev/null + gpg --import /gpg-keys/${dev.device}/pubkey.asc > /dev/null 2> /dev/null gpg --card-status > /dev/null 2> /dev/null for try in $(seq 3); do - echo -n "PIN for GPG Card associated with device ${device}: " + echo -n "PIN for GPG Card associated with device ${dev.device}: " pin= while true; do if [ -e /crypt-ramfs/passphrase ]; then @@ -382,8 +385,8 @@ let fi fi done - echo -n "Verifying passphrase for ${device}..." - echo -n "$pin" | gpg -q --batch --passphrase-fd 0 --pinentry-mode loopback -d /gpg-keys/${device}/cryptkey.gpg 2> /dev/null | ${csopen} --key-file=- > /dev/null 2> /dev/null + echo -n "Verifying passphrase for ${dev.device}..." + echo -n "$pin" | gpg -q --batch --passphrase-fd 0 --pinentry-mode loopback -d /gpg-keys/${dev.device}/cryptkey.gpg 2> /dev/null | ${csopen} --key-file=- > /dev/null 2> /dev/null if [ $? == 0 ]; then echo " - success" ${if luks.reusePassphrases then '' @@ -403,7 +406,7 @@ let } open_with_hardware() { - if wait_gpgcard ${toString gpgCard.gracePeriod}; then + if wait_gpgcard ${toString dev.gpgCard.gracePeriod}; then do_open_gpg_card else echo "No GPG Card found, falling back to normal open procedure" @@ -412,15 +415,15 @@ let } ''} - ${optionalString (luks.fido2Support && (fido2.credential != null)) '' + ${optionalString (luks.fido2Support && (dev.fido2.credential != null)) '' open_with_hardware() { local passsphrase - ${if fido2.passwordLess then '' + ${if dev.fido2.passwordLess then '' export passphrase="" '' else '' - read -rsp "FIDO2 salt for ${device}: " passphrase + read -rsp "FIDO2 salt for ${dev.device}: " passphrase echo ''} ${optionalString (lib.versionOlder kernelPackages.kernel.version "5.4") '' @@ -428,7 +431,7 @@ let echo "Please move your mouse to create needed randomness." ''} echo "Waiting for your FIDO2 device..." - fido2luks open ${device} ${name} ${fido2.credential} --await-dev ${toString fido2.gracePeriod} --salt string:$passphrase + fido2luks open ${dev.device} ${dev.name} ${dev.fido2.credential} --await-dev ${toString dev.fido2.gracePeriod} --salt string:$passphrase if [ $? -ne 0 ]; then echo "No FIDO2 key found, falling back to normal open procedure" open_normally @@ -437,16 +440,16 @@ let ''} # commands to run right before we mount our device - ${preOpenCommands} + ${dev.preOpenCommands} - ${if (luks.yubikeySupport && (yubikey != null)) || (luks.gpgSupport && (gpgCard != null)) || (luks.fido2Support && (fido2.credential != null)) then '' + ${if (luks.yubikeySupport && (dev.yubikey != null)) || (luks.gpgSupport && (dev.gpgCard != null)) || (luks.fido2Support && (dev.fido2.credential != null)) then '' open_with_hardware '' else '' open_normally ''} # commands to run right after we mounted our device - ${postOpenCommands} + ${dev.postOpenCommands} ''; askPass = pkgs.writeScriptBin "cryptsetup-askpass" '' @@ -618,6 +621,19 @@ in Whether to allow TRIM requests to the underlying device. This option has security implications; please read the LUKS documentation before activating it. + This option is incompatible with authenticated encryption (dm-crypt + stacked over dm-integrity). + ''; + }; + + bypassWorkqueues = mkOption { + default = false; + type = types.bool; + description = '' + Whether to bypass dm-crypt's internal read and write workqueues. + Enabling this should improve performance on SSDs; see + <link xlink:href="https://wiki.archlinux.org/index.php/Dm-crypt/Specialties#Disable_workqueue_for_increased_solid_state_drive_(SSD)_performance">here</link> + for more information. Needs Linux 5.9 or later. ''; }; @@ -833,6 +849,11 @@ in { assertion = !(luks.fido2Support && luks.yubikeySupport); message = "FIDO2 and YubiKey may not be used at the same time."; } + + { assertion = any (dev: dev.bypassWorkqueues) (attrValues luks.devices) + -> versionAtLeast kernelPackages.kernel.version "5.9"; + message = "boot.initrd.luks.devices.<name>.bypassWorkqueues is not supported for kernels older than 5.9"; + } ]; # actually, sbp2 driver is the one enabling the DMA attack, but this needs to be tested diff --git a/nixos/modules/system/boot/resolved.nix b/nixos/modules/system/boot/resolved.nix index 84bc9b78076..a6fc07da0ab 100644 --- a/nixos/modules/system/boot/resolved.nix +++ b/nixos/modules/system/boot/resolved.nix @@ -140,7 +140,8 @@ in # add resolve to nss hosts database if enabled and nscd enabled # system.nssModules is configured in nixos/modules/system/boot/systemd.nix - system.nssDatabases.hosts = optional config.services.nscd.enable "resolve [!UNAVAIL=return]"; + # added with order 501 to allow modules to go before with mkBefore + system.nssDatabases.hosts = (mkOrder 501 ["resolve [!UNAVAIL=return]"]); systemd.additionalUpstreamSystemUnits = [ "systemd-resolved.service" diff --git a/nixos/modules/system/boot/systemd.nix b/nixos/modules/system/boot/systemd.nix index 6be7b7e6846..58064e5de86 100644 --- a/nixos/modules/system/boot/systemd.nix +++ b/nixos/modules/system/boot/systemd.nix @@ -755,7 +755,7 @@ in default = []; example = [ "d /tmp 1777 root root 10d" ]; description = '' - Rules for creating and cleaning up temporary files + Rules for creation, deletion and cleaning of volatile and temporary files automatically. See <citerefentry><refentrytitle>tmpfiles.d</refentrytitle><manvolnum>5</manvolnum></citerefentry> for the exact format. @@ -925,9 +925,8 @@ in system.nssModules = [ systemd.out ]; system.nssDatabases = { hosts = (mkMerge [ - [ "mymachines" ] - (mkOrder 1600 [ "myhostname" ] # 1600 to ensure it's always the last - ) + (mkOrder 400 ["mymachines"]) # 400 to ensure it comes before resolve (which is mkBefore'd) + (mkOrder 999 ["myhostname"]) # after files (which is 998), but before regular nss modules ]); passwd = (mkMerge [ (mkAfter [ "systemd" ]) diff --git a/nixos/modules/tasks/filesystems.nix b/nixos/modules/tasks/filesystems.nix index 49c9a37a900..d9f7ce5d2c3 100644 --- a/nixos/modules/tasks/filesystems.nix +++ b/nixos/modules/tasks/filesystems.nix @@ -24,13 +24,15 @@ let specialFSTypes = [ "proc" "sysfs" "tmpfs" "ramfs" "devtmpfs" "devpts" ]; + nonEmptyWithoutTrailingSlash = addCheckDesc "non-empty without trailing slash" types.str + (s: isNonEmpty s && (builtins.match ".+/" s) == null); + coreFileSystemOpts = { name, config, ... }: { options = { mountPoint = mkOption { example = "/mnt/usb"; - type = addCheckDesc "non-empty without trailing slash" types.str - (s: isNonEmpty s && (builtins.match ".+/" s) == null); + type = nonEmptyWithoutTrailingSlash; description = "Location of the mounted the file system."; }; @@ -55,6 +57,20 @@ let type = types.listOf nonEmptyStr; }; + depends = mkOption { + default = [ ]; + example = [ "/persist" ]; + type = types.listOf nonEmptyWithoutTrailingSlash; + description = '' + List of paths that should be mounted before this one. This filesystem's + <option>device</option> and <option>mountPoint</option> are always + checked and do not need to be included explicitly. If a path is added + to this list, any other filesystem whose mount point is a parent of + the path will be mounted before this filesystem. The paths do not need + to actually be the <option>mountPoint</option> of some other filesystem. + ''; + }; + }; config = { @@ -238,8 +254,11 @@ in skipCheck = fs: fs.noCheck || fs.device == "none" || builtins.elem fs.fsType fsToSkipCheck; # https://wiki.archlinux.org/index.php/fstab#Filepath_spaces escape = string: builtins.replaceStrings [ " " "\t" ] [ "\\040" "\\011" ] string; - swapOptions = sw: "defaults" - + optionalString (sw.priority != null) ",pri=${toString sw.priority}"; + swapOptions = sw: concatStringsSep "," ( + sw.options + ++ optional (sw.priority != null) "pri=${toString sw.priority}" + ++ optional (sw.discardPolicy != null) "discard${optionalString (sw.discardPolicy != "both") "=${toString sw.discardPolicy}"}" + ); in '' # This is a generated file. Do not edit! # diff --git a/nixos/modules/tasks/filesystems/btrfs.nix b/nixos/modules/tasks/filesystems/btrfs.nix index c0ff28039b1..ae1dab5b8d8 100644 --- a/nixos/modules/tasks/filesystems/btrfs.nix +++ b/nixos/modules/tasks/filesystems/btrfs.nix @@ -55,7 +55,16 @@ in (mkIf enableBtrfs { system.fsPackages = [ pkgs.btrfs-progs ]; - boot.initrd.kernelModules = mkIf inInitrd [ "btrfs" "crc32c" ]; + boot.initrd.kernelModules = mkIf inInitrd [ "btrfs" ]; + boot.initrd.availableKernelModules = mkIf inInitrd ( + [ "crc32c" ] + ++ optionals (config.boot.kernelPackages.kernel.kernelAtLeast "5.5") [ + # Needed for mounting filesystems with new checksums + "xxhash_generic" + "blake2b_generic" + "sha256_generic" # Should be baked into our kernel, just to be sure + ] + ); boot.initrd.extraUtilsCommands = mkIf inInitrd '' diff --git a/nixos/modules/tasks/snapraid.nix b/nixos/modules/tasks/snapraid.nix new file mode 100644 index 00000000000..4529009930f --- /dev/null +++ b/nixos/modules/tasks/snapraid.nix @@ -0,0 +1,230 @@ +{ config, lib, pkgs, ... }: + +with lib; + +let cfg = config.snapraid; +in +{ + options.snapraid = with types; { + enable = mkEnableOption "SnapRAID"; + dataDisks = mkOption { + default = { }; + example = { + d1 = "/mnt/disk1/"; + d2 = "/mnt/disk2/"; + d3 = "/mnt/disk3/"; + }; + description = "SnapRAID data disks."; + type = attrsOf str; + }; + parityFiles = mkOption { + default = [ ]; + example = [ + "/mnt/diskp/snapraid.parity" + "/mnt/diskq/snapraid.2-parity" + "/mnt/diskr/snapraid.3-parity" + "/mnt/disks/snapraid.4-parity" + "/mnt/diskt/snapraid.5-parity" + "/mnt/disku/snapraid.6-parity" + ]; + description = "SnapRAID parity files."; + type = listOf str; + }; + contentFiles = mkOption { + default = [ ]; + example = [ + "/var/snapraid.content" + "/mnt/disk1/snapraid.content" + "/mnt/disk2/snapraid.content" + ]; + description = "SnapRAID content list files."; + type = listOf str; + }; + exclude = mkOption { + default = [ ]; + example = [ "*.unrecoverable" "/tmp/" "/lost+found/" ]; + description = "SnapRAID exclude directives."; + type = listOf str; + }; + touchBeforeSync = mkOption { + default = true; + example = false; + description = + "Whether <command>snapraid touch</command> should be run before <command>snapraid sync</command>."; + type = bool; + }; + sync.interval = mkOption { + default = "01:00"; + example = "daily"; + description = "How often to run <command>snapraid sync</command>."; + type = str; + }; + scrub = { + interval = mkOption { + default = "Mon *-*-* 02:00:00"; + example = "weekly"; + description = "How often to run <command>snapraid scrub</command>."; + type = str; + }; + plan = mkOption { + default = 8; + example = 5; + description = + "Percent of the array that should be checked by <command>snapraid scrub</command>."; + type = int; + }; + olderThan = mkOption { + default = 10; + example = 20; + description = + "Number of days since data was last scrubbed before it can be scrubbed again."; + type = int; + }; + }; + extraConfig = mkOption { + default = ""; + example = '' + nohidden + blocksize 256 + hashsize 16 + autosave 500 + pool /pool + ''; + description = "Extra config options for SnapRAID."; + type = lines; + }; + }; + + config = + let + nParity = builtins.length cfg.parityFiles; + mkPrepend = pre: s: pre + s; + in + mkIf cfg.enable { + assertions = [ + { + assertion = nParity <= 6; + message = "You can have no more than six SnapRAID parity files."; + } + { + assertion = builtins.length cfg.contentFiles >= nParity + 1; + message = + "There must be at least one SnapRAID content file for each SnapRAID parity file plus one."; + } + ]; + + environment = { + systemPackages = with pkgs; [ snapraid ]; + + etc."snapraid.conf" = { + text = with cfg; + let + prependData = mkPrepend "data "; + prependContent = mkPrepend "content "; + prependExclude = mkPrepend "exclude "; + in + concatStringsSep "\n" + (map prependData + ((mapAttrsToList (name: value: name + " " + value)) dataDisks) + ++ zipListsWith (a: b: a + b) + ([ "parity " ] ++ map (i: toString i + "-parity ") (range 2 6)) + parityFiles ++ map prependContent contentFiles + ++ map prependExclude exclude) + "\n" + extraConfig; + }; + }; + + systemd.services = with cfg; { + snapraid-scrub = { + description = "Scrub the SnapRAID array"; + startAt = scrub.interval; + serviceConfig = { + Type = "oneshot"; + ExecStart = "${pkgs.snapraid}/bin/snapraid scrub -p ${ + toString scrub.plan + } -o ${toString scrub.olderThan}"; + Nice = 19; + IOSchedulingPriority = 7; + CPUSchedulingPolicy = "batch"; + + LockPersonality = true; + MemoryDenyWriteExecute = true; + NoNewPrivileges = true; + PrivateDevices = true; + PrivateTmp = true; + ProtectClock = true; + ProtectControlGroups = true; + ProtectHostname = true; + ProtectKernelLogs = true; + ProtectKernelModules = true; + ProtectKernelTunables = true; + RestrictAddressFamilies = "none"; + RestrictNamespaces = true; + RestrictRealtime = true; + RestrictSUIDSGID = true; + SystemCallArchitectures = "native"; + SystemCallFilter = "@system-service"; + SystemCallErrorNumber = "EPERM"; + CapabilityBoundingSet = "CAP_DAC_OVERRIDE"; + + ProtectSystem = "strict"; + ProtectHome = "read-only"; + ReadWritePaths = + # scrub requires access to directories containing content files + # to remove them if they are stale + let + contentDirs = map dirOf contentFiles; + in + unique ( + attrValues dataDisks ++ contentDirs + ); + }; + unitConfig.After = "snapraid-sync.service"; + }; + snapraid-sync = { + description = "Synchronize the state of the SnapRAID array"; + startAt = sync.interval; + serviceConfig = { + Type = "oneshot"; + ExecStart = "${pkgs.snapraid}/bin/snapraid sync"; + Nice = 19; + IOSchedulingPriority = 7; + CPUSchedulingPolicy = "batch"; + + LockPersonality = true; + MemoryDenyWriteExecute = true; + NoNewPrivileges = true; + PrivateDevices = true; + PrivateTmp = true; + ProtectClock = true; + ProtectControlGroups = true; + ProtectHostname = true; + ProtectKernelLogs = true; + ProtectKernelModules = true; + ProtectKernelTunables = true; + RestrictAddressFamilies = "none"; + RestrictNamespaces = true; + RestrictRealtime = true; + RestrictSUIDSGID = true; + SystemCallArchitectures = "native"; + SystemCallFilter = "@system-service"; + SystemCallErrorNumber = "EPERM"; + CapabilityBoundingSet = "CAP_DAC_OVERRIDE"; + + ProtectSystem = "strict"; + ProtectHome = "read-only"; + ReadWritePaths = + # sync requires access to directories containing content files + # to remove them if they are stale + let + contentDirs = map dirOf contentFiles; + in + unique ( + attrValues dataDisks ++ parityFiles ++ contentDirs + ); + } // optionalAttrs touchBeforeSync { + ExecStartPre = "${pkgs.snapraid}/bin/snapraid touch"; + }; + }; + }; + }; +} diff --git a/nixos/modules/tasks/trackpoint.nix b/nixos/modules/tasks/trackpoint.nix index b154cf9f5f0..029d8a00295 100644 --- a/nixos/modules/tasks/trackpoint.nix +++ b/nixos/modules/tasks/trackpoint.nix @@ -87,9 +87,9 @@ with lib; }) (mkIf (cfg.emulateWheel) { - services.xserver.inputClassSections = - ['' - Identifier "Trackpoint Wheel Emulation" + services.xserver.inputClassSections = [ + '' + Identifier "Trackpoint Wheel Emulation" MatchProduct "${if cfg.fakeButtons then "PS/2 Generic Mouse" else "ETPS/2 Elantech TrackPoint|Elantech PS/2 TrackPoint|TPPS/2 IBM TrackPoint|DualPoint Stick|Synaptics Inc. Composite TouchPad / TrackPoint|ThinkPad USB Keyboard with TrackPoint|USB Trackpoint pointing device|Composite TouchPad / TrackPoint|${cfg.device}"}" MatchDevicePath "/dev/input/event*" Option "EmulateWheel" "true" @@ -97,7 +97,8 @@ with lib; Option "Emulate3Buttons" "false" Option "XAxisMapping" "6 7" Option "YAxisMapping" "4 5" - '']; + '' + ]; }) (mkIf cfg.fakeButtons { diff --git a/nixos/modules/virtualisation/containerd.nix b/nixos/modules/virtualisation/containerd.nix index b554bc6ea24..c7ceb816a31 100644 --- a/nixos/modules/virtualisation/containerd.nix +++ b/nixos/modules/virtualisation/containerd.nix @@ -1,10 +1,20 @@ { pkgs, lib, config, ... }: let cfg = config.virtualisation.containerd; - containerdConfigChecked = pkgs.runCommand "containerd-config-checked.toml" { nativeBuildInputs = [pkgs.containerd]; } '' - containerd -c ${cfg.configFile} config dump >/dev/null - ln -s ${cfg.configFile} $out + + configFile = if cfg.configFile == null then + settingsFormat.generate "containerd.toml" cfg.settings + else + cfg.configFile; + + containerdConfigChecked = pkgs.runCommand "containerd-config-checked.toml" { + nativeBuildInputs = [ pkgs.containerd ]; + } '' + containerd -c ${configFile} config dump >/dev/null + ln -s ${configFile} $out ''; + + settingsFormat = pkgs.formats.toml {}; in { @@ -13,10 +23,21 @@ in configFile = lib.mkOption { default = null; - description = "path to containerd config file"; + description = '' + Path to containerd config file. + Setting this option will override any configuration applied by the settings option. + ''; type = nullOr path; }; + settings = lib.mkOption { + type = settingsFormat.type; + default = {}; + description = '' + Verbatim lines to add to containerd.toml + ''; + }; + args = lib.mkOption { default = {}; description = "extra args to append to the containerd cmdline"; @@ -25,9 +46,19 @@ in }; config = lib.mkIf cfg.enable { - virtualisation.containerd.args.config = lib.mkIf (cfg.configFile != null) (toString containerdConfigChecked); + warnings = lib.optional (cfg.configFile != null) '' + `virtualisation.containerd.configFile` is deprecated. use `virtualisation.containerd.settings` instead. + ''; + + virtualisation.containerd = { + args.config = toString containerdConfigChecked; + settings = { + plugins.cri.containerd.snapshotter = lib.mkIf config.boot.zfs.enabled "zfs"; + plugins.cri.cni.bin_dir = lib.mkDefault "${pkgs.cni-plugins}/bin"; + }; + }; - environment.systemPackages = [pkgs.containerd]; + environment.systemPackages = [ pkgs.containerd ]; systemd.services.containerd = { description = "containerd - container runtime"; @@ -37,7 +68,7 @@ in containerd runc iptables - ]; + ] ++ lib.optional config.boot.zfs.enabled config.boot.zfs.package; serviceConfig = { ExecStart = ''${pkgs.containerd}/bin/containerd ${lib.concatStringsSep " " (lib.cli.toGNUCommandLine {} cfg.args)}''; Delegate = "yes"; diff --git a/nixos/modules/virtualisation/containers.nix b/nixos/modules/virtualisation/containers.nix index 3974caf2233..84824e2f90f 100644 --- a/nixos/modules/virtualisation/containers.nix +++ b/nixos/modules/virtualisation/containers.nix @@ -48,6 +48,35 @@ in description = "containers.conf configuration"; }; + containersConf.cniPlugins = mkOption { + type = types.listOf types.package; + defaultText = '' + [ + pkgs.cni-plugins + ] + ''; + example = lib.literalExample '' + [ + pkgs.cniPlugins.dnsname + ] + ''; + description = '' + CNI plugins to install on the system. + ''; + }; + + storage.settings = mkOption { + type = toml.type; + default = { + storage = { + driver = "overlay"; + graphroot = "/var/lib/containers/storage"; + runroot = "/run/containers/storage"; + }; + }; + description = "storage.conf configuration"; + }; + registries = { search = mkOption { type = types.listOf types.str; @@ -97,8 +126,11 @@ in }; config = lib.mkIf cfg.enable { + + virtualisation.containers.containersConf.cniPlugins = [ pkgs.cni-plugins ]; + virtualisation.containers.containersConf.settings = { - network.cni_plugin_dirs = [ "${pkgs.cni-plugins}/bin/" ]; + network.cni_plugin_dirs = map (p: "${lib.getBin p}/bin") cfg.containersConf.cniPlugins; engine = { init_path = "${pkgs.catatonit}/bin/catatonit"; } // lib.optionalAttrs cfg.ociSeccompBpfHook.enable { @@ -109,6 +141,9 @@ in environment.etc."containers/containers.conf".source = toml.generate "containers.conf" cfg.containersConf.settings; + environment.etc."containers/storage.conf".source = + toml.generate "storage.conf" cfg.storage.settings; + environment.etc."containers/registries.conf".source = toml.generate "registries.conf" { registries = lib.mapAttrs (n: v: { registries = v; }) cfg.registries; }; diff --git a/nixos/modules/virtualisation/cri-o.nix b/nixos/modules/virtualisation/cri-o.nix index 8d352e36ef9..c135081959a 100644 --- a/nixos/modules/virtualisation/cri-o.nix +++ b/nixos/modules/virtualisation/cri-o.nix @@ -6,6 +6,9 @@ let crioPackage = (pkgs.cri-o.override { inherit (cfg) extraPackages; }); + format = pkgs.formats.toml { }; + + cfgFile = format.generate "00-default.conf" cfg.settings; in { imports = [ @@ -13,7 +16,7 @@ in ]; meta = { - maintainers = lib.teams.podman.members; + maintainers = teams.podman.members; }; options.virtualisation.cri-o = { @@ -55,7 +58,7 @@ in extraPackages = mkOption { type = with types; listOf package; default = [ ]; - example = lib.literalExample '' + example = literalExample '' [ pkgs.gvisor ] @@ -65,7 +68,7 @@ in ''; }; - package = lib.mkOption { + package = mkOption { type = types.package; default = crioPackage; internal = true; @@ -80,6 +83,15 @@ in description = "Override the network_dir option."; internal = true; }; + + settings = mkOption { + type = format.type; + default = { }; + description = '' + Configuration for cri-o, see + <link xlink:href="https://github.com/cri-o/cri-o/blob/master/docs/crio.conf.5.md"/>. + ''; + }; }; config = mkIf cfg.enable { @@ -87,36 +99,38 @@ in environment.etc."crictl.yaml".source = utils.copyFile "${pkgs.cri-o-unwrapped.src}/crictl.yaml"; - environment.etc."crio/crio.conf.d/00-default.conf".text = '' - [crio] - storage_driver = "${cfg.storageDriver}" - - [crio.image] - ${optionalString (cfg.pauseImage != null) ''pause_image = "${cfg.pauseImage}"''} - ${optionalString (cfg.pauseCommand != null) ''pause_command = "${cfg.pauseCommand}"''} - - [crio.network] - plugin_dirs = ["${pkgs.cni-plugins}/bin/"] - ${optionalString (cfg.networkDir != null) ''network_dir = "${cfg.networkDir}"''} - - [crio.runtime] - cgroup_manager = "systemd" - log_level = "${cfg.logLevel}" - pinns_path = "${cfg.package}/bin/pinns" - hooks_dir = [ - ${lib.optionalString config.virtualisation.containers.ociSeccompBpfHook.enable - ''"${config.boot.kernelPackages.oci-seccomp-bpf-hook}",''} - ] - - ${optionalString (cfg.runtime != null) '' - default_runtime = "${cfg.runtime}" - [crio.runtime.runtimes] - [crio.runtime.runtimes.${cfg.runtime}] - ''} - ''; + virtualisation.cri-o.settings.crio = { + storage_driver = cfg.storageDriver; + + image = { + pause_image = mkIf (cfg.pauseImage != null) cfg.pauseImage; + pause_command = mkIf (cfg.pauseCommand != null) cfg.pauseCommand; + }; + + network = { + plugin_dirs = [ "${pkgs.cni-plugins}/bin" ]; + network_dir = mkIf (cfg.networkDir != null) cfg.networkDir; + }; + + runtime = { + cgroup_manager = "systemd"; + log_level = cfg.logLevel; + manage_ns_lifecycle = true; + pinns_path = "${cfg.package}/bin/pinns"; + hooks_dir = + optional (config.virtualisation.containers.ociSeccompBpfHook.enable) + config.boot.kernelPackages.oci-seccomp-bpf-hook; + + default_runtime = mkIf (cfg.runtime != null) cfg.runtime; + runtimes = mkIf (cfg.runtime != null) { + "${cfg.runtime}" = { }; + }; + }; + }; environment.etc."cni/net.d/10-crio-bridge.conf".source = utils.copyFile "${pkgs.cri-o-unwrapped.src}/contrib/cni/10-crio-bridge.conf"; environment.etc."cni/net.d/99-loopback.conf".source = utils.copyFile "${pkgs.cri-o-unwrapped.src}/contrib/cni/99-loopback.conf"; + environment.etc."crio/crio.conf.d/00-default.conf".source = cfgFile; # Enable common /etc/containers configuration virtualisation.containers.enable = true; @@ -139,6 +153,7 @@ in TimeoutStartSec = "0"; Restart = "on-abnormal"; }; + restartTriggers = [ cfgFile ]; }; }; } diff --git a/nixos/modules/virtualisation/ec2-amis.nix b/nixos/modules/virtualisation/ec2-amis.nix index 892af513b03..d38f41ab39d 100644 --- a/nixos/modules/virtualisation/ec2-amis.nix +++ b/nixos/modules/virtualisation/ec2-amis.nix @@ -348,5 +348,24 @@ let self = { "20.09".ap-east-1.hvm-ebs = "ami-0c42f97e5b1fda92f"; "20.09".sa-east-1.hvm-ebs = "ami-021637976b094959d"; - latest = self."20.09"; + # 21.05.740.aa576357673 + "21.05".eu-west-1.hvm-ebs = "ami-048dbc738074a3083"; + "21.05".eu-west-2.hvm-ebs = "ami-0234cf81fec68315d"; + "21.05".eu-west-3.hvm-ebs = "ami-020e459baf709107d"; + "21.05".eu-central-1.hvm-ebs = "ami-0857d5d1309ab8b77"; + "21.05".eu-north-1.hvm-ebs = "ami-05403e3ae53d3716f"; + "21.05".us-east-1.hvm-ebs = "ami-0d3002ba40b5b9897"; + "21.05".us-east-2.hvm-ebs = "ami-069a0ca1bde6dea52"; + "21.05".us-west-1.hvm-ebs = "ami-0b415460a84bcf9bc"; + "21.05".us-west-2.hvm-ebs = "ami-093cba49754abd7f8"; + "21.05".ca-central-1.hvm-ebs = "ami-065c13e1d52d60b33"; + "21.05".ap-southeast-1.hvm-ebs = "ami-04f570c70ff9b665e"; + "21.05".ap-southeast-2.hvm-ebs = "ami-02a3d1df595df5ef6"; + "21.05".ap-northeast-1.hvm-ebs = "ami-027836fddb5c56012"; + "21.05".ap-northeast-2.hvm-ebs = "ami-0edacd41dc7700c39"; + "21.05".ap-south-1.hvm-ebs = "ami-0b279b5bb55288059"; + "21.05".ap-east-1.hvm-ebs = "ami-06dc98082bc55c1fc"; + "21.05".sa-east-1.hvm-ebs = "ami-04737dd49b98936c6"; + + latest = self."21.05"; }; in self diff --git a/nixos/modules/virtualisation/libvirtd.nix b/nixos/modules/virtualisation/libvirtd.nix index d12169787c5..f45f1802d91 100644 --- a/nixos/modules/virtualisation/libvirtd.nix +++ b/nixos/modules/virtualisation/libvirtd.nix @@ -155,12 +155,19 @@ in { config = mkIf cfg.enable { + assertions = [ + { + assertion = config.security.polkit.enable; + message = "The libvirtd module currently requires Polkit to be enabled ('security.polkit.enable = true')."; + } + ]; + environment = { # this file is expected in /etc/qemu and not sysconfdir (/var/lib) etc."qemu/bridge.conf".text = lib.concatMapStringsSep "\n" (e: "allow ${e}") cfg.allowedBridges; systemPackages = with pkgs; [ libressl.nc iptables cfg.package cfg.qemuPackage ]; - etc.ethertypes.source = "${pkgs.iptables}/etc/ethertypes"; + etc.ethertypes.source = "${pkgs.ebtables}/etc/ethertypes"; }; boot.kernelModules = [ "tun" ]; diff --git a/nixos/modules/virtualisation/lxd.nix b/nixos/modules/virtualisation/lxd.nix index 6b6f4b6e652..cde29f7bf59 100644 --- a/nixos/modules/virtualisation/lxd.nix +++ b/nixos/modules/virtualisation/lxd.nix @@ -175,5 +175,8 @@ in { "net.ipv6.neigh.default.gc_thresh3" = 8192; "kernel.keys.maxkeys" = 2000; }; + + boot.kernelModules = [ "veth" "xt_comment" "xt_CHECKSUM" "xt_MASQUERADE" ] + ++ optionals (!config.networking.nftables.enable) [ "iptable_mangle" ]; }; } diff --git a/nixos/modules/virtualisation/oci-containers.nix b/nixos/modules/virtualisation/oci-containers.nix index ad436ed3014..a4a92f22506 100644 --- a/nixos/modules/virtualisation/oci-containers.nix +++ b/nixos/modules/virtualisation/oci-containers.nix @@ -31,6 +31,30 @@ let example = literalExample "pkgs.dockerTools.buildDockerImage {...};"; }; + login = { + + username = mkOption { + type = with types; nullOr str; + default = null; + description = "Username for login."; + }; + + passwordFile = mkOption { + type = with types; nullOr str; + default = null; + description = "Path to file containing password."; + example = "/etc/nixos/dockerhub-password.txt"; + }; + + registry = mkOption { + type = with types; nullOr str; + default = null; + description = "Registry where to login to."; + example = "https://docker.pkg.github.com"; + }; + + }; + cmd = mkOption { type = with types; listOf str; default = []; @@ -220,6 +244,8 @@ let }; }; + isValidLogin = login: login.username != null && login.passwordFile != null && login.registry != null; + mkService = name: container: let dependsOn = map (x: "${cfg.backend}-${x}.service") container.dependsOn; in { @@ -235,6 +261,13 @@ let preStart = '' ${cfg.backend} rm -f ${name} || true + ${optionalString (isValidLogin container.login) '' + cat ${container.login.passwordFile} | \ + ${cfg.backend} login \ + ${container.login.registry} \ + --username ${container.login.username} \ + --password-stdin + ''} ${optionalString (container.imageFile != null) '' ${cfg.backend} load -i ${container.imageFile} ''} @@ -262,9 +295,6 @@ let postStop = "${cfg.backend} rm -f ${name} || true"; serviceConfig = { - StandardOutput = "null"; - StandardError = "null"; - ### There is no generalized way of supporting `reload` for docker ### containers. Some containers may respond well to SIGHUP sent to their ### init process, but it is not guaranteed; some apps have other reload diff --git a/nixos/modules/virtualisation/openvswitch.nix b/nixos/modules/virtualisation/openvswitch.nix index c6a3ceddc3e..ccf32641df6 100644 --- a/nixos/modules/virtualisation/openvswitch.nix +++ b/nixos/modules/virtualisation/openvswitch.nix @@ -66,9 +66,7 @@ in { }; in (mkMerge [{ - - environment.systemPackages = [ cfg.package pkgs.ipsecTools ]; - + environment.systemPackages = [ cfg.package ]; boot.kernelModules = [ "tun" "openvswitch" ]; boot.extraModulePackages = [ cfg.package ]; @@ -146,6 +144,8 @@ in { } (mkIf (cfg.ipsec && (versionOlder cfg.package.version "2.6.0")) { + environment.systemPackages = [ pkgs.ipsecTools ]; + services.racoon.enable = true; services.racoon.configPath = "${runDir}/ipsec/etc/racoon/racoon.conf"; diff --git a/nixos/modules/virtualisation/podman-dnsname.nix b/nixos/modules/virtualisation/podman-dnsname.nix new file mode 100644 index 00000000000..beef1975507 --- /dev/null +++ b/nixos/modules/virtualisation/podman-dnsname.nix @@ -0,0 +1,36 @@ +{ config, lib, pkgs, ... }: +let + inherit (lib) + mkOption + mkIf + types + ; + + cfg = config.virtualisation.podman; + +in +{ + options = { + virtualisation.podman = { + + defaultNetwork.dnsname.enable = mkOption { + type = types.bool; + default = false; + description = '' + Enable DNS resolution in the default podman network. + ''; + }; + + }; + }; + + config = { + virtualisation.containers.containersConf.cniPlugins = mkIf cfg.defaultNetwork.dnsname.enable [ pkgs.dnsname-cni ]; + virtualisation.podman.defaultNetwork.extraPlugins = + lib.optional cfg.defaultNetwork.dnsname.enable { + type = "dnsname"; + domainName = "dns.podman"; + capabilities.aliases = true; + }; + }; +} diff --git a/nixos/modules/virtualisation/podman-network-socket-ghostunnel.nix b/nixos/modules/virtualisation/podman-network-socket-ghostunnel.nix new file mode 100644 index 00000000000..a0e7e433164 --- /dev/null +++ b/nixos/modules/virtualisation/podman-network-socket-ghostunnel.nix @@ -0,0 +1,34 @@ +{ config, lib, pkg, ... }: +let + inherit (lib) + mkOption + types + ; + + cfg = config.virtualisation.podman.networkSocket; + +in +{ + options.virtualisation.podman.networkSocket = { + server = mkOption { + type = types.enum [ "ghostunnel" ]; + }; + }; + + config = lib.mkIf (cfg.enable && cfg.server == "ghostunnel") { + + services.ghostunnel = { + enable = true; + servers."podman-socket" = { + inherit (cfg.tls) cert key cacert; + listen = "${cfg.listenAddress}:${toString cfg.port}"; + target = "unix:/run/podman/podman.sock"; + allowAll = lib.mkDefault true; + }; + }; + systemd.services.ghostunnel-server-podman-socket.serviceConfig.SupplementaryGroups = ["podman"]; + + }; + + meta.maintainers = lib.teams.podman.members ++ [ lib.maintainers.roberth ]; +} diff --git a/nixos/modules/virtualisation/podman-network-socket.nix b/nixos/modules/virtualisation/podman-network-socket.nix new file mode 100644 index 00000000000..1429164630b --- /dev/null +++ b/nixos/modules/virtualisation/podman-network-socket.nix @@ -0,0 +1,91 @@ +{ config, lib, pkg, ... }: +let + inherit (lib) + mkOption + types + ; + + cfg = config.virtualisation.podman.networkSocket; + +in +{ + options.virtualisation.podman.networkSocket = { + enable = mkOption { + type = types.bool; + default = false; + description = '' + Make the Podman and Docker compatibility API available over the network + with TLS client certificate authentication. + + This allows Docker clients to connect with the equivalents of the Docker + CLI <code>-H</code> and <code>--tls*</code> family of options. + + For certificate setup, see https://docs.docker.com/engine/security/protect-access/ + + This option is independent of <xref linkend="opt-virtualisation.podman.dockerSocket.enable"/>. + ''; + }; + + server = mkOption { + type = types.enum []; + description = '' + Choice of TLS proxy server. + ''; + example = "ghostunnel"; + }; + + openFirewall = mkOption { + type = types.bool; + default = false; + description = '' + Whether to open the port in the firewall. + ''; + }; + + tls.cacert = mkOption { + type = types.path; + description = '' + Path to CA certificate to use for client authentication. + ''; + }; + + tls.cert = mkOption { + type = types.path; + description = '' + Path to certificate describing the server. + ''; + }; + + tls.key = mkOption { + type = types.path; + description = '' + Path to the private key corresponding to the server certificate. + + Use a string for this setting. Otherwise it will be copied to the Nix + store first, where it is readable by any system process. + ''; + }; + + port = mkOption { + type = types.port; + default = 2376; + description = '' + TCP port number for receiving TLS connections. + ''; + }; + listenAddress = mkOption { + type = types.str; + default = "0.0.0.0"; + description = '' + Interface address for receiving TLS connections. + ''; + }; + }; + + config = { + networking.firewall.allowedTCPPorts = + lib.optional (cfg.enable && cfg.openFirewall) cfg.port; + }; + + meta.maintainers = lib.teams.podman.members ++ [ lib.maintainers.roberth ]; +} diff --git a/nixos/modules/virtualisation/podman.nix b/nixos/modules/virtualisation/podman.nix index d6421d488b8..e245004e04a 100644 --- a/nixos/modules/virtualisation/podman.nix +++ b/nixos/modules/virtualisation/podman.nix @@ -1,7 +1,8 @@ -{ config, lib, pkgs, utils, ... }: +{ config, lib, pkgs, ... }: let cfg = config.virtualisation.podman; toml = pkgs.formats.toml { }; + json = pkgs.formats.json { }; inherit (lib) mkOption types; @@ -22,9 +23,24 @@ let done ''; + net-conflist = pkgs.runCommand "87-podman-bridge.conflist" { + nativeBuildInputs = [ pkgs.jq ]; + extraPlugins = builtins.toJSON cfg.defaultNetwork.extraPlugins; + jqScript = '' + . + { "plugins": (.plugins + $extraPlugins) } + ''; + } '' + jq <${cfg.package}/etc/cni/net.d/87-podman-bridge.conflist \ + --argjson extraPlugins "$extraPlugins" \ + "$jqScript" \ + >$out + ''; + in { imports = [ + ./podman-dnsname.nix + ./podman-network-socket.nix (lib.mkRenamedOptionModule [ "virtualisation" "podman" "libpod" ] [ "virtualisation" "containers" "containersConf" ]) ]; @@ -46,6 +62,20 @@ in ''; }; + dockerSocket.enable = mkOption { + type = types.bool; + default = false; + description = '' + Make the Podman socket available in place of the Docker socket, so + Docker tools can find the Podman socket. + + Podman implements the Docker API. + + Users must be in the <code>podman</code> group in order to connect. As + with Docker, members of this group can gain root access. + ''; + }; + dockerCompat = mkOption { type = types.bool; default = false; @@ -84,6 +114,13 @@ in ''; }; + defaultNetwork.extraPlugins = lib.mkOption { + type = types.listOf json.type; + default = []; + description = '' + Extra CNI plugin configurations to add to podman's default network. + ''; + }; }; @@ -92,7 +129,7 @@ in environment.systemPackages = [ cfg.package ] ++ lib.optional cfg.dockerCompat dockerCompat; - environment.etc."cni/net.d/87-podman-bridge.conflist".source = utils.copyFile "${pkgs.podman-unwrapped.src}/cni/87-podman-bridge.conflist"; + environment.etc."cni/net.d/87-podman-bridge.conflist".source = net-conflist; virtualisation.containers = { enable = true; # Enable common /etc/containers configuration @@ -111,14 +148,36 @@ in }; systemd.sockets.podman.wantedBy = [ "sockets.target" ]; + systemd.sockets.podman.socketConfig.SocketGroup = "podman"; - systemd.tmpfiles.packages = [ cfg.package ]; + systemd.tmpfiles.packages = [ + # The /run/podman rule interferes with our podman group, so we remove + # it and let the systemd socket logic take care of it. + (pkgs.runCommand "podman-tmpfiles-nixos" { package = cfg.package; } '' + mkdir -p $out/lib/tmpfiles.d/ + grep -v 'D! /run/podman 0700 root root' \ + <$package/lib/tmpfiles.d/podman.conf \ + >$out/lib/tmpfiles.d/podman.conf + '') ]; + + systemd.tmpfiles.rules = + lib.optionals cfg.dockerSocket.enable [ + "L! /run/docker.sock - - - - /run/podman/podman.sock" + ]; + + users.groups.podman = {}; assertions = [ { assertion = cfg.dockerCompat -> !config.virtualisation.docker.enable; message = "Option dockerCompat conflicts with docker"; } + { + assertion = cfg.dockerSocket.enable -> !config.virtualisation.docker.enable; + message = '' + The options virtualisation.podman.dockerSocket.enable and virtualisation.docker.enable conflict, because only one can serve the socket. + ''; + } ]; } ]); diff --git a/nixos/modules/virtualisation/virtualbox-image.nix b/nixos/modules/virtualisation/virtualbox-image.nix index 071edda8269..272c696807a 100644 --- a/nixos/modules/virtualisation/virtualbox-image.nix +++ b/nixos/modules/virtualisation/virtualbox-image.nix @@ -58,7 +58,19 @@ in { Run <literal>VBoxManage modifyvm --help</literal> to see more options. ''; - }; + }; + exportParams = mkOption { + type = with types; listOf (oneOf [ str int bool (listOf str) ]); + example = [ + "--vsys" "0" "--vendor" "ACME Inc." + ]; + default = []; + description = '' + Parameters passed to the Virtualbox export command. + + Run <literal>VBoxManage export --help</literal> to see more options. + ''; + }; extraDisk = mkOption { description = '' Optional extra disk/hdd configuration. @@ -158,7 +170,7 @@ in { echo "exporting VirtualBox VM..." mkdir -p $out fn="$out/${cfg.vmFileName}" - VBoxManage export "$vmName" --output "$fn" --options manifest + VBoxManage export "$vmName" --output "$fn" --options manifest ${escapeShellArgs cfg.exportParams} rm -v $diskImage diff --git a/nixos/modules/virtualisation/vmware-guest.nix b/nixos/modules/virtualisation/vmware-guest.nix index 962a9059ea4..9465a8d6800 100644 --- a/nixos/modules/virtualisation/vmware-guest.nix +++ b/nixos/modules/virtualisation/vmware-guest.nix @@ -56,5 +56,7 @@ in ${open-vm-tools}/bin/vmware-user-suid-wrapper ''; }; + + services.udev.packages = [ open-vm-tools ]; }; } diff --git a/nixos/release-combined.nix b/nixos/release-combined.nix index 34183c0ba9f..ee3f3d19174 100644 --- a/nixos/release-combined.nix +++ b/nixos/release-combined.nix @@ -147,6 +147,7 @@ in rec { (onFullSupported "nixos.tests.sddm.default") (onFullSupported "nixos.tests.shadow") (onFullSupported "nixos.tests.simple") + (onFullSupported "nixos.tests.sway") (onFullSupported "nixos.tests.switchTest") (onFullSupported "nixos.tests.udisks2") (onFullSupported "nixos.tests.xfce") diff --git a/nixos/tests/acme.nix b/nixos/tests/acme.nix index 6f98b0da378..6532fc4ac1d 100644 --- a/nixos/tests/acme.nix +++ b/nixos/tests/acme.nix @@ -330,30 +330,38 @@ in import ./make-test-python.nix ({ lib, ... }: { with subtest("Can request certificate with HTTPS-01 challenge"): webserver.wait_for_unit("acme-finished-a.example.test.target") - check_fullchain(webserver, "a.example.test") - check_issuer(webserver, "a.example.test", "pebble") - check_connection(client, "a.example.test") with subtest("Certificates and accounts have safe + valid permissions"): group = "${nodes.webserver.config.security.acme.certs."a.example.test".group}" webserver.succeed( - f"test $(stat -L -c \"%a %U %G\" /var/lib/acme/a.example.test/* | tee /dev/stderr | grep '640 acme {group}' | wc -l) -eq 5" + f"test $(stat -L -c '%a %U %G' /var/lib/acme/a.example.test/*.pem | tee /dev/stderr | grep '640 acme {group}' | wc -l) -eq 5" ) webserver.succeed( - f"test $(stat -L -c \"%a %U %G\" /var/lib/acme/.lego/a.example.test/**/* | tee /dev/stderr | grep '640 acme {group}' | wc -l) -eq 5" + f"test $(stat -L -c '%a %U %G' /var/lib/acme/.lego/a.example.test/**/a.example.test* | tee /dev/stderr | grep '600 acme {group}' | wc -l) -eq 4" ) webserver.succeed( - f"test $(stat -L -c \"%a %U %G\" /var/lib/acme/a.example.test | tee /dev/stderr | grep '750 acme {group}' | wc -l) -eq 1" + f"test $(stat -L -c '%a %U %G' /var/lib/acme/a.example.test | tee /dev/stderr | grep '750 acme {group}' | wc -l) -eq 1" ) webserver.succeed( - f"test $(find /var/lib/acme/accounts -type f -exec stat -L -c \"%a %U %G\" {{}} \\; | tee /dev/stderr | grep -v '600 acme {group}' | wc -l) -eq 0" + f"test $(find /var/lib/acme/accounts -type f -exec stat -L -c '%a %U %G' {{}} \\; | tee /dev/stderr | grep -v '600 acme {group}' | wc -l) -eq 0" ) + with subtest("Certs are accepted by web server"): + webserver.succeed("systemctl start nginx.service") + check_fullchain(webserver, "a.example.test") + check_issuer(webserver, "a.example.test", "pebble") + check_connection(client, "a.example.test") + + # Selfsigned certs tests happen late so we aren't fighting the system init triggering cert renewal with subtest("Can generate valid selfsigned certs"): webserver.succeed("systemctl clean acme-a.example.test.service --what=state") webserver.succeed("systemctl start acme-selfsigned-a.example.test.service") check_fullchain(webserver, "a.example.test") check_issuer(webserver, "a.example.test", "minica") + # Check selfsigned permissions + webserver.succeed( + f"test $(stat -L -c '%a %U %G' /var/lib/acme/a.example.test/*.pem | tee /dev/stderr | grep '640 acme {group}' | wc -l) -eq 5" + ) # Will succeed if nginx can load the certs webserver.succeed("systemctl start nginx-config-reload.service") @@ -376,6 +384,8 @@ in import ./make-test-python.nix ({ lib, ... }: { webserver.wait_for_unit("acme-finished-a.example.test.target") check_connection_key_bits(client, "a.example.test", "384") webserver.succeed("grep testing /var/lib/acme/a.example.test/test") + # Clean to remove the testing file (and anything else messy we did) + webserver.succeed("systemctl clean acme-a.example.test.service --what=state") with subtest("Correctly implements OCSP stapling"): switch_to(webserver, "ocsp-stapling") @@ -392,14 +402,11 @@ in import ./make-test-python.nix ({ lib, ... }: { # Check the key hash before and after adding an alias. It should not change. # The previous test reverts the ed384 change webserver.wait_for_unit("acme-finished-a.example.test.target") - keyhash_old = webserver.succeed("md5sum /var/lib/acme/a.example.test/key.pem") switch_to(webserver, "nginx-aliases") webserver.wait_for_unit("acme-finished-a.example.test.target") check_issuer(webserver, "a.example.test", "pebble") check_connection(client, "a.example.test") check_connection(client, "b.example.test") - keyhash_new = webserver.succeed("md5sum /var/lib/acme/a.example.test/key.pem") - assert keyhash_old == keyhash_new with subtest("Can request certificates for vhost + aliases (apache-httpd)"): try: diff --git a/nixos/tests/agda.nix b/nixos/tests/agda.nix index f282788519c..ec61af2afe7 100644 --- a/nixos/tests/agda.nix +++ b/nixos/tests/agda.nix @@ -2,6 +2,7 @@ import ./make-test-python.nix ({ pkgs, ... }: let hello-world = pkgs.writeText "hello-world" '' + {-# OPTIONS --guardedness #-} open import IO open import Level @@ -35,10 +36,6 @@ in machine.succeed("touch TestEmpty.agda") machine.succeed("agda TestEmpty.agda") - # Minimal script that actually uses the standard library - machine.succeed('echo "import IO" > TestIO.agda') - machine.succeed("agda -l standard-library -i . TestIO.agda") - # Hello world machine.succeed( "cp ${hello-world} HelloWorld.agda" diff --git a/nixos/tests/all-tests.nix b/nixos/tests/all-tests.nix index 99393e5b184..d6ef7d42431 100644 --- a/nixos/tests/all-tests.nix +++ b/nixos/tests/all-tests.nix @@ -42,17 +42,17 @@ in bind = handleTest ./bind.nix {}; bitcoind = handleTest ./bitcoind.nix {}; bittorrent = handleTest ./bittorrent.nix {}; - bitwarden = handleTest ./bitwarden.nix {}; blockbook-frontend = handleTest ./blockbook-frontend.nix {}; - boot = handleTestOn ["x86_64-linux"] ./boot.nix {}; # syslinux is unsupported on aarch64 + boot = handleTestOn ["x86_64-linux" "aarch64-linux"] ./boot.nix {}; boot-stage1 = handleTest ./boot-stage1.nix {}; borgbackup = handleTest ./borgbackup.nix {}; botamusique = handleTest ./botamusique.nix {}; + btrbk = handleTest ./btrbk.nix {}; buildbot = handleTest ./buildbot.nix {}; buildkite-agents = handleTest ./buildkite-agents.nix {}; caddy = handleTest ./caddy.nix {}; cadvisor = handleTestOn ["x86_64-linux"] ./cadvisor.nix {}; - cage = handleTestOn ["x86_64-linux"] ./cage.nix {}; + cage = handleTest ./cage.nix {}; cagebreak = handleTest ./cagebreak.nix {}; calibre-web = handleTest ./calibre-web.nix {}; cassandra_2_1 = handleTest ./cassandra.nix { testPackage = pkgs.cassandra_2_1; }; @@ -88,6 +88,7 @@ in containers-tmpfs = handleTest ./containers-tmpfs.nix {}; convos = handleTest ./convos.nix {}; corerad = handleTest ./corerad.nix {}; + coturn = handleTest ./coturn.nix {}; couchdb = handleTest ./couchdb.nix {}; cri-o = handleTestOn ["x86_64-linux"] ./cri-o.nix {}; custom-ca = handleTest ./custom-ca.nix {}; @@ -173,6 +174,7 @@ in hitch = handleTest ./hitch {}; hledger-web = handleTest ./hledger-web.nix {}; hocker-fetchdocker = handleTest ./hocker-fetchdocker {}; + hockeypuck = handleTest ./hockeypuck.nix { }; home-assistant = handleTest ./home-assistant.nix {}; hostname = handleTest ./hostname.nix {}; hound = handleTest ./hound.nix {}; @@ -201,6 +203,8 @@ in jitsi-meet = handleTest ./jitsi-meet.nix {}; k3s = handleTest ./k3s.nix {}; kafka = handleTest ./kafka.nix {}; + kbd-setfont-decompress = handleTest ./kbd-setfont-decompress.nix {}; + kea = handleTest ./kea.nix {}; keepalived = handleTest ./keepalived.nix {}; keepassxc = handleTest ./keepassxc.nix {}; kerberos = handleTest ./kerberos/default.nix {}; @@ -293,6 +297,7 @@ in nginx-sandbox = handleTestOn ["x86_64-linux"] ./nginx-sandbox.nix {}; nginx-sso = handleTest ./nginx-sso.nix {}; nginx-variants = handleTest ./nginx-variants.nix {}; + nix-serve = handleTest ./nix-ssh-serve.nix {}; nix-ssh-serve = handleTest ./nix-ssh-serve.nix {}; nixos-generate-config = handleTest ./nixos-generate-config.nix {}; nomad = handleTest ./nomad.nix {}; @@ -325,16 +330,18 @@ in pgjwt = handleTest ./pgjwt.nix {}; pgmanage = handleTest ./pgmanage.nix {}; php = handleTest ./php {}; - php73 = handleTest ./php { php = pkgs.php73; }; php74 = handleTest ./php { php = pkgs.php74; }; php80 = handleTest ./php { php = pkgs.php80; }; pinnwand = handleTest ./pinnwand.nix {}; plasma5 = handleTest ./plasma5.nix {}; + plausible = handleTest ./plausible.nix {}; pleroma = handleTestOn [ "x86_64-linux" "aarch64-linux" ] ./pleroma.nix {}; plikd = handleTest ./plikd.nix {}; plotinus = handleTest ./plotinus.nix {}; podgrab = handleTest ./podgrab.nix {}; podman = handleTestOn ["x86_64-linux"] ./podman.nix {}; + podman-dnsname = handleTestOn ["x86_64-linux"] ./podman-dnsname.nix {}; + podman-tls-ghostunnel = handleTestOn ["x86_64-linux"] ./podman-tls-ghostunnel.nix {}; pomerium = handleTestOn ["x86_64-linux"] ./pomerium.nix {}; postfix = handleTest ./postfix.nix {}; postfix-raise-smtpd-tls-security-level = handleTest ./postfix-raise-smtpd-tls-security-level.nix {}; @@ -417,6 +424,7 @@ in taskserver = handleTest ./taskserver.nix {}; telegraf = handleTest ./telegraf.nix {}; tiddlywiki = handleTest ./tiddlywiki.nix {}; + tigervnc = handleTest ./tigervnc.nix {}; timezone = handleTest ./timezone.nix {}; tinc = handleTest ./tinc {}; tinydns = handleTest ./tinydns.nix {}; @@ -429,8 +437,11 @@ in trezord = handleTest ./trezord.nix {}; trickster = handleTest ./trickster.nix {}; trilium-server = handleTestOn ["x86_64-linux"] ./trilium-server.nix {}; + txredisapi = handleTest ./txredisapi.nix {}; tuptime = handleTest ./tuptime.nix {}; turbovnc-headless-server = handleTest ./turbovnc-headless-server.nix {}; + tuxguitar = handleTest ./tuxguitar.nix {}; + ucarp = handleTest ./ucarp.nix {}; ucg = handleTest ./ucg.nix {}; udisks2 = handleTest ./udisks2.nix {}; unbound = handleTest ./unbound.nix {}; @@ -441,8 +452,10 @@ in v2ray = handleTest ./v2ray.nix {}; vault = handleTest ./vault.nix {}; vault-postgresql = handleTest ./vault-postgresql.nix {}; + vaultwarden = handleTest ./vaultwarden.nix {}; vector = handleTest ./vector.nix {}; victoriametrics = handleTest ./victoriametrics.nix {}; + vikunja = handleTest ./vikunja.nix {}; virtualbox = handleTestOn ["x86_64-linux"] ./virtualbox.nix {}; vscodium = handleTest ./vscodium.nix {}; wasabibackend = handleTest ./wasabibackend.nix {}; diff --git a/nixos/tests/boot.nix b/nixos/tests/boot.nix index c5040f3b31f..bdae6341ec9 100644 --- a/nixos/tests/boot.nix +++ b/nixos/tests/boot.nix @@ -4,6 +4,7 @@ }: with import ../lib/testing-python.nix { inherit system pkgs; }; +with import ../lib/qemu-flags.nix { inherit pkgs; }; with pkgs.lib; let @@ -21,7 +22,10 @@ let makeBootTest = name: extraConfig: let - machineConfig = pythonDict ({ qemuFlags = "-m 768"; } // extraConfig); + machineConfig = pythonDict ({ + qemuBinary = qemuBinary pkgs.qemu_test; + qemuFlags = "-m 768"; + } // extraConfig); in makeTest { inherit iso; @@ -61,6 +65,7 @@ let ]; }; machineConfig = pythonDict ({ + qemuBinary = qemuBinary pkgs.qemu_test; qemuFlags = "-boot order=n -m 2000"; netBackendArgs = "tftp=${ipxeBootDir},bootfile=netboot.ipxe"; } // extraConfig); @@ -75,31 +80,34 @@ let machine.shutdown() ''; }; + uefiBinary = { + x86_64-linux = "${pkgs.OVMF.fd}/FV/OVMF.fd"; + aarch64-linux = "${pkgs.OVMF.fd}/FV/QEMU_EFI.fd"; + }.${pkgs.stdenv.hostPlatform.system}; in { - - biosCdrom = makeBootTest "bios-cdrom" { + uefiCdrom = makeBootTest "uefi-cdrom" { cdrom = "${iso}/iso/${iso.isoName}"; + bios = uefiBinary; }; - biosUsb = makeBootTest "bios-usb" { + uefiUsb = makeBootTest "uefi-usb" { usb = "${iso}/iso/${iso.isoName}"; + bios = uefiBinary; }; - uefiCdrom = makeBootTest "uefi-cdrom" { + uefiNetboot = makeNetbootTest "uefi" { + bios = uefiBinary; + # Custom ROM is needed for EFI PXE boot. I failed to understand exactly why, because QEMU should still use iPXE for EFI. + netFrontendArgs = "romfile=${pkgs.ipxe}/ipxe.efirom"; + }; +} // optionalAttrs (pkgs.stdenv.hostPlatform.system == "x86_64-linux") { + biosCdrom = makeBootTest "bios-cdrom" { cdrom = "${iso}/iso/${iso.isoName}"; - bios = "${pkgs.OVMF.fd}/FV/OVMF.fd"; }; - uefiUsb = makeBootTest "uefi-usb" { + biosUsb = makeBootTest "bios-usb" { usb = "${iso}/iso/${iso.isoName}"; - bios = "${pkgs.OVMF.fd}/FV/OVMF.fd"; }; biosNetboot = makeNetbootTest "bios" {}; - - uefiNetboot = makeNetbootTest "uefi" { - bios = "${pkgs.OVMF.fd}/FV/OVMF.fd"; - # Custom ROM is needed for EFI PXE boot. I failed to understand exactly why, because QEMU should still use iPXE for EFI. - netFrontendArgs = "romfile=${pkgs.ipxe}/ipxe.efirom"; - }; } diff --git a/nixos/tests/brscan5.nix b/nixos/tests/brscan5.nix new file mode 100644 index 00000000000..715191b383c --- /dev/null +++ b/nixos/tests/brscan5.nix @@ -0,0 +1,42 @@ +# integration tests for brscan5 sane driver +# + +import ./make-test-python.nix ({ pkgs, ...} : { + name = "brscan5"; + meta = with pkgs.lib.maintainers; { + maintainers = [ mattchrist ]; + }; + + machine = { pkgs, ... }: + { + nixpkgs.config.allowUnfree = true; + hardware.sane = { + enable = true; + brscan5 = { + enable = true; + netDevices = { + "a" = { model="ADS-1200"; nodename="BRW0080927AFBCE"; }; + "b" = { model="ADS-1200"; ip="192.168.1.2"; }; + }; + }; + }; + }; + + testScript = '' + # sane loads libsane-brother5.so.1 successfully, and scanimage doesn't die + strace = machine.succeed('strace scanimage -L 2>&1').split("\n") + regexp = 'openat\(.*libsane-brother5.so.1", O_RDONLY|O_CLOEXEC\) = \d\d*$' + assert len([x for x in strace if re.match(regexp,x)]) > 0 + + # module creates a config + cfg = machine.succeed('cat /etc/opt/brother/scanner/brscan5/brsanenetdevice.cfg') + assert 'DEVICE=a , "ADS-1200" , 0x4f9:0x459 , NODENAME=BRW0080927AFBCE' in cfg + assert 'DEVICE=b , "ADS-1200" , 0x4f9:0x459 , IP-ADDRESS=192.168.1.2' in cfg + + # scanimage lists the two network scanners + scanimage = machine.succeed("scanimage -L") + print(scanimage) + assert """device `brother5:net1;dev0' is a Brother b ADS-1200""" in scanimage + assert """device `brother5:net1;dev1' is a Brother a ADS-1200""" in scanimage + ''; +}) diff --git a/nixos/tests/btrbk.nix b/nixos/tests/btrbk.nix new file mode 100644 index 00000000000..2689bb66c63 --- /dev/null +++ b/nixos/tests/btrbk.nix @@ -0,0 +1,110 @@ +import ./make-test-python.nix ({ pkgs, ... }: + + let + privateKey = '' + -----BEGIN OPENSSH PRIVATE KEY----- + b3BlbnNzaC1rZXktdjEAAAAABG5vbmUAAAAEbm9uZQAAAAAAAAABAAAAMwAAAAtzc2gtZW + QyNTUxOQAAACBx8UB04Q6Q/fwDFjakHq904PYFzG9pU2TJ9KXpaPMcrwAAAJB+cF5HfnBe + RwAAAAtzc2gtZWQyNTUxOQAAACBx8UB04Q6Q/fwDFjakHq904PYFzG9pU2TJ9KXpaPMcrw + AAAEBN75NsJZSpt63faCuaD75Unko0JjlSDxMhYHAPJk2/xXHxQHThDpD9/AMWNqQer3Tg + 9gXMb2lTZMn0pelo8xyvAAAADXJzY2h1ZXR6QGt1cnQ= + -----END OPENSSH PRIVATE KEY----- + ''; + publicKey = '' + ssh-ed25519 AAAAC3NzaC1lZDI1NTE5AAAAIHHxQHThDpD9/AMWNqQer3Tg9gXMb2lTZMn0pelo8xyv + ''; + in + { + name = "btrbk"; + meta = with pkgs.lib; { + maintainers = with maintainers; [ symphorien ]; + }; + + nodes = { + archive = { ... }: { + environment.systemPackages = with pkgs; [ btrfs-progs ]; + # note: this makes the privateKey world readable. + # don't do it with real ssh keys. + environment.etc."btrbk_key".text = privateKey; + services.btrbk = { + extraPackages = [ pkgs.lz4 ]; + instances = { + remote = { + onCalendar = "minutely"; + settings = { + ssh_identity = "/etc/btrbk_key"; + ssh_user = "btrbk"; + stream_compress = "lz4"; + volume = { + "ssh://main/mnt" = { + target = "/mnt"; + snapshot_dir = "btrbk/remote"; + subvolume = "to_backup"; + }; + }; + }; + }; + }; + }; + }; + + main = { ... }: { + environment.systemPackages = with pkgs; [ btrfs-progs ]; + services.openssh = { + enable = true; + passwordAuthentication = false; + challengeResponseAuthentication = false; + }; + services.btrbk = { + extraPackages = [ pkgs.lz4 ]; + sshAccess = [ + { + key = publicKey; + roles = [ "source" "send" "info" "delete" ]; + } + ]; + instances = { + local = { + onCalendar = "minutely"; + settings = { + volume = { + "/mnt" = { + snapshot_dir = "btrbk/local"; + subvolume = "to_backup"; + }; + }; + }; + }; + }; + }; + }; + }; + + testScript = '' + start_all() + + # create btrfs partition at /mnt + for machine in (archive, main): + machine.succeed("dd if=/dev/zero of=/data_fs bs=120M count=1") + machine.succeed("mkfs.btrfs /data_fs") + machine.succeed("mkdir /mnt") + machine.succeed("mount /data_fs /mnt") + + # what to backup and where + main.succeed("btrfs subvolume create /mnt/to_backup") + main.succeed("mkdir -p /mnt/btrbk/{local,remote}") + + # check that local snapshots work + with subtest("local"): + main.succeed("echo foo > /mnt/to_backup/bar") + main.wait_until_succeeds("cat /mnt/btrbk/local/*/bar | grep foo") + main.succeed("echo bar > /mnt/to_backup/bar") + main.succeed("cat /mnt/btrbk/local/*/bar | grep foo") + + # check that btrfs send/receive works and ssh access works + with subtest("remote"): + archive.wait_until_succeeds("cat /mnt/*/bar | grep bar") + main.succeed("echo baz > /mnt/to_backup/bar") + archive.succeed("cat /mnt/*/bar | grep bar") + ''; + }) diff --git a/nixos/tests/cage.nix b/nixos/tests/cage.nix index 80ce1e0d8b3..e6bef374d30 100644 --- a/nixos/tests/cage.nix +++ b/nixos/tests/cage.nix @@ -18,10 +18,8 @@ import ./make-test-python.nix ({ pkgs, ...} : }; virtualisation.memorySize = 1024; - # Need to switch to a different VGA card / GPU driver because Cage segfaults with the default one (std): - # machine # [ 14.355893] .cage-wrapped[736]: segfault at 20 ip 00007f035fa0d8c7 sp 00007ffce9e4a2f0 error 4 in libwlroots.so.8[7f035fa07000+5a000] - # machine # [ 14.358108] Code: 4f a8 ff ff eb aa 0f 1f 44 00 00 c3 0f 1f 80 00 00 00 00 41 54 49 89 f4 55 31 ed 53 48 89 fb 48 8d 7f 18 48 8d 83 b8 00 00 00 <80> 7f 08 00 75 0d 48 83 3f 00 0f 85 91 00 00 00 48 89 fd 48 83 c7 - virtualisation.qemu.options = [ "-vga virtio" ]; + # Need to switch to a different GPU driver than the default one (-vga std) so that Cage can launch: + virtualisation.qemu.options = [ "-vga none -device virtio-gpu-pci" ]; }; enableOCR = true; diff --git a/nixos/tests/cagebreak.nix b/nixos/tests/cagebreak.nix index e343cd88e7f..242e59f5d7a 100644 --- a/nixos/tests/cagebreak.nix +++ b/nixos/tests/cagebreak.nix @@ -36,8 +36,8 @@ in environment.systemPackages = [ pkgs.cagebreak pkgs.wayland-utils ]; virtualisation.memorySize = 1024; - # Need to switch to a different VGA card / GPU driver than the default one (std) so that Cagebreak can launch: - virtualisation.qemu.options = [ "-vga virtio" ]; + # Need to switch to a different GPU driver than the default one (-vga std) so that Cagebreak can launch: + virtualisation.qemu.options = [ "-vga none -device virtio-gpu-pci" ]; }; enableOCR = true; diff --git a/nixos/tests/calibre-web.nix b/nixos/tests/calibre-web.nix index 4f73b331112..0af997317fc 100644 --- a/nixos/tests/calibre-web.nix +++ b/nixos/tests/calibre-web.nix @@ -36,7 +36,7 @@ import ./make-test-python.nix ( default.wait_for_unit("calibre-web.service") default.wait_for_open_port(${toString defaultPort}) default.succeed( - "curl --fail 'http://localhost:${toString defaultPort}/basicconfig' | grep -q 'Basic Configuration'" + "curl --fail 'http://localhost:${toString defaultPort}/basicconfig' | grep 'Basic Configuration'" ) customized.succeed( @@ -46,7 +46,7 @@ import ./make-test-python.nix ( customized.wait_for_unit("calibre-web.service") customized.wait_for_open_port(${toString port}) customized.succeed( - "curl --fail -H X-User:admin 'http://localhost:${toString port}' | grep -q test-book" + "curl --fail -H X-User:admin 'http://localhost:${toString port}' | grep test-book" ) ''; } diff --git a/nixos/tests/chromium.nix b/nixos/tests/chromium.nix index 60ecf986d6e..0c85b2d2199 100644 --- a/nixos/tests/chromium.nix +++ b/nixos/tests/chromium.nix @@ -30,7 +30,10 @@ mapAttrs (channel: chromiumPkg: makeTest rec { machine.imports = [ ./common/user-account.nix ./common/x11.nix ]; machine.virtualisation.memorySize = 2047; machine.test-support.displayManager.auto.user = user; - machine.environment.systemPackages = [ chromiumPkg ]; + machine.environment = { + systemPackages = [ chromiumPkg ]; + variables."XAUTHORITY" = "/home/alice/.Xauthority"; + }; startupHTML = pkgs.writeText "chromium-startup.html" '' <!DOCTYPE html> @@ -63,17 +66,32 @@ mapAttrs (channel: chromiumPkg: makeTest rec { return "su - ${user} -c " + shlex.quote(cmd) - def get_browser_binary(): - """Returns the name of the browser binary.""" + def launch_browser(): + """Launches the web browser with the correct options.""" + # Determine the name of the binary: pname = "${getName chromiumPkg.name}" if pname.find("chromium") != -1: - return "chromium" # Same name for all channels and ungoogled-chromium - if pname == "google-chrome": - return "google-chrome-stable" - if pname == "google-chrome-dev": - return "google-chrome-unstable" - # For google-chrome-beta and as fallback: - return pname + binary = "chromium" # Same name for all channels and ungoogled-chromium + elif pname == "google-chrome": + binary = "google-chrome-stable" + elif pname == "google-chrome-dev": + binary = "google-chrome-unstable" + else: # For google-chrome-beta and as fallback: + binary = pname + # Add optional CLI options: + options = [] + major_version = "${versions.major (getVersion chromiumPkg.name)}" + if major_version > "91" and pname.startswith("google-chrome"): + # To avoid a GPU crash: + options += ["--use-gl=angle", "--use-angle=swiftshader"] + options.append("file://${startupHTML}") + # Launch the process: + machine.succeed(ru(f'ulimit -c unlimited; {binary} {shlex.join(options)} & disown')) + if binary.startswith("google-chrome"): + # Need to click away the first window: + machine.wait_for_text("Make Google Chrome the default browser") + machine.screenshot("google_chrome_default_browser_prompt") + machine.send_key("ret") def create_new_win(): @@ -124,24 +142,32 @@ mapAttrs (channel: chromiumPkg: makeTest rec { @contextmanager - def test_new_win(description): + def test_new_win(description, url, window_name): create_new_win() + machine.wait_for_window("New Tab") + machine.send_chars(f"{url}\n") + machine.wait_for_window(window_name) + machine.screenshot(description) + machine.succeed( + ru( + "${xdo "copy-all" '' + key --delay 1000 Ctrl+a Ctrl+c + ''}" + ) + ) + clipboard = machine.succeed( + ru("${pkgs.xclip}/bin/xclip -o") + ) + print(f"{description} window content:\n{clipboard}") with machine.nested(description): - yield + yield clipboard # Close the newly created window: machine.send_key("ctrl-w") machine.wait_for_x() - url = "file://${startupHTML}" - machine.succeed(ru(f'ulimit -c unlimited; "{get_browser_binary()}" "{url}" & disown')) - - if get_browser_binary().startswith("google-chrome"): - # Need to click away the first window: - machine.wait_for_text("Make Google Chrome the default browser") - machine.screenshot("google_chrome_default_browser_prompt") - machine.send_key("ret") + launch_browser() machine.wait_for_text("startup done") machine.wait_until_succeeds( @@ -164,49 +190,7 @@ mapAttrs (channel: chromiumPkg: makeTest rec { machine.screenshot("startup_done") - with test_new_win("check sandbox"): - machine.succeed( - ru( - "${xdo "type-url" '' - search --sync --onlyvisible --name "New Tab" - windowfocus --sync - type --delay 1000 "chrome://sandbox" - ''}" - ) - ) - - machine.succeed( - ru( - "${xdo "submit-url" '' - search --sync --onlyvisible --name "New Tab" - windowfocus --sync - key --delay 1000 Return - ''}" - ) - ) - - machine.screenshot("sandbox_info") - - machine.succeed( - ru( - "${xdo "find-window" '' - search --sync --onlyvisible --name "Sandbox Status" - windowfocus --sync - ''}" - ) - ) - machine.succeed( - ru( - "${xdo "copy-sandbox-info" '' - key --delay 1000 Ctrl+a Ctrl+c - ''}" - ) - ) - - clipboard = machine.succeed( - ru("${pkgs.xclip}/bin/xclip -o") - ) - + with test_new_win("sandbox_info", "chrome://sandbox", "Sandbox Status") as clipboard: filters = [ "layer 1 sandbox.*namespace", "pid namespaces.*yes", @@ -253,6 +237,12 @@ mapAttrs (channel: chromiumPkg: makeTest rec { machine.screenshot("after_copy_from_chromium") + + with test_new_win("gpu_info", "chrome://gpu", "chrome://gpu"): + # To check the text rendering (catches regressions like #131074): + machine.wait_for_text("Graphics Feature Status") + + machine.shutdown() ''; }) channelMap diff --git a/nixos/tests/coturn.nix b/nixos/tests/coturn.nix new file mode 100644 index 00000000000..dff832281c7 --- /dev/null +++ b/nixos/tests/coturn.nix @@ -0,0 +1,29 @@ +import ./make-test-python.nix ({ ... }: { + name = "coturn"; + nodes = { + default = { + services.coturn.enable = true; + }; + secretsfile = { + boot.postBootCommands = '' + echo "some-very-secret-string" > /run/coturn-secret + ''; + services.coturn = { + enable = true; + static-auth-secret-file = "/run/coturn-secret"; + }; + }; + }; + + testScript = + '' + start_all() + + with subtest("by default works without configuration"): + default.wait_for_unit("coturn.service") + + with subtest("works with static-auth-secret-file"): + secretsfile.wait_for_unit("coturn.service") + secretsfile.succeed("grep 'some-very-secret-string' /run/coturn/turnserver.cfg") + ''; +}) diff --git a/nixos/tests/custom-ca.nix b/nixos/tests/custom-ca.nix index 7ce1101911d..26f29a3e68f 100644 --- a/nixos/tests/custom-ca.nix +++ b/nixos/tests/custom-ca.nix @@ -107,8 +107,15 @@ in ''; }; - environment.systemPackages = with pkgs; - [ xdotool firefox chromium falkon midori ]; + environment.systemPackages = with pkgs; [ + xdotool + # Firefox was disabled here, because we needed to disable p11-kit support in nss, + # which is why it will not use the system certificate store for the time being. + # firefox + chromium + falkon + midori + ]; }; testScript = '' @@ -145,7 +152,14 @@ in with subtest("Unknown CA is untrusted in curl"): machine.fail("curl -fv https://bad.example.com") - browsers = ["firefox", "chromium", "falkon", "midori"] + browsers = [ + # Firefox was disabled here, because we needed to disable p11-kit support in nss, + # which is why it will not use the system certificate store for the time being. + # "firefox", + "chromium", + "falkon", + "midori" + ] errors = ["Security Risk", "not private", "Certificate Error", "Security"] machine.wait_for_x() diff --git a/nixos/tests/discourse.nix b/nixos/tests/discourse.nix index 3c965550fe0..2ed6fb957c2 100644 --- a/nixos/tests/discourse.nix +++ b/nixos/tests/discourse.nix @@ -51,6 +51,8 @@ import ./make-test-python.nix ( environment.systemPackages = [ pkgs.jq ]; + services.postgresql.package = pkgs.postgresql_13; + services.discourse = { enable = true; inherit admin; diff --git a/nixos/tests/docker-tools.nix b/nixos/tests/docker-tools.nix index 39b97b4cb99..4c3c26980aa 100644 --- a/nixos/tests/docker-tools.nix +++ b/nixos/tests/docker-tools.nix @@ -20,6 +20,20 @@ import ./make-test-python.nix ({ pkgs, ... }: { docker.wait_for_unit("sockets.target") + with subtest("includeStorePath"): + with subtest("assumption"): + docker.succeed("${examples.helloOnRoot} | docker load") + docker.succeed("docker run --rm hello | grep -i hello") + docker.succeed("docker image rm hello:latest") + with subtest("includeStorePath = false; breaks example"): + docker.succeed("${examples.helloOnRootNoStore} | docker load") + docker.fail("docker run --rm hello | grep -i hello") + docker.succeed("docker image rm hello:latest") + with subtest("includeStorePath = false; works with mounted store"): + docker.succeed("${examples.helloOnRootNoStore} | docker load") + docker.succeed("docker run --rm --volume ${builtins.storeDir}:${builtins.storeDir}:ro hello | grep -i hello") + docker.succeed("docker image rm hello:latest") + with subtest("Ensure Docker images use a stable date by default"): docker.succeed( "docker load --input='${examples.bash}'" diff --git a/nixos/tests/doh-proxy-rust.nix b/nixos/tests/doh-proxy-rust.nix index ca150cafab5..23f8616849c 100644 --- a/nixos/tests/doh-proxy-rust.nix +++ b/nixos/tests/doh-proxy-rust.nix @@ -38,6 +38,6 @@ import ./make-test-python.nix ({ lib, pkgs, ... }: { machine.wait_for_unit("doh-proxy-rust.service") machine.wait_for_open_port(53) machine.wait_for_open_port(3000) - machine.succeed(f"curl --fail '{url}?dns={query}' | grep -qF {bin_ip}") + machine.succeed(f"curl --fail '{url}?dns={query}' | grep -F {bin_ip}") ''; }) diff --git a/nixos/tests/elk.nix b/nixos/tests/elk.nix index fee350de65b..2a1a4cba295 100644 --- a/nixos/tests/elk.nix +++ b/nixos/tests/elk.nix @@ -56,6 +56,24 @@ let ''); }; + metricbeat = { + enable = true; + package = elk.metricbeat; + modules.system = { + metricsets = ["cpu" "load" "memory" "network" "process" "process_summary" "uptime" "socket_summary"]; + enabled = true; + period = "5s"; + processes = [".*"]; + cpu.metrics = ["percentages" "normalized_percentages"]; + core.metrics = ["percentages"]; + }; + settings = { + output.elasticsearch = { + hosts = ["127.0.0.1:9200"]; + }; + }; + }; + logstash = { enable = true; package = elk.logstash; @@ -135,6 +153,16 @@ let ) + def has_metricbeat(): + dictionary = {"query": {"match": {"event.dataset": {"query": "system.cpu"}}}} + return ( + "curl --silent --show-error '${esUrl}/_search' " + + "-H 'Content-Type: application/json' " + + "-d '{}' ".format(json.dumps(dictionary)) + + "| jq '.hits.total > 0'" + ) + + start_all() one.wait_for_unit("elasticsearch.service") @@ -161,6 +189,12 @@ let "curl --silent --show-error 'http://localhost:5601/api/status' | jq .status.overall.state | grep green" ) + with subtest("Metricbeat is running"): + one.wait_for_unit("metricbeat.service") + + with subtest("Metricbeat metrics arrive in elasticsearch"): + one.wait_until_succeeds(has_metricbeat() + " | tee /dev/console | grep 'true'") + with subtest("Logstash messages arive in elasticsearch"): one.wait_until_succeeds(total_hits("flowers") + " | grep -v 0") one.wait_until_succeeds(total_hits("dragons") + " | grep 0") @@ -178,7 +212,7 @@ let one.systemctl("stop logstash") one.systemctl("start elasticsearch-curator") one.wait_until_succeeds( - '! curl --silent --show-error "${esUrl}/_cat/indices" | grep logstash | grep -q ^' + '! curl --silent --show-error "${esUrl}/_cat/indices" | grep logstash | grep ^' ) ''; }) {}; @@ -190,12 +224,14 @@ in pkgs.lib.mapAttrs mkElkTest { logstash = pkgs.logstash6; kibana = pkgs.kibana6; journalbeat = pkgs.journalbeat6; + metricbeat = pkgs.metricbeat6; } else { elasticsearch = pkgs.elasticsearch6-oss; logstash = pkgs.logstash6-oss; kibana = pkgs.kibana6-oss; journalbeat = pkgs.journalbeat6; + metricbeat = pkgs.metricbeat6; }; ELK-7 = if enableUnfree @@ -204,11 +240,13 @@ in pkgs.lib.mapAttrs mkElkTest { logstash = pkgs.logstash7; kibana = pkgs.kibana7; journalbeat = pkgs.journalbeat7; + metricbeat = pkgs.metricbeat7; } else { elasticsearch = pkgs.elasticsearch7-oss; logstash = pkgs.logstash7-oss; kibana = pkgs.kibana7-oss; journalbeat = pkgs.journalbeat7; + metricbeat = pkgs.metricbeat7; }; } diff --git a/nixos/tests/firefox.nix b/nixos/tests/firefox.nix index 4262f5443bf..2e27ac302af 100644 --- a/nixos/tests/firefox.nix +++ b/nixos/tests/firefox.nix @@ -46,7 +46,7 @@ import ./make-test-python.nix ({ pkgs, esr ? false, ... }: { systemd.services.audio-recorder = { description = "Record NixOS test audio to /tmp/record.wav"; - script = "${pkgs.alsaUtils}/bin/arecord -D recorder -f S16_LE -r48000 /tmp/record.wav"; + script = "${pkgs.alsa-utils}/bin/arecord -D recorder -f S16_LE -r48000 /tmp/record.wav"; }; }; diff --git a/nixos/tests/gitlab.nix b/nixos/tests/gitlab.nix index af2ab12bf4b..696ebabb580 100644 --- a/nixos/tests/gitlab.nix +++ b/nixos/tests/gitlab.nix @@ -102,7 +102,7 @@ import ./make-test-python.nix ({ pkgs, lib, ...} : with lib; { # `doSetup` is is true. test = doSetup: '' gitlab.succeed( - "curl -isSf http://gitlab | grep -i location | grep -q http://gitlab/users/sign_in" + "curl -isSf http://gitlab | grep -i location | grep http://gitlab/users/sign_in" ) gitlab.succeed( "${pkgs.sudo}/bin/sudo -u gitlab -H gitlab-rake gitlab:check 1>&2" diff --git a/nixos/tests/go-neb.nix b/nixos/tests/go-neb.nix index f8801ff68d6..4bd03dcf3c6 100644 --- a/nixos/tests/go-neb.nix +++ b/nixos/tests/go-neb.nix @@ -10,10 +10,11 @@ import ./make-test-python.nix ({ pkgs, ... }: services.go-neb = { enable = true; baseUrl = "http://localhost"; + secretFile = pkgs.writeText "secrets" "ACCESS_TOKEN=changeme"; config = { clients = [ { UserId = "@test:localhost"; - AccessToken = "changeme"; + AccessToken = "$ACCESS_TOKEN"; HomeServerUrl = "http://localhost"; Sync = false; AutoJoinRooms = false; @@ -33,11 +34,10 @@ import ./make-test-python.nix ({ pkgs, ... }: testScript = '' start_all() server.wait_for_unit("go-neb.service") - server.wait_until_succeeds( - "curl -fL http://localhost:4050/services/hooks/d2lraXBlZGlhX3NlcnZpY2U" - ) - server.wait_until_succeeds( - "journalctl -eu go-neb -o cat | grep -q service_id=wikipedia_service" + server.wait_until_succeeds("curl -fL http://localhost:4050/services/hooks/d2lraXBlZGlhX3NlcnZpY2U") + server.succeed( + "journalctl -eu go-neb -o cat | grep -q service_id=wikipedia_service", + "grep -q changeme /var/run/go-neb/config.yaml", ) ''; diff --git a/nixos/tests/gocd-agent.nix b/nixos/tests/gocd-agent.nix index 75edf43ee29..686d0b971d3 100644 --- a/nixos/tests/gocd-agent.nix +++ b/nixos/tests/gocd-agent.nix @@ -42,7 +42,7 @@ import ./make-test-python.nix ({ pkgs, ...} : { "curl ${serverUrl} -H '${header}' | ${pkgs.jq}/bin/jq -e ._embedded.agents[0].uuid" ) agent.succeed( - "curl ${serverUrl} -H '${header}' | ${pkgs.jq}/bin/jq -e ._embedded.agents[0].agent_state | grep -q Idle" + "curl ${serverUrl} -H '${header}' | ${pkgs.jq}/bin/jq -e ._embedded.agents[0].agent_state | grep Idle" ) ''; }) diff --git a/nixos/tests/grafana.nix b/nixos/tests/grafana.nix index 4ba091b893f..174d664d877 100644 --- a/nixos/tests/grafana.nix +++ b/nixos/tests/grafana.nix @@ -74,7 +74,7 @@ in { declarativePlugins.wait_for_unit("grafana.service") declarativePlugins.wait_for_open_port(3000) declarativePlugins.succeed( - "curl -sSfN -u testadmin:snakeoilpwd http://127.0.0.1:3000/api/plugins | grep -q grafana-clock-panel" + "curl -sSfN -u testadmin:snakeoilpwd http://127.0.0.1:3000/api/plugins | grep grafana-clock-panel" ) declarativePlugins.shutdown() @@ -82,7 +82,7 @@ in { sqlite.wait_for_unit("grafana.service") sqlite.wait_for_open_port(3000) sqlite.succeed( - "curl -sSfN -u testadmin:snakeoilpwd http://127.0.0.1:3000/api/org/users | grep -q testadmin\@localhost" + "curl -sSfN -u testadmin:snakeoilpwd http://127.0.0.1:3000/api/org/users | grep testadmin\@localhost" ) sqlite.shutdown() @@ -92,7 +92,7 @@ in { postgresql.wait_for_open_port(3000) postgresql.wait_for_open_port(5432) postgresql.succeed( - "curl -sSfN -u testadmin:snakeoilpwd http://127.0.0.1:3000/api/org/users | grep -q testadmin\@localhost" + "curl -sSfN -u testadmin:snakeoilpwd http://127.0.0.1:3000/api/org/users | grep testadmin\@localhost" ) postgresql.shutdown() @@ -102,7 +102,7 @@ in { mysql.wait_for_open_port(3000) mysql.wait_for_open_port(3306) mysql.succeed( - "curl -sSfN -u testadmin:snakeoilpwd http://127.0.0.1:3000/api/org/users | grep -q testadmin\@localhost" + "curl -sSfN -u testadmin:snakeoilpwd http://127.0.0.1:3000/api/org/users | grep testadmin\@localhost" ) mysql.shutdown() ''; diff --git a/nixos/tests/grocy.nix b/nixos/tests/grocy.nix index 220c55b1f63..2be5c24ecb5 100644 --- a/nixos/tests/grocy.nix +++ b/nixos/tests/grocy.nix @@ -40,7 +40,7 @@ import ./make-test-python.nix ({ pkgs, ... }: { assert task_name == "Test Task" - machine.succeed("curl -sSfI http://localhost/api/tasks 2>&1 | grep '401 Unauthorized'") + machine.succeed("curl -sSI http://localhost/api/tasks 2>&1 | grep '401 Unauthorized'") machine.shutdown() ''; diff --git a/nixos/tests/hockeypuck.nix b/nixos/tests/hockeypuck.nix new file mode 100644 index 00000000000..79313f314fd --- /dev/null +++ b/nixos/tests/hockeypuck.nix @@ -0,0 +1,63 @@ +import ./make-test-python.nix ({ lib, pkgs, ... }: +let + gpgKeyring = (pkgs.runCommandNoCC "gpg-keyring" { buildInputs = [ pkgs.gnupg ]; } '' + mkdir -p $out + export GNUPGHOME=$out + cat > foo <<EOF + %echo Generating a basic OpenPGP key + %no-protection + Key-Type: DSA + Key-Length: 1024 + Subkey-Type: ELG-E + Subkey-Length: 1024 + Name-Real: Foo Example + Name-Email: foo@example.org + Expire-Date: 0 + # Do a commit here, so that we can later print "done" + %commit + %echo done + EOF + gpg --batch --generate-key foo + rm $out/S.gpg-agent $out/S.gpg-agent.* + ''); +in { + name = "hockeypuck"; + meta.maintainers = with lib.maintainers; [ etu ]; + + machine = { ... }: { + # Used for test + environment.systemPackages = [ pkgs.gnupg ]; + + services.hockeypuck.enable = true; + + services.postgresql = { + enable = true; + ensureDatabases = [ "hockeypuck" ]; + ensureUsers = [{ + name = "hockeypuck"; + ensurePermissions."DATABASE hockeypuck" = "ALL PRIVILEGES"; + }]; + }; + }; + + testScript = '' + machine.wait_for_unit("hockeypuck.service") + machine.wait_for_open_port(11371) + + response = machine.succeed("curl -vvv -s http://127.0.0.1:11371/") + + assert "<title>OpenPGP Keyserver</title>" in response, "HTML title not found" + + # Copy the keyring + machine.succeed("cp -R ${gpgKeyring} /tmp/GNUPGHOME") + + # Extract our GPG key id + keyId = machine.succeed("GNUPGHOME=/tmp/GNUPGHOME gpg --list-keys | grep dsa1024 --after-context=1 | grep -v dsa1024").strip() + + # Send the key to our local keyserver + machine.succeed("GNUPGHOME=/tmp/GNUPGHOME gpg --keyserver hkp://127.0.0.1:11371 --send-keys " + keyId) + + # Recieve the key from our local keyserver to a separate directory + machine.succeed("GNUPGHOME=$(mktemp -d) gpg --keyserver hkp://127.0.0.1:11371 --recv-keys " + keyId) + ''; +}) diff --git a/nixos/tests/home-assistant.nix b/nixos/tests/home-assistant.nix index c75dd248ecb..699be8fd7dc 100644 --- a/nixos/tests/home-assistant.nix +++ b/nixos/tests/home-assistant.nix @@ -23,8 +23,6 @@ in { services.home-assistant = { inherit configDir; enable = true; - # includes the package with all tests enabled - package = pkgs.home-assistant; config = { homeassistant = { name = "Home"; @@ -45,6 +43,7 @@ in { payload_on = "let_there_be_light"; payload_off = "off"; }]; + # tests component-based capability assignment (CAP_NET_BIND_SERVICE) emulated_hue = { host_ip = "127.0.0.1"; listen_port = 80; @@ -100,6 +99,7 @@ in { assert "let_there_be_light" in output_log with subtest("Check systemd unit hardening"): + hass.log(hass.succeed("systemctl show home-assistant.service")) hass.log(hass.succeed("systemd-analyze security home-assistant.service")) ''; }) diff --git a/nixos/tests/jenkins-cli.nix b/nixos/tests/jenkins-cli.nix new file mode 100644 index 00000000000..f25e1604da3 --- /dev/null +++ b/nixos/tests/jenkins-cli.nix @@ -0,0 +1,30 @@ +import ./make-test-python.nix ({ pkgs, ...} : rec { + name = "jenkins-cli"; + meta = with pkgs.lib.maintainers; { + maintainers = [ pamplemousse ]; + }; + + nodes = { + machine = + { ... }: + { + services.jenkins = { + enable = true; + withCLI = true; + }; + }; + }; + + testScript = '' + start_all() + + machine.wait_for_unit("jenkins") + + assert "JENKINS_URL" in machine.succeed("env") + assert "http://0.0.0.0:8080" in machine.succeed("echo $JENKINS_URL") + + machine.succeed( + "jenkins-cli -auth admin:$(cat /var/lib/jenkins/secrets/initialAdminPassword)" + ) + ''; +}) diff --git a/nixos/tests/jenkins.nix b/nixos/tests/jenkins.nix index 5898adab759..cb4207c6e77 100644 --- a/nixos/tests/jenkins.nix +++ b/nixos/tests/jenkins.nix @@ -2,6 +2,7 @@ # 1. jenkins service starts on master node # 2. jenkins user can be extended on both master and slave # 3. jenkins service not started on slave node +# 4. declarative jobs can be added and removed import ./make-test-python.nix ({ pkgs, ...} : { name = "jenkins"; @@ -13,7 +14,45 @@ import ./make-test-python.nix ({ pkgs, ...} : { master = { ... }: - { services.jenkins.enable = true; + { services.jenkins = { + enable = true; + jobBuilder = { + enable = true; + nixJobs = [ + { job = { + name = "job-1"; + builders = [ + { shell = '' + echo "Running job-1" + ''; + } + ]; + }; + } + + { job = { + name = "folder-1"; + project-type = "folder"; + }; + } + + { job = { + name = "folder-1/job-2"; + builders = [ + { shell = '' + echo "Running job-2" + ''; + } + ]; + }; + } + ]; + }; + }; + + specialisation.noJenkinsJobs.configuration = { + services.jenkins.jobBuilder.nixJobs = pkgs.lib.mkForce []; + }; # should have no effect services.jenkinsSlave.enable = true; @@ -32,7 +71,12 @@ import ./make-test-python.nix ({ pkgs, ...} : { }; - testScript = '' + testScript = { nodes, ... }: + let + configWithoutJobs = "${nodes.master.config.system.build.toplevel}/specialisation/noJenkinsJobs"; + jenkinsPort = nodes.master.config.services.jenkins.port; + jenkinsUrl = "http://localhost:${toString jenkinsPort}"; + in '' start_all() master.wait_for_unit("jenkins") @@ -45,5 +89,42 @@ import ./make-test-python.nix ({ pkgs, ...} : { assert "users" in groups slave.fail("systemctl is-enabled jenkins.service") + + with subtest("jobs are declarative"): + # Check that jobs are created on disk. + master.wait_for_unit("jenkins-job-builder") + master.wait_until_fails("systemctl is-active jenkins-job-builder") + master.wait_until_succeeds("test -f /var/lib/jenkins/jobs/job-1/config.xml") + master.wait_until_succeeds("test -f /var/lib/jenkins/jobs/folder-1/config.xml") + master.wait_until_succeeds("test -f /var/lib/jenkins/jobs/folder-1/jobs/job-2/config.xml") + + # Wait until jenkins is ready, reload configuration and verify it also + # sees the jobs. + master.succeed("curl --fail ${jenkinsUrl}/cli") + master.succeed("curl ${jenkinsUrl}/jnlpJars/jenkins-cli.jar -O") + master.succeed("${pkgs.jre}/bin/java -jar jenkins-cli.jar -s ${jenkinsUrl} -auth admin:$(cat /var/lib/jenkins/secrets/initialAdminPassword) reload-configuration") + out = master.succeed("${pkgs.jre}/bin/java -jar jenkins-cli.jar -s ${jenkinsUrl} -auth admin:$(cat /var/lib/jenkins/secrets/initialAdminPassword) list-jobs") + jobs = [x.strip() for x in out.splitlines()] + # Seeing jobs inside folders requires the Folders plugin + # (https://plugins.jenkins.io/cloudbees-folder/), which we don't have + # in this vanilla jenkins install, so limit ourself to non-folder jobs. + assert jobs == ['job-1'], f"jobs != ['job-1']: {jobs}" + + master.succeed( + "${configWithoutJobs}/bin/switch-to-configuration test >&2" + ) + + # Check that jobs are removed from disk. + master.wait_for_unit("jenkins-job-builder") + master.wait_until_fails("systemctl is-active jenkins-job-builder") + master.wait_until_fails("test -f /var/lib/jenkins/jobs/job-1/config.xml") + master.wait_until_fails("test -f /var/lib/jenkins/jobs/folder-1/config.xml") + master.wait_until_fails("test -f /var/lib/jenkins/jobs/folder-1/jobs/job-2/config.xml") + + # Reload jenkins' configuration and verify it also sees the jobs as removed. + master.succeed("${pkgs.jre}/bin/java -jar jenkins-cli.jar -s ${jenkinsUrl} -auth admin:$(cat /var/lib/jenkins/secrets/initialAdminPassword) reload-configuration") + out = master.succeed("${pkgs.jre}/bin/java -jar jenkins-cli.jar -s ${jenkinsUrl} -auth admin:$(cat /var/lib/jenkins/secrets/initialAdminPassword) list-jobs") + jobs = [x.strip() for x in out.splitlines()] + assert jobs == [], f"jobs != []: {jobs}" ''; }) diff --git a/nixos/tests/jitsi-meet.nix b/nixos/tests/jitsi-meet.nix index dec49c83121..f9a0b121a2b 100644 --- a/nixos/tests/jitsi-meet.nix +++ b/nixos/tests/jitsi-meet.nix @@ -8,6 +8,7 @@ import ./make-test-python.nix ({ pkgs, ... }: { client = { nodes, pkgs, ... }: { }; server = { config, pkgs, ... }: { + virtualisation.memorySize = 512; services.jitsi-meet = { enable = true; hostName = "server"; @@ -37,15 +38,9 @@ import ./make-test-python.nix ({ pkgs, ... }: { "journalctl -b -u jitsi-videobridge2 -o cat | grep -q 'Performed a successful health check'" ) server.wait_until_succeeds( - "journalctl -b -u jicofo -o cat | grep -q 'connected .JID: focus@auth.server'" - ) - server.wait_until_succeeds( "journalctl -b -u prosody -o cat | grep -q 'Authenticated as focus@auth.server'" ) server.wait_until_succeeds( - "journalctl -b -u prosody -o cat | grep -q 'focus.server:component: External component successfully authenticated'" - ) - server.wait_until_succeeds( "journalctl -b -u prosody -o cat | grep -q 'Authenticated as jvb@auth.server'" ) diff --git a/nixos/tests/kbd-setfont-decompress.nix b/nixos/tests/kbd-setfont-decompress.nix new file mode 100644 index 00000000000..c3a495afac8 --- /dev/null +++ b/nixos/tests/kbd-setfont-decompress.nix @@ -0,0 +1,21 @@ +import ./make-test-python.nix ({ lib, pkgs, ... }: +{ + name = "kbd-setfont-decompress"; + + meta.maintainers = with lib.maintainers; [ oxalica ]; + + machine = { ... }: {}; + + testScript = '' + machine.succeed("gzip -cd ${pkgs.terminus_font}/share/consolefonts/ter-v16b.psf.gz >font.psf") + machine.succeed("gzip <font.psf >font.psf.gz") + machine.succeed("bzip2 <font.psf >font.psf.bz2") + machine.succeed("xz <font.psf >font.psf.xz") + machine.succeed("zstd <font.psf >font.psf.zst") + # setfont returns 0 even on error. + assert machine.succeed("PATH= ${pkgs.kbd}/bin/setfont font.psf.gz 2>&1") == "" + assert machine.succeed("PATH= ${pkgs.kbd}/bin/setfont font.psf.bz2 2>&1") == "" + assert machine.succeed("PATH= ${pkgs.kbd}/bin/setfont font.psf.xz 2>&1") == "" + assert machine.succeed("PATH= ${pkgs.kbd}/bin/setfont font.psf.zst 2>&1") == "" + ''; +}) diff --git a/nixos/tests/kea.nix b/nixos/tests/kea.nix new file mode 100644 index 00000000000..6b345893108 --- /dev/null +++ b/nixos/tests/kea.nix @@ -0,0 +1,73 @@ +import ./make-test-python.nix ({ pkgs, lib, ...}: { + meta.maintainers = with lib.maintainers; [ hexa ]; + + nodes = { + router = { config, pkgs, ... }: { + virtualisation.vlans = [ 1 ]; + + networking = { + useNetworkd = true; + useDHCP = false; + firewall.allowedUDPPorts = [ 67 ]; + }; + + systemd.network = { + networks = { + "01-eth1" = { + name = "eth1"; + networkConfig = { + Address = "10.0.0.1/30"; + }; + }; + }; + }; + + services.kea.dhcp4 = { + enable = true; + settings = { + valid-lifetime = 3600; + renew-timer = 900; + rebind-timer = 1800; + + lease-database = { + type = "memfile"; + persist = true; + name = "/var/lib/kea/dhcp4.leases"; + }; + + interfaces-config = { + dhcp-socket-type = "raw"; + interfaces = [ + "eth1" + ]; + }; + + subnet4 = [ { + subnet = "10.0.0.0/30"; + pools = [ { + pool = "10.0.0.2 - 10.0.0.2"; + } ]; + } ]; + }; + }; + }; + + client = { config, pkgs, ... }: { + virtualisation.vlans = [ 1 ]; + systemd.services.systemd-networkd.environment.SYSTEMD_LOG_LEVEL = "debug"; + networking = { + useNetworkd = true; + useDHCP = false; + firewall.enable = false; + interfaces.eth1.useDHCP = true; + }; + }; + }; + testScript = { ... }: '' + start_all() + router.wait_for_unit("kea-dhcp4-server.service") + client.wait_for_unit("systemd-networkd-wait-online.service") + client.wait_until_succeeds("ping -c 5 10.0.0.1") + router.wait_until_succeeds("ping -c 5 10.0.0.2") + ''; +}) diff --git a/nixos/tests/kernel-generic.nix b/nixos/tests/kernel-generic.nix index a300609cf2b..cd32049dff4 100644 --- a/nixos/tests/kernel-generic.nix +++ b/nixos/tests/kernel-generic.nix @@ -31,8 +31,8 @@ with pkgs; { linux_4_19 = makeKernelTest "4.19" linuxPackages_4_19; linux_5_4 = makeKernelTest "5.4" linuxPackages_5_4; linux_5_10 = makeKernelTest "5.10" linuxPackages_5_10; - linux_5_11 = makeKernelTest "5.11" linuxPackages_5_11; linux_5_12 = makeKernelTest "5.12" linuxPackages_5_12; + linux_5_13 = makeKernelTest "5.13" linuxPackages_5_13; linux_testing = makeKernelTest "testing" linuxPackages_testing; } diff --git a/nixos/tests/kubernetes/base.nix b/nixos/tests/kubernetes/base.nix index 8cfac10b6dc..1f23ca55fb2 100644 --- a/nixos/tests/kubernetes/base.nix +++ b/nixos/tests/kubernetes/base.nix @@ -40,7 +40,7 @@ let allowedTCPPorts = [ 10250 # kubelet ]; - trustedInterfaces = ["docker0"]; + trustedInterfaces = ["mynet"]; extraCommands = concatMapStrings (node: '' iptables -A INPUT -s ${node.config.networking.primaryIPAddress} -j ACCEPT @@ -61,6 +61,13 @@ let advertiseAddress = master.ip; }; masterAddress = "${masterName}.${config.networking.domain}"; + # workaround for: + # https://github.com/kubernetes/kubernetes/issues/102676 + # (workaround from) https://github.com/kubernetes/kubernetes/issues/95488 + kubelet.extraOpts = ''\ + --cgroups-per-qos=false \ + --enforce-node-allocatable="" \ + ''; }; } (optionalAttrs (any (role: role == "master") machine.roles) { diff --git a/nixos/tests/lxd.nix b/nixos/tests/lxd.nix index ab56b75c02e..889ca9598e3 100644 --- a/nixos/tests/lxd.nix +++ b/nixos/tests/lxd.nix @@ -96,6 +96,7 @@ in { ## limits.cpu ## machine.succeed("lxc config set test limits.cpu 1") + machine.succeed("lxc restart test") # Since Alpine doesn't have `nproc` pre-installed, we've gotta resort # to the primal methods @@ -105,6 +106,7 @@ in { ) machine.succeed("lxc config set test limits.cpu 2") + machine.succeed("lxc restart test") assert ( "2" @@ -115,6 +117,7 @@ in { ## limits.memory ## machine.succeed("lxc config set test limits.memory 64MB") + machine.succeed("lxc restart test") assert ( "MemTotal: 62500 kB" @@ -122,6 +125,7 @@ in { ) machine.succeed("lxc config set test limits.memory 128MB") + machine.succeed("lxc restart test") assert ( "MemTotal: 125000 kB" diff --git a/nixos/tests/make-test-python.nix b/nixos/tests/make-test-python.nix index 89897fe7e61..7a96f538d8d 100644 --- a/nixos/tests/make-test-python.nix +++ b/nixos/tests/make-test-python.nix @@ -1,6 +1,6 @@ f: { system ? builtins.currentSystem, - pkgs ? import ../.. { inherit system; config = {}; }, + pkgs ? import ../.. { inherit system; }, ... } @ args: diff --git a/nixos/tests/matomo.nix b/nixos/tests/matomo.nix index 2bea237c8bd..f6b0845749c 100644 --- a/nixos/tests/matomo.nix +++ b/nixos/tests/matomo.nix @@ -18,7 +18,7 @@ let }; services.mysql = { enable = true; - package = pkgs.mysql; + package = pkgs.mariadb; }; services.nginx.enable = true; }; diff --git a/nixos/tests/miniflux.nix b/nixos/tests/miniflux.nix index 797a2787d1a..9a25a9e77cc 100644 --- a/nixos/tests/miniflux.nix +++ b/nixos/tests/miniflux.nix @@ -48,23 +48,23 @@ with lib; default.wait_for_unit("miniflux.service") default.wait_for_open_port(${toString defaultPort}) - default.succeed("curl --fail 'http://localhost:${toString defaultPort}/healthcheck' | grep -q OK") + default.succeed("curl --fail 'http://localhost:${toString defaultPort}/healthcheck' | grep OK") default.succeed( - "curl 'http://localhost:${toString defaultPort}/v1/me' -u '${defaultUsername}:${defaultPassword}' -H Content-Type:application/json | grep -q '\"is_admin\":true'" + "curl 'http://localhost:${toString defaultPort}/v1/me' -u '${defaultUsername}:${defaultPassword}' -H Content-Type:application/json | grep '\"is_admin\":true'" ) withoutSudo.wait_for_unit("miniflux.service") withoutSudo.wait_for_open_port(${toString defaultPort}) - withoutSudo.succeed("curl --fail 'http://localhost:${toString defaultPort}/healthcheck' | grep -q OK") + withoutSudo.succeed("curl --fail 'http://localhost:${toString defaultPort}/healthcheck' | grep OK") withoutSudo.succeed( - "curl 'http://localhost:${toString defaultPort}/v1/me' -u '${defaultUsername}:${defaultPassword}' -H Content-Type:application/json | grep -q '\"is_admin\":true'" + "curl 'http://localhost:${toString defaultPort}/v1/me' -u '${defaultUsername}:${defaultPassword}' -H Content-Type:application/json | grep '\"is_admin\":true'" ) customized.wait_for_unit("miniflux.service") customized.wait_for_open_port(${toString port}) - customized.succeed("curl --fail 'http://localhost:${toString port}/healthcheck' | grep -q OK") + customized.succeed("curl --fail 'http://localhost:${toString port}/healthcheck' | grep OK") customized.succeed( - "curl 'http://localhost:${toString port}/v1/me' -u '${username}:${password}' -H Content-Type:application/json | grep -q '\"is_admin\":true'" + "curl 'http://localhost:${toString port}/v1/me' -u '${username}:${password}' -H Content-Type:application/json | grep '\"is_admin\":true'" ) ''; }) diff --git a/nixos/tests/mysql/mysql-autobackup.nix b/nixos/tests/mysql/mysql-autobackup.nix index 65576e52a53..b0ec7daaf05 100644 --- a/nixos/tests/mysql/mysql-autobackup.nix +++ b/nixos/tests/mysql/mysql-autobackup.nix @@ -8,7 +8,7 @@ import ./../make-test-python.nix ({ pkgs, lib, ... }: { pkgs, ... }: { services.mysql.enable = true; - services.mysql.package = pkgs.mysql; + services.mysql.package = pkgs.mariadb; services.mysql.initialDatabases = [ { name = "testdb"; schema = ./testdb.sql; } ]; services.automysqlbackup.enable = true; diff --git a/nixos/tests/mysql/mysql-backup.nix b/nixos/tests/mysql/mysql-backup.nix index d428fb6c16e..269fddc66e1 100644 --- a/nixos/tests/mysql/mysql-backup.nix +++ b/nixos/tests/mysql/mysql-backup.nix @@ -10,7 +10,7 @@ import ./../make-test-python.nix ({ pkgs, ... } : { services.mysql = { enable = true; initialDatabases = [ { name = "testdb"; schema = ./testdb.sql; } ]; - package = pkgs.mysql; + package = pkgs.mariadb; }; services.mysqlBackup = { diff --git a/nixos/tests/mysql/mysql-replication.nix b/nixos/tests/mysql/mysql-replication.nix index ad84c801ea1..a52372ca47c 100644 --- a/nixos/tests/mysql/mysql-replication.nix +++ b/nixos/tests/mysql/mysql-replication.nix @@ -17,7 +17,7 @@ in { services.mysql.enable = true; - services.mysql.package = pkgs.mysql; + services.mysql.package = pkgs.mariadb; services.mysql.replication.role = "master"; services.mysql.replication.slaveHost = "%"; services.mysql.replication.masterUser = replicateUser; @@ -31,7 +31,7 @@ in { services.mysql.enable = true; - services.mysql.package = pkgs.mysql; + services.mysql.package = pkgs.mariadb; services.mysql.replication.role = "slave"; services.mysql.replication.serverId = 2; services.mysql.replication.masterHost = nodes.master.config.networking.hostName; @@ -44,7 +44,7 @@ in { services.mysql.enable = true; - services.mysql.package = pkgs.mysql; + services.mysql.package = pkgs.mariadb; services.mysql.replication.role = "slave"; services.mysql.replication.serverId = 3; services.mysql.replication.masterHost = nodes.master.config.networking.hostName; diff --git a/nixos/tests/mysql/mysql.nix b/nixos/tests/mysql/mysql.nix index c21136416d4..2ec9c3d50a3 100644 --- a/nixos/tests/mysql/mysql.nix +++ b/nixos/tests/mysql/mysql.nix @@ -98,7 +98,7 @@ import ./../make-test-python.nix ({ pkgs, ...} : { }]; services.mysql.settings = { mysqld = { - plugin-load-add = [ "ha_rocksdb.so" ]; + plugin-load-add = [ "ha_mroonga.so" "ha_rocksdb.so" ]; }; }; services.mysql.package = pkgs.mariadb; @@ -172,6 +172,20 @@ import ./../make-test-python.nix ({ pkgs, ...} : { "echo 'use testdb; select test_id from tests;' | sudo -u testuser mysql -u testuser -N | grep 42" ) + # Check if Mroonga plugin works + mariadb.succeed( + "echo 'use testdb; create table mroongadb (test_id INT, PRIMARY KEY (test_id)) ENGINE = Mroonga;' | sudo -u testuser mysql -u testuser" + ) + mariadb.succeed( + "echo 'use testdb; insert into mroongadb values (25);' | sudo -u testuser mysql -u testuser" + ) + mariadb.succeed( + "echo 'use testdb; select test_id from mroongadb;' | sudo -u testuser mysql -u testuser -N | grep 25" + ) + mariadb.succeed( + "echo 'use testdb; drop table mroongadb;' | sudo -u testuser mysql -u testuser" + ) + # Check if RocksDB plugin works mariadb.succeed( "echo 'use testdb; create table rocksdb (test_id INT, PRIMARY KEY (test_id)) ENGINE = RocksDB;' | sudo -u testuser mysql -u testuser" diff --git a/nixos/tests/nginx-variants.nix b/nixos/tests/nginx-variants.nix index ca4655391bc..96a9a2c3b8c 100644 --- a/nixos/tests/nginx-variants.nix +++ b/nixos/tests/nginx-variants.nix @@ -29,5 +29,5 @@ builtins.listToAttrs ( }; } ) - [ "nginxStable" "nginxUnstable" "nginxShibboleth" "openresty" "tengine" ] + [ "nginxStable" "nginxMainline" "nginxQuic" "nginxShibboleth" "openresty" "tengine" ] ) diff --git a/nixos/tests/nginx.nix b/nixos/tests/nginx.nix index 5686afcd043..d9d073822a1 100644 --- a/nixos/tests/nginx.nix +++ b/nixos/tests/nginx.nix @@ -56,11 +56,11 @@ import ./make-test-python.nix ({ pkgs, ... }: { }; specialisation.reloadRestartSystem.configuration = { - services.nginx.package = pkgs.nginxUnstable; + services.nginx.package = pkgs.nginxMainline; }; specialisation.reloadWithErrorsSystem.configuration = { - services.nginx.package = pkgs.nginxUnstable; + services.nginx.package = pkgs.nginxMainline; services.nginx.virtualHosts."!@$$(#*%".locations."~@#*$*!)".proxyPass = ";;;"; }; }; diff --git a/nixos/tests/nix-serve.nix b/nixos/tests/nix-serve.nix new file mode 100644 index 00000000000..ab82f4be43e --- /dev/null +++ b/nixos/tests/nix-serve.nix @@ -0,0 +1,22 @@ +import ./make-test-python.nix ({ pkgs, ... }: +{ + name = "nix-serve"; + machine = { pkgs, ... }: { + services.nix-serve.enable = true; + environment.systemPackages = [ + pkgs.hello + ]; + }; + testScript = let + pkgHash = builtins.head ( + builtins.match "${builtins.storeDir}/([^-]+).+" (toString pkgs.hello) + ); + in '' + start_all() + machine.wait_for_unit("nix-serve.service") + machine.wait_for_open_port(5000) + machine.succeed( + "curl --fail -g http://0.0.0.0:5000/nar/${pkgHash}.nar -o /tmp/hello.nar" + ) + ''; +}) diff --git a/nixos/tests/overlayfs.nix b/nixos/tests/overlayfs.nix index 142e7d378b2..1768f1fea1e 100644 --- a/nixos/tests/overlayfs.nix +++ b/nixos/tests/overlayfs.nix @@ -15,36 +15,33 @@ import ./make-test-python.nix ({ pkgs, ... }: { # Test ext4 + overlayfs machine.succeed( - """ - mkfs.ext4 -F -L overlay-ext4 /dev/vdb - mount -t ext4 /dev/vdb /tmp/mnt - mkdir -p /tmp/mnt/upper /tmp/mnt/lower /tmp/mnt/work /tmp/mnt/merged - # Setup some existing files - echo 'Replace' > /tmp/mnt/lower/replace.txt - echo 'Append' > /tmp/mnt/lower/append.txt - echo 'Overwrite' > /tmp/mnt/lower/overwrite.txt - mount -t overlay overlay -o lowerdir=/tmp/mnt/lower,upperdir=/tmp/mnt/upper,workdir=/tmp/mnt/work /tmp/mnt/merged - # Test new - echo 'New' > /tmp/mnt/merged/new.txt - [[ "\$(cat /tmp/mnt/merged/new.txt)" == "New" ]] - # Test replace - [[ "\$(cat /tmp/mnt/merged/replace.txt)" == "Replace" ]] - echo 'Replaced' > /tmp/mnt/merged/replace-tmp.txt - mv /tmp/mnt/merged/replace-tmp.txt /tmp/mnt/merged/replace.txt - [[ "\$(cat /tmp/mnt/merged/replace.txt)" == "Replaced" ]] - # Overwrite - [[ "\$(cat /tmp/mnt/merged/overwrite.txt)" == "Overwrite" ]] - echo 'Overwritten' > /tmp/mnt/merged/overwrite.txt - [[ "\$(cat /tmp/mnt/merged/overwrite.txt)" == "Overwritten" ]] - # Test append - [[ "\$(cat /tmp/mnt/merged/append.txt)" == "Append" ]] - echo 'ed' >> /tmp/mnt/merged/append.txt - #"cat /tmp/mnt/merged/append.txt && exit 1 - [[ "\$(cat /tmp/mnt/merged/append.txt)" == "Append\ned" ]] - umount /tmp/mnt/merged - umount /tmp/mnt - udevadm settle - """ + 'mkfs.ext4 -F -L overlay-ext4 /dev/vdb', + 'mount -t ext4 /dev/vdb /tmp/mnt', + 'mkdir -p /tmp/mnt/upper /tmp/mnt/lower /tmp/mnt/work /tmp/mnt/merged', + # Setup some existing files + 'echo Replace > /tmp/mnt/lower/replace.txt', + 'echo Append > /tmp/mnt/lower/append.txt', + 'echo Overwrite > /tmp/mnt/lower/overwrite.txt', + 'mount -t overlay overlay -o lowerdir=/tmp/mnt/lower,upperdir=/tmp/mnt/upper,workdir=/tmp/mnt/work /tmp/mnt/merged', + # Test new + 'echo New > /tmp/mnt/merged/new.txt', + '[[ "$(cat /tmp/mnt/merged/new.txt)" == New ]]', + # Test replace + '[[ "$(cat /tmp/mnt/merged/replace.txt)" == Replace ]]', + 'echo Replaced > /tmp/mnt/merged/replace-tmp.txt', + 'mv /tmp/mnt/merged/replace-tmp.txt /tmp/mnt/merged/replace.txt', + '[[ "$(cat /tmp/mnt/merged/replace.txt)" == Replaced ]]', + # Overwrite + '[[ "$(cat /tmp/mnt/merged/overwrite.txt)" == Overwrite ]]', + 'echo Overwritten > /tmp/mnt/merged/overwrite.txt', + '[[ "$(cat /tmp/mnt/merged/overwrite.txt)" == Overwritten ]]', + # Test append + '[[ "$(cat /tmp/mnt/merged/append.txt)" == Append ]]', + 'echo ed >> /tmp/mnt/merged/append.txt', + '[[ "$(cat /tmp/mnt/merged/append.txt)" == "Append\ned" ]]', + 'umount /tmp/mnt/merged', + 'umount /tmp/mnt', + 'udevadm settle', ) ''; }) diff --git a/nixos/tests/php/default.nix b/nixos/tests/php/default.nix index cf78c9db53b..c0386385753 100644 --- a/nixos/tests/php/default.nix +++ b/nixos/tests/php/default.nix @@ -1,5 +1,5 @@ { system ? builtins.currentSystem -, config ? {} +, config ? { } , pkgs ? import ../../.. { inherit system config; } , php ? pkgs.php }: @@ -8,7 +8,8 @@ let php' = php.buildEnv { extensions = { enabled, all }: with all; enabled ++ [ apcu ]; }; -in { +in +{ fpm = import ./fpm.nix { inherit system pkgs; php = php'; }; httpd = import ./httpd.nix { inherit system pkgs; php = php'; }; pcre = import ./pcre.nix { inherit system pkgs; php = php'; }; diff --git a/nixos/tests/php/fpm.nix b/nixos/tests/php/fpm.nix index b11f85d39cb..31a79bb4dbe 100644 --- a/nixos/tests/php/fpm.nix +++ b/nixos/tests/php/fpm.nix @@ -1,4 +1,4 @@ -import ../make-test-python.nix ({pkgs, lib, php, ...}: { +import ../make-test-python.nix ({ pkgs, lib, php, ... }: { name = "php-${php.version}-fpm-nginx-test"; meta.maintainers = lib.teams.php.members; @@ -8,21 +8,23 @@ import ../make-test-python.nix ({pkgs, lib, php, ...}: { services.nginx = { enable = true; - virtualHosts."phpfpm" = let - testdir = pkgs.writeTextDir "web/index.php" "<?php phpinfo();"; - in { - root = "${testdir}/web"; - locations."~ \\.php$".extraConfig = '' - fastcgi_pass unix:${config.services.phpfpm.pools.foobar.socket}; - fastcgi_index index.php; - include ${pkgs.nginx}/conf/fastcgi_params; - include ${pkgs.nginx}/conf/fastcgi.conf; - ''; - locations."/" = { - tryFiles = "$uri $uri/ index.php"; - index = "index.php index.html index.htm"; + virtualHosts."phpfpm" = + let + testdir = pkgs.writeTextDir "web/index.php" "<?php phpinfo();"; + in + { + root = "${testdir}/web"; + locations."~ \\.php$".extraConfig = '' + fastcgi_pass unix:${config.services.phpfpm.pools.foobar.socket}; + fastcgi_index index.php; + include ${pkgs.nginx}/conf/fastcgi_params; + include ${pkgs.nginx}/conf/fastcgi.conf; + ''; + locations."/" = { + tryFiles = "$uri $uri/ index.php"; + index = "index.php index.html index.htm"; + }; }; - }; }; services.phpfpm.pools."foobar" = { diff --git a/nixos/tests/php/httpd.nix b/nixos/tests/php/httpd.nix index a5ca9b3c5d1..36d90e72d7d 100644 --- a/nixos/tests/php/httpd.nix +++ b/nixos/tests/php/httpd.nix @@ -1,4 +1,4 @@ -import ../make-test-python.nix ({pkgs, lib, php, ...}: { +import ../make-test-python.nix ({ pkgs, lib, php, ... }: { name = "php-${php.version}-httpd-test"; meta.maintainers = lib.teams.php.members; @@ -6,14 +6,16 @@ import ../make-test-python.nix ({pkgs, lib, php, ...}: { services.httpd = { enable = true; adminAddr = "admin@phpfpm"; - virtualHosts."phpfpm" = let - testdir = pkgs.writeTextDir "web/index.php" "<?php phpinfo();"; - in { - documentRoot = "${testdir}/web"; - locations."/" = { - index = "index.php index.html"; + virtualHosts."phpfpm" = + let + testdir = pkgs.writeTextDir "web/index.php" "<?php phpinfo();"; + in + { + documentRoot = "${testdir}/web"; + locations."/" = { + index = "index.php index.html"; + }; }; - }; phpPackage = php; enablePHP = true; }; diff --git a/nixos/tests/php/pcre.nix b/nixos/tests/php/pcre.nix index 97572f63af3..917184b975e 100644 --- a/nixos/tests/php/pcre.nix +++ b/nixos/tests/php/pcre.nix @@ -1,6 +1,7 @@ let testString = "can-use-subgroups"; -in import ../make-test-python.nix ({lib, php, ...}: { +in +import ../make-test-python.nix ({ lib, php, ... }: { name = "php-${php.version}-httpd-pcre-jit-test"; meta.maintainers = lib.teams.php.members; @@ -12,14 +13,15 @@ in import ../make-test-python.nix ({lib, php, ...}: { phpPackage = php; enablePHP = true; phpOptions = "pcre.jit = true"; - extraConfig = let - testRoot = pkgs.writeText "index.php" - '' - <?php - preg_match('/(${testString})/', '${testString}', $result); - var_dump($result); - ''; - in + extraConfig = + let + testRoot = pkgs.writeText "index.php" + '' + <?php + preg_match('/(${testString})/', '${testString}', $result); + var_dump($result); + ''; + in '' Alias / ${testRoot}/ diff --git a/nixos/tests/plausible.nix b/nixos/tests/plausible.nix new file mode 100644 index 00000000000..45e11f0270e --- /dev/null +++ b/nixos/tests/plausible.nix @@ -0,0 +1,46 @@ +import ./make-test-python.nix ({ pkgs, lib, ... }: { + name = "plausible"; + meta = with lib.maintainers; { + maintainers = [ ma27 ]; + }; + + machine = { pkgs, ... }: { + virtualisation.memorySize = 4096; + services.plausible = { + enable = true; + adminUser = { + email = "admin@example.org"; + passwordFile = "${pkgs.writeText "pwd" "foobar"}"; + activate = true; + }; + server = { + baseUrl = "http://localhost:8000"; + secretKeybaseFile = "${pkgs.writeText "dont-try-this-at-home" "nannannannannannannannannannannannannannannannannannannan_batman!"}"; + }; + }; + }; + + testScript = '' + start_all() + machine.wait_for_unit("plausible.service") + machine.wait_for_open_port(8000) + + machine.succeed("curl -f localhost:8000 >&2") + + csrf_token = machine.succeed( + "curl -c /tmp/cookies localhost:8000/login | grep '_csrf_token' | sed -E 's,.*value=\"(.*)\".*,\\1,g'" + ) + + machine.succeed( + f"curl -b /tmp/cookies -f -X POST localhost:8000/login -F email=admin@example.org -F password=foobar -F _csrf_token={csrf_token.strip()} -D headers" + ) + + # By ensuring that the user is redirected to the dashboard after login, we + # also make sure that the automatic verification of the module works. + machine.succeed( + "[[ $(grep 'location: ' headers | cut -d: -f2- | xargs echo) == /sites* ]]" + ) + + machine.shutdown() + ''; +}) diff --git a/nixos/tests/podman-dnsname.nix b/nixos/tests/podman-dnsname.nix new file mode 100644 index 00000000000..9e4e8fdb08a --- /dev/null +++ b/nixos/tests/podman-dnsname.nix @@ -0,0 +1,42 @@ +import ./make-test-python.nix ( + { pkgs, lib, ... }: + let + inherit (pkgs) writeTextDir python3 curl; + webroot = writeTextDir "index.html" "<h1>Hi</h1>"; + in + { + name = "podman-dnsname"; + meta = { + maintainers = with lib.maintainers; [ roberth ] ++ lib.teams.podman.members; + }; + + nodes = { + podman = { pkgs, ... }: { + virtualisation.podman.enable = true; + virtualisation.podman.defaultNetwork.dnsname.enable = true; + }; + }; + + testScript = '' + podman.wait_for_unit("sockets.target") + + with subtest("DNS works"): # also tests inter-container tcp routing + podman.succeed("tar cvf scratchimg.tar --files-from /dev/null && podman import scratchimg.tar scratchimg") + podman.succeed( + "podman run -d --name=webserver -v /nix/store:/nix/store -v /run/current-system/sw/bin:/bin -w ${webroot} scratchimg ${python3}/bin/python -m http.server 8000" + ) + podman.succeed("podman ps | grep webserver") + podman.succeed(""" + for i in `seq 0 120`; do + podman run --rm --name=client -v /nix/store:/nix/store -v /run/current-system/sw/bin:/bin scratchimg ${curl}/bin/curl http://webserver:8000 >/dev/console \ + && exit 0 + sleep 0.5 + done + exit 1 + """) + podman.succeed("podman stop webserver") + podman.succeed("podman rm webserver") + + ''; + } +) diff --git a/nixos/tests/podman-tls-ghostunnel.nix b/nixos/tests/podman-tls-ghostunnel.nix new file mode 100644 index 00000000000..b5836c43649 --- /dev/null +++ b/nixos/tests/podman-tls-ghostunnel.nix @@ -0,0 +1,150 @@ +/* + This test runs podman as a backend for the Docker CLI. + */ +import ./make-test-python.nix ( + { pkgs, lib, ... }: + + let gen-ca = pkgs.writeScript "gen-ca" '' + # Create CA + PATH="${pkgs.openssl}/bin:$PATH" + openssl genrsa -out ca-key.pem 4096 + openssl req -new -x509 -days 365 -key ca-key.pem -sha256 -subj '/C=NL/ST=Zuid-Holland/L=The Hague/O=Stevige Balken en Planken B.V./OU=OpSec/CN=Certificate Authority' -out ca.pem + + # Create service + openssl genrsa -out podman-key.pem 4096 + openssl req -subj '/CN=podman' -sha256 -new -key podman-key.pem -out service.csr + echo subjectAltName = DNS:podman,IP:127.0.0.1 >> extfile.cnf + echo extendedKeyUsage = serverAuth >> extfile.cnf + openssl x509 -req -days 365 -sha256 -in service.csr -CA ca.pem -CAkey ca-key.pem -CAcreateserial -out podman-cert.pem -extfile extfile.cnf + + # Create client + openssl genrsa -out client-key.pem 4096 + openssl req -subj '/CN=client' -new -key client-key.pem -out client.csr + echo extendedKeyUsage = clientAuth > extfile-client.cnf + openssl x509 -req -days 365 -sha256 -in client.csr -CA ca.pem -CAkey ca-key.pem -CAcreateserial -out client-cert.pem -extfile extfile-client.cnf + + # Create CA 2 + PATH="${pkgs.openssl}/bin:$PATH" + openssl genrsa -out ca-2-key.pem 4096 + openssl req -new -x509 -days 365 -key ca-2-key.pem -sha256 -subj '/C=NL/ST=Zuid-Holland/L=The Hague/O=Stevige Balken en Planken B.V./OU=OpSec/CN=Certificate Authority' -out ca-2.pem + + # Create client signed by CA 2 + openssl genrsa -out client-2-key.pem 4096 + openssl req -subj '/CN=client' -new -key client-2-key.pem -out client-2.csr + echo extendedKeyUsage = clientAuth > extfile-client.cnf + openssl x509 -req -days 365 -sha256 -in client-2.csr -CA ca-2.pem -CAkey ca-2-key.pem -CAcreateserial -out client-2-cert.pem -extfile extfile-client.cnf + + ''; + in + { + name = "podman-tls-ghostunnel"; + meta = { + maintainers = lib.teams.podman.members ++ [ lib.maintainers.roberth ]; + }; + + nodes = { + podman = + { pkgs, ... }: + { + virtualisation.podman.enable = true; + virtualisation.podman.dockerSocket.enable = true; + virtualisation.podman.networkSocket = { + enable = true; + openFirewall = true; + server = "ghostunnel"; + tls.cert = "/root/podman-cert.pem"; + tls.key = "/root/podman-key.pem"; + tls.cacert = "/root/ca.pem"; + }; + + environment.systemPackages = [ + pkgs.docker-client + ]; + + users.users.alice = { + isNormalUser = true; + home = "/home/alice"; + description = "Alice Foobar"; + extraGroups = ["podman"]; + }; + + }; + + client = { ... }: { + environment.systemPackages = [ + # Installs the docker _client_ only + # Normally, you'd want `virtualisation.docker.enable = true;`. + pkgs.docker-client + ]; + environment.variables.DOCKER_HOST = "podman:2376"; + environment.variables.DOCKER_TLS_VERIFY = "1"; + }; + }; + + testScript = '' + import shlex + + + def su_cmd(user, cmd): + cmd = shlex.quote(cmd) + return f"su {user} -l -c {cmd}" + + def cmd(command): + print(f"+{command}") + r = os.system(command) + if r != 0: + raise Exception(f"Command {command} failed with exit code {r}") + + start_all() + cmd("${gen-ca}") + + podman.copy_from_host("ca.pem", "/root/ca.pem") + podman.copy_from_host("podman-cert.pem", "/root/podman-cert.pem") + podman.copy_from_host("podman-key.pem", "/root/podman-key.pem") + + client.copy_from_host("ca.pem", "/root/.docker/ca.pem") + # client.copy_from_host("podman-cert.pem", "/root/podman-cert.pem") + client.copy_from_host("client-cert.pem", "/root/.docker/cert.pem") + client.copy_from_host("client-key.pem", "/root/.docker/key.pem") + + # TODO (ghostunnel): add file watchers so the restart isn't necessary + podman.succeed("systemctl reset-failed && systemctl restart ghostunnel-server-podman-socket.service") + + podman.wait_for_unit("sockets.target") + podman.wait_for_unit("ghostunnel-server-podman-socket.service") + + with subtest("Create default network"): + podman.succeed("docker network create default") + + with subtest("Root docker cli also works"): + podman.succeed("docker version") + + with subtest("A podman member can also still use the docker cli"): + podman.succeed(su_cmd("alice", "docker version")) + + with subtest("Run container remotely via docker cli"): + client.succeed("docker version") + + # via socket would be nicer + podman.succeed("tar cvf scratchimg.tar --files-from /dev/null && podman import scratchimg.tar scratchimg") + + client.succeed( + "docker run -d --name=sleeping -v /nix/store:/nix/store -v /run/current-system/sw/bin:/bin scratchimg /bin/sleep 10" + ) + client.succeed("docker ps | grep sleeping") + podman.succeed("docker ps | grep sleeping") + client.succeed("docker stop sleeping") + client.succeed("docker rm sleeping") + + with subtest("Clients without cert will be denied"): + client.succeed("rm /root/.docker/{cert,key}.pem") + client.fail("docker version") + + with subtest("Clients with wrong cert will be denied"): + client.copy_from_host("client-2-cert.pem", "/root/.docker/cert.pem") + client.copy_from_host("client-2-key.pem", "/root/.docker/key.pem") + client.fail("docker version") + + ''; + } +) diff --git a/nixos/tests/podman.nix b/nixos/tests/podman.nix index 6078a936ede..6184561e6dd 100644 --- a/nixos/tests/podman.nix +++ b/nixos/tests/podman.nix @@ -13,10 +13,23 @@ import ./make-test-python.nix ( { virtualisation.podman.enable = true; + # To test docker socket support + virtualisation.podman.dockerSocket.enable = true; + environment.systemPackages = [ + pkgs.docker-client + ]; + users.users.alice = { isNormalUser = true; home = "/home/alice"; description = "Alice Foobar"; + extraGroups = [ "podman" ]; + }; + + users.users.mallory = { + isNormalUser = true; + home = "/home/mallory"; + description = "Mallory Foobar"; }; }; @@ -26,16 +39,16 @@ import ./make-test-python.nix ( import shlex - def su_cmd(cmd): + def su_cmd(cmd, user = "alice"): cmd = shlex.quote(cmd) - return f"su alice -l -c {cmd}" + return f"su {user} -l -c {cmd}" podman.wait_for_unit("sockets.target") start_all() with subtest("Run container as root with runc"): - podman.succeed("tar cv --files-from /dev/null | podman import - scratchimg") + podman.succeed("tar cvf scratchimg.tar --files-from /dev/null && podman import scratchimg.tar scratchimg") podman.succeed( "podman run --runtime=runc -d --name=sleeping -v /nix/store:/nix/store -v /run/current-system/sw/bin:/bin scratchimg /bin/sleep 10" ) @@ -44,7 +57,7 @@ import ./make-test-python.nix ( podman.succeed("podman rm sleeping") with subtest("Run container as root with crun"): - podman.succeed("tar cv --files-from /dev/null | podman import - scratchimg") + podman.succeed("tar cvf scratchimg.tar --files-from /dev/null && podman import scratchimg.tar scratchimg") podman.succeed( "podman run --runtime=crun -d --name=sleeping -v /nix/store:/nix/store -v /run/current-system/sw/bin:/bin scratchimg /bin/sleep 10" ) @@ -53,7 +66,7 @@ import ./make-test-python.nix ( podman.succeed("podman rm sleeping") with subtest("Run container as root with the default backend"): - podman.succeed("tar cv --files-from /dev/null | podman import - scratchimg") + podman.succeed("tar cvf scratchimg.tar --files-from /dev/null && podman import scratchimg.tar scratchimg") podman.succeed( "podman run -d --name=sleeping -v /nix/store:/nix/store -v /run/current-system/sw/bin:/bin scratchimg /bin/sleep 10" ) @@ -65,7 +78,7 @@ import ./make-test-python.nix ( podman.succeed("loginctl enable-linger alice") with subtest("Run container rootless with runc"): - podman.succeed(su_cmd("tar cv --files-from /dev/null | podman import - scratchimg")) + podman.succeed(su_cmd("tar cvf scratchimg.tar --files-from /dev/null && podman import scratchimg.tar scratchimg")) podman.succeed( su_cmd( "podman run --runtime=runc -d --name=sleeping -v /nix/store:/nix/store -v /run/current-system/sw/bin:/bin scratchimg /bin/sleep 10" @@ -76,7 +89,7 @@ import ./make-test-python.nix ( podman.succeed(su_cmd("podman rm sleeping")) with subtest("Run container rootless with crun"): - podman.succeed(su_cmd("tar cv --files-from /dev/null | podman import - scratchimg")) + podman.succeed(su_cmd("tar cvf scratchimg.tar --files-from /dev/null && podman import scratchimg.tar scratchimg")) podman.succeed( su_cmd( "podman run --runtime=crun -d --name=sleeping -v /nix/store:/nix/store -v /run/current-system/sw/bin:/bin scratchimg /bin/sleep 10" @@ -87,7 +100,7 @@ import ./make-test-python.nix ( podman.succeed(su_cmd("podman rm sleeping")) with subtest("Run container rootless with the default backend"): - podman.succeed(su_cmd("tar cv --files-from /dev/null | podman import - scratchimg")) + podman.succeed(su_cmd("tar cvf scratchimg.tar --files-from /dev/null && podman import scratchimg.tar scratchimg")) podman.succeed( su_cmd( "podman run -d --name=sleeping -v /nix/store:/nix/store -v /run/current-system/sw/bin:/bin scratchimg /bin/sleep 10" @@ -99,12 +112,33 @@ import ./make-test-python.nix ( with subtest("Run container with init"): podman.succeed( - "tar cv -C ${pkgs.pkgsStatic.busybox} . | podman import - busybox" + "tar cvf busybox.tar -C ${pkgs.pkgsStatic.busybox} . && podman import busybox.tar busybox" ) pid = podman.succeed("podman run --rm busybox readlink /proc/self").strip() assert pid == "1" pid = podman.succeed("podman run --rm --init busybox readlink /proc/self").strip() assert pid == "2" + + with subtest("A podman member can use the docker cli"): + podman.succeed(su_cmd("docker version")) + + with subtest("Run container via docker cli"): + podman.succeed("docker network create default") + podman.succeed("tar cvf scratchimg.tar --files-from /dev/null && podman import scratchimg.tar scratchimg") + podman.succeed( + "docker run -d --name=sleeping -v /nix/store:/nix/store -v /run/current-system/sw/bin:/bin scratchimg /bin/sleep 10" + ) + podman.succeed("docker ps | grep sleeping") + podman.succeed("podman ps | grep sleeping") + podman.succeed("docker stop sleeping") + podman.succeed("docker rm sleeping") + podman.succeed("docker network rm default") + + with subtest("A podman non-member can not use the docker cli"): + podman.fail(su_cmd("docker version", user="mallory")) + + # TODO: add docker-compose test + ''; } ) diff --git a/nixos/tests/pomerium.nix b/nixos/tests/pomerium.nix index 531b6212711..7af82832644 100644 --- a/nixos/tests/pomerium.nix +++ b/nixos/tests/pomerium.nix @@ -88,15 +88,15 @@ import ./make-test-python.nix ({ pkgs, lib, ... }: { with subtest("no authentication required"): pomerium.succeed( - "curl --resolve my.website:80:127.0.0.1 http://my.website | grep -q 'hello world'" + "curl --resolve my.website:80:127.0.0.1 http://my.website | grep 'hello world'" ) with subtest("login required"): pomerium.succeed( - "curl -I --resolve login.required:80:127.0.0.1 http://login.required | grep -q pom-auth" + "curl -I --resolve login.required:80:127.0.0.1 http://login.required | grep pom-auth" ) pomerium.succeed( - "curl -L --resolve login.required:80:127.0.0.1 http://login.required | grep -q 'hello I am login page'" + "curl -L --resolve login.required:80:127.0.0.1 http://login.required | grep 'hello I am login page'" ) ''; }) diff --git a/nixos/tests/postgresql.nix b/nixos/tests/postgresql.nix index 091e64294ac..0369a070719 100644 --- a/nixos/tests/postgresql.nix +++ b/nixos/tests/postgresql.nix @@ -73,8 +73,30 @@ let machine.succeed( "systemctl start ${backupService}.service", "zcat /var/backup/postgresql/${backupName}.sql.gz | grep '<test>ok</test>'", + "ls -hal /var/backup/postgresql/ >/dev/console", "stat -c '%a' /var/backup/postgresql/${backupName}.sql.gz | grep 600", ) + with subtest("Backup service fails gracefully"): + # Sabotage the backup process + machine.succeed("rm /run/postgresql/.s.PGSQL.5432") + machine.fail( + "systemctl start ${backupService}.service", + ) + machine.succeed( + "ls -hal /var/backup/postgresql/ >/dev/console", + "zcat /var/backup/postgresql/${backupName}.prev.sql.gz | grep '<test>ok</test>'", + "stat /var/backup/postgresql/${backupName}.in-progress.sql.gz", + ) + # In a previous version, the second run would overwrite prev.sql.gz, + # so we test a second run as well. + machine.fail( + "systemctl start ${backupService}.service", + ) + machine.succeed( + "stat /var/backup/postgresql/${backupName}.in-progress.sql.gz", + "zcat /var/backup/postgresql/${backupName}.prev.sql.gz | grep '<test>ok</test>'", + ) + with subtest("Initdb works"): machine.succeed("sudo -u postgres initdb -D /tmp/testpostgres2") diff --git a/nixos/tests/printing.nix b/nixos/tests/printing.nix index b2f2540fb7a..badcb99a57a 100644 --- a/nixos/tests/printing.nix +++ b/nixos/tests/printing.nix @@ -63,7 +63,7 @@ in { ): serviceClient.sleep(20) socketActivatedClient.wait_until_succeeds( - "systemctl status ensure-printers | grep -q -E 'code=exited, status=0/SUCCESS'" + "systemctl show ensure-printers | grep -q -E 'code=exited ; status=0'" ) diff --git a/nixos/tests/prometheus-exporters.nix b/nixos/tests/prometheus-exporters.nix index e3bfff218ad..e8bc6339ecf 100644 --- a/nixos/tests/prometheus-exporters.nix +++ b/nixos/tests/prometheus-exporters.nix @@ -71,7 +71,7 @@ let wait_for_open_port(3551) wait_for_unit("prometheus-apcupsd-exporter.service") wait_for_open_port(9162) - succeed("curl -sSf http://localhost:9162/metrics | grep -q 'apcupsd_info'") + succeed("curl -sSf http://localhost:9162/metrics | grep 'apcupsd_info'") ''; }; @@ -85,7 +85,7 @@ let wait_for_unit("prometheus-artifactory-exporter.service") wait_for_open_port(9531) succeed( - "curl -sSf http://localhost:9531/metrics | grep -q 'artifactory_up'" + "curl -sSf http://localhost:9531/metrics | grep 'artifactory_up'" ) ''; }; @@ -106,7 +106,7 @@ let wait_for_unit("prometheus-bind-exporter.service") wait_for_open_port(9119) succeed( - "curl -sSf http://localhost:9119/metrics | grep -q 'bind_query_recursions_total 0'" + "curl -sSf http://localhost:9119/metrics | grep 'bind_query_recursions_total 0'" ) ''; }; @@ -135,7 +135,7 @@ let wait_for_unit("prometheus-bird-exporter.service") wait_for_open_port(9324) wait_until_succeeds( - "curl -sSf http://localhost:9324/metrics | grep -q 'MyObviousTestString'" + "curl -sSf http://localhost:9324/metrics | grep 'MyObviousTestString'" ) ''; }; @@ -154,7 +154,7 @@ let wait_for_unit("prometheus-bitcoin-exporter.service") wait_for_unit("bitcoind-default.service") wait_for_open_port(9332) - succeed("curl -sSf http://localhost:9332/metrics | grep -q '^bitcoin_blocks '") + succeed("curl -sSf http://localhost:9332/metrics | grep '^bitcoin_blocks '") ''; }; @@ -172,7 +172,7 @@ let wait_for_unit("prometheus-blackbox-exporter.service") wait_for_open_port(9115) succeed( - "curl -sSf 'http://localhost:9115/probe?target=localhost&module=icmp_v6' | grep -q 'probe_success 1'" + "curl -sSf 'http://localhost:9115/probe?target=localhost&module=icmp_v6' | grep 'probe_success 1'" ) ''; }; @@ -204,7 +204,7 @@ let "curl -sSfH 'Content-Type: application/json' -X POST --data @/tmp/data.json localhost:9103/collectd" ) succeed( - "curl -sSf localhost:9103/metrics | grep -q 'collectd_testplugin_gauge{instance=\"testhost\"} 23'" + "curl -sSf localhost:9103/metrics | grep 'collectd_testplugin_gauge{instance=\"testhost\"} 23'" ) ''; }; @@ -220,7 +220,7 @@ let exporterTest = '' wait_for_unit("prometheus-dnsmasq-exporter.service") wait_for_open_port(9153) - succeed("curl -sSf http://localhost:9153/metrics | grep -q 'dnsmasq_leases 0'") + succeed("curl -sSf http://localhost:9153/metrics | grep 'dnsmasq_leases 0'") ''; }; @@ -235,7 +235,7 @@ let wait_for_unit("prometheus-domain-exporter.service") wait_for_open_port(9222) succeed( - "curl -sSf 'http://localhost:9222/probe?target=nixos.org' | grep -q 'domain_probe_success 0'" + "curl -sSf 'http://localhost:9222/probe?target=nixos.org' | grep 'domain_probe_success 0'" ) ''; }; @@ -254,7 +254,7 @@ let wait_for_unit("prometheus-dovecot-exporter.service") wait_for_open_port(9166) succeed( - "curl -sSf http://localhost:9166/metrics | grep -q 'dovecot_up{scope=\"global\"} 1'" + "curl -sSf http://localhost:9166/metrics | grep 'dovecot_up{scope=\"global\"} 1'" ) ''; }; @@ -268,7 +268,7 @@ let wait_for_unit("prometheus-fritzbox-exporter.service") wait_for_open_port(9133) succeed( - "curl -sSf http://localhost:9133/metrics | grep -q 'fritzbox_exporter_collect_errors 0'" + "curl -sSf http://localhost:9133/metrics | grep 'fritzbox_exporter_collect_errors 0'" ) ''; }; @@ -290,9 +290,9 @@ let wait_for_unit("prometheus-jitsi-exporter.service") wait_for_open_port(9700) wait_until_succeeds( - 'journalctl -eu prometheus-jitsi-exporter.service -o cat | grep -q "key=participants"' + 'journalctl -eu prometheus-jitsi-exporter.service -o cat | grep "key=participants"' ) - succeed("curl -sSf 'localhost:9700/metrics' | grep -q 'jitsi_participants 0'") + succeed("curl -sSf 'localhost:9700/metrics' | grep 'jitsi_participants 0'") ''; }; @@ -321,54 +321,41 @@ let wait_for_unit("prometheus-json-exporter.service") wait_for_open_port(7979) succeed( - "curl -sSf 'localhost:7979/probe?target=http://localhost' | grep -q 'json_test_metric 1'" + "curl -sSf 'localhost:7979/probe?target=http://localhost' | grep 'json_test_metric 1'" ) ''; }; - kea = { + kea = let + controlSocketPath = "/run/kea/dhcp6.sock"; + in + { exporterConfig = { enable = true; controlSocketPaths = [ - "/run/kea/kea-dhcp6.sock" + controlSocketPath ]; }; metricProvider = { - users.users.kea = { - isSystemUser = true; - }; - users.groups.kea = {}; + systemd.services.prometheus-kea-exporter.after = [ "kea-dhcp6-server.service" ]; - systemd.services.prometheus-kea-exporter.after = [ "kea-dhcp6.service" ]; - - systemd.services.kea-dhcp6 = let - configFile = pkgs.writeText "kea-dhcp6.conf" (builtins.toJSON { - Dhcp6 = { - "control-socket" = { - "socket-type" = "unix"; - "socket-name" = "/run/kea/kea-dhcp6.sock"; + services.kea = { + enable = true; + dhcp6 = { + enable = true; + settings = { + control-socket = { + socket-type = "unix"; + socket-name = controlSocketPath; }; }; - }); - in - { - after = [ "network.target" ]; - wantedBy = [ "multi-user.target" ]; - - serviceConfig = { - DynamicUser = false; - User = "kea"; - Group = "kea"; - ExecStart = "${pkgs.kea}/bin/kea-dhcp6 -c ${configFile}"; - StateDirectory = "kea"; - RuntimeDirectory = "kea"; - UMask = "0007"; }; }; }; + exporterTest = '' - wait_for_unit("kea-dhcp6.service") - wait_for_file("/run/kea/kea-dhcp6.sock") + wait_for_unit("kea-dhcp6-server.service") + wait_for_file("${controlSocketPath}") wait_for_unit("prometheus-kea-exporter.service") wait_for_open_port(9547) succeed( @@ -426,7 +413,7 @@ let wait_for_unit("knot.service") wait_for_unit("prometheus-knot-exporter.service") wait_for_open_port(9433) - succeed("curl -sSf 'localhost:9433' | grep -q 'knot_server_zone_count 1.0'") + succeed("curl -sSf 'localhost:9433' | grep 'knot_server_zone_count 1.0'") ''; }; @@ -441,10 +428,10 @@ let wait_for_unit("prometheus-keylight-exporter.service") wait_for_open_port(9288) succeed( - "curl -sS --write-out '%{http_code}' -o /dev/null http://localhost:9288/metrics | grep -q '400'" + "curl -sS --write-out '%{http_code}' -o /dev/null http://localhost:9288/metrics | grep '400'" ) succeed( - "curl -sS --write-out '%{http_code}' -o /dev/null http://localhost:9288/metrics?target=nosuchdevice | grep -q '500'" + "curl -sS --write-out '%{http_code}' -o /dev/null http://localhost:9288/metrics?target=nosuchdevice | grep '500'" ) ''; }; @@ -454,15 +441,21 @@ let enable = true; lndTlsPath = "/var/lib/lnd/tls.cert"; lndMacaroonDir = "/var/lib/lnd"; + extraFlags = [ "--lnd.network=regtest" ]; }; metricProvider = { - systemd.services.prometheus-lnd-exporter.serviceConfig.DynamicUser = false; - services.bitcoind.main.enable = true; - services.bitcoind.main.extraConfig = '' - rpcauth=bitcoinrpc:e8fe33f797e698ac258c16c8d7aadfbe$872bdb8f4d787367c26bcfd75e6c23c4f19d44a69f5d1ad329e5adf3f82710f7 - bitcoind.zmqpubrawblock=tcp://127.0.0.1:28332 - bitcoind.zmqpubrawtx=tcp://127.0.0.1:28333 - ''; + virtualisation.memorySize = 1024; + systemd.services.prometheus-lnd-exporter.serviceConfig.RestartSec = 15; + systemd.services.prometheus-lnd-exporter.after = [ "lnd.service" ]; + services.bitcoind.regtest = { + enable = true; + extraConfig = '' + rpcauth=bitcoinrpc:e8fe33f797e698ac258c16c8d7aadfbe$872bdb8f4d787367c26bcfd75e6c23c4f19d44a69f5d1ad329e5adf3f82710f7 + zmqpubrawblock=tcp://127.0.0.1:28332 + zmqpubrawtx=tcp://127.0.0.1:28333 + ''; + extraCmdlineOptions = [ "-regtest" ]; + }; systemd.services.lnd = { serviceConfig.ExecStart = '' ${pkgs.lnd}/bin/lnd \ @@ -471,7 +464,7 @@ let --tlskeypath=/var/lib/lnd/tls.key \ --logdir=/var/log/lnd \ --bitcoin.active \ - --bitcoin.mainnet \ + --bitcoin.regtest \ --bitcoin.node=bitcoind \ --bitcoind.rpcuser=bitcoinrpc \ --bitcoind.rpcpass=hunter2 \ @@ -483,13 +476,31 @@ let wantedBy = [ "multi-user.target" ]; after = [ "network.target" ]; }; + # initialize wallet, creates macaroon needed by exporter + systemd.services.lnd.postStart = '' + ${pkgs.curl}/bin/curl \ + --retry 20 \ + --retry-delay 1 \ + --retry-connrefused \ + --cacert /var/lib/lnd/tls.cert \ + -X GET \ + https://localhost:8080/v1/genseed | ${pkgs.jq}/bin/jq -c '.cipher_seed_mnemonic' > /tmp/seed + ${pkgs.curl}/bin/curl \ + --retry 20 \ + --retry-delay 1 \ + --retry-connrefused \ + --cacert /var/lib/lnd/tls.cert \ + -X POST \ + -d "{\"wallet_password\": \"asdfasdfasdf\", \"cipher_seed_mnemonic\": $(cat /tmp/seed | tr -d '\n')}" \ + https://localhost:8080/v1/initwallet + ''; }; exporterTest = '' wait_for_unit("lnd.service") wait_for_open_port(10009) wait_for_unit("prometheus-lnd-exporter.service") wait_for_open_port(9092) - succeed("curl -sSf localhost:9092/metrics | grep -q '^promhttp_metric_handler'") + succeed("curl -sSf localhost:9092/metrics | grep '^lnd_peer_count'") ''; }; @@ -531,7 +542,7 @@ let wait_for_unit("prometheus-mail-exporter.service") wait_for_open_port(9225) wait_until_succeeds( - "curl -sSf http://localhost:9225/metrics | grep -q 'mail_deliver_success{configname=\"testserver\"} 1'" + "curl -sSf http://localhost:9225/metrics | grep 'mail_deliver_success{configname=\"testserver\"} 1'" ) ''; }; @@ -571,7 +582,7 @@ let wait_for_unit("prometheus-mikrotik-exporter.service") wait_for_open_port(9436) succeed( - "curl -sSf http://localhost:9436/metrics | grep -q 'mikrotik_scrape_collector_success{device=\"router\"} 0'" + "curl -sSf http://localhost:9436/metrics | grep 'mikrotik_scrape_collector_success{device=\"router\"} 0'" ) ''; }; @@ -596,7 +607,7 @@ let wait_for_unit("prometheus-modemmanager-exporter.service") wait_for_open_port(9539) succeed( - "curl -sSf http://localhost:9539/metrics | grep -q 'modemmanager_info'" + "curl -sSf http://localhost:9539/metrics | grep 'modemmanager_info'" ) ''; }; @@ -634,7 +645,7 @@ let wait_for_unit("nginx.service") wait_for_unit("prometheus-nextcloud-exporter.service") wait_for_open_port(9205) - succeed("curl -sSf http://localhost:9205/metrics | grep -q 'nextcloud_up 1'") + succeed("curl -sSf http://localhost:9205/metrics | grep 'nextcloud_up 1'") ''; }; @@ -653,7 +664,7 @@ let wait_for_unit("nginx.service") wait_for_unit("prometheus-nginx-exporter.service") wait_for_open_port(9113) - succeed("curl -sSf http://localhost:9113/metrics | grep -q 'nginx_up 1'") + succeed("curl -sSf http://localhost:9113/metrics | grep 'nginx_up 1'") ''; }; @@ -708,12 +719,12 @@ let succeed("curl http://localhost") execute("sleep 1") succeed( - "curl -sSf http://localhost:9117/metrics | grep 'filelogger_http_response_count_total' | grep -q 1" + "curl -sSf http://localhost:9117/metrics | grep 'filelogger_http_response_count_total' | grep 1" ) succeed("curl http://localhost:81") execute("sleep 1") succeed( - "curl -sSf http://localhost:9117/metrics | grep 'syslogger_http_response_count_total' | grep -q 1" + "curl -sSf http://localhost:9117/metrics | grep 'syslogger_http_response_count_total' | grep 1" ) ''; }; @@ -726,7 +737,7 @@ let wait_for_unit("prometheus-node-exporter.service") wait_for_open_port(9100) succeed( - "curl -sSf http://localhost:9100/metrics | grep -q 'node_exporter_build_info{.\\+} 1'" + "curl -sSf http://localhost:9100/metrics | grep 'node_exporter_build_info{.\\+} 1'" ) ''; }; @@ -786,7 +797,7 @@ let wait_for_open_port(389) wait_for_open_port(9330) wait_until_succeeds( - "curl -sSf http://localhost:9330/metrics | grep -q 'openldap_scrape{result=\"ok\"} 1'" + "curl -sSf http://localhost:9330/metrics | grep 'openldap_scrape{result=\"ok\"} 1'" ) ''; }; @@ -812,7 +823,7 @@ let exporterTest = '' wait_for_unit("openvpn-test.service") wait_for_unit("prometheus-openvpn-exporter.service") - succeed("curl -sSf http://localhost:9176/metrics | grep -q 'openvpn_up{.*} 1'") + succeed("curl -sSf http://localhost:9176/metrics | grep 'openvpn_up{.*} 1'") ''; }; @@ -828,9 +839,9 @@ let wait_for_file("/var/lib/postfix/queue/public/showq") wait_for_open_port(9154) succeed( - "curl -sSf http://localhost:9154/metrics | grep -q 'postfix_smtpd_connects_total 0'" + "curl -sSf http://localhost:9154/metrics | grep 'postfix_smtpd_connects_total 0'" ) - succeed("curl -sSf http://localhost:9154/metrics | grep -q 'postfix_up{.*} 1'") + succeed("curl -sSf http://localhost:9154/metrics | grep 'postfix_up{.*} 1'") ''; }; @@ -847,20 +858,39 @@ let wait_for_open_port(9187) wait_for_unit("postgresql.service") succeed( - "curl -sSf http://localhost:9187/metrics | grep -q 'pg_exporter_last_scrape_error 0'" + "curl -sSf http://localhost:9187/metrics | grep 'pg_exporter_last_scrape_error 0'" ) - succeed("curl -sSf http://localhost:9187/metrics | grep -q 'pg_up 1'") + succeed("curl -sSf http://localhost:9187/metrics | grep 'pg_up 1'") systemctl("stop postgresql.service") succeed( - "curl -sSf http://localhost:9187/metrics | grep -qv 'pg_exporter_last_scrape_error 0'" + "curl -sSf http://localhost:9187/metrics | grep -v 'pg_exporter_last_scrape_error 0'" ) - succeed("curl -sSf http://localhost:9187/metrics | grep -q 'pg_up 0'") + succeed("curl -sSf http://localhost:9187/metrics | grep 'pg_up 0'") systemctl("start postgresql.service") wait_for_unit("postgresql.service") succeed( - "curl -sSf http://localhost:9187/metrics | grep -q 'pg_exporter_last_scrape_error 0'" + "curl -sSf http://localhost:9187/metrics | grep 'pg_exporter_last_scrape_error 0'" + ) + succeed("curl -sSf http://localhost:9187/metrics | grep 'pg_up 1'") + ''; + }; + + process = { + exporterConfig = { + enable = true; + settings.process_names = [ + # Remove nix store path from process name + { name = "{{.Matches.Wrapped}} {{ .Matches.Args }}"; cmdline = [ "^/nix/store[^ ]*/(?P<Wrapped>[^ /]*) (?P<Args>.*)" ]; } + ]; + }; + exporterTest = '' + wait_for_unit("prometheus-process-exporter.service") + wait_for_open_port(9256) + wait_until_succeeds( + "curl -sSf localhost:9256/metrics | grep -q '{}'".format( + 'namedprocess_namegroup_cpu_seconds_total{groupname="process-exporter ' + ) ) - succeed("curl -sSf http://localhost:9187/metrics | grep -q 'pg_up 1'") ''; }; @@ -874,7 +904,7 @@ let wait_for_unit("prometheus-py-air-control-exporter.service") wait_for_open_port(9896) succeed( - "curl -sSf http://localhost:9896/metrics | grep -q 'py_air_control_sampling_error_total'" + "curl -sSf http://localhost:9896/metrics | grep 'py_air_control_sampling_error_total'" ) ''; }; @@ -889,7 +919,7 @@ let wait_for_unit("prometheus-redis-exporter.service") wait_for_open_port(6379) wait_for_open_port(9121) - wait_until_succeeds("curl -sSf localhost:9121/metrics | grep -q 'redis_up 1'") + wait_until_succeeds("curl -sSf localhost:9121/metrics | grep 'redis_up 1'") ''; }; @@ -907,7 +937,7 @@ let wait_for_open_port(11334) wait_for_open_port(7980) wait_until_succeeds( - "curl -sSf 'localhost:7980/probe?target=http://localhost:11334/stat' | grep -q 'rspamd_scanned{host=\"rspamd\"} 0'" + "curl -sSf 'localhost:7980/probe?target=http://localhost:11334/stat' | grep 'rspamd_scanned{host=\"rspamd\"} 0'" ) ''; }; @@ -938,13 +968,31 @@ let wait_for_unit("prometheus-rtl_433-exporter.service") wait_for_open_port(9550) wait_until_succeeds( - "curl -sSf localhost:9550/metrics | grep -q '{}'".format( + "curl -sSf localhost:9550/metrics | grep '{}'".format( 'rtl_433_temperature_celsius{channel="3",id="55",location="",model="zopieux"} 18' ) ) ''; }; + script = { + exporterConfig = { + enable = true; + settings.scripts = [ + { name = "success"; script = "sleep 1"; } + ]; + }; + exporterTest = '' + wait_for_unit("prometheus-script-exporter.service") + wait_for_open_port(9172) + wait_until_succeeds( + "curl -sSf 'localhost:9172/probe?name=success' | grep -q '{}'".format( + 'script_success{script="success"} 1' + ) + ) + ''; + }; + smokeping = { exporterConfig = { enable = true; @@ -954,12 +1002,12 @@ let wait_for_unit("prometheus-smokeping-exporter.service") wait_for_open_port(9374) wait_until_succeeds( - "curl -sSf localhost:9374/metrics | grep '{}' | grep -qv ' 0$'".format( + "curl -sSf localhost:9374/metrics | grep '{}' | grep -v ' 0$'".format( 'smokeping_requests_total{host="127.0.0.1",ip="127.0.0.1"} ' ) ) wait_until_succeeds( - "curl -sSf localhost:9374/metrics | grep -q '{}'".format( + "curl -sSf localhost:9374/metrics | grep '{}'".format( 'smokeping_response_ttl{host="127.0.0.1",ip="127.0.0.1"}' ) ) @@ -977,7 +1025,7 @@ let exporterTest = '' wait_for_unit("prometheus-snmp-exporter.service") wait_for_open_port(9116) - succeed("curl -sSf localhost:9116/metrics | grep -q 'snmp_request_errors_total 0'") + succeed("curl -sSf localhost:9116/metrics | grep 'snmp_request_errors_total 0'") ''; }; @@ -1021,7 +1069,7 @@ let exporterTest = '' wait_for_unit("prometheus-sql-exporter.service") wait_for_open_port(9237) - succeed("curl http://localhost:9237/metrics | grep -c 'sql_points{' | grep -q 2") + succeed("curl http://localhost:9237/metrics | grep -c 'sql_points{' | grep 2") ''; }; @@ -1044,7 +1092,7 @@ let wait_for_open_port(80) wait_for_unit("prometheus-surfboard-exporter.service") wait_for_open_port(9239) - succeed("curl -sSf localhost:9239/metrics | grep -q 'surfboard_up 1'") + succeed("curl -sSf localhost:9239/metrics | grep 'surfboard_up 1'") ''; }; @@ -1057,7 +1105,7 @@ let wait_for_unit("prometheus-systemd-exporter.service") wait_for_open_port(9558) succeed( - "curl -sSf localhost:9558/metrics | grep -q '{}'".format( + "curl -sSf localhost:9558/metrics | grep '{}'".format( 'systemd_unit_state{name="basic.target",state="active",type="target"} 1' ) ) @@ -1079,7 +1127,7 @@ let wait_for_open_port(9051) wait_for_unit("prometheus-tor-exporter.service") wait_for_open_port(9130) - succeed("curl -sSf localhost:9130/metrics | grep -q 'tor_version{.\\+} 1'") + succeed("curl -sSf localhost:9130/metrics | grep 'tor_version{.\\+} 1'") ''; }; @@ -1091,7 +1139,7 @@ let wait_for_unit("prometheus-unifi-poller-exporter.service") wait_for_open_port(9130) succeed( - "curl -sSf localhost:9130/metrics | grep -q 'unifipoller_build_info{.\\+} 1'" + "curl -sSf localhost:9130/metrics | grep 'unifipoller_build_info{.\\+} 1'" ) ''; }; @@ -1115,7 +1163,7 @@ let wait_for_unit("unbound.service") wait_for_unit("prometheus-unbound-exporter.service") wait_for_open_port(9167) - succeed("curl -sSf localhost:9167/metrics | grep -q 'unbound_up 1'") + succeed("curl -sSf localhost:9167/metrics | grep 'unbound_up 1'") ''; }; @@ -1144,7 +1192,7 @@ let wait_for_unit("prometheus-varnish-exporter.service") wait_for_open_port(6081) wait_for_open_port(9131) - succeed("curl -sSf http://localhost:9131/metrics | grep -q 'varnish_up 1'") + succeed("curl -sSf http://localhost:9131/metrics | grep 'varnish_up 1'") ''; }; diff --git a/nixos/tests/rss2email.nix b/nixos/tests/rss2email.nix index d62207a417b..f32326feb50 100644 --- a/nixos/tests/rss2email.nix +++ b/nixos/tests/rss2email.nix @@ -1,5 +1,5 @@ import ./make-test-python.nix { - name = "opensmtpd"; + name = "rss2email"; nodes = { server = { pkgs, ... }: { diff --git a/nixos/tests/sanoid.nix b/nixos/tests/sanoid.nix index c691bfc08ef..7cef51e4201 100644 --- a/nixos/tests/sanoid.nix +++ b/nixos/tests/sanoid.nix @@ -33,7 +33,7 @@ in { autosnap = true; }; - datasets."pool/sanoid".useTemplate = [ "test" ]; + datasets."pool/sanoid".use_template = [ "test" ]; extraArgs = [ "--verbose" ]; }; @@ -44,7 +44,7 @@ in { # Sync snapshot taken by sanoid "pool/sanoid" = { target = "root@target:pool/sanoid"; - extraArgs = [ "--no-sync-snap" ]; + extraArgs = [ "--no-sync-snap" "--create-bookmark" ]; }; # Take snapshot and sync "pool/syncoid".target = "root@target:pool/syncoid"; @@ -92,8 +92,9 @@ in { # Sync snapshots target.wait_for_open_port(22) source.succeed("touch /mnt/pool/syncoid/test.txt") - source.systemctl("start --wait syncoid.service") + source.systemctl("start --wait syncoid-pool-sanoid.service") target.succeed("cat /mnt/pool/sanoid/test.txt") + source.systemctl("start --wait syncoid-pool-syncoid.service") target.succeed("cat /mnt/pool/syncoid/test.txt") ''; }) diff --git a/nixos/tests/shiori.nix b/nixos/tests/shiori.nix index a5771262c6f..418bee43c93 100644 --- a/nixos/tests/shiori.nix +++ b/nixos/tests/shiori.nix @@ -28,7 +28,7 @@ import ./make-test-python.nix ({ pkgs, lib, ...}: machine.wait_for_unit("shiori.service") machine.wait_for_open_port(8080) machine.succeed("curl --fail http://localhost:8080/") - machine.succeed("curl --fail --location http://localhost:8080/ | grep -qi shiori") + machine.succeed("curl --fail --location http://localhost:8080/ | grep -i shiori") with subtest("login"): auth_json = machine.succeed( diff --git a/nixos/tests/snapcast.nix b/nixos/tests/snapcast.nix index ef35d586c9c..8d960b4cc06 100644 --- a/nixos/tests/snapcast.nix +++ b/nixos/tests/snapcast.nix @@ -72,10 +72,10 @@ in { ) with subtest("test a connection"): - client.execute("systemd-run snapclient -h server -p ${toString port}") + client.execute("systemd-run --unit=snapcast-client snapclient -h server -p ${toString port}") server.wait_until_succeeds( "journalctl -o cat -u snapserver.service | grep -q 'Hello from'" ) - client.wait_until_succeeds("journalctl -o cat -u run-\* | grep -q ${toString bufferSize}") + client.wait_until_succeeds("journalctl -o cat -u snapcast-client | grep -q 'buffer: ${toString bufferSize}'") ''; }) diff --git a/nixos/tests/sogo.nix b/nixos/tests/sogo.nix index 3f600b4cd55..acdad8d0f47 100644 --- a/nixos/tests/sogo.nix +++ b/nixos/tests/sogo.nix @@ -10,7 +10,7 @@ import ./make-test-python.nix ({ pkgs, ... }: { services.mysql = { enable = true; - package = pkgs.mysql; + package = pkgs.mariadb; ensureDatabases = [ "sogo" ]; ensureUsers = [{ name = "sogo"; diff --git a/nixos/tests/solanum.nix b/nixos/tests/solanum.nix index aabfb906aa8..1ecf91bce40 100644 --- a/nixos/tests/solanum.nix +++ b/nixos/tests/solanum.nix @@ -16,6 +16,10 @@ import ./make-test-python.nix ({ pkgs, lib, ... }: { networking.firewall.allowedTCPPorts = [ ircPort ]; services.solanum = { enable = true; + motd = '' + The default MOTD doesn't contain the word "nixos" in it. + This one does. + ''; }; }; } // lib.listToAttrs (builtins.map (client: lib.nameValuePair client { @@ -48,6 +52,10 @@ import ./make-test-python.nix ({ pkgs, lib, ... }: { ${client}.wait_for_unit("ii") ${client}.wait_for_file("${iiDir}/${server}/out") '' + # look for the custom text in the MOTD. + '' + ${client}.wait_until_succeeds("grep 'nixos' ${iiDir}/${server}/out") + '' # wait until first PING from server arrives before joining, # so we don't try it too early '' diff --git a/nixos/tests/sourcehut.nix b/nixos/tests/sourcehut.nix new file mode 100644 index 00000000000..b56a14ebf85 --- /dev/null +++ b/nixos/tests/sourcehut.nix @@ -0,0 +1,29 @@ +import ./make-test-python.nix ({ pkgs, ... }: + +{ + name = "sourcehut"; + + meta.maintainers = [ pkgs.lib.maintainers.tomberek ]; + + machine = { config, pkgs, ... }: { + virtualisation.memorySize = 2048; + networking.firewall.allowedTCPPorts = [ 80 ]; + + services.sourcehut = { + enable = true; + services = [ "meta" ]; + originBase = "sourcehut"; + settings."sr.ht".service-key = "8888888888888888888888888888888888888888888888888888888888888888"; + settings."sr.ht".network-key = "0000000000000000000000000000000000000000000="; + settings.webhooks.private-key = "0000000000000000000000000000000000000000000="; + }; + }; + + testScript = '' + start_all() + machine.wait_for_unit("multi-user.target") + machine.wait_for_unit("metasrht.service") + machine.wait_for_open_port(5000) + machine.succeed("curl -sL http://localhost:5000 | grep meta.sourcehut") + ''; +}) diff --git a/nixos/tests/sway.nix b/nixos/tests/sway.nix index 1d23b0e9431..01240ef572a 100644 --- a/nixos/tests/sway.nix +++ b/nixos/tests/sway.nix @@ -15,7 +15,10 @@ import ./make-test-python.nix ({ pkgs, lib, ...} : # For glinfo and wayland-info: systemPackages = with pkgs; [ mesa-demos wayland-utils ]; # Use a fixed SWAYSOCK path (for swaymsg): - variables."SWAYSOCK" = "/tmp/sway-ipc.sock"; + variables = { + "SWAYSOCK" = "/tmp/sway-ipc.sock"; + "WLR_RENDERER_ALLOW_SOFTWARE" = "1"; + }; # For convenience: shellAliases = { test-x11 = "glinfo | head -n 3 | tee /tmp/test-x11.out && touch /tmp/test-x11-exit-ok"; @@ -42,8 +45,8 @@ import ./make-test-python.nix ({ pkgs, lib, ...} : programs.gnupg.agent.enable = true; virtualisation.memorySize = 1024; - # Need to switch to a different VGA card / GPU driver than the default one (std) so that Sway can launch: - virtualisation.qemu.options = [ "-vga virtio" ]; + # Need to switch to a different GPU driver than the default one (-vga std) so that Sway can launch: + virtualisation.qemu.options = [ "-vga none -device virtio-gpu-pci" ]; }; enableOCR = true; @@ -101,6 +104,10 @@ import ./make-test-python.nix ({ pkgs, lib, ...} : # Exit Sway and verify process exit status 0: machine.succeed("su - alice -c 'swaymsg exit || true'") - machine.wait_for_file("/tmp/sway-exit-ok") + machine.wait_until_fails("pgrep -x sway") + + # TODO: Sway currently segfaults after "swaymsg exit" but only in this VM test: + # machine # [ 104.090032] sway[921]: segfault at 3f800008 ip 00007f7dbdc25f10 sp 00007ffe282182f8 error 4 in libwayland-server.so.0.1.0[7f7dbdc1f000+8000] + # machine.wait_for_file("/tmp/sway-exit-ok") ''; }) diff --git a/nixos/tests/tigervnc.nix b/nixos/tests/tigervnc.nix new file mode 100644 index 00000000000..c0a52808b27 --- /dev/null +++ b/nixos/tests/tigervnc.nix @@ -0,0 +1,53 @@ +{ system ? builtins.currentSystem +, config ? {} +, pkgs ? import ../.. { inherit system config; } +}: + +with import ../lib/testing-python.nix { inherit system pkgs; }; +makeTest { + name = "tigervnc"; + meta = with pkgs.stdenv.lib.maintainers; { + maintainers = [ lheckemann ]; + }; + + nodes = { + server = { pkgs, ...}: { + environment.systemPackages = with pkgs; [ + tigervnc # for Xvnc + xorg.xwininfo + imagemagickBig # for display with working label: support + ]; + networking.firewall.allowedTCPPorts = [ 5901 ]; + }; + + client = { pkgs, ... }: { + imports = [ ./common/x11.nix ]; + # for vncviewer + environment.systemPackages = [ pkgs.tigervnc ]; + }; + }; + + enableOCR = true; + + testScript = '' + start_all() + + for host in [server, client]: + host.succeed("echo foobar | vncpasswd -f > vncpasswd") + + server.succeed("Xvnc -geometry 720x576 :1 -PasswordFile vncpasswd &") + server.wait_until_succeeds("nc -z localhost 5901", timeout=10) + server.succeed("DISPLAY=:1 xwininfo -root | grep 720x576") + server.execute("DISPLAY=:1 display -size 360x200 -font sans -gravity south label:'HELLO VNC WORLD' &") + + client.wait_for_x() + client.execute("vncviewer server:1 -PasswordFile vncpasswd &") + client.wait_for_window(r"VNC") + client.screenshot("screenshot") + text = client.get_screen_text() + # Displayed text + assert 'HELLO VNC WORLD' in text + # Client window title + assert 'TigerVNC' in text + ''; +} diff --git a/nixos/tests/trafficserver.nix b/nixos/tests/trafficserver.nix index 3979a1b4a48..983ded4f172 100644 --- a/nixos/tests/trafficserver.nix +++ b/nixos/tests/trafficserver.nix @@ -104,6 +104,7 @@ import ./make-test-python.nix ({ pkgs, ... }: { ats.wait_for_open_port(80) httpbin.wait_for_unit("httpbin") httpbin.wait_for_open_port(80) + client.wait_for_unit("network-online.target") with subtest("Traffic Server is running"): out = ats.succeed("traffic_ctl server status") diff --git a/nixos/tests/tuxguitar.nix b/nixos/tests/tuxguitar.nix new file mode 100644 index 00000000000..6586132d3cd --- /dev/null +++ b/nixos/tests/tuxguitar.nix @@ -0,0 +1,24 @@ +import ./make-test-python.nix ({ pkgs, ... }: { + name = "tuxguitar"; + meta = with pkgs.lib.maintainers; { + maintainers = [ asbachb ]; + }; + + machine = { config, pkgs, ... }: { + imports = [ + ./common/x11.nix + ]; + + services.xserver.enable = true; + + environment.systemPackages = [ pkgs.tuxguitar ]; + }; + + testScript = '' + machine.wait_for_x() + machine.succeed("tuxguitar &") + machine.wait_for_window("TuxGuitar - Untitled.tg") + machine.sleep(1) + machine.screenshot("tuxguitar") + ''; +}) diff --git a/nixos/tests/txredisapi.nix b/nixos/tests/txredisapi.nix new file mode 100644 index 00000000000..bc3814a7137 --- /dev/null +++ b/nixos/tests/txredisapi.nix @@ -0,0 +1,27 @@ +import ./make-test-python.nix ({ pkgs, ... }: +{ + name = "txredisapi"; + meta = with pkgs.lib.maintainers; { + maintainers = [ dandellion ]; + }; + + nodes = { + machine = + { pkgs, ... }: + + { + services.redis.enable = true; + services.redis.unixSocket = "/run/redis/redis.sock"; + + environment.systemPackages = with pkgs; [ (python38.withPackages (ps: [ ps.twisted ps.txredisapi ps.mock ]))]; + }; + }; + + testScript = '' + start_all() + machine.wait_for_unit("redis") + machine.wait_for_open_port("6379") + + tests = machine.succeed("PYTHONPATH=\"${pkgs.python3Packages.txredisapi.src}\" python -m twisted.trial ${pkgs.python3Packages.txredisapi.src}/tests") + ''; +}) diff --git a/nixos/tests/ucarp.nix b/nixos/tests/ucarp.nix new file mode 100644 index 00000000000..1f60f770d3a --- /dev/null +++ b/nixos/tests/ucarp.nix @@ -0,0 +1,66 @@ +import ./make-test-python.nix ({ pkgs, lib, ...} : + +let + addrShared = "192.168.0.1"; + addrHostA = "192.168.0.10"; + addrHostB = "192.168.0.11"; + + mkUcarpHost = addr: { config, pkgs, lib, ... }: { + networking.interfaces.eth1.ipv4.addresses = lib.mkForce [ + { address = addr; prefixLength = 24; } + ]; + + networking.ucarp = { + enable = true; + interface = "eth1"; + srcIp = addr; + vhId = 1; + passwordFile = "${pkgs.writeText "ucarp-pass" "secure"}"; + addr = addrShared; + upscript = pkgs.writeScript "upscript" '' + #!/bin/sh + ${pkgs.iproute2}/bin/ip addr add "$2"/24 dev "$1" + ''; + downscript = pkgs.writeScript "downscript" '' + #!/bin/sh + ${pkgs.iproute2}/bin/ip addr del "$2"/24 dev "$1" + ''; + }; + }; +in { + name = "ucarp"; + meta.maintainers = with lib.maintainers; [ oxzi ]; + + nodes = { + hostA = mkUcarpHost addrHostA; + hostB = mkUcarpHost addrHostB; + }; + + testScript = '' + def is_master(host): + ipOutput = host.succeed("ip addr show dev eth1") + return "inet ${addrShared}/24" in ipOutput + + + start_all() + + # First, let both hosts start and let a master node be selected + for host, peer in [(hostA, "${addrHostB}"), (hostB, "${addrHostA}")]: + host.wait_for_unit("ucarp.service") + host.succeed(f"ping -c 1 {peer}") + + hostA.sleep(5) + + hostA_master, hostB_master = is_master(hostA), is_master(hostB) + assert hostA_master != hostB_master, "only one master node is allowed" + + master_host = hostA if hostA_master else hostB + backup_host = hostB if hostA_master else hostA + + # Let's crash the master host and let the backup take over + master_host.crash() + + backup_host.sleep(5) + assert is_master(backup_host), "backup did not take over" + ''; +}) diff --git a/nixos/tests/vault.nix b/nixos/tests/vault.nix index 59bccbe2595..c3b28b62695 100644 --- a/nixos/tests/vault.nix +++ b/nixos/tests/vault.nix @@ -19,6 +19,8 @@ import ./make-test-python.nix ({ pkgs, ... }: machine.wait_for_unit("vault.service") machine.wait_for_open_port(8200) machine.succeed("vault operator init") - machine.succeed("vault status | grep Sealed | grep true") + # vault now returns exit code 2 for sealed vaults + machine.fail("vault status") + machine.succeed("vault status || test $? -eq 2") ''; }) diff --git a/nixos/tests/bitwarden.nix b/nixos/tests/vaultwarden.nix index 3813a1f70f9..b5343f5cad2 100644 --- a/nixos/tests/bitwarden.nix +++ b/nixos/tests/vaultwarden.nix @@ -4,7 +4,7 @@ }: # These tests will: -# * Set up a bitwarden-rs server +# * Set up a vaultwarden server # * Have Firefox use the web vault to create an account, log in, and save a password to the valut # * Have the bw cli log in and read that password from the vault # @@ -24,8 +24,8 @@ let storedPassword = "seeeecret"; - makeBitwardenTest = backend: makeTest { - name = "bitwarden_rs-${backend}"; + makeVaultwardenTest = backend: makeTest { + name = "vaultwarden-${backend}"; meta = { maintainers = with pkgs.lib.maintainers; [ jjjollyjim ]; }; @@ -42,12 +42,12 @@ let GRANT ALL ON `bitwarden`.* TO 'bitwardenuser'@'localhost'; FLUSH PRIVILEGES; ''; - package = pkgs.mysql; + package = pkgs.mariadb; }; - services.bitwarden_rs.config.databaseUrl = "mysql://bitwardenuser:${dbPassword}@localhost/bitwarden"; + services.vaultwarden.config.databaseUrl = "mysql://bitwardenuser:${dbPassword}@localhost/bitwarden"; - systemd.services.bitwarden_rs.after = [ "mysql.service" ]; + systemd.services.vaultwarden.after = [ "mysql.service" ]; }; postgresql = { @@ -60,9 +60,9 @@ let ''; }; - services.bitwarden_rs.config.databaseUrl = "postgresql://bitwardenuser:${dbPassword}@localhost/bitwarden"; + services.vaultwarden.config.databaseUrl = "postgresql://bitwardenuser:${dbPassword}@localhost/bitwarden"; - systemd.services.bitwarden_rs.after = [ "postgresql.service" ]; + systemd.services.vaultwarden.after = [ "postgresql.service" ]; }; sqlite = { }; @@ -71,7 +71,7 @@ let mkMerge [ backendConfig.${backend} { - services.bitwarden_rs = { + services.vaultwarden = { enable = true; dbBackend = backend; config.rocketPort = 80; @@ -152,7 +152,7 @@ let testScript = '' start_all() - server.wait_for_unit("bitwarden_rs.service") + server.wait_for_unit("vaultwarden.service") server.wait_for_open_port(80) with subtest("configure the cli"): @@ -184,6 +184,6 @@ let in builtins.listToAttrs ( map - (backend: { name = backend; value = makeBitwardenTest backend; }) + (backend: { name = backend; value = makeVaultwardenTest backend; }) backends ) diff --git a/nixos/tests/vikunja.nix b/nixos/tests/vikunja.nix new file mode 100644 index 00000000000..bd884b37f4f --- /dev/null +++ b/nixos/tests/vikunja.nix @@ -0,0 +1,65 @@ +import ./make-test-python.nix ({ pkgs, lib, ... }: { + name = "vikunja"; + + meta = with lib.maintainers; { + maintainers = [ em0lar ]; + }; + + nodes = { + vikunjaSqlite = { ... }: { + services.vikunja = { + enable = true; + database = { + type = "sqlite"; + }; + frontendScheme = "http"; + frontendHostname = "localhost"; + }; + services.nginx.enable = true; + }; + vikunjaPostgresql = { pkgs, ... }: { + services.vikunja = { + enable = true; + database = { + type = "postgres"; + user = "vikunja-api"; + database = "vikunja-api"; + host = "/run/postgresql"; + }; + frontendScheme = "http"; + frontendHostname = "localhost"; + }; + services.postgresql = { + enable = true; + ensureDatabases = [ "vikunja-api" ]; + ensureUsers = [ + { name = "vikunja-api"; + ensurePermissions = { "DATABASE \"vikunja-api\"" = "ALL PRIVILEGES"; }; + } + ]; + }; + services.nginx.enable = true; + }; + }; + + testScript = + '' + vikunjaSqlite.wait_for_unit("vikunja-api.service") + vikunjaSqlite.wait_for_open_port(3456) + vikunjaSqlite.succeed("curl --fail http://localhost:3456/api/v1/info") + + vikunjaSqlite.wait_for_unit("nginx.service") + vikunjaSqlite.wait_for_open_port(80) + vikunjaSqlite.succeed("curl --fail http://localhost/api/v1/info") + vikunjaSqlite.succeed("curl --fail http://localhost") + + vikunjaPostgresql.wait_for_unit("vikunja-api.service") + vikunjaPostgresql.wait_for_open_port(3456) + vikunjaPostgresql.succeed("curl --fail http://localhost:3456/api/v1/info") + + vikunjaPostgresql.wait_for_unit("nginx.service") + vikunjaPostgresql.wait_for_open_port(80) + vikunjaPostgresql.succeed("curl --fail http://localhost/api/v1/info") + vikunjaPostgresql.succeed("curl --fail http://localhost") + ''; +}) diff --git a/nixos/tests/web-servers/unit-php.nix b/nixos/tests/web-servers/unit-php.nix index c4e89f069f1..00512b506cc 100644 --- a/nixos/tests/web-servers/unit-php.nix +++ b/nixos/tests/web-servers/unit-php.nix @@ -1,6 +1,6 @@ import ../make-test-python.nix ({pkgs, ...}: - let - testdir = pkgs.writeTextDir "www/info.php" "<?php phpinfo();"; +let + testdir = pkgs.writeTextDir "www/info.php" "<?php phpinfo();"; in { name = "unit-php-test"; @@ -9,37 +9,27 @@ in { machine = { config, lib, pkgs, ... }: { services.unit = { enable = true; - config = '' - { - "listeners": { - "*:9074": { - "application": "php_74" - } - }, - "applications": { - "php_74": { - "type": "php 7.4", - "processes": 1, - "user": "testuser", - "group": "testgroup", - "root": "${testdir}/www", - "index": "info.php", - "options": { - "file": "${pkgs.unit.usedPhp74}/lib/php.ini" - } - } - } - } - ''; + config = pkgs.lib.strings.toJSON { + listeners."*:9080".application = "php_80"; + applications.php_80 = { + type = "php 8.0"; + processes = 1; + user = "testuser"; + group = "testgroup"; + root = "${testdir}/www"; + index = "info.php"; + options.file = "${pkgs.unit.usedPhp80}/lib/php.ini"; + }; + }; }; users = { users.testuser = { isSystemUser = true; - uid = 1074; + uid = 1080; group = "testgroup"; }; groups.testgroup = { - gid= 1074; + gid = 1080; }; }; }; @@ -47,8 +37,8 @@ in { machine.wait_for_unit("unit.service") # Check so we get an evaluated PHP back - response = machine.succeed("curl -f -vvv -s http://127.0.0.1:9074/") - assert "PHP Version ${pkgs.unit.usedPhp74.version}" in response, "PHP version not detected" + response = machine.succeed("curl -f -vvv -s http://127.0.0.1:9080/") + assert "PHP Version ${pkgs.unit.usedPhp80.version}" in response, "PHP version not detected" # Check so we have database and some other extensions loaded for ext in ["json", "opcache", "pdo_mysql", "pdo_pgsql", "pdo_sqlite"]: diff --git a/nixos/tests/wiki-js.nix b/nixos/tests/wiki-js.nix index 9aa87d15366..783887d2dca 100644 --- a/nixos/tests/wiki-js.nix +++ b/nixos/tests/wiki-js.nix @@ -119,7 +119,7 @@ import ./make-test-python.nix ({ pkgs, lib, ...} : { with subtest("Setup"): result = machine.succeed( - "set -o pipefail; curl -sSf localhost:3000/finalize -X POST -d " + "curl -sSf localhost:3000/finalize -X POST -d " + "@${payloads.finalize} -H 'Content-Type: application/json' " + "| jq .ok | xargs echo" ) @@ -132,7 +132,7 @@ import ./make-test-python.nix ({ pkgs, lib, ...} : { with subtest("Base functionality"): auth = machine.succeed( - "set -o pipefail; curl -sSf localhost:3000/graphql -X POST " + "curl -sSf localhost:3000/graphql -X POST " + "-d @${payloads.login} -H 'Content-Type: application/json' " + "| jq '.[0].data.authentication.login.jwt' | xargs echo" ).strip() @@ -140,7 +140,7 @@ import ./make-test-python.nix ({ pkgs, lib, ...} : { assert auth create = machine.succeed( - "set -o pipefail; curl -sSf localhost:3000/graphql -X POST " + "curl -sSf localhost:3000/graphql -X POST " + "-d @${payloads.content} -H 'Content-Type: application/json' " + f"-H 'Authorization: Bearer {auth}' " + "| jq '.[0].data.pages.create.responseResult.succeeded'|xargs echo" diff --git a/nixos/tests/wordpress.nix b/nixos/tests/wordpress.nix index a5c10c2de74..45c58b5b65c 100644 --- a/nixos/tests/wordpress.nix +++ b/nixos/tests/wordpress.nix @@ -10,48 +10,68 @@ import ./make-test-python.nix ({ pkgs, ... }: ]; }; - machine = - { ... }: - { services.httpd.adminAddr = "webmaster@site.local"; + nodes = { + wp_httpd = { ... }: { + services.httpd.adminAddr = "webmaster@site.local"; services.httpd.logPerVirtualHost = true; - services.wordpress."site1.local" = { - database.tablePrefix = "site1_"; + services.wordpress = { + # Test support for old interface + "site1.local" = { + database.tablePrefix = "site1_"; + }; + sites = { + "site2.local" = { + database.tablePrefix = "site2_"; + }; + }; }; - services.wordpress."site2.local" = { - database.tablePrefix = "site2_"; + networking.firewall.allowedTCPPorts = [ 80 ]; + networking.hosts."127.0.0.1" = [ "site1.local" "site2.local" ]; + }; + + wp_nginx = { ... }: { + services.wordpress.webserver = "nginx"; + services.wordpress.sites = { + "site1.local" = { + database.tablePrefix = "site1_"; + }; + "site2.local" = { + database.tablePrefix = "site2_"; + }; }; + networking.firewall.allowedTCPPorts = [ 80 ]; networking.hosts."127.0.0.1" = [ "site1.local" "site2.local" ]; }; + }; testScript = '' import re start_all() - machine.wait_for_unit("httpd") - - machine.wait_for_unit("phpfpm-wordpress-site1.local") - machine.wait_for_unit("phpfpm-wordpress-site2.local") + wp_httpd.wait_for_unit("httpd") + wp_nginx.wait_for_unit("nginx") site_names = ["site1.local", "site2.local"] - with subtest("website returns welcome screen"): + for machine in (wp_httpd, wp_nginx): for site_name in site_names: - assert "Welcome to the famous" in machine.succeed(f"curl -fL {site_name}") + machine.wait_for_unit(f"phpfpm-wordpress-{site_name}") - with subtest("wordpress-init went through"): - for site_name in site_names: - info = machine.get_unit_info(f"wordpress-init-{site_name}") - assert info["Result"] == "success" + with subtest("website returns welcome screen"): + assert "Welcome to the famous" in machine.succeed(f"curl -L {site_name}") - with subtest("secret keys are set"): - pattern = re.compile(r"^define.*NONCE_SALT.{64,};$", re.MULTILINE) - for site_name in site_names: - assert pattern.search( - machine.succeed(f"cat /var/lib/wordpress/{site_name}/secret-keys.php") - ) + with subtest("wordpress-init went through"): + info = machine.get_unit_info(f"wordpress-init-{site_name}") + assert info["Result"] == "success" + + with subtest("secret keys are set"): + pattern = re.compile(r"^define.*NONCE_SALT.{64,};$", re.MULTILINE) + assert pattern.search( + machine.succeed(f"cat /var/lib/wordpress/{site_name}/secret-keys.php") + ) ''; }) diff --git a/nixos/tests/xandikos.nix b/nixos/tests/xandikos.nix index 48c770a3d16..69d78ee21e7 100644 --- a/nixos/tests/xandikos.nix +++ b/nixos/tests/xandikos.nix @@ -44,7 +44,7 @@ import ./make-test-python.nix ( xandikos_default.wait_for_open_port(8080) xandikos_default.succeed("curl --fail http://localhost:8080/") xandikos_default.succeed( - "curl -s --fail --location http://localhost:8080/ | grep -qi Xandikos" + "curl -s --fail --location http://localhost:8080/ | grep -i Xandikos" ) xandikos_client.wait_for_unit("network.target") xandikos_client.fail("curl --fail http://xandikos_default:8080/") @@ -55,15 +55,15 @@ import ./make-test-python.nix ( xandikos_proxy.wait_for_open_port(8080) xandikos_proxy.succeed("curl --fail http://localhost:8080/") xandikos_proxy.succeed( - "curl -s --fail --location http://localhost:8080/ | grep -qi Xandikos" + "curl -s --fail --location http://localhost:8080/ | grep -i Xandikos" ) xandikos_client.wait_for_unit("network.target") xandikos_client.fail("curl --fail http://xandikos_proxy:8080/") xandikos_client.succeed( - "curl -s --fail -u xandikos:snakeOilPassword -H 'Host: xandikos.local' http://xandikos_proxy/xandikos/ | grep -qi Xandikos" + "curl -s --fail -u xandikos:snakeOilPassword -H 'Host: xandikos.local' http://xandikos_proxy/xandikos/ | grep -i Xandikos" ) xandikos_client.succeed( - "curl -s --fail -u xandikos:snakeOilPassword -H 'Host: xandikos.local' http://xandikos_proxy/xandikos/user/ | grep -qi Xandikos" + "curl -s --fail -u xandikos:snakeOilPassword -H 'Host: xandikos.local' http://xandikos_proxy/xandikos/user/ | grep -i Xandikos" ) ''; } diff --git a/nixos/tests/yggdrasil.nix b/nixos/tests/yggdrasil.nix index 0e75ed54db2..b409d9ed785 100644 --- a/nixos/tests/yggdrasil.nix +++ b/nixos/tests/yggdrasil.nix @@ -1,23 +1,19 @@ let - aliceIp6 = "200:3b91:b2d8:e708:fbf3:f06:fdd5:90d0"; + aliceIp6 = "202:b70:9b0b:cf34:f93c:8f18:bbfd:7034"; aliceKeys = { - EncryptionPublicKey = "13e23986fe76bc3966b42453f479bc563348b7ff76633b7efcb76e185ec7652f"; - EncryptionPrivateKey = "9f86947b15e86f9badac095517a1982e39a2db37ca726357f95987b898d82208"; - SigningPublicKey = "e2c43349083bc1e998e4ec4535b4c6a8f44ca9a5a8e07336561267253b2be5f4"; - SigningPrivateKey = "fe3add8da35316c05f6d90d3ca79bd2801e6ccab6d37e5339fef4152589398abe2c43349083bc1e998e4ec4535b4c6a8f44ca9a5a8e07336561267253b2be5f4"; + PublicKey = "3e91ec9e861960d86e1ce88051f97c435bdf2859640ab681dfa906eb45ad5182"; + PrivateKey = "a867f9e078e4ce58d310cf5acd4622d759e2a21df07e1d6fc380a2a26489480d3e91ec9e861960d86e1ce88051f97c435bdf2859640ab681dfa906eb45ad5182"; }; - bobIp6 = "201:ebbd:bde9:f138:c302:4afa:1fb6:a19a"; - bobPrefix = "301:ebbd:bde9:f138"; + bobIp6 = "202:a483:73a4:9f2d:a559:4a19:bc9:8458"; + bobPrefix = "302:a483:73a4:9f2d"; bobConfig = { InterfacePeers = { eth1 = [ "tcp://192.168.1.200:12345" ]; }; MulticastInterfaces = [ "eth1" ]; LinkLocalTCPPort = 54321; - EncryptionPublicKey = "c99d6830111e12d1b004c52fe9e5a2eef0f6aefca167aca14589a370b7373279"; - EncryptionPrivateKey = "2e698a53d3fdce5962d2ff37de0fe77742a5c8b56cd8259f5da6aa792f6e8ba3"; - SigningPublicKey = "de111da0ec781e45bf6c63ecb45a78c24d7d4655abfaeea83b26c36eb5c0fd5b"; - SigningPrivateKey = "2a6c21550f3fca0331df50668ffab66b6dce8237bcd5728e571e8033b363e247de111da0ec781e45bf6c63ecb45a78c24d7d4655abfaeea83b26c36eb5c0fd5b"; + PublicKey = "2b6f918b6c1a4b54d6bcde86cf74e074fb32ead4ee439b7930df2aa60c825186"; + PrivateKey = "0c4a24acd3402722ce9277ed179f4a04b895b49586493c25fbaed60653d857d62b6f918b6c1a4b54d6bcde86cf74e074fb32ead4ee439b7930df2aa60c825186"; }; danIp6 = bobPrefix + "::2"; diff --git a/nixos/tests/zfs.nix b/nixos/tests/zfs.nix index ba5eb7cd528..d25090403e5 100644 --- a/nixos/tests/zfs.nix +++ b/nixos/tests/zfs.nix @@ -18,13 +18,29 @@ let maintainers = [ adisbladis ]; }; - machine = { pkgs, lib, ... }: { + machine = { pkgs, lib, ... }: + let + usersharePath = "/var/lib/samba/usershares"; + in { virtualisation.emptyDiskImages = [ 4096 ]; networking.hostId = "deadbeef"; boot.kernelPackages = kernelPackage; boot.supportedFilesystems = [ "zfs" ]; boot.zfs.enableUnstable = enableUnstable; + services.samba = { + enable = true; + extraConfig = '' + registry shares = yes + usershare path = ${usersharePath} + usershare allow guests = yes + usershare max shares = 100 + usershare owner only = no + ''; + }; + systemd.services.samba-smbd.serviceConfig.ExecStartPre = + "${pkgs.coreutils}/bin/mkdir -m +t -p ${usersharePath}"; + environment.systemPackages = [ pkgs.parted ]; # Setup regular fileSystems machinery to ensure forceImportAll can be @@ -58,8 +74,15 @@ let "udevadm settle", "zpool create rpool /dev/vdb1", "zfs create -o mountpoint=legacy rpool/root", + # shared datasets cannot have legacy mountpoint + "zfs create rpool/shared_smb", "mount -t zfs rpool/root /tmp/mnt", "udevadm settle", + # wait for samba services + "systemctl is-system-running --wait", + "zfs set sharesmb=on rpool/shared_smb", + "zfs share rpool/shared_smb", + "smbclient -gNL localhost | grep rpool_shared_smb", "umount /tmp/mnt", "zpool destroy rpool", "udevadm settle", diff --git a/nixos/tests/zsh-history.nix b/nixos/tests/zsh-history.nix index 3109c3f6508..35568779840 100644 --- a/nixos/tests/zsh-history.nix +++ b/nixos/tests/zsh-history.nix @@ -23,7 +23,7 @@ import ./make-test-python.nix ({ pkgs, ...} : { # Login default.wait_until_tty_matches(1, "login: ") default.send_chars("root\n") - default.wait_until_tty_matches(1, "root@default>") + default.wait_until_tty_matches(1, r"\nroot@default\b") # Generate some history default.send_chars("echo foobar\n") |