Skip to content

Commit 65c2c54

Browse files
royrussoroyrusso
committed
- updates to docs and readme
1 parent 23767cf commit 65c2c54

22 files changed

+431
-403
lines changed

‎README.md

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,16 @@ Simplified Monitoring and Management for ElasticSearch clusters.
2727
* Active project used by Fortune 100 companies around the world.
2828
* Free and (Real) Open Source. ;-)
2929

30-
## Installation
30+
## Quickstart: Docker
31+
32+
We are hosted on Dockerhub: [ElasticHQ on Dockerhub](https://hub.docker.com/r/elastichq/elasticsearch-hq/)
33+
34+
1. ``docker run -p 5000:5000 elastichq/elasticsearch-hq``
35+
2. Access HQ with: `` http://localhost:5000 ``
36+
37+
For further instructions on docker commands and configuration, please see relevant documentation: [Docker Images](http://docs.elastichq.org/installation.html#docker-images).
38+
39+
## Source Installation
3140

3241
### Requirements
3342

@@ -44,15 +53,6 @@ For **full** installation and configuration instructions, see [Getting Started](
4453

4554
For further installation and configuration help, please read the docs: [ElasticHQ Documentation](http://docs.elastichq.org)
4655

47-
## Docker Installation
48-
49-
We are hosted on Dockerhub: [ElasticHQ on Dockerhub](https://hub.docker.com/r/elastichq/elasticsearch-hq/)
50-
51-
1. ``docker run -p 5000:5000 elastichq/elasticsearch-hq``
52-
2. Access HQ with: `` http://localhost:5000 ``
53-
54-
For further instructions, please see relevant documentation: [Docker Images](http://docs.elastichq.org/installation.html#docker-images).
55-
5656
## OpenShift Installation
5757

5858
Please see relevant documentation: [ElasticHQ on OpenShift](openshift/README.md).

‎docs/.buildinfo

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
11
# Sphinx build info version 1
22
# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
3-
config: 7941a7fdcaed6c9c9192da5b0438d143
3+
config: d95de450ee0c2c25942b746b3626a6b0
44
tags: 645f666f9bcd5a90fca523b33c5a78b7

‎docs/.doctrees/environment.pickle

844 Bytes
Binary file not shown.

‎docs/.doctrees/index.doctree

0 Bytes
Binary file not shown.

‎docs/.doctrees/installation.doctree

2.54 KB
Binary file not shown.

‎docs/.doctrees/rest-api.doctree

0 Bytes
Binary file not shown.

‎docs/_sources/index.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ ElasticHQ Documentation
44

55

66
.. toctree::
7-
:includehidden:
7+
:hidden:
88

99
installation
1010
rest-api

‎docs/_sources/installation.txt

Lines changed: 46 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -3,23 +3,46 @@ Getting Started
33
===============
44

55
.. contents:: Table of Contents
6-
:depth: 3
6+
:depth: 2
77
:local:
88

9-
10-
119
Quick-Start Guide
1210
-----------------
1311

12+
1. :any:`docker images`
13+
2. :any:`run from source`
14+
15+
.. _docker images:
16+
17+
Running with Docker
18+
-------------------
19+
20+
Docker images are offered on the `ElasticHQ Dockerhub <https://hub.docker.com/r/elastichq/elasticsearch-hq/>`_.
21+
22+
Run with:
23+
24+
.. code-block:: bash
25+
26+
docker run -p 5000:5000 elastichq/elasticsearch-hq
27+
28+
Access HQ with: http://localhost:5000
29+
30+
When starting with Docker, see :any:`environment variables` for passing startup args. Environment variables are passed to docker using the `-e` flag.
31+
32+
ie. ``-e HQ_DEFAULT_URL='http://aa.com:1212'``
33+
34+
.. note:: The ``latest`` tag deploys the latest stable release. Where ``develop`` is the latest unstable working branch.
1435

15-
Installation
16-
------------
36+
.. _run from source:
37+
38+
Install from Source
39+
-------------------
1740

1841
Requirements
1942
^^^^^^^^^^^^
2043

2144
* Python 3.4+
22-
* Elasticsearch. Supported versions: 2.x, 5.x, 6.x
45+
* Elasticsearch. Supported versions: 2.x, 5.x, 6.x, 7.x
2346

2447
Install ElasticHQ
2548
^^^^^^^^^^^^^^^^^
@@ -31,24 +54,6 @@ Install ElasticHQ
3154

3255
.. note:: Alternatively, you can start the server with ``python manage.py runserver``
3356

34-
.. _docker images:
35-
36-
Docker Images
37-
^^^^^^^^^^^^^
38-
39-
Docker images are offered on the `ElasticHQ Dockerhub <https://hub.docker.com/r/elastichq/elasticsearch-hq/>`_.
40-
41-
The ``latest`` tag deploys the latest stable release. Where ``develop`` is the latest unstable working branch.
42-
43-
When starting with Docker, see :any:`environment variables` for passing startup args. Environment variables are passed to docker using the `-e` flag.
44-
45-
ie. ``-e HQ_DEFAULT_URL='http://aa.com:1212'``
46-
47-
To run/install container:
48-
49-
``docker run -p 5000:5000 elastichq/elasticsearch-hq``
50-
51-
Access HQ with: http://localhost:5000
5257

5358
Pre-Releases
5459
^^^^^^^^^^^^
@@ -103,6 +108,15 @@ The ``application.py`` start script takes parameters passed in as arguments from
103108
``--verify_certs`` True Whether HQ should attempt to validate certs. Set to False for self-signed certs.
104109
================== ========================= ================================================================================
105110

111+
Example:
112+
========
113+
114+
.. code-block:: bash
115+
116+
python -m application
117+
--enable-ssl
118+
--ca-certs /path/to/your/ca.crt
119+
106120
.. _environment variables:
107121

108122
Environment Variables
@@ -118,6 +132,14 @@ Environment Variables
118132
``HQ_DEBUG`` False If True, enables debug level on logging.
119133
=================== ========================= ================================================================================
120134

135+
Example:
136+
========
137+
138+
.. code-block:: bash
139+
140+
docker run -p 5000:5000 elastichq/elasticsearch-hq
141+
-e HQ_DEFAULT_URL='http://aa.com:1212'
142+
-e HQ_ENABLE_SSL=False
121143

122144
Logging
123145
^^^^^^^

‎docs/developer-guide.html

Lines changed: 21 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -66,10 +66,8 @@ <h3>Navigation</h3>
6666
<a href="#"><span class="glyphicon glyphicon-align-justify" aria-hidden="true"></span></a>
6767
</div>
6868
<div id="left-column">
69-
<div class="sphinxsidebar">
70-
<a href="
69+
<div class="sphinxsidebar"><a href="
7170
index.html" class="text-logo">ElasticHQ</a>
72-
7371
<div class="sidebar-block">
7472
<div class="sidebar-wrapper">
7573
<h2>Table Of Contents</h2>
@@ -82,12 +80,27 @@ <h2>Table Of Contents</h2>
8280
<li class="toctree-l1"><a class="reference internal" href="rest-api.html">REST API</a></li>
8381
<li class="toctree-l1 current"><a class="current reference internal" href="#">For Developers</a><ul>
8482
<li class="toctree-l2"><a class="reference internal" href="#contributing">Contributing</a></li>
85-
<li class="toctree-l2"><a class="reference internal" href="#developer-environment">Developer Environment</a></li>
86-
<li class="toctree-l2"><a class="reference internal" href="#building-pre-releases">Building Pre-Releases</a></li>
83+
<li class="toctree-l2"><a class="reference internal" href="#developer-environment">Developer Environment</a><ul>
84+
<li class="toctree-l3"><a class="reference internal" href="#set-debug-to-true">Set Debug to True</a></li>
85+
</ul>
86+
</li>
87+
<li class="toctree-l2"><a class="reference internal" href="#building-pre-releases">Building Pre-Releases</a><ul>
88+
<li class="toctree-l3"><a class="reference internal" href="#install-build-the-ui">Install/Build the UI</a></li>
89+
<li class="toctree-l3"><a class="reference internal" href="#building-a-distribution">Building a Distribution</a></li>
90+
<li class="toctree-l3"><a class="reference internal" href="#pulling-a-tag-from-dockerhub">Pulling a tag from DockerHub</a></li>
91+
</ul>
92+
</li>
8793
<li class="toctree-l2"><a class="reference internal" href="#running-tests">Running Tests</a></li>
88-
<li class="toctree-l2"><a class="reference internal" href="#manual-testing">Manual Testing</a></li>
94+
<li class="toctree-l2"><a class="reference internal" href="#manual-testing">Manual Testing</a><ul>
95+
<li class="toctree-l3"><a class="reference internal" href="#notes">Notes</a></li>
96+
</ul>
97+
</li>
8998
<li class="toctree-l2"><a class="reference internal" href="#building-documentation">Building Documentation</a></li>
90-
<li class="toctree-l2"><a class="reference internal" href="#http-responses">HTTP Responses</a></li>
99+
<li class="toctree-l2"><a class="reference internal" href="#http-responses">HTTP Responses</a><ul>
100+
<li class="toctree-l3"><a class="reference internal" href="#http-status">HTTP Status</a></li>
101+
<li class="toctree-l3"><a class="reference internal" href="#response-headers">Response Headers</a></li>
102+
</ul>
103+
</li>
91104
<li class="toctree-l2"><a class="reference internal" href="#issues-bugs">Issues/Bugs</a></li>
92105
</ul>
93106
</li>
@@ -97,7 +110,6 @@ <h2>Table Of Contents</h2>
97110

98111
</div>
99112
</div>
100-
101113
<div class="sidebar-block">
102114
<div class="sidebar-wrapper">
103115
<div id="main-search">
@@ -111,6 +123,7 @@ <h2>Table Of Contents</h2>
111123
</div>
112124
</div>
113125
</div>
126+
114127
</div>
115128
</div>
116129
<div id="right-column">

‎docs/faq.html

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -62,10 +62,8 @@ <h3>Navigation</h3>
6262
<a href="#"><span class="glyphicon glyphicon-align-justify" aria-hidden="true"></span></a>
6363
</div>
6464
<div id="left-column">
65-
<div class="sphinxsidebar">
66-
<a href="
65+
<div class="sphinxsidebar"><a href="
6766
index.html" class="text-logo">ElasticHQ</a>
68-
6967
<div class="sidebar-block">
7068
<div class="sidebar-wrapper">
7169
<h2>Table Of Contents</h2>
@@ -87,7 +85,6 @@ <h2>Table Of Contents</h2>
8785

8886
</div>
8987
</div>
90-
9188
<div class="sidebar-block">
9289
<div class="sidebar-wrapper">
9390
<div id="main-search">
@@ -101,6 +98,7 @@ <h2>Table Of Contents</h2>
10198
</div>
10299
</div>
103100
</div>
101+
104102
</div>
105103
</div>
106104
<div id="right-column">

0 commit comments

Comments
 (0)