diff options
author | Vladimír Čunát <vcunat@gmail.com> | 2017-03-18 10:57:37 +0100 |
---|---|---|
committer | Vladimír Čunát <vcunat@gmail.com> | 2017-03-18 11:00:31 +0100 |
commit | 742b120ddc77bfbd1fc489cdd743974a80699eda (patch) | |
tree | 9cfd7886f7304b7044ba998b8a3031011a7ed86a /nixos/modules/services | |
parent | 7ff6eec5fd80ece0d634f1353c96f6ba4fb11ec6 (diff) | |
parent | 553964ca7120c6341a58f84c60f6e6eaa2c43bb3 (diff) | |
download | nixlib-742b120ddc77bfbd1fc489cdd743974a80699eda.tar nixlib-742b120ddc77bfbd1fc489cdd743974a80699eda.tar.gz nixlib-742b120ddc77bfbd1fc489cdd743974a80699eda.tar.bz2 nixlib-742b120ddc77bfbd1fc489cdd743974a80699eda.tar.lz nixlib-742b120ddc77bfbd1fc489cdd743974a80699eda.tar.xz nixlib-742b120ddc77bfbd1fc489cdd743974a80699eda.tar.zst nixlib-742b120ddc77bfbd1fc489cdd743974a80699eda.zip |
Merge branch 'master' into staging
Nontrivial rebuilds from master, again :-/
Diffstat (limited to 'nixos/modules/services')
43 files changed, 228 insertions, 76 deletions
diff --git a/nixos/modules/services/backup/rsnapshot.nix b/nixos/modules/services/backup/rsnapshot.nix index 16815bcc8605..bb5dcab1dcf2 100644 --- a/nixos/modules/services/backup/rsnapshot.nix +++ b/nixos/modules/services/backup/rsnapshot.nix @@ -26,7 +26,6 @@ in enableManualRsnapshot = mkOption { description = "Whether to enable manual usage of the rsnapshot command with this module."; default = true; - example = false; type = types.bool; }; diff --git a/nixos/modules/services/computing/boinc/client.nix b/nixos/modules/services/computing/boinc/client.nix index 91bd463732de..e43b6bbb2536 100644 --- a/nixos/modules/services/computing/boinc/client.nix +++ b/nixos/modules/services/computing/boinc/client.nix @@ -12,7 +12,6 @@ in enable = mkOption { type = types.bool; default = false; - example = true; description = '' Whether to enable the BOINC distributed computing client. If this option is set to true, the boinc_client daemon will be run as a @@ -41,7 +40,6 @@ in allowRemoteGuiRpc = mkOption { type = types.bool; default = false; - example = true; description = '' If set to true, any remote host can connect to and control this BOINC client (subject to password authentication). If instead set to false, diff --git a/nixos/modules/services/databases/cassandra.nix b/nixos/modules/services/databases/cassandra.nix index b43b448ed7e1..5df4ae57f809 100644 --- a/nixos/modules/services/databases/cassandra.nix +++ b/nixos/modules/services/databases/cassandra.nix @@ -310,7 +310,6 @@ in { autoBootstrap = mkOption { description = "It makes new (non-seed) nodes automatically migrate the right data to themselves."; default = true; - example = true; type = types.bool; }; streamingSocketTimoutInMS = mkOption { diff --git a/nixos/modules/services/databases/couchdb.nix b/nixos/modules/services/databases/couchdb.nix index d4d231456c52..52247bfb983e 100644 --- a/nixos/modules/services/databases/couchdb.nix +++ b/nixos/modules/services/databases/couchdb.nix @@ -4,20 +4,29 @@ with lib; let cfg = config.services.couchdb; - configFile = pkgs.writeText "couchdb.ini" + useVersion2 = strings.versionAtLeast (strings.getVersion cfg.package) "2.0"; + configFile = pkgs.writeText "couchdb.ini" ( '' [couchdb] database_dir = ${cfg.databaseDir} uri_file = ${cfg.uriFile} view_index_dir = ${cfg.viewIndexDir} - + '' + (if useVersion2 then + '' + [chttpd] + '' else + '' [httpd] + '') + + '' port = ${toString cfg.port} bind_address = ${cfg.bindAddress} [log] file = ${cfg.logFile} - ''; + ''); + executable = if useVersion2 then "${cfg.package}/bin/couchdb" + else ''${cfg.package}/bin/couchdb -a ${configFile} -a ${pkgs.writeText "couchdb-extra.ini" cfg.extraConfig} -a ${cfg.configFile}''; in { @@ -130,7 +139,6 @@ in { configFile = mkOption { type = types.string; - default = "/var/lib/couchdb/couchdb.ini"; description = '' Configuration file for persisting runtime changes. File needs to be readable and writable from couchdb user/group. @@ -147,6 +155,9 @@ in { environment.systemPackages = [ cfg.package ]; + services.couchdb.configFile = mkDefault + (if useVersion2 then "/var/lib/couchdb/local.ini" else "/var/lib/couchdb/couchdb.ini"); + systemd.services.couchdb = { description = "CouchDB Server"; wantedBy = [ "multi-user.target" ]; @@ -170,11 +181,20 @@ in { fi ''; + environment = mkIf useVersion2 { + # we are actually specifying 4 configuration files: + # 1. the preinstalled default.ini + # 2. the module configuration + # 3. the extraConfig from the module options + # 4. the locally writable config file, which couchdb itself writes to + ERL_FLAGS= ''-couch_ini ${cfg.package}/etc/default.ini ${configFile} ${pkgs.writeText "couchdb-extra.ini" cfg.extraConfig} ${cfg.configFile}''; + }; + serviceConfig = { PermissionsStartOnly = true; User = cfg.user; Group = cfg.group; - ExecStart = "${cfg.package}/bin/couchdb -a ${configFile} -a ${pkgs.writeText "couchdb-extra.ini" cfg.extraConfig} -a ${cfg.configFile}"; + ExecStart = executable; }; }; diff --git a/nixos/modules/services/databases/neo4j.nix b/nixos/modules/services/databases/neo4j.nix index cbba9c2a691c..205c8dc610ac 100644 --- a/nixos/modules/services/databases/neo4j.nix +++ b/nixos/modules/services/databases/neo4j.nix @@ -130,6 +130,7 @@ in { ExecStart = "${cfg.package}/bin/neo4j console"; User = "neo4j"; PermissionsStartOnly = true; + LimitNOFILE = 40000; }; preStart = '' mkdir -m 0700 -p ${cfg.dataDir}/{data/graph.db,conf,logs} diff --git a/nixos/modules/services/databases/openldap.nix b/nixos/modules/services/databases/openldap.nix index d76859bf3eb6..e884098cb08d 100644 --- a/nixos/modules/services/databases/openldap.nix +++ b/nixos/modules/services/databases/openldap.nix @@ -25,7 +25,6 @@ in description = " Whether to enable the ldap server. "; - example = true; }; user = mkOption { diff --git a/nixos/modules/services/editors/emacs.nix b/nixos/modules/services/editors/emacs.nix index 08fa6de6374c..2c5a0c4849ef 100644 --- a/nixos/modules/services/editors/emacs.nix +++ b/nixos/modules/services/editors/emacs.nix @@ -21,7 +21,6 @@ in { enable = mkOption { type = types.bool; default = false; - example = true; description = '' Whether to enable a user service for the Emacs daemon. Use <literal>emacsclient</literal> to connect to the daemon. If <literal>true</literal>, <varname>services.emacs.install</varname> is @@ -32,7 +31,6 @@ in { install = mkOption { type = types.bool; default = false; - example = true; description = '' Whether to install a user service for the Emacs daemon. Once the service is started, use emacsclient to connect to the @@ -57,7 +55,6 @@ in { defaultEditor = mkOption { type = types.bool; default = false; - example = true; description = '' When enabled, configures emacsclient to be the default editor using the EDITOR environment variable. diff --git a/nixos/modules/services/mail/mlmmj.nix b/nixos/modules/services/mail/mlmmj.nix index e2b37522cb16..4a01745eb8b6 100644 --- a/nixos/modules/services/mail/mlmmj.nix +++ b/nixos/modules/services/mail/mlmmj.nix @@ -18,7 +18,7 @@ let footer = domain: list: "To unsubscribe send a mail to ${list}+unsubscribe@${domain}"; createList = d: l: '' ${pkgs.coreutils}/bin/mkdir -p ${listCtl d l} - echo ${listAddress d l} > ${listCtl d l}/listadress + echo ${listAddress d l} > ${listCtl d l}/listaddress echo "${lib.concatStringsSep "\n" (customHeaders d l)}" > ${listCtl d l}/customheaders echo ${footer d l} > ${listCtl d l}/footer echo ${subjectPrefix l} > ${listCtl d l}/prefix diff --git a/nixos/modules/services/mail/offlineimap.nix b/nixos/modules/services/mail/offlineimap.nix index 85ece020905b..4b24bd8d0813 100644 --- a/nixos/modules/services/mail/offlineimap.nix +++ b/nixos/modules/services/mail/offlineimap.nix @@ -12,7 +12,6 @@ in { install = mkOption { type = types.bool; default = false; - example = true; description = '' Whether to install a user service for Offlineimap. Once the service is started, emails will be fetched automatically. diff --git a/nixos/modules/services/misc/ihaskell.nix b/nixos/modules/services/misc/ihaskell.nix index df7b9be0db50..e07a4a44613a 100644 --- a/nixos/modules/services/misc/ihaskell.nix +++ b/nixos/modules/services/misc/ihaskell.nix @@ -16,7 +16,6 @@ in services.ihaskell = { enable = mkOption { default = false; - example = true; description = "Autostart an IHaskell notebook service."; }; diff --git a/nixos/modules/services/misc/irkerd.nix b/nixos/modules/services/misc/irkerd.nix new file mode 100644 index 000000000000..993d77ba424c --- /dev/null +++ b/nixos/modules/services/misc/irkerd.nix @@ -0,0 +1,67 @@ +{ config, lib, pkgs, ... }: + +with lib; + +let + cfg = config.services.irkerd; + ports = [ 6659 ]; +in +{ + options.services.irkerd = { + enable = mkOption { + description = "Whether to enable irker, an IRC notification daemon."; + default = false; + type = types.bool; + }; + + openPorts = mkOption { + description = "Open ports in the firewall for irkerd"; + default = false; + type = types.bool; + }; + + listenAddress = mkOption { + default = "localhost"; + example = "0.0.0.0"; + type = types.str; + description = '' + Specifies the bind address on which the irker daemon listens. + The default is localhost. + + Irker authors strongly warn about the risks of running this on + a publicly accessible interface, so change this with caution. + ''; + }; + + nick = mkOption { + default = "irker"; + type = types.str; + description = "Nick to use for irker"; + }; + }; + + config = mkIf cfg.enable { + systemd.services.irkerd = { + description = "Internet Relay Chat (IRC) notification daemon"; + documentation = [ "man:irkerd(8)" "man:irkerhook(1)" "man:irk(1)" ]; + after = [ "network.target" ]; + wantedBy = [ "multi-user.target" ]; + serviceConfig = { + ExecStart = "${pkgs.irker}/bin/irkerd -H ${cfg.listenAddress} -n ${cfg.nick}"; + User = "irkerd"; + }; + }; + + environment.systemPackages = [ pkgs.irker ]; + + users.users.irkerd = { + description = "Irker daemon user"; + isSystemUser = true; + group = "irkerd"; + }; + users.groups.irkerd = {}; + + networking.firewall.allowedTCPPorts = mkIf cfg.openPorts ports; + networking.firewall.allowedUDPPorts = mkIf cfg.openPorts ports; + }; +} diff --git a/nixos/modules/services/misc/taskserver/default.nix b/nixos/modules/services/misc/taskserver/default.nix index 826f463bbd75..ba9f52f1904b 100644 --- a/nixos/modules/services/misc/taskserver/default.nix +++ b/nixos/modules/services/misc/taskserver/default.nix @@ -148,7 +148,6 @@ in { enable = mkOption { type = types.bool; default = false; - example = true; description = '' Whether to enable the Taskwarrior server. diff --git a/nixos/modules/services/monitoring/arbtt.nix b/nixos/modules/services/monitoring/arbtt.nix index 1135c2c441cb..a8d5e3b7fa07 100644 --- a/nixos/modules/services/monitoring/arbtt.nix +++ b/nixos/modules/services/monitoring/arbtt.nix @@ -10,7 +10,6 @@ in { enable = mkOption { type = types.bool; default = false; - example = true; description = '' Enable the arbtt statistics capture service. ''; diff --git a/nixos/modules/services/monitoring/prometheus/unifi-exporter.nix b/nixos/modules/services/monitoring/prometheus/unifi-exporter.nix new file mode 100644 index 000000000000..e3059e485098 --- /dev/null +++ b/nixos/modules/services/monitoring/prometheus/unifi-exporter.nix @@ -0,0 +1,104 @@ +{ config, pkgs, lib, ... }: + +with lib; + +let + cfg = config.services.prometheus.unifiExporter; +in { + options = { + services.prometheus.unifiExporter = { + enable = mkEnableOption "prometheus unifi exporter"; + + port = mkOption { + type = types.int; + default = 9130; + description = '' + Port to listen on. + ''; + }; + + unifiAddress = mkOption { + type = types.str; + example = "https://10.0.0.1:8443"; + description = '' + URL of the UniFi Controller API. + ''; + }; + + unifiInsecure = mkOption { + type = types.bool; + default = false; + description = '' + If enabled skip the verification of the TLS certificate of the UniFi Controller API. + Use with caution. + ''; + }; + + unifiUsername = mkOption { + type = types.str; + example = "ReadOnlyUser"; + description = '' + username for authentication against UniFi Controller API. + ''; + }; + + unifiPassword = mkOption { + type = types.str; + description = '' + Password for authentication against UniFi Controller API. + ''; + }; + + unifiTimeout = mkOption { + type = types.str; + default = "5s"; + example = "2m"; + description = '' + Timeout including unit for UniFi Controller API requests. + ''; + }; + + extraFlags = mkOption { + type = types.listOf types.str; + default = []; + description = '' + Extra commandline options when launching the unifi exporter. + ''; + }; + + openFirewall = mkOption { + type = types.bool; + default = false; + description = '' + Open port in firewall for incoming connections. + ''; + }; + }; + }; + + config = mkIf cfg.enable { + networking.firewall.allowedTCPPorts = optional cfg.openFirewall cfg.port; + + systemd.services.prometheus-unifi-exporter = { + description = "Prometheus exporter for UniFi Controller metrics"; + unitConfig.Documentation = "https://github.com/mdlayher/unifi_exporter"; + wantedBy = [ "multi-user.target" ]; + serviceConfig = { + User = "nobody"; + Restart = "always"; + PrivateTmp = true; + WorkingDirectory = /tmp; + ExecStart = '' + ${pkgs.prometheus-unifi-exporter}/bin/unifi_exporter \ + -telemetry.addr :${toString cfg.port} \ + -unifi.addr ${cfg.unifiAddress} \ + -unifi.username ${cfg.unifiUsername} \ + -unifi.password ${cfg.unifiPassword} \ + -unifi.timeout ${cfg.unifiTimeout} \ + ${optionalString cfg.unifiInsecure "-unifi.insecure" } \ + ${concatStringsSep " \\\n " cfg.extraFlags} + ''; + }; + }; + }; +} diff --git a/nixos/modules/services/networking/aiccu.nix b/nixos/modules/services/networking/aiccu.nix index 4301da288814..aeb0910d6246 100644 --- a/nixos/modules/services/networking/aiccu.nix +++ b/nixos/modules/services/networking/aiccu.nix @@ -35,7 +35,6 @@ in { enable = mkOption { type = types.bool; default = false; - example = true; description = "Enable aiccu IPv6 over IPv4 SiXXs tunnel"; }; @@ -88,21 +87,18 @@ in { verbose = mkOption { type = types.bool; default = false; - example = true; description = "Be verbose?"; }; automatic = mkOption { type = types.bool; default = true; - example = false; description = "Automatic Login and Tunnel activation"; }; requireTLS = mkOption { type = types.bool; default = false; - example = true; description = '' When set to true, if TLS is not supported on the server the TIC transaction will fail. @@ -124,7 +120,6 @@ in { defaultRoute = mkOption { type = types.bool; default = true; - example = false; description = "Add a default route"; }; @@ -138,7 +133,6 @@ in { makeHeartBeats = mkOption { type = types.bool; default = true; - example = false; description = '' In general you don't want to turn this off Of course only applies to AYIYA and heartbeat tunnels not to static ones @@ -148,21 +142,18 @@ in { noConfigure = mkOption { type = types.bool; default = false; - example = true; description = "Don't configure anything"; }; behindNAT = mkOption { type = types.bool; default = false; - example = true; description = "Notify the user that a NAT-kind network is detected"; }; localIPv4Override = mkOption { type = types.bool; default = false; - example = true; description = '' Overrides the IPv4 parameter received from TIC This allows one to configure a NAT into "DMZ" mode and then diff --git a/nixos/modules/services/networking/ferm.nix b/nixos/modules/services/networking/ferm.nix index 8933e166f59f..07338ccf4d9c 100644 --- a/nixos/modules/services/networking/ferm.nix +++ b/nixos/modules/services/networking/ferm.nix @@ -19,7 +19,6 @@ in { services.ferm = { enable = mkOption { default = false; - example = true; type = types.bool; description = '' Whether to enable Ferm Firewall. diff --git a/nixos/modules/services/networking/firefox/sync-server.nix b/nixos/modules/services/networking/firefox/sync-server.nix index 70d2d72ca8b7..5c14ceff6a0d 100644 --- a/nixos/modules/services/networking/firefox/sync-server.nix +++ b/nixos/modules/services/networking/firefox/sync-server.nix @@ -33,7 +33,6 @@ in enable = mkOption { type = types.bool; default = false; - example = true; description = '' Whether to enable a Firefox Sync Server, this give the opportunity to Firefox users to store all synchronized data on their own server. To use this @@ -78,7 +77,6 @@ in allowNewUsers = mkOption { type = types.bool; default = true; - example = false; description = '' Whether to allow new-user signups on the server. Only request by existing accounts will be honored. diff --git a/nixos/modules/services/networking/mosquitto.nix b/nixos/modules/services/networking/mosquitto.nix index f926cd710c8d..2325424ff3c5 100644 --- a/nixos/modules/services/networking/mosquitto.nix +++ b/nixos/modules/services/networking/mosquitto.nix @@ -147,7 +147,6 @@ in allowAnonymous = mkOption { default = false; - example = true; type = types.bool; description = '' Allow clients to connect without authentication. diff --git a/nixos/modules/services/networking/quagga.nix b/nixos/modules/services/networking/quagga.nix index ac83da920638..aab58cc77b90 100644 --- a/nixos/modules/services/networking/quagga.nix +++ b/nixos/modules/services/networking/quagga.nix @@ -104,7 +104,6 @@ in enable = mkOption { type = types.bool; default = any isEnabled services; - example = true; description = '' Whether to enable the Zebra routing manager. diff --git a/nixos/modules/services/networking/znc.nix b/nixos/modules/services/networking/znc.nix index 0d41e3ea92ce..6d68b790e869 100644 --- a/nixos/modules/services/networking/znc.nix +++ b/nixos/modules/services/networking/znc.nix @@ -132,7 +132,6 @@ in services.znc = { enable = mkOption { default = false; - example = true; type = types.bool; description = '' Enable a ZNC service for a user. @@ -251,7 +250,6 @@ in useSSL = mkOption { default = true; - example = true; type = types.bool; description = '' Indicates whether the ZNC server should use SSL when listening on the specified port. A self-signed certificate will be generated. @@ -278,7 +276,6 @@ in mutable = mkOption { default = false; - example = true; type = types.bool; description = '' Indicates whether to allow the contents of the `dataDir` directory to be changed diff --git a/nixos/modules/services/scheduling/cron.nix b/nixos/modules/services/scheduling/cron.nix index 6eb277d0a2f2..7b1a1599e141 100644 --- a/nixos/modules/services/scheduling/cron.nix +++ b/nixos/modules/services/scheduling/cron.nix @@ -39,7 +39,7 @@ in enable = mkOption { type = types.bool; - example = true; + default = false; description = "Whether to enable the Vixie cron daemon."; }; diff --git a/nixos/modules/services/security/haka.nix b/nixos/modules/services/security/haka.nix index f48a79b1f7f1..b64a1b4d03e0 100644 --- a/nixos/modules/services/security/haka.nix +++ b/nixos/modules/services/security/haka.nix @@ -99,7 +99,6 @@ in pcap = mkOption { default = true; - example = false; type = types.bool; description = "Whether to enable pcap"; }; diff --git a/nixos/modules/services/security/tor.nix b/nixos/modules/services/security/tor.nix index 47f863b96df2..3b4d77a6f7b1 100644 --- a/nixos/modules/services/security/tor.nix +++ b/nixos/modules/services/security/tor.nix @@ -12,6 +12,10 @@ let torRc = '' User tor DataDirectory ${torDirectory} + ${optionalString cfg.enableGeoIP '' + GeoIPFile ${pkgs.tor.geoip}/share/tor/geoip + GeoIPv6File ${pkgs.tor.geoip}/share/tor/geoip6 + ''} ${optint "ControlPort" cfg.controlPort} '' @@ -58,6 +62,18 @@ in ''; }; + enableGeoIP = mkOption { + type = types.bool; + default = true; + description = '' + Whenever to configure Tor daemon to use GeoIP databases. + + Disabling this will disable by-country statistics for + bridges and relays and some client and third-party software + functionality. + ''; + }; + extraConfig = mkOption { type = types.lines; default = ""; diff --git a/nixos/modules/services/security/torify.nix b/nixos/modules/services/security/torify.nix index a81cdbbc172f..a29cb3f33dae 100644 --- a/nixos/modules/services/security/torify.nix +++ b/nixos/modules/services/security/torify.nix @@ -19,15 +19,23 @@ in { ###### interface - + options = { - + services.tor.tsocks = { enable = mkOption { - default = cfg.enable && cfg.client.enable; + default = false; description = '' - Whether to build tsocks wrapper script to relay application traffic via TOR. + Whether to build tsocks wrapper script to relay application traffic via Tor. + + <important> + <para>You shouldn't use this unless you know what you're + doing because your installation of Tor already comes with + its own superior (doesn't leak DNS queries) + <literal>torsocks</literal> wrapper which does pretty much + exactly the same thing as this.</para> + </important> ''; }; diff --git a/nixos/modules/services/torrent/deluge.nix b/nixos/modules/services/torrent/deluge.nix index a9c08b66eb82..2534f09b555a 100644 --- a/nixos/modules/services/torrent/deluge.nix +++ b/nixos/modules/services/torrent/deluge.nix @@ -13,7 +13,6 @@ in { deluge = { enable = mkOption { default = false; - example = true; description = "Start the Deluge daemon"; }; @@ -29,7 +28,6 @@ in { deluge.web = { enable = mkOption { default = false; - example = true; description = '' Start Deluge Web daemon. ''; diff --git a/nixos/modules/services/web-apps/atlassian/crowd.nix b/nixos/modules/services/web-apps/atlassian/crowd.nix index ada26f8057ba..7ff7dc4e5748 100644 --- a/nixos/modules/services/web-apps/atlassian/crowd.nix +++ b/nixos/modules/services/web-apps/atlassian/crowd.nix @@ -88,7 +88,6 @@ in secure = mkOption { type = types.bool; default = true; - example = false; description = "Whether the connections to the proxy should be considered secure."; }; }; diff --git a/nixos/modules/services/web-apps/atlassian/jira.nix b/nixos/modules/services/web-apps/atlassian/jira.nix index 6e31d20d0681..0ab94d95eee8 100644 --- a/nixos/modules/services/web-apps/atlassian/jira.nix +++ b/nixos/modules/services/web-apps/atlassian/jira.nix @@ -78,7 +78,6 @@ in secure = mkOption { type = types.bool; default = true; - example = false; description = "Whether the connections to the proxy should be considered secure."; }; }; diff --git a/nixos/modules/services/web-servers/caddy.nix b/nixos/modules/services/web-servers/caddy.nix index a49838c876f9..eec285f6bc44 100644 --- a/nixos/modules/services/web-servers/caddy.nix +++ b/nixos/modules/services/web-servers/caddy.nix @@ -29,7 +29,6 @@ in agree = mkOption { default = false; - example = true; type = types.bool; description = "Agree to Let's Encrypt Subscriber Agreement"; }; diff --git a/nixos/modules/services/web-servers/jboss/default.nix b/nixos/modules/services/web-servers/jboss/default.nix index 583fe56eb5e2..d28724281a83 100644 --- a/nixos/modules/services/web-servers/jboss/default.nix +++ b/nixos/modules/services/web-servers/jboss/default.nix @@ -25,7 +25,7 @@ in enable = mkOption { default = false; - description = "Whether to enable jboss"; + description = "Whether to enable JBoss. WARNING : this package is outdated and is known to have vulnerabilities."; }; tempDir = mkOption { diff --git a/nixos/modules/services/x11/compton.nix b/nixos/modules/services/x11/compton.nix index 7cbca1dcddfd..d1f7f164e641 100644 --- a/nixos/modules/services/x11/compton.nix +++ b/nixos/modules/services/x11/compton.nix @@ -43,7 +43,6 @@ in { enable = mkOption { type = types.bool; default = false; - example = true; description = '' Whether of not to enable Compton as the X.org composite manager. ''; @@ -52,7 +51,6 @@ in { fade = mkOption { type = types.bool; default = false; - example = true; description = '' Fade windows in and out. ''; @@ -93,7 +91,6 @@ in { shadow = mkOption { type = types.bool; default = false; - example = true; description = '' Draw window shadows. ''; diff --git a/nixos/modules/services/x11/desktop-managers/enlightenment.nix b/nixos/modules/services/x11/desktop-managers/enlightenment.nix index d908553ccdf8..38e24e9b709a 100644 --- a/nixos/modules/services/x11/desktop-managers/enlightenment.nix +++ b/nixos/modules/services/x11/desktop-managers/enlightenment.nix @@ -20,7 +20,6 @@ in services.xserver.desktopManager.enlightenment.enable = mkOption { default = false; - example = true; description = "Enable the Enlightenment desktop environment."; }; diff --git a/nixos/modules/services/x11/desktop-managers/gnome3.nix b/nixos/modules/services/x11/desktop-managers/gnome3.nix index 21453d1917e8..a1790ccd675c 100644 --- a/nixos/modules/services/x11/desktop-managers/gnome3.nix +++ b/nixos/modules/services/x11/desktop-managers/gnome3.nix @@ -53,7 +53,6 @@ in { services.xserver.desktopManager.gnome3 = { enable = mkOption { default = false; - example = true; description = "Enable Gnome 3 desktop manager."; }; diff --git a/nixos/modules/services/x11/desktop-managers/kodi.nix b/nixos/modules/services/x11/desktop-managers/kodi.nix index de00ff93b17c..3ce49b9d2bf8 100644 --- a/nixos/modules/services/x11/desktop-managers/kodi.nix +++ b/nixos/modules/services/x11/desktop-managers/kodi.nix @@ -11,7 +11,6 @@ in services.xserver.desktopManager.kodi = { enable = mkOption { default = false; - example = true; description = "Enable the kodi multimedia center."; }; }; diff --git a/nixos/modules/services/x11/desktop-managers/xterm.nix b/nixos/modules/services/x11/desktop-managers/xterm.nix index eab914071410..29752ff405e2 100644 --- a/nixos/modules/services/x11/desktop-managers/xterm.nix +++ b/nixos/modules/services/x11/desktop-managers/xterm.nix @@ -13,7 +13,6 @@ in services.xserver.desktopManager.xterm.enable = mkOption { default = true; - example = false; description = "Enable a xterm terminal as a desktop manager."; }; diff --git a/nixos/modules/services/x11/hardware/libinput.nix b/nixos/modules/services/x11/hardware/libinput.nix index b358550ba41d..d75c785270b3 100644 --- a/nixos/modules/services/x11/hardware/libinput.nix +++ b/nixos/modules/services/x11/hardware/libinput.nix @@ -73,7 +73,6 @@ in { clickMethod = mkOption { type = types.nullOr (types.enum [ "none" "buttonareas" "clickfinger" ]); default = null; - example = "none"; description = '' Enables a click method. Permitted values are none, buttonareas, clickfinger. @@ -85,14 +84,12 @@ in { leftHanded = mkOption { type = types.bool; default = false; - example = true; description = "Enables left-handed button orientation, i.e. swapping left and right buttons."; }; middleEmulation = mkOption { type = types.bool; default = true; - example = false; description = '' Enables middle button emulation. When enabled, pressing the left and right buttons @@ -103,7 +100,6 @@ in { naturalScrolling = mkOption { type = types.bool; default = false; - example = true; description = "Enables or disables natural scrolling behavior."; }; @@ -131,7 +127,6 @@ in { horizontalScrolling = mkOption { type = types.bool; default = true; - example = false; description = '' Disables horizontal scrolling. When disabled, this driver will discard any horizontal scroll @@ -153,7 +148,6 @@ in { tapping = mkOption { type = types.bool; default = true; - example = false; description = '' Enables or disables tap-to-click behavior. @@ -163,7 +157,6 @@ in { tappingDragLock = mkOption { type = types.bool; default = true; - example = false; description = '' Enables or disables drag lock during tapping behavior. When enabled, a finger up during tap- @@ -175,7 +168,6 @@ in { disableWhileTyping = mkOption { type = types.bool; default = true; - example = false; description = '' Disable input method while typing. diff --git a/nixos/modules/services/x11/hardware/multitouch.nix b/nixos/modules/services/x11/hardware/multitouch.nix index f8386b5e333b..0e9eb0214947 100644 --- a/nixos/modules/services/x11/hardware/multitouch.nix +++ b/nixos/modules/services/x11/hardware/multitouch.nix @@ -18,20 +18,17 @@ in { enable = mkOption { default = false; - example = true; description = "Whether to enable multitouch touchpad support."; }; invertScroll = mkOption { default = false; - example = true; type = types.bool; description = "Whether to invert scrolling direction à la OSX Lion"; }; ignorePalm = mkOption { default = false; - example = true; type = types.bool; description = "Whether to ignore touches detected as being the palm (i.e when typing)"; }; @@ -39,7 +36,6 @@ in { tapButtons = mkOption { type = types.bool; default = true; - example = false; description = "Whether to enable tap buttons."; }; diff --git a/nixos/modules/services/x11/hardware/synaptics.nix b/nixos/modules/services/x11/hardware/synaptics.nix index 2a7f4e5cbcd1..54454c736c1d 100644 --- a/nixos/modules/services/x11/hardware/synaptics.nix +++ b/nixos/modules/services/x11/hardware/synaptics.nix @@ -29,7 +29,6 @@ in { enable = mkOption { type = types.bool; default = false; - example = true; description = "Whether to enable touchpad support."; }; @@ -102,7 +101,6 @@ in { tapButtons = mkOption { type = types.bool; default = true; - example = false; description = "Whether to enable tap buttons."; }; @@ -125,7 +123,6 @@ in { palmDetect = mkOption { type = types.bool; default = false; - example = true; description = "Whether to enable palm detection (hardware support required)"; }; @@ -146,7 +143,6 @@ in { horizontalScroll = mkOption { type = types.bool; default = true; - example = false; description = "Whether to enable horizontal scrolling (on touchpad)"; }; diff --git a/nixos/modules/services/x11/redshift.nix b/nixos/modules/services/x11/redshift.nix index 78a97df98775..eb5dfdf95849 100644 --- a/nixos/modules/services/x11/redshift.nix +++ b/nixos/modules/services/x11/redshift.nix @@ -12,7 +12,6 @@ in { enable = mkOption { type = types.bool; default = false; - example = true; description = '' Enable Redshift to change your screen's colour temperature depending on the time of day. diff --git a/nixos/modules/services/x11/unclutter-xfixes.nix b/nixos/modules/services/x11/unclutter-xfixes.nix index bd02c5ed9895..b94dfb1a26a6 100644 --- a/nixos/modules/services/x11/unclutter-xfixes.nix +++ b/nixos/modules/services/x11/unclutter-xfixes.nix @@ -11,7 +11,6 @@ in { description = "Enable unclutter-xfixes to hide your mouse cursor when inactive."; type = types.bool; default = false; - example = true; }; package = mkOption { diff --git a/nixos/modules/services/x11/unclutter.nix b/nixos/modules/services/x11/unclutter.nix index ebc195d108d0..6c789b7578fa 100644 --- a/nixos/modules/services/x11/unclutter.nix +++ b/nixos/modules/services/x11/unclutter.nix @@ -11,7 +11,6 @@ in { description = "Enable unclutter to hide your mouse cursor when inactive"; type = types.bool; default = false; - example = true; }; package = mkOption { diff --git a/nixos/modules/services/x11/urxvtd.nix b/nixos/modules/services/x11/urxvtd.nix index be36efaa5897..57ad93f20174 100644 --- a/nixos/modules/services/x11/urxvtd.nix +++ b/nixos/modules/services/x11/urxvtd.nix @@ -11,7 +11,6 @@ in { options.services.urxvtd.enable = mkOption { type = types.bool; default = false; - example = true; description = '' Enable urxvtd, the urxvt terminal daemon. To use urxvtd, run "urxvtc". diff --git a/nixos/modules/services/x11/window-managers/exwm.nix b/nixos/modules/services/x11/window-managers/exwm.nix index dbbd8a125d66..dc1d957c1709 100644 --- a/nixos/modules/services/x11/window-managers/exwm.nix +++ b/nixos/modules/services/x11/window-managers/exwm.nix @@ -21,7 +21,6 @@ in enable = mkEnableOption "exwm"; enableDefaultConfig = mkOption { default = true; - example = false; type = lib.types.bool; description = "Enable an uncustomised exwm configuration."; }; diff --git a/nixos/modules/services/x11/window-managers/xmonad.nix b/nixos/modules/services/x11/window-managers/xmonad.nix index 6af88d4f645b..e25a8ae22823 100644 --- a/nixos/modules/services/x11/window-managers/xmonad.nix +++ b/nixos/modules/services/x11/window-managers/xmonad.nix @@ -44,7 +44,6 @@ in enableContribAndExtras = mkOption { default = false; - example = true; type = lib.types.bool; description = "Enable xmonad-{contrib,extras} in Xmonad."; }; |