Unleash awesomeness. Private packages, team management tools, and powerful integrations. Get started with npm Orgs »

mosca

0.7.0 • Public • Published

Mosca

Mosca

BuildStatus

Mosca is a multi-transport MQTT broker. It aims to support every publish/subscribe broker or protocol out there. This list currently includes:

  • RabbitMQ and all implementations of the AMQP protocol.
  • Redis, the fabulous key/value store by @antirez.
  • Mosquitto and all implementations of the MQTT protocol, including itself.
  • ZeroMQ without a central broker, so Mosca can also be used in a P2P fashion.
  • MongoDB, the documental NoSQL that is revolutioning how web apps are built.

Mosca is still under active development, but it should work :). Let me know if you plan to use Mosca in production.

Usage

Mosca is a node.js application, so it needs node.js to run.

$: npm install mosca bunyan -g
$: mosca -v | bunyan

Then you can connect to it with your preferred MQTT client.

Features

  • MQTT 3.1 compliant
  • QoS 0 and QoS 1
  • Various storage options for QoS 1 offline packets, and subscriptions.
  • Built on top on node.js
  • As fast as it is possible
  • Usable inside ANY other node.js app, see the API.

Configuration

Mosca supports some command line options:

  Usage: mosca [options] [command]

  Commands:

    adduser <user> <pass>  Add a user to the given credentials file
    rmuser <user>          Removes a user from the given credentials file
    start                  start the server (optional)

  Options:

    -h, --help                       output usage information
    -V, --version                    output the version number
    -p, --port <n>                   the port to listen to
    --parent-port <n>                the parent port to connect to
    --parent-host <s>                the parent host to connect to
    --parent-prefix <s>              the prefix to use in the parent broker
    --credentials <file>             the file containing the credentials
    --authorize-publish <pattern>    the pattern for publishing to topics for the added user
    --authorize-subscribe <pattern>  the pattern for subscribing to topics for the added user
    -c, --config <c>                 the config file to use (override every other option)
    -d, --db <path>                  the path were to store the database
    -v, --verbose                    set the bunyan log to INFO
    --very-verbose                   set the bunyan log to DEBUG

However you can only use a MQTT backend with the command line options.

If you want to unleash the full power of mosca, you will need to use a configuration file. Some examples are included in this repository, one using Redis, and one using a tree-based topology of Moscas.

A configuration file is structured in the following way:

module.exports = {
  port: 4883,
  backend: {
    type: "redis"
  }
};

As Mosca is based on Ascoltatori to integrate all backends, please refer to Ascoltatori's documentation to set them up accordingly. The whole content of the backend key is passed through to the ascoltatori.build method.

Users

Mosca support user authentication through the use of a specific json file. In order to create one, you can just add an user to it:

$ mosca adduser myuser mypass --credentials ./credentials.json

Then, in order to start Mosca with a specific set of credentials:

$ mosca --credentials ./credentials.json

It is also possible to remove a user:

$ mosca rmuser myuser --credentials ./credentials.json

The adduser command allows also to specify the pattern of topics that a given user is authorized to access, like so:

$ mosca adduser myuser mypass --credentials ./credentials.json \
  --authorize-publish 'hello/*' --authorize-subscribe 'hello/*'

The patterns are checked and validated using Minimatch.

The credentials file can be automatically reladed by Mosca if it receives a SIGHUP.

Persistance

The MQTT specification requires a persistent storage for offline QoS 1 subscription that has been done by an unclean client. Mosca offers several persitance options:

All of them can be configured from the configuration file, under the persistance key. The only exception is LevelUp, which can be specified by using the --db option from the command line.

Contributing to Mosca

  • Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet
  • Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it
  • Fork the project
  • Start a feature/bugfix branch
  • Commit and push until you are happy with your contribution
  • Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
  • Please try not to mess with the Makefile and package.json. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.

LICENSE - "MIT License"

Copyright (c) 2013 Matteo Collina, http://matteocollina.com

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

install

npm i mosca

Downloadsweekly downloads

2,838

version

0.7.0

license

MIT

homepage

github.com

repository

Gitgithub

last publish

collaborators

  • avatar
Report a vulnerability