GitOrigin-RevId: f91ee3065de91a3531329a674a45ddcb3467a650
54 KiB
Release 23.05 (“Stoat”, 2023.05/??)
Support is planned until the end of December 2023, handing over to 23.11.
Highlights
In addition to numerous new and upgraded packages, this release has the following highlights:
-
Core version changes:
-
default linux: 5.15 -> 6.1, all supported kernels available
-
systemd has been updated to v253.1, see the pull request for more info. It's recommended to use
nixos-rebuild boot
andreboot
, rather thannixos-rebuild switch
- since in some rare cases the switch of a live system might fail. -
glibc: 2.35 -> 2.37
-
-
Cinnamon has been updated to 5.6, see the pull request for what is changed.
-
GNOME has been upgraded to version 44. Please see the release notes for details.
-
KDE Plasma has been updated to v5.27, see the release notes for what is changed.
-
Python implements PEP 668, providing better feedback to users that try to run
pip install
system-wide. -
nixos-rebuild
now supports an extra--specialisation
option that can be used to change specialisation forswitch
andtest
commands. -
libxcrypt
, the library providing thecrypt(3)
password hashing function, is now built without support for algorithms not flaggedstrong
. This affects the availability of password hashing algorithms used for system login (login(1)
,passwd(1)
), but also Apache2 Basic-Auth, Samba, OpenLDAP, Dovecot, and many other packages. -
boot.bootspec.enable
(internal option) is now enabled by default because RFC-0125 was merged. This means you will have a bootspec document calledboot.json
generated for each system and specialisation in the top-level. This is useful to enable advanced boot usecases in NixOS such as SecureBoot.
New Services
-
Akkoma, an ActivityPub microblogging server. Available as services.akkoma.
-
Pixelfed, an Instagram-like ActivityPub server. Available as services.pixelfed.
-
blesh, a line editor written in pure bash. Available as programs.bash.blesh.
-
webhook, a lightweight webhook server. Available as services.webhook.
-
cups-pdf-to-pdf, a pdf-generating cups backend based on cups-pdf. Available as services.printing.cups-pdf.
-
clash-verge, A Clash GUI based on tauri. Available as programs.clash-verge.
-
Cloudlog, a web-based Amateur Radio logging application. Available as services.cloudlog.
-
Deepin Desktop Environment, an elegant, easy to use and reliable desktop environment. Available as services.xserver.desktopManager.deepin.
-
system-repart, grow and add partitions to a partition table. Available as systemd.repart and boot.initrd.systemd.repart
-
frigate, an open source NVR built around real-time AI object detection. Available as services.frigate.
-
fzf, a command line fuzzyfinder. Available as programs.fzf.
-
readarr, Book Manager and Automation (Sonarr for Ebooks). Available as services.readarr.
-
gemstash, a RubyGems.org cache and private gem server. Available as services.gemstash.
-
gitea-actions-runner, a CI runner for Gitea/Forgejo Actions. Available as services.gitea-actions-runner.
-
gmediarender, a simple, headless UPnP/DLNA renderer. Available as services.gmediarender.
-
go2rtc, a camera streaming appliation with support for RTSP, WebRTC, HomeKit, FFMPEG, RTMP and other protocols. Available as services.go2rtc.
-
harmonia, Nix binary cache implemented in rust using libnix-store. Available as services.harmonia.
-
hyprland, a dynamic tiling Wayland compositor that doesn't sacrifice on its looks. Available as programs.hyprland.
-
minipro, an open source program for controlling the MiniPRO TL866xx series of chip programmers. Available as programs.minipro.
-
stevenblack-blocklist, A unified hosts file with base extensions for blocking unwanted websites. Available as networking.stevenblack.
-
Budgie Desktop, a familiar, modern desktop environment. Available as services.xserver.desktopManager.budgie.
-
imaginary, a microservice for high-level image processing that Nextcloud can use to generate previews. Available as services.imaginary.
-
opensearch, a search server alternative to Elasticsearch. Available as services.opensearch.
-
kavita, a self-hosted digital library. Available as services.kavita.
-
monica, an open source personal CRM. Available as services.monica.
-
authelia, is an open-source authentication and authorization server. Available under services.authelia.
-
goeland, an alternative to rss2email written in golang with many filters. Available as services.goeland.
-
alertmanager-irc-relay, a Prometheus Alertmanager IRC Relay. Available as services.prometheus.alertmanagerIrcRelay.
-
tts, a battle-tested deep learning toolkit for Text-to-Speech. Multiple servers may be configured below services.tts.servers.
-
atuin, a sync server for shell history. Available as services.atuin.
-
esphome, a dashboard to configure ESP8266/ESP32 devices for use with Home Automation systems. Available as services.esphome.
-
networkd-dispatcher, a dispatcher service for systemd-networkd connection status changes. Available as services.networkd-dispatcher.
-
gonic, a Subsonic music streaming server. Available as services.gonic.
-
mmsd, a lower level daemon that transmits and receives MMSes. Available as services.mmsd.
-
QDMR, a GUI application and command line tool for programming DMR radios programs.qdmr
-
keyd, a key remapping daemon for linux. Available as services.keyd.
-
consul-template, a template rendering, notifier, and supervisor for HashiCorp Consul and Vault data. Available as services.consul-template.
-
vault-agent, a template rendering and API auth proxy for HashiCorp Vault, similar to
consul-template
. Available as services.vault-agent. -
trippy, a network diagnostic tool. Available as programs.trippy.
-
v2rayA, a Linux web GUI client of Project V which supports V2Ray, Xray, SS, SSR, Trojan and Pingtunnel. Available as services.v2raya.
-
rshim, the user-space rshim driver for the BlueField SoC. Available as services.rshim.
-
wstunnel, a proxy tunnelling arbitrary TCP or UDP traffic through a WebSocket connection. Instances may be configured via services.wstunnel.
-
ulogd, a userspace logging daemon for netfilter/iptables related logging. Available as services.ulogd.
-
PufferPanel, game server management panel designed to be easy to use. Available as services.pufferpanel.
-
jellyseerr, a web-based requests manager for Jellyfin, forked from Overseerr. Available as services.jellyseerr.
-
stargazer, a fast and easy to use Gemini server. Available as services.stargazer.
-
sniffnet, an application to monitor your network traffic. Available as programs.sniffnet.
-
photoprism, a AI-Powered Photos App for the Decentralized Web. Available as services.photoprism.
-
alice-lg, a looking-glass for BGP sessions. Available as services.alice-lg.
-
birdwatcher, a small HTTP server meant to provide an API defined by Barry O'Donovan's birds-eye to the BIRD internet routing daemon. Available as services.birdwatcher.
-
peroxide, a fork of the official ProtonMail bridge that aims to be similar to Hydroxide. Available as services.peroxide.
-
autosuspend, a python daemon that suspends a system if certain conditions are met, or not met.
-
sharing, a command-line tool to share directories and files from the CLI to iOS and Android devices without the need of an extra client app. Available as programs.sharing.
-
nimdow, a window manager written in Nim, inspired by dwm.
-
trurl, a command line tool for URL parsing and manipulation.
-
wgautomesh, a simple utility to help connect wireguard nodes together in a full mesh topology. Available as services.wgautomesh.
-
woodpecker-agents, a simple CI engine with great extensibility. Available as services.woodpecker-agents.
-
woodpecker-server, a simple CI engine with great extensibility. Available as services.woodpecker-server.
-
lldap, a lightweight authentication server that provides an opinionated, simplified LDAP interface for authentication. Available as services.lldap.
-
ReGreet, a clean and customizable greeter for greetd. Available as programs.regreet.
-
v4l2-relayd, a streaming relay for v4l2loopback using gstreamer. Available as services.v4l2-relayd.
-
hardware.ipu6 adds support for ipu6 based webcams on intel tiger lake and alder lake.
-
ivpn, a secure, private VPN with fast WireGuard connections. Available as services.ivpn.
-
openvscode-server, run VS Code on a remote machine with access through a modern web browser from any device, anywhere. Available as services.openvscode-server.
Backward Incompatibilities
-
carnix
andcratesIO
has been removed due to being unmaintained, use alternatives such as naersk and crate2nix instead. -
services.asusd
configuration now uses strings instead of structured configuration, as upstream switched to the RON configuration format. Support for structured configuration may return when RON generation is implemented in nixpkgs. -
checkInputs
have been renamed tonativeCheckInputs
, because they behave the same asnativeBuildInputs
whendoCheck
is set.checkInputs
now denote a new type of dependencies, added tobuildInputs
whendoCheck
is set. As a rule of thumb,nativeCheckInputs
are tools on$PATH
used during the tests, andcheckInputs
are libraries which are linked to executables built as part of the tests. Similarly,installCheckInputs
are renamed tonativeInstallCheckInputs
, corresponding tonativeBuildInputs
, andinstallCheckInputs
are a new type of dependencies added tobuildInputs
whendoInstallCheck
is set. (Note that this change will not cause breakage to derivations withstrictDeps
unset, which are most packages except python, rust, ocaml and go packages). -
buildDunePackage
now defaults tostrictDeps = true
which means that any library should go intobuildInputs
orcheckInputs
. Any executable that is run on the building machine should go intonativeBuildInputs
ornativeCheckInputs
respectively. Example of executables areocaml
,findlib
andmenhir
. PPXs are libraries which are built by dune and should therefore not go intonativeBuildInputs
. -
borgbackup
module now has an option for inhibiting system sleep while backups are running, defaulting to off (not inhibiting sleep), available asservices.borgbackup.jobs.<name>.inhibitsSleep
. -
The
ssh
client tool now disables the~C
escape sequence by default. This can be re-enabled by settingEnableEscapeCommandline yes
-
Many
services.syncthing
options have been moved toservices.syncthing.settings
, as part of RFC 42's implementation, see #226088. -
The
ssh
module does not read/etc/ssh/ssh_known_hosts2
anymore since this location is deprecated since 2001. -
The openssh module does not read
~/.ssh/authorized_keys2
anymore since this location is deprecated since 2001. -
podman
now uses thenetavark
network stack. Users will need to delete all of their local containers, images, volumes, etc, by runningpodman system reset --force
once before upgrading their systems. -
git-bug
has been updated to at least version 0.8.0, which includes backwards incompatible changes. Thegit-bug-migration
package can be used to upgrade existing repositories. -
graylog
has been updated to version 5, which can not be upgraded directly from the previously packaged version 3.3. If you had installed the previously packaged version 3.3, please follow the upgrade path from 3.3 to 4.0 to 4.3 to 5.0. -
nushell
has been updated to at least version 0.77.0, which includes potential breaking changes in aliases. The old aliases are now available asold-alias
but it is recommended you migrate to the new format. See Reworked aliases. -
gajim
has been updated to version 1.7.3 which has disabled legacy ciphers. See changelog for version 1.7.0. -
keepassx
andkeepassx2
have been removed, due to upstream stopping development. Consider KeePassXC as a maintained alternative. -
The services.kubo.settings option is now no longer stateful. If you changed any of the options in services.kubo.settings in the past and then removed them from your NixOS configuration again, those changes are still in your Kubo configuration file but will now be reset to the default. If you're unsure, you may want to make a backup of your configuration file (probably /var/lib/ipfs/config) and compare after the update.
-
The Kubo HTTP API will no longer listen on localhost and will instead only listen on a Unix domain socket by default. Read the services.kubo.settings.Addresses.API option description for more information.
-
The EC2 image module no longer fetches instance metadata in stage-1. This results in a significantly smaller initramfs, since network drivers no longer need to be included, and faster boots, since metadata fetching can happen in parallel with startup of other services. This breaks services which rely on metadata being present by the time stage-2 is entered. Anything which reads EC2 metadata from
/etc/ec2-metadata
should now have anafter
dependency onfetch-ec2-metadata.service
-
The mailman service now defaults to using a randomly generated REST API password instead of a hardcoded one.
-
minio
removed support for its legacy filesystem backend in RELEASE.2022-10-29T06-21-33Z. This means if your storage was created with the old format, minio will no longer start. Unfortunately minio doesn't provide a an automatic migration, they only provide instructions how to manually convert the node. To facilitate this migration we keep around the last version that still supports the old filesystem backend asminio_legacy_fs
. Use it viaservices.minio.package = minio_legacy_fs;
to export your data before switching to the new version. See the corresponding issue for more details. -
services.sourcehut.dispatch
and the corresponding package (sourcehut.dispatchsrht
) have been removed due to upstream deprecation. -
The attributes used by
services.snapper.configs.<name>
have changed. Migrate from this:services.snapper.configs.example = { subvolume = "/example"; extraConfig = '' ALLOW_USERS="alice" ''; };
to this:
services.snapper.configs.example = { SUBVOLUME = "/example"; ALLOW_USERS = [ "alice" ]; };
-
The services.snapserver.openFirewall module option default value has been changed from
true
tofalse
. You will need to explicitly set this option totrue
, or configure your firewall. -
The services.tmate-ssh-server.openFirewall module option default value has been changed from
true
tofalse
. You will need to explicitly set this option totrue
, or configure your firewall. -
The services.unifi-video.openFirewall module option default value has been changed from
true
tofalse
. You will need to explicitly set this option totrue
, or configure your firewall. -
The option
i18n.inputMethod.fcitx5.enableRimeData
has been removed. Default RIME data is now included infcitx5-rime
by default, and can be customized usingfcitx5-rime.override { rimeDataPkgs = [ pkgs.rime-data, package2, ... ]; }
-
The udev hwdb.bin file is now built with systemd-hwdb rather than the deprecated "udevadm hwdb". This may impact mappings where the same key is defined in multiple matching entries. The updated behavior will select the latest definition in case of conflict. In general, this should be a positive change, as the hwdb source files are designed with this ordering in mind. As an example, the mapping of the HP Dev One keyboard scan code for "mute mic" is corrected by this update. This change may impact users who have worked-around previously incorrect mappings.
-
Kime has been updated from 2.5.6 to 3.0.2 and the
i18n.inputMethod.kime.config
option has been removed. Users should usedaemonModules
,iconColor
, andextraConfig
options underi18n.inputMethod.kime
instead. -
tut
has been updated from 1.0.34 to 2.0.0, and now uses the TOML format for the configuration file instead of INI. Additional information can be found here. -
i3status-rust
has been updated from 0.22.0 to 0.30.5, and this brings many changes to its configuration format. Additional information can be found here. -
The
wordpress
derivation no longer contains any builtin plugins or themes. If you need them you have to add them back to prevent your site from breaking. You can find them inwordpressPackages.{plugins,themes}
. -
llvmPackages_rocm.llvm
will not containclang
orcompiler-rt
.llvmPackages_rocm.clang
will not containllvm
.llvmPackages_rocm.clangNoCompilerRt
has been removed in favor of usingllvmPackages_rocm.clang-unwrapped
. -
services.xserver.desktopManager.plasma5.excludePackages
has been moved toenvironment.plasma5.excludePackages
, for consistency with other Desktop Environments -
The EC2 image module previously detected and automatically mounted ext3-formatted instance store devices and partitions in stage-1 (initramfs), storing
/tmp
on the first discovered device. This behaviour, which only catered to very specific use cases and could not be disabled, has been removed. Users relying on this should provide their own implementation, and probably use ext4 and perform the mount in stage-2. -
teleport
has been upgraded from major version 10 to major version 12. Please see upstream upgrade instructions and release notes for versions 11 and 12. Note that Teleport does not officially support upgrades across more than one major version at a time. If you're running Teleport server components, it is recommended to first upgrade to an intermediate 11.x version by settingservices.teleport.package = pkgs.teleport_11
. Afterwards, this option can be removed to upgrade to the default version (12). -
The EC2 image module previously detected and activated swap-formatted instance store devices and partitions in stage-1 (initramfs). This behaviour has been removed. Users relying on this should provide their own implementation.
-
fail2ban
has been updated to 1.0.2, which has a few breaking changes compared to 0.11.2 (changelog for 1.0.1, changelog for 1.0.2) -
albert
has been updated from 0.17.6 to 0.20.13, and 0.18.0 changed the config format and many plugins (changelog for 0.18.0) -
Calling
makeSetupHook
without passing aname
argument is deprecated. -
Top-level buildPlatform,hostPlatform,targetPlatform have been deprecated, use stdenv.X instead.
-
lib.systems.examples.ghcjs
and consequentlypkgsCross.ghcjs
now use the target tripletjavascript-unknown-ghcjs
instead ofjs-unknown-ghcjs
. This has been done to match an upstream decision to follow Cabal's platform naming more closely. Nixpkgs will also rejectjs
as an architecture name. -
dokuwiki
has been updated from 2023-07-31a (Igor) to 2023-04-04 (Jack Jackrum), which has completely removed the options to embed HTML and PHP for security reasons. The htmlok plugin can be used to regain this functionality. -
The old unsupported version 6.x of the ELK-stack and Elastic beats have been removed. Use OpenSearch instead.
-
The
cosmoc
package has been removed. The upstream scripts incosmocc
should be used instead. -
Qt 5.12 and 5.14 have been removed, as the corresponding branches have been EOL upstream for a long time. This affected under 10 packages in nixpkgs, largely unmaintained upstream as well, however, out-of-tree package expressions may need to be updated manually.
-
The services.wordpress.sites.<name>.plugins and services.wordpress.sites.<name>.themes options have been converted from sets to attribute sets to allow for consumers to specify explicit install paths via attribute name.
-
services.nextcloud.database.createLocally
now uses socket authentication and is no longer compatible with password authentication.- If you want the module to manage the database for you, unset
services.nextcloud.config.dbpassFile
(andservices.nextcloud.config.dbhost
, if it's set). - If you want to use password authentication and create the database locally, you will have to use
services.mysql
to set it up.
- If you want the module to manage the database for you, unset
-
protonmail-bridge
package has been updated to major version 3. -
Nebula now runs as a system user and group created for each nebula network, using the
CAP_NET_ADMIN
ambient capability on launch rather than starting as root. Ensure that any files each Nebula instance needs to access are owned by the correct user and group, by defaultnebula-${networkName}
. -
The
i18n.inputMethod.fcitx
option has been replaced withi18n.inputMethod.fcitx5
because fcitx 4pkgs.fcitx
has been removed. -
In
mastodon
it is now necessary to specify location of file withPostgreSQL
database password. Inservices.mastodon.database.passwordFile
parameter default value/var/lib/mastodon/secrets/db-password
has been changed tonull
. -
The
--target-host
and--build-host
options ofnixos-rebuild
no longer treat thelocalhost
value specially – to build on/deploy to local machine, omit the relevant flag. -
The
nix.readOnlyStore
option has been renamed toboot.readOnlyNixStore
to clarify that it configures the NixOS boot process, not the Nix daemon. -
Deprecated
xlibsWrapper
transitional package has been removed in favour of direct use of its constituents:xorg.libX11
,freetype
and others. -
The latest available version of Nextcloud is v26 (available as
pkgs.nextcloud26
) which uses PHP 8.2 as interpreter by default. The installation logic is as follows:- If
system.stateVersion
is >=23.05,pkgs.nextcloud26
will be installed by default. - If
system.stateVersion
is >=22.11,pkgs.nextcloud25
will be installed by default. - Please note that an upgrade from v24 (or older) to v26 directly is not possible. Please upgrade to
nextcloud25
(or earlier) first. Nextcloud prohibits skipping major versions while upgrading. You can upgrade by declaringservices.nextcloud.package = pkgs.nextcloud25;
. - It's recommended to use the latest version available (i.e. v26) and to specify that using
services.nextcloud.package
.
- If
-
.NET 5.0 and .NET 3.1 were removed due to being end-of-life, use a newer, supported .NET version - https://dotnet.microsoft.com/en-us/platform/support/policy/dotnet-core
-
The iputils package, which is installed by default, no longer provides the
ninfod
,rarpd
andrdisc
tools. See upstream's release notes for more details and available replacements. -
The ppp plugin
rp-pppoe.so
has been renamed topppoe.so
in ppp 2.4.9. Starting from ppp 2.5.0, there is no longer a alias for backwards compatibility. Configurations that use this plugin must be updated accordingly fromplugin rp-pppoe.so
toplugin pppoe.so
. See upstream change. -
services.xserver.videoDrivers now defaults to the
modesetting
driver over device-specific ones. Theradeon
,amdgpu
andnouveau
drivers are still available, but effectively unmaintained and not recommended for use. -
services.xserver.libinput.enable is now set by default, enabling the more actively maintained and consistently behaved input device driver.
-
To enable the HTTP3 (QUIC) protocol for a nginx virtual host, set the
quic
attribute on it to true, e.g.services.nginx.virtualHosts.<name>.quic = true;
. -
In
services.fail2ban
,bantime-increment.<name>
options now default tonull
(exceptbantime-increment.enable
) and are used to set the corresponding option injail.local
only if notnull
. Also, enforce thatbantime-increment.formula
andbantime-increment.multipliers
are not both specified. -
The default Asterisk package was changed to v20 from v19. Asterisk versions 16 and 19 have been dropped due to being EOL. You may need to update /var/lib/asterisk to match the template files in
${asterisk-20}/var/lib/asterisk
. -
conntrack helper autodetection has been removed from kernels 6.0 and up upstream, and an assertion was added to ensure things don't silently stop working. Migrate your configuration to assign helpers explicitly or use an older LTS kernel branch as a temporary workaround.
-
The
services.pipewire.config
options have been removed, as they have basically never worked correctly. All behavior defined by the default configuration can be overridden with drop-in files as necessary - see below for details. -
The catch-all
hardware.video.hidpi.enable
option was removed. Users on high density displays may want to:- Set
services.xserver.upscaleDefaultCursor
to upscale the default X11 cursor for higher resolutions - Adjust settings under
fonts.fontconfig
according to preference - Adjust
console.font
according to preference, though the kernel will generally choose a reasonably sized font
- Set
-
services.pipewire.media-session
and thepipewire-media-session
package have been removed, as they are no longer supported upstream. Users are encouraged to useservices.pipewire.wireplumber
instead. -
The
baget
package and module was removed due to being unmaintained. -
The
qlandkartegt
andgarmindev
packages were removed due to being unmaintained and insecure. -
go-ethereum
package has been updated to v1.11.5 and thepuppeth
command is no longer available as of v1.11.0. -
The
pnpm
package has be updated to from version 7.29.1 to version 8.1.1 and Node.js 14 support has been discontinued (though, there are workarounds if Node.js 14 is still required) -
The
zplug
package changes its output path from$out
to$out/share/zplug
. Users should update their dependency on${pkgs.zplug}/init.zsh
to${pkgs.zplug}/share/zplug/init.zsh
. -
The
pict-rs
package was updated from an 0.3 alpha release to 0.3 stable, and related environment variables now require two underscores instead of one. -
espanso
has been updated to major version 2. Therefore, migration steps may need to be performed. See the official migration instructions for how to perform these migrations. Further,espanso-wayland
can now be used for Wayland support.
Other Notable Changes
-
vim_configurable
has been renamed tovim-full
to avoid confusion:vim-full
's build-time features are configurable, but bothvim
andvim-full
are customizable (in the sense of user configuration, like vimrc). -
Pantheon now defaults to Mutter 43 and GNOME settings daemon 43, all Pantheon packages are now tracking elementary OS 7 updates.
-
The module for the application firewall
opensnitch
got the ability to configure rules. Available as services.opensnitch.rules -
The module
usbmuxd
now has the ability to change the package used by the daemon. In case you're experiencing issues withusbmuxd
you can try an alternative program likeusbmuxd2
. Available as services.usbmuxd.package -
A few openssh options have been moved from extraConfig to the new freeform option
settings
and renamed as follows:services.openssh.forwardX11
toservices.openssh.settings.X11Forwarding
services.openssh.kbdInteractiveAuthentication
->services.openssh.settings.KbdInteractiveAuthentication
services.openssh.passwordAuthentication
toservices.openssh.settings.PasswordAuthentication
services.openssh.useDns
toservices.openssh.settings.UseDns
services.openssh.permitRootLogin
toservices.openssh.settings.PermitRootLogin
services.openssh.logLevel
toservices.openssh.settings.LogLevel
services.openssh.kexAlgorithms
toservices.openssh.settings.KexAlgorithms
services.openssh.macs
toservices.openssh.settings.Macs
services.openssh.ciphers
toservices.openssh.settings.Ciphers
services.openssh.gatewayPorts
toservices.openssh.settings.GatewayPorts
-
netbox
was updated to 3.5. NixOS'services.netbox.package
still defaults to 3.3 ifstateVersion
is earlier than 23.05. Please review upstream's breaking changes for 3.4.0 and for 3.5.0, and upgrade NetBox by changingservices.netbox.package
. Database migrations will be run automatically. -
services.netbox
now support RFC42-style options, throughservices.netbox.settings
. -
services.mastodon
gained a tootctl wrapped namedmastodon-tootctl
similar tonextcloud-occ
which can be executed from any user and switches to the configured mastodon user with sudo and sources the environment variables. -
DocBook option documentation, which has been deprecated since 22.11, will now cause a warning when documentation is built. Out-of-tree modules should migrate to using CommonMark documentation as outlined in to silence this warning.
DocBook option documentation support will be removed in the next release and CommonMark will become the default. DocBook option documentation that has not been migrated until then will no longer render properly or cause errors.
-
NixOS now defaults to using nsncd (a non-caching reimplementation in Rust) as NSS lookup dispatcher, instead of the buggy and deprecated glibc-provided nscd. If you need to switch back, set
services.nscd.enableNsncd = false
, but please open an issue in nixpkgs so your issue can be fixed. -
services.borgmatic
now allows for multiple configurations, placed in/etc/borgmatic.d/
, you can define them withservices.borgmatic.configurations
. -
service.openafsServer
features a new backup serverpkgs.fabs
as a replacement for openafs's ownbuserver
. See FABS to check if this is an viable replacement. It stores backups as volume dump files and thus better integrates into contemporary backup solutions. -
services.maddy
got several updates:- Configuration of users and their credentials using
services.maddy.ensureCredentials
. - TLS configuration is now possible via
services.maddy.tls
with two loaders present: ACME and file based.
- Configuration of users and their credentials using
-
The
dnsmasq
service now takes configuration via theservices.dnsmasq.settings
attribute set. The optionservices.dnsmasq.extraConfig
will be deprecated when NixOS 22.11 reaches end of life. -
kube3d
has now been renamed tok3d
since the 3d editor that originally took that name has been dropped from nixpkgs.kube3d
will continue to work as an alias for now. -
The
dokuwiki
service is now configured viaservices.dokuwiki.sites.<name>.settings
attribute set;extraConfig
has been removed. The{aclUse,superUser,disableActions}
attributes have been renamed accordingly.pluginsConfig
now only accepts an attribute set of booleans. Passing plain PHP is no longer possible. Same applies toacl
which now also only accepts structuredsettings
. -
The
zsh
package changes the way to set environment variables on NixOS systems whereprograms.zsh.enable
equalsfalse
. It now sources/etc/set-environment
when reading the system-levelzshenv
file. Before, it sourced/etc/profile
when reading the system-levelzprofile
file. -
The
wordpress
service now takes configuration via theservices.wordpress.sites.<name>.settings
attribute set,extraConfig
is still available to append additional text towp-config.php
. -
To reduce closure size in
nixos/modules/profiles/minimal.nix
profile disabled installation documentations and manuals. Also disabledlogrotate
andudisks2
services. -
To reduce closure size in
nixos/modules/installer/netboot/netboot-minimal.nix
profile disabled load linux firmwares, pre-installing the complete stdenv andnetworking.wireless
service. -
The minimal ISO image now uses the
nixos/modules/profiles/minimal.nix
profile. -
The
ghcWithPackages
andghcWithHoogle
wrappers will now also symlink GHC's and all included libraries' documentation to$out/share/doc
for convenience. If undesired, the old behavior can be restored by overriding the builders with{ installDocumentation = false; }
. -
The new option
networking.nftables.checkRuleset
controls whether the ruleset is checked for syntax or not during build. It istrue
by default. The check might fail because it is in a sandbox environment. To circumvent this, the ruleset file can be edited using thenetworking.nftables.preCheckRuleset
option. -
mastodon
now supports connection to a remotePostgreSQL
database. -
nextcloud
has an option to enable SSE-C in S3. -
NixOS swap partitions with random encryption can now control the sector size, cipher, and key size used to setup the plain encryption device over the underlying block device rather than allowing them to be determined by
cryptsetup(8)
. One can use these features like so:{ swapDevices = [ { device = "/dev/disk/by-partlabel/swapspace"; randomEncryption = { enable = true; cipher = "aes-xts-plain64"; keySize = 512; sectorSize = 4096; }; } ]; }
-
New option
security.pam.zfs
to enable unlocking and mounting of encrypted ZFS home dataset at login. -
services.peertube
now requires you to specify the secret filesecrets.secretsFile
. It can be generated by runningopenssl rand -hex 32
. Before upgrading, read the release notes for PeerTube:And backup your data.
-
services.chronyd
is now started with additional systemd sandbox/hardening options for better security. -
PostgreSQL has opt-in support for JIT compilation. It can be enabled like this:
{ services.postgresql = { enable = true; enableJIT = true; }; }
-
services.netdata
offers adeadlineBeforeStopSec
option which enable users who have netdata instance that takes time to initialize to not have systemd kill them for no reason. -
services.dhcpcd
service now don't solicit or accept IPv6 Router Advertisements on interfaces that use static IPv6 addresses. If network uses both IPv6 Unique local addresses (ULA) and global IPv6 address auto-configuration with SLAAC, must add the parameternetworking.dhcpcd.IPv6rs = true;
. -
The module
services.headscale
was refactored to be compliant with RFC 0042. To be precise, this means that the following things have changed:- Most settings has been migrated under services.headscale.settings which is an attribute-set that will be converted into headscale's YAML config format. This means that the configuration from headscale's example configuration can be directly written as attribute-set in Nix within this option.
-
services.kubo
now unmountsipfsMountDir
andipnsMountDir
even if it is killed unexpectedly whenautoMount
is enabled. -
nixos/lib/make-disk-image.nix
can now mutate EFI variables, run user-provided EFI firmware or variable templates. This is now extensively documented in the NixOS manual. -
services.grafana
listens only on localhost by default again. This was changed to upstreams default of0.0.0.0
by accident in the freeform setting conversion. -
Grafana Tempo has been updated to version 2.0. See the upstream upgrade guide for migration instructions.
-
A new
virtualisation.rosetta
module was added to allow runningx86_64
binaries through Rosetta inside virtualised NixOS guests on Apple silicon. This feature works by default with the UTM virtualisation package. -
The new option
users.motdFile
allows configuring a Message Of The Day that can be updated dynamically. -
The
root
package is now built with the"-Dgnuinstall=ON"
CMake flag, making the output conform thebin
lib
share
layout. In this layout,tutorials
is undershare/doc/ROOT/
;cmake
,font
,icons
,js
andmacro
undershare/root
;Makefile.comp
andMakefile.config
underetc/root
. -
Enabling global redirect in
services.nginx.virtualHosts
now allows one to add exceptions with thelocations
option. -
A new option
proxyCachePath
has been added toservices.nginx
. Learn more about proxy_cache_path: https://nginx.org/en/docs/http/ngx_http_proxy_module.html#proxy_cache_path. -
A new option
recommendedBrotliSettings
has been added toservices.nginx
. Learn more about compression in Brotli format here. -
Updated recommended settings in
services.nginx.recommendedGzipSettings
:- Enables gzip compression for only certain proxied requests.
- Allow checking and loading of precompressed files.
- Updated gzip mime-types.
- Increased the minimum length of a response that will be gzipped.
-
Garage version is based on system.stateVersion, existing installations will keep using version 0.7. New installations will use version 0.8. In order to upgrade a Garage cluster, please follow upstream instructions and force services.garage.package or upgrade accordingly system.stateVersion.
-
Nebula now supports the
services.nebula.networks.<name>.isRelay
andservices.nebula.networks.<name>.relays
configuration options for setting up or allowing traffic relaying. See the announcement for more details about relays. -
hip
has been separated intohip
,hip-common
andhipcc
. -
services.nginx.recommendedProxySettings
now removes theConnection
header preventing clients from closing backend connections. -
Resilio sync secret keys can now be provided using a secrets file at runtime, preventing these secrets from ending up in the Nix store.
-
The
firewall
andnat
module now has a nftables based implementation. Enablenetworking.nftables
to use it. -
The
services.fwupd
module now allows arbitrary daemon settings to be configured in a structured manner (services.fwupd.daemonSettings
). -
services.xserver.desktopManager.plasma5.phononBackend
now defaults to vlc according to upstrean recommendation -
The
zramSwap
is now implemented withzram-generator
, and the optionzramSwap.numDevices
for using ZRAM devices as general purpose ephemeral block devices has been removed. -
As Singularity has renamed to Apptainer to distinguish from an un-renamed fork by Sylabs Inc., there are now two packages of Singularity/Apptainer:
apptainer
: Fromgithub.com/apptainer/apptainer
, which is the new repo after renaming.singularity
: Fromgithub.com/sylabs/singularity
, which is the fork by Sylabs Inc..
programs.singularity
got a newpackage
option to specify which package to use.singularity-tools.buildImage
got a new input argumentsingularity
to specify which package to use. -
The new option
programs.singularity.enableFakeroot
, if set totrue
, provides--fakeroot
support forapptainer
andsingularity
. -
The
unifi-poller
package and corresponding NixOS module have been renamed tounpoller
to match upstream. -
The
rtsp-simple-server
package and corresponding NixOS module have been renamed tomediamtx
to match upstream. -
The new option
services.tailscale.useRoutingFeatures
controls various settings for using Tailscale features like exit nodes and subnet routers. If you wish to use your machine as an exit node, you can set this setting toserver
, otherwise if you wish to use an exit node you can set this setting toclient
. The strict RPF warning has been removed as the RPF will be loosened automatically based on the value of this setting. -
openjdk
from version 11 and above is not build withopenjfx
(i.e.: JavaFX) support by default anymore. You can re-enable it by overriding, e.g.:openjdk11.override { enableJavaFX = true; };
. -
Xastir can now access AX.25 interfaces via the
libax25
package. -
nixos-version
now accepts--configuration-revision
to display more information about the current generation revision -
The option
services.nomad.extraSettingsPlugins
has been fixed to allow more than one plugin in the path. -
The option
services.prometheus.exporters.pihole.interval
does not exist anymore and has been removed. -
The option
services.gpsd.device
has been replaced withservices.gpsd.devices
, which supports multiple devices. -
k3s
can now be configured with an EnvironmentFile for its systemd service, allowing secrets to be provided without ending up in the Nix Store. -
gitea
module options have been changed to be RFC042 conforming (i.e. some options were moved to be located underservices.gitea.settings
) -
boot.initrd.luks.device.<name>
has a newtryEmptyPassphrase
option, this is useful for OEM's who need to install an encrypted disk with a future settable passphrase -
Lisp gained a manual section, documenting a new and backwards incompatible interface. The previous interface will be removed in a future release.
-
The
bind
module now allows the per-zoneallow-query
setting to be configured (previously it was hard-coded toany
; it still defaults toany
to retain compatibility). -
make-disk-image
handlescontents
arguments that are directories better, fixing a bug where it used to put them in a subdirectory of the intendedtarget
. -
The option
services.jitsi-videobridge.apis
has been renamed tocolibriRestApi
and turned into a boolean. Setting it totrue
will enable the private rest API, useful for monitoring usingservices.prometheus.exporters.jitsi.enable
. Learn more about the API: "The COLIBRI control interface (/colibri/)".
Detailed migration information
Pipewire configuration overrides
Why this change?
The Pipewire config semantics don't really match the NixOS module semantics, so it's extremely awkward to override the default config, especially when lists are involved. Vendoring the configuration files in nixpkgs also creates unnecessary maintenance overhead.
Also, upstream added a lot of accommodations to allow doing most of the things you'd want to do with a config edit in better ways.
Migrating your configuration
Compare your settings to the defaults and where your configuration differs from them.
Then, create a drop-in JSON file in /etc/pipewire/<config file name>.d/99-custom.conf
(the actual filename can be anything) and migrate your changes to it according to the following sections.
Repeat for every file you've modified, changing the directory name accordingly.
Things you can just copy over
If you are:
- setting properties via
*.properties
- loading a new module to
context.modules
- creating new objects with
context.objects
- declaring SPA libraries with
context.spa-libs
- running custom commands with
context.exec
- adding new rules with
*.rules
- running custom PulseAudio commands with
pulse.cmd
Simply move the definitions into the drop-in.
Note that the use of context.exec
is not recommended and other methods of running your thing are likely a better option.
{
"context.properties": {
"your.property.name": "your.property.value"
},
"context.modules": [
{ "name": "libpipewire-module-my-cool-thing" }
],
"context.objects": [
{ "factory": { ... } }
],
"alsa.rules": [
{ "matches: { ... }, "actions": { ... } }
]
}
Removing a module from context.modules
Look for an option to disable it via context.properties
("module.x11.bell": "false"
is likely the most common use case here).
If one is not available, proceed to Nuclear option.
Modifying a module's parameters in context.modules
For most modules (e.g. libpipewire-module-rt
) it's enough to load the module again with the new arguments, e.g.:
{
"context.modules": [
{
"name": "libpipewire-module-rt",
"args": {
"rt.prio": 90
}
}
]
}
Note that module-rt
specifically will generally use the highest values available by default, so setting limits on the pipewire
systemd service is preferable to reloading.
If reloading the module is not an option, proceed to Nuclear option.
Nuclear option
If all else fails, you can still manually copy the contents of the default configuration file
from ${pkgs.pipewire.lib}/share/pipewire
to /etc/pipewire
and edit it to fully override the default.
However, this should be done only as a last resort. Please talk to the Pipewire maintainers if you ever need to do this.