mosca - GitLite

KO | EN

gitlite — search

#python #typescript #llm #golang #android #deep-learning #linux #awesome #cli #kubernetes #pytorch #openai #ios #open-source

mosca

(★ 3,183)

MQTT broker as a module

File Explorer

Download Latest Version (.zip)

- mosca
- - auth.json
  - Dockerfile
  - index.html
  - README.md
  - server.js
- - config.js
  - start.js
- - firstConfig.js
  - README.md
  - secondConfig.js
  - thirdConfig.js
- - firstConfig.js
  - README.md
  - secondConfig.js
- - broker.js
  - README.md
- - secureClient.js
  - secureEmbedded.js
  - secureServer.js
- - index.html
  - start.sh
- Server_With_All_Interfaces-Settings.js
- - abstract.js
  - index.js
  - levelup.js
  - matcher.js
  - memory.js
  - mongo.js
  - redis.js
  - utils.js
- authorizer.js
- cli.js
- client.js
- interfaces.js
- options.js
- serializers.js
- server.js
- stats.js
- .gitkeep
- - createConnection.js
  - createSecureConnection.js
  - createSecureWebsocketConnection.js
  - createWebsocketConnection.js
- - abstract.js
  - levelup_spec.js
  - memory_spec.js
  - mongo_spec.js
  - redis_spec.js
  - utils_spec.js
- - tls-cert.pem
  - tls-key.pem
- - index.html
  - test
- abstract_server.js
- authorizer.js
- cli.js
- common.js
- credentials.json
- mocha.opts
- options.js
- sample_config.js
- server.js
- server_error.js
- server_mongo.js
- server_redis.js
- server_secure.js
- server_websocket.js
- server_websocket_attach.js
- server_websocket_secure.js
- stats.js
.dockerignore
.gitignore
.jshintrc
.npmignore
.travis.yml
CONTRIBUTING.md
Dockerfile
Dockerfile-rpi
Dockerfile-rpi-hub
HISTORY.md
index.js
package.json
publish_docs.sh
README.md

# Installation Guide

1. Get the code

git clone https://github.com/moscajs/mosca

Downloads the entire project code from GitHub to your computer.

cd mosca

Moves into the project folder you just downloaded.

2. Docker

Easy Recommended

Prerequisites

Git Needed to download the project code from GitHub.
Docker Desktop Needed to build and run containers. Install it and keep it running in the background.

docker build -t mosca .

Builds a runnable image based on the Dockerfile.

docker run -p 8080:80 mosca

Runs the built image as an actual container.

✅ Run docker compose ps to check the containers are Up. If the README mentions a port, open http://localhost:PORT in your browser.

3. Node.js

Easy

Prerequisites

Git Needed to download the project code from GitHub.
Node.js Node.js must be installed to use npm. The LTS version is recommended.

npm install mosca pino -g

Downloads and installs the libraries listed in package.json.

npm install mosca --save

Downloads and installs the libraries listed in package.json.

✅ After running the command, open the address shown in the terminal (usually something like http://localhost:3000) in your browser.

Pulled directly from this repo's README.

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

Mosca&nbsp;&nbsp;&nbsp;[![Build Status](https://travis-ci.org/mcollina/mosca.svg)](https://travis-ci.org/mcollina/mosca)&nbsp;&nbsp;[![Coverage Status](https://coveralls.io/repos/mcollina/mosca/badge.svg)](https://coveralls.io/r/mcollina/mosca)
====================

[![MOSCA](http://cloud.dynamatik.com/image/3I3I0q1M1x0E/mosca_small.png)](https://github.com/mcollina/mosca)

[![NPM](https://nodei.co/npm/mosca.png)](https://nodei.co/npm/mosca/)

[![NPM](https://nodei.co/npm-dl/mosca.png)](https://nodei.co/npm/mosca/)

## This project is UNMAINTAINED. Please move to [Aedes](https://github.com/moscajs/aedes)

## About

#### Mosca is a node.js mqtt broker, which can be used:

* <a href="https://github.com/mcollina/mosca/wiki/Mosca-as-a-standalone-service.">Standalone</a>
* <a href="https://github.com/mcollina/mosca/wiki/Mosca-basic-usage">Embedded in another Node.js application</a>

## Features

* MQTT 3.1 and 3.1.1 compliant.
* QoS 0 and QoS 1.
* Various storage options for QoS 1 offline packets, and subscriptions.
* Usable inside ANY other Node.js app.
* version 2.0.0+ targets node v6, v4 and v0.12
* version 1.0.0+ targets node v6, v5, v4 and v0.12, with partial support for node v0.10.

## Quickstart

### Standalone

```bash
npm install mosca pino -g
mosca -v | pino
```

### Embedded

```bash
npm install mosca --save
```

Show me some code:

```javascript
var mosca = require('mosca');

var ascoltatore = {
  //using ascoltatore
  type: 'mongo',
  url: 'mongodb://localhost:27017/mqtt',
  pubsubCollection: 'ascoltatori',
  mongo: {}
};

var settings = {
  port: 1883,
  backend: ascoltatore
};

var server = new mosca.Server(settings);

server.on('clientConnected', function(client) {
    console.log('client connected', client.id);
});

// fired when a message is received
server.on('published', function(packet, client) {
  console.log('Published', packet.payload);
});

server.on('ready', setup);

// fired when the mqtt server is ready
function setup() {
  console.log('Mosca server is up and running');
}
```

All the info to get you started is gathered [in this wiki page](https://github.com/mcollina/mosca/wiki/Mosca-basic-usage)

Also there is an example using [Redis](https://github.com/mcollina/mosca/wiki/Mosca-basic-usage#in-this-example-we-will-be-using-redis)

## How to's/Tutorials

All to be found [on our repository wiki section.](https://github.com/mcollina/mosca/wiki)

OR

read the [dox generated documentation](http://mcollina.github.io/mosca/docs).

### Learn more

See the slides of my talk ["MQTT and Node.js - Messaging in the Internet
of Things"](http://mcollina.github.io/mqtt_and_nodejs/).

You can find a test version of mosca at test.mosca.io.
You can use ws://test.mosca.io/ to connect to the WebSocket tunnel.
This is powered by the [docker image](https://github.com/mcollina/mosca/wiki/Docker-support).

If you find Mosca useful, consider supporting the project by buying a support package
from [me](http://twitter.com/matteocollina) by writing an email to hello@matteocollina.com.

Check out our [showcase](https://github.com/mcollina/mosca/wiki/Mosca-Showcase) wiki
page! Feel free to add yourself! :)

## Security Issues

__Mosca__ sits between your system and the devices: this is a tough role, and we did our best to secure your systems.
However, you might find a security issue: in that case, email @mcollina at hello@matteocollina.com.

## Feedback

Use the [issue tracker](http://github.com/mcollina/mosca/issues) for bugs.
[Tweet](http://twitter.com/matteocollina) us for any idea that can improve the project.
Chat with us on [Mosca's room](https://gitter.im/mcollina/mosca) on Gitter.

## Links

* [GIT Repository](http://github.com/mcollina/mosca)
* [Mosca Documentation](http://mcollina.github.io/mosca/docs)
* [Ascoltatori](http://github.com/mcollina/ascoltatori)
* [MQTT protocol](http://mqtt.org)
* [MQTT.js](http://github.com/adamvr/MQTT.js)

## Authors

[Matteo Collina](http://twitter.com/matteocollina)

## Logo
[Sam Beck](http://two-thirty.tumblr.com)

## LICENSE - "MIT License"

Copyright (c) 2013-2016 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.