Browse Source

docs++

pull/1/head
Alexey Velikiy 7 years ago
parent
commit
d67313e2af
  1. 15
      HOOKS.md
  2. 18
      README.md

15
HOOKS.md

@ -5,10 +5,10 @@ It's possible to get notifications about new anomalies via [WebHooks](https://en
You need to set variable `HASTIC_ALERT_ENDPOINT` with your endpoint and expects `POST` methods You need to set variable `HASTIC_ALERT_ENDPOINT` with your endpoint and expects `POST` methods
from hastic-server if format: from hastic-server if format:
``` ```json
{ {
anomaly: 'cpu_load', "anomaly": "cpu_load",
status: <str> "status": "OK"
} }
``` ```
@ -26,9 +26,12 @@ docker run -d --name hastic-server -p 80:8000 -e HASTIC_API_KEY=<your_grafana_ap
Add variable before launch node.js server Add variable before launch node.js server
```bash ```bash
$ export HASTIC_ALERT_ENDPOINT=http://alert.example.com export HASTIC_API_KEY=<your_grafana_api_key>
$ cd hastic-server/server export HASTIC_PORT=<port_you_want_to_run_server_on>
$ npm start export HASTIC_ALERT_ENDPOINT=http://alert.example.com
cd hastic-server/server
npm start
``` ```

18
README.md

@ -18,8 +18,15 @@ API key role needs only `Viewer` access.
Example of running hastic-server in Docker: Example of running hastic-server in Docker:
#### Build
```bash ```bash
git clone https://github.com/hastic/hastic-server.git
cd hastic-server
docker build -t hastic-server . docker build -t hastic-server .
```
#### Run
```bash
docker run -d --name hastic-server -p 80:8000 -e HASTIC_API_KEY=<your_grafana_api_key> hastic-server docker run -d --name hastic-server -p 80:8000 -e HASTIC_API_KEY=<your_grafana_api_key> hastic-server
``` ```
@ -35,10 +42,10 @@ You can export following environment variables for hastic-server to use:
You need in your system: You need in your system:
* [nodejs >= 6.0.0](https://nodejs.org/en/download/package-manager/) * [nodejs >= 6.0.0](https://nodejs.org/en/download/package-manager/)
* [python3 python3-pip](https://www.python.org/downloads/) * [python3](https://www.python.org/downloads/) with pip3
* curl gnupg git make g++ * curl gnupg git make g++
### Intallation #### Intallation
```bash ```bash
pip3 install pandas seglearn scipy tsfresh pip3 install pandas seglearn scipy tsfresh
@ -46,13 +53,12 @@ git clone https://github.com/hastic/hastic-server.git
cd ./hastic-server/server cd ./hastic-server/server
npm install npm install
npm run build npm run build
``` ```
### Run #### Run
```bash ```bash
$ export HASTIC_API_KEY=<your_grafana_api_key> export HASTIC_API_KEY=<your_grafana_api_key>
$ export HASTIC_PORT=<port_you_want_to_run_server_on> export HASTIC_PORT=<port_you_want_to_run_server_on>
cd ./hastic-server/server cd ./hastic-server/server
npm start npm start

Loading…
Cancel
Save