Skip to content

Latest commit

 

History

History
130 lines (97 loc) · 2.95 KB

README.md

File metadata and controls

130 lines (97 loc) · 2.95 KB

modulix

A NixOS configuration framework that simplifies host and module management using a structured approach, built upon haumea.

Please see the docs for more information.

Basic Usage

To use this library, you need to have enabled the following experimental features:

experimental-features = nix-command flakes pipe-operators

Look at the example directory for a working example.

flake.nix:

{
    inputs = {
        nixpkgs.url = "github:NixOS/nixpkgs/nixos-unstable";
        modulix = {
            url = "github:anders130/modulix";
            inputs.nixpkgs.follows = "nixpkgs";
        };
    };

    outputs = inputs: {
        nixosConfigurations = inputs.modulix.lib.mkHosts {
            inherit inputs;
            src = ./hosts-directory; # optional (defaults to ./hosts)
            flakePath = "/path/to/flake"; # for lib.mkSymlink
            modulesPath = ./modules-directory; # optional
            specialArgs = {
                hostname = "nixos";
                # put in your specialArgs like above
            };
        };
    };
}

hosts-directory

The hosts-directory should contain a directory for each host you want to configure. The directory name will be the hostname of the host. The host directory should contain a default.nix and a config.nix. The default.nix should contain the configuration for the host. The config.nix should contain the values for the specialArgs.


hosts
├── host1
│ ├── config.nix
│ └── default.nix
└── host2
  ├── config.nix
  └── default.nix

example config.nix:

inputs: {
    system = "x86_64-linux";
    username = "user1";
    hostname = "host1";
    modules = [inputs.some-module.nixosModules.some-module];
}

default specialArgs

The default specialArgs are:

{
    isThinClient = false; # if true, lib.mkSymlink will use the store path instead of the flake path
    system = "x86_64-linux"; # the system of the host
    username = "nixos"; # the username of the host
    modules = []; # additional modules to add to the host
}

modules-directory

The modules-directory should contain a directory or a file for each module you want to declare.

You can declare simple to complex modules:

{
    options = {
        someOption = mkOption {
            type = types.bool;
            default = false;
            description = "Some option";
        };
    };

    config = cfg: {
        someConfig = cfg.someOption;
    };
}

Contributing

Contributions are welcome!

Documentation

The documentation is written in mdbook and can be found in the docs directory. You can start a local server with:

cd docs
nix develop

To build the documentation locally, run the following command:

cd docs
nix build

License

MIT