Skip to content

Get Started with NixOS

Now that we have learned the basics of the Nix language, we can start using it to configure our NixOS system. The default configuration file for NixOS is located at /etc/nixos/configuration.nix. This file contains all the declarative configuration for the system, including settings for the time zone, language, keyboard layout, network, users, file system, and boot options.

To modify the system state in a reproducible manner (which is highly recommended), we need to manually edit the /etc/nixos/configuration.nix file and then execute sudo nixos-rebuild switch to apply the modified configuration. This command generates a new system environment based on the modified configuration file, sets the new environment as the default one, and preserves the previous environment in the boot options of grub/systemd-boot. This ensures that we can always roll back to the old environment even if the new one fails to start.

While /etc/nixos/configuration.nix is the classic method for configuring NixOS, it relies on data sources configured by nix-channel and lacks a version-locking mechanism, making it challenging to ensure the reproducibility of the system. A better approach is to use Flakes, which provides reproducibility and facilitates configuration management.

In this section, we will first learn how to manage NixOS using the classic method (/etc/nixos/configuration.nix), and then we will explore the more advanced Flakes.

Configuring the System using /etc/nixos/configuration.nix

The /etc/nixos/configuration.nix file is the default and classic method for configuring NixOS. While it lacks some of the advanced features of Flakes, it is still widely used and provides flexibility in system configuration.

To illustrate how to use /etc/nixos/configuration.nix, let's consider an example where we enable SSH and add a user named ryan to the system. We can achieve this by adding the following content to /etc/nixos/configuration.nix:

nix
# Edit this configuration file to define what should be installed on
# your system.  Help is available in the configuration.nix(5) man page
# and in the NixOS manual (accessible by running ‘nixos-help’).
{ config, pkgs, ... }:

{
  imports =
    [ # Include the results of the hardware scan.
      ./hardware-configuration.nix
    ];

  # Omit previous configuration settings...

  # Add user 'ryan'
  users.users.ryan = {
    isNormalUser = true;
    description = "ryan";
    extraGroups = [ "networkmanager" "wheel" ];
    openssh.authorizedKeys.keys = [
        # Replace with your own public key
        "ssh-ed25519 <some-public-key> ryan@ryan-pc"
    ];
    packages = with pkgs; [
      firefox
    #  thunderbird
    ];
  };

  # Enable the OpenSSH daemon.
  services.openssh = {
    enable = true;
    settings = {
      X11Forwarding = true;
      PermitRootLogin = "no"; # disable root login
      PasswordAuthentication = false; # disable password login
    };
    openFirewall = true;
  };

  # Omit the rest of the configuration...
}

In this configuration, we declare our intention to enable the openssh service, add an SSH public key for the user 'ryan', and disable password login.

To deploy the modified configuration, run sudo nixos-rebuild switch. This command will apply the changes, generate a new system environment, and set it as the default. You can now log in to the system using SSH with the configured SSH keys.

You can always try to add --show-trace --print-build-logs --verbose to the nixos-rebuild command to get the detailed error message if you encounter any errors during the deployment.

Remember that any reproducible changes to the system can be made by modifying the /etc/nixos/configuration.nix file and deploying the changes with sudo nixos-rebuild switch.

To find configuration options and documentation:

  • Use search engines like Google, e.g., search for Chrome NixOS to find NixOS-related information about Chrome. The NixOS Wiki and the source code of Nixpkgs are usually among the top results.
  • Utilize the NixOS Options Search to search for keywords.
  • Refer to the Configuration section in the NixOS Manual for system-level configuration documentation.
  • Search for keywords directly in the source code of nixpkgs on GitHub.

References