Mainflux.mainflux/README.md

5.1 KiB

Mainflux

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

About

Mainflux is an open source and patent-free IoT cloud platform based on microservices.

It allows device, user and application connections over various network protocols, like HTTP, MQTT, WebSocket and CoAP, making a seamless bridge between them. It is used as the IoT middleware for building complex IoT solutions.

Cloud Architecture

Mainflux is built with <3 by Mainflux team and community contributors.

Features

An extensive (and incomplete) list of features includes:

  • Responsive and scalable architecture based on a set of microservices
  • Set of clean APIs: HTTP RESTful, MQTT, WebSocket and CoAP
  • SDK - set of client libraries for many HW platforms in several programming languages: C/C++, JavaScript, Go and Python
  • Device management and provisioning and OTA FW updates
  • Highly secured connections via TLS and DTLS
  • Standardized NGSI model representation
  • Enhanced and fine-grained security via Reverse Proxy, OAuth 2.0 identity management and RBAC Authorization Server.
  • LwM2M standard compliance
  • oneM2M adapter
  • Easy deployment and high system scalability via Docker images
  • Clear project roadmap, extensive development ecosystem and highly skilled developer community
  • And many more

Install/Deploy

Installation and deployment of Mainflux IoT cloud is super-easy:

  • Clone the repo:
git clone https://github.com/Mainflux/mainflux.git && cd mainflux
  • Start the Docker composition:
docker-compose up

This will automatically download Docker images from Mainflux Docker Hub and deploy the composition.

If you need to modify these Docker images, you will have to look at appropriate repos in the Mainflux project GitHub - look for the repos starting with prefix mainflux-<protocol>-server.

System Architecture

Mainflux IoT cloud is composed of several components, i.e. microservices:

  • Mainflux Core
  • HTTP API Server
  • MQTT API Server
  • WebSocket API Server
  • NATS PUB/SUB Broker
  • Dashflux UI

The following matrix describes the functionality of each GE in the system and gives the location of the code repositories:

Microservice Function GitHub repo
Mainflux Core Core Server mainflux-core-server
HTTP API Server HTTP API Server mainflux-http-server
MQTT API Server MQTT API Server mainflux-mqtt-server
WS API Server WS API Server mainflux-ws-server
NATS PUB/SUB Broker nats-io/gnatsd
Dashflux Dashboard UI dashflux

These components are packaged and deployed in a set of Docker containers maintained by Mainflux team, with images uploaded to Mainflux Docker Hub page.

Docker composition that constitues Mainflux IoT infrastructure is defined in the docker-compose.yml.

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