- 🚀 Ready-to-use modules, profiles and tools.
- ❄️ Simple high-level configuration.
- 🧩 Modular structure.
- 🌎 One config for a full network.
This project is constantly evolving according to my needs. If you'd like to be informed about upcoming stable versions, please let me know on GitHub or by subscribing to my YouTube channel (FR). Thank you!
| Feature | Description | |
|---|---|---|
| ⚙️ | Automated install | Fully automated host installation with nixos-anywhere and disko |
| 👤 | User profiles | User profiles and modules with Home Manager (admin, gamer, beginner...) |
| 🔑 | Security | Simple and reliable security strategy powered by sops-nix |
| 🧩 | Hosts & Users | Multi-host and multi-user architecture, deployed with colmena and just |
| 🤗 | Smart services | Immich, Nextcloud, KeyCloak (SSO), Forgejo, Vaultwarden, Mattermost, etc. |
| 📦 | High-level modules | High-level NixOS modules, enabled with a simple .enable = true |
| 💾 | 3-2-1 Backups | Comprehensive backup strategy with Restic or Borg |
| 🖥️ | Host profiles | Host profiles (servers, containers, network nodes, workstations...) |
| 🌐 | Tailnet VPN | Simple full-mesh VPN powered by headscale / tailscale |
| 📐 | Architecture | Extensible and scalable architecture, consistent and customizable |
| 🏠 | Home & proxy | Automated homepage and reverse proxy with Homepage and Caddy |
| 🛜 | Networking | Zero-conf network plumbing (DNS, DHCP, firewall...) with dnsmasq |
| 🛡️ | Ad-Free web | Secure, ad-free internet with AdguardHome |
| 💻 | Easy GNOME | Streamlined, easy-to-use GNOME interface for beginners and experts alike. |
Available recipes:
[apply]
apply on what='switch' # Apply configuration using colmena [alias: a]
apply-local what='switch' # Apply the local host configuration [alias: al]
apply-verbose on what='switch' # Apply force with verbose options [alias: av]
[check]
check # Recursive deadnix on nix files
check-flake # Check the main flake
check-statix # Check with statix
[dev]
cat host='' # Clean + git Amend + apply-local (or on host) + Test
clean # format: fix + check + generate + format [alias: c]
develop # Launch a "nix develop" with zsh (dev env) [alias: d]
fix # Fix with statix
format # Recursive nixfmt on all nix files
generate # Update the nix generated files
pull # Pull common files from DNF repository
push # Push common files to DNF repository
[install]
build-iso arch="x86_64-linux" # Build DNF iso image
configure host # New host: ssh cp id, extr. hw, clean, commit, apply
configure-admin-host # Framework installation on local machine (builder / admin)
copy-hw host # Extract hardware config from host
copy-id host # Copy pub key to the node (nix user must exists)
full-install host user='nix' ip='auto' # New host: full installation (install, configure, apply)
install host user='nix' ip='auto' do='install' # New host: format with nixos-everywhere + disko
install-key host # New host: format with nixos-everywhere + disko
passwd user # Update a user password
passwd-default # Update the default DNF password
push-key host # Push the infrastructure key to the host
[manage]
enter on # Interactive shell to the host [alias: e]
fix-boot on # Multi-reinstall bootloader (using colmena)
fix-zsh on # Remove zshrc bkp to avoid error when replacing zshrc
gc on # Multi garbage collector (using colmena)
halt on # Multi-alt (using colmena)
reboot on # Multi-reboot (using colmena)