Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.ilyama.golain.io/llms.txt

Use this file to discover all available pages before exploring further.

For feature development on ilyama (API/workers) and pw (web console), use the local Docker stack — not the VM edge TLS bundle.

​
Prerequisites

  • Go 1.25+
  • Docker with Compose v2
  • Node.js (for pw)

​
Platform backend (ilyama)

From repo root: 
make help              # discover targets
make dev-setup         # infra + migrations + topology + sqlc
make dev-provision alone skips sqlc generation. Per-service env: 
make service-local-env   # copies missing .env from .env.example
# or manually: cp services/apis/.env.example services/apis/.env
Run services: 
make run               # apis, domain-workers, telemetry, mqtt-broker
make status
make tail-logs
Ports and troubleshooting: ilyama getting-started.

​
Auth bypass (optional)

With AUTH_BYPASS=true in apis .env, any bearer token works for API calls — useful for platform-tui and e2e without Zitadel. 
PLATFORM_TOKEN=dev PLATFORM_API_URL=http://localhost:19090 platform-tui fleets list

​
Web console (pw)

cd pw
npm install
cp .env.example .env     # VITE_MOCK_AUTH=true
npm run mock:server        # :8899
npm run dev                # :5173
Open http://localhost:5173 — auto login as Dev User with mock fleets/devices. Point at real local API by setting VITE_MOCK_AUTH=false and configuring Zitadel + VITE_API_URL.

​
platform-tui from source

cd ilyama
make platform-tui-build
make platform-tui-login
make platform-tui

​
Omega against local stack

Use HTTP mock transport or local MQTT from make provision-mqtt-dev. For full JITR rehearsal, see vm-edge or e2e fixtures.

​
When to switch to vm-edge

Move to VM edge deployment when you need:
  • Public DNS and Let’s Encrypt
  • mTLS on Postgres/Rabbit/Timescale
  • Staging environment matching production topology

​
E2E tests

make e2e SUITE=smoke
Requires full dev-provision. See ilyama testing docs.