Skip to content

README.md

Latest commit

 

History

History
127 lines (79 loc) · 2.8 KB

README.md

File metadata and controls

127 lines (79 loc) · 2.8 KB

How to Build Your Own ILLA Units

Index

Desc

In this tutorial, You can find the way out to build illa units by yourself, and all details about illa units.

Architechture

Illa consists of the following parts (called by illa unit):

Build illa-builder

Prepare Build Environment and Required Libs

  • linux kernel 4.5 or later version, ubuntu 20.04 LTS are recommended.
  • node.js 18 or later version

Clone From Source

mkdir /opt/illa/illa-builder-frontend
cd /opt/illa/illa-builder-frontend
git clone -b main https://github.com/illacloud/illa-builder.git /opt/illa/illa-builder-frontend/

Init Git Submodule

git submodule init
git submodule update

Install PNPM

npm install -g pnpm

Build

pnpm install
pnpm build-self

The build products are in /opt/illa/illa-builder-frontend/apps/builder/dist/.

  • dist/index.html for entrance.
  • dist/assets for frontend assets (css & javascripts).

Build builder-backend

Prepare Build Environment and Required Libs

  • golang 1.19 or later version.

Clone From Source

makedir /opt/illa/illa-builder-backend
cd /opt/illa/illa-builder-backend

git clone -b main https://github.com/illacloud/builder-backend.git ./

Build

make all 
ls -alh ./bin/*

The build products are in /opt/illa/illa-builder-backend/bin/.

  • bin/illa-builder-backend for WEB API.
  • bin/illa-builder-backend-ws for WebSocket server.

Build illa-supervisor-backend

Prepare Build Environment and Required Libs

  • golang 1.19 or later version.

Clone From Source

makedir /opt/illa/illa-supervisor-backend
cd /opt/illa/illa-supervisor-backend

git clone -b main https://github.com/illacloud/illa-supervisor-backend.git ./

Build

make all 
ls -alh ./bin/*

The build products are in /opt/illa/illa-supervisor-backend/bin/.

  • bin/illa-supervisor-backend for supervisor API.
  • bin/illa-supervisor-backend-internal for supervisor internal API. (Note this API design for other backend program retrieve raw data of illa units, so do not start and listen this API on public IP address.)

Need Support?

  • Call @Karminski at our Discord. Any questions are welcome!