OrgGo
/
Mainflux.mainflux
mirror of https://github.com/mainflux/mainflux.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity
129 Commits 1 Branch 0 Tags 70 MiB
Go 98.6%
Shell 0.7%
Makefile 0.4%
JavaScript 0.2%
Go to file
Drasko DRASKOVIC 52f0017be5 Correct banner 
Signed-off-by: Drasko DRASKOVIC <drasko.draskovic@gmail.com>
 		2016-09-20 22:47:55 +02:00
clients 🐭 GO GO GO! 2016-09-20 19:24:54 +02:00
config 🐭 GO GO GO! 2016-09-20 19:24:54 +02:00
controllers 🐭 GO GO GO! 2016-09-20 19:24:54 +02:00
db 🐭 GO GO GO! 2016-09-20 19:24:54 +02:00
models Add schema 2016-09-20 21:55:48 +02:00
schema Add schema 2016-09-20 21:55:48 +02:00
servers 🐭 GO GO GO! 2016-09-20 19:24:54 +02:00
tls 🐭 GO GO GO! 2016-09-20 19:24:54 +02:00
.dockerignore Add .dockerignore 2016-09-20 21:28:42 +02:00
.gitignore 🐭 GO GO GO! 2016-09-20 19:24:54 +02:00
.travis.yml Add Travis 2016-09-20 21:28:42 +02:00
CONTRIBUTING.md Switch LICENSE to Apache v2.0 2015-10-09 23:35:23 +02:00
Dockerfile 🐭 GO GO GO! 2016-09-20 19:24:54 +02:00
LICENSE Switch LICENSE to Apache v2.0 2015-10-09 23:35:23 +02:00
MAINTAINERS Correct MAINTAINERS 2016-09-20 21:21:25 +02:00
README.md Update README.md 2016-09-20 21:25:46 +02:00
const.go 🐭 GO GO GO! 2016-09-20 19:24:54 +02:00
docker-compose.yml 🐭 GO GO GO! 2016-09-20 19:24:54 +02:00
main.go Correct banner 2016-09-20 22:47:55 +02:00
opts.go 🐭 GO GO GO! 2016-09-20 19:24:54 +02:00

README.md

Mainflux

License Build Status Go Report Card Join the chat at https://gitter.im/Mainflux/mainflux

About

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

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.

N.B. Mainlux is uder heavy development and not yet suitable for professional deployments

Install/Deploy

Mainflux uses MongoDB, so insure that it is installed on your system (more info here). You will also need MQTT broker running on default port 1883 - for example Mosquitto.

Installing Mainflux is trivial go get:

go get github.com/mainflux/mainflux
$GOBIN/mainflux

If you are new to Go, more information about setting-up environment and fetching Mainflux Lite code can be found here.

Docker

Running Mainflux in a Docker is even easier, as it will launch whole composition of microservices, so you do not have to care about dependencies.

  • 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.

System Architecture

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

  • Mainflux Core (HTTP API Server and Admin)
  • Authentication and Authorization Server
  • MQTT PUB/SUB Broker (and WebSocket Server)
  • Mongo Database
  • Dashflux UI

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

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
  • 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

Documentation

Development documentation can be found on our Mainflux GitHub Wiki.

Community

Mailing list

mainflux Google group

For quick questions and suggestions you can also use GitHub Issues.

IRC

Mainflux Gitter

Twitter

@mainflux

Authors

Main architect and BDFL of Mainflux project is @drasko.

Maintainers are listed in MAINTAINERS file.

License

Apache License, version 2.0