# ElasticHQ

**Repository Path**: mirrors/ElasticHQ

## Basic Information

- **Project Name**: ElasticHQ
- **Description**: ElasticHQ 是一个基于浏览器的直观和功能强大的 ElasticSearch 管理和监控工具，它提供了对 ElasticSearch 的实时监控、全集群管理、搜索和查询等功能
- **Primary Language**: JavaScript
- **License**: Apache-2.0
- **Default Branch**: master
- **Homepage**: https://www.oschina.net/p/elastic+hq
- **GVP Project**: No

## Statistics

- **Stars**: 7
- **Forks**: 2
- **Created**: 2017-12-05
- **Last Updated**: 2026-02-21

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# ElasticHQ

## This project is no longer maintained. Use at your own risk.  
#### It has become too time-consuming to maintain this project with Elasticsearch acting as a moving target. Elastic's license changes, frequent backwards incompatibilities, and [crippling](https://github.com/elastic/elasticsearch-py/pull/1623) of their "open source" python libs were too much to keep up with. 

Simplified Monitoring and Management for ElasticSearch clusters.

[![gitHub stars](https://img.shields.io/github/stars/ElasticHQ/elasticsearch-HQ.svg)](https://github.com/ElasticHQ/elasticsearch-HQ)
[![docker pulls](https://img.shields.io/docker/pulls/elastichq/elasticsearch-hq.svg)](https://hub.docker.com/r/elastichq/elasticsearch-hq 'DockerHub')
[![latest](https://img.shields.io/github/release/ElasticHQ/elasticsearch-HQ.svg)](https://github.com/ElasticHQ/elasticsearch-HQ)
[![gitHub issues](https://img.shields.io/github/issues/ElasticHQ/elasticsearch-HQ.svg)](https://github.com/ElasticHQ/elasticsearch-HQ)
![python](https://img.shields.io/badge/python-v3.4%20%2F%20v3.6-blue.svg)
[![license](https://img.shields.io/badge/license-ASL-blue.svg)](https://opensource.org/licenses/ASL)


![alt text](https://raw.githubusercontent.com/ElasticHQ/elasticsearch-HQ/master/main_dashboard.png)

  
## Key Features

* Works with 2.x, 5.x, 6.x, 7.x and current versions of Elasticsearch. 
* Monitor **many** clusters at once.
* Monitor Nodes, Indices, Shards, and general cluster metrics.
* Create and maintain Elasticsearch Indices.
* One-Click access to ES API and cat API endpoints.
* Easy-to-Use Querying capabilities.
* Copy mappings and reindex Indices.
* Real-time monitoring charts of important metrics.
* Diagnostics check-up helps alert to specific nodes having issues.
* Active project used by Fortune 100 companies around the world.
* Free and (Real) Open Source. ;-)

## 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

* Python 3.6

### Instructions

For **full** installation and configuration instructions, see [Getting Started](http://docs.elastichq.org/installation.html)

1. Download or clone the repository. 
2. Open terminal and point to root of repository. Type: ``pip install -r requirements.txt``
3. Run server with: `` python3 application.py ``. Alternatively: ``./manage.py runserver``
4. Access HQ with: `` http://localhost:5000 ``

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

## OpenShift Installation

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

## Useful Links

* [Documentation](http://docs.elastichq.org)
* [Official Website](http://www.elastichq.org)
* [Docker Images](https://hub.docker.com/r/elastichq/elasticsearch-hq/)
* [Google Group](https://groups.google.com/d/forum/elastichq)