HomeDocumentation
Documentation

Installation

Suggest Edits

📘

To use the Boodskap Cloud

Go to Boodskap Platform

Create an account and start using right away..

Boodskap IoT platform can be installed in a variety of ways, the simplest way to get started is to use docker environment to setup everything in a single machine

💥

Scalable Cluster Installation

Contact Us for setting up very highly scalable platform clusters

Supported deployment environments

  • Docker Swarm
  • Kubernetes
  • AWS EC2 On-Demand Scalable
  • Microsoft Azure
  • GCP
  • E2E Networks

👍

On Premise Installation

Meant for experienced users who need to deploy it on their own infrastructure

❗️

You need a machine with at least 32 GB of RAM

Linux (Ubuntu, CentOS, RedHat) machine is preferred

📘

The following services will be installed as containers

  • Apache Cassandra
  • ElasticSearch
  • Apache Zookeeper
  • Apache Kafka
  • EMQX - MQTT Server
  • Apache Ignite - Grid Computing Framework
  • Boodskap IoT Platform
  • Boodskap UI - Developer Console
  • Nginx

Setup Docker

Install Docker

Follow the above link, pick your operating system and install Docker Engine and docker-compose utility

Clone the repository

git clone https://github.com/boodskap/boodskap.git

Pull the Containers and Start

cd boodskap

docker-compose pull

./deploy.sh

Depends upon your machine configuration and internet bandwidth speed, the above step may take about 15 minutes to several hours

Verify

You can find the Boodskap Platform container ID by

docker ps | grep boodskap01 you may find something similar to the below

7c0473f0848e   boodskapiot/platform:5.2.0-00   "/bin/sh -c 'exec /u…"   About an hour ago   Up 2 minutes       1883/tcp, 2021/tcp, 5151/udp, 5151/tcp, 5555/udp, 6161/tcp, 6161/udp, 7171/tcp, 8083/tcp, 7171/udp, 8181/tcp, 40000-40100/tcp, 8181/udp, 0.0.0.0:18080->18080/tcp   boodskap-boodskap01-1

Now you can see the container logs by typing

docker logs -f your-container-id

Replace your-container-id with something similar to 7c0473f0848e

Wait until you see something similar to the below

05:28:57.145 INFO ServiceManager.java:237 All setup done, platform started

    )             (           )
 ( /(             )\ )     ( /(     )
 )\())  (    (   (()/( (   )\()) ( /(  `  )
((_)\   )\   )\   ((_)))\ ((_)\  )(_)) /(/(
| |(_) ((_) ((_)  _| |((_)| |(_)((_)_ ((_)_\
| '_ \/ _ \/ _ \/ _` |(_-<| / / / _` || '_ \)
|_.__/\___/\___/\__,_|/__/|_\_\ \__,_|| .__/
                                      |_| IoT Platform 5.2.0-00

Find your Cluster ID

curl http://localhost/api/license/status

The above command will produce something similar

{"clusterId":"WEBE-POB9-IGQL-WBAO","licensed":false,"state":0,"accountActive":false,"domainActive":false,"version":"5.2.0-00","apiVersion":"5.0.0-120"}

Contact Support[support @ boodskap.io] with your Cluster ID, Example: WEBE-POB9-IGQL-WBAO

Apply your License

Once you have received a license key, open it in a text editor and copy the content of it

curl -XPOST -H "Content-Type: application/json" http://localhost/api/cluster/license/apply -d 'YOUR LICENSE CONTENT'

Developer Console

Quick Tips

  • The default admin domain (tenant) is not meant to be used for any development except admin purpose
  • When you install the license, a new tenant will be created and the email id supplied during license generation will be set as default domain administrator
  • You can login to the newly created domain by logging as admin user and
    • Home -> Login As -> Re-Enter the admin password -> Click on the Login Action
  • Passwords can be changed by
    • Drop Down Profile Icon -> Edit Profile -> Change Password

❗️

Restrictions

  • On Premise installations won't support creation of additional domains (tenants)
  • You can Contact Us for
    • New domain license keys
    • Additional CPU resources exceeding 24 cores

Updated 4 months ago