Giter Site home page Giter Site logo

borokero.github.io's Introduction

Borokero ;) Open Source Microservice Platform

About

Open Source Back End for IoT, Web, Apps and Mobile

Borokero will enable you to put your IoT, Mobile, Apps or Web API services on your own server simply and painless in one command. It supports the popular MQTT protocol in sync with HTTP. It is in javascript and authenticate and authorize your device list so broker perform authentication by your entry data in oauth server like Keycloak. Borokero is an open-source solution that includes a scalable server and a multiprotocol API. Borokero is opensource forever under development so it should work. It need time to release stable version.

Features

  • Simple and Scalable based on docker-compose and as soon as possible on kubernetes
  • HTTP, MQTT connections together as a bridge.
  • MQTT 3.1 and 3.1.1 compliant.
  • Sercured with authentication and authorization.

Installation

Borokero IoT Platform is installed by two methods. Firstly besure docker and docker-compose is installed.

Using Shell Script

Run the following command in your terminal to install the latest official Borokero IoT Platform release. For customization environment variables, make iot-mqtt.env and iot-http.env with your desired variables before run installer shell script. Deafualt value will loaded if .env files is not existence in current path.

sudo curl -o- https://raw.githubusercontent.com/borokero/borokero/master/install.sh | bash

Using Git

Download Borokero Platform git

git clone https://github.com/borokero/borokero-docker-compose

cd borokero-docker-compose

sudo docker-compose up

Tutorial

You can find a step by step tutorial in wiki page .

Development

Borokero is composed by different microservices. Follow the installation guidelines for each of them.

Microservice Description
Docs Borokero Documentations
Borokero Borokero Installer Shell Script
HTTP Bridge HTTP/HTTPS server
MQTT Bridge MQTT/MQTTS broker
Borokero Auth Borokero Authentication and Authorization
Docker-Compose Docker-Compose confiuration
CLI Borokero CLI
Borokero Webpage Borokero Github Page

Development Environment Variable

During deployment, every microservice needs to be set to the following environment variables. You can customize .env file in every repository.

Learn more

You can find a test version of Borokero IoT Platform at borokero.iokloud.com as soon as possible. If you find Borokero useful, consider supporting the project by buying a support package from me by writing an email to [email protected]

Check out our showcase wiki page! Feel free to add yourself! :)

Security Issues

Borokero sits between your system and the devices: this is a tough role, and we did our best to secure your systems. However, you might find a security issue: in that case, email [email protected]

Feedback

Use the issue tracker for bugs. Tweet us for any idea that can improve the project. Any questions? Technical question? Please ask the community Borokero Discord Community

Contribution

At Borokero we are strong believers in community, transparency, technical excellence & innovation. That is why we made Borokero Open-Source and actively contribute to, and depend on, this ecosystem.

Links

Authors

borokero.github.io's People

Contributors

expandboard avatar

Stargazers

Kamerdack avatar  avatar

Watchers

James Cloos avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.