dotfiles/utilities/nixos-installers/install_notes.md
2025-11-25 17:51:44 -06:00

8 KiB

Install nix minimal with btrfs filesystem + luks encryption

# Partition main drive with btrfs
# tip: lsblk
# use correct drive name
export D=sda

# Partitioning
# make GPT partition table
parted /dev/$D -- mklabel gpt
# make root partition (2GB offset for boot)
parted /dev/$D -- mkpart NIXROOT 2GB 100%
# make boot partition, 1MB alignment offset
parted /dev/$D -- mkpart ESP fat32 1MB 2GB 
# make boot partition bootable
parted /dev/$D -- set 2 esp on 

# NOTE this is not bulletproof, check actual name and set these appropriately
export ROOT=$D"1"
export BOOT=$D"2"

# Anything else to partition before moving on?

# Encryption Luks (optional)
export ENC=true
cryptsetup luksFormat /dev/$ROOT
cryptsetup luksOpen /dev/$ROOT cryptroot

if [ $ENC = true ]; then 
    ROOTP="/dev/mapper/cryptroot"
else
    ROOTP="/dev/$ROOT"
fi

# Formatting
mkfs.fat -F 32 -n NIXBOOT /dev/$BOOT
mkfs.btrfs -fL NIXROOT $ROOTP

# Subvolumes (so snapshots 
mount -o subvolid=5 "$ROOTP" /mnt
btrfs subvolume create /mnt/@root
btrfs subvolume create /mnt/@nix
btrfs subvolume create /mnt/@snapshots
btrfs subvolume create /mnt/@swap
btrfs subvolume create /mnt/@persist
umount /mnt

# Mount for real system use
mount -o subvol=@root,compress=zstd "$ROOTP" /mnt
mkdir -p /mnt/{nix,boot,.snapshots,.swap,persist}

mount -o umask=077 /dev/disk/by-label/NIXBOOT /mnt/boot

mount -o subvol=@nix,compress=zstd,noatime "$ROOTP" /mnt/nix
mount -o subvol=@swap,noatime "$ROOTP" /mnt/.swap
mount -o subvol=@snapshots,compress=zstd,noatime "$ROOTP" /mnt/.snapshots
mount -o subvol=@persist,compress=zstd,noatime "$ROOTP" /mnt/persist

# Create config
nixos-generate-config --root /mnt

Fix hardware-configuration

# @root options + "compress=zstd"
# @nix options + "compress=zstd" "noatime"
# @swap options + "noatime"
# @snapshots options + "compress=zstd" "noatime"
# @persist options + "compress=zstd"

# add Swap device
swapDevices = [{ 
  device = "/.swap/swapfile"; 
  size = 8*1024; # Creates an 8GB swap file 
}];

# https://wiki.nixos.org/wiki/Btrfs#Scrubbing
services.btrfs.autoScrub = {
  enable = true;
  # syntax defined by https://www.freedesktop.org/software/systemd/man/systemd.time.html#Calendar%20Events
  interval = "monthly";
  fileSystems = [ "/" ];
};

Add initial system config changes

curl -o /mnt/etc/nixos/onboard.nix https://git.joshuabell.xyz/ringofstorms/dotfiles/raw/branch/master/utilities/nixos-installers/onboard.nix
# add import to configuration.nix
sed -i '/\.\/hardware-configuration.nix/a \      ./onboard.nix' /mnt/etc/nixos/configuration.nix

in configuration.nix add

onboardOpts = {
  hostName = "NAME";
  primaryUser = "luser";
};

Auto unlock luks (optional) - USB key

# Format if needed (fat32 for compatibility)
sudo parted /dev/DRIVEDEVICE
  mklabel gpt
  mkpart primary fat32 0% 100%
  quit
sudo mkfs.vfat -F 32 /dev/DRIVEDEVICE1

# Create key
mkdir -p /key_tmpfs
sudo mount -o umask=0022,gid=$(id -g),uid=$(id -u) /dev/DRIVEDEVICE /key_tmpfs
dd if=/dev/random of=/key_tmpfs/keyfile bs=1024 count=4
sudo chmod 0400 /key_tmpfs/keyfile
sudo cryptsetup luksAddKey /dev/ROOT_DEVICE /key_tmpfs/keyfile
lsblk && ll /dev/
sudo umount /key_tmpfs
rmdir /key_tmpfs

In hardware-configuration ensure these are all added:

  boot.initrd.availableKernelModules = [
    "xhci_pci" "ehci_pci" "usb_storage" "uas"
  ];

  boot.initrd.luks.devices."cryptroot" = {
    device = "/dev/disk/by-uuid/<LUKS_UUID>";

    keyFile = "/keyfile";
    # The USB device that holds the keyfile (by UUID for reliability)
    keyfileDevice = "/dev/disk/by-uuid/<USB_UUID>";

    tryEmptyPassphrase = true;
    fallbackToPassword = true;
    crypttabExtraOpts = [ "tries=3" ];
  };

Install nixos

sudo nixos-install reboot

  1. Install and setup nixos
  • nixos config and hardware config
    • export HOSTNAME=desired_hostname_for_this_machine
    • export USERNAME=desired_username_for_admin_on_this_machine (josh)
    • nixos-generate-config --root /mnt
    • cd /mnt/etc/nixos
    • curl -O --proto '=https' --tlsv1.2 -sSf https://git.joshuabell.xyz/ringofstorms/dotfiles/raw/branch/master/onboard.sh
    • chmod +x onboard.sh && ./onboard.sh
    • verify hardware config, run nixos-install
    • reboot
  • log into USERNAME with password1, use passwd to change the password

Easiest to ssh into the machine for these steps so you can copy paste...

  • cat /etc/ssh/ssh_host_ed25519_key.pub ~/.ssh/id_ed25519.pub
    • On an already onboarded computer copy these and add them to secrets/secrets.nix file
      • nix run github:yaxitech/ragenix -- --rules ~/.config/nixos-config/common/secrets/secrets/secrets.nix -r
    • Maybe copy hardware/configs over and setup, otherwise do it on the client machine
  • git clone nixos-config git clone https://git.joshuabell.xyz/ringofstorms/dotfiles ~/.config/nixos-config
  • Setup config as needed
    • add hosts dir and files needed
  • sudo nixos-rebuild switch --flake ~/.config/nixos-config/hosts/$HOSTNAME
  • Update remote, ssh should work now: cd ~/.config/nixos-config && git remote remove origin && git remote add origin "ssh://git.joshuabell.xyz:3032/ringofstorms/dotfiles" && git pull origin master

Local tooling

  • bitwarden setup/sign into self hosted vault

  • atuin setup

    • if atuin is on enable that mod in configuration.nix, make sure to atuin login get key from existing device
    • TODO move key into secrets and mount it to atuin local share
  • ssh key access, ssh iden in config in nix config

Notes

Dual booting windows?

  • If there is a new boot partition being used than the old windows one, copy over the /boot/EFI/Microsoft folder into the new boot partition, same place
  • If the above auto probing for windows does not work, you can also manually add in a windows.conf in the loader entries: /boot/loader/entries/windows.conf:
title Windows 11
efi   /EFI/Microsoft/Boot/bootmgfw.efi

Settings references

TODO

Nix Infrastructure & Automation Improvements

  • Replace deployment scripts with deploy-rs for declarative, hands-off host updates.
    Remove manual deploy_linode/deploy_oracle scripts. Use deploy-rs to apply updates across one or all hosts, including remote builds.

  • Add isoImage outputs for every host for instant USB/boot media creation.
    Use:

    packages.x86_64-linux.install-iso = nixosConfigurations.<host>.config.system.build.isoImage;
    

    Then:

    nix build .#packages.x86_64-linux.install-iso
    
  • Document or automate new host bootstrap:

    • Script or steps: boot custom ISO, git clone config, secrets onboarding (agenix), nixos-install with flake config.
    • Provide an example shell script or README note for a single-command initial setup.
  • (Optional) Add an ephemeral “vm-experiment” target for NixOS VM/dev testing.

    • Use new host config with minimal stateful services, then
      nixos-rebuild build-vm --flake .#vm-experiment
  • Remote build reliability:

    • Parametrize/automate remote builder enable/disable.
    • Add quickstart SSH builder key setup instructions per-host in README.
    • (Optional) Use deploy-rs's agent forwarding and improve errors if builder can't be reached at deploy time.
  • Add disko to declaratively manage disk/partition creation for new installs and reinstalls.

  • work on secrets pre ragenix, stormd pre install for all the above bootstrapping steps would be ideal

  • reduce home manager, make per user modules support instead

  • Ensure my neovim undohistory/auto saves don't save .age files as they can be sensitive.

Server hosts

simply run deploy in the host root and it will push changes to the server (or deploy_[oracle|linode] <name> from root)