Introduction

Features

Multi-hosts and multi-users, deployed with colmena 🡕 and just 🡕.
Host profiles for servers, containers, and workstations.
User profiles providing common configurations for various users.
High-level modules 100% functional with a simple .enable = true.
Extensible, scalable, consistent, customizable architecture.
User profiles management with home manager 🡕 + home profiles 🡕.
Automatic homepage 🡕 with Homepage 🡕, based on activated services.
Cross-configuration to ensure network consistency.
Easy and reliable security, a single password to unlock, with sops 🡕.

Files organisation

Main folders:

dnf -> Framework: tools + modules + profiles (users, hosts, themes)
usr -> Local project: config, modules + profiles, machines, users
src -> Generator and scripts for tools
var -> Generated files and logs
doc -> Framework documentation

Layers

The lower layers serve the upper layers.

DNF Project layers

The configurations are also organized by category:

Standard modules: Ready-to-use simple modules (just write .enable = true).
Mixin modules: Ready-to-use collections of modules with a consistent common configurations.
Users’ declaration: Used to instantiate real users from user profiles.
Home profiles: Contains Home Manager 🡕 configurations for each user profile.
Tools & configurations: Manage the generation and quality of Nix declarations.

Structure

flake.nix Main flake
Justfile Project management with just
Directorydnf/ Darkone Nixos Framework (modules & common files)
- Directorymodules/ Framework modules
  - Directorynix Nix modules
    Directorystandard Standard nix modules
    Directorysystem/ System / Hardware configurations
    core.nix
    i18n.nix
    doc.nix
    …
    Directoryconsole/ CLI applications
    …
    Directorygraphic/ X applications
    …
    Directoryservice/ Daemons
    …
    Directoryadmin/ Nix administration settings
    nix.nix Nix tools
    …
    Directoryuser/ User management (not home)
    nix.nix Nix special user (for deployments)
    build.nix Users builder
    …
    Directorymixin Mixin modules
    Directoryhost/ Host profiles
    desktop.nix
    laptop.nix
    server.nix
    vm.nix
    minimal.nix
    …
    Directorytheme/ Thematic features
    office.nix
    advanced.nix
    student.nix
    …
    default.nix Auto-generated default
  - Directoryhome Home manager modules
    zed.nix
    …
    default.nix Auto-generated default
- Directoryhomes/ User profiles (.nix) + home profiles (dirs)
  - admin.nix Admin user profile config (extragroups, etc.)
  - Directoryadmin/ Admin user profile home
    …
  - Directoryadvanced/ Advanced user with development tools
    …
  - Directoryminimal/ Easy environment
    …
  - Directorynormal/ Non-technical user
    …
  - Directorygamer/ Optimized environment for gamers
    …
  - Directorychild/ Kids softwares and settings
    …
  - …
- Directoryoverlays/
  - …
Directoryusr/ Writable zone for local network project
- config.yaml Local configuration used by the generator
- Directorymodules/ Local modules
  - Directorynix/
    Directorystandard/
    …
    Directorymixin/
    Directoryhost/ Local host profiles
    …
  - Directoryhome/
    …
- Directorysecrets/ Local secrets file
  - secret.yaml SOPS secrets
- Directoryhomes/ Local home profiles
  - …
- Directorymachines/ Machine specific configuration by host (hardwares)
  - …
- Directoryoverlays/
  - …
Directoryvar/
- Directorylog/
  - …
- Directorygenerated/ Generated files
  - hosts.nix Hosts to deploy
  - users.nix Users to deploy
  - network.nix Local network configuration
Directorysrc/ Generator sources
- …