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.

Golain can run on Golain-managed cloud or on your own VMs using the open-source ilyama stack.

Deployment options

OptionAudienceEntry point
Golain cloudMost customersConsole at https://web.ilyama.golain.io — no infra doc required
Local devEngineersmake dev-provision in ilyama
VM edge (production-like)OperatorsVM edge stack
AWS VM bootstrapOperatorsilyama/infra/deploy/aws-vm/README.md

Components

┌─────────────┐     ┌──────────────────┐     ┌─────────────┐
│  pw (web)   │────▶│  apis + workers  │────▶│  Postgres   │
└─────────────┘     │  mqtt-broker     │     │  RabbitMQ   │
                    │  telemetry       │     │  Timescale  │
                    └────────┬─────────┘     └─────────────┘

                    ┌────────▼─────────┐
                    │  Omega devices │
                    └────────────────┘
  • apis — HTTP API (Fiber)
  • domain-workers — mutations, integrations, outbox
  • mqtt-broker — device MQTT/QUIC
  • telemetry — time-series ingester
  • Zitadel — OIDC for users (console + CLIs)

Choose local dev vs VM edge

Local devVM edge
TLS on data planeNoYes (internal CA)
Public DNS + LE certsNoYes (Cloudflare DNS-01)
Commandmake dev-provisionmake vm-edge-stack-up
Use caseLaptop feature workStaging / airgap / on-prem
Local development

Edge and console URLs

Self-hosted operators publish:
  • https://auth.<domain> — Zitadel
  • https://api.<domain> — Platform API
  • https://app.<domain> — Web console (pw Docker image)
  • mqtt.<domain> — Device broker
Configure matching URLs in Omega connection / JITR blocks and in pw build args.

Getting help

  • Repo runbooks: ilyama/infra/devstack/
  • Mintlify docs (this site): platform, edge, and CLI guides apply to self-hosted with URL substitutions