Merge branch 'release/v3.5.3'

ElasticHQ · Sep 27, 2019 · 5cb7889 · 5cb7889
2 parents 1730251 + 0ebdc27
commit 5cb7889
Show file tree

Hide file tree

Showing 24 changed files with 434 additions and 406 deletions.
diff --git a/README.md b/README.md
@@ -27,7 +27,16 @@ Simplified Monitoring and Management for ElasticSearch clusters.
 * Active project used by Fortune 100 companies around the world.
 * Free and (Real) Open Source. ;-)
 
-## Installation
+## Quickstart: Docker
+
+We are hosted on Dockerhub: [ElasticHQ on Dockerhub](https://hub.docker.com/r/elastichq/elasticsearch-hq/)  
+
+1. ``docker run -p 5000:5000 elastichq/elasticsearch-hq``
+2. Access HQ with: `` http://localhost:5000 ``
+
+For further instructions on docker commands and configuration, please see relevant documentation: [Docker Images](http://docs.elastichq.org/installation.html#docker-images).
+
+## Source Installation
 
 ### Requirements
 
@@ -44,15 +53,6 @@ For **full** installation and configuration instructions, see [Getting Started](
 
 For further installation and configuration help, please read the docs: [ElasticHQ Documentation](http://docs.elastichq.org)
 
-## Docker Installation
-
-We are hosted on Dockerhub: [ElasticHQ on Dockerhub](https://hub.docker.com/r/elastichq/elasticsearch-hq/)  
-
-1. ``docker run -p 5000:5000 elastichq/elasticsearch-hq``
-2. Access HQ with: `` http://localhost:5000 ``
-
-For further instructions, please see relevant documentation: [Docker Images](http://docs.elastichq.org/installation.html#docker-images).
-
 ## OpenShift Installation
 
 Please see relevant documentation: [ElasticHQ on OpenShift](openshift/README.md).

diff --git a/docs/.buildinfo b/docs/.buildinfo
@@ -1,4 +1,4 @@
 # Sphinx build info version 1
 # This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
-config: 7941a7fdcaed6c9c9192da5b0438d143
+config: d95de450ee0c2c25942b746b3626a6b0
 tags: 645f666f9bcd5a90fca523b33c5a78b7
diff --git a/docs/.doctrees/environment.pickle b/docs/.doctrees/environment.pickle
diff --git a/docs/.doctrees/index.doctree b/docs/.doctrees/index.doctree
diff --git a/docs/.doctrees/installation.doctree b/docs/.doctrees/installation.doctree
diff --git a/docs/.doctrees/rest-api.doctree b/docs/.doctrees/rest-api.doctree
diff --git a/docs/_sources/index.txt b/docs/_sources/index.txt
@@ -4,7 +4,7 @@ ElasticHQ Documentation
 
 
 .. toctree::
-    :includehidden:
+    :hidden:
 
     installation
     rest-api

diff --git a/docs/_sources/installation.txt b/docs/_sources/installation.txt
@@ -3,23 +3,46 @@ Getting Started
 ===============
 
 .. contents:: Table of Contents
-    :depth: 3
+    :depth: 2
     :local:
 
-
-
 Quick-Start Guide
 -----------------
 
+1. :any:`docker images`
+2. :any:`run from source`
+
+.. _docker images:
+
+Running with Docker
+-------------------
+
+Docker images are offered on the `ElasticHQ Dockerhub <https://hub.docker.com/r/elastichq/elasticsearch-hq/>`_.
+
+Run with:
+
+.. code-block:: bash
+
+    docker run -p 5000:5000 elastichq/elasticsearch-hq
+
+Access HQ with: http://localhost:5000
+
+When starting with Docker, see :any:`environment variables` for passing startup args. Environment variables are passed to docker using the `-e` flag.
+
+ie. ``-e HQ_DEFAULT_URL='http://aa.com:1212'``
+
+.. note:: The ``latest`` tag deploys the latest stable release. Where ``develop`` is the latest unstable working branch.
 
-Installation
-------------
+.. _run from source:
+
+Install from Source
+-------------------
 
 Requirements
 ^^^^^^^^^^^^
 
 * Python 3.4+
-* Elasticsearch. Supported versions: 2.x, 5.x, 6.x
+* Elasticsearch. Supported versions: 2.x, 5.x, 6.x, 7.x
 
 Install ElasticHQ
 ^^^^^^^^^^^^^^^^^
@@ -31,24 +54,6 @@ Install ElasticHQ
 
 .. note:: Alternatively, you can start the server with ``python manage.py runserver``
 
-.. _docker images:
-
-Docker Images
-^^^^^^^^^^^^^
-
-Docker images are offered on the `ElasticHQ Dockerhub <https://hub.docker.com/r/elastichq/elasticsearch-hq/>`_.
-
-The ``latest`` tag deploys the latest stable release. Where ``develop`` is the latest unstable working branch.
-
-When starting with Docker, see :any:`environment variables` for passing startup args. Environment variables are passed to docker using the `-e` flag.
-
-ie. ``-e HQ_DEFAULT_URL='http://aa.com:1212'``
-
-To run/install container:
-
-``docker run -p 5000:5000 elastichq/elasticsearch-hq``
-
-Access HQ with: http://localhost:5000
 
 Pre-Releases
 ^^^^^^^^^^^^
@@ -103,6 +108,15 @@ The ``application.py`` start script takes parameters passed in as arguments from
     ``--verify_certs``  True                       Whether HQ should attempt to validate certs. Set to False for self-signed certs.
     ==================  =========================  ================================================================================
 
+Example:
+========
+
+.. code-block:: bash
+
+    python -m application
+    --enable-ssl
+    --ca-certs /path/to/your/ca.crt
+
 .. _environment variables:
 
 Environment Variables
@@ -118,6 +132,14 @@ Environment Variables
     ``HQ_DEBUG``         False                      If True, enables debug level on logging.
     ===================  =========================  ================================================================================
 
+Example:
+========
+
+.. code-block:: bash
+
+    docker run -p 5000:5000 elastichq/elasticsearch-hq
+    -e HQ_DEFAULT_URL='http://aa.com:1212'
+    -e HQ_ENABLE_SSL=False
 
 Logging
 ^^^^^^^

diff --git a/docs/developer-guide.html b/docs/developer-guide.html
@@ -66,10 +66,8 @@ <h3>Navigation</h3>
         <a href="#"><span class="glyphicon glyphicon-align-justify" aria-hidden="true"></span></a>
       </div>
   <div id="left-column">
-    <div class="sphinxsidebar">
-        <a href="
+    <div class="sphinxsidebar"><a href="
     index.html" class="text-logo">ElasticHQ</a>
-
 <div class="sidebar-block">
   <div class="sidebar-wrapper">
     <h2>Table Of Contents</h2>
@@ -82,12 +80,27 @@ <h2>Table Of Contents</h2>
 <li class="toctree-l1"><a class="reference internal" href="rest-api.html">REST API</a></li>
 <li class="toctree-l1 current"><a class="current reference internal" href="#">For Developers</a><ul>
 <li class="toctree-l2"><a class="reference internal" href="#contributing">Contributing</a></li>
-<li class="toctree-l2"><a class="reference internal" href="#developer-environment">Developer Environment</a></li>
-<li class="toctree-l2"><a class="reference internal" href="#building-pre-releases">Building Pre-Releases</a></li>
+<li class="toctree-l2"><a class="reference internal" href="#developer-environment">Developer Environment</a><ul>
+<li class="toctree-l3"><a class="reference internal" href="#set-debug-to-true">Set Debug to True</a></li>
+</ul>
+</li>
+<li class="toctree-l2"><a class="reference internal" href="#building-pre-releases">Building Pre-Releases</a><ul>
+<li class="toctree-l3"><a class="reference internal" href="#install-build-the-ui">Install/Build the UI</a></li>
+<li class="toctree-l3"><a class="reference internal" href="#building-a-distribution">Building a Distribution</a></li>
+<li class="toctree-l3"><a class="reference internal" href="#pulling-a-tag-from-dockerhub">Pulling a tag from DockerHub</a></li>
+</ul>
+</li>
 <li class="toctree-l2"><a class="reference internal" href="#running-tests">Running Tests</a></li>
-<li class="toctree-l2"><a class="reference internal" href="#manual-testing">Manual Testing</a></li>
+<li class="toctree-l2"><a class="reference internal" href="#manual-testing">Manual Testing</a><ul>
+<li class="toctree-l3"><a class="reference internal" href="#notes">Notes</a></li>
+</ul>
+</li>
 <li class="toctree-l2"><a class="reference internal" href="#building-documentation">Building Documentation</a></li>
-<li class="toctree-l2"><a class="reference internal" href="#http-responses">HTTP Responses</a></li>
+<li class="toctree-l2"><a class="reference internal" href="#http-responses">HTTP Responses</a><ul>
+<li class="toctree-l3"><a class="reference internal" href="#http-status">HTTP Status</a></li>
+<li class="toctree-l3"><a class="reference internal" href="#response-headers">Response Headers</a></li>
+</ul>
+</li>
 <li class="toctree-l2"><a class="reference internal" href="#issues-bugs">Issues/Bugs</a></li>
 </ul>
 </li>
@@ -97,7 +110,6 @@ <h2>Table Of Contents</h2>
 
   </div>
 </div>
-
 <div class="sidebar-block">
   <div class="sidebar-wrapper">
     <div id="main-search">
@@ -111,6 +123,7 @@ <h2>Table Of Contents</h2>
     </div>
   </div>
 </div>
+
     </div>
   </div>
         <div id="right-column">

diff --git a/docs/faq.html b/docs/faq.html
@@ -62,10 +62,8 @@ <h3>Navigation</h3>
         <a href="#"><span class="glyphicon glyphicon-align-justify" aria-hidden="true"></span></a>
       </div>
   <div id="left-column">
-    <div class="sphinxsidebar">
-        <a href="
+    <div class="sphinxsidebar"><a href="
     index.html" class="text-logo">ElasticHQ</a>
-
 <div class="sidebar-block">
   <div class="sidebar-wrapper">
     <h2>Table Of Contents</h2>
@@ -87,7 +85,6 @@ <h2>Table Of Contents</h2>
 
   </div>
 </div>
-
 <div class="sidebar-block">
   <div class="sidebar-wrapper">
     <div id="main-search">
@@ -101,6 +98,7 @@ <h2>Table Of Contents</h2>
     </div>
   </div>
 </div>
+
     </div>
   </div>
         <div id="right-column">

diff --git a/docs/genindex.html b/docs/genindex.html
@@ -59,10 +59,8 @@ <h3>Navigation</h3>
         <a href="#"><span class="glyphicon glyphicon-align-justify" aria-hidden="true"></span></a>
       </div>
   <div id="left-column">
-    <div class="sphinxsidebar">
-        <a href="
+    <div class="sphinxsidebar"><a href="
     index.html" class="text-logo">ElasticHQ</a>
-
 <div class="sidebar-block">
   <div class="sidebar-wrapper">
     <h2>Table Of Contents</h2>
@@ -80,7 +78,6 @@ <h2>Table Of Contents</h2>
 
   </div>
 </div>
-
 <div class="sidebar-block">
   <div class="sidebar-wrapper">
     <div id="main-search">
@@ -94,6 +91,7 @@ <h2>Table Of Contents</h2>
     </div>
   </div>
 </div>
+
     </div>
   </div>
         <div id="right-column">

diff --git a/docs/http-routingtable.html b/docs/http-routingtable.html
@@ -65,10 +65,8 @@ <h3>Navigation</h3>
         <a href="#"><span class="glyphicon glyphicon-align-justify" aria-hidden="true"></span></a>
       </div>
   <div id="left-column">
-    <div class="sphinxsidebar">
-        <a href="
+    <div class="sphinxsidebar"><a href="
     index.html" class="text-logo">ElasticHQ</a>
-
 <div class="sidebar-block">
   <div class="sidebar-wrapper">
     <h2>Table Of Contents</h2>
@@ -86,7 +84,6 @@ <h2>Table Of Contents</h2>
 
   </div>
 </div>
-
 <div class="sidebar-block">
   <div class="sidebar-wrapper">
     <div id="main-search">
@@ -100,6 +97,7 @@ <h2>Table Of Contents</h2>
     </div>
   </div>
 </div>
+
     </div>
   </div>
         <div id="right-column">