|
1 | 1 | # Elastalert Server |
2 | 2 | **A server that runs [ElastAlert](https://github.com/Yelp/elastalert) and exposes REST API's for manipulating rules and alerts. It works great in combination with our [ElastAlert Kibana plugin](https://github.com/bitsensor/elastalert-kibana-plugin).** |
3 | 3 |
|
4 | | -## Requirements |
5 | | -- Docker |
6 | | - |
7 | 4 | ## Docker installation |
8 | | -First, build the container locally: |
9 | | -```bash |
10 | | -docker build . -t elastalert |
11 | | -``` |
12 | | -The default configuration uses localhost as ES host. |
| 5 | +The default configuration uses localhost as ES host. You will want to mount the volumes for configuration and rule files to keep them after container updates. In order to do that conviniently, please do a `git clone https://github.com/bitsensor/elastalert.git; cd elastalert` |
13 | 6 |
|
14 | | -_Bash_ |
| 7 | +### Bash |
15 | 8 | ```bash |
16 | 9 | docker run -d -p 3030:3030 \ |
17 | 10 | -v `pwd`/config/elastalert.yaml:/opt/elastalert/config.yaml \ |
18 | 11 | -v `pwd`/config/config.json:/opt/elastalert-server/config/config.json \ |
19 | 12 | -v `pwd`/rules:/opt/elastalert/rules \ |
20 | 13 | -v `pwd`/rule_templates:/opt/elastalert/rule_templates \ |
21 | | - -v `pwd`/elastalert_modules:/opt/elastalert/elastalert_modules \ |
22 | 14 | --net="host" \ |
23 | | - --name elastalert elastalert:latest |
| 15 | + --name elastalert bitsensor/elastalert:latest |
24 | 16 | ``` |
25 | 17 |
|
26 | | -_Fish_ |
| 18 | +### Fish |
27 | 19 | ```bash |
28 | 20 | docker run -d -p 3030:3030 \ |
29 | 21 | -v (pwd)/config/elastalert.yaml:/opt/elastalert/config.yaml \ |
30 | 22 | -v (pwd)/config/config.json:/opt/elastalert-server/config/config.json \ |
31 | 23 | -v (pwd)/rules:/opt/elastalert/rules \ |
32 | 24 | -v (pwd)/rule_templates:/opt/elastalert/rule_templates \ |
33 | | - -v (pwd)/elastalert_modules:/opt/elastalert/elastalert_modules \ |
34 | 25 | --net="host" \ |
35 | | - --name elastalert elastalert:latest |
| 26 | + --name elastalert bitsensor/elastalert:latest |
36 | 27 | ``` |
37 | 28 | ### Configuration |
38 | 29 | #### ElastAlert parameters |
39 | 30 | ElastAlert supports additional arguments, that can be passed in the `config.json` file. An example is given in `config/config-historic-data-example.json`. |
40 | 31 |
|
41 | | - |
42 | | - |
43 | 32 | ## Installation using npm and manual ElastAlert setup |
44 | 33 |
|
45 | 34 | ### Requirements |
|
0 commit comments