dotfiles

This directory contains the configuration and dotfiles for my continuously evolving multi-PC setup (using Nix). All the devices I own, controlled by code. It also builds and deploys my website to maydayv7.dev.

Features

• Device-Agnostic
• Convenient and Automated
• Hermetically Reproducible
• Declarative and Derivational
• Atomic, Generational and Immutable

Notable Features

• Supports multiple users and devices
• Configuration for multiple DEs and Compositors
• Incorporates PipeWire, Wayland, ...!
• Automatically builds and deploys my Website
• Credentials management using the sops-nix module and gnupg keys
• Comprehensive User Configuration using the home-manager module
• Ephemeral, opt-in filesystem state using the impermanence module and ZFS
• Declarative disk partitioning and installation using disko
• Support for Secure Boot using lanzaboote
• Multiple development shells integrated with direnv and lorri
• Automatic packages updates using update.sh
• Syntax formatting using treefmt
• Support for source filters with nix-filter
• Support for Base16 color theming using stylix
• Support for declaratively installing Flatpak applications using nix-flatpak
• Support for Android Virtualisation using Waydroid
• Support for VFIO PCI Device Passthrough with a declarative, performant Windows VM using NixVirt and Looking Glass (see my blog post)

Programs

Structure

Overview of File Hierarchy

$ nix flake show
github:maydayv7/dotfiles
├───apps
│   └───x86_64-linux
│       ├───sysutils: app
│       ├───hyprutils: app
│       ├───install: app
│       ├───nixos: app
│       └───default: app
├───checks
│   └───x86_64-linux
│       ├───configurations:nixos:futura: derivation
│       ├───configurations:nixos:valkyrie: derivation
│       ├───configurations:nixos:vortex: derivation
│       └───treefmt: derivation 'treefmt-check'
├───devShells
│   └───x86_64-linux
│       ├───cc: development environment 'C'
│       ├───android: development environment 'Android'
│       ├───default: development environment 'devShell'
│       ├───format: development environment 'nix-shell'
│       ├───java: development environment 'Java'
│       ├───js: development environment 'JavaScript'
│       ├───lua: development environment 'Lua'
│       ├───python: development environment 'Python'
│       ├───rust: development environment 'Rust'
│       ├───sql: development environment 'SQL'
│       ├───video: development environment 'Video'
│       └───website: development environment 'Website'
├───files: 'dotfiles' and program configuration
├───formatter
│   └───x86_64-linux: package 'treefmt'
├───homeConfigurations
│   ├───navya@futura: Home Manager configuration
│   ├───v7@valkyrie: Home Manager configuration
│   └───v7@vortex: Home Manager configuration
├───legacyPackages
│   └───x86_64-linux (Default package channel)
├───modules: dendritic configuration modules
├───nixosConfigurations
│   ├───futura: NixOS configuration
│   ├───install: NixOS configuration
│   ├───valkyrie: NixOS configuration
│   └───vortex: NixOS configuration
├───overlays
├───packages
│   └───x86_64-linux
│       ├───install: package 'os-install'
│       ├───nixos: package 'nixos'
│       └───website: package 'website-stable'
├───patchedPkgs: patched package source
└───templates
    └───default: template: My NixOS Configuration

┌── flake.nix
├── flake.lock
├── files
├── site
├── secrets
│   └── passwords
├── shells
├── lib
│   ├── build.nix
│   └── map.nix
├── scripts
│   ├── install.nix
│   └── os.nix
├── packages
│   ├── overlays
│   └── patches
└── modules
    ├── core
    ├── hosts
    ├── apps
    ├── desktop
    ├── games
    ├── gui
    ├── hardware
    ├── shell
    ├── system
    ├── users
    └── virt

• flake.nix: toplevel configuration file and repository version control
  flake-parts is used for modularization, following the dendritic pattern

• files: dotfiles and program configuration

• site: personal website generated using zola
• secrets: authentication credentials and user passwords managed using sops-nix
• shells: sand-boxed shells for development purposes
• lib: custom functions designed for conveniently defining configuration
• scripts: useful system management scripts
• packages: locally built custom packages
• overlays: overrides for pre-built packages
• modules: custom configuration modules for additional functionality

Installation

sudo mkdir /etc/nixos
   sudo chown $USER /etc/nixos && sudo chmod ugo+rw /etc/nixos
   cd /etc/nixos
   

nix flake init -t github:maydayv7/dotfiles
   git init
   

gpg --full-generate-key
   1
   4096
   0
   y
   USER
   EMAIL
   COMMENT
   O
   gpg --output public.pgp --armor --export USER@EMAIL
   gpg --output private.pgp --armor --export-secret-key USER@EMAIL
   

sops --config /path/to/secrets.yaml -i PATH

nix build github:maydayv7/dotfiles#nixosConfigurations.install.config.system.build.images.iso

nix build github:maydayv7/dotfiles#install
sudo ./result/bin/os-install

nix build github:maydayv7/dotfiles#nixosConfigurations.DEVICE.config.system.build.images.iso

Notes

Caution

This repository contains my personal configuration, and may cause undesirable effects on other systems. It may also be subject to rapid undocumented changes, and uses Nix Flakes, an experimental feature.

It is not recommended to use NixOS if you are a beginner just starting out, without acquaintance with either the command-line or functional programming languages, since the learning curve is steep, debugging issues is difficult, documentation is shallow, and the effort required/time spent isn't worth the hassle for a novice/casual user.

Platform

May change according to available hardware

This configuration works well with an Intel CPU + iGPU, and is currently being improved to support an AMD APU + Nvidia GPU. Any other setup is untested.
The hardware.modules option can be used to load relevant configuration from nixos-hardware.

See this for additional information

Cache

The system build cache is publicly hosted using Cachix at maydayv7-dotfiles, and can be used while building the system to prevent rebuilding from scratch

Continuous Integration

This repository makes use of GitHub Actions in order to automatically check the configuration syntax & format on every commit, update the inputs and build the Install Media .iso every month, and upload the build cache to Cachix. A git hook is used to check the commit message to adhere to the Conventional Commits specification

Variables

• ACCESS_TOKEN: Personal Access Token (To create one, see this)
• CACHIX_TOKEN: Cachix Authentication Token

If you like this project, consider leaving a star