# elasticsearch

## Options

### services.elasticsearch.enable

Whether to enable elasticsearch.

*Type:* boolean

*Default:*

```nix
false
```

*Declared by:*

* <https://github.com/cachix/devenv/blob/main/src/modules/services/elasticsearch.nix>

### services.elasticsearch.package

Elasticsearch package to use.

*Type:* package

*Default:*

```nix
pkgs.elasticsearch7
```

*Declared by:*

* <https://github.com/cachix/devenv/blob/main/src/modules/services/elasticsearch.nix>

### services.elasticsearch.cluster\_name

Elasticsearch name that identifies your cluster for auto-discovery.

*Type:* string

*Default:*

```nix
"elasticsearch"
```

*Declared by:*

* <https://github.com/cachix/devenv/blob/main/src/modules/services/elasticsearch.nix>

### services.elasticsearch.extraCmdLineOptions

Extra command line options for the elasticsearch launcher.

*Type:* list of string

*Default:*

```nix
[ ]
```

*Declared by:*

* <https://github.com/cachix/devenv/blob/main/src/modules/services/elasticsearch.nix>

### services.elasticsearch.extraConf

Extra configuration for elasticsearch.

*Type:* string

*Default:*

```nix
""
```

*Example:*

```nix
''
  node.name: "elasticsearch"
  node.master: true
  node.data: false
''
```

*Declared by:*

* <https://github.com/cachix/devenv/blob/main/src/modules/services/elasticsearch.nix>

### services.elasticsearch.extraJavaOptions

Extra command line options for Java.

*Type:* list of string

*Default:*

```nix
[ ]
```

*Example:*

```nix
[
  "-Djava.net.preferIPv4Stack=true"
]
```

*Declared by:*

* <https://github.com/cachix/devenv/blob/main/src/modules/services/elasticsearch.nix>

### services.elasticsearch.listenAddress

Elasticsearch listen address.

*Type:* string

*Default:*

```nix
"127.0.0.1"
```

*Declared by:*

* <https://github.com/cachix/devenv/blob/main/src/modules/services/elasticsearch.nix>

### services.elasticsearch.logging

Elasticsearch logging configuration.

*Type:* string

*Default:*

```nix
''
  logger.action.name = org.elasticsearch.action
  logger.action.level = info
  appender.console.type = Console
  appender.console.name = console
  appender.console.layout.type = PatternLayout
  appender.console.layout.pattern = [%d{ISO8601}][%-5p][%-25c{1.}] %marker%m%n
  rootLogger.level = info
  rootLogger.appenderRef.console.ref = console
''
```

*Declared by:*

* <https://github.com/cachix/devenv/blob/main/src/modules/services/elasticsearch.nix>

### services.elasticsearch.plugins

Extra elasticsearch plugins

*Type:* list of package

*Default:*

```nix
[ ]
```

*Example:*

```nix
[ pkgs.elasticsearchPlugins.discovery-ec2 ]
```

*Declared by:*

* <https://github.com/cachix/devenv/blob/main/src/modules/services/elasticsearch.nix>

### services.elasticsearch.port

Elasticsearch port to listen for HTTP traffic.

*Type:* 16 bit unsigned integer; between 0 and 65535 (both inclusive)

*Default:*

```nix
9200
```

*Declared by:*

* <https://github.com/cachix/devenv/blob/main/src/modules/services/elasticsearch.nix>

### services.elasticsearch.single\_node

Start a single-node cluster

*Type:* boolean

*Default:*

```nix
true
```

*Declared by:*

* <https://github.com/cachix/devenv/blob/main/src/modules/services/elasticsearch.nix>

### services.elasticsearch.tcp\_port

Elasticsearch port for the node to node communication.

*Type:* 16 bit unsigned integer; between 0 and 65535 (both inclusive)

*Default:*

```nix
9300
```

*Declared by:*

* <https://github.com/cachix/devenv/blob/main/src/modules/services/elasticsearch.nix>