2016-04-29 04:07:16 +08:00
|
|
|
# Mainflux
|
2015-10-02 22:15:46 +08:00
|
|
|
|
2017-09-23 08:27:49 +08:00
|
|
|
[![build][ci-badge]][ci-url]
|
|
|
|
|
[![go report card][grc-badge]][grc-url]
|
|
|
|
|
[![license][license]](LICENSE)
|
|
|
|
|
[![chat][gitter-badge]][gitter]
|
2015-07-07 05:43:19 +08:00
|
|
|
|
2017-09-23 08:27:49 +08:00
|
|
|
![banner][banner]
|
2015-07-07 05:43:19 +08:00
|
|
|
|
2017-09-23 19:43:23 +08:00
|
|
|
Mainflux is modern, scalable, secure open source and patent-free IoT cloud platform written in Go.
|
2015-10-02 22:18:35 +08:00
|
|
|
|
2017-09-23 19:43:23 +08:00
|
|
|
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.
|
2016-11-13 02:49:23 +08:00
|
|
|
|
2017-09-23 08:27:49 +08:00
|
|
|
For more details, check out the [official documentation][docs].
|
2015-10-02 22:18:35 +08:00
|
|
|
|
2017-09-23 08:27:49 +08:00
|
|
|
## Features
|
2016-11-24 09:19:06 +08:00
|
|
|
|
2017-09-23 19:43:23 +08:00
|
|
|
- Protocol bridging (i.e. HTTP, MQTT, WebSocket, CoAP)
|
|
|
|
|
- Device management and provisioning
|
|
|
|
|
- Fine-grained access control
|
|
|
|
|
- Container-based deployment using [Docker][docker]
|
2017-01-15 07:57:59 +08:00
|
|
|
|
2017-09-23 08:27:49 +08:00
|
|
|
## Quickstart
|
2017-09-19 03:38:06 +08:00
|
|
|
|
2017-09-23 08:27:49 +08:00
|
|
|
#### Docker
|
2017-09-19 03:38:06 +08:00
|
|
|
|
2017-09-25 19:50:23 +08:00
|
|
|
To start the docker composition, execute the [startup script](bin/mainflux-docker.sh) from `bin`
|
2017-09-25 18:00:28 +08:00
|
|
|
directory:
|
|
|
|
|
|
2017-09-19 03:38:06 +08:00
|
|
|
```
|
2017-09-25 18:00:28 +08:00
|
|
|
./mainflux-docker.sh start
|
2016-04-29 04:16:01 +08:00
|
|
|
```
|
2015-10-02 22:18:35 +08:00
|
|
|
|
2017-09-25 18:00:28 +08:00
|
|
|
If the command successfully completes, you can verify that the all images are up & running by
|
|
|
|
|
executing the following command in the terminal window:
|
|
|
|
|
|
|
|
|
|
```
|
|
|
|
|
docker ps
|
2015-10-02 22:18:35 +08:00
|
|
|
```
|
2016-04-29 04:19:08 +08:00
|
|
|
|
2017-09-25 18:00:28 +08:00
|
|
|
The composition can be terminated in the following way:
|
2016-04-29 04:07:16 +08:00
|
|
|
|
2017-09-25 18:00:28 +08:00
|
|
|
```
|
|
|
|
|
./mainflux-docker.sh stop
|
|
|
|
|
```
|
2017-09-19 03:38:06 +08:00
|
|
|
|
2017-09-25 18:00:28 +08:00
|
|
|
#### From sources
|
2017-09-19 03:38:06 +08:00
|
|
|
|
2017-09-25 18:00:28 +08:00
|
|
|
To download all the sources, and place them in appropriate locations (i.e. $GOPATH), use the
|
|
|
|
|
[installation script](bin/mainflux-install.sh). Once it completes, the script will provide the
|
|
|
|
|
instructions on how to finish the manual installation (i.e. install the required infrastructure).
|
2017-09-19 03:38:06 +08:00
|
|
|
|
2017-09-23 19:43:23 +08:00
|
|
|
## Contributing
|
|
|
|
|
|
|
|
|
|
Thank you for your interest in Mainflux and wish to contribute!
|
|
|
|
|
|
|
|
|
|
1. Take a look at our [open issues](https://github.com/mainflux/mainflux/issues).
|
|
|
|
|
2. Checkout the [contribution guide](CONTRIBUTING.md) to learn more about our style and conventions.
|
|
|
|
|
3. Make your changes compatible to our workflow.
|
|
|
|
|
|
2017-09-23 08:27:49 +08:00
|
|
|
## Community
|
|
|
|
|
|
|
|
|
|
- [Google group][forum]
|
|
|
|
|
- [Gitter][gitter]
|
|
|
|
|
- [Twitter][twitter]
|
|
|
|
|
|
|
|
|
|
[banner]: https://github.com/mainflux/doc/blob/master/docs/img/gopherBanner.jpg
|
2017-09-23 23:41:08 +08:00
|
|
|
[ci-badge]: https://semaphoreci.com/api/v1/mainflux/mainflux/branches/master/badge.svg
|
|
|
|
|
[ci-url]: https://semaphoreci.com/mainflux/mainflux
|
2017-09-23 08:27:49 +08:00
|
|
|
[docs]: http://mainflux.readthedocs.io
|
|
|
|
|
[docker]: https://www.docker.com
|
|
|
|
|
[forum]: https://groups.google.com/forum/#!forum/mainflux
|
|
|
|
|
[gitter]: https://gitter.im/mainflux/mainflux?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge
|
|
|
|
|
[gitter-badge]: https://badges.gitter.im/Join%20Chat.svg
|
|
|
|
|
[grc-badge]: https://goreportcard.com/badge/github.com/mainflux/mainflux
|
|
|
|
|
[grc-url]: https://goreportcard.com/report/github.com/mainflux/mainflux
|
|
|
|
|
[license]: https://img.shields.io/badge/license-Apache%20v2.0-blue.svg
|
|
|
|
|
[twitter]: https://twitter.com/mainflux
|
