graylog-plugin-redis-lookup/README.md

59 lines
1.7 KiB
Markdown
Raw Normal View History

2024-02-03 14:07:41 +01:00
# RedisLookupPlugin Plugin for Graylog
[![Build Status](https://travis-ci.org/https://git.nosd.in/yo/graylog-plugin-redis-lookup.svg?branch=master)](https://travis-ci.org/https://git.nosd.in/yo/graylog-plugin-redis-lookup)
__Use this paragraph to enter a description of your plugin.__
**Required Graylog version:** 2.0 and later
Installation
------------
[Download the plugin](https://github.com/https://git.nosd.in/yo/graylog-plugin-redis-lookup/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.
Development
-----------
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.git`
* `cd graylog2-server/graylog2-web-interface`
* `ln -s $YOURPLUGIN plugin/`
* `npm install && npm start`
Usage
-----
__Use this paragraph to document the usage of your plugin__
Getting started
---------------
This project is using Maven 3 and requires Java 8 or higher.
* Clone this repository.
* Run `mvn package` to build a JAR file.
* Optional: Run `mvn jdeb:jdeb` and `mvn rpm:rpm` to create a DEB and RPM package respectively.
* Copy generated JAR file in target directory to your Graylog plugin directory.
* Restart the Graylog.
Plugin Release
--------------
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.