-
Notifications
You must be signed in to change notification settings - Fork 24
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
docs/darwin: document current modules
- Loading branch information
Showing
3 changed files
with
60 additions
and
10 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,13 @@ | ||
Config extensions for a given machine. | ||
|
||
One or more can be included per NixOS configuration. | ||
|
||
### `darwiModules.mixins-telegraf` | ||
|
||
Enables a generic telegraf configuration. `nixosModules.mixins-prometheus` for monitoring rules targeting this telegraf configuration. | ||
|
||
### `darwinModules.mixins-terminfo` | ||
|
||
Extends the terminfo database with often used terminal emulators. | ||
Terminfo is used by terminal applications to interfere supported features in the terminal. | ||
This is useful when connecting to a server via SSH. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,32 @@ | ||
Those high-level modules are used to define the type of machine. | ||
|
||
We expect only one of those to be imported per Darwin configuration. | ||
|
||
### Common (`darwinModules.common`) | ||
|
||
Use this module if you are unsure if your darwin module will be used on server or desktop. | ||
|
||
- Better nix-daemon defaults | ||
- Better serial console support | ||
- Colored package diffs on nixos-rebuild | ||
- Use systemd in initrd by default and networkd as a backend for the | ||
Networking module | ||
- Do not block on networkd/networkmanager's online target | ||
- Better zfs defaults | ||
- Add ssh host keys to well-known Git servers (eg: github) | ||
- Enable sudo for @wheel users. | ||
- ... | ||
|
||
### Server (`darwinModules.server`) | ||
|
||
Use this for headless systems that are remotely managed via ssh. | ||
|
||
- Includes everything from common | ||
- So far nothing else, but this might change over time | ||
|
||
### Desktop (`darwinModules.desktop`) | ||
|
||
Despite this project being about servers, we wanted to dogfood the common module. | ||
|
||
- Includes everything from common | ||
- So far nothing else, but this might change over time |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters