diff --git a/README.md b/README.md index e1faa25..8a60171 100644 --- a/README.md +++ b/README.md @@ -7,15 +7,56 @@ see [REST API](REST.md) ## Build & run -### Docker - First of all, you should generate [API key](http://docs.grafana.org/tutorials/api_org_token_howto/) in your Grafana instance. Without API key hastic-server will not be able to use your datasources. +### Docker + Example of running hastic-server in Docker: ``` docker build -t hastic-server . -docker run -d --name hastic-server -p 80:8000 -e API_KEY= hastic-server +docker run -d --name hastic-server -p 80:8000 -e HASTIC_API_KEY= hastic-server +``` + +### Linux + +#### Environment variables + +You can export following environment variables for hastic-server to use: +- HASTIC_API_KEY - (required) API-key of your Grafana instance +- HASTIC_PORT - (optional) port you want to run server on, default: 8000 + +#### Dependencies + +- python3 with: + - pip + - pandas + - seglearn + - scipy + - tsfresh +- nodejs >= 9 + +Example of running hastic-server on Debian / Ubuntu host: + +``` +$ export HASTIC_API_KEY= +$ export HASTIC_PORT= +# apt-get install python3 \ + python3-pip \ + gnupg \ + curl \ + make \ + g++ \ + git +$ pip3 install pandas +$ pip3 install seglearn +$ pip3 install scipy +$ pip3 install tsfresh +$ curl -sL https://deb.nodesource.com/setup_9.x | bash - +# apt-get update && apt-get install -y nodejs +$ cd server +$ npm install && npm run build +$ npm start ```