DISCONTINUATION OF PROJECT.

This project will no longer be maintained by Intel.

This project has been identified as having known security escapes.

Intel has ceased development and contributions including, but not limited to, maintenance, bug fixes, new releases, or updates, to this project.

Intel no longer accepts patches to this project.

IoT Portal

IoT Portal is a web application that interacts with Intel In-Band Manageability to provide remote over-the-air (OTA) updates to IoT devices. It supports Firmware OTA (FOTA), Software OTA (SOTA), Application OTA (AOTA) and Configuration OTA (COTA).

• Supports FOTA, SOTA, AOTA and COTA features.
• Device categorization feature.
• Device grouping feature.
• Saved command feature.
• Mass OTA update feature.
• Robust Mass OTA background job processing.

📋 Requirements

• Docker Engine 20.10
• Docker Compose 1.29.2 (already included with some Docker installations)

These dependencies are free to use.

🔧 Installation

You can install IoT Portal using Docker containers on Linux distributions. Use the provided Bash scripts to get started quickly.

Linux

Install Docker Engine 20.10

curl -fsSL https://get.docker.com -o get-docker.sh
sudo VERSION=20.10 sh get-docker.sh

Optionally, manage Docker as a non-root user by following the instructions at Manage Docker as a non-root user.

sudo groupadd docker
sudo usermod -aG docker $USER
newgrp docker

Install Docker Compose 1.29.2

sudo curl -L "https://github.com/docker/compose/releases/download/1.29.2/docker-compose-$(uname -s)-$(uname -m)" -o /usr/local/bin/docker-compose
sudo chmod +x /usr/local/bin/docker-compose
sudo ln -s /usr/local/bin/docker-compose /usr/bin/docker-compose

Clone the repository to your system:

git clone https://github.com/intel/IoTPortal

Navigate to the scripts directory and give it permission to execute:

cd scripts && chmod +x *

Run the installation script. A ./iotportaldata directory will be created.

./iotportal.sh install 

Finally, start your IoT Portal instance.

./iotportal.sh start 

Migrate the database for the first run.

./iotportal.sh migrateDb 

Seed the database.

./iotportal.sh seedDb 

To seed the database with sample data, run the command below. A random generated user will be created with the password defaulted to password.

ONLY TRY THIS ON DEVELOPMENT INSTANCE! THIS IS FOR YOU TO EXPERIMENT THE FEATURES WITHOUT ACTUALLY PROVISIONING A DEVICE.

./iotportal.sh seedDbSample 

By default, the script uses values in the .env.staging file for deployment. You should replace those default credentials, e.g. DB_PASSWORD, REDIS_PASSWORD, MQTT_PASSWORD etc. with your own randomly generated password for production deployment.

📖 Script Commands Reference

Command	Description
install	Start the installer.
start	Start all containers.
restart	Restart all containers (same as start).
stop	Stop all containers.
rebuild	Rebuild generated installation assets.
migrateDb	Update/initialize the database.
seedDb	Seed all required data for first run.
seedDbSample	Seed the database with sample data. (Development use only)
clearDb	Clear the entire database. (Development use only)
help	List all commands.

Use these commands cautiously. Some commands are intended for development purpose only.

⚒️ In-Band Manageability Integration

Read our Integration Guide to learn how to integrate the IoT Portal adapter into In-Band Manageability.

👏 Contributing

Thank you for considering contributing to the IoT Portal! PHPStorm is highly recommended if you are working on this project. Please commit any pull requests against the master branch.

📄 License

IoT Portal is open-sourced software licensed under the GPL-2.0-or-later license.