Mainflux.mainflux/README.md

3.2 KiB

Mainflux

License Join the chat at https://gitter.im/Mainflux/mainflux

About

Mainflux is lean open source industrial IoT cloud written in NodeJS.

It allows device, user and application connections over various network protocols, like HTTP, MQTT, WebSocket and CoAP, making a seamless bridge between them. As a consequence, Mainflux represents highly secure and highly optimised M2M platform based on the cutting-edge standards and approaches in the industry.

Architecture

AltTxt

Features

An extensive (and incomplete) list of featureas includes:

  • Set of clean APIs, Swagger documented: HTTP RESTful, MQTT, WebSocket and CoAP
  • Set of client libraries for many HW platforms in several programming languages: C/C++, JavaScript and Python
  • Device management and provisioning and OTA FW updates
  • UNIX-like permissions for device sharing
  • Highly secured connections via TLS and DTLS
  • User authentication via JSON Web Tokens
  • Responsive and scalable ModgoDB database
  • Modern architecture based on micro-services
  • LwM2M standard compliance via Coreflux
  • Partial oneM2M compliance
  • Easy deployment and high system scalability via Docker images
  • Clear project roadmap, extensive development ecosystem and highly skilled developer community
  • Professional support via Mainflux company
  • And many more

Install

Clone the repo:

git clone https://github.com/Mainflux/mainflux.git
cd mainflux

Install Node modules:

npm install

Run Gulp Task:

gulp

N.B. Mainflux has a MongoDB dependency. Database path and port can be defined in the config files.

Docker

Apart from main nodejs Docker image, Mainflux also uses mongo Docker image (database instance is run in a separte generic Docker image).

This is why Mainflux uses Docker Compose, to run both nodejs and mongo images at the same time and make a connection between them:

docker-compose up

Documentation

Development documentation can be found on our Mainflux GitHub Wiki

Community

Mailing lists

  • mainflux-dev - developers related. This is discussion about development of Mainflux IoT cloud itself.
  • mainflux-user - general discussion and support. If you do not participate in development of Mainflux cloud infrastructure, this is probably what you're looking for.

IRC

Mainflux Gitter

Twitter

@mainflux

License

Apache License, version 2.0