mirror of
https://github.com/ilyakooo0/nixpkgs.git
synced 2024-09-11 07:15:54 +03:00
nixos: improve many 'enable' descriptions
This commit is contained in:
parent
34852ddf5e
commit
a29010fe79
@ -10,7 +10,7 @@ in
|
||||
|
||||
options = {
|
||||
users.mysql = {
|
||||
enable = mkEnableOption (lib.mdDoc "Authentication against a MySQL/MariaDB database");
|
||||
enable = mkEnableOption (lib.mdDoc "authentication against a MySQL/MariaDB database");
|
||||
host = mkOption {
|
||||
type = types.str;
|
||||
example = "localhost";
|
||||
|
@ -15,7 +15,7 @@ in
|
||||
|
||||
options.xdg.portal.wlr = {
|
||||
enable = mkEnableOption (lib.mdDoc ''
|
||||
desktop portal for wlroots-based desktops
|
||||
desktop portal for wlroots-based desktops.
|
||||
|
||||
This will add the `xdg-desktop-portal-wlr` package into
|
||||
the {option}`xdg.portal.extraPortals` option, and provide the
|
||||
|
@ -11,7 +11,7 @@ in {
|
||||
];
|
||||
|
||||
options.hardware.ksm = {
|
||||
enable = mkEnableOption (lib.mdDoc "Kernel Same-Page Merging");
|
||||
enable = mkEnableOption (lib.mdDoc "Linux kernel Same-Page Merging");
|
||||
sleep = mkOption {
|
||||
type = types.nullOr types.int;
|
||||
default = null;
|
||||
|
@ -19,7 +19,7 @@ in
|
||||
options.hardware.logitech = {
|
||||
|
||||
lcd = {
|
||||
enable = mkEnableOption (lib.mdDoc "Logitech LCD Devices");
|
||||
enable = mkEnableOption (lib.mdDoc "support for Logitech LCD Devices");
|
||||
|
||||
startWhenNeeded = mkOption {
|
||||
type = types.bool;
|
||||
@ -41,7 +41,7 @@ in
|
||||
};
|
||||
|
||||
wireless = {
|
||||
enable = mkEnableOption (lib.mdDoc "Logitech Wireless Devices");
|
||||
enable = mkEnableOption (lib.mdDoc "support for Logitech Wireless Devices");
|
||||
|
||||
enableGraphical = mkOption {
|
||||
type = types.bool;
|
||||
|
@ -12,7 +12,7 @@ in
|
||||
|
||||
{
|
||||
|
||||
options.hardware.mwProCapture.enable = mkEnableOption (lib.mdDoc "Magewell Pro Capture family kernel module");
|
||||
options.hardware.mwProCapture.enable = mkEnableOption (lib.mdDoc "the Magewell Pro Capture family kernel module");
|
||||
|
||||
config = mkIf cfg.enable {
|
||||
|
||||
|
@ -5,7 +5,7 @@ with lib;
|
||||
{
|
||||
options = {
|
||||
programs.appgate-sdp = {
|
||||
enable = mkEnableOption (lib.mdDoc "AppGate SDP VPN client");
|
||||
enable = mkEnableOption (lib.mdDoc "the AppGate SDP VPN client");
|
||||
};
|
||||
};
|
||||
|
||||
|
@ -14,7 +14,7 @@ in
|
||||
|
||||
programs.atop = rec {
|
||||
|
||||
enable = mkEnableOption (lib.mdDoc "Atop");
|
||||
enable = mkEnableOption (lib.mdDoc "Atop, a tool for monitoring system resources");
|
||||
|
||||
package = mkPackageOption pkgs "atop" { };
|
||||
|
||||
|
@ -4,7 +4,7 @@ let
|
||||
cfg = config.programs.bash.blesh;
|
||||
in {
|
||||
options = {
|
||||
programs.bash.blesh.enable = mkEnableOption (mdDoc "blesh");
|
||||
programs.bash.blesh.enable = mkEnableOption (mdDoc "blesh, a full-featured line editor written in pure Bash");
|
||||
};
|
||||
|
||||
config = mkIf cfg.enable {
|
||||
|
@ -1,6 +1,6 @@
|
||||
{ config, pkgs, lib, ... }:
|
||||
{
|
||||
options.programs.bcc.enable = lib.mkEnableOption (lib.mdDoc "bcc");
|
||||
options.programs.bcc.enable = lib.mkEnableOption (lib.mdDoc "bcc, tools for BPF-based Linux IO analysis, networking, monitoring, and more");
|
||||
|
||||
config = lib.mkIf config.programs.bcc.enable {
|
||||
environment.systemPackages = [ pkgs.bcc ];
|
||||
|
@ -49,7 +49,7 @@ in
|
||||
|
||||
options = {
|
||||
programs.captive-browser = {
|
||||
enable = mkEnableOption (lib.mdDoc "captive browser");
|
||||
enable = mkEnableOption (lib.mdDoc "captive browser, a dedicated Chrome instance to log into captive portals without messing with DNS settings");
|
||||
|
||||
package = mkPackageOption pkgs "captive-browser" { };
|
||||
|
||||
|
@ -5,7 +5,7 @@ let
|
||||
in {
|
||||
options.programs.ccache = {
|
||||
# host configuration
|
||||
enable = lib.mkEnableOption (lib.mdDoc "CCache");
|
||||
enable = lib.mkEnableOption (lib.mdDoc "CCache, a compiler cache for fast recompilation of C/C++ code");
|
||||
cacheDir = lib.mkOption {
|
||||
type = lib.types.path;
|
||||
description = lib.mdDoc "CCache directory";
|
||||
|
@ -40,7 +40,7 @@ let
|
||||
|
||||
in {
|
||||
options.programs.firejail = {
|
||||
enable = mkEnableOption (lib.mdDoc "firejail");
|
||||
enable = mkEnableOption (lib.mdDoc "firejail, a sandboxing tool for Linux");
|
||||
|
||||
wrappedBinaries = mkOption {
|
||||
type = types.attrsOf (types.either types.path (types.submodule {
|
||||
|
@ -21,7 +21,7 @@ with lib; let
|
||||
in
|
||||
{
|
||||
options.programs.gamescope = {
|
||||
enable = mkEnableOption (mdDoc "gamescope");
|
||||
enable = mkEnableOption (mdDoc "gamescope, the SteamOS session compositing window manager");
|
||||
|
||||
package = mkPackageOption pkgs "gamescope" { };
|
||||
|
||||
|
@ -11,7 +11,7 @@ in {
|
||||
};
|
||||
|
||||
options = {
|
||||
programs.geary.enable = mkEnableOption (lib.mdDoc "Geary, a Mail client for GNOME 3");
|
||||
programs.geary.enable = mkEnableOption (lib.mdDoc "Geary, a Mail client for GNOME");
|
||||
};
|
||||
|
||||
config = mkIf cfg.enable {
|
||||
|
@ -9,7 +9,7 @@ in
|
||||
{
|
||||
options = {
|
||||
programs.git = {
|
||||
enable = mkEnableOption (lib.mdDoc "git");
|
||||
enable = mkEnableOption (lib.mdDoc "git, a distributed version control system");
|
||||
|
||||
package = mkPackageOption pkgs "git" {
|
||||
example = "gitFull";
|
||||
@ -59,7 +59,7 @@ in
|
||||
};
|
||||
|
||||
lfs = {
|
||||
enable = mkEnableOption (lib.mdDoc "git-lfs");
|
||||
enable = mkEnableOption (lib.mdDoc "git-lfs (Large File Storage)");
|
||||
|
||||
package = mkPackageOption pkgs "git-lfs" { };
|
||||
};
|
||||
|
@ -5,7 +5,7 @@ let
|
||||
inherit (lib) mkEnableOption mkIf mkOption mkPackageOption optionalString types;
|
||||
in {
|
||||
options.programs.iay = {
|
||||
enable = mkEnableOption (lib.mdDoc "iay");
|
||||
enable = mkEnableOption (lib.mdDoc "iay, a minimalistic shell prompt");
|
||||
package = mkPackageOption pkgs "iay" {};
|
||||
|
||||
minimalPrompt = mkOption {
|
||||
|
@ -35,7 +35,7 @@ in
|
||||
|
||||
# note that environment.nix sets PAGER=less, and
|
||||
# therefore also enables this module
|
||||
enable = mkEnableOption (lib.mdDoc "less");
|
||||
enable = mkEnableOption (lib.mdDoc "less, a file pager");
|
||||
|
||||
configFile = mkOption {
|
||||
type = types.nullOr types.path;
|
||||
|
@ -5,7 +5,7 @@ let
|
||||
in
|
||||
{
|
||||
options.programs.mepo = {
|
||||
enable = mkEnableOption (mdDoc "Mepo");
|
||||
enable = mkEnableOption (mdDoc "Mepo, a fast, simple and hackable OSM map viewer");
|
||||
|
||||
locationBackends = {
|
||||
gpsd = mkOption {
|
||||
|
@ -8,7 +8,7 @@ let
|
||||
cfg = config.programs.mininet;
|
||||
in
|
||||
{
|
||||
options.programs.mininet.enable = mkEnableOption (lib.mdDoc "Mininet");
|
||||
options.programs.mininet.enable = mkEnableOption (lib.mdDoc "Mininet, an emulator for rapid prototyping of Software Defined Networks");
|
||||
|
||||
config = mkIf cfg.enable {
|
||||
|
||||
|
@ -8,7 +8,7 @@ in
|
||||
programs.minipro = {
|
||||
enable = lib.mkEnableOption (lib.mdDoc "minipro") // {
|
||||
description = lib.mdDoc ''
|
||||
Installs minipro and its udev rules.
|
||||
Whether to enable minipro and its udev rules.
|
||||
Users of the `plugdev` group can interact with connected MiniPRO chip programmers.
|
||||
'';
|
||||
};
|
||||
|
@ -7,7 +7,7 @@ in
|
||||
{
|
||||
options = {
|
||||
programs.nano = {
|
||||
enable = lib.mkEnableOption (lib.mdDoc "nano") // {
|
||||
enable = lib.mkEnableOption (lib.mdDoc "nano, a small user-friendly console text editor") // {
|
||||
default = true;
|
||||
};
|
||||
|
||||
|
@ -6,7 +6,7 @@
|
||||
};
|
||||
|
||||
options.programs.nm-applet = {
|
||||
enable = lib.mkEnableOption (lib.mdDoc "nm-applet");
|
||||
enable = lib.mkEnableOption (lib.mdDoc "nm-applet, a NetworkManager control applet for GNOME");
|
||||
|
||||
indicator = lib.mkOption {
|
||||
type = lib.types.bool;
|
||||
|
@ -6,7 +6,7 @@ let cfg = config.programs.noisetorch;
|
||||
in
|
||||
{
|
||||
options.programs.noisetorch = {
|
||||
enable = mkEnableOption (lib.mdDoc "noisetorch + setcap wrapper");
|
||||
enable = mkEnableOption (lib.mdDoc "noisetorch (+ setcap wrapper), a virtual microphone device with noise suppression");
|
||||
|
||||
package = mkPackageOption pkgs "noisetorch" { };
|
||||
};
|
||||
|
@ -6,7 +6,7 @@ in
|
||||
{
|
||||
options = {
|
||||
programs.oddjobd = {
|
||||
enable = lib.mkEnableOption "oddjob";
|
||||
enable = lib.mkEnableOption "oddjob, a D-Bus service which runs odd jobs on behalf of client applications";
|
||||
package = lib.mkPackageOption pkgs "oddjob" {};
|
||||
};
|
||||
};
|
||||
|
@ -5,7 +5,7 @@ let
|
||||
in
|
||||
{
|
||||
options.programs.projecteur = {
|
||||
enable = lib.mkEnableOption (lib.mdDoc "projecteur");
|
||||
enable = lib.mkEnableOption (lib.mdDoc "projecteur, an application for the Logitech Spotlight device (and similar)");
|
||||
package = lib.mkPackageOption pkgs "projecteur" { };
|
||||
};
|
||||
|
||||
|
@ -49,7 +49,7 @@ in {
|
||||
|
||||
programs.proxychains = {
|
||||
|
||||
enable = mkEnableOption (lib.mdDoc "installing proxychains configuration");
|
||||
enable = mkEnableOption (lib.mdDoc "proxychains configuration");
|
||||
|
||||
package = mkPackageOption pkgs "proxychains" {
|
||||
example = "proxychains-ng";
|
||||
|
@ -24,7 +24,7 @@ let
|
||||
'';
|
||||
in {
|
||||
options.programs.rust-motd = {
|
||||
enable = mkEnableOption (lib.mdDoc "rust-motd");
|
||||
enable = mkEnableOption (lib.mdDoc "rust-motd, a Message Of The Day (MOTD) generator");
|
||||
enableMotdInSSHD = mkOption {
|
||||
default = true;
|
||||
type = types.bool;
|
||||
|
@ -6,7 +6,7 @@ let
|
||||
cfg = config.programs.sedutil;
|
||||
|
||||
in {
|
||||
options.programs.sedutil.enable = mkEnableOption (lib.mdDoc "sedutil");
|
||||
options.programs.sedutil.enable = mkEnableOption (lib.mdDoc "sedutil, to manage self encrypting drives that conform to the Trusted Computing Group OPAL 2.0 SSC specification");
|
||||
|
||||
config = mkIf cfg.enable {
|
||||
boot.kernelParams = [
|
||||
|
@ -7,7 +7,7 @@ in
|
||||
{
|
||||
options = {
|
||||
programs.sniffnet = {
|
||||
enable = lib.mkEnableOption (lib.mdDoc "sniffnet");
|
||||
enable = lib.mkEnableOption (lib.mdDoc "sniffnet, a network traffic monitor application");
|
||||
};
|
||||
};
|
||||
|
||||
|
@ -5,7 +5,7 @@ with lib;
|
||||
let
|
||||
cfg = config.programs.sysdig;
|
||||
in {
|
||||
options.programs.sysdig.enable = mkEnableOption (lib.mdDoc "sysdig");
|
||||
options.programs.sysdig.enable = mkEnableOption (lib.mdDoc "sysdig, a tracing tool");
|
||||
|
||||
config = mkIf cfg.enable {
|
||||
environment.systemPackages = [ pkgs.sysdig ];
|
||||
|
@ -16,7 +16,7 @@ in
|
||||
{
|
||||
options = {
|
||||
programs.thefuck = {
|
||||
enable = mkEnableOption (lib.mdDoc "thefuck");
|
||||
enable = mkEnableOption (lib.mdDoc "thefuck, an app which corrects your previous console command");
|
||||
|
||||
alias = mkOption {
|
||||
default = "fuck";
|
||||
|
@ -7,7 +7,7 @@ in
|
||||
{
|
||||
options = {
|
||||
programs.trippy = {
|
||||
enable = lib.mkEnableOption (lib.mdDoc "trippy");
|
||||
enable = lib.mkEnableOption (lib.mdDoc "trippy, a network diagnostic tool");
|
||||
};
|
||||
};
|
||||
|
||||
|
@ -6,7 +6,7 @@ let
|
||||
cfg = config.programs.udevil;
|
||||
|
||||
in {
|
||||
options.programs.udevil.enable = mkEnableOption (lib.mdDoc "udevil");
|
||||
options.programs.udevil.enable = mkEnableOption (lib.mdDoc "udevil, to mount filesystems without password");
|
||||
|
||||
config = mkIf cfg.enable {
|
||||
security.wrappers.udevil =
|
||||
|
@ -6,7 +6,7 @@ let
|
||||
cfg = config.programs.usbtop;
|
||||
in {
|
||||
options = {
|
||||
programs.usbtop.enable = mkEnableOption (lib.mdDoc "usbtop and required kernel module");
|
||||
programs.usbtop.enable = mkEnableOption (lib.mdDoc "usbtop and required kernel module, to show estimated USB bandwidth");
|
||||
};
|
||||
|
||||
config = mkIf cfg.enable {
|
||||
|
@ -14,7 +14,7 @@ in
|
||||
options.programs.hyprland = {
|
||||
enable = mkEnableOption null // {
|
||||
description = ''
|
||||
Hyprland, the dynamic tiling Wayland compositor that doesn't sacrifice on its looks.
|
||||
Whether to enable Hyprland, the dynamic tiling Wayland compositor that doesn't sacrifice on its looks.
|
||||
|
||||
You can manually launch Hyprland by executing {command}`Hyprland` on a TTY.
|
||||
|
||||
|
@ -7,7 +7,7 @@ let
|
||||
in
|
||||
{
|
||||
options.programs.waybar = {
|
||||
enable = mkEnableOption (lib.mdDoc "waybar");
|
||||
enable = mkEnableOption (lib.mdDoc "waybar, a highly customizable Wayland bar for Sway and Wlroots based compositors");
|
||||
package = mkPackageOption pkgs "waybar" { };
|
||||
};
|
||||
|
||||
|
@ -7,7 +7,7 @@ let
|
||||
in
|
||||
{
|
||||
options.programs.weylus = with types; {
|
||||
enable = mkEnableOption (lib.mdDoc "weylus");
|
||||
enable = mkEnableOption (lib.mdDoc "weylus, which turns your smart phone into a graphic tablet/touch screen for your computer");
|
||||
|
||||
openFirewall = mkOption {
|
||||
type = bool;
|
||||
|
@ -41,7 +41,7 @@ let
|
||||
in
|
||||
{
|
||||
options.programs.yabar = {
|
||||
enable = mkEnableOption (lib.mdDoc "yabar");
|
||||
enable = mkEnableOption (lib.mdDoc "yabar, a status bar for X window managers");
|
||||
|
||||
package = mkOption {
|
||||
default = pkgs.yabar-unstable;
|
||||
|
@ -6,7 +6,7 @@ let
|
||||
cfg = config.programs.zmap;
|
||||
in {
|
||||
options.programs.zmap = {
|
||||
enable = mkEnableOption (lib.mdDoc "ZMap");
|
||||
enable = mkEnableOption (lib.mdDoc "ZMap, a network scanner designed for Internet-wide network surveys");
|
||||
};
|
||||
|
||||
config = mkIf cfg.enable {
|
||||
|
@ -19,7 +19,7 @@ in
|
||||
{
|
||||
|
||||
options = {
|
||||
security.pki.installCACerts = mkEnableOption "Add CA certificates to system" // {
|
||||
security.pki.installCACerts = mkEnableOption "installing CA certificates to the system" // {
|
||||
default = true;
|
||||
internal = true;
|
||||
};
|
||||
|
@ -1430,12 +1430,12 @@ in
|
||||
|
||||
security.pam.enableEcryptfs = mkEnableOption (lib.mdDoc "eCryptfs PAM module (mounting ecryptfs home directory on login)");
|
||||
security.pam.enableFscrypt = mkEnableOption (lib.mdDoc ''
|
||||
fscrypt to automatically unlock directories with the user's login password.
|
||||
fscrypt, to automatically unlock directories with the user's login password.
|
||||
|
||||
This also enables a service at security.pam.services.fscrypt which is used by
|
||||
fscrypt to verify the user's password when setting up a new protector. If you
|
||||
use something other than pam_unix to verify user passwords, please remember to
|
||||
adjust this PAM service.
|
||||
adjust this PAM service
|
||||
'');
|
||||
|
||||
users.motd = mkOption {
|
||||
|
@ -20,7 +20,7 @@ in
|
||||
{
|
||||
options = {
|
||||
services.salt.master = {
|
||||
enable = mkEnableOption (lib.mdDoc "Salt master service");
|
||||
enable = mkEnableOption (lib.mdDoc "Salt configuration management system master service");
|
||||
configuration = mkOption {
|
||||
type = types.attrs;
|
||||
default = {};
|
||||
|
@ -21,7 +21,7 @@ in
|
||||
{
|
||||
options = {
|
||||
services.salt.minion = {
|
||||
enable = mkEnableOption (lib.mdDoc "Salt minion service");
|
||||
enable = mkEnableOption (lib.mdDoc "Salt configuration management system minion service");
|
||||
configuration = mkOption {
|
||||
type = types.attrs;
|
||||
default = {};
|
||||
|
@ -77,7 +77,7 @@ in {
|
||||
|
||||
options.services.mpdscribble = {
|
||||
|
||||
enable = mkEnableOption (lib.mdDoc "mpdscribble");
|
||||
enable = mkEnableOption (lib.mdDoc "mpdscribble, an MPD client which submits info about tracks being played to Last.fm (formerly AudioScrobbler)");
|
||||
|
||||
proxy = mkOption {
|
||||
default = null;
|
||||
|
@ -43,7 +43,7 @@ in {
|
||||
|
||||
enable = mkEnableOption (lib.mdDoc ''
|
||||
HBase master in standalone mode with embedded regionserver and zookeper.
|
||||
Do not use this configuration for production nor for evaluating HBase performance.
|
||||
Do not use this configuration for production nor for evaluating HBase performance
|
||||
'');
|
||||
|
||||
package = mkPackageOption pkgs "hbase" { };
|
||||
|
@ -6,7 +6,7 @@ let
|
||||
in
|
||||
{
|
||||
options.services.lldap = with lib; {
|
||||
enable = mkEnableOption (mdDoc "lldap");
|
||||
enable = mkEnableOption (mdDoc "lldap, a lightweight authentication server that provides an opinionated, simplified LDAP interface for authentication");
|
||||
|
||||
package = mkPackageOption pkgs "lldap" { };
|
||||
|
||||
|
@ -2,7 +2,7 @@
|
||||
let cfg = config.services.victoriametrics; in
|
||||
{
|
||||
options.services.victoriametrics = with lib; {
|
||||
enable = mkEnableOption (lib.mdDoc "victoriametrics");
|
||||
enable = mkEnableOption (lib.mdDoc "VictoriaMetrics, a time series database, long-term remote storage for Prometheus");
|
||||
package = mkPackageOption pkgs "victoriametrics" { };
|
||||
listenAddress = mkOption {
|
||||
default = ":8428";
|
||||
|
@ -9,7 +9,7 @@ in {
|
||||
###### interface
|
||||
options = {
|
||||
services.blueman = {
|
||||
enable = mkEnableOption (lib.mdDoc "blueman");
|
||||
enable = mkEnableOption (lib.mdDoc "blueman, a bluetooth manager");
|
||||
};
|
||||
};
|
||||
|
||||
|
@ -15,7 +15,7 @@ with lib;
|
||||
services.deepin.dde-api = {
|
||||
|
||||
enable = mkEnableOption (lib.mdDoc ''
|
||||
some dbus interfaces that is used for screen zone detecting,
|
||||
the DDE API, which provides some dbus interfaces that is used for screen zone detecting,
|
||||
thumbnail generating, and sound playing in Deepin Desktop Environment
|
||||
'');
|
||||
|
||||
|
@ -7,7 +7,7 @@ with lib;
|
||||
###### interface
|
||||
options = {
|
||||
services.neard = {
|
||||
enable = mkEnableOption (lib.mdDoc "neard, NFC daemon");
|
||||
enable = mkEnableOption (lib.mdDoc "neard, an NFC daemon");
|
||||
};
|
||||
};
|
||||
|
||||
|
@ -14,7 +14,7 @@ with lib;
|
||||
|
||||
options = {
|
||||
services.zeitgeist = {
|
||||
enable = mkEnableOption (lib.mdDoc "zeitgeist");
|
||||
enable = mkEnableOption (lib.mdDoc "zeitgeist, a service which logs the users' activities and events");
|
||||
};
|
||||
};
|
||||
|
||||
|
@ -8,7 +8,7 @@ in
|
||||
{
|
||||
options = {
|
||||
services.distccd = {
|
||||
enable = mkEnableOption (lib.mdDoc "distccd");
|
||||
enable = mkEnableOption (lib.mdDoc "distccd, a distributed C/C++ compiler");
|
||||
|
||||
allowedClients = mkOption {
|
||||
type = types.listOf types.str;
|
||||
|
@ -24,7 +24,7 @@ let
|
||||
in
|
||||
{
|
||||
options.services.gemstash = {
|
||||
enable = mkEnableOption (lib.mdDoc "gemstash service");
|
||||
enable = mkEnableOption (lib.mdDoc "gemstash, a cache for rubygems.org and a private gem server");
|
||||
|
||||
openFirewall = mkOption {
|
||||
type = types.bool;
|
||||
|
@ -8,7 +8,7 @@ let
|
||||
in
|
||||
{
|
||||
options.services.greetd = {
|
||||
enable = mkEnableOption (lib.mdDoc "greetd");
|
||||
enable = mkEnableOption (lib.mdDoc "greetd, a minimal and flexible login manager daemon");
|
||||
|
||||
package = mkPackageOption pkgs [ "greetd" "greetd" ] { };
|
||||
|
||||
|
@ -9,7 +9,7 @@ in
|
||||
{
|
||||
options = {
|
||||
services.odoo = {
|
||||
enable = mkEnableOption (lib.mdDoc "odoo");
|
||||
enable = mkEnableOption (lib.mdDoc "odoo, an open source ERP and CRM system");
|
||||
|
||||
package = mkPackageOption pkgs "odoo" { };
|
||||
|
||||
|
@ -22,7 +22,7 @@ in
|
||||
{
|
||||
options = {
|
||||
services.mchprs = {
|
||||
enable = mkEnableOption "MCHPRS";
|
||||
enable = mkEnableOption "MCHPRS, a Minecraft server";
|
||||
|
||||
declarativeSettings = mkOption {
|
||||
type = types.bool;
|
||||
|
@ -7,7 +7,7 @@ in
|
||||
{
|
||||
options = {
|
||||
services.openarena = {
|
||||
enable = mkEnableOption (lib.mdDoc "OpenArena");
|
||||
enable = mkEnableOption (lib.mdDoc "OpenArena game server");
|
||||
package = lib.mkPackageOption pkgs "openarena" { };
|
||||
|
||||
openPorts = mkOption {
|
||||
|
@ -151,7 +151,7 @@ let
|
||||
in
|
||||
{
|
||||
options.services.kanata = {
|
||||
enable = mkEnableOption (mdDoc "kanata");
|
||||
enable = mkEnableOption (mdDoc "kanata, a tool to improve keyboard comfort and usability with advanced customization");
|
||||
package = mkPackageOption pkgs "kanata" {
|
||||
example = "kanata-with-cmd";
|
||||
extraDescription = ''
|
||||
|
@ -11,7 +11,7 @@ in {
|
||||
options = {
|
||||
services.lirc = {
|
||||
|
||||
enable = mkEnableOption (lib.mdDoc "LIRC daemon");
|
||||
enable = mkEnableOption (lib.mdDoc "the LIRC daemon, to receive and send infrared signals");
|
||||
|
||||
options = mkOption {
|
||||
type = types.lines;
|
||||
|
@ -6,7 +6,7 @@ let
|
||||
cfg = config.services.hardware.openrgb;
|
||||
in {
|
||||
options.services.hardware.openrgb = {
|
||||
enable = mkEnableOption (lib.mdDoc "OpenRGB server");
|
||||
enable = mkEnableOption (lib.mdDoc "OpenRGB server, for RGB lighting control");
|
||||
|
||||
package = mkPackageOption pkgs "openrgb" { };
|
||||
|
||||
|
@ -18,7 +18,7 @@ let
|
||||
in
|
||||
{
|
||||
options.services.pcscd = {
|
||||
enable = mkEnableOption (lib.mdDoc "PCSC-Lite daemon");
|
||||
enable = mkEnableOption (lib.mdDoc "PCSC-Lite daemon, to access smart cards using SCard API (PC/SC)");
|
||||
|
||||
plugins = mkOption {
|
||||
type = types.listOf types.package;
|
||||
|
@ -200,7 +200,7 @@ in
|
||||
};
|
||||
|
||||
services.udev = {
|
||||
enable = mkEnableOption (lib.mdDoc "udev") // {
|
||||
enable = mkEnableOption (lib.mdDoc "udev, a device manager for the Linux kernel") // {
|
||||
default = true;
|
||||
};
|
||||
|
||||
|
@ -37,7 +37,7 @@ in
|
||||
enable = mkEnableOption (lib.mdDoc ''
|
||||
Undervolting service for Intel CPUs.
|
||||
|
||||
Warning: This service is not endorsed by Intel and may permanently damage your hardware. Use at your own risk!
|
||||
Warning: This service is not endorsed by Intel and may permanently damage your hardware. Use at your own risk
|
||||
'');
|
||||
|
||||
verbose = mkOption {
|
||||
|
@ -9,7 +9,7 @@ in
|
||||
options = {
|
||||
|
||||
services.vdr = {
|
||||
enable = mkEnableOption (mdDoc "Start VDR");
|
||||
enable = mkEnableOption (mdDoc "VDR, a video disk recorder");
|
||||
|
||||
package = mkPackageOption pkgs "vdr" {
|
||||
example = "wrapVdr.override { plugins = with pkgs.vdrPlugins; [ hello ]; }";
|
||||
|
@ -44,7 +44,7 @@ in
|
||||
meta.maintainers = with maintainers; [ nathan-gs ];
|
||||
|
||||
options.services.ebusd = {
|
||||
enable = mkEnableOption (lib.mdDoc "ebusd service");
|
||||
enable = mkEnableOption (lib.mdDoc "ebusd, a daemon for communication with eBUS heating systems");
|
||||
|
||||
device = mkOption {
|
||||
type = types.str;
|
||||
|
@ -24,7 +24,7 @@ in
|
||||
meta.maintainers = with maintainers; [ oddlama ];
|
||||
|
||||
options.services.esphome = {
|
||||
enable = mkEnableOption (mdDoc "esphome");
|
||||
enable = mkEnableOption (mdDoc "esphome, for making custom firmwares for ESP32/ESP8266");
|
||||
|
||||
package = lib.mkPackageOption pkgs "esphome" { };
|
||||
|
||||
|
@ -95,7 +95,7 @@ in
|
||||
];
|
||||
|
||||
options.services.awstats = {
|
||||
enable = mkEnableOption (lib.mdDoc "awstats");
|
||||
enable = mkEnableOption (lib.mdDoc "awstats, a real-time logfile analyzer");
|
||||
|
||||
dataDir = mkOption {
|
||||
type = types.path;
|
||||
|
@ -12,7 +12,7 @@ in {
|
||||
options = {
|
||||
|
||||
services.fluentd = {
|
||||
enable = mkEnableOption (lib.mdDoc "fluentd");
|
||||
enable = mkEnableOption (lib.mdDoc "fluentd, a data/log collector");
|
||||
|
||||
config = mkOption {
|
||||
type = types.lines;
|
||||
|
@ -33,7 +33,7 @@ in
|
||||
|
||||
services.graylog = {
|
||||
|
||||
enable = mkEnableOption (lib.mdDoc "Graylog");
|
||||
enable = mkEnableOption (lib.mdDoc "Graylog, a log management solution");
|
||||
|
||||
package = mkOption {
|
||||
type = types.package;
|
||||
|
@ -18,7 +18,7 @@ in
|
||||
|
||||
services.heartbeat = {
|
||||
|
||||
enable = mkEnableOption (lib.mdDoc "heartbeat");
|
||||
enable = mkEnableOption (lib.mdDoc "heartbeat, uptime monitoring");
|
||||
|
||||
package = mkPackageOption pkgs "heartbeat" {
|
||||
example = "heartbeat7";
|
||||
|
@ -109,7 +109,7 @@ in
|
||||
{
|
||||
options = {
|
||||
services.logcheck = {
|
||||
enable = mkEnableOption (lib.mdDoc "logcheck cron job");
|
||||
enable = mkEnableOption (lib.mdDoc "logcheck cron job, to mail anomalies in the system logfiles to the administrator");
|
||||
|
||||
user = mkOption {
|
||||
default = "logcheck";
|
||||
|
@ -8,7 +8,7 @@ let
|
||||
in {
|
||||
options = {
|
||||
services.ulogd = {
|
||||
enable = mkEnableOption (lib.mdDoc "ulogd");
|
||||
enable = mkEnableOption (lib.mdDoc "ulogd, a userspace logging daemon for netfilter/iptables related logging");
|
||||
|
||||
settings = mkOption {
|
||||
example = {
|
||||
|
@ -6,7 +6,7 @@ let cfg = config.services.vector;
|
||||
in
|
||||
{
|
||||
options.services.vector = {
|
||||
enable = mkEnableOption (lib.mdDoc "Vector");
|
||||
enable = mkEnableOption (lib.mdDoc "Vector, a high-performance observability data pipeline");
|
||||
|
||||
package = mkPackageOption pkgs "vector" { };
|
||||
|
||||
|
@ -8,7 +8,7 @@ let
|
||||
in
|
||||
{
|
||||
options.services.goeland = {
|
||||
enable = mkEnableOption (mdDoc "goeland");
|
||||
enable = mkEnableOption (mdDoc "goeland, an alternative to rss2email");
|
||||
|
||||
settings = mkOption {
|
||||
description = mdDoc ''
|
||||
|
@ -11,7 +11,7 @@ in
|
||||
options = {
|
||||
|
||||
services.mailcatcher = {
|
||||
enable = mkEnableOption (lib.mdDoc "MailCatcher");
|
||||
enable = mkEnableOption (lib.mdDoc "MailCatcher, an SMTP server and web interface to locally test outbound emails");
|
||||
|
||||
http.ip = mkOption {
|
||||
type = types.str;
|
||||
|
@ -27,7 +27,7 @@ in
|
||||
options = {
|
||||
|
||||
services.mailhog = {
|
||||
enable = mkEnableOption (lib.mdDoc "MailHog");
|
||||
enable = mkEnableOption (lib.mdDoc "MailHog, web and API based SMTP testing");
|
||||
|
||||
storage = mkOption {
|
||||
type = types.enum [ "maildir" "memory" ];
|
||||
|
@ -367,7 +367,7 @@ in {
|
||||
});
|
||||
in {
|
||||
services.matrix-synapse = {
|
||||
enable = mkEnableOption (lib.mdDoc "matrix.org synapse");
|
||||
enable = mkEnableOption (lib.mdDoc "matrix.org synapse, the reference homeserver");
|
||||
|
||||
enableRegistrationScript = mkOption {
|
||||
type = types.bool;
|
||||
|
@ -22,7 +22,7 @@ let
|
||||
in
|
||||
{
|
||||
options.services.ankisyncd = {
|
||||
enable = mkEnableOption (lib.mdDoc "ankisyncd");
|
||||
enable = mkEnableOption (lib.mdDoc "ankisyncd, a standalone unofficial anky sync server");
|
||||
|
||||
package = mkPackageOption pkgs "ankisyncd" { };
|
||||
|
||||
|
@ -13,7 +13,7 @@ let
|
||||
in
|
||||
{
|
||||
options.services.bepasty = {
|
||||
enable = mkEnableOption (lib.mdDoc "Bepasty servers");
|
||||
enable = mkEnableOption (lib.mdDoc "bepasty, a binary pastebin server");
|
||||
|
||||
servers = mkOption {
|
||||
default = {};
|
||||
|
@ -32,7 +32,7 @@ in
|
||||
options = {
|
||||
services.calibre-server = {
|
||||
|
||||
enable = mkEnableOption (lib.mdDoc "calibre-server");
|
||||
enable = mkEnableOption (lib.mdDoc "calibre-server (e-book software)");
|
||||
package = lib.mkPackageOption pkgs "calibre" { };
|
||||
|
||||
libraries = mkOption {
|
||||
|
@ -17,7 +17,7 @@ let
|
||||
|
||||
in {
|
||||
options.services.confd = {
|
||||
enable = mkEnableOption (lib.mdDoc "confd service");
|
||||
enable = mkEnableOption (lib.mdDoc "confd, a service to manage local application configuration files using templates and data from etcd/consul/redis/zookeeper");
|
||||
|
||||
backend = mkOption {
|
||||
description = lib.mdDoc "Confd config storage backend to use.";
|
||||
|
@ -7,7 +7,7 @@ let
|
||||
in
|
||||
{
|
||||
options.services.etesync-dav = {
|
||||
enable = mkEnableOption (lib.mdDoc "etesync-dav");
|
||||
enable = mkEnableOption (lib.mdDoc "etesync-dav, end-to-end encrypted sync for contacts, calendars and tasks");
|
||||
|
||||
host = mkOption {
|
||||
type = types.str;
|
||||
|
@ -8,7 +8,7 @@ let
|
||||
in
|
||||
{
|
||||
options.services.evdevremapkeys = {
|
||||
enable = mkEnableOption (lib.mdDoc ''evdevremapkeys'');
|
||||
enable = mkEnableOption (lib.mdDoc ''evdevremapkeys, a daemon to remap events on linux input devices'');
|
||||
|
||||
settings = mkOption {
|
||||
type = format.type;
|
||||
|
@ -55,7 +55,7 @@ in
|
||||
|
||||
options = {
|
||||
services.forgejo = {
|
||||
enable = mkEnableOption (mdDoc "Forgejo");
|
||||
enable = mkEnableOption (mdDoc "Forgejo, a software forge");
|
||||
|
||||
package = mkPackageOption pkgs "forgejo" { };
|
||||
|
||||
|
@ -12,7 +12,7 @@ in
|
||||
options = {
|
||||
services.geoipupdate = {
|
||||
enable = lib.mkEnableOption (lib.mdDoc ''
|
||||
periodic downloading of GeoIP databases using geoipupdate.
|
||||
periodic downloading of GeoIP databases using geoipupdate
|
||||
'');
|
||||
|
||||
interval = lib.mkOption {
|
||||
|
@ -8,7 +8,7 @@ in
|
||||
|
||||
{
|
||||
options.services.gollum = {
|
||||
enable = mkEnableOption (lib.mdDoc "Gollum service");
|
||||
enable = mkEnableOption (lib.mdDoc "Gollum, a git-powered wiki service");
|
||||
|
||||
address = mkOption {
|
||||
type = types.str;
|
||||
|
@ -7,7 +7,7 @@ let
|
||||
in {
|
||||
|
||||
options.services.greenclip = {
|
||||
enable = mkEnableOption (lib.mdDoc "Greenclip daemon");
|
||||
enable = mkEnableOption (lib.mdDoc "Greenclip, a clipboard manager");
|
||||
|
||||
package = mkPackageOption pkgs [ "haskellPackages" "greenclip" ] { };
|
||||
};
|
||||
|
@ -12,7 +12,7 @@ in
|
||||
{
|
||||
options = {
|
||||
services.homepage-dashboard = {
|
||||
enable = lib.mkEnableOption (lib.mdDoc "Homepage Dashboard");
|
||||
enable = lib.mkEnableOption (lib.mdDoc "Homepage Dashboard, a highly customizable application dashboard");
|
||||
|
||||
package = lib.mkPackageOption pkgs "homepage-dashboard" { };
|
||||
|
||||
|
@ -9,7 +9,7 @@ in
|
||||
{
|
||||
options = {
|
||||
services.jackett = {
|
||||
enable = mkEnableOption (lib.mdDoc "Jackett");
|
||||
enable = mkEnableOption (lib.mdDoc "Jackett, API support for your favorite torrent trackers");
|
||||
|
||||
dataDir = mkOption {
|
||||
type = types.str;
|
||||
|
@ -7,7 +7,7 @@ let
|
||||
settingsFormat = pkgs.formats.javaProperties {};
|
||||
in {
|
||||
options.services.languagetool = {
|
||||
enable = mkEnableOption (mdDoc "the LanguageTool server");
|
||||
enable = mkEnableOption (mdDoc "the LanguageTool server, a multilingual spelling, style, and grammar checker that helps correct or paraphrase texts");
|
||||
|
||||
port = mkOption {
|
||||
type = types.port;
|
||||
|
@ -9,7 +9,7 @@ in
|
||||
{
|
||||
options = {
|
||||
services.leaps = {
|
||||
enable = mkEnableOption (lib.mdDoc "leaps");
|
||||
enable = mkEnableOption (lib.mdDoc "leaps, a pair programming service");
|
||||
port = mkOption {
|
||||
type = types.port;
|
||||
default = 8080;
|
||||
|
@ -8,7 +8,7 @@ in
|
||||
{
|
||||
options = {
|
||||
services.lidarr = {
|
||||
enable = mkEnableOption (lib.mdDoc "Lidarr");
|
||||
enable = mkEnableOption (lib.mdDoc "Lidarr, a Usenet/BitTorrent music downloader");
|
||||
|
||||
dataDir = mkOption {
|
||||
type = types.str;
|
||||
|
@ -25,7 +25,7 @@ in
|
||||
|
||||
options = {
|
||||
services.lifecycled = {
|
||||
enable = mkEnableOption (lib.mdDoc "lifecycled");
|
||||
enable = mkEnableOption (lib.mdDoc "lifecycled, a daemon for responding to AWS AutoScaling Lifecycle Hooks");
|
||||
|
||||
queueCleaner = {
|
||||
enable = mkEnableOption (lib.mdDoc "lifecycled-queue-cleaner");
|
||||
|
@ -6,7 +6,7 @@ let
|
||||
cfg = config.services.logkeys;
|
||||
in {
|
||||
options.services.logkeys = {
|
||||
enable = mkEnableOption (lib.mdDoc "logkeys service");
|
||||
enable = mkEnableOption (lib.mdDoc "logkeys, a keylogger service");
|
||||
|
||||
device = mkOption {
|
||||
description = lib.mdDoc "Use the given device as keyboard input event device instead of /dev/input/eventX default.";
|
||||
|
@ -52,7 +52,7 @@ in
|
||||
|
||||
options = {
|
||||
services.nitter = {
|
||||
enable = mkEnableOption (lib.mdDoc "Nitter");
|
||||
enable = mkEnableOption (lib.mdDoc "Nitter, an alternative Twitter front-end");
|
||||
|
||||
package = mkPackageOption pkgs "nitter" { };
|
||||
|
||||
|
@ -25,7 +25,7 @@ in
|
||||
|
||||
options = {
|
||||
services.nzbget = {
|
||||
enable = mkEnableOption (lib.mdDoc "NZBGet");
|
||||
enable = mkEnableOption (lib.mdDoc "NZBGet, for downloading files from news servers");
|
||||
|
||||
user = mkOption {
|
||||
type = types.str;
|
||||
|
@ -7,7 +7,7 @@ let cfg = config.services.nzbhydra2;
|
||||
in {
|
||||
options = {
|
||||
services.nzbhydra2 = {
|
||||
enable = mkEnableOption (lib.mdDoc "NZBHydra2");
|
||||
enable = mkEnableOption (lib.mdDoc "NZBHydra2, Usenet meta search");
|
||||
|
||||
dataDir = mkOption {
|
||||
type = types.str;
|
||||
|
@ -8,7 +8,9 @@ in {
|
||||
options = {
|
||||
services.ombi = {
|
||||
enable = mkEnableOption (lib.mdDoc ''
|
||||
Ombi.
|
||||
Ombi, a web application that automatically gives your shared Plex or
|
||||
Emby users the ability to request content by themselves!
|
||||
|
||||
Optionally see <https://docs.ombi.app/info/reverse-proxy>
|
||||
on how to set up a reverse proxy
|
||||
'');
|
||||
|
@ -5,7 +5,7 @@ in {
|
||||
|
||||
options.services.owncast = {
|
||||
|
||||
enable = mkEnableOption (lib.mdDoc "owncast");
|
||||
enable = mkEnableOption (lib.mdDoc "owncast, a video live streaming solution");
|
||||
|
||||
dataDir = mkOption {
|
||||
type = types.str;
|
||||
|
@ -10,7 +10,7 @@ let
|
||||
in
|
||||
{
|
||||
options.services.pinnwand = {
|
||||
enable = mkEnableOption (lib.mdDoc "Pinnwand");
|
||||
enable = mkEnableOption (lib.mdDoc "Pinnwand, a pastebin");
|
||||
|
||||
port = mkOption {
|
||||
type = types.port;
|
||||
|
Some files were not shown because too many files have changed in this diff Show More
Loading…
Reference in New Issue
Block a user