Skip to content

Commit ac9a85c

Browse files
committed
updated IntelOwl's doc about Elasticsearch config
1 parent ecb7c72 commit ac9a85c

File tree

1 file changed

+12
-5
lines changed

1 file changed

+12
-5
lines changed

docs/IntelOwl/advanced_configuration.md

Lines changed: 12 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -11,17 +11,24 @@ Right now only ElasticSearch v8 is supported.
1111
### Configuration
1212
In the `env_file_app_template`, you'd see various elasticsearch related environment variables. The user should spin their own Elastic Search instance and configure these variables.
1313

14-
* ELASTIC_DSL_ENABLED: Enable the ElasticSearch integration to perform advanced searches.
15-
* ELASTIC_HOST: URL of the Elasticsearch instance.
16-
* ELASTIC_PASSWORD: (optional) Password of the "elastic" user. This can be empty in case of external services with credentials in the url.
14+
* ELASTICSEARCH_DSL_ENABLED: Enable the ElasticSearch integration to perform advanced searches.
15+
* ELASTICSEARCH_DSL_HOST: URL of the Elasticsearch instance.
16+
* ELASTICSEARCH_DSL_PASSWORD: (optional) Password of the "elastic" user. This can be empty in case of external services with credentials in the url.
1717
* ELASTICSEARCH_BI_ENABLED: Use the Business Intelligence feature.
1818
* ELASTICSEARCH_BI_HOST: URL of the Elasticsearch instance for the BI.
1919
* ELASTICSEARCH_BI_INDEX: Base path of the BI index.
2020

21+
In the `env_file_elasticsearch_template` there is a viarable called `ELASTICSEARCH_PASSWORD`. This name is forced by elastic to set the password into the container.
22+
2123
#### Example Configuration
2224

23-
* Use external instance: In this case it's enough to set the `ELASTIC_DSL_ENABLED` to `True` and `ELASTIC_HOST` with the URL of the external instance.
24-
* Use docker instance: With the `--elastic` option you can run a container based Elasticsearch instance. In this case the `ELASTIC_HOST` must be set to https://elasticsearch:9200. Configure also `ELASTIC_PASSWORD`.
25+
* Use external instance: In this case it's enough to set the `ELASTICSEARCH_DSL_ENABLED` to `True` and `ELASTICSEARCH_DSL_HOST` with the URL of the external instance.
26+
* Use docker instance:
27+
* Before starting IntelOwl move inside `docker` folder.
28+
* `cp env_file_elasticsearch_template env_file_elasticsearch`
29+
* Populate the var `ELASTICSEARCH_PASSWORD` inside the file `env_file_elasticsearch`.
30+
* Populate the var `ELASTICSEARCH_DSL_PASSWORD` in the file `env_file_app` with the same value of `ELASTICSEARCH_PASSWORD`. Populate also `ELASTICSEARCH_DSL_HOST` with https://elasticsearch:9200.
31+
* Start the project with `--elastic` in this way a container based Elasticsearch instance will start.
2532

2633
### Data Search
2734

0 commit comments

Comments
 (0)