mainflux

package module
Version: v0.0.0-...-b6b9972 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Dec 12, 2017 License: Apache-2.0 Imports: 2 Imported by: 0

README

Mainflux

build go report card license chat

banner

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
  • Linearly scalable data storage
  • Fine-grained access control
  • Platform logging and instrumentation support
  • Container-based deployment using Docker

Quickstart

Docker

To start the docker composition, execute the startup script from bin directory:

./mainflux-docker.sh start  

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

The composition can be terminated in the following way:

./mainflux-docker.sh stop
From sources

To download all the sources, and place them in appropriate locations (i.e. $GOPATH), use the installation script. Once it completes, the script will provide the instructions on how to finish the manual installation (i.e. install the required infrastructure).

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

Documentation

Overview

Package mainflux acts as an umbrella package containing multiple different microservices / deliverables. It provides the top-level platform versioning.

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func Version

func Version() http.HandlerFunc

Version exposes an HTTP handler for retrieving service version.

Types

This section is empty.

Source Files

Directories

Path Synopsis
cmd
nats
Package nats contains NATS-specific message repository implementation.
Package nats contains NATS-specific message repository implementation.
Package http contains the domain concept definitions needed to support Mainflux http adapter service functionality.
Package http contains the domain concept definitions needed to support Mainflux http adapter service functionality.
api
Package api contains API-related concerns: endpoint definitions, middlewares and all resource representations.
Package api contains API-related concerns: endpoint definitions, middlewares and all resource representations.
nats
Package nats contains NATS-specific message repository implementation.
Package nats contains NATS-specific message repository implementation.
Package manager contains the domain concept definitions needed to support Mainflux manager service functionality.
Package manager contains the domain concept definitions needed to support Mainflux manager service functionality.
api
Package api contains API-related concerns: endpoint definitions, middlewares and all resource representations.
Package api contains API-related concerns: endpoint definitions, middlewares and all resource representations.
bcrypt
Package bcrypt provides a hasher implementation utilising bcrypt.
Package bcrypt provides a hasher implementation utilising bcrypt.
cassandra
Package cassandra contains Cassandra-specific repository implementations.
Package cassandra contains Cassandra-specific repository implementations.
client
Package client provides a manager service client intended for internal service communication.
Package client provides a manager service client intended for internal service communication.
jwt
Package jwt provides a JWT identity provider.
Package jwt provides a JWT identity provider.
Package writer provides message writer concept definitions.
Package writer provides message writer concept definitions.
cassandra
Package cassandra contains Cassandra-specific repository implementations.
Package cassandra contains Cassandra-specific repository implementations.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL