diff options
Diffstat (limited to 'nixos/modules/services/search/elasticsearch.nix')
-rw-r--r-- | nixos/modules/services/search/elasticsearch.nix | 28 |
1 files changed, 14 insertions, 14 deletions
diff --git a/nixos/modules/services/search/elasticsearch.nix b/nixos/modules/services/search/elasticsearch.nix index 041d0b3c43f..4a9dd50310e 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, |