Skip to content

Commit 9d72c0b

Browse files
author
nksft
committed
Update README.md
1 parent 2d9fdd4 commit 9d72c0b

1 file changed

Lines changed: 30 additions & 0 deletions

File tree

README.md

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,32 @@
11
# graylog2-plugin-exec
22
An alarm callback plugin for executing a script on Graylog2's server.
3+
4+
## Installation
5+
6+
[Download the plugin](https://github.com/nksft/graylog2-plugin-exec/releases)
7+
and place the `.jar` file in your Graylog plugin directory. The plugin directory
8+
is the `plugins/` folder relative from your `graylog-server` directory by default
9+
and can be configured in your `graylog.conf` file.
10+
11+
Restart `graylog-server` and you are done.
12+
13+
## Usage
14+
15+
Create a "Execute Command Alarm Callback" on the "Manage alerts" page of your stream.
16+
Enter the requested configuration and save.
17+
Make sure you also configured alert conditions for the stream so that the alerts are actually triggered.
18+
19+
## Example
20+
21+
For calling the script /root/script.php and passing it a parameter just fill the box like this:
22+
php /root/script.php param1
23+
24+
## Build
25+
26+
This project is using Maven and requires Java 7 or higher.
27+
28+
You can build a plugin (JAR) with `mvn package`.
29+
30+
## Copyright
31+
32+
Copyright (c) 2016 Ahmad Niksefat. See LICENSE for further details.

0 commit comments

Comments
 (0)