Skip to content

Commit d3d8df2

Browse files
author
Ruben van Vreeland
committed
Update readme to use prebuild dockerfile
1 parent f4e2a12 commit d3d8df2

File tree

1 file changed

+5
-16
lines changed

1 file changed

+5
-16
lines changed

README.md

Lines changed: 5 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -1,45 +1,34 @@
11
# Elastalert Server
22
**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).**
33

4-
## Requirements
5-
- Docker
6-
74
## 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`
136

14-
_Bash_
7+
### Bash
158
```bash
169
docker run -d -p 3030:3030 \
1710
-v `pwd`/config/elastalert.yaml:/opt/elastalert/config.yaml \
1811
-v `pwd`/config/config.json:/opt/elastalert-server/config/config.json \
1912
-v `pwd`/rules:/opt/elastalert/rules \
2013
-v `pwd`/rule_templates:/opt/elastalert/rule_templates \
21-
-v `pwd`/elastalert_modules:/opt/elastalert/elastalert_modules \
2214
--net="host" \
23-
--name elastalert elastalert:latest
15+
--name elastalert bitsensor/elastalert:latest
2416
```
2517

26-
_Fish_
18+
### Fish
2719
```bash
2820
docker run -d -p 3030:3030 \
2921
-v (pwd)/config/elastalert.yaml:/opt/elastalert/config.yaml \
3022
-v (pwd)/config/config.json:/opt/elastalert-server/config/config.json \
3123
-v (pwd)/rules:/opt/elastalert/rules \
3224
-v (pwd)/rule_templates:/opt/elastalert/rule_templates \
33-
-v (pwd)/elastalert_modules:/opt/elastalert/elastalert_modules \
3425
--net="host" \
35-
--name elastalert elastalert:latest
26+
--name elastalert bitsensor/elastalert:latest
3627
```
3728
### Configuration
3829
#### ElastAlert parameters
3930
ElastAlert supports additional arguments, that can be passed in the `config.json` file. An example is given in `config/config-historic-data-example.json`.
4031

41-
42-
4332
## Installation using npm and manual ElastAlert setup
4433

4534
### Requirements

0 commit comments

Comments
 (0)