diff options
Diffstat (limited to 'nixos/modules/services/search')
| -rw-r--r-- | nixos/modules/services/search/elasticsearch-curator.nix | 8 | ||||
| -rw-r--r-- | nixos/modules/services/search/elasticsearch.nix | 28 | ||||
| -rw-r--r-- | nixos/modules/services/search/hound.nix | 16 | ||||
| -rw-r--r-- | nixos/modules/services/search/kibana.nix | 40 | ||||
| -rw-r--r-- | nixos/modules/services/search/meilisearch.nix | 16 | ||||
| -rw-r--r-- | nixos/modules/services/search/solr.nix | 12 |
6 files changed, 60 insertions, 60 deletions
diff --git a/nixos/modules/services/search/elasticsearch-curator.nix b/nixos/modules/services/search/elasticsearch-curator.nix index bb2612322bbad..da3b0dc9d7135 100644 --- a/nixos/modules/services/search/elasticsearch-curator.nix +++ b/nixos/modules/services/search/elasticsearch-curator.nix @@ -39,22 +39,22 @@ in { enable = mkEnableOption "elasticsearch curator"; interval = mkOption { - description = "The frequency to run curator, a systemd.time such as 'hourly'"; + description = lib.mdDoc "The frequency to run curator, a systemd.time such as 'hourly'"; default = "hourly"; type = types.str; }; hosts = mkOption { - description = "a list of elasticsearch hosts to connect to"; + description = lib.mdDoc "a list of elasticsearch hosts to connect to"; type = types.listOf types.str; default = ["localhost"]; }; port = mkOption { - description = "the port that elasticsearch is listening on"; + description = lib.mdDoc "the port that elasticsearch is listening on"; type = types.int; default = 9200; }; actionYAML = mkOption { - description = "curator action.yaml file contents, alternatively use curator-cli which takes a simple action command"; + description = lib.mdDoc "curator action.yaml file contents, alternatively use curator-cli which takes a simple action command"; type = types.lines; example = '' --- diff --git a/nixos/modules/services/search/elasticsearch.nix b/nixos/modules/services/search/elasticsearch.nix index 041d0b3c43fd0..4a9dd50310e20 100644 --- a/nixos/modules/services/search/elasticsearch.nix +++ b/nixos/modules/services/search/elasticsearch.nix @@ -45,50 +45,50 @@ in options.services.elasticsearch = { enable = mkOption { - description = "Whether to enable elasticsearch."; + description = lib.mdDoc "Whether to enable elasticsearch."; default = false; type = types.bool; }; package = mkOption { - description = "Elasticsearch package to use."; + description = lib.mdDoc "Elasticsearch package to use."; default = pkgs.elasticsearch; defaultText = literalExpression "pkgs.elasticsearch"; type = types.package; }; listenAddress = mkOption { - description = "Elasticsearch listen address."; + description = lib.mdDoc "Elasticsearch listen address."; default = "127.0.0.1"; type = types.str; }; port = mkOption { - description = "Elasticsearch port to listen for HTTP traffic."; + description = lib.mdDoc "Elasticsearch port to listen for HTTP traffic."; default = 9200; type = types.int; }; tcp_port = mkOption { - description = "Elasticsearch port for the node to node communication."; + description = lib.mdDoc "Elasticsearch port for the node to node communication."; default = 9300; type = types.int; }; cluster_name = mkOption { - description = "Elasticsearch name that identifies your cluster for auto-discovery."; + description = lib.mdDoc "Elasticsearch name that identifies your cluster for auto-discovery."; default = "elasticsearch"; type = types.str; }; single_node = mkOption { - description = "Start a single-node cluster"; + description = lib.mdDoc "Start a single-node cluster"; default = true; type = types.bool; }; extraConf = mkOption { - description = "Extra configuration for elasticsearch."; + description = lib.mdDoc "Extra configuration for elasticsearch."; default = ""; type = types.str; example = '' @@ -99,7 +99,7 @@ in }; logging = mkOption { - description = "Elasticsearch logging configuration."; + description = lib.mdDoc "Elasticsearch logging configuration."; default = '' logger.action.name = org.elasticsearch.action logger.action.level = info @@ -118,26 +118,26 @@ in dataDir = mkOption { type = types.path; default = "/var/lib/elasticsearch"; - description = '' + description = lib.mdDoc '' Data directory for elasticsearch. ''; }; extraCmdLineOptions = mkOption { - description = "Extra command line options for the elasticsearch launcher."; + description = lib.mdDoc "Extra command line options for the elasticsearch launcher."; default = [ ]; type = types.listOf types.str; }; extraJavaOptions = mkOption { - description = "Extra command line options for Java."; + description = lib.mdDoc "Extra command line options for Java."; default = [ ]; type = types.listOf types.str; example = [ "-Djava.net.preferIPv4Stack=true" ]; }; plugins = mkOption { - description = "Extra elasticsearch plugins"; + description = lib.mdDoc "Extra elasticsearch plugins"; default = [ ]; type = types.listOf types.package; example = lib.literalExpression "[ pkgs.elasticsearchPlugins.discovery-ec2 ]"; @@ -145,7 +145,7 @@ in restartIfChanged = mkOption { type = types.bool; - description = '' + description = lib.mdDoc '' Automatically restart the service on config change. This can be set to false to defer restarts on a server or cluster. Please consider the security implications of inadvertently running an older version, diff --git a/nixos/modules/services/search/hound.nix b/nixos/modules/services/search/hound.nix index ef62175b0a3e3..c81ceee546965 100644 --- a/nixos/modules/services/search/hound.nix +++ b/nixos/modules/services/search/hound.nix @@ -8,7 +8,7 @@ in { enable = mkOption { type = types.bool; default = false; - description = '' + description = lib.mdDoc '' Whether to enable the hound code search daemon. ''; }; @@ -16,7 +16,7 @@ in { user = mkOption { default = "hound"; type = types.str; - description = '' + description = lib.mdDoc '' User the hound daemon should execute under. ''; }; @@ -24,7 +24,7 @@ in { group = mkOption { default = "hound"; type = types.str; - description = '' + description = lib.mdDoc '' Group the hound daemon should execute under. ''; }; @@ -33,7 +33,7 @@ in { type = types.listOf types.str; default = [ ]; example = [ "dialout" ]; - description = '' + description = lib.mdDoc '' List of extra groups that the "hound" user should be a part of. ''; }; @@ -41,7 +41,7 @@ in { home = mkOption { default = "/var/lib/hound"; type = types.path; - description = '' + description = lib.mdDoc '' The path to use as hound's $HOME. If the default user "hound" is configured then this is the home of the "hound" user. @@ -52,14 +52,14 @@ in { default = pkgs.hound; defaultText = literalExpression "pkgs.hound"; type = types.package; - description = '' + description = lib.mdDoc '' Package for running hound. ''; }; config = mkOption { type = types.str; - description = '' + description = lib.mdDoc '' The full configuration of the Hound daemon. Note the dbpath should be an absolute path to a writable location on disk. ''; @@ -82,7 +82,7 @@ in { type = types.str; default = "0.0.0.0:6080"; example = "127.0.0.1:6080 or just :6080"; - description = '' + description = lib.mdDoc '' Listen on this IP:port / :port ''; }; diff --git a/nixos/modules/services/search/kibana.nix b/nixos/modules/services/search/kibana.nix index e4ab85be9ef15..c945ef4c89d06 100644 --- a/nixos/modules/services/search/kibana.nix +++ b/nixos/modules/services/search/kibana.nix @@ -35,50 +35,50 @@ in { enable = mkEnableOption "kibana service"; listenAddress = mkOption { - description = "Kibana listening host"; + description = lib.mdDoc "Kibana listening host"; default = "127.0.0.1"; type = types.str; }; port = mkOption { - description = "Kibana listening port"; + description = lib.mdDoc "Kibana listening port"; default = 5601; type = types.int; }; cert = mkOption { - description = "Kibana ssl certificate."; + description = lib.mdDoc "Kibana ssl certificate."; default = null; type = types.nullOr types.path; }; key = mkOption { - description = "Kibana ssl key."; + description = lib.mdDoc "Kibana ssl key."; default = null; type = types.nullOr types.path; }; index = mkOption { - description = "Elasticsearch index to use for saving kibana config."; + description = lib.mdDoc "Elasticsearch index to use for saving kibana config."; default = ".kibana"; type = types.str; }; defaultAppId = mkOption { - description = "Elasticsearch default application id."; + description = lib.mdDoc "Elasticsearch default application id."; default = "discover"; type = types.str; }; elasticsearch = { url = mkOption { - description = '' + description = lib.mdDoc '' Elasticsearch url. - Defaults to <literal>"http://localhost:9200"</literal>. + Defaults to `"http://localhost:9200"`. Don't set this when using Kibana >= 7.0.0 because it will result in a - configuration error. Use <option>services.kibana.elasticsearch.hosts</option> + configuration error. Use {option}`services.kibana.elasticsearch.hosts` instead. ''; default = null; @@ -86,11 +86,11 @@ in { }; hosts = mkOption { - description = '' + description = lib.mdDoc '' The URLs of the Elasticsearch instances to use for all your queries. All nodes listed here must be on the same cluster. - Defaults to <literal>[ "http://localhost:9200" ]</literal>. + Defaults to `[ "http://localhost:9200" ]`. This option is only valid when using kibana >= 6.6. ''; @@ -99,22 +99,22 @@ in { }; username = mkOption { - description = "Username for elasticsearch basic auth."; + description = lib.mdDoc "Username for elasticsearch basic auth."; default = null; type = types.nullOr types.str; }; password = mkOption { - description = "Password for elasticsearch basic auth."; + description = lib.mdDoc "Password for elasticsearch basic auth."; default = null; type = types.nullOr types.str; }; ca = mkOption { - description = '' + description = lib.mdDoc '' CA file to auth against elasticsearch. - It's recommended to use the <option>certificateAuthorities</option> option + It's recommended to use the {option}`certificateAuthorities` option when using kibana-5.4 or newer. ''; default = null; @@ -138,33 +138,33 @@ in { }; cert = mkOption { - description = "Certificate file to auth against elasticsearch."; + description = lib.mdDoc "Certificate file to auth against elasticsearch."; default = null; type = types.nullOr types.path; }; key = mkOption { - description = "Key file to auth against elasticsearch."; + description = lib.mdDoc "Key file to auth against elasticsearch."; default = null; type = types.nullOr types.path; }; }; package = mkOption { - description = "Kibana package to use"; + description = lib.mdDoc "Kibana package to use"; default = pkgs.kibana; defaultText = literalExpression "pkgs.kibana"; type = types.package; }; dataDir = mkOption { - description = "Kibana data directory"; + description = lib.mdDoc "Kibana data directory"; default = "/var/lib/kibana"; type = types.path; }; extraConf = mkOption { - description = "Kibana extra configuration"; + description = lib.mdDoc "Kibana extra configuration"; default = {}; type = types.attrs; }; diff --git a/nixos/modules/services/search/meilisearch.nix b/nixos/modules/services/search/meilisearch.nix index f6210f6f16e1d..9a03fc1f715b8 100644 --- a/nixos/modules/services/search/meilisearch.nix +++ b/nixos/modules/services/search/meilisearch.nix @@ -19,33 +19,33 @@ in enable = mkEnableOption "MeiliSearch - a RESTful search API"; package = mkOption { - description = "The package to use for meilisearch. Use this if you require specific features to be enabled. The default package has no features."; + description = lib.mdDoc "The package to use for meilisearch. Use this if you require specific features to be enabled. The default package has no features."; default = pkgs.meilisearch; defaultText = "pkgs.meilisearch"; type = types.package; }; listenAddress = mkOption { - description = "MeiliSearch listen address."; + description = lib.mdDoc "MeiliSearch listen address."; default = "127.0.0.1"; type = types.str; }; listenPort = mkOption { - description = "MeiliSearch port to listen on."; + description = lib.mdDoc "MeiliSearch port to listen on."; default = 7700; type = types.port; }; environment = mkOption { - description = "Defines the running environment of MeiliSearch."; + description = lib.mdDoc "Defines the running environment of MeiliSearch."; default = "development"; type = types.enum [ "development" "production" ]; }; # TODO change this to LoadCredentials once possible masterKeyEnvironmentFile = mkOption { - description = '' + description = lib.mdDoc '' Path to file which contains the master key. By doing so, all routes will be protected and will require a key to be accessed. If no master key is provided, all routes can be accessed without requiring any key. @@ -57,7 +57,7 @@ in }; noAnalytics = mkOption { - description = '' + description = lib.mdDoc '' Deactivates analytics. Analytics allow MeiliSearch to know how many users are using MeiliSearch, which versions and which platforms are used. @@ -82,7 +82,7 @@ in }; maxIndexSize = mkOption { - description = '' + description = lib.mdDoc '' Sets the maximum size of the index. Value must be given in bytes or explicitly stating a base unit. For example, the default value can be written as 107374182400, '107.7Gb', or '107374 Mb'. @@ -93,7 +93,7 @@ in }; payloadSizeLimit = mkOption { - description = '' + description = lib.mdDoc '' Sets the maximum size of accepted JSON payloads. Value must be given in bytes or explicitly stating a base unit. For example, the default value can be written as 107374182400, '107.7Gb', or '107374 Mb'. diff --git a/nixos/modules/services/search/solr.nix b/nixos/modules/services/search/solr.nix index ea76bfc9298f6..ea8a2d6f92773 100644 --- a/nixos/modules/services/search/solr.nix +++ b/nixos/modules/services/search/solr.nix @@ -17,37 +17,37 @@ in type = types.package; default = pkgs.solr; defaultText = literalExpression "pkgs.solr"; - description = "Which Solr package to use."; + description = lib.mdDoc "Which Solr package to use."; }; port = mkOption { type = types.int; default = 8983; - description = "Port on which Solr is ran."; + description = lib.mdDoc "Port on which Solr is ran."; }; stateDir = mkOption { type = types.path; default = "/var/lib/solr"; - description = "The solr home directory containing config, data, and logging files."; + description = lib.mdDoc "The solr home directory containing config, data, and logging files."; }; extraJavaOptions = mkOption { type = types.listOf types.str; default = []; - description = "Extra command line options given to the java process running Solr."; + description = lib.mdDoc "Extra command line options given to the java process running Solr."; }; user = mkOption { type = types.str; default = "solr"; - description = "User under which Solr is ran."; + description = lib.mdDoc "User under which Solr is ran."; }; group = mkOption { type = types.str; default = "solr"; - description = "Group under which Solr is ran."; + description = lib.mdDoc "Group under which Solr is ran."; }; }; }; |