<commit_before># Found Elasticsearch Transport Module

A transport module that works with Found Elasticsearch.

## Installing

To install, add a dependency to this module in your build system :

```xml
    <dependency>
        <groupId>no.found.elasticsearch</groupId>
        <artifactId>elasticsearch-transport-module</artifactId>
        <version>1.1.18-SNAPSHOT</version>
    </dependency>
```

The module is enabled by adding this project as a dependency to your application
and setting the ``transport.type`` setting in Elasticsearch to
``no.found.elasticsearch.transport.netty.FoundNettyTransportModule``.

Note: This is not a standard Elasticsearch plugin, it just needs to be on the
application classpath.

## Configuring an API key.

In order to use this module, you must configure one or more API-keys. API-keys
are stored as a list of acceptable keys under ``api_keys`` at the root level
of the ACL. For example:

```yaml
default: deny

api_keys:
    - <KEY>
    - <KEY>

auth:
  users:
    ...

rules:
  - ...
```

In the above example, both ``<KEY>`` and ``<KEY>`` would be
valid API-keys.

## New Elasticsearch settings

New settings introduced by this module:

* **transport.found.host-suffixes**: A comma-separated list of host suffixes that
 trigger our attempt to authenticate with Found Elasticsearch. Defaults to
 {@code foundcluster.com,found.no}".

* **transport.found.ssl-ports**: A comma-separated list of ports that trigger our
 SSL support. Defaults to {@code 9343}".

* **transport.found.api-key**: An API-key which is used to authorize this client
 when connecting to Found Elasticsearch. API-keys are managed via the console as
 a list of Strings under the root level key "api_keys". Defaults to
 {@code missing-api-key}

* **transport.found.ssl.unsafe_allow_self_signed**: Whether to accept self-signed
 certificates when using SSL. This is unsafe and allows for MITM-attacks, but
 may be useful for testing. Defaults to {@code false}.
<commit_msg>markdown != javadoc<commit_after># Found Elasticsearch Transport Module

A transport module that works with Found Elasticsearch.

## Installing

To install, add a dependency to this module in your build system :

```xml
    <dependency>
        <groupId>no.found.elasticsearch</groupId>
        <artifactId>elasticsearch-transport-module</artifactId>
        <version>1.1.18-SNAPSHOT</version>
    </dependency>
```

The module is enabled by adding this project as a dependency to your application
and setting the ``transport.type`` setting in Elasticsearch to
``no.found.elasticsearch.transport.netty.FoundNettyTransportModule``.

Note: This is not a standard Elasticsearch plugin, it just needs to be on the
application classpath.

## Configuring an API key.

In order to use this module, you must configure one or more API-keys. API-keys
are stored as a list of acceptable keys under ``api_keys`` at the root level
of the ACL. For example:

```yaml
default: deny

api_keys:
    - <KEY>
    <KEY>

auth:
  users:
    ...

rules:
  - ...
```

In the above example, both ``<KEY>`` and ``<KEY>`` would be
valid API-keys.

## New Elasticsearch settings

New settings introduced by this module:

* **transport.found.host-suffixes**: A comma-separated list of host suffixes that
 trigger our attempt to authenticate with Found Elasticsearch. Defaults to
 ``foundcluster.com,found.no``.

* **transport.found.ssl-ports**: A comma-separated list of ports that trigger our
 SSL support. Defaults to ``9343``.

* **transport.found.api-key**: An API-key which is used to authorize this client
 when connecting to Found Elasticsearch. API-keys are managed via the console as
 a list of Strings under the root level key "api_keys". Defaults to
 ``missing-api-key``

* **transport.found.ssl.unsafe_allow_self_signed**: Whether to accept self-signed
 certificates when using SSL. This is unsafe and allows for MITM-attacks, but
 may be useful for testing. Defaults to ``false``.

{'fraction_non_alphanumeric': 0.09609533468559837, 'fraction_numerical': 0.004056795131845842, 'mean_word_length': 4.038314176245211, 'pattern_counts': {'":': 0, '<': 27, '<?xml version=': 0, '>': 27, 'https://': 0, 'lorem ipsum': 0, 'www.': 0, 'xml': 2}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 0, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '551998', 'n_tokens_mistral': 1138, 'n_tokens_neox': 1105, 'n_words': 469}