Mainflux.mainflux/README.md

Mainflux

Mainflux is modern, scalable, secure open source and patent-free IoT cloud platform written in Go.

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

For more details, check out the official documentation.

Features

• Protocol bridging (i.e. HTTP, MQTT, WebSocket, CoAP)
• Device management and provisioning
• Fine-grained access control
• Container-based deployment using Docker

Quickstart

Docker

• Clone the repo:

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

• Go to mainflux/docker dir:

cd mainflux/docker

• Use mainflux-docker.sh script to start the Docker composition:

./mainflux-docker.sh start

Once started, the script will download and start Docker images required by the composition.

From sources

Use script install_sources.sh.

This will create ./mainflux_sources dir, git-clone all the sources from GitHub repos and place them in appropriate destination (Go code goes to $GOPATH, symlinks are created).

It will also give you the instructions how to finish the installation manually.

Contributing

Thank you for your interest in Mainflux and wish to contribute!

1. Take a look at our open issues.
2. Checkout the contribution guide to learn more about our style and conventions.
3. Make your changes compatible to our workflow.

Community

• Google group
• Gitter
• Twitter