os/doc/api-reference-channels.md

Ignoring revisions in .git-blame-ignore-revs. Click here to bypass and see the normal blame view.

77 lines
1.1 KiB
Markdown
Raw Permalink Normal View History

# Channels API Container
2022-11-20 22:28:23 +00:00
Configure your channels that you can use throughout your configurations.
> #### ⚠ Gotcha ⚠
2022-11-20 22:28:23 +00:00
>
> Devshell & (non-host-specific) Home-Manager `pkgs` instances are rendered off the
> `nixos.hostDefaults.channelName` (default) channel.
## channels
nixpkgs channels to create
_*Type*_:
attribute set of submodules or path convertible to it
2022-11-20 22:28:23 +00:00
_*Default*_
```
{}
```
## channels.\<name\>.config
nixpkgs config for this channel
_*Type*_:
attribute set or path convertible to it
2022-11-20 22:28:23 +00:00
_*Default*_
```
{}
```
## channels.\<name\>.input
nixpkgs flake input to use for this channel
_*Type*_:
nix flake
2022-11-20 22:28:23 +00:00
_*Default*_
```
"self.inputs.<name>"
```
## channels.\<name\>.overlays
2022-11-20 22:28:23 +00:00
overlays to apply to this channel
these will get exported under the 'overlays' flake output
as \<channel\>/\<name\> and any overlay pulled from \<inputs\>
will be filtered out
_*Type*_:
list of valid Nixpkgs overlay or path convertible to its or anything convertible to it or path convertible to it
2022-11-20 22:28:23 +00:00
_*Default*_
```
[]
```
## channels.\<name\>.patches
patches to apply to this channel
_*Type*_:
list of paths
2022-11-20 22:28:23 +00:00
_*Default*_
```
[]
```