pub-solar-os/README.md

Since flakes are still quite new, I've listed some learning resources below.

Introduction

Herein lies a NixOS configuration template using the new flakes mechanism. Its aim is to provide a generic repository which neatly separates concerns and allows one to get up and running with NixOS faster than ever, while keeping your code clean and organized.

Some key advantages include:

• A single home for all your Nix expressions, easily sharable and portable!
• Skip the boilerplate, simply use the included nix-shell or direnv profile and get up and running with flakes right away.
• Thanks to flakes, the entire system is more deterministic.
• Systems defined under hosts are automatically imported into nixosConfigurations, ready to deploy.
• Profiles are a simple mechanism for using portable code across machines, and are available to share via the nixosModules.profiles output.
• Defined packages and modules, are automatically wired and available from anywhere. They are also sharable via their respective flake outputs.
• Easily override packages from different nixpkgs versions.
• Keep user configuration isolated and easily reusable by taking advantage of user profiles and home-manager.
• Overlay files are automatically available and sharable.
• Automatic NUR support.

For a more detailed explanation of the code structure, check out the docs.

⚠ Advisory

Flakes are still new, so not everything works yet. However, it has been to merged in nixpkgs via pkgs.nixFlakes. Thus, this project should be considered experimental, until flakes become the default.

Also, flakes are meant to deprecate nix-channels. It's recommended not to install any. If your really want them, they should work if you hook them into NIX_PATH.

Sharing

One of the great benefits of flakes is the ability to easily share your user defined packages, modules and other nix expressions without having to merge anything upstream. In that spirit, everything defined in this flake is usable from other flakes. So even if you don't want to use this project as a template, you can still pull in any useful modules, packages or profiles defined here.

From the command line:

# to see what this flake exports
nix flake show "github:nrdxp/nixflk"

# run an app
nix run "github:nrdxp/nixflk#someApp"

# start a dev shell for a given derivation
nix develop "github:nrdxp/nixflk#somePackage"

# a nix shell with the package in scope
nix shell "github:nrdxp/nixflk#somePackage"

From within a flake:

{
  inputs.nixflk.url = "github:nrdxp/nixflk";

  outputs = { self, nixpkgs, nixflk, ... }:
  {
    nixosConfigurations.example = nixpkgs.lib.nixosSystem {
      # ...
        modules = [
        nixflk.nixosModules.someModule
        ({
          nixpkgs.overlays = [ nixflk.overlay nixflk.overlays.someOverlay ];
        })
        # ...
      ];
    };
  };
}

Setup

There are a few ways to get up and running. You can fork this repo or use it as a template. There is a bare branch if you want to start with a completely empty template and make your own profiles from scratch. The only hard requirement is nix itself. The shell.nix will pull in everything else.

Flake Templates

If you already have nix-command setup you can:

# for standard template
nix flake new -t "github:nrdxp/nixflk" flk

# for bare template
nix flake new -t "github:nrdxp/nixflk/bare" flk

Nix Only

Once you have this repo, you'll want to move or symlink it to /etc/nixos for ease of use. Once inside:

# This will setup nix-command and pull in the needed tools
nix-shell # or `direnv allow` if you prefer

# use nixos-generate-config to generate a basic config for your system
# edit hosts/up-$(hostname).nix to modify.
flk up

# The following should work fine for EFI systems.
# boot.loader.systemd-boot.enable = true;
# boot.loader.efi.canTouchEfiVariables = true;

# Set your locale
$EDITOR local/locale.nix

# install NixOS to bare metal
flk install yourConfig # deploys hosts/yourConfig.nix

# if you already have NixOS and just want to deploy your new setup
flk yourConfig switch

Note on flk up:

While the up sub-command is provided as a convenience to quickly set up and install a "fresh" NixOS system on current hardware, committing these files is discouraged.

They are placed in the git staging area automatically because they would be invisible to the flake otherwise, but it is best to move what you need from them directly into your hosts file and commit that instead.

Home Manager Integration

The home-manager nixos module is available for each host. It is meant to be used in the user profiles, you can find an example in the nixos user profile

The home-manager configuration for each user in each system is available in the outputs as homeConfigurations and the activation packages in hmActivationPackages.

This allows you to just build the home-manager environment without the rest of the system configuration. The feature is useful on systems without nixos or root access.

Lets say you want to activate the home configuration for the user nixos in the host NixOS.

With the flk script:

# You can build it using
flk home NixOS nixos
# and activate with
./result/activate

# Or do both like this
flk home NixOS nixos switch

This can also be done manually:

# With hmActivationPackages, what the flk script uses
nix build ./#hmActivationPackages.NixOS.nixos

# Or with homeConfigurations, 
nix build ./#homeConfigurations.NixOS.nixos.home.activationPackage
# this is hard to debug though, due to nix build's fallback to packages

# The configuration can then be activated like before

Build an ISO

You can make an ISO out of any config:

flk iso yourConfig # build an iso for hosts/yourConfig.nix

Hardware Specific Profile for a Single Host

Find out the fitting nixos-hardware profile for the hardware of your host, then find the corresponding modules in the flake and add it to the configuration. For example for a Dell XPS 13 9370 the host configuration would contain:

{
  imports = [ hardware.dell-xps-13-9370 ... ];
  ...
}

Use a Package from NUR

NUR is wired in from the start. For safety, nothing is added from it by default, but you can easily pull packages from inside your configuration like so:

{ pkgs, ... }:
{
  environment.systemPackages = with pkgs; [ nur.repos.<owner>.<package> ];
}

Resources

Links

• Example Repo
• Tweag.io Flakes Blog Series
• NixOS Flakes Wiki
• Zimbatm's Flakes Blog
• Original RFC

Flake Talk:

License

This software is licensed under the MIT License.

Note: MIT license does not apply to the packages built by this configuration, merely to the files in this repository (the Nix expressions, build scripts, NixOS modules, etc.). It also might not apply to patches included here, which may be derivative works of the packages to which they apply. The aforementioned artifacts are all covered by the licenses of the respective packages.