Files
nix-config/README.md
T
Ryan Yin 001d180b22 feat(noctalia): upgrade to the native v5 shell
Noctalia v5 is the native C++/Wayland rewrite; the Quickshell-based v4 line (pkgs.noctalia-shell) is EOL and its JSON config is not migrated upstream.

- use the upstream home-manager programs.noctalia module (present at our pinned HM revision) instead of the hand-rolled package + symlink module: it installs pkgs.noctalia, validates config.toml at build time via checkConfig, and supports customPalettes; drop the v4 Qt/Qt6ct session setup
- replace the v4 settings.json/plugins.json with a minimal shared config.toml (font, Catppuccin shell palette, templates off, screenshot annotation, accessibility/bar scale, night light, wallpaper, location/weather); host-specific bits live in per-host files (shoukei's eDP-1 backlight in noctalia/host-shoukei.toml), which merge after config.toml. Application theming stays with catppuccin/nix
- treat config.toml as the single source of truth: do NOT persist ~/.local/state/noctalia and set setup_wizard_enabled = false, so UI tweaks are promoted back into the repo instead of accumulating in app-owned state
- port niri keybinds to 'noctalia msg ...', update spawn-at-startup and the backdrop layer namespace, fix the broken 'octalia-shell' media-previous bind, and replace the grim/slurp/satty screenshot stack with Noctalia's native region/fullscreen/annotate commands (drop the unused packages)
- drop the now-redundant swaybg and swaylock (Noctalia owns the wallpaper and lock screen, the latter authenticating against the PAM 'login' service) and its PAM entry; keep wlogout as an emergency fallback
- update hypridle's lock commands and the matching eval test
- refresh the noctalia docs
2026-09-19 15:07:54 +08:00

12 KiB

❄️ Ryan4Yin's Nix Config ❄️

Stargazers

My configuration is becoming more and more complex, and it will be difficult for beginners to read. If you are new to NixOS and want to know how I use NixOS, I would recommend you to take a look at the ryan4yin/nix-config/releases first, check out to some simpler older versions, such as i3-kickstarter, which will be much easier to understand.

This repository is home to the nix code that builds my systems:

  1. NixOS Desktops: NixOS with home-manager, niri, agenix, etc.
  2. macOS Desktops: nix-darwin with home-manager, share the same home-manager configuration with NixOS Desktops.
  3. NixOS Servers: virtual machines running on Proxmox/KubeVirt, with various services, such as kubernetes, homepage, prometheus, grafana, etc.

See ./hosts for details of each host.

See ./Virtual-Machine.md for details of how to create & manage KubeVirt's Virtual Machine from this flake.

Why NixOS & Flakes?

Nix allows for easy-to-manage, collaborative, reproducible deployments. This means that once something is setup and configured once, it works (almost) forever. If someone else shares their configuration, anyone else can just use it (if you really understand what you're copying/referring now).

As for Flakes, refer to Introduction to Flakes - NixOS & Nix Flakes Book

Want to know NixOS & Flakes in detail? Looking for a beginner-friendly tutorial or best practices? You don't have to go through the pain I've experienced again! Check out my NixOS & Nix Flakes Book - 🛠️ ❤️ An unofficial & opinionated 📖 for beginners!

If you're using macOS, check out ryan4yin/nix-darwin-kickstarter for a quick start.

Components

NixOS(Wayland)
Window Manager Niri
Terminal Emulator Zellij + foot/Kitty/Alacritty/Ghostty
Status Bar / Notifier / Launcher / lockscreens noctalia
Display Manager tuigreet
Color Scheme catppuccin-nix
network management tool NetworkManager
Input method framework Fcitx5 + rime + 小鹤音形 flypy
System resource monitor Btop
File Manager Yazi + thunar
Shell Nushell + Starship
Media Player mpv
Editors / IDE Helix (primary), Neovim (backup) — configuration & usage
Fonts Nerd fonts
Image Viewer imv
Screenshot Software Niri's builtin function
Screen Recording OBS
Filesystem & Encryption tmpfs as /, Btrfs subvolumes on a LUKS encrypted partition for persistent, unlock via passphrase
Secure Boot lanzaboote

Wallpapers: https://github.com/ryan4yin/wallpapers

Screenshots

desktop

overview

nvim

Editors / IDE

Secrets Management

See ./secrets for details.

How to Deploy this Flake?

🔴 IMPORTANT: You should NOT deploy this flake directly on your machine ❗ It will not succeed. This flake contains my hardware configuration(such as hardware-configuration.nix, Nvidia Support, etc.) which is not suitable for your hardware, and requires my private secrets repository ryan4yin/nix-secrets to deploy. You may use this repo as a reference to build your own configuration.

For NixOS:

To deploy this flake from NixOS's official ISO image (purest installation method), please refer to ./nixos-installer/

# deploy one of the configuration based on the hostname
sudo nixos-rebuild switch --flake .#ai-niri

# Deploy the nixosConfiguration matching the hostname immediately
just local

# Set it as the next boot configuration without switching immediately
just local boot

# Deploy with detailed output; use `boot debug` to combine both options
just local switch debug

# Deploy the niri nixosConfiguration by hostname match
just niri

# The niri recipe accepts the same mode and verbosity arguments
just niri boot
just niri switch debug
just niri boot debug

For macOS:

# If you are deploying for the first time,
# 1. install nix & homebrew manually.
# 2. prepare the deployment environment with essential packages available
nix-shell -p just nushell
# 3. comment home-manager's code in lib/macosSystem.nix to speed up the first deployment.
# 4. comment out the proxy settings in scripts/darwin_set_proxy.py if the proxy is not ready yet.

# Deploy the darwinConfiguration by hostname match
just local

# Deploy with details (macOS has no switch/boot mode argument)
just local debug

What y'all will need when Nix drives you to drink. (copy from hlissner's dotfiles, it really matches my feelings when I first started using NixOS...)

References

Other dotfiles that inspired me: