Skip to content

Commit

Permalink
Some plugin maintenance
Browse files Browse the repository at this point in the history
- Use Travis CI container infrastructure.
- Update README.
- Change groupId and artifactId in pom.xml.
- Use maven release plugin to build releases.
  • Loading branch information
bernd committed Sep 10, 2015
1 parent e1b5486 commit ffa67ee
Show file tree
Hide file tree
Showing 4 changed files with 59 additions and 15 deletions.
1 change: 1 addition & 0 deletions .travis.yml
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
sudo: false
language: java
jdk:
- oraclejdk7
Expand Down
43 changes: 33 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,14 +1,37 @@
# Graylog MQTT Input Plugin
[![Build Status](https://travis-ci.org/Graylog2/graylog2-input-mqtt.svg?branch=v1.1.0)](https://travis-ci.org/Graylog2/graylog2-input-mqtt)
MQTT Plugin for Graylog
=======================

[![Build Status](https://travis-ci.org/Graylog2/graylog-plugin-mqtt.svg)](https://travis-ci.org/Graylog2/graylog-plugin-mqtt)

This is an input plugin that allows you to subscribe to an [MQTT](http://mqtt.org) broker and index all published messages.
It _requires_ a recent Graylog server (1.0.0 or higher)

Getting started for users
-------------------------
**Required Graylog version:** 1.0 and later

## Installation

[Download the plugin](https://github.com/Graylog2/graylog-plugin-mqtt/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.

## Build

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

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

DEB and RPM packages can be build with `mvn jdeb:jdeb` and `mvn rpm:rpm` respectively.

## Plugin Release

We are using the maven release plugin:

```
$ mvn release:prepare
[...]
$ mvn release:perform
```

* Clone this repository
* run `mvn package` to build a jar file.
* Copy generated jar file in target directory to your Graylog server plugin directory
* Restart Graylog server
* Create a new MQTT Input in the Graylog web interface
This sets the version numbers, creates a tag and pushes to GitHub. TravisCI will build the release artifacts and upload to GitHub automatically.
28 changes: 24 additions & 4 deletions pom.xml
Original file line number Diff line number Diff line change
Expand Up @@ -4,11 +4,11 @@
xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
<modelVersion>4.0.0</modelVersion>

<groupId>org.graylog</groupId>
<artifactId>graylog-input-mqtt</artifactId>
<version>1.1.0</version>
<groupId>org.graylog.plugins</groupId>
<artifactId>graylog-plugin-mqtt</artifactId>
<version>1.1.1-SNAPSHOT</version>

<name>graylog-input-mqtt</name>
<name>${project.artifactId}</name>
<description>Graylog MQTT Input plugin</description>
<url>https://www.graylog.org</url>

Expand All @@ -17,6 +17,13 @@
<url>https://www.graylog.com</url>
</organization>

<scm>
<connection>scm:git:[email protected]:Graylog2/graylog-plugin-mqtt.git</connection>
<developerConnection>scm:git:[email protected]:Graylog2/graylog-plugin-mqtt.git</developerConnection>
<url>https://github.com/Graylog2/graylog-plugin-mqtt</url>
<tag>HEAD</tag>
</scm>

<properties>
<project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
<maven.compiler.source>1.7</maven.compiler.source>
Expand Down Expand Up @@ -113,6 +120,19 @@
</executions>
</plugin>

<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-release-plugin</artifactId>
<version>2.5.2</version>
<configuration>
<autoVersionSubmodules>true</autoVersionSubmodules>
<mavenExecutorId>forked-path</mavenExecutorId>
<tagNameFormat>@{project.version}</tagNameFormat>
<preparationGoals>clean test</preparationGoals>
<goals>package</goals>
</configuration>
</plugin>

<plugin>
<groupId>org.vafer</groupId>
<artifactId>jdeb</artifactId>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ public URI getURL() {

@Override
public Version getVersion() {
return new Version(1, 0, 2);
return new Version(1, 1, 1);
}

@Override
Expand Down

0 comments on commit ffa67ee

Please sign in to comment.