Files
IM-server-new/README.md
T
Andreas Mager e8b105fa90 switch to gradle
gradle files added
gradle: plugins added
build: files added
.travis.yml: gradle cache stored
distribution: tar and zip file stuff added
broker/build.gradle: osgi plugin added
build: bintray upload added
pom: files removed
distribution: assembly.xml removed
gradle: test ouput added to sub builds
.editorconfig: gradle files added
build: wrapper task added
osgi: added to h2_ and mapdb_storage
gradle: files cleaned
build.gradle: jars used for tar/zip
2017-08-24 17:50:59 +02:00

71 lines
2.4 KiB
Markdown

## What is Moquette?
[![Build Status](https://api.travis-ci.org/andsel/moquette.svg?branch=master)](https://travis-ci.org/andsel/moquette)
* [Documentation reference guide] (http://andsel.github.io/moquette/) Guide on how to use and configure Moquette
* [Google Group] (https://groups.google.com/forum/#!forum/moquette-mqtt) Google Group to participate in development discussions.
Moquette aims to be a MQTT compliant broker. The broker supports QoS 0, QoS 1 and QoS 2.
Its designed to be evented, uses Netty for the protocol encoding and decoding part.
## Embeddable
[Freedomotic] (http://www.freedomotic.com/) Is an home automation framework, uses Moquette embedded to interface with MQTT world.
Moquette is also used into [Atomize Spin] (http://atomizesoftware.com/spin) a software solution for the logistic field.
Part of moquette are used into the [Vertx MQTT module] (https://github.com/giovibal/vertx-mqtt-broker-mod), into [MQTT spy](http://kamilfb.github.io/mqtt-spy/)
and into [WSO2 Messge broker] (http://techexplosives-pamod.blogspot.it/2014/05/mqtt-transport-architecture-wso2-mb-3x.html).
## Try the demo instance
Point your MQTT client to _broker.moquette.io_
## 1 minute set up
Start play with it, download the self distribution tar from [BinTray](https://bintray.com/artifact/download/andsel/generic/distribution-0.10-bundle-tar.tar.gz) ,
the un untar and start the broker listening on 1883 port and enjoy!
```
tar zxf distribution-0.10-bundle-tar.tar.gz
cd bin
./moquette.sh
```
Or if you are on Windows shell
```
cd bin
.\moquette.bat
```
## Embedding in other projects
To embed Moquette in another maven project is sufficient to include a repository and declare the dependency:
```
<repositories>
<repository>
<id>bintray</id>
<url>https://jcenter.bintray.com</url>
<releases>
<enabled>true</enabled>
</releases>
<snapshots>
<enabled>false</enabled>
</snapshots>
</repository>
</repositories>
```
Include dependency in your project:
```
<dependency>
<groupId>io.moquette</groupId>
<artifactId>moquette-broker</artifactId>
<version>0.10</version>
</dependency>
```
## Build from sources
After a git clone of the repository, cd into the cloned sources and: `./gradlew clean distribution:distMoquetteTar` or
`./gradlew clean distribution:distMoquetteZip`.
In distribution/build directory will be produced the selfcontained file for the broker with all dependencies and a running script.