Add missing 'type', 'defaultText' and 'literalExample' in module definitions

- add missing types in module definitions
- add missing 'defaultText' in module definitions
- wrap example with 'literalExample' where necessary in module definitions

+1
nixos/modules/config/ldap.nix
···
users.ldap = {
enable = mkOption {
default = false;
description = "Whether to enable authentication against an LDAP server.";
};
···
users.ldap = {
enable = mkOption {
+
type = types.bool;
default = false;
description = "Whether to enable authentication against an LDAP server.";
};
+1
nixos/modules/config/pulseaudio.nix
···
package = mkOption {
type = types.package;
default = pulseaudioLight;
example = literalExample "pkgs.pulseaudioFull";
description = ''
The PulseAudio derivation to use. This can be used to enable
···
package = mkOption {
type = types.package;
default = pulseaudioLight;
+
defaultText = "pkgs.pulseaudioLight";
example = literalExample "pkgs.pulseaudioFull";
description = ''
The PulseAudio derivation to use. This can be used to enable
+1
nixos/modules/config/shells-environment.nix
···
environment.binsh = mkOption {
default = "${config.system.build.binsh}/bin/sh";
example = literalExample ''
"''${pkgs.dash}/bin/dash"
'';
···
environment.binsh = mkOption {
default = "${config.system.build.binsh}/bin/sh";
+
defaultText = "\${config.system.build.binsh}/bin/sh";
example = literalExample ''
"''${pkgs.dash}/bin/dash"
'';
+3 -2
nixos/modules/config/unix-odbc-drivers.nix
···
options = {
environment.unixODBCDrivers = mkOption {
default = [];
-
example = literalExample "map (x : x.ini) (with pkgs.unixODBCDrivers; [ mysql psql psqlng ] )";
description = ''
Specifies Unix ODBC drivers to be registered in
<filename>/etc/odbcinst.ini</filename>. You may also want to
···
config = mkIf (config.environment.unixODBCDrivers != []) {
environment.etc."odbcinst.ini".text =
-
let inis = config.environment.unixODBCDrivers;
in lib.concatStringsSep "\n" inis;
};
···
options = {
environment.unixODBCDrivers = mkOption {
+
type = types.listOf types.package;
default = [];
+
example = literalExample "with pkgs.unixODBCDrivers; [ mysql psql psqlng ]";
description = ''
Specifies Unix ODBC drivers to be registered in
<filename>/etc/odbcinst.ini</filename>. You may also want to
···
config = mkIf (config.environment.unixODBCDrivers != []) {
environment.etc."odbcinst.ini".text =
+
let inis = map (x : x.ini) config.environment.unixODBCDrivers;
in lib.concatStringsSep "\n" inis;
};
+1
nixos/modules/misc/crashdump.nix
···
'';
};
kernelPackages = mkOption {
default = pkgs.linuxPackages;
# We don't want to evaluate all of linuxPackages for the manual
# - some of it might not even evaluate correctly.
···
'';
};
kernelPackages = mkOption {
+
type = types.package;
default = pkgs.linuxPackages;
# We don't want to evaluate all of linuxPackages for the manual
# - some of it might not even evaluate correctly.
+2 -2
nixos/modules/misc/nixos.nix
···
nixos.extraModules = mkOption {
default = [];
-
example = literalExample "mkIf config.services.openssh.enable [ ./sshd-config.nix ]";
-
type = types.listOf types.unspecified;
description = ''
Define additional modules which would be loaded to evaluate the
configuration.
···
nixos.extraModules = mkOption {
default = [];
+
example = literalExample "[ ./sshd-config.nix ]";
+
type = types.listOf (types.either (types.submodule ({...}:{options={};})) types.path);
description = ''
Define additional modules which would be loaded to evaluate the
configuration.
+14 -10
nixos/modules/programs/ssh.nix
···
};
package = mkOption {
default = pkgs.openssh;
description = ''
The package used for the openssh client and daemon.
'';
···
description = ''
The set of system-wide known SSH hosts.
'';
-
example = [
-
{
-
hostNames = [ "myhost" "myhost.mydomain.com" "10.10.1.4" ];
-
publicKeyFile = literalExample "./pubkeys/myhost_ssh_host_dsa_key.pub";
-
}
-
{
-
hostNames = [ "myhost2" ];
-
publicKeyFile = literalExample "./pubkeys/myhost2_ssh_host_dsa_key.pub";
-
}
-
];
};
};
···
};
package = mkOption {
+
type = types.package;
default = pkgs.openssh;
+
defaultText = "pkgs.openssh";
description = ''
The package used for the openssh client and daemon.
'';
···
description = ''
The set of system-wide known SSH hosts.
'';
+
example = literalExample ''
+
[
+
{
+
hostNames = [ "myhost" "myhost.mydomain.com" "10.10.1.4" ];
+
publicKeyFile = "./pubkeys/myhost_ssh_host_dsa_key.pub";
+
}
+
{
+
hostNames = [ "myhost2" ];
+
publicKeyFile = "./pubkeys/myhost2_ssh_host_dsa_key.pub";
+
}
+
]
+
'';
};
};
+1 -1
nixos/modules/services/audio/liquidsoap.nix
···
example = {
myStream1 = literalExample "\"/etc/liquidsoap/myStream1.liq\"";
myStream2 = literalExample "./myStream2.liq";
-
myStream3 = literalExample "\"out(playlist(\"/srv/music/\"))\"";
};
type = types.attrsOf (types.either types.path types.str);
···
example = {
myStream1 = literalExample "\"/etc/liquidsoap/myStream1.liq\"";
myStream2 = literalExample "./myStream2.liq";
+
myStream3 = literalExample "\"out(playlist(\\\"/srv/music/\\\"))\"";
};
type = types.attrsOf (types.either types.path types.str);
+2 -2
nixos/modules/services/backup/bacula.nix
···
description = ''
Extra configuration to be passed in Client directive.
'';
-
example = literalExample ''
Maximum Concurrent Jobs = 20;
Heartbeat Interval = 30;
'';
···
description = ''
Extra configuration to be passed in Messages directive.
'';
-
example = literalExample ''
console = all
'';
};
···
description = ''
Extra configuration to be passed in Client directive.
'';
+
example = ''
Maximum Concurrent Jobs = 20;
Heartbeat Interval = 30;
'';
···
description = ''
Extra configuration to be passed in Messages directive.
'';
+
example = ''
console = all
'';
};
+1
nixos/modules/services/backup/rsnapshot.nix
···
package = mkOption {
type = types.package;
default = pkgs.rsnapshot;
example = literalExample "pkgs.rsnapshotGit";
description = ''
RSnapshot package to use.
···
package = mkOption {
type = types.package;
default = pkgs.rsnapshot;
+
defaultText = "pkgs.rsnapshot";
example = literalExample "pkgs.rsnapshotGit";
description = ''
RSnapshot package to use.
+1
nixos/modules/services/continuous-integration/jenkins/default.nix
···
packages = mkOption {
default = [ pkgs.stdenv pkgs.git pkgs.jdk config.programs.ssh.package pkgs.nix ];
type = types.listOf types.package;
description = ''
Packages to add to PATH for the jenkins process.
···
packages = mkOption {
default = [ pkgs.stdenv pkgs.git pkgs.jdk config.programs.ssh.package pkgs.nix ];
+
defaultText = "[ pkgs.stdenv pkgs.git pkgs.jdk config.programs.ssh.package pkgs.nix ]";
type = types.listOf types.package;
description = ''
Packages to add to PATH for the jenkins process.
+1 -1
nixos/modules/services/continuous-integration/jenkins/job-builder.nix
···
];
};
}
-
];
'';
description = ''
Job descriptions for Jenkins Job Builder in Nix format.
···
];
};
}
+
]
'';
description = ''
Job descriptions for Jenkins Job Builder in Nix format.
+1
nixos/modules/services/databases/couchdb.nix
···
package = mkOption {
type = types.package;
default = pkgs.couchdb;
example = literalExample "pkgs.couchdb";
description = ''
CouchDB package to use.
···
package = mkOption {
type = types.package;
default = pkgs.couchdb;
+
defaultText = "pkgs.couchdb";
example = literalExample "pkgs.couchdb";
description = ''
CouchDB package to use.
+1
nixos/modules/services/databases/firebird.nix
···
package = mkOption {
default = pkgs.firebirdSuper;
type = types.package;
/*
Example: <code>package = pkgs.firebirdSuper.override { icu =
···
package = mkOption {
default = pkgs.firebirdSuper;
+
defaultText = "pkgs.firebirdSuper";
type = types.package;
/*
Example: <code>package = pkgs.firebirdSuper.override { icu =
+1
nixos/modules/services/databases/hbase.nix
···
package = mkOption {
type = types.package;
default = pkgs.hbase;
example = literalExample "pkgs.hbase";
description = ''
HBase package to use.
···
package = mkOption {
type = types.package;
default = pkgs.hbase;
+
defaultText = "pkgs.hbase";
example = literalExample "pkgs.hbase";
description = ''
HBase package to use.
+1
nixos/modules/services/databases/influxdb.nix
···
package = mkOption {
default = pkgs.influxdb;
description = "Which influxdb derivation to use";
type = types.package;
};
···
package = mkOption {
default = pkgs.influxdb;
+
defaultText = "pkgs.influxdb";
description = "Which influxdb derivation to use";
type = types.package;
};
+1
nixos/modules/services/databases/mongodb.nix
···
package = mkOption {
default = pkgs.mongodb;
type = types.package;
description = "
Which MongoDB derivation to use.
···
package = mkOption {
default = pkgs.mongodb;
+
defaultText = "pkgs.mongodb";
type = types.package;
description = "
Which MongoDB derivation to use.
+1
nixos/modules/services/databases/neo4j.nix
···
package = mkOption {
description = "Neo4j package to use.";
default = pkgs.neo4j;
type = types.package;
};
···
package = mkOption {
description = "Neo4j package to use.";
default = pkgs.neo4j;
+
defaultText = "pkgs.neo4j";
type = types.package;
};
+14 -16
nixos/modules/services/databases/openldap.nix
···
description = "
Whether to enable the ldap server.
";
-
example = literalExample ''
-
openldap.enable = true;
-
openldap.extraConfig = '''
-
include ''${pkgs.openldap}/etc/openldap/schema/core.schema
-
include ''${pkgs.openldap}/etc/openldap/schema/cosine.schema
-
include ''${pkgs.openldap}/etc/openldap/schema/inetorgperson.schema
-
include ''${pkgs.openldap}/etc/openldap/schema/nis.schema
-
-
database bdb
-
suffix dc=example,dc=org
-
rootdn cn=admin,dc=example,dc=org
-
# NOTE: change after first start
-
rootpw secret
-
directory /var/db/openldap
-
''';
-
'';
};
user = mkOption {
···
description = "
sldapd.conf configuration
";
};
};
···
description = "
Whether to enable the ldap server.
";
+
example = true;
};
user = mkOption {
···
description = "
sldapd.conf configuration
";
+
example = ''
+
include ''${pkgs.openldap}/etc/openldap/schema/core.schema
+
include ''${pkgs.openldap}/etc/openldap/schema/cosine.schema
+
include ''${pkgs.openldap}/etc/openldap/schema/inetorgperson.schema
+
include ''${pkgs.openldap}/etc/openldap/schema/nis.schema
+
+
database bdb
+
suffix dc=example,dc=org
+
rootdn cn=admin,dc=example,dc=org
+
# NOTE: change after first start
+
rootpw secret
+
directory /var/db/openldap
+
'';
};
};
+1
nixos/modules/services/databases/opentsdb.nix
···
package = mkOption {
type = types.package;
default = pkgs.opentsdb;
example = literalExample "pkgs.opentsdb";
description = ''
OpenTSDB package to use.
···
package = mkOption {
type = types.package;
default = pkgs.opentsdb;
+
defaultText = "pkgs.opentsdb";
example = literalExample "pkgs.opentsdb";
description = ''
OpenTSDB package to use.
+1
nixos/modules/services/databases/redis.nix
···
package = mkOption {
type = types.package;
default = pkgs.redis;
description = "Which Redis derivation to use.";
};
···
package = mkOption {
type = types.package;
default = pkgs.redis;
+
defaultText = "pkgs.redis";
description = "Which Redis derivation to use.";
};
+1
nixos/modules/services/hardware/freefall.nix
···
package = mkOption {
type = types.package;
default = pkgs.freefall;
description = ''
freefall derivation to use.
'';
···
package = mkOption {
type = types.package;
default = pkgs.freefall;
+
defaultText = "pkgs.freefall";
description = ''
freefall derivation to use.
'';
+1
nixos/modules/services/hardware/upower.nix
···
package = mkOption {
type = types.package;
default = pkgs.upower;
example = lib.literalExample "pkgs.upower";
description = ''
Which upower package to use.
···
package = mkOption {
type = types.package;
default = pkgs.upower;
+
defaultText = "pkgs.upower";
example = lib.literalExample "pkgs.upower";
description = ''
Which upower package to use.
+1
nixos/modules/services/logging/logrotate.nix
···
options = {
services.logrotate = {
enable = mkOption {
default = false;
description = ''
Enable the logrotate cron job
···
options = {
services.logrotate = {
enable = mkOption {
+
type = lib.types.bool;
default = false;
description = ''
Enable the logrotate cron job
+2 -1
nixos/modules/services/logging/logstash.nix
···
package = mkOption {
type = types.package;
default = pkgs.logstash;
example = literalExample "pkgs.logstash";
description = "Logstash package to use.";
};
···
type = types.lines;
default = ''stdin { type => "example" }'';
description = "Logstash input configuration.";
-
example = literalExample ''
# Read from journal
pipe {
command => "''${pkgs.systemd}/bin/journalctl -f -o json"
···
package = mkOption {
type = types.package;
default = pkgs.logstash;
+
defaultText = "pkgs.logstash";
example = literalExample "pkgs.logstash";
description = "Logstash package to use.";
};
···
type = types.lines;
default = ''stdin { type => "example" }'';
description = "Logstash input configuration.";
+
example = ''
# Read from journal
pipe {
command => "''${pkgs.systemd}/bin/journalctl -f -o json"
+1
nixos/modules/services/logging/syslog-ng.nix
···
package = mkOption {
type = types.package;
default = pkgs.syslogng;
description = ''
The package providing syslog-ng binaries.
'';
···
package = mkOption {
type = types.package;
default = pkgs.syslogng;
+
defaultText = "pkgs.syslogng";
description = ''
The package providing syslog-ng binaries.
'';
+2 -1
nixos/modules/services/mail/dovecot.nix
···
package = mkOption {
type = types.package;
default = pkgs.dovecot22;
description = "Dovecot package to use.";
};
···
modules = mkOption {
type = types.listOf types.package;
default = [];
-
example = [ pkgs.dovecot_pigeonhole ];
description = ''
Symlinks the contents of lib/dovecot of every given package into
/var/lib/dovecot/modules. This will make the given modules available
···
package = mkOption {
type = types.package;
default = pkgs.dovecot22;
+
defaultText = "pkgs.dovecot22";
description = "Dovecot package to use.";
};
···
modules = mkOption {
type = types.listOf types.package;
default = [];
+
example = literalExample "[ pkgs.dovecot_pigeonhole ]";
description = ''
Symlinks the contents of lib/dovecot of every given package into
/var/lib/dovecot/modules. This will make the given modules available
+1 -2
nixos/modules/services/misc/apache-kafka.nix
···
package = mkOption {
description = "The kafka package to use";
-
default = pkgs.apacheKafka;
-
type = types.package;
};
···
package = mkOption {
description = "The kafka package to use";
default = pkgs.apacheKafka;
+
defaultText = "pkgs.apacheKafka";
type = types.package;
};
+2 -1
nixos/modules/services/misc/autofs.nix
···
};
autoMaster = mkOption {
example = literalExample ''
-
autoMaster = let
mapConf = pkgs.writeText "auto" '''
kernel -ro,soft,intr ftp.kernel.org:/pub/linux
boot -fstype=ext2 :/dev/hda1
···
};
autoMaster = mkOption {
+
type = types.str;
example = literalExample ''
+
let
mapConf = pkgs.writeText "auto" '''
kernel -ro,soft,intr ftp.kernel.org:/pub/linux
boot -fstype=ext2 :/dev/hda1
+1
nixos/modules/services/misc/cgminer.nix
···
package = mkOption {
default = pkgs.cgminer;
description = "Which cgminer derivation to use.";
type = types.package;
};
···
package = mkOption {
default = pkgs.cgminer;
+
defaultText = "pkgs.cgminer";
description = "Which cgminer derivation to use.";
type = types.package;
};
+1
nixos/modules/services/misc/confd.nix
···
package = mkOption {
description = "Confd package to use.";
default = pkgs.confd;
type = types.package;
};
};
···
package = mkOption {
description = "Confd package to use.";
default = pkgs.confd;
+
defaultText = "pkgs.confd";
type = types.package;
};
};
+5 -5
nixos/modules/services/misc/etcd.nix
···
default = {};
example = literalExample ''
{
-
"CORS": "*",
-
"NAME": "default-name",
-
"MAX_RESULT_BUFFER": "1024",
-
"MAX_CLUSTER_SIZE": "9",
-
"MAX_RETRY_ATTEMPTS": "3"
}
'';
};
···
default = {};
example = literalExample ''
{
+
"CORS" = "*";
+
"NAME" = "default-name";
+
"MAX_RESULT_BUFFER" = "1024";
+
"MAX_CLUSTER_SIZE" = "9";
+
"MAX_RETRY_ATTEMPTS" = "3";
}
'';
};
+2
nixos/modules/services/misc/felix.nix
···
};
bundles = mkOption {
default = [ pkgs.felix_remoteshell ];
description = "List of bundles that should be activated on startup";
};
···
};
bundles = mkOption {
+
type = types.listOf types.package;
default = [ pkgs.felix_remoteshell ];
+
defaultText = "[ pkgs.felix_remoteshell ]";
description = "List of bundles that should be activated on startup";
};
+1
nixos/modules/services/misc/gitit.nix
···
};
haskellPackages = mkOption {
default = pkgs.haskellPackages;
defaultText = "pkgs.haskellPackages";
example = literalExample "pkgs.haskell.packages.ghc784";
···
};
haskellPackages = mkOption {
+
type = types.attrsOf types.package;
default = pkgs.haskellPackages;
defaultText = "pkgs.haskellPackages";
example = literalExample "pkgs.haskell.packages.ghc784";
+1
nixos/modules/services/misc/ihaskell.nix
···
};
haskellPackages = mkOption {
default = pkgs.haskellPackages;
defaultText = "pkgs.haskellPackages";
example = literalExample "pkgs.haskell.packages.ghc784";
···
};
haskellPackages = mkOption {
+
type = types.attrsOf types.package;
default = pkgs.haskellPackages;
defaultText = "pkgs.haskellPackages";
example = literalExample "pkgs.haskell.packages.ghc784";
+2
nixos/modules/services/misc/mbpfan.nix
···
};
package = mkOption {
default = pkgs.mbpfan;
description = ''
The package used for the mbpfan daemon.
'';
···
};
package = mkOption {
+
type = types.package;
default = pkgs.mbpfan;
+
defaultText = "pkgs.mbpfan";
description = ''
The package used for the mbpfan daemon.
'';
+1
nixos/modules/services/misc/nix-daemon.nix
···
package = mkOption {
type = types.package;
default = pkgs.nix;
description = ''
This option specifies the Nix package instance to use throughout the system.
'';
···
package = mkOption {
type = types.package;
default = pkgs.nix;
+
defaultText = "pkgs.nix";
description = ''
This option specifies the Nix package instance to use throughout the system.
'';
+4 -3
nixos/modules/services/misc/rippled.nix
···
description = "Which rippled package to use.";
type = types.package;
default = pkgs.rippled;
};
ports = mkOption {
···
nodeDb = mkOption {
description = "Rippled main database options.";
type = types.nullOr types.optionSet;
-
options = [dbOptions];
default = {
type = "rocksdb";
extraOpts = ''
···
tempDb = mkOption {
description = "Rippled temporary database options.";
type = types.nullOr types.optionSet;
-
options = [dbOptions];
default = null;
};
importDb = mkOption {
description = "Settings for performing a one-time import.";
type = types.nullOr types.optionSet;
-
options = [dbOptions];
default = null;
};
···
description = "Which rippled package to use.";
type = types.package;
default = pkgs.rippled;
+
defaultText = "pkgs.rippled";
};
ports = mkOption {
···
nodeDb = mkOption {
description = "Rippled main database options.";
type = types.nullOr types.optionSet;
+
options = dbOptions;
default = {
type = "rocksdb";
extraOpts = ''
···
tempDb = mkOption {
description = "Rippled temporary database options.";
type = types.nullOr types.optionSet;
+
options = dbOptions;
default = null;
};
importDb = mkOption {
description = "Settings for performing a one-time import.";
type = types.nullOr types.optionSet;
+
options = dbOptions;
default = null;
};
+1
nixos/modules/services/monitoring/bosun.nix
···
package = mkOption {
type = types.package;
default = pkgs.bosun;
example = literalExample "pkgs.bosun";
description = ''
bosun binary to use.
···
package = mkOption {
type = types.package;
default = pkgs.bosun;
+
defaultText = "pkgs.bosun";
example = literalExample "pkgs.bosun";
description = ''
bosun binary to use.
+1
nixos/modules/services/monitoring/grafana.nix
···
package = mkOption {
description = "Package to use.";
default = pkgs.grafana;
type = types.package;
};
···
package = mkOption {
description = "Package to use.";
default = pkgs.grafana;
+
defaultText = "pkgs.grafana";
type = types.package;
};
+4 -3
nixos/modules/services/monitoring/graphite.nix
···
finders = mkOption {
description = "List of finder plugins to load.";
default = [];
-
example = [ pkgs.python27Packages.graphite_influxdb ];
type = types.listOf types.package;
};
···
package = mkOption {
description = "Package to use for graphite api.";
default = pkgs.python27Packages.graphite_api;
type = types.package;
};
···
directories:
- ${dataDir}/whisper
'';
-
example = literalExample ''
allowed_origins:
- dashboard.example.com
cheat_times: true
···
critical: 200
name: Test
'';
-
example = literalExample ''
pushbullet_key: pushbullet_api_key
alerts:
- target: stats.seatgeek.app.deal_quality.venue_info_cache.hit
···
finders = mkOption {
description = "List of finder plugins to load.";
default = [];
+
example = literalExample "[ pkgs.python27Packages.graphite_influxdb ]";
type = types.listOf types.package;
};
···
package = mkOption {
description = "Package to use for graphite api.";
default = pkgs.python27Packages.graphite_api;
+
defaultText = "pkgs.python27Packages.graphite_api";
type = types.package;
};
···
directories:
- ${dataDir}/whisper
'';
+
example = ''
allowed_origins:
- dashboard.example.com
cheat_times: true
···
critical: 200
name: Test
'';
+
example = ''
pushbullet_key: pushbullet_api_key
alerts:
- target: stats.seatgeek.app.deal_quality.venue_info_cache.hit
+1
nixos/modules/services/monitoring/heapster.nix
···
package = mkOption {
description = "Package to use by heapster";
default = pkgs.heapster;
type = types.package;
};
};
···
package = mkOption {
description = "Package to use by heapster";
default = pkgs.heapster;
+
defaultText = "pkgs.heapster";
type = types.package;
};
};
+3 -15
nixos/modules/services/monitoring/munin.nix
···
HTML output is in <filename>/var/www/munin/</filename>, configure your
favourite webserver to serve static files.
'';
-
example = literalExample ''
-
services = {
-
munin-node.enable = true;
-
munin-cron = {
-
enable = true;
-
hosts = '''
-
[''${config.networking.hostName}]
-
address localhost
-
''';
-
extraGlobalConfig = '''
-
contact.email.command mail -s "Munin notification for ''${var:host}" someone@example.com
-
''';
-
};
-
};
-
'';
};
extraGlobalConfig = mkOption {
···
See <link xlink:href='http://munin-monitoring.org/wiki/munin.conf' />.
Useful to setup notifications, see
<link xlink:href='http://munin-monitoring.org/wiki/HowToContact' />
'';
};
···
HTML output is in <filename>/var/www/munin/</filename>, configure your
favourite webserver to serve static files.
'';
};
extraGlobalConfig = mkOption {
···
See <link xlink:href='http://munin-monitoring.org/wiki/munin.conf' />.
Useful to setup notifications, see
<link xlink:href='http://munin-monitoring.org/wiki/HowToContact' />
+
'';
+
example = ''
+
contact.email.command mail -s "Munin notification for ''${var:host}" someone@example.com
'';
};
+6
nixos/modules/services/monitoring/nagios.nix
···
};
plugins = mkOption {
default = [pkgs.nagiosPluginsOfficial pkgs.ssmtp];
description = "
Packages to be added to the Nagios <envar>PATH</envar>.
Typically used to add plugins, but can be anything.
···
};
mainConfigFile = mkOption {
default = nagiosCfgFile;
description = "
Derivation for the main configuration file of Nagios.
";
};
cgiConfigFile = mkOption {
default = nagiosCGICfgFile;
description = "
Derivation for the configuration file of Nagios CGI scripts
that can be used in web servers for running the Nagios web interface.
···
};
plugins = mkOption {
+
type = types.listOf types.package;
default = [pkgs.nagiosPluginsOfficial pkgs.ssmtp];
+
defaultText = "[pkgs.nagiosPluginsOfficial pkgs.ssmtp]";
description = "
Packages to be added to the Nagios <envar>PATH</envar>.
Typically used to add plugins, but can be anything.
···
};
mainConfigFile = mkOption {
+
type = types.package;
default = nagiosCfgFile;
+
defaultText = "nagiosCfgFile";
description = "
Derivation for the main configuration file of Nagios.
";
};
cgiConfigFile = mkOption {
+
type = types.package;
default = nagiosCGICfgFile;
+
defaultText = "nagiosCGICfgFile";
description = "
Derivation for the configuration file of Nagios CGI scripts
that can be used in web servers for running the Nagios web interface.
+2 -1
nixos/modules/services/monitoring/scollector.nix
···
package = mkOption {
type = types.package;
default = pkgs.scollector;
example = literalExample "pkgs.scollector";
description = ''
scollector binary to use.
···
collectors = mkOption {
type = with types; attrsOf (listOf path);
default = {};
-
example = literalExample "{ 0 = [ \"\${postgresStats}/bin/collect-stats\" ]; }";
description = ''
An attribute set mapping the frequency of collection to a list of
binaries that should be executed at that frequency. You can use "0"
···
package = mkOption {
type = types.package;
default = pkgs.scollector;
+
defaultText = "pkgs.scollector";
example = literalExample "pkgs.scollector";
description = ''
scollector binary to use.
···
collectors = mkOption {
type = with types; attrsOf (listOf path);
default = {};
+
example = literalExample "{ \"0\" = [ \"\${postgresStats}/bin/collect-stats\" ]; }";
description = ''
An attribute set mapping the frequency of collection to a list of
binaries that should be executed at that frequency. You can use "0"
+2 -1
nixos/modules/services/network-filesystems/samba.nix
···
package = mkOption {
type = types.package;
default = pkgs.samba;
-
example = pkgs.samba4;
description = ''
Defines which package should be used for the samba server.
'';
···
package = mkOption {
type = types.package;
default = pkgs.samba;
+
defaultText = "pkgs.samba";
+
example = literalExample "pkgs.samba4";
description = ''
Defines which package should be used for the samba server.
'';
+2
nixos/modules/services/networking/bind.nix
···
};
configFile = mkOption {
default = confFile;
description = "
Overridable config file to use for named. By default, that
generated by nixos.
···
};
configFile = mkOption {
+
type = types.path;
default = confFile;
+
defaultText = "confFile";
description = "
Overridable config file to use for named. By default, that
generated by nixos.
+1
nixos/modules/services/networking/consul.nix
···
package = mkOption {
description = "Package to use for consul-alerts.";
default = pkgs.consul-alerts;
type = types.package;
};
···
package = mkOption {
description = "Package to use for consul-alerts.";
default = pkgs.consul-alerts;
+
defaultText = "pkgs.consul-alerts";
type = types.package;
};
+2 -1
nixos/modules/services/networking/firewall.nix
···
};
networking.firewall.extraPackages = mkOption {
default = [ ];
-
example = [ pkgs.ipset ];
description =
''
Additional packages to be included in the environment of the system
···
};
networking.firewall.extraPackages = mkOption {
+
type = types.listOf types.package;
default = [ ];
+
example = literalExample "[ pkgs.ipset ]";
description =
''
Additional packages to be included in the environment of the system
+1
nixos/modules/services/networking/lambdabot.nix
···
package = mkOption {
type = types.package;
default = pkgs.lambdabot;
description = "Used lambdabot package";
};
···
package = mkOption {
type = types.package;
default = pkgs.lambdabot;
+
defaultText = "pkgs.lambdabot";
description = "Used lambdabot package";
};
+1 -1
nixos/modules/services/networking/networkmanager.nix
···
# Ugly hack for using the correct gnome3 packageSet
basePackages = mkOption {
-
type = types.attrsOf types.path;
default = { inherit networkmanager modemmanager wpa_supplicant
networkmanager_openvpn networkmanager_vpnc
networkmanager_openconnect
···
# Ugly hack for using the correct gnome3 packageSet
basePackages = mkOption {
+
type = types.attrsOf types.package;
default = { inherit networkmanager modemmanager wpa_supplicant
networkmanager_openvpn networkmanager_vpnc
networkmanager_openconnect
+1
nixos/modules/services/networking/ngircd.nix
···
type = types.package;
default = pkgs.ngircd;
};
};
};
···
type = types.package;
default = pkgs.ngircd;
+
defaultText = "pkgs.ngircd";
};
};
};
+1
nixos/modules/services/networking/skydns.nix
···
package = mkOption {
default = pkgs.skydns;
type = types.package;
description = "Skydns package to use.";
};
···
package = mkOption {
default = pkgs.skydns;
+
defaultText = "pkgs.skydns";
type = types.package;
description = "Skydns package to use.";
};
+1 -1
nixos/modules/services/networking/supplicant.nix
···
path = mkOption {
type = types.path;
-
example = "/etc/wpa_supplicant.conf";
description = ''
External <literal>wpa_supplicant.conf</literal> configuration file.
The configuration options defined declaratively within <literal>networking.supplicant</literal> have
···
path = mkOption {
type = types.path;
+
example = literalExample "/etc/wpa_supplicant.conf";
description = ''
External <literal>wpa_supplicant.conf</literal> configuration file.
The configuration options defined declaratively within <literal>networking.supplicant</literal> have
+1
nixos/modules/services/networking/syncthing.nix
···
package = mkOption {
type = types.package;
default = pkgs.syncthing;
example = literalExample "pkgs.syncthing";
description = ''
Syncthing package to use.
···
package = mkOption {
type = types.package;
default = pkgs.syncthing;
+
defaultText = "pkgs.syncthing";
example = literalExample "pkgs.syncthing";
description = ''
Syncthing package to use.
+2
nixos/modules/services/networking/tinc.nix
···
};
package = mkOption {
default = pkgs.tinc_pre;
description = ''
The package to use for the tinc daemon's binary.
'';
···
};
package = mkOption {
+
type = types.package;
default = pkgs.tinc_pre;
+
defaultText = "pkgs.tinc_pre";
description = ''
The package to use for the tinc daemon's binary.
'';
+2
nixos/modules/services/networking/vsftpd.nix
···
};
userlistFile = mkOption {
default = pkgs.writeText "userlist" (concatMapStrings (x: "${x}\n") cfg.userlist);
description = ''
Newline separated list of names to be allowed/denied if <option>userlistEnable</option>
is <literal>true</literal>. Meaning see <option>userlistDeny</option>.
···
};
userlistFile = mkOption {
+
type = types.path;
default = pkgs.writeText "userlist" (concatMapStrings (x: "${x}\n") cfg.userlist);
+
defaultText = "pkgs.writeText \"userlist\" (concatMapStrings (x: \"\${x}\n\") cfg.userlist)";
description = ''
Newline separated list of names to be allowed/denied if <option>userlistEnable</option>
is <literal>true</literal>. Meaning see <option>userlistDeny</option>.
+1
nixos/modules/services/search/elasticsearch.nix
···
package = mkOption {
description = "Elasticsearch package to use.";
default = pkgs.elasticsearch;
type = types.package;
};
···
package = mkOption {
description = "Elasticsearch package to use.";
default = pkgs.elasticsearch;
+
defaultText = "pkgs.elasticsearch";
type = types.package;
};
+1
nixos/modules/services/search/kibana.nix
···
package = mkOption {
description = "Kibana package to use";
default = pkgs.kibana;
type = types.package;
};
···
package = mkOption {
description = "Kibana package to use";
default = pkgs.kibana;
+
defaultText = "pkgs.kibana";
type = types.package;
};
+2
nixos/modules/services/search/solr.nix
···
javaPackage = mkOption {
type = types.package;
default = pkgs.jre;
description = ''
Which Java derivation to use for running solr.
'';
···
solrPackage = mkOption {
type = types.package;
default = pkgs.solr;
description = ''
Which solr derivation to use for running solr.
'';
···
javaPackage = mkOption {
type = types.package;
default = pkgs.jre;
+
defaultText = "pkgs.jre";
description = ''
Which Java derivation to use for running solr.
'';
···
solrPackage = mkOption {
type = types.package;
default = pkgs.solr;
+
defaultText = "pkgs.solr";
description = ''
Which solr derivation to use for running solr.
'';
+3 -1
nixos/modules/services/web-servers/apache-httpd/default.nix
···
package = mkOption {
type = types.package;
default = pkgs.apacheHttpd;
description = ''
Overridable attribute of the Apache HTTP Server package to use.
'';
···
configFile = mkOption {
type = types.path;
default = confFile;
-
example = literalExample ''pkgs.writeText "httpd.conf" "# my custom config file ...";'';
description = ''
Override the configuration file used by Apache. By default,
NixOS generates one automatically.
···
package = mkOption {
type = types.package;
default = pkgs.apacheHttpd;
+
defaultText = "pkgs.apacheHttpd";
description = ''
Overridable attribute of the Apache HTTP Server package to use.
'';
···
configFile = mkOption {
type = types.path;
default = confFile;
+
defaultText = "confFile";
+
example = literalExample ''pkgs.writeText "httpd.conf" "# my custom config file ..."'';
description = ''
Override the configuration file used by Apache. By default,
NixOS generates one automatically.
+1
nixos/modules/services/web-servers/nginx/default.nix
···
package = mkOption {
default = pkgs.nginx;
type = types.package;
description = "
Nginx package to use.
···
package = mkOption {
default = pkgs.nginx;
+
defaultText = "pkgs.nginx";
type = types.package;
description = "
Nginx package to use.
+2
nixos/modules/services/web-servers/phpfpm.nix
···
};
phpPackage = mkOption {
default = pkgs.php;
description = ''
The PHP package to use for running the FPM service.
'';
···
};
phpPackage = mkOption {
+
type = types.package;
default = pkgs.php;
+
defaultText = "pkgs.php";
description = ''
The PHP package to use for running the FPM service.
'';
+5
nixos/modules/services/web-servers/tomcat.nix
···
package = mkOption {
type = types.package;
default = pkgs.tomcat7;
example = lib.literalExample "pkgs.tomcat8";
description = ''
Which tomcat package to use.
···
};
webapps = mkOption {
default = [ tomcat ];
description = "List containing WAR files or directories with WAR files which are web applications to be deployed on Tomcat";
};
···
};
jdk = mkOption {
default = pkgs.jdk;
description = "Which JDK to use.";
};
···
package = mkOption {
type = types.package;
default = pkgs.tomcat7;
+
defaultText = "pkgs.tomcat7";
example = lib.literalExample "pkgs.tomcat8";
description = ''
Which tomcat package to use.
···
};
webapps = mkOption {
+
type = types.listOf types.package;
default = [ tomcat ];
+
defaultText = "[ tomcat ]";
description = "List containing WAR files or directories with WAR files which are web applications to be deployed on Tomcat";
};
···
};
jdk = mkOption {
+
type = types.package;
default = pkgs.jdk;
+
defaultText = "pkgs.jdk";
description = "Which JDK to use.";
};
+1
nixos/modules/services/web-servers/winstone.nix
···
javaPackage = mkOption {
type = types.package;
default = pkgs.jre;
description = ''
Which Java derivation to use for running Winstone.
'';
···
javaPackage = mkOption {
type = types.package;
default = pkgs.jre;
+
defaultText = "pkgs.jre";
description = ''
Which Java derivation to use for running Winstone.
'';
+20 -19
nixos/modules/services/web-servers/zope2.nix
···
services.zope2.instances = mkOption {
default = {};
type = types.loaOf types.optionSet;
-
example = {
-
plone01 = {
-
http_address = "127.0.0.1:8080";
-
extra =
-
''
-
<zodb_db main>
-
mount-point /
-
cache-size 30000
-
<blobstorage>
-
blob-dir /var/lib/zope2/plone01/blobstorage
-
<filestorage>
-
path /var/lib/zope2/plone01/filestorage/Data.fs
-
</filestorage>
-
</blobstorage>
-
</zodb_db>
-
'';
-
-
};
-
};
description = "zope2 instances to be created automaticaly by the system.";
options = [ zope2Opts ];
};
···
services.zope2.instances = mkOption {
default = {};
type = types.loaOf types.optionSet;
+
example = literalExample ''
+
{
+
plone01 = {
+
http_address = "127.0.0.1:8080";
+
extra =
+
'''
+
<zodb_db main>
+
mount-point /
+
cache-size 30000
+
<blobstorage>
+
blob-dir /var/lib/zope2/plone01/blobstorage
+
<filestorage>
+
path /var/lib/zope2/plone01/filestorage/Data.fs
+
</filestorage>
+
</blobstorage>
+
</zodb_db>
+
''';
+
};
+
}
+
'';
description = "zope2 instances to be created automaticaly by the system.";
options = [ zope2Opts ];
};
+1
nixos/modules/services/x11/desktop-managers/gnome3.nix
···
};
environment.gnome3.packageSet = mkOption {
default = null;
example = literalExample "pkgs.gnome3_16";
description = "Which GNOME 3 package set to use.";
···
};
environment.gnome3.packageSet = mkOption {
+
type = types.nullOr types.package;
default = null;
example = literalExample "pkgs.gnome3_16";
description = "Which GNOME 3 package set to use.";
+1
nixos/modules/services/x11/desktop-managers/kde4.nix
···
kdeWorkspacePackage = mkOption {
internal = true;
default = pkgs.kde4.kde_workspace;
type = types.package;
description = "Custom kde-workspace, used for NixOS rebranding.";
};
···
kdeWorkspacePackage = mkOption {
internal = true;
default = pkgs.kde4.kde_workspace;
+
defaultText = "pkgs.kde4.kde_workspace";
type = types.package;
description = "Custom kde-workspace, used for NixOS rebranding.";
};
+4 -2
nixos/modules/services/x11/display-managers/lightdm-greeters/gtk.nix
···
theme = {
package = mkOption {
-
type = types.path;
default = pkgs.gnome3.gnome_themes_standard;
description = ''
The package path that contains the theme given in the name option.
'';
···
iconTheme = {
package = mkOption {
-
type = types.path;
default = pkgs.gnome3.defaultIconTheme;
description = ''
The package path that contains the icon theme given in the name option.
'';
···
theme = {
package = mkOption {
+
type = types.package;
default = pkgs.gnome3.gnome_themes_standard;
+
defaultText = "pkgs.gnome3.gnome_themes_standard";
description = ''
The package path that contains the theme given in the name option.
'';
···
iconTheme = {
package = mkOption {
+
type = types.package;
default = pkgs.gnome3.defaultIconTheme;
+
defaultText = "pkgs.gnome3.defaultIconTheme";
description = ''
The package path that contains the icon theme given in the name option.
'';
+2 -1
nixos/modules/services/x11/display-managers/lightdm.nix
···
greeter = {
package = mkOption {
-
type = types.path;
description = ''
The LightDM greeter to login via. The package should be a directory
containing a .desktop file matching the name in the 'name' option.
···
};
background = mkOption {
description = ''
The background image or color to use.
'';
···
greeter = {
package = mkOption {
+
type = types.package;
description = ''
The LightDM greeter to login via. The package should be a directory
containing a .desktop file matching the name in the 'name' option.
···
};
background = mkOption {
+
type = types.path;
description = ''
The background image or color to use.
'';
+4
nixos/modules/services/x11/display-managers/slim.nix
···
url = "https://github.com/jagajaga/nixos-slim-theme/archive/2.0.tar.gz";
sha256 = "0lldizhigx7bjhxkipii87y432hlf5wdvamnfxrryf9z7zkfypc8";
};
example = literalExample ''
pkgs.fetchurl {
url = "mirror://sourceforge/slim.berlios/slim-wave.tar.gz";
···
url = "https://github.com/jagajaga/nixos-slim-theme/archive/2.0.tar.gz";
sha256 = "0lldizhigx7bjhxkipii87y432hlf5wdvamnfxrryf9z7zkfypc8";
};
+
defaultText = ''pkgs.fetchurl {
+
url = "https://github.com/jagajaga/nixos-slim-theme/archive/2.0.tar.gz";
+
sha256 = "0lldizhigx7bjhxkipii87y432hlf5wdvamnfxrryf9z7zkfypc8";
+
}'';
example = literalExample ''
pkgs.fetchurl {
url = "mirror://sourceforge/slim.berlios/slim-wave.tar.gz";
+1
nixos/modules/services/x11/redshift.nix
···
package = mkOption {
type = types.package;
default = pkgs.redshift;
description = ''
redshift derivation to use.
'';
···
package = mkOption {
type = types.package;
default = pkgs.redshift;
+
defaultText = "pkgs.redshift";
description = ''
redshift derivation to use.
'';
+1
nixos/modules/services/x11/window-managers/xmonad.nix
···
services.xserver.windowManager.xmonad = {
enable = mkEnableOption "xmonad";
haskellPackages = mkOption {
default = pkgs.haskellPackages;
defaultText = "pkgs.haskellPackages";
example = literalExample "pkgs.haskell.packages.ghc784";
···
services.xserver.windowManager.xmonad = {
enable = mkEnableOption "xmonad";
haskellPackages = mkOption {
+
type = lib.types.packageSet;
default = pkgs.haskellPackages;
defaultText = "pkgs.haskellPackages";
example = literalExample "pkgs.haskell.packages.ghc784";
+1 -1
nixos/modules/system/activation/top-level.nix
···
system.replaceRuntimeDependencies = mkOption {
default = [];
-
example = lib.literalExample "[ ({ original = pkgs.openssl; replacement = pkgs.callPackage /path/to/openssl { ... }; }) ]";
type = types.listOf (types.submodule (
{ options, ... }: {
options.original = mkOption {
···
system.replaceRuntimeDependencies = mkOption {
default = [];
+
example = lib.literalExample "[ ({ original = pkgs.openssl; replacement = pkgs.callPackage /path/to/openssl { }; }) ]";
type = types.listOf (types.submodule (
{ options, ... }: {
options.original = mkOption {
+2 -1
nixos/modules/system/boot/kernel.nix
···
options = {
boot.kernelPackages = mkOption {
default = pkgs.linuxPackages;
# We don't want to evaluate all of linuxPackages for the manual
# - some of it might not even evaluate correctly.
···
};
boot.extraModulePackages = mkOption {
-
type = types.listOf types.path;
default = [];
example = literalExample "[ pkgs.linuxPackages.nvidia_x11 ]";
description = "A list of additional packages supplying kernel modules.";
···
options = {
boot.kernelPackages = mkOption {
+
type = types.packageSet;
default = pkgs.linuxPackages;
# We don't want to evaluate all of linuxPackages for the manual
# - some of it might not even evaluate correctly.
···
};
boot.extraModulePackages = mkOption {
+
type = types.listOf types.package;
default = [];
example = literalExample "[ pkgs.linuxPackages.nvidia_x11 ]";
description = "A list of additional packages supplying kernel modules.";
+1
nixos/modules/system/boot/loader/grub/grub.nix
···
};
extraFiles = mkOption {
default = {};
example = literalExample ''
{ "memtest.bin" = "''${pkgs.memtest86plus}/memtest.bin"; }
···
};
extraFiles = mkOption {
+
type = types.attrsOf types.path;
default = {};
example = literalExample ''
{ "memtest.bin" = "''${pkgs.memtest86plus}/memtest.bin"; }
+1 -1
nixos/modules/system/boot/loader/grub/ipxe.nix
···
dhcp
chain http://boot.ipxe.org/demo/boot.php
''';
-
};
'';
};
};
···
dhcp
chain http://boot.ipxe.org/demo/boot.php
''';
+
}
'';
};
};
+1 -1
nixos/modules/system/boot/luksroot.nix
···
boot.initrd.luks.devices = mkOption {
default = [ ];
-
example = [ { name = "luksroot"; device = "/dev/sda3"; preLVM = true; } ];
description = ''
The list of devices that should be decrypted using LUKS before trying to mount the
root partition. This works for both LVM-over-LUKS and LUKS-over-LVM setups.
···
boot.initrd.luks.devices = mkOption {
default = [ ];
+
example = literalExample ''[ { name = "luksroot"; device = "/dev/sda3"; preLVM = true; } ]'';
description = ''
The list of devices that should be decrypted using LUKS before trying to mount the
root partition. This works for both LVM-over-LUKS and LUKS-over-LVM setups.
+1
nixos/modules/system/boot/systemd.nix
···
systemd.package = mkOption {
default = pkgs.systemd;
type = types.package;
description = "The systemd package.";
};
···
systemd.package = mkOption {
default = pkgs.systemd;
+
defaultText = "pkgs.systemd";
type = types.package;
description = "The systemd package.";
};
+2
nixos/modules/tasks/network-interfaces.nix
···
};
networking.nameservers = mkOption {
default = [];
example = ["130.161.158.4" "130.161.33.17"];
description = ''
···
};
networking.localCommands = mkOption {
default = "";
example = "text=anything; echo You can put $text here.";
description = ''
···
};
networking.nameservers = mkOption {
+
type = types.listOf types.str;
default = [];
example = ["130.161.158.4" "130.161.33.17"];
description = ''
···
};
networking.localCommands = mkOption {
+
type = types.str;
default = "";
example = "text=anything; echo You can put $text here.";
description = ''
+1
nixos/modules/virtualisation/openvswitch.nix
···
package = mkOption {
type = types.package;
default = pkgs.openvswitch;
description = ''
Open vSwitch package to use.
'';
···
package = mkOption {
type = types.package;
default = pkgs.openvswitch;
+
defaultText = "pkgs.openvswitch";
description = ''
Open vSwitch package to use.
'';