pub-solar-os/doc/concepts/extern.md

43 lines
1.1 KiB
Markdown
Raw Normal View History

2021-02-14 02:38:20 +00:00
# External Art
When you need to use a module, overlay, or pass a value from one of your inputs
to the rest of your NixOS configuration, you can make use of a couple arguments.
It is encouraged to add external art directly in your `flake.nix` so the file
represents a complete dependency overview of your flake.
2021-02-14 02:38:20 +00:00
## Overlays
External overlays can directly be added to a channel's `overlays` list.
2021-02-14 02:38:20 +00:00
2021-02-21 21:44:57 +00:00
flake.nix:
```nix
{
channels.nixos.overlays = [ inputs.agenix.overlay ];
2021-02-21 21:44:57 +00:00
}
```
These overlays will be automatically filtered by inspecting the `inputs` argument.
2021-02-21 21:44:57 +00:00
## Modules
There is a dedicated `nixos.hostDefaults.externalModules` argument for external
modules.
flake.nix:
2021-02-20 19:42:36 +00:00
```nix
{
nixos.hostDefaults.externalModules = [ inputs.agenix.nixosModules.age ];
2021-02-21 21:44:57 +00:00
}
```
## Home Manager
Since there isn't a `hosts` concept for home-manager, externalModules is just a
top-level argument in the `home` namespace.
flake.nix:
2021-02-21 21:44:57 +00:00
```nix
{
home.externalModules = [ doom-emacs = doom-emacs.hmModule ];
2021-02-20 19:42:36 +00:00
}
```
> ##### Note:
> The optimal solution would be to automatically export modules that were created in
> your flake. But this is not possible due to NixOS/nix#4740.