Jump to content

Automatic system upgrades: Difference between revisions

From Official NixOS Wiki
imported>Onny
Add usage examples
Peter (talk | contribs)
m Flake-based systems: Capitalisation consistency.
 
(7 intermediate revisions by 6 users not shown)
Line 1: Line 1:
Automatic system upgrades can be used to upgrade a system regularly at a specific time. This can help to reduce the time period of applying important security patches to your running software but might also introduce some breakage in case an automatic upgrade fails.
Automatic system upgrades can be used to upgrade a system regularly at a specific time. This can help to reduce the time period of applying important security patches to your running software but might also introduce some breakage in case an automatic upgrade fails. For automatic upgrades an automatic [[Garbage Collection|garbage collection]] is important to prevent full <syntaxhighlight inline lang="bash">/boot</syntaxhighlight> and <syntaxhighlight inline lang="bash">/</syntaxhighlight> partitions.


== Configuration ==
== Configuration ==
=== Channel-based systems (default) ===
Most NixOS installations use channels by default. If you're unsure which you're using, check with <syntaxhighlight inline lang="bash">nix-channel --list</syntaxhighlight>. If that returns results, you're using channels.
For channel-based systems, use this configuration:
{{file|auto-upgrade.nix|nix|<nowiki>
system.autoUpgrade = {
  enable = true;
  flags = [
    "--print-build-logs"
  ];
  dates = "02:00";
  randomizedDelaySec = "45min";
  allowReboot = false;  # Set to true if you want automatic reboots
};
</nowiki>}}
<strong>Important:</strong> Do not use flake-specific flags with channel-based systems, as they will cause the upgrade to fail silently.
=== Flake-based systems ===


To enable unattended automatic system updates on a flake-enabled host, add following part to your configuration:
To enable unattended automatic system updates on a flake-enabled host, add following part to your configuration:


{{file|/etc/nixos/configuration.nix|nix|<nowiki>
{{file|auto-upgrade.nix|nix|<nowiki>
system.autoUpgrade = {
system.autoUpgrade = {
   enable = true;
   enable = true;
   flake = inputs.self.outPath;
   flake = "/path/to/flake";
   flags = [
   flags = [
     "--update-input"
     "--print-build-logs"
    "nixpkgs"
     "--commit-lock-file" # If you want to automatically commit the updated flake.lock
     "-L" # print build logs
   ];
   ];
   dates = "02:00";
   dates = "02:00";
Line 19: Line 40:
</nowiki>}}
</nowiki>}}


To see the status of the timer run
== Monitoring ==
 
Check that automatic system upgrades run successfully. Force an automatic system upgrade by running


<syntaxhighlight lang="bash">
<syntaxhighlight lang="bash">
# systemctl status nixos-upgrade.timer
# systemctl start nixos-upgrade
</syntaxhighlight>
</syntaxhighlight>


The upgrade log can be printed with this command
Check the upgrade log with


<syntaxhighlight lang="bash">
<syntaxhighlight lang="bash">
# systemctl status nixos-upgrade.service
# systemctl status nixos-upgrade.service
</syntaxhighlight>
</syntaxhighlight>
Or, to see the full log
<syntaxhighlight lang="bash">
# journalctl -u nixos-upgrade.service
</syntaxhighlight>
To see the status of the upgrade timer run
<syntaxhighlight lang="bash">
# systemctl status nixos-upgrade.timer
</syntaxhighlight>
== Troubleshooting ==
=== Git "repository is not owned by current user" ===
The flake repository directory is not owned by <syntaxhighlight inline lang="bash">root</syntaxhighlight> (which <syntaxhighlight inline lang="bash">nixos-upgrade</syntaxhighlight> runs as). To fix this, add the following to <syntaxhighlight inline lang="bash">/root/.gitconfig</syntaxhighlight>:
{{file|/root/.gitconfig|gitconfig|<nowiki>
[safe]
  directory = /path/to/flake
</nowiki>}}
[[Category:NixOS]]

Latest revision as of 00:36, 2 March 2026

Automatic system upgrades can be used to upgrade a system regularly at a specific time. This can help to reduce the time period of applying important security patches to your running software but might also introduce some breakage in case an automatic upgrade fails. For automatic upgrades an automatic garbage collection is important to prevent full /boot and / partitions.

Configuration

Channel-based systems (default)

Most NixOS installations use channels by default. If you're unsure which you're using, check with nix-channel --list. If that returns results, you're using channels.

For channel-based systems, use this configuration:

❄︎ auto-upgrade.nix
system.autoUpgrade = {
  enable = true;
  flags = [
    "--print-build-logs"
  ];
  dates = "02:00";
  randomizedDelaySec = "45min";
  allowReboot = false;  # Set to true if you want automatic reboots
};

Important: Do not use flake-specific flags with channel-based systems, as they will cause the upgrade to fail silently.

Flake-based systems

To enable unattended automatic system updates on a flake-enabled host, add following part to your configuration:

❄︎ auto-upgrade.nix
system.autoUpgrade = {
  enable = true;
  flake = "/path/to/flake";
  flags = [
    "--print-build-logs"
    "--commit-lock-file"  # If you want to automatically commit the updated flake.lock
  ];
  dates = "02:00";
  randomizedDelaySec = "45min";
};

Monitoring

Check that automatic system upgrades run successfully. Force an automatic system upgrade by running

# systemctl start nixos-upgrade

Check the upgrade log with

# systemctl status nixos-upgrade.service

Or, to see the full log

# journalctl -u nixos-upgrade.service

To see the status of the upgrade timer run

# systemctl status nixos-upgrade.timer

Troubleshooting

Git "repository is not owned by current user"

The flake repository directory is not owned by root (which nixos-upgrade runs as). To fix this, add the following to /root/.gitconfig:

≡︎ /root/.gitconfig
[safe]
  directory = /path/to/flake