OrgGo
/
Mainflux.mainflux
mirror of https://github.com/mainflux/mainflux.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

Update README.md

This commit is contained in:
Drasko DRASKOVIC 2016-04-28 22:19:08 +02:00
parent 1750395240
commit daf9f39a11
1 changed files with 4 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
README.md
View File

@ -3,9 +3,9 @@
[![License](https://img.shields.io/badge/license-Apache%20v2.0-blue.svg)](LICENSE) [![Join the chat at https://gitter.im/Mainflux/mainflux](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/Mainflux/mainflux?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
### About
Mainflux is lean open source industrial IoT cloud written in NodeJS.
Mainflux is an open source and patent-free IoT Cloud Platform.
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. It is used as the IoT middleware for building complex IoT solutions.
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](https://github.com/Mainflux/mainflux-doc/blob/master/img/cloudArchitecture.jpg)
@ -37,6 +37,7 @@ git clone https://github.com/Mainflux/mainflux.git && cd mainflux
```bash
docker-compose up
```
This will automatically download Docker images from [Mainflux Docker Hub](https://hub.docker.com/u/mainflux/) 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](https://github.com/Mainflux) - look for the repos starting with prefix `mainflux-<protocol>-server`.
@ -57,7 +58,7 @@ The following matrix describes the functionality of each GE in the system and gi
| HTTP API Server | HTTP API Server | [mainflux-http-server](https://github.com/Mainflux/mainflux-http-server) |
| MQTT API Server | MQTT API Server | [mainflux-mqtt-server](https://github.com/Mainflux/mainflux-mqtt-server) |
| WS API Server | WS API Server | [mainflux-ws-server](https://github.com/Mainflux/mainflux-ws-server) |
| NATS | PUB/SUB Broker | [gnatsd](https://github.com/nats-io/gnatsd) |
| NATS | PUB/SUB Broker | [nats-io/gnatsd](https://github.com/nats-io/gnatsd) |
These components are packaged and deployed in a set of Docker containers maintained by Mainflux team, with images uploaded to [Mainflux Docker Hub page](https://hub.docker.com/u/mainflux/).