os/doc/api-reference-home.md

98 lines
1.4 KiB
Markdown
Raw Normal View History

# Home-Manager API Container
2023-01-28 20:49:10 +00:00
Configure your home manager modules, profiles & suites.
## home
2023-01-28 20:49:10 +00:00
hosts, modules, suites, and profiles for home-manager
2023-01-28 20:49:10 +00:00
_*Type*_:
submodule or path convertible to it
2023-01-28 20:49:10 +00:00
_*Default*_
```
{}
```
## home.exportedModules
2023-01-28 20:49:10 +00:00
modules to include in all hosts and export to homeModules output
2023-01-28 20:49:10 +00:00
_*Type*_:
list of valid modules or anything convertible to it or path convertible to it
2023-01-28 20:49:10 +00:00
_*Default*_
```
[]
```
## home.externalModules
2023-01-28 20:49:10 +00:00
The `externalModules` option has been removed.
Any modules that should be exported should be defined with the `exportedModules`
option and all other modules should just go into the `modules` option.
2023-01-28 20:49:10 +00:00
_*Type*_:
list of valid modules or anything convertible to it
2023-01-28 20:49:10 +00:00
_*Default*_
```
[]
```
## home.importables
2023-01-28 20:49:10 +00:00
Packages of paths to be passed to modules as `specialArgs`.
2023-01-28 20:49:10 +00:00
_*Type*_:
attribute set
2023-01-28 20:49:10 +00:00
_*Default*_
```
{}
```
## home.importables.suites
2023-01-28 20:49:10 +00:00
collections of profiles
2023-01-28 20:49:10 +00:00
_*Type*_:
null or attribute set of list of paths or anything convertible to its or path convertible to it
2023-01-28 20:49:10 +00:00
_*Default*_
```
null
```
## home.modules
2023-01-28 20:49:10 +00:00
modules to include that won't be exported
meant importing modules from external flakes
2023-01-28 20:49:10 +00:00
_*Type*_:
list of valid modules or anything convertible to it or path convertible to it
2023-01-28 20:49:10 +00:00
_*Default*_
```
[]
```
## home.users
2023-01-28 20:49:10 +00:00
HM users that can be deployed portably without a host.
2023-01-28 20:49:10 +00:00
_*Type*_:
attribute set of HM user configs
2023-01-28 20:49:10 +00:00
_*Default*_
```
{}
```