Skip to content

Latest commit

 

History

History
393 lines (314 loc) · 17.5 KB

README.md

File metadata and controls

393 lines (314 loc) · 17.5 KB
Raw

Static Badge Static Badge Static Badge Static Badge Static Badge Static Badge Static Badge Static Badge Static Badge Static Badge Static Badge Static Badge Static Badge Static Badge Static Badge Static Badge

NixOS & Home Manager Configurations

GitHub stars GitHub repo size NixOS License

This repository contains a Nix Flake for configuring my computers and/or home environment. It is not intended to be a drop in configuration for your computer, but you are welcome to use it as a reference or starting point for your own configuration. If you are looking for a more generic NixOS configuration, I recommend nix-starter-configs. 👍️ These computers are managed by this Nix flake ❄️

Hostname Board CPU RAM Primary GPU Role OS State
woody ROG-STRIX-B650E-WIFI AMD Ryzen 9 7900X 64GB AMD Radeon RX 7800 XT 🖥️ ❄️ ✅
frametop Framework-13in-12thGen Intel i7-1260P 64GB Intel Iris XE Graphics 💻️ ❄️ ✅
steamdeck SteamDeck-OLED Zen 2 4c/8t 16GB 8 RDNA 2 CUs 🎮️ 🐧 ✅
vm1 QEMU - - VirGL 🐄 ❄️ ✅
mv2 QEMU - - VirGL 🐄 ❄️ ✅
nuc1 [NUC6i7KYK] [Intel Core i7-6770HQ] 64GB Intel Iris Pro Graphics 580 ☁️ ❄️ 🚧
nuc2 [NUC5i7RYH] [Intel Core i7-5557U] 32GB Intel Iris Graphics 6100 ☁️ ❄️ 🧟

Key

  • 🎭️ : Dual boot
  • 🖥️ : Desktop
  • 💻️ : Laptop
  • 🎮️ : Games Machine
  • 🐄 : Virtual Machine
  • ☁️ : Server

Structure

  • .github: GitHub CI/CD workflows Nix ❄️ supercharged ⚡️ by Determinate Systems
  • home: My Home-manager configuration, acessible via home-manager --flake
    • features:
    • global:
    • $HOST_NAME.nix: Each hm configuration can toggle. Sane defaults for shell and desktop
  • hosts: NixOS Configurations, accessible via nixos-rebuild --flake.
    • common: Shared configurations consumed by the machine-specific ones.
      • global: Configurations that are globally applied to all my machines.
      • optional: Opt-in configurations my machines can use.
    • $HOST_NAME: Includes discrete hardware configurations that leverage the NixOS Hardware modules.
  • modules: A few modules
  • overlay: Patches and version overrides for some packages. Accessible via
  • pkgs: My custom packages. Also accessible via nix build. You can compose these into your own configuration by using my flake's overlay, or consume them through NUR.
  • templates: A couple project templates for different languages. Accessible via nix init.
  • flake.nix: Entrypoint for hosts and home configurations. Also exposes a devshell for boostrapping (nix develop or nix-shell).
  • [Makefile]: Commands for managing nix

Installing 💾

  • Boot off a .iso image created by this flake using build-iso-desktop or build-iso-console (see below)
  • Put the .iso image on a USB drive
  • Boot the target computer from the USB drive
  • Two installation options are available: 1 Use the graphical Calamares installer to install an ad-hoc system 2 Run install-system <hostname> <username> from a terminal
    • The install script uses Disko or disks.sh to automatically partition and format the disks, then uses my flake via nixos-install to complete a full-system installation
    • This flake is copied to the target user's home directory as ~/Zero/nix-config
    • The nixos-enter command is used to automatically chroot into the new system and apply the Home Manager configuration.
  • Reboot 🥾

All you need is nix (any version). Run:

nix-shell

If you already have nix 2.4+, git, and have already enabled flakes and nix-command, you can also use the non-legacy command:

nix develop

nixos-rebuild --flake . To build system configurations

home-manager --flake . To build user configurations

nix build (or shell or run) To build and use packages

sops To manage secrets

Applying Changes ✨

I clone this repo to ~/nix-config. NixOS and Home Manager changes are applied separately because I have some non-NixOS hosts.

gh repo clone ryanwclark1/nix-config ~/nix-config
  • ❄️ NixOS: A build-host and switch-host aliases are provided that build the NixOS configuration and switch to it respectively.
  • 🏠️ Home Manager: A build-home and switch-home aliases are provided that build the Home Manager configuration and switch to it respectively.
  • 🌍️ All: There are also build-all and switch-all aliases that build and switch to both the NixOS and Home Manager configurations.

ISO 📀

The build-iso script is included that creates .iso images from this flake. The following modes are available:

  • build-iso console (terminal environment): Includes install-system for automated installation.
  • build-iso desktop (desktop environment): Includes install-system and Calamares installation.

Live images will be left in ~/$HOME/nix-config/result/iso/ and are also injected into ~/Quickemu/nixos-console and ~/Quickemu/nixos-desktop respectively. The console .iso image is also periodically built and published via [GitHub Actions and are available in this project's Releases](https://github.com/ryanwclark1/nix-config/releases).

What's in the box? 🎁

Nix is configured with flake support and the unified CLI enabled.

Structure

Here is the directory structure I'm using.

.
├── home
│   ├── features
│   │   ├── alacritty
│   │   ├── cli
│   │   ├── compression
│   │   ├── desktop
│   │   │   ├── common
│   │   │   ├── gnome
│   │   │   ├── hyprland
│   │   │   │   ├── config
│   │   │   │   │   ├── hyprland
│   │   │   │   │   ├── fastfetch
│   │   │   │   │   ├── pipewire
│   │   │   │   │   ├── rofi
│   │   │   │   │   └── swaync
│   │   │   │   ├── fonts
│   │   │   │   ├── media
│   │   │   │   │   └── wallpapers
│   │   │   │   └── scripts
│   │   │   └── plasma
│   │   ├── development
│   │   ├── eza
│   │   ├── filesearch
│   │   ├── fzf
│   │   ├── games
│   │   ├── git
│   │   ├── gpu
│   │   ├── helix
│   │   ├── insomnia
│   │   ├── kitty
│   │   ├── kubernetes
│   │   ├── lazygit
│   │   ├── lf
│   │   ├── media
│   │   ├── networking-utils
│   │   ├── nvim
│   │   │   └── plugin
│   │   ├── osint
│   │   ├── pistol
│   │   ├── productivity
│   │   ├── qutebrowser
│   │   ├── shell
│   │   ├── starship
│   │   ├── sys-stats
│   │   ├── vscode
│   │   ├── wezterm
│   │   ├── zellij
│   │   └── zoxide
│   └── global
├── hosts
│   ├── common
│   │   ├── global
│   │   ├── optional
│   │   │   ├── displaymanager
│   │   │   ├── gnome
│   │   │   ├── hyprland
│   │   │   ├── pantheon
│   │   │   └── plasma
│   │   ├── users
│   │   │   └── administrator
│   │   └── wallpaper
│   ├── frametop
│   │   └── services
│   └── woody
│       └── services
├── lib
├── modules
│   ├── home-manager
│   └── nixos
├── overlays
├── pkgs
│   ├── aichat
│   ├── gitkraken
│   ├── multiviewer
│   ├── nix-inspect
│   ├── shellcolord
│   └── wallpapers
└── templates
│   ├── c
│   │   └── src
│   ├── haskell
│   │   ├── app
│   │   └── src
│   ├── node
│   │   └── src
│   └── rust
│       └── src
├── secrets.yaml
└── flake.nix

The NixOS and Home Manager configurations are in the hosts and home directories respectively The pkgs directory contains my custom packages with package overlays in the overlays directory. The secrets.yaml contains secrets managed by sops-nix. The default.nix files in the root of each directory are the entry points.

The Shell 🐚

The Desktop 🖥️

The font configuration is common with both desktops using Work Sans and Fira Code. The usual creature comforts you'd expect to find in a Linux Desktop are integrated such as Pipewire, Bluetooth, Avahi, CUPS, SANE and NetworkManager.

Desktop System Configuration Theme

Alt

Post-install Checklist

Things I currently need to do manually after installation.

Secrets

  • Provision ~/.config/sops/age/keys.txt. Optionally handled by install-system.
  • Add ssh-to-age -i /etc/ssh/ssh_host_ed25519_key.pub to .sops.yaml.
  • Run sops updatekeys secrets/secrets.yaml
  • Run gpg-restore
  • LastPass - authenticate
  • Authy - activate
  • 1Password - authenticate

Services

  • Atuin - atuin login -u <user>
  • Brave - enroll sync
  • Chatterino - authenticate
  • Discord - authenticate
  • GitKraken - authenticate with GitHub
  • Grammarly - authenticate
  • IRCCloud - authenticate
  • Maelstral - maestral_qt
  • Matrix - authenticate
  • Syncthing - Connect API and introduce host
  • Tailscale - sudo tailscale up
  • Telegram - authenticate
  • Keybase - keybase login
  • VSCode - authenticate with GitHub enable sync
  • Wavebox - authenticate Google and restore profile
  • ZeroTier - enable host sudo zerotier-cli info
  • Run fonts.sh to install commercial fonts

Windows Boot Manager on multi-disk systems

One of my desktop (woody) is a multi-disk system with Windows 11 Pro installed on a separate disk from NixOS. The Windows EFI partition is not automatically detected by systemd-boot. The following steps are required to copy the Windows Boot Manager to the NixOS EFI partition.

Find Windows EFI Partition

lsblk -o NAME,FSTYPE,SIZE,MOUNTPOINT

Mount Windows EFI Partition

sudo mkdir /mnt/win-efi
sudo mount /dev/nvme1n1p1 /mnt/win-efi

Copy Contents of Windows EFI to NixOS EFI

sudo rsync -av /mnt/win-efi/EFI/Microsoft/ /boot/EFI/Microsoft/

Clean up

sudo umount /mnt/win-efi
sudo rm -rf /mnt/win-efi

Reboot and systemd-boot should now offer the option to boot NixOS and Windows.

TODO 🗒️

Things I should do or improve:

Shell

  • fzf
  • tmate or tmux
  • git-graph and/or git-igitt integration

Servers

Inspirations 🧑‍🏫

The Disko implementation and automated installation are chasing the ideas outlined in these blog posts: