From af73402cbef92c926618c0bc319e298b08b4f8d9 Mon Sep 17 00:00:00 2001 From: Elan Hasson <234704+ElanHasson@users.noreply.github.com> Date: Tue, 5 Dec 2023 10:06:17 -0500 Subject: [PATCH] Update `ES_HOST` to document TLS usage (#1140) * Update `ES_HOST` to document TLS usage * Update elasticsearch.md * Update content/en/admin/config.md * Apply suggestions from code review Co-authored-by: Michael Stanclift --- content/en/admin/config.md | 3 ++- content/en/admin/elasticsearch.md | 2 ++ 2 files changed, 4 insertions(+), 1 deletion(-) diff --git a/content/en/admin/config.md b/content/en/admin/config.md index 2b1d3959..1e94f2dc 100644 --- a/content/en/admin/config.md +++ b/content/en/admin/config.md @@ -387,7 +387,7 @@ See the [ElasticSearch setup page for details on each setting](../elasticsearch# #### `ES_HOST` -Host of the Elasticsearch server. Defaults to `localhost` +Host of the Elasticsearch server. Defaults to `localhost`. If using TLS, prepend the hostname with `https://`. For example: `https://elastic.example.com`. #### `ES_PORT` @@ -830,3 +830,4 @@ Defaults to `512`. #### `GITHUB_API_TOKEN` Used in a rake task for generating AUTHORS.md from GitHub commit history. + diff --git a/content/en/admin/elasticsearch.md b/content/en/admin/elasticsearch.md index cf33bda3..676561b8 100644 --- a/content/en/admin/elasticsearch.md +++ b/content/en/admin/elasticsearch.md @@ -71,6 +71,8 @@ ES_PRESET= # single_node_cluster, small_cluster or large_cluster # ES_PASS= ``` +_Note_: If using TLS, prepend the hostname with `https://`. For example: `https://elastic.example.com`. + ### Choosing the correct preset The value for `ES_PRESET` depends on the size of your Elasticsearch and will be used to set the number of shards and replica for your indices to the best value for your setup: