goon/nixos

NixOS configuration designed for a single host featuring flakes and home manager.

Important

This is my personal NixOS configuration, shared for reference and inspiration NOT adoption.

• This configuration is constantly evolving. It is prone to drastic and likely breaking changes.
• Features may be partially implemented or entirely broken.
• The README and documentation will often times be outdated.
• I provide no guarantees of stability or support.

If you intend to use any aspect of my configuration, make sure you:

1. Review the code thoroughly.
2. Understand what each module does.
3. Adapt it to your specific use case.

Components

Component	Link
Window Manager	Niri
Terminal Emulator	Kitty
Display Manager	Ly
System Resource Monitor	Resources
File Manager	Yazi & Nautilus
Shell	Zsh & Starship
Media Player	Totem
Text Editor	Neovim
Image Viewer	Loupe
Screen Recording	OBS
Status Bar / Notifications / Launcher / Wallpaper	Made with Quickshell

Structure

• flake.nix & flake.lock define the entry point and lock dependencies.
• treefmt.nix defines formatting standards for the codebase.
• host/ contains host specific configuration e.g. hardware-configuration.
• modules/ contains nix and home manager modules separated by subfolder.
• wallpapers/ collection of wallpapers for your viewing pleasure.

Setup

1. Clone:

   nix-shell -p git
   git clone --recursive https://github.com/goon/nixos ~/.nixos
   cd ~/.nixos
   
    # The configuration expects the repository to be located under $HOME/.nixos. 
    # This can be overidden in the modules/options.nix file under "repoName".
    # You should update the "username" in modules/options.nix to match your user.
   
    # The --recursive flag pulls the quickshell git submodule. 

2. Generate Hardware Configuration:

   nixos-generate-config --show-hardware-config > host/hardware-configuration.nix

3. Rebuild:

   sudo nixos-rebuild switch --flake .#desktop 

4. Update:

   sudo nix flake update

Credits

Thank you to the countless Nix OS configurations that I copied learnt from.

namishh - seniormatt - fufexan - frost-pheonix - anotherhadi - vic - vimjoyer - bad3r - mitchellh - misterio77 - max-baz - gvolpe - librephoenix - sioodmy

Due to my dementia I may have missed many. Regardless, I am thankful.