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.

The Golain Platform Web (pw) is the browser UI for managing organizations, projects, fleets, devices, OTA, integrations, and settings.

​
Access the console

EnvironmentURL
Productionhttps://web.ilyama.golain.io (or your operator URL)
Local devhttp://localhost:5173 after npm run dev
Sign in with Zitadel OIDC. After login the app stores your access token and sends it on every API request together with the active ORG-ID header.

​
Layout

┌─────────────────────────────────────────────────────────┐
│  Header — org switcher, project switcher, user menu      │
├──────────────┬──────────────────────────────────────────┤
│  Sidebar     │  Main content (lazy-loaded feature)      │
│  (per        │                                          │
│   project)   │                                          │
└──────────────┴──────────────────────────────────────────┘
Routes follow /:org_id/:project_id/<feature>. Changing org or project updates the URL and reloads scoped data.

​
Feature modules

ModulePurpose
HomeProject dashboard and shortcuts
Fleets & devicesFleet CRUD, device list, device detail, certificates
OTA updatesReleases, deployments, rollout status
ConnectionsIntegration accounts and bindings
DefinitionsData points, shadows, contexts
DashboardPanel visualizations
Rule engine / Quick rulesAutomation pipelines
Logs & activitiesAudit and alert views
SettingsOrg and project configuration
User authenticationMembers and access
Analysis / Reports / Query builderData exploration
Each module loads on demand for faster initial page load.

​
Local development with mock data

Developers can run the UI without a live backend: 
cd pw
npm install
cp .env.example .env   # VITE_MOCK_AUTH=true by default
npm run mock:server    # terminal 1 — Hono API on :8899
npm run dev            # terminal 2 — Vite on :5173
Mock mode seeds a fake Dev User and realistic sample fleets/devices. Switch to real auth by setting VITE_MOCK_AUTH=false and configuring Zitadel variables in .env. Many console actions have CLI equivalents in platform-tui — useful for scripting and CI.

Fleets & devices

Create fleets, register devices, view MQTT details.

OTA updates

Ship firmware to tagged devices.