nixos-config/README.md
2022-12-03 15:27:29 -05:00

47 lines
1.9 KiB
Markdown

This repository contains the Nix / NixOS configuration for all of my systems. Start from `flakes.nix` (see [Flakes](https://nixos.wiki/wiki/Flakes)).
To build,
```sh
# First, edit nixosConfigurations in flake.nix to add your system's hostname.
# And then change `userName` to your username.
nix run
```
## Install notes
- NixOS Linux
- Install NixOS
- Hetzner dedicated from Linux Rescue system: https://github.com/serokell/nixos-install-scripts/pull/1#pullrequestreview-746593205
- Digital Ocean: https://github.com/elitak/nixos-infect
- X1 Carbon: https://www.srid.ca/x1c7-install
- Windows (via WSL): https://github.com/nix-community/NixOS-WSL
- Clone this repo at `/etc/nixos`
- Edit `flake.nix` and
- add your Linux's hostname in the `nixosConfigurations` set, as well as
- update `people.myself` to your desired username.
- put your SSH keys in `./nixos/takemessh`
- Run `nix run`. That's it. Re-open your shell.
- macOS:
- Install Nix normally (multi-user)
- Install [nix-darwin](https://github.com/LnL7/nix-darwin)
- This will create a `~/.nixpkgs/darwin-configuration.nix`, but we do not need that.
- Clone this repo anywhere
- Edit `flake.nix` to update `people.myself` to your desired username.
- Run `nix run`.[^cleanup] That's it. Re-open your shell.
[^cleanup]: You might have to `rm -rf /etc/nix/nix.conf`, so our flake.nix can do its thing.
## Directory layout
- `home`: home-manager config (shared between Linux and macOS)
- `nixos`: nixos config for Linux
- `nix-darwin`: nix-darwin config for macOS
- `systems`: top-level configuration.nix('ish) for various kinds of system
## Tips
- To update NixOS (and other inputs) run `nix flake update`[^selective]
- To autoformat the project tree using nixpkgs-fmt, run `nix fmt`.
[^selective]: You may also update the inputs selectively, viz.: `nix flake lock --update-input nixpkgs --update-input darwin --update-input home-manager`