Files
IM-server-new/README.md
T

82 lines
2.5 KiB
Markdown
Raw Normal View History

2015-03-07 19:23:04 +01:00
2014-10-05 15:33:47 +02:00
## What is Moquette?
2019-02-10 18:59:05 +01:00
[![Build Status](https://api.travis-ci.org/moquette-io/moquette.svg?branch=master)](https://travis-ci.org/moquette-io/moquette)
2015-03-07 19:23:04 +01:00
2019-02-10 17:47:15 +01:00
* [Documentation reference guide](http://moquette-io.github.io/moquette/) Guide on how to use and configure Moquette
2017-10-31 19:15:50 +08:00
* [Google Group](https://groups.google.com/forum/#!forum/moquette-mqtt) Google Group to participate in development discussions.
2014-10-05 15:33:47 +02:00
Moquette aims to be a MQTT compliant broker. The broker supports QoS 0, QoS 1 and QoS 2.
2015-11-20 21:36:52 +01:00
Its designed to be evented, uses Netty for the protocol encoding and decoding part.
2014-10-05 15:33:47 +02:00
2015-05-11 19:45:04 +02:00
## Embeddable
2014-10-05 15:33:47 +02:00
2017-10-31 19:15:50 +08:00
[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).
2014-10-05 15:33:47 +02:00
2017-06-21 22:47:05 +02:00
## Try the demo instance
2017-10-31 19:15:50 +08:00
2018-07-18 17:34:41 +02:00
Point your browser to [cloud instance](http://broker.moquette.io), request an account then use it from your MQTT clients.
2017-06-21 22:47:05 +02:00
2014-10-05 15:33:47 +02:00
## 1 minute set up
2017-10-31 19:15:50 +08:00
2018-12-01 15:20:19 +01:00
Start play with it, download the self distribution tar from [BinTray](https://bintray.com/artifact/download/andsel/generic/moquette-0.12.tar.gz) ,
2017-10-31 19:15:50 +08:00
the un untar and start the broker listening on `1883` port and enjoy!
2014-10-05 15:33:47 +02:00
```
2018-12-01 15:20:19 +01:00
tar xvf moquette-distribution-0.12.tar.gz
2014-10-05 15:33:47 +02:00
cd bin
./moquette.sh
```
2015-07-08 19:54:29 +02:00
Or if you are on Windows shell
2017-10-31 19:15:50 +08:00
2014-10-05 15:33:47 +02:00
```
2015-07-08 19:54:29 +02:00
cd bin
.\moquette.bat
2017-10-31 19:15:50 +08:00
```
2014-10-05 15:33:47 +02:00
## Embedding in other projects
2017-10-31 19:15:50 +08:00
2014-10-05 15:33:47 +02:00
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>
2014-10-05 15:33:47 +02:00
<releases>
<enabled>true</enabled>
</releases>
<snapshots>
<enabled>false</enabled>
</snapshots>
</repository>
</repositories>
```
Include dependency in your project:
```
<dependency>
<groupId>io.moquette</groupId>
2014-10-05 15:33:47 +02:00
<artifactId>moquette-broker</artifactId>
2018-12-01 15:20:19 +01:00
<version>0.12</version>
2014-10-05 15:33:47 +02:00
</dependency>
```
## Build from sources
2017-10-31 19:15:50 +08:00
2018-07-18 17:34:41 +02:00
After a git clone of the repository, cd into the cloned sources and: `./gradlew clean moquette-distribution:distMoquetteTar` or
`./gradlew clean moquette-distribution:distMoquetteZip`.
2017-10-31 19:15:50 +08:00
2017-01-17 15:12:15 +01:00
In distribution/build directory will be produced the selfcontained file for the broker with all dependencies and a running script.
2015-02-21 21:56:09 +01:00