1. Introduction
+1. Introduction
@@ -400,8 +400,8 @@ Customization is designed to occur primarily through modular .conf files, allowi Before proceeding with installation, it is strongly recommended to read this documentation carefully. Understanding the structure and design philosophy will help ensure a smooth setup and provide the necessary context for extending the system effectively.
1.1. What do you get?
+1.1. What do you get?
This repository delivers a reproducible foundation built on NixOS, Home-Manager, and Flakes. It assumes a clean NixOS installation as a starting point, preferably minimal or headless, onto which the configuration is applied. @@ -410,8 +410,8 @@ Core packages are installed as part of the base configuration. Additional softwa
1.2. What you do not get
+1.2. What you do not get
This repository does not provide a fully polished, bug-free desktop system with every default preconfigured and validated across all hardware combinations. It is a structured foundation, not a turnkey end-user distribution. @@ -423,8 +423,8 @@ In short, this repository provides a coherent and extensible base, not a finishe
2. What Is a Literate System in the Context of NixOS?
+2. What Is a Literate System in the Context of NixOS?
A literate system combines documentation and implementation into a single, coherent source. @@ -458,8 +458,8 @@ The README is not describing the system. The README is the system.
2.1. Two Types of Code Blocks
+2.1. Two Types of Code Blocks
This literate system uses two different kinds of source blocks. @@ -471,7 +471,7 @@ These blocks exist purely for documentation purposes. They generate visible code blocks in the exported documentation, but they do not create files. Example:
-+#+begin_src bash :tangle no <tekst> #+end_src @@ -487,7 +487,7 @@ They are never tangled into the filesystem. These blocks generate real.nixfiles and insert the same code into the documentation. Example: -+** install_packages.nix <tekst> #+begin_src nix :tangle configuration/apps/install_packages.nix :noweb tangle :mkdirp yes @@ -515,8 +515,8 @@ This means:
2.2. The Two Core Commands
+2.2. The Two Core Commands
There are exactly two commands that matter. @@ -564,8 +564,8 @@ Both come from the same source.
2.3. Editing Generated Files
+2.3. Editing Generated Files
The directories: @@ -591,8 +591,8 @@ Generated directories are output, not source.
2.4. Recommended Workflow
+2.4. Recommended Workflow
This workflow allows safe experimentation while preserving literate structure. @@ -633,15 +633,15 @@ If you are confident about your changes, you may skip steps 1–3 and edit READM
2.5. Folder Structure Explained
+2.5. Folder Structure Explained
The repository separates generated system code from non-generated supporting files.
2.5.1. ./assets
+2.5.1. ./assets
Contains non-generated assisting files such as: @@ -656,8 +656,8 @@ These files are safe to edit directly.
2.5.2. ./assets/conf
+2.5.2. ./assets/conf
Contains non-generated assisting configuration files that influence several aspects of builds. @@ -665,8 +665,8 @@ Users are expected to modify these when needed.
2.5.3. ./configuration
+2.5.3. ./configuration
Fully (re)generated by README.org. @@ -685,8 +685,8 @@ This directory is output.
2.5.4. ./hardware
+2.5.4. ./hardware
Contains non-generated hardware.nix files detailing hardware-specific details. @@ -694,8 +694,8 @@ This directory will likely be deprecated in the future.
2.5.5. ./home
+2.5.5. ./home
Fully (re)generated by README.org. @@ -711,8 +711,8 @@ Contains:
2.5.6. ./machines
+2.5.6. ./machines
Contains one folder per machine you want to configure. @@ -730,8 +730,8 @@ These determine how shared modules apply to each system.
2.6. Final Principle
+2.6. Final Principle
A literate NixOS system guarantees: @@ -750,8 +750,8 @@ You are maintaining a structured narrative that builds an operating system.
2.7. Base packages
+2.7. Base packages
The baseline package set is defined explicitly within the repository to ensure reproducibility: @@ -825,8 +825,8 @@ The baseline package set is defined explicitly within the repository to ensure r
2.8. Additional packages
+2.8. Additional packages
Additional software can be installed by extending the dedicated configuration files that define system and Flatpak packages: @@ -867,12 +867,12 @@ This separation maintains clarity between system-level packages and user-facing
3. Setting up your system manually
+3. Setting up your system manually
3.1. Pre-requisites to build this setup
+3.1. Pre-requisites to build this setup
- a NIXOS system installed with a user with sudo rights. @@ -882,8 +882,8 @@ This separation maintains clarity between system-level packages and user-facing
3.2. Setup when Emacs not (yet) available
+3.2. Setup when Emacs not (yet) available
- Copy the folder henrovnixok to your machine @@ -952,8 +952,8 @@ Run the build command to set up the system for the first time
4. Testing and generating builds
+4. Testing and generating builds
At this stage, you should have a functional and reproducible system that can be edited, rebuilt, and extended according to your needs. The foundational structure is now in place, and further customization can occur incrementally through the modular configuration files. @@ -1016,46 +1016,46 @@ Other important files:
5. flake.lock for pinning input versions.
+5. flake.lock for pinning input versions.
6. assets/* for non-Nix-managed artifacts such as images and wallpapers.
+6. assets/* for non-Nix-managed artifacts such as images and wallpapers.
Generated outputs should not be edited directly. A CI workflow can tangle and commit generated outputs when they differ.
6.1. Emacs + Org + Tangle
+6.1. Emacs + Org + Tangle
7. [Emacs](https://www.gnu.org/software/emacs/][Emacs) is used as the editor and execution environment for this literate configuration.
+7. [Emacs](https://www.gnu.org/software/emacs/][Emacs) is used as the editor and execution environment for this literate configuration.
8. [Org](https://orgmode.org/][Org) mode provides the document structure and the source block execution model used here.
+8. [Org](https://orgmode.org/][Org) mode provides the document structure and the source block execution model used here.
9. Tangling exports source blocks from this Org document into the corresponding configuration files.
+9. Tangling exports source blocks from this Org document into the corresponding configuration files.
- References of the form
<<code-id>>are noweb placeholders that are expanded from other blocks during tangling.
9.1. Nix & NixOS
+9.1. Nix & NixOS
10. [Nix](https://nix.dev/][Nix) is used to define packages, environments, and configuration as pure expressions.
+10. [Nix](https://nix.dev/][Nix) is used to define packages, environments, and configuration as pure expressions.
11. [NixOS](https://nixos.org/][NixOS) evaluates Nix expressions into a complete system configuration that can be applied by rebuild operations.
+11. [NixOS](https://nixos.org/][NixOS) evaluates Nix expressions into a complete system configuration that can be applied by rebuild operations.
11.1. Repository layout and folder conventions
+11.1. Repository layout and folder conventions
<p> @@ -1068,8 +1068,8 @@ Generated outputs should not be edited directly. A CI workflow can tangle and co
11.2. Shared domain folders
+11.2. Shared domain folders
<ul> @@ -1083,8 +1083,8 @@ Generated outputs should not be edited directly. A CI workflow can tangle and co
11.3. Full tree (including unchanged parts)
+11.3. Full tree (including unchanged parts)
The tree below shows the full repository layout, with the standardized internal structure applied only inside @@ -1219,8 +1219,8 @@ The tree below shows the full repository layout, with the standardized internal
11.4. Notes
+11.4. Notes
<ul> @@ -1253,8 +1253,8 @@ This prevents unwanted and surprise updates when rebuilding without changing the
12. TLDR App List
+12. TLDR App List
13. Configuration Variables
+13. Configuration Variables
I have a bunch of constant strings that I would rather put in a file. Thats what user.nix is.
@@ -1346,8 +1346,8 @@ The values are imported at the beginning and are available to almost all the fun
14. Flake Inputs
+14. Flake Inputs
The inputs for my system's configuration are very simple @@ -1388,8 +1388,8 @@ Sometimes pinned to a specific commit because unstable broke something and the f
15. Flake Output
+15. Flake Output
Now that the inputs are ready, the outputs define what the system will actually look like. I also define the machines that this configuration specifies early on. Finally, I iterate over the machines list and pull files from /.machines/${name} subdirectory. This allows me to have configuration that has machine specific configuration limited to those files while also keeping a modular reusable base.
@@ -1397,7 +1397,7 @@ We also add a devshell that makes editing this repository easier in emacs.
outputs = inputs@{
+outputs = inputs@{
nixpkgs,
home-manager,
emacs-overlay,
@@ -1458,7 +1458,7 @@ Overlays are a special nix way to override existing packages within a repository
-({ ... }: {
+({ ... }: {
nixpkgs.overlays = [ emacs-overlay.overlays.default ];
})
@@ -1468,7 +1468,7 @@ Overlays are a special nix way to override existing packages within a repository
Then the machine specific configuration, in this case, just "traveldroid".
-./machines/${machine}/configuration.nix
+./machines/${machine}/configuration.nix
@@ -1478,7 +1478,7 @@ This can be initialized and managed on its own but I'd rather use the nixo
-home-manager.nixosModules.home-manager
+home-manager.nixosModules.home-manager
{
home-manager.useGlobalPkgs = true;
home-manager.useUserPackages = true;
@@ -1521,8 +1521,8 @@ Finally I pull in the machine specific home configuration. Along with the overri
-
-15.1. Envrc + Direnv
+
+15.1. Envrc + Direnv
Editing this file will be much nicer if we have the dev environment configured.
@@ -1543,14 +1543,14 @@ fi
-
-16. Machines
+
+16. Machines
The individual machines subdirectory is configured as follows :-
-+--machine
++--machine
| +--configuration.nix
| +--home.nix
| +--hardware-configuration.nix
@@ -1571,12 +1571,12 @@ This imported object (or function result) is just trivially merged into a common
We can take a look at that the common hardware options I have for all my machines.
-
-16.0.1. Other Utils
+
+16.0.1. Other Utils
-
-17. Hardware
+
+17. Hardware
I'll let the code comments explain the file here.
@@ -1625,8 +1625,8 @@ I'll let the code comments explain the file here.
-
-18. Configuration
+
+18. Configuration
This section describes the main system configuration for the computers that I have. Nix will look for a default.nix file if you give it a path to a folder to import. And default.nix looks as follows :-
@@ -1669,16 +1669,16 @@ This section describes the main system configuration for the computers that I ha
-
-18.1. Apps section
+
+18.1. Apps section
This section describes a way of installing packages, either through nixpkgs orr flatpak. What apps to instal is decided in the files ./assets/conf/apps/packages.conf and flatpaks.conf
-
-18.2. installpackages.nix
+
+18.2. installpackages.nix
{ config, lib, pkgs, flakeRoot, inputs, ... }:
@@ -1728,8 +1728,8 @@ in
-
-18.3. installflatpaks.nix
+
+18.3. installflatpaks.nix
{ config, pkgs, lib, flakeRoot, ... }:
@@ -1841,8 +1841,8 @@ in
-
-18.4. Nix Settings
+
+18.4. Nix Settings
These are global nix settings that configure the settings for the actual tool.
@@ -1891,8 +1891,8 @@ These are global nix settings that configure the settings for the actual tool.
-
-18.5. Boot
+
+18.5. Boot
This file has most of the settings the control how the computer boots up.
@@ -1930,16 +1930,16 @@ This file has most of the settings the control how the computer boots up.
-
-18.6. Login
+
+18.6. Login
Here we control what the login screen would look like. In configuration/default.nix you can choose whether to use tuigreet (very minimalistic) or LightDM (nicer, themeable)
-
-18.7. Tuigreet
+
+18.7. Tuigreet
Doesn't match the rest of the aesthetic of the system (with hyprland), but I like its simplicity.
@@ -1964,8 +1964,8 @@ Doesn't match the rest of the aesthetic of the system (with hyprland), but I lik
-
-18.8. LightDM
+
+18.8. LightDM
{ config, pkgs, lib, ... }:
@@ -2112,8 +2112,8 @@ in
-
-18.9. Terminal (default system)
+
+18.9. Terminal (default system)
This is the initial system level configuration for the terminal that I use on this machine. Its just zsh.
@@ -2132,8 +2132,8 @@ This is the initial system level configuration for the terminal that I use on th
-
-18.10. Files
+
+18.10. Files
I use Thunar as the file explorer. Also setup a few plugins for Thunar in this config.
@@ -2174,8 +2174,8 @@ Along with that, a few other utilities like zip and enabling services to automou
-
-18.11. Locale
+
+18.11. Locale
I live in Netherlands and would like all my locale and timezone settings to match. Except my default locale.
@@ -2209,8 +2209,8 @@ in
-
-18.12. Networking
+
+18.12. Networking
Not much to see here. I want networking to be enabled. I want firewall as well.
@@ -2241,8 +2241,8 @@ Not much to see here. I want networking to be enabled. I want firewall as well.
-
-18.13. Hyprland
+
+18.13. Hyprland
This is a big one because the DE needs so much configuration. This section mostly installs Hyprland.
@@ -2313,8 +2313,8 @@ The configuration is done in the home manager section.
-
-18.14. Services
+
+18.14. Services
These are some of the services that I enable at the system level. Explanation in the comments.
@@ -2347,8 +2347,8 @@ These are some of the services that I enable at the system level. Explanation in
-
-18.15. Audio
+
+18.15. Audio
{ config, pkgs, lib, ... }:
@@ -2425,14 +2425,14 @@ These are some of the services that I enable at the system level. Explanation in
-
-18.16. Fonts
+
+18.16. Fonts
Nothing much to see here. I love Aporetic, and I use it everywhere.
-fonts.packages = with pkgs; [
+fonts.packages = with pkgs; [
aporetic
nerd-fonts.iosevka
];
@@ -2440,14 +2440,14 @@ Nothing much to see here. I love
-18.17. User Config
+
+18.17. User Config
This creates the user profile that I login with. Initially created during install.
-users.users.${user.username} = {
+users.users.${user.username} = {
isNormalUser = true;
description = "henrov";
extraGroups = [
@@ -2462,8 +2462,8 @@ This creates the user profile that I login with. Initially created during instal
-
-19. Home
+
+19. Home
I use home-manager to manage my user level dotfiles and configurations.
@@ -2471,8 +2471,8 @@ Most of the "theme" of the system is decided here.
I also use it to install programs that are okay with being installed at the user level instead of the system.
-
-19.1. default.nix
+
+19.1. default.nix
This module will import all necessities.
@@ -2516,8 +2516,8 @@ This module will import all necessities.
-
-19.2. Ollama
+
+19.2. Ollama
This Home Manager Nix module (ai.nix) installs the Ollama package and configures it by reading a simple key-value configuration file (ollama.conf) for settings like the server host and default model. It sets environment variables (OLLAMAHOST and OLAMADEFAULTMODEL) for easy access in your shell or applications, with fallback defaults if the config file is missing or empty. Optionally, it also defines a user-level systemd service to automatically start the Ollama server on NixOS or systems with Home Manager’s systemd support enabled.
@@ -2544,8 +2544,8 @@ in
-
-19.3. Powermenu
+
+19.3. Powermenu
Creates a script for a powermenu
@@ -2568,8 +2568,8 @@ in
-
-19.4. Animated Wallpaper
+
+19.4. Animated Wallpaper
userRelRoot = "nixosconf/wallpaperstuff";
@@ -2630,8 +2630,8 @@ in
-
-19.5. Rotating Wallpaper
+
+19.5. Rotating Wallpaper
rotatingwallpaper.nix installs wpaperd and deploys your wallpaper files from the repo (./assets/conf/desktop/wallpaper/pictures/) into ~/conf/desktop/wallpaper/pictures. It also deploys the default wallpaper configuration from assets/conf/desktop/wallpaper/wallpaper.conf into ~/conf/desktop/wallpaper/wallpaper.conf, which is the file you can edit as a user override.
@@ -2685,8 +2685,8 @@ in
-
-19.6. Workspace Wallpaper
+
+19.6. Workspace Wallpaper
{ config, lib, pkgs, flakeRoot, ... }:
@@ -2896,11 +2896,11 @@ in
-
-19.7. Waybar
+
+19.7. Waybar
-
+
@@ -2934,8 +2934,8 @@ in
-
-19.8. Lock Screen
+
+19.8. Lock Screen
The lock screen configured using hyprlock.
@@ -2957,8 +2957,8 @@ in
-
-19.9. Idle Screen
+
+19.9. Idle Screen
<henro: needs instruction>
@@ -2976,8 +2976,8 @@ in
-
-19.10. hyprscrolling
+
+19.10. hyprscrolling
This Nix module integrates the hyprscrolling plugin into a Home-Manager managed Hyprland setup in a declarative and reproducible way. It ensures the plugin is installed, optionally switches Hyprland to the scrolling layout, and renders user-defined plugin settings directly into the Hyprland configuration. The goal is to manage the scrolling workspace behavior entirely from Nix instead of maintaining manual edits inside hyprland.conf.
@@ -3034,8 +3034,8 @@ in
-
-19.11. Hyprshell
+
+19.11. Hyprshell
For nice task-starting and -switching
@@ -3075,8 +3075,8 @@ in
-
-19.12. Hyprland
+
+19.12. Hyprland
This configures the desktop environment along with the peripherals. The comments should explain whats happening.
@@ -3126,8 +3126,8 @@ in
-
-19.13. Walker
+
+19.13. Walker
This is how I launch applications. It is bound to Win+Space in the ./asstes/conf/desktop/hypr/bindings.conf.
@@ -3163,8 +3163,8 @@ in
-
-19.14. Theme
+
+19.14. Theme
I use the Catppuccin almost everywhere. The nix module integrates almost automatically everywhere (except gtk).
@@ -3197,8 +3197,8 @@ You'll notice the color values in multiple places outside this as well.
-
-19.15. Default-apps
+
+19.15. Default-apps
This is where you can set defaults
@@ -3217,8 +3217,8 @@ This is where you can set defaults
-
-19.16. Hyperexpo
+
+19.16. Hyperexpo
hyprexpo gets installed and configured
@@ -3257,8 +3257,8 @@ hyprexpo gets installed and configured
-
-19.17. Alacritty
+
+19.17. Alacritty
Alacritty gets installed and configured
@@ -3280,8 +3280,8 @@ in
-
-19.18. Dev Tools
+
+19.18. Dev Tools
All the miscellaneous dev tools on this computer.
@@ -3333,8 +3333,8 @@ All the miscellaneous dev tools on this computer.
-
-19.19. Kitty
+
+19.19. Kitty
Kitty gets installed and configured
@@ -3373,8 +3373,8 @@ in
-
-19.20. Shells
+
+19.20. Shells
The aliases mentioned in ./assets/conf/dev/terminal/shells.conf will be added to enabled shells
@@ -3590,8 +3590,8 @@ EOF
-
-19.21. Zsh
+
+19.21. Zsh
Zsh gets installed and configured
@@ -3627,8 +3627,8 @@ Zsh gets installed and configured
-
-19.22. Starship
+
+19.22. Starship
The configuration mentioned in ./assets/conf/dev/terminal/starship.toml will be added to enabled shells
@@ -3660,18 +3660,18 @@ in
-
-19.23. Other Settings
+
+19.23. Other Settings
Some repeated info from the configuration.
-
-19.23.1. Home User
+
+19.23.1. Home User
-home.username = "${user.username}";
+home.username = "${user.username}";
home.homeDirectory = pkgs.lib.mkDefault "/home/${user.username}";
home.stateVersion = user.stateVersion;
@@ -3680,8 +3680,8 @@ home.stateVersion = user.stateVersion;
-
-20. Emacs
+
+20. Emacs
I practically live inside emacs. The configuration for it is a mix between init.el and the nix configuration.
@@ -3760,8 +3760,8 @@ Comments describe the emacs package and what it does.
-
-20.1. Early Initialization
+
+20.1. Early Initialization
There are some emacs settings that can be configured before the gui shows up.
@@ -3866,8 +3866,8 @@ These are listed here.
-
-20.2. Initialization
+
+20.2. Initialization
Now starts the main emacs configuration.
@@ -4279,22 +4279,22 @@ ting a file within such a
-
-21. Machines
+
+21. Machines
Only a few more things left. Specifically the machine level extra settings.
-
-21.1. Traveldroid
+
+21.1. Traveldroid
The configuration for the laptop does not change much. Most changes are because the hardware is different.
-
-21.1.1. System Level
+
+21.1.1. System Level
Nothing specific for the laptop.
@@ -4312,8 +4312,8 @@ Nothing specific for the laptop.
-
-21.1.2. Hardware
+
+21.1.2. Hardware
This is the most different. Mostly taken from hardware-configuration.nix setup at first install.
@@ -4363,8 +4363,8 @@ hardware.cpu.intel.updateMicrocode = lib.mkDefault config.hardware.enableRedistr
-
-21.1.3. Home
+
+21.1.3. Home
This is mostly about configuring the monitor. And laptop specific utilities.
@@ -4391,18 +4391,18 @@ This is mostly about configuring the monitor. And laptop specific utilities.
-
-22. README Utils
+
+22. README Utils
-
-22.0.1. Headers
+
+22.0.1. Headers
This script adds a DO NOT MODIFY header to all the generated nix files.
-(progn
+(progn
(defun add-tangle-headers ()
(message "running in %s" (buffer-file-name))
(when (string= (file-name-extension (buffer-file-name)) "nix")
@@ -4419,7 +4419,7 @@ This script adds a DO NOT MODIFY header to all the generated nix fi