Skip to content

Latest commit

 

History

History
68 lines (45 loc) · 3.17 KB

README.md

File metadata and controls

68 lines (45 loc) · 3.17 KB
Raw

Declarative Today. Utopia Tomorrow.

This is the NixOS configuration repository for all my machines and custom packages (i.e not part of nixpkgs yet). In some sense it is my world, which is how it got its name.

It's based on a relatively recent feature of the Nix package manager called flakes. Flakes are somewhat similar to a Cargo.toml/Cargo.lock from the Rust programming language, a go.mod/go.sum from the Go programming language or the package.json/package.lock files used by the Node Package Manager. The difference being that it is language agnostic - it handles any package(s) or file(s) really. Here, we're using it to build hosts and software deterministically in a reproducible fashion. This would all be possible using Nix without the flakes feature, but it would be more work to design and keep it up-to-date. While flakes are still labelled "experimental" they have a bright future.

This repo is using flake-parts to modularize and clean up ./flake.nix.

Installing a new machine

Add a new file under the relevant architecture folder under the hosts/ directory, possibly copying an existing fitting host and modifying it. Add the wanted profiles and other configuration. Commit and push them to this repository.

Running the installation process

Download a recent installer from https://nixos.org/download.html#nixos-iso and enable flakes after booting it:

  mkdir -p /etc/nix
  cat<<EOF>>/etc/nix/nix.conf
  experimental-features = nix-command flakes
  EOF

Then proceed to clone this repo:

  cd /tmp
  git clone https://github.com/johnae/world
  cd world

After that, just pick the host you're installing, like this:

  host=eris
  nix build .#"$host"-diskformat
  ./result/bin/diskformat
  nixos-install --flake .#"$host" --no-root-passwd

Hosts are defined in the hosts/ directory.

This setup is very customized to my taste. You're welcome to use any or all of it for your own purposes but be advised that you'll probably want to make a lot of changes for it to work well for you.

Updating an existing machine

Updates should be handled through standard commit/push/pullreq workflow. Updating a machine is done like this:

  nixos-rebuild switch --flake github:johnae/world --use-remote-sudo

or via a local clone of this repo:

  git clone [email protected]:johnae/world
  cd world
  nixos-rebuild switch --flake . --use-remote-sudo

Package updates etc

Package updates and OS updates are automated through actions. The update action creates pull requests where all custom packages are built and then all machine configurations are built to test that things seem ok before merging. This should catch many issues coming from OS and package updates before they're deployed.

License

MIT

This repository references many packages with varying licenses so please only consider the actual code in this repo to be MIT licensed.