https://github.com/lmenezes/elasticsearch-kopf

web admin interface for elasticsearch
https://github.com/lmenezes/elasticsearch-kopf

Last synced: 4 months ago
JSON representation

web admin interface for elasticsearch

• Host: GitHub
• URL: https://github.com/lmenezes/elasticsearch-kopf
• Owner: lmenezes
• License: mit
• Archived: true
• Created: 2013-08-16T16:33:49.000Z (over 11 years ago)
• Default Branch: master
• Last Pushed: 2019-11-21T06:29:38.000Z (about 5 years ago)
• Last Synced: 2024-09-21T16:15:01.602Z (4 months ago)
• Language: JavaScript
• Size: 8.46 MB
• Stars: 2,413
• Watchers: 133
• Forks: 333
• Open Issues: 43
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

• awesome-elasticsearch - Kopf - Another management plugin that have REST console and *manual* shard allocation (Elasticsearch plugins / Cluster)
• elasticsearch-collection - Kopf - Another management plugin that have REST console and *manual* shard allocation (Elasticsearch plugins / Cluster)
• awesome-starred - lmenezes/elasticsearch-kopf - web admin interface for elasticsearch (others)

README

        
kopf

=======================

kopf is a simple web administration tool for [elasticsearch](http://elastic.co) written in JavaScript + AngularJS + jQuery + Twitter bootstrap.

It offers an easy way of performing common tasks on an elasticsearch cluster. Not every single API is covered by this plugin, but it does offer a REST client which allows you to explore the full potential of the ElasticSearch API.

## Important:

Kopf is no longer maintained. A replacement(cerebro) has been developed and is currently maintained at [https://github.com/lmenezes/cerebro](https://github.com/lmenezes/cerebro). At this point, cerebro should be pretty much feature equivalent of kopf, with a few new features on top.

Versions

------------

| elasticsearch version | branch | latest version  |

| --------------------- | ------ | --------------- |

| 0.90.X                | 0.90   | v0.90           |

| 1.X                   | 1.0    | v1.6.1          |

| 2.X                   | 2.0    | v2.1.1          |

Installation

------------

You can either install a specific version(using its release tag) or the most up to date version from a given branch.

####Installing on an Elasticsearch instance:

```bash

./elasticsearch/bin/plugin install lmenezes/elasticsearch-kopf/{branch|version}

open http://localhost:9200/_plugin/kopf

```

####Run locally:

```bash

git clone git://github.com/lmenezes/elasticsearch-kopf.git

cd elasticsearch-kopf

git checkout {branch|version}

open _site/index.html

```

ps: local execution doesn't work with Chrome(and maybe other browsers). See more [here](http://docs.angularjs.org/api/ng.directive:ngInclude).

Alternatively you can run it via `connect` which should solve the `ng-include` issue.

```bash

git clone git://github.com/lmenezes/elasticsearch-kopf.git

cd elasticsearch-kopf

git checkout {branch|version}

npm install

grunt server

```

Browse to .

####Kopf behind a reverse proxy

Example configuration for nginx:

```

server {

  listen       8080;

  server_name  localhost;

  location ~ ^/es.*$ {

    proxy_pass http://localhost:9200;

    rewrite ^/es(.*) /$1 break;

  }

  location ~ ^/kopf/.*$ {

    proxy_pass http://localhost:9200;

    rewrite ^/kopf/(.*) /_plugin/kopf/$1 break;

  }

}

```

Example configuration for kopf(kopf_external_settings.json):

```json

{

  "elasticsearch_root_path": "/es",

  "with_credentials": false,

  "theme": "dark",

  "refresh_rate": 5000

}

```

Access kopf at http://localhost:8080/kopf/

####Try it online:

```

http://lmenezes.com/elasticsearch-kopf/?location=http://localhost:9200

```

####Basic HTTP Auth support:

```

http://lmenezes.com/elasticsearch-kopf/?location=http://user:pwd@localhost:9200

```

if using https://github.com/Asquera/elasticsearch-http-basic, try:

```

http://lmenezes.com/elasticsearch-kopf/?location=http://user:pwd@localhost:9200//

```

The plugin modifies the base elasticsearch response and therefore this workaround is needed.

Screenshots

------------

####cluster overview

![cluster overview](imgs/cluster_view.png)

####header reflects cluster state

![cluster state](imgs/cluster_state.png)

####REST Client

![rest client](imgs/rest_client.png)

####aliases management

![aliases management](imgs/aliases.png)

####warmers management

![warmers management](imgs/warmer.png)

####percolator

![percolator](imgs/percolator.png)

####snapshots management

![snapshots management](imgs/snapshot.png)

####analysis api

![analysis api](imgs/analysis.png)