- doc updates

Author: royrusso

docs/.doctrees/environment.pickle

@@ -42,6 +42,11 @@ When starting with Docker, see :any:`environment variables` for passing startup
 
 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
 ^^^^^^^^^^^^
@@ -202,9 +207,11 @@ Upgrading Minor and Patch versions
 Running in Production
 ---------------------
 
-We advise that under any considerable usage/load, this application should be run with a multithreaded server. The current flask implemenation by itself should not be run in production without this, as it is a single-threaded process.
+We advise that under any considerable usage/load, this application should be run with a multithreaded server. The current flask implementation by itself should not be run in production without this, as it is a single-threaded process.
 
-We recommend running this WSGI application with gunicorn. Install gunicorn by either commenting out the line in the ``requirements.txt`` file or simply running ``pip install gunicorn``
+We recommend running this WSGI application with gunicorn. The Docker container available on DockerHub is pre-configured to run with gunicorn, and is preferred. See the Docker Images section in this document for details.
+
+If you wish to run without a container, install gunicorn by either commenting out the line in the ``requirements.txt`` file or simply running ``pip install gunicorn``
 
 In console, run gunicorn with:
 
@@ -216,8 +223,6 @@ Read the `Gunicorn Docs <http://docs.gunicorn.org/en/stable/configure.html>`_ fo
 
 .. note:: For the *Metrics* section to broadcast via websocket, you must have gunicorn set to 1 worker.
 
-.. note:: The Docker container available on DockerHub is pre-configured to run with gunicorn.
-
 Troubleshooting
 ---------------
 

docs/.doctrees/installation.doctree

@@ -197,6 +197,9 @@ <h3><a class="toc-backref" href="#id6">Docker Images</a><a class="headerlink" hr
 <p>The <code class="docutils literal"><span class="pre">latest</span></code> tag deploys the latest stable release. Where <code class="docutils literal"><span class="pre">develop</span></code> is the latest unstable working branch.</p>
 <p>When starting with Docker, see <a class="reference internal" href="#environment-variables"><span class="std std-ref">Environment Variables</span></a> for passing startup args. Environment variables are passed to docker using the <cite>-e</cite> flag.</p>
 <p>ie. <code class="docutils literal"><span class="pre">-e</span> <span class="pre">HQ_DEFAULT_URL='http://aa.com:1212'</span></code></p>
+<p>To run/install container:</p>
+<p><code class="docutils literal"><span class="pre">docker</span> <span class="pre">run</span> <span class="pre">-p</span> <span class="pre">5000:5000</span> <span class="pre">elastichq/elasticsearch-hq</span></code></p>
+<p>Access HQ with: <a class="reference external" href="http://localhost:5000">http://localhost:5000</a></p>
 </div>
 <div class="section" id="pre-releases">
 <h3><a class="toc-backref" href="#id7">Pre-Releases</a><a class="headerlink" href="#pre-releases" title="Permalink to this headline">¶</a></h3>
@@ -393,8 +396,9 @@ <h3><a class="toc-backref" href="#id19">Upgrading Minor and Patch versions</a><a
 </div>
 <div class="section" id="running-in-production">
 <h2><a class="toc-backref" href="#id20">Running in Production</a><a class="headerlink" href="#running-in-production" title="Permalink to this headline">¶</a></h2>
-<p>We advise that under any considerable usage/load, this application should be run with a multithreaded server. The current flask implemenation by itself should not be run in production without this, as it is a single-threaded process.</p>
-<p>We recommend running this WSGI application with gunicorn. Install gunicorn by either commenting out the line in the <code class="docutils literal"><span class="pre">requirements.txt</span></code> file or simply running <code class="docutils literal"><span class="pre">pip</span> <span class="pre">install</span> <span class="pre">gunicorn</span></code></p>
+<p>We advise that under any considerable usage/load, this application should be run with a multithreaded server. The current flask implementation by itself should not be run in production without this, as it is a single-threaded process.</p>
+<p>We recommend running this WSGI application with gunicorn. The Docker container available on DockerHub is pre-configured to run with gunicorn, and is preferred. See the Docker Images section in this document for details.</p>
+<p>If you wish to run without a container, install gunicorn by either commenting out the line in the <code class="docutils literal"><span class="pre">requirements.txt</span></code> file or simply running <code class="docutils literal"><span class="pre">pip</span> <span class="pre">install</span> <span class="pre">gunicorn</span></code></p>
 <p>In console, run gunicorn with:</p>
 <p><code class="docutils literal"><span class="pre">gunicorn</span> <span class="pre">-w</span> <span class="pre">1</span> <span class="pre">-b</span> <span class="pre">:5000</span> <span class="pre">--worker-class</span> <span class="pre">eventlet</span> <span class="pre">application:application</span></code></p>
 <p>The application will be accessible under <a class="reference external" href="http://127.0.0.1:5000">http://127.0.0.1:5000</a></p>
@@ -403,10 +407,6 @@ <h2><a class="toc-backref" href="#id20">Running in Production</a><a class="heade
 <p class="first admonition-title">Note</p>
 <p class="last">For the <em>Metrics</em> section to broadcast via websocket, you must have gunicorn set to 1 worker.</p>
 </div>
-<div class="admonition note">
-<p class="first admonition-title">Note</p>
-<p class="last">The Docker container available on DockerHub is pre-configured to run with gunicorn.</p>
-</div>
 </div>
 <div class="section" id="troubleshooting">
 <h2><a class="toc-backref" href="#id21">Troubleshooting</a><a class="headerlink" href="#troubleshooting" title="Permalink to this headline">¶</a></h2>

docs/_sources/installation.txt

@@ -42,6 +42,11 @@ When starting with Docker, see :any:`environment variables` for passing startup
 
 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
 ^^^^^^^^^^^^
@@ -202,9 +207,11 @@ Upgrading Minor and Patch versions
 Running in Production
 ---------------------
 
-We advise that under any considerable usage/load, this application should be run with a multithreaded server. The current flask implemenation by itself should not be run in production without this, as it is a single-threaded process.
+We advise that under any considerable usage/load, this application should be run with a multithreaded server. The current flask implementation by itself should not be run in production without this, as it is a single-threaded process.
 
-We recommend running this WSGI application with gunicorn. Install gunicorn by either commenting out the line in the ``requirements.txt`` file or simply running ``pip install gunicorn``
+We recommend running this WSGI application with gunicorn. The Docker container available on DockerHub is pre-configured to run with gunicorn, and is preferred. See the Docker Images section in this document for details.
+
+If you wish to run without a container, install gunicorn by either commenting out the line in the ``requirements.txt`` file or simply running ``pip install gunicorn``
 
 In console, run gunicorn with:
 
@@ -216,8 +223,6 @@ Read the `Gunicorn Docs <http://docs.gunicorn.org/en/stable/configure.html>`_ fo
 
 .. note:: For the *Metrics* section to broadcast via websocket, you must have gunicorn set to 1 worker.
 
-.. note:: The Docker container available on DockerHub is pre-configured to run with gunicorn.
-
 Troubleshooting
 ---------------