This repository is intended to be used to follow the Plugin API documentation for Graylog. It contains no useful functionality beyond illustrating the various extension points one can use for customizing and extending Graylog.
Important: Do not use this repository as a boilerplate for a new graylog plugin.
Please use the maven archetype to create a plugin skeleton, as described in the Plugin API documentation.
Use this paragraph to enter a description of your plugin.
Required Graylog version: 5.1 and later
Download the plugin
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.
You can improve your development experience for the web interface part of your plugin dramatically by making use of hot reloading. To do this, do the following:
git clone https://github.com/Graylog2/graylog2-server.gitcd graylog2-server/graylog2-web-interfaceln -s $YOURPLUGIN plugin/npm install && npm start
Use this paragraph to document the usage of your plugin
This project is using Maven 3 and requires Java 7 or higher.
- Clone this repository.
- Run
mvn packageto build a JAR file. - Optional: Run
mvn jdeb:jdebandmvn rpm:rpmto create a DEB and RPM package respectively. - Copy generated JAR file in target directory to your Graylog plugin directory.
- Restart the Graylog.
We are using the maven release plugin:
$ mvn release:prepare
[...]
$ mvn release:perform
This sets the version numbers, creates a tag and pushes to GitHub. Travis CI will build the release artifacts and upload to GitHub automatically.