Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
nksft committed Apr 23, 2016
1 parent 2d9fdd4 commit 9d72c0b
Showing 1 changed file with 30 additions and 0 deletions.
30 changes: 30 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,2 +1,32 @@
# graylog2-plugin-exec
An alarm callback plugin for executing a script on Graylog2's server.

## Installation

[Download the plugin](https://github.com/nksft/graylog2-plugin-exec/releases)
and place the `.jar` file in your Graylog plugin directory. The plugin directory
is the `plugins/` folder relative from your `graylog-server` directory by default
and can be configured in your `graylog.conf` file.

Restart `graylog-server` and you are done.

## Usage

Create a "Execute Command Alarm Callback" on the "Manage alerts" page of your stream.
Enter the requested configuration and save.
Make sure you also configured alert conditions for the stream so that the alerts are actually triggered.

## Example

For calling the script /root/script.php and passing it a parameter just fill the box like this:
php /root/script.php param1

## Build

This project is using Maven and requires Java 7 or higher.

You can build a plugin (JAR) with `mvn package`.

## Copyright

Copyright (c) 2016 Ahmad Niksefat. See LICENSE for further details.

0 comments on commit 9d72c0b

Please sign in to comment.