Commit cd845069 authored by Leonardo Menezes's avatar Leonardo Menezes
Browse files

polished readme.md

parent ca0ca0ad
Loading
Loading
Loading
Loading
+25 −13
Original line number Diff line number Diff line
cerebro
=======================
Cerebro
------------

cerebro is an open source(MIT License) elasticsearch web admin tool.

Installation
------------

- Download from ...
##Installation
- Download from [https://github.com/lmenezes/cerebro/releases](https://github.com/lmenezes/cerebro/releases)
- Extract files
- Run bin/cerebro on unix, of bin/cerebro.bar on Windows
- Run bin/cerebro(or bin/cerebro.bar if on Windows)
- Access on http://localhost:9000

Screenshots
------------
#### cluster overview
![cluster overview](imgs/cluster_view.png)
##Configuration
You can further customize Cerebro by editing its conf/application.conf file.

###List of known hosts
A list of predefined hosts can be defined for quicker access. If host is password protected, authentication should be also set.

Example:

####REST Client
![rest client](imgs/rest_client.png)
```yaml
hosts: [
	{
		host: http://localhost:9200
	},
	{
    	host = "http://some-authenticated-host:9200",
  		auth = {
       		username = "username"
			password = "secret-password"
	}
]
```
 No newline at end of file
+7 −0
Original line number Diff line number Diff line
@@ -12,6 +12,13 @@ application.secret="ki:s:[[@=Ag?QI`W2jMwkY:eqvrJ]JqoJyi2axj3ZvOv^/KavOT4ViJSv?6Y
application.langs="en"

hosts = [
  #{
  #  host = "http://some-authenticated-host:9200",
  #  auth = {
  #    username = "username"
  #    password = "secret-password"
  #  }
  #},
  {
    host = "http://localhost:9200"
  }