honeymoose
/
OpenSearch
mirror of https://github.com/honeymoose/OpenSearch.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Updated readme file to include sense usage 

Original commit: elastic/x-pack-elasticsearch@e9ec1f9a78
This commit is contained in:
Boaz Leskes 2014-03-11 21:01:54 +01:00
parent f113d4c052
commit c4c757801a
1 changed files with 10 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
README.md
View File

@ -9,13 +9,22 @@ The easiest way to play/get to know Marvel is to install the latest release vers
Once done, open up the following url (assuming standard ES config): http://localhost:9200/_plugin/marvel . This will take you to the Overview Dashboard. Use Kibana's Load dashboard menu to navigate to the Cluster Pulse dashboard
## I just want to run Sense
To run Sense, checkout a copy of this repo. You can now double click `sense/index.html` and it will open in your default browser.
For a cleaner experience, we recommend using something like http://anvilformac.com and point it at the repo checkout. Once done you can access Sense via `http://webserver/sense/`, for example http://elasticsearch-marvel.dev/sense if using Anvil.
Note: to run the Kibana side of Marvel, you'd need to install grunt as described bellow.
## Grunt build system (for running the UI from a code checkout)
This grunt-based build system handles Kibana development environment setup for Marvel as well as building, packaging and distribution of the Marvel plugin. Note that you **must** run *grunt setup* before any other tasks as this build system reuses parts of the Kibana build system that must be fetched
### Installing
You will need node.js+npm and grunt. Node is available via brew, install grunt with the command below. Once grunt is installed you may run grunt tasks to setup your environment and build Marvel
```npm install -g grunt```
```npm install -g grunt-cli```
```npm install```
### Tasks