Skip to content

Commit e61e162

Browse files
Make master branch guide to the correct branch for specific Kibana version
1 parent 2f75406 commit e61e162

34 files changed

+5
-4633
lines changed

.editorconfig

Lines changed: 0 additions & 14 deletions
This file was deleted.

.eslintrc

Lines changed: 0 additions & 76 deletions
This file was deleted.

.gitignore

Lines changed: 0 additions & 6 deletions
This file was deleted.

.gitlab-ci.yml

Lines changed: 0 additions & 29 deletions
This file was deleted.

.node-version

Lines changed: 0 additions & 1 deletion
This file was deleted.

README.md

Lines changed: 5 additions & 73 deletions
Original file line numberDiff line numberDiff line change
@@ -1,77 +1,9 @@
11
# ElastAlert Kibana plugin
2-
32
![img](https://www.bitsensor.io/assets/img/screenshots/template.gif)
43

5-
## Installation from build
6-
Kibana 4
7-
```bash
8-
./bin/kibana plugin -i elastalert -u https://git.bitsensor.io/front-end/elastalert-kibana-plugin/builds/artifacts/develop/raw/build/elastalert-latest.zip?job=build
9-
```
10-
11-
Kibana 5
12-
```bash
13-
./bin/kibana-plugin install https://git.bitsensor.io/front-end/elastalert-kibana-plugin/builds/artifacts/kibana5/raw/artifact/elastalert-`pwd | grep -Po '(?<=kibana-)[^-]*'`-latest.zip?job=build
14-
```
15-
16-
Kibana 5 (if you have renamed the `kibana-5.x.x` folder
17-
```bash
18-
./bin/kibana-plugin install https://git.bitsensor.io/front-end/elastalert-kibana-plugin/builds/artifacts/kibana5/raw/artifact/elastalert-5.x.x-latest.zip?job=build
19-
```
20-
21-
Append to the `config/kibana.yml` file the host of ElastAlert server, if it is different than localhost. Typically the case if you are running on macOS.
22-
```
23-
elastalert.serverHost: docker.for.mac.localhost
24-
```
25-
26-
## Starting the [ElastAlert](https://github.com/bitsensor/elastalert) server
27-
28-
### Docker installation
29-
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.
30-
31-
In order to do that conviniently, please do a `git clone https://github.com/bitsensor/elastalert.git; cd elastalert`
32-
33-
#### Bash
34-
```bash
35-
docker run -d -p 3030:3030 \
36-
-v `pwd`/config/elastalert.yaml:/opt/elastalert/config.yaml \
37-
-v `pwd`/config/config.json:/opt/elastalert-server/config/config.json \
38-
-v `pwd`/rules:/opt/elastalert/rules \
39-
-v `pwd`/rule_templates:/opt/elastalert/rule_templates \
40-
--net="host" \
41-
--name elastalert bitsensor/elastalert:latest
42-
```
43-
44-
#### Fish
45-
```bash
46-
docker run -d -p 3030:3030 \
47-
-v (pwd)/config/elastalert.yaml:/opt/elastalert/config.yaml \
48-
-v (pwd)/config/config.json:/opt/elastalert-server/config/config.json \
49-
-v (pwd)/rules:/opt/elastalert/rules \
50-
-v (pwd)/rule_templates:/opt/elastalert/rule_templates \
51-
--net="host" \
52-
--name elastalert bitsensor/elastalert:latest
53-
```
54-
55-
A more detailed description is available at the [ElastAlert](https://github.com/bitsensor/elastalert) repository.
56-
57-
## Building artifact from source
58-
59-
```bash
60-
npm run build
61-
```
62-
63-
## Development
64-
65-
### Branch strategy
66-
The repository is split in a `develop` branch, targeted at Kibana 4 development, and a `kibana5` branch.
67-
If changes are made in develop that should be applied to all kibana versions, make sure to pick that commit in both the develop as well as `kibana5` branch.
68-
69-
### Tests
70-
Run the browser tests in a real web browser, or mocha.
71-
```bash
72-
npm run test:browser
73-
npm run test:server
74-
```
4+
## Installation
5+
Check the installation guide inside the branch that matches your Kibana version.
756

76-
## Kibana Plugin Development
77-
See the [kibana contributing guide](https://github.com/elastic/kibana/blob/master/CONTRIBUTING.md) for instructions setting up your development environment. Once you have completed that, use the following npm tasks within Kibana.
7+
- [Kibana 4.6.6](https://github.com/bitsensor/elastalert-kibana-plugin/tree/4.6.6)
8+
- [Kibana 5.6.8](https://github.com/bitsensor/elastalert-kibana-plugin/tree/5.6.8)
9+
- [Kibana 6.2.3](https://github.com/bitsensor/elastalert-kibana-plugin/tree/6.2.3) (experimental)

build_package_without_kibana.patch

Lines changed: 0 additions & 16 deletions
This file was deleted.

create_package_without_kibana.patch

Lines changed: 0 additions & 16 deletions
This file was deleted.

index.js

Lines changed: 0 additions & 23 deletions
This file was deleted.

package.json

Lines changed: 0 additions & 39 deletions
This file was deleted.

0 commit comments

Comments
 (0)