Add documentation for Elasticsearch HTTP authentication

VIDA-NYU · Feb 2, 2022 · 2fd2e39 · 2fd2e39
1 parent 4553057
commit 2fd2e39
Show file tree

Hide file tree

Showing 2 changed files with 14 additions and 2 deletions.
diff --git a/docs/data-formats.rst b/docs/data-formats.rst
@@ -157,7 +157,17 @@ for more information on these parameters.
   target_storage.data_format.elasticsearch.rest.socket_timeout: 30000
   target_storage.data_format.elasticsearch.rest.max_retry_timeout_millis: 90000
 
-**Transport Client (deprecated)**
+**HTTP Basic Authentication**
+
+You can configure the username and password by adding the following to ``ache.yml`` file:
+
+.. code:: yaml
+
+    target_storage.data_format.elasticsearch.rest.username: myusername
+    target_storage.data_format.elasticsearch.rest.password: mypasswd
+
+
+**Transport Client (removed since version >=0.11)**
 
 You can also configure ACHE to connect to Elasticsearch v1.x using the native
 transport client by adding the following lines::

diff --git a/docs/requirements.txt b/docs/requirements.txt
@@ -1,2 +1,4 @@
+sphinx
 sphinxcontrib-httpdomain
-sphinx-material
+sphinx-material
+