Find a file
2020-02-09 13:18:15 -07:00
.github/ISSUE_TEMPLATE Update issue templates 2020-01-04 17:21:01 -07:00
hosts remove unnecessary recursive attribute sets 2020-02-01 21:10:09 -07:00
lib Revert "utils: now lives in lib.utils globally" 2020-01-05 15:39:59 -07:00
local change formatter to nixfmt 2020-01-03 22:06:31 -07:00
modules flake.nix: consistent default.nix semantics 2020-01-10 22:39:42 -07:00
overlays overlays#qutebrowser: fix invisible tooltip hover 2020-02-01 15:07:02 -07:00
pkgs remove unnecessary recursive attribute sets 2020-02-01 21:10:09 -07:00
profiles develop: add clang as default cc 2020-02-09 13:18:15 -07:00
users niximg: fix nixos user 2020-01-11 00:24:12 -07:00
.envrc Initialize template branch 2020-01-03 17:47:17 -07:00
.gitattributes setup configurations API 2019-12-05 01:58:40 -07:00
.gitignore setup configurations API 2019-12-05 01:58:40 -07:00
configuration.nix Revert "Merge branch 'nur' into template" 2020-01-10 21:55:09 -07:00
CONTRIBUTING.md CONTRIBUTING.md: break off from README.md 2020-01-04 17:16:59 -07:00
COPYING init 2019-12-02 22:18:30 -07:00
DOC.md DOC.md: fix typo 2020-02-01 20:37:43 -07:00
flake.lock flake.lock: update 2020-01-11 00:05:34 -07:00
flake.nix flake.nix: define pkgs in flake 2020-01-29 08:50:07 -07:00
README.md README.md: minor fix 2020-01-11 19:56:12 -07:00
shell.nix DOC.md: split off from README.md 2020-01-10 23:49:18 -07:00

Introduction

A NixOS configuration template using the experimental 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.

A core goal is to facilitate a (mostly) seamless transition to flakes. You could start by simply importing your configuration.nix from a module in hosts. There may be some translation if you import anything from the NIX_PATH, e.g. import <nixpkgs> {}, but the majority of any valid NixOS config should work right out of the box. Once your up and running, you may wish to modify your configuration to adhere to the ideals of this project.

⚠ Advisory

Flakes are still an experimental feature, so not everything works yet. Things like nixops/disnix are not yet supported.

Also, flakes are meant to deprecate nix-channels. I'd recommend not installing any. If your really want them, they should work if you hook them into your NIX_PATH manually.

Flake Talk:

Flake talk at NixConf

Setup

# This is not needed if your using direnv:
nix-shell

# It's recommend to start a new branch:
git checkout -b $new_branch template

# Generate a hardware config:
nixos-generate-config --show-hardware-config > ./hosts/${new_host}.nix

# Edit the new file, removing `not-detected.nix` from the imports.
# In order to maintain purity flakes cannot resolve from the NIX_PATH.

# You could import your existing `configuration.nix`, or the generic
# `./hosts/NixOS.nix` from here. The latter sets up Network Manger,
# an efi bootloader, an empty root password, and a generic user
# named `nixos`.

# Also ensure your file systems are set the way you want:
$EDITOR ./hosts/${new_host}.nix

# Backup your existing config:
mv /etc/nixos /etc/nixos.old

# Ensure this flake can be found in its expected location:
ln -s $PWD /etc/nixos

# A flake is vcs based, so only git aware files are bundled
# adding a new file to staging is enough:
git add ./hosts/${new_host}.nix

# A generic `rebuild` wrapper for `nix build` is provided
# bypassing the need for `nixos-rebuild`.

# Usage: rebuild [host] {switch|boot|test|dry-activate}
# where `host` is any file living in the `./hosts` directory

# Test your new deployment; this will be run as root:
rebuild $new_host test

# You may wish to start by creating a user:
mkdir users/new-user && $EDITOR users/new-user/default.nix

# Once your satisfied, permanently deploy with:
rebuild $new_host switch

Please read the doc in order to understand the impetus behind the directory structure.

Additional Capabilities

# Make an iso image based on `./hosts/niximg.nix`:
rebuild iso

# Install any package the flake exports:
nix profile install ".#packages.x86_64-linux.myPackage"

this flake exports multiple outputs for use in other flakes, or forks of this one:

# external flake.nix
{
  # ...
  inputs.nixflk.url = "github:nrdxp/nixflk";

  outputs = { self, nixpkgs, nixflk }: {

    nixosConfigurations.newConfig = nixflk.nixosConfigurations.someConfig;

    nixosConfigurations.myConfig = nixpkgs.lib.nixosSystem {
      system = "x86_64-linux";
      modules = [
        { nixpkgs.overlays = nixflk.overlays; }
        nixflk.nixosModules.myModule
      ];
    };
  };
}

NUR usage

You can use packages, modules and overlays from the Nix User Repository.

Since NUR packages are completely unchecked, they are not included by default. Check out the NUR branch for usage.

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.