diff --git a/README.md b/README.md
index 4f2c8a7b..d53dfb9e 100644
--- 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
index de623a26..843757ed 100644
--- 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
index b554b675..f0fb7c8b 100644
Binary files a/docs/.doctrees/environment.pickle and b/docs/.doctrees/environment.pickle differ
diff --git a/docs/.doctrees/index.doctree b/docs/.doctrees/index.doctree
index e2af0196..95839178 100644
Binary files a/docs/.doctrees/index.doctree and b/docs/.doctrees/index.doctree differ
diff --git a/docs/.doctrees/installation.doctree b/docs/.doctrees/installation.doctree
index e4ea9531..a8d1c2dc 100644
Binary files a/docs/.doctrees/installation.doctree and b/docs/.doctrees/installation.doctree differ
diff --git a/docs/.doctrees/rest-api.doctree b/docs/.doctrees/rest-api.doctree
index 97cba0b2..4a8a8dcd 100644
Binary files a/docs/.doctrees/rest-api.doctree and b/docs/.doctrees/rest-api.doctree differ
diff --git a/docs/_sources/index.txt b/docs/_sources/index.txt
index 9cd1a7c9..24605632 100644
--- 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
index 833b57b5..8c1ccfc2 100644
--- 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
Docker images are offered on the ElasticHQ Dockerhub.
+Run with:
+docker run -p 5000:5000 elastichq/elasticsearch-hq
+
Access HQ with: http://localhost:5000
+When starting with Docker, see 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.
pip install -r requirements.txt
python manage.py runserver
Docker images are offered on the ElasticHQ Dockerhub.
-The latest
tag deploys the latest stable release. Where develop
is the latest unstable working branch.
When starting with Docker, see 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-release versions are made available as branches in the github repository. We use GitFlow methodology and adhere to semantic versioning.
@@ -231,7 +264,7 @@The application.py
start script takes parameters passed in as arguments from the command line:
+@@ -278,9 +311,17 @@
Configuration
python -m application
+--enable-ssl
+--ca-certs /path/to/your/ca.crt
+
+
@@ -318,6 +359,14 @@ Configuration
docker run -p 5000:5000 elastichq/elasticsearch-hq
+-e HQ_DEFAULT_URL='http://aa.com:1212'
+-e HQ_ENABLE_SSL=False
+
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. The Docker container available on DockerHub is pre-configured to run with gunicorn, and is preferred. See the Docker Images
+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 Running with Docker
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:
gunicorn -w 1 -b :5000 --worker-class eventlet application:application
DELETE
/api/clusters/
(string: cluster_name)/_connect
¶DELETE
/api/clusters/_connect
¶Deletes a connection from the connection pool and the database, by cluster name.
+Note: | This method does NOT delete your Elasticsearch Cluster, just the connection from HQ to it. | +
---|
Example request:
+DELETE /clusters/_connect/<CLUSTER_NAME> HTTP/1.1
+Accept: application/json
+
Parameters: |
|
+
---|---|
Returns: | List of active clusters. + |
+
Status Codes: |
|
+
POST
/api/clusters/
(string: cluster_name)/_connect
¶DELETE
/api/clusters/
(string: cluster_name)/_connect
¶DELETE
/api/clusters/_connect
¶Deletes a connection from the connection pool and the database, by cluster name.
-Note: | This method does NOT delete your Elasticsearch Cluster, just the connection from HQ to it. | -
---|
Example request:
-DELETE /clusters/_connect/<CLUSTER_NAME> HTTP/1.1
-Accept: application/json
-
Parameters: |
|
-
---|---|
Returns: | List of active clusters. - |
-
Status Codes: |
|
-
GET
/api/indices/
(string: cluster_name)/
(string: index_name)¶GET
/api/indices/
(string: cluster_name)¶Wrapper around https://www.elastic.co/guide/en/elasticsearch/reference/current/indices-get-index.html
-Parameters: |
|
-
---|---|
Return: | - |
POST
/api/indices/
(string: cluster_name)/
(string: index_name)¶GET
/api/indices/
(string: cluster_name)/
(string: index_name)¶GET
/api/indices/
(string: cluster_name)¶Wrapper around https://www.elastic.co/guide/en/elasticsearch/reference/current/indices-get-index.html
+Parameters: |
|
+
---|---|
Return: | + |
GET
/api/indices/
(string: cluster_name)/
(string: index_name)/
(string: alias_name)/_aliases
¶DELETE
/api/indices/
(string: cluster_name)/
(string: index_name)/
(string: alias_name)/_aliases
¶GET
/api/indices/
(string: cluster_name)/
(string: index_name)/_aliases
¶DELETE
/api/indices/
(string: cluster_name)/
(string: index_name)/_aliases
¶GET
/api/indices/
(string: cluster_name)/_aliases
¶Get all aliases for this index
+DELETE
/api/indices/
(string: cluster_name)/_aliases
¶Deletes an alias.