Merge pull request #200440 from nagy/treewide-modules

treewide: use `types.port` and `mkEnableOption` in nixos modules
This commit is contained in:
figsoda 2022-11-10 12:12:51 -05:00 committed by GitHub
commit e920aed521
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
70 changed files with 93 additions and 188 deletions

View file

@ -8,13 +8,12 @@ in
options = {
hardware.brillo = {
enable = mkEnableOption (lib.mdDoc ''
Enable brillo in userspace.
This will allow brightness control from users in the video group.
brillo in userspace.
This will allow brightness control from users in the video group
'');
};
};
config = mkIf cfg.enable {
services.udev.packages = [ pkgs.brillo ];
environment.systemPackages = [ pkgs.brillo ];

View file

@ -10,7 +10,7 @@ let
};
in {
options.hardware.ubertooth = {
enable = mkEnableOption (lib.mdDoc "Enable the Ubertooth software and its udev rules.");
enable = mkEnableOption (lib.mdDoc "Ubertooth software and its udev rules");
group = mkOption {
type = types.str;

View file

@ -3,7 +3,7 @@
with lib;
{
options.hardware.wooting.enable =
mkEnableOption (lib.mdDoc "Enable support for Wooting keyboards");
mkEnableOption (lib.mdDoc "support for Wooting keyboards");
config = mkIf config.hardware.wooting.enable {
environment.systemPackages = [ pkgs.wootility ];

View file

@ -4,7 +4,7 @@ let
cfg = config.programs.kclock;
kclockPkg = pkgs.libsForQt5.kclock;
in {
options.programs.kclock = { enable = mkEnableOption (lib.mdDoc "Enable KClock"); };
options.programs.kclock = { enable = mkEnableOption (lib.mdDoc "KClock"); };
config = mkIf cfg.enable {
services.dbus.packages = [ kclockPkg ];

View file

@ -29,7 +29,7 @@ in {
};
port = mkOption {
type = types.int;
type = types.port;
default = config.services.mpd.network.port;
defaultText = literalExpression "config.services.mpd.network.port";
description = lib.mdDoc "The port where MPD is listening.";

View file

@ -314,7 +314,7 @@ in {
port = mkOption {
default = 9102;
type = types.int;
type = types.port;
description = lib.mdDoc ''
This specifies the port number on which the Client listens for
Director connections. It must agree with the FDPort specified in
@ -374,7 +374,7 @@ in {
port = mkOption {
default = 9103;
type = types.int;
type = types.port;
description = lib.mdDoc ''
Specifies port number on which the Storage daemon listens for
Director connections.
@ -451,7 +451,7 @@ in {
port = mkOption {
default = 9101;
type = types.int;
type = types.port;
description = lib.mdDoc ''
Specify the port (a positive integer) on which the Director daemon
will listen for Bacula Console connections. This same port number

View file

@ -12,7 +12,7 @@ in
port = mkOption {
default = 8200;
type = types.int;
type = types.port;
description = lib.mdDoc ''
Port serving the web interface
'';

View file

@ -12,7 +12,7 @@ in
{
###### interface
options.services.kubernetes.flannel = {
enable = mkEnableOption (lib.mdDoc "enable flannel networking");
enable = mkEnableOption (lib.mdDoc "flannel networking");
};
###### implementation

View file

@ -18,7 +18,7 @@ in
'')
];
options.services.foldingathome = {
enable = mkEnableOption (lib.mdDoc "Enable the Folding@home client");
enable = mkEnableOption (lib.mdDoc "Folding@home client");
package = mkOption {
type = types.package;

View file

@ -34,13 +34,7 @@ in {
services.couchdb = {
enable = mkOption {
type = types.bool;
default = false;
description = lib.mdDoc ''
Whether to run CouchDB Server.
'';
};
enable = mkEnableOption (lib.mdDoc "CouchDB Server");
package = mkOption {
type = types.package;

View file

@ -15,13 +15,7 @@ in {
services.opentsdb = {
enable = mkOption {
type = types.bool;
default = false;
description = lib.mdDoc ''
Whether to run OpenTSDB.
'';
};
enable = mkEnableOption (lib.mdDoc "OpenTSDB");
package = mkOption {
type = types.package;
@ -49,7 +43,7 @@ in {
};
port = mkOption {
type = types.int;
type = types.port;
default = 4242;
description = lib.mdDoc ''
Which port OpenTSDB listens on.

View file

@ -85,7 +85,7 @@ in {
};
port = mkOption {
type = types.int;
type = types.port;
default = 8080;
description = lib.mdDoc ''
This tells pgmanage what port to listen on for browser requests.

View file

@ -70,7 +70,7 @@ in
};
port = mkOption {
type = types.int;
type = types.port;
default = 8303;
description = lib.mdDoc ''
Port the server will listen on.

View file

@ -18,7 +18,7 @@ in
];
options.services.zigbee2mqtt = {
enable = mkEnableOption (lib.mdDoc "enable zigbee2mqtt service");
enable = mkEnableOption (lib.mdDoc "zigbee2mqtt service");
package = mkOption {
description = lib.mdDoc "Zigbee2mqtt package to use";

View file

@ -12,11 +12,7 @@ in {
options = {
services.fluentd = {
enable = mkOption {
type = types.bool;
default = false;
description = lib.mdDoc "Whether to enable fluentd.";
};
enable = mkEnableOption (lib.mdDoc "fluentd");
config = mkOption {
type = types.lines;

View file

@ -109,13 +109,7 @@ in
{
options = {
services.logcheck = {
enable = mkOption {
default = false;
type = types.bool;
description = lib.mdDoc ''
Enable the logcheck cron job.
'';
};
enable = mkEnableOption (lib.mdDoc "logcheck cron job");
user = mkOption {
default = "logcheck";

View file

@ -48,7 +48,7 @@ in {
};
port = mkOption {
type = types.int;
type = types.port;
default = 4040;
description = lib.mdDoc ''
The port on which Airsonic will listen for

View file

@ -44,7 +44,7 @@ in
};
port = mkOption {
type = types.int;
type = types.port;
default = 27701;
description = lib.mdDoc "ankisyncd port";
};

View file

@ -40,7 +40,7 @@ in {
port = mkOption {
description = lib.mdDoc "Port number the broker should listen on.";
default = 9092;
type = types.int;
type = types.port;
};
hostname = mkOption {

View file

@ -68,17 +68,12 @@ in
{
options = {
services.exhibitor = {
enable = mkOption {
type = types.bool;
default = false;
description = lib.mdDoc ''
Whether to enable the exhibitor server.
'';
};
enable = mkEnableOption (lib.mdDoc "exhibitor server");
# See https://github.com/soabase/exhibitor/wiki/Running-Exhibitor for what these mean
# General options for any type of config
port = mkOption {
type = types.int;
type = types.port;
default = 8080;
description = lib.mdDoc ''
The port for exhibitor to listen on and communicate with other exhibitors.

View file

@ -90,7 +90,7 @@ in
};
port = mkOption {
type = types.int;
type = types.port;
default = 3306;
description = lib.mdDoc "Database host port.";
};
@ -167,7 +167,7 @@ in
};
httpPort = mkOption {
type = types.int;
type = types.port;
default = 3000;
description = lib.mdDoc "HTTP listen port.";
};

View file

@ -8,11 +8,7 @@ in
{
options.services.gollum = {
enable = mkOption {
type = types.bool;
default = false;
description = lib.mdDoc "Enable the Gollum service.";
};
enable = mkEnableOption (lib.mdDoc "Gollum service");
address = mkOption {
type = types.str;
@ -21,7 +17,7 @@ in
};
port = mkOption {
type = types.int;
type = types.port;
default = 4567;
description = lib.mdDoc "Port on which the web server will run.";
};

View file

@ -70,7 +70,7 @@ in
};
port = mkOption {
type = types.int;
type = types.port;
default = 8000;
description = lib.mdDoc ''
Port to listen on.

View file

@ -28,7 +28,7 @@ in
};
port = mkOption {
type = types.int;
type = types.port;
default = 1688;
description = lib.mdDoc "The port on which to listen.";
};

View file

@ -161,7 +161,7 @@ in
};
port = mkOption {
type = types.int;
type = types.port;
default = if cfg.database.type == "postgresql" then 5432 else 3306;
defaultText = literalExpression "3306";
description = lib.mdDoc "Database host port.";

View file

@ -98,7 +98,7 @@ let
port = mkOption {
description = lib.mdDoc "Port where rippled listens.";
type = types.int;
type = types.port;
};
protocol = mkOption {

View file

@ -27,7 +27,7 @@ in
};
port = mkOption {
type = types.int;
type = types.port;
default = 8181;
description = lib.mdDoc "TCP port where Tautulli listens.";
};

View file

@ -97,7 +97,7 @@ in {
};
port = mkOption {
type = types.int;
type = types.port;
default = 8095;
description = lib.mdDoc ''
The port on which to listen.

View file

@ -24,16 +24,12 @@ let
in {
options.services.zookeeper = {
enable = mkOption {
description = lib.mdDoc "Whether to enable Zookeeper.";
default = false;
type = types.bool;
};
enable = mkEnableOption (lib.mdDoc "Zookeeper");
port = mkOption {
description = lib.mdDoc "Zookeeper Client port.";
default = 2181;
type = types.int;
type = types.port;
};
id = mkOption {

View file

@ -24,7 +24,7 @@ in
enable = mkEnableOption (lib.mdDoc "alerta");
port = mkOption {
type = types.int;
type = types.port;
default = 5000;
description = lib.mdDoc "Port of Alerta";
};

View file

@ -7,13 +7,7 @@ let
in {
options = {
services.arbtt = {
enable = mkOption {
type = types.bool;
default = false;
description = lib.mdDoc ''
Enable the arbtt statistics capture service.
'';
};
enable = mkEnableOption (lib.mdDoc "Arbtt statistics capture service");
package = mkOption {
type = types.package;

View file

@ -22,13 +22,7 @@ in {
services.bosun = {
enable = mkOption {
type = types.bool;
default = false;
description = lib.mdDoc ''
Whether to run bosun.
'';
};
enable = mkEnableOption (lib.mdDoc "bosun");
package = mkOption {
type = types.package;

View file

@ -8,11 +8,7 @@ let
in {
options = {
services.cadvisor = {
enable = mkOption {
default = false;
type = types.bool;
description = lib.mdDoc "Whether to enable cadvisor service.";
};
enable = mkEnableOption (lib.mdDoc "Cadvisor service");
listenAddress = mkOption {
default = "127.0.0.1";
@ -22,7 +18,7 @@ in {
port = mkOption {
default = 8080;
type = types.int;
type = types.port;
description = lib.mdDoc "Cadvisor listening port";
};

View file

@ -49,13 +49,7 @@ let
};
in {
options.services.datadog-agent = {
enable = mkOption {
description = lib.mdDoc ''
Whether to enable the datadog-agent v7 monitoring service
'';
default = false;
type = types.bool;
};
enable = mkEnableOption (lib.mdDoc "Datadog-agent v7 monitoring service");
package = mkOption {
default = pkgs.datadog-agent;

View file

@ -23,7 +23,7 @@ in {
port = mkOption {
description = lib.mdDoc "Grafana port.";
default = 3000;
type = types.int;
type = types.port;
};
};
@ -36,7 +36,7 @@ in {
port = mkOption {
description = lib.mdDoc "Listening port.";
default = 8686;
type = types.int;
type = types.port;
};
templateDir = mkOption {

View file

@ -6,11 +6,7 @@ let
cfg = config.services.heapster;
in {
options.services.heapster = {
enable = mkOption {
description = lib.mdDoc "Whether to enable heapster monitoring";
default = false;
type = types.bool;
};
enable = mkEnableOption (lib.mdDoc "Heapster monitoring");
source = mkOption {
description = lib.mdDoc "Heapster metric source";

View file

@ -1563,13 +1563,7 @@ in
options.services.prometheus = {
enable = mkOption {
type = types.bool;
default = false;
description = lib.mdDoc ''
Enable the Prometheus monitoring daemon.
'';
};
enable = mkEnableOption (lib.mdDoc "Prometheus monitoring daemon");
package = mkOption {
type = types.package;

View file

@ -33,7 +33,7 @@ let
'';
};
port = mkOption {
type = types.int;
type = types.port;
example = 587;
description = lib.mdDoc ''
Port to use for SMTP.

View file

@ -17,7 +17,7 @@ in
};
torControlPort = mkOption {
type = types.int;
type = types.port;
default = 9051;
description = lib.mdDoc ''
Tor control port.

View file

@ -27,13 +27,8 @@ in {
options = {
services.riemann = {
enable = mkOption {
type = types.bool;
default = false;
description = lib.mdDoc ''
Enable the Riemann network monitoring daemon.
'';
};
enable = mkEnableOption (lib.mdDoc "Riemann network monitoring daemon");
config = mkOption {
type = types.lines;
description = lib.mdDoc ''

View file

@ -94,7 +94,7 @@ in
};
port = mkOption {
type = types.int;
type = types.port;
default = if cfg.database.type == "mysql" then mysql.port else pgsql.port;
defaultText = literalExpression ''
if config.${opt.database.type} == "mysql"

View file

@ -9,7 +9,7 @@ in {
options = {
services.samba-wsdd = {
enable = mkEnableOption (lib.mdDoc ''
Enable Web Services Dynamic Discovery host daemon. This enables (Samba) hosts, like your local NAS device,
Web Services Dynamic Discovery host daemon. This enables (Samba) hosts, like your local NAS device,
to be found by Web Service Discovery Clients like Windows.
::: {.note}

View file

@ -68,7 +68,7 @@ in
portNumber = mkOption {
default = 6667;
type = types.int;
type = types.port;
description = lib.mdDoc ''
Number of the port BitlBee will be listening to.
'';

View file

@ -135,7 +135,7 @@ in {
};
port = mkOption {
type = types.int;
type = types.port;
default = 5353;
description = lib.mdDoc ''
The DNSCrypt wrapper will listen for DNS queries on this port.
@ -182,7 +182,7 @@ in {
};
upstream.port = mkOption {
type = types.int;
type = types.port;
default = 53;
description = lib.mdDoc ''
The port of the upstream DNS server DNSCrypt will "wrap".

View file

@ -20,7 +20,7 @@ in
port = mkOption {
default = 2022;
type = types.int;
type = types.port;
description = lib.mdDoc ''
The port the server should listen on. Will use the server's default (2022) if not specified.

View file

@ -9,7 +9,7 @@ let
in
{
options.services.magic-wormhole-mailbox-server = {
enable = mkEnableOption (lib.mdDoc "Enable Magic Wormhole Mailbox Server");
enable = mkEnableOption (lib.mdDoc "Magic Wormhole Mailbox Server");
};
config = mkIf cfg.enable {

View file

@ -1,13 +1,8 @@
{ config, lib, pkgs, ... }:
{
options.services.mozillavpn.enable = lib.mkOption {
type = lib.types.bool;
default = false;
description = lib.mdDoc ''
Enable the Mozilla VPN daemon.
'';
};
options.services.mozillavpn.enable =
lib.mkEnableOption (lib.mdDoc "Mozilla VPN daemon");
config = lib.mkIf config.services.mozillavpn.enable {
environment.systemPackages = [ pkgs.mozillavpn ];

View file

@ -365,7 +365,7 @@ in {
If you enable this option the
`networkmanager_strongswan` plugin will be added to
the {option}`networking.networkmanager.plugins` option
so you don't need to to that yourself.
so you don't need to do that yourself.
'';
};

View file

@ -71,7 +71,7 @@ in
};
upstreamPort = mkOption {
type = types.int;
type = types.port;
default = 563;
description = lib.mdDoc ''
Upstream server port
@ -112,7 +112,7 @@ in
};
port = mkOption {
type = types.int;
type = types.port;
default = 5555;
description = lib.mdDoc ''
Proxy listen port

View file

@ -26,11 +26,7 @@ in {
### Interface
options.services.onedrive = {
enable = lib.mkOption {
type = lib.types.bool;
default = false;
description = lib.mdDoc "Enable OneDrive service";
};
enable = lib.mkEnableOption (lib.mdDoc "OneDrive service");
package = lib.mkOption {
type = lib.types.package;

View file

@ -29,7 +29,7 @@ in
enable = mkEnableOption (lib.mdDoc "Ostinato agent-controller (Drone)");
port = mkOption {
type = types.int;
type = types.port;
default = 7878;
description = lib.mdDoc ''
Port to listen on.

View file

@ -10,7 +10,7 @@ in
###### interface
options = {
services.owamp.enable = mkEnableOption (lib.mdDoc "Enable OWAMP server");
services.owamp.enable = mkEnableOption (lib.mdDoc "OWAMP server");
};

View file

@ -23,11 +23,7 @@ in
services.polipo = {
enable = mkOption {
type = types.bool;
default = false;
description = lib.mdDoc "Whether to run the polipo caching web proxy.";
};
enable = mkEnableOption (lib.mdDoc "polipo caching web proxy");
proxyAddress = mkOption {
type = types.str;
@ -36,7 +32,7 @@ in
};
proxyPort = mkOption {
type = types.int;
type = types.port;
default = 8123;
description = lib.mdDoc "TCP port on which Polipo will listen.";
};

View file

@ -48,7 +48,7 @@ in
};
port = mkOption {
type = types.int;
type = types.port;
default = 8388;
description = lib.mdDoc ''
Port which the server uses.

View file

@ -49,11 +49,8 @@ in
{
options = {
services.smokeping = {
enable = mkOption {
type = types.bool;
default = false;
description = lib.mdDoc "Enable the smokeping service";
};
enable = mkEnableOption (lib.mdDoc "smokeping service");
alertConfig = mkOption {
type = types.lines;
default = ''
@ -186,7 +183,7 @@ in
'';
};
port = mkOption {
type = types.int;
type = types.port;
default = 8081;
description = lib.mdDoc "TCP port to use for the web server.";
};

View file

@ -70,7 +70,7 @@ in
};
port = mkOption {
type = types.int;
type = types.port;
default = 443;
description = lib.mdDoc "Listening port.";
};

View file

@ -65,7 +65,7 @@ in
};
port = mkOption {
type = int;
type = port;
default = 3000;
description = lib.mdDoc "Metrics and diagnostics port.";
};

View file

@ -29,7 +29,7 @@ in
};
port = mkOption {
type = types.int;
type = types.port;
default = 33445;
description = lib.mdDoc "Listening port (UDP).";
};

View file

@ -14,7 +14,7 @@ with lib;
};
port = mkOption {
type = types.int;
type = types.port;
default = 33445;
description = lib.mdDoc "udp port for toxcore, port-forward to help with connectivity if you run many nodes behind one NAT";
};

View file

@ -54,7 +54,7 @@ in
};
port = mkOption {
type = types.int;
type = types.port;
default = 3389;
description = lib.mdDoc ''
Specifies on which port the xrdp daemon listens.

View file

@ -19,7 +19,7 @@ in
options.services.zerotierone.port = mkOption {
default = 9993;
type = types.int;
type = types.port;
description = lib.mdDoc ''
Network port used by ZeroTier.
'';

View file

@ -21,7 +21,7 @@ in
};
port = mkOption {
type = types.int;
type = types.port;
default = 8983;
description = lib.mdDoc "Port on which Solr is ran.";
};

View file

@ -61,7 +61,7 @@ in
};
listenPort = mkOption {
type = types.int;
type = types.port;
default = 8092;
description = lib.mdDoc "Port to listen on.";
};
@ -95,7 +95,7 @@ in
};
port = mkOption {
type = types.int;
type = types.port;
default = 443;
example = 80;
description = lib.mdDoc "Port used at the proxy";

View file

@ -75,7 +75,7 @@ let
in {
options.services.peertube = {
enable = lib.mkEnableOption (lib.mdDoc "Enable Peertubes service");
enable = lib.mkEnableOption (lib.mdDoc "Peertube");
user = lib.mkOption {
type = lib.types.str;
@ -96,13 +96,13 @@ in {
};
listenHttp = lib.mkOption {
type = lib.types.int;
type = lib.types.port;
default = 9000;
description = lib.mdDoc "listen port for HTTP server.";
};
listenWeb = lib.mkOption {
type = lib.types.int;
type = lib.types.port;
default = 9000;
description = lib.mdDoc "listen port for WEB server.";
};
@ -177,7 +177,7 @@ in {
};
port = lib.mkOption {
type = lib.types.int;
type = lib.types.port;
default = 5432;
description = lib.mdDoc "Database host port.";
};

View file

@ -69,7 +69,7 @@ in
};
listenPort = mkOption {
type = types.int;
type = types.port;
default = 3000;
description = lib.mdDoc ''
Listen port for the virtualhost to use.
@ -132,7 +132,7 @@ in
};
port = mkOption {
type = types.int;
type = types.port;
default = 25;
description = lib.mdDoc ''
Port used to connect to SMTP server.

View file

@ -67,7 +67,7 @@ in
};
port = mkOption {
type = types.int;
type = types.port;
default = 8080;
description = lib.mdDoc ''
The port number to bind to.

View file

@ -208,7 +208,7 @@ let
};
port = mkOption {
type = types.nullOr types.int;
type = types.nullOr types.port;
default = null;
description = lib.mdDoc ''
The database's port. If not set, the default ports will be provided (5432

View file

@ -68,7 +68,7 @@ in
The port youtrack will listen on.
'';
default = 8080;
type = types.int;
type = types.port;
};
statePath = mkOption {

View file

@ -28,13 +28,7 @@ let
cfg.settings));
in {
options.services.clight = {
enable = mkOption {
type = types.bool;
default = false;
description = lib.mdDoc ''
Whether to enable clight or not.
'';
};
enable = mkEnableOption (lib.mdDoc "clight");
temperature = {
day = mkOption {

View file

@ -25,7 +25,7 @@ in
};
port = mkOption {
type = types.int;
type = types.port;
default = 22;
description = lib.mdDoc ''
Port on which SSH initrd service should listen.