alyraffauf/nixcfg
1
0
Fork 0
mirror of https://github.com/alyraffauf/nixcfg.git synced 2024-11-25 15:11:54 -05:00
Code Issues Actions 7 Packages Projects Releases Wiki Activity

nixosModules: improve option documentation

Browse source
This commit is contained in:
Aly Raffauf 2024-06-11 23:28:21 -04:00
parent 0e2068b4c6
commit 5d062c1b9d
1 changed files with 7 additions and 7 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

14
nixosModules/options.nix
View file

@ -16,7 +16,7 @@
steam.enable = steam.enable =
lib.mkEnableOption "Valve's Steam for video games."; lib.mkEnableOption "Valve's Steam for video games.";
virt-manager.enable = virt-manager.enable =
lib.mkEnableOption "Virt-manager with TPM and EFI support."; lib.mkEnableOption "Virt-manager for virtual machines with TPM and EFI support.";
}; };
base.enable = base.enable =
@ -26,7 +26,7 @@
nixos = { nixos = {
audiobookshelf = { audiobookshelf = {
enable = enable =
lib.mkEnableOption "audiobookshelf nixos container."; lib.mkEnableOption "audiobookshelf audiobook and podcast server in NixOS container.";
mediaDirectory = lib.mkOption { mediaDirectory = lib.mkOption {
description = "Media directory for audiobookshelf."; description = "Media directory for audiobookshelf.";
default = "/mnt/Media"; default = "/mnt/Media";
@ -40,7 +40,7 @@
}; };
navidrome = { navidrome = {
enable = enable =
lib.mkEnableOption "navidrome nixos container."; lib.mkEnableOption "Navidrome music server in NixOS container.";
musicDirectory = lib.mkOption { musicDirectory = lib.mkOption {
description = "Music directory for Navidrome."; description = "Music directory for Navidrome.";
default = "/mnt/Media/Music"; default = "/mnt/Media/Music";
@ -227,7 +227,7 @@
type = lib.types.str; type = lib.types.str;
}; };
}; };
tailscale.enable = lib.mkEnableOption "Enable Tailscale"; tailscale.enable = lib.mkEnableOption "Tailscale WireGuard VPN.";
}; };
base = { base = {
plymouth.enable = plymouth.enable =
@ -240,7 +240,7 @@
zramSwap = { zramSwap = {
enable = lib.mkEnableOption "Zram swap."; enable = lib.mkEnableOption "Zram swap.";
size = lib.mkOption { size = lib.mkOption {
description = "Percent size of the zram swap."; description = "Percent size of the zram swap relative to RAM.";
default = 50; default = 50;
type = lib.types.int; type = lib.types.int;
}; };
@ -250,14 +250,14 @@
aly = { aly = {
enable = lib.mkEnableOption "Aly's user."; enable = lib.mkEnableOption "Aly's user.";
password = lib.mkOption { password = lib.mkOption {
description = "Hashed password for user aly."; description = "Hashed password for aly.";
type = lib.types.str; type = lib.types.str;
}; };
}; };
dustin = { dustin = {
enable = lib.mkEnableOption "Dustin's user."; enable = lib.mkEnableOption "Dustin's user.";
password = lib.mkOption { password = lib.mkOption {
description = "Hashed password."; description = "Hashed password for dustin.";
type = lib.types.str; type = lib.types.str;
}; };
}; };