Developer guide

Build, configure, deploy, and extend UmamiEdge v8.

This guide is for engineers implementing the control plane, Supabase backend, node telemetry, customer APIs, and pilot deployment workflow.

Quick commands

Developer quick reference.

TaskCommand or endpoint
Local setupnpm install && npm run dev
Buildnpm run build
Schema orderdocs/supabase-schema.sql → docs/rls-policies.sql → docs/seed-demo.sql
Health checkGET /api/health
Readiness checkGET /api/readiness/check
OpenAI-compatible gatewayGET /api/v1/models · POST /api/v1/chat/completions · POST /api/v1/embeddings
Architecture

The v8 control-plane layers.

Frontend

Next.js App Router, global marketing pages, dashboard screens, docs hub, auth callbacks, API route handlers.

Supabase

Postgres tables, RLS policies, OAuth, magic links, tenant membership, node telemetry, usage events, audit events.

Node Agent

Linux TypeScript collector starter that reports GPU, power, latency, temperature, and heartbeat metrics.

Routing

Explainable routing stubs that score nodes by latency, health, available power, region policy, runtime health, and tenant quota.

Gateway

OpenAI-compatible API surfaces for /v1/models, /v1/chat/completions, and /v1/embeddings.

Operations

Incidents, SLA, failover, billing-control, compliance evidence, runtime marketplace, and admin/audit screens.

Setup sequence

Recommended local-to-production workflow.

01

Extract the ZIP and run npm install.

02

Copy .env.example to .env.local and add Supabase URL, anon key, service role key, and NEXT_PUBLIC_SITE_URL.

03

Run docs/supabase-schema.sql, then docs/rls-policies.sql, then optionally docs/seed-demo.sql in Supabase SQL editor.

04

Configure Google and GitHub OAuth providers in Supabase Auth and add /auth/callback redirect URLs.

05

Run npm run dev and verify /api/health, /login, /operator, /docs, and /api/readiness/check.

06

Deploy to Vercel, add the same environment variables, and re-check OAuth redirects on the production domain.

API map

Core route groups to wire into real services.

Auth

/api/auth/oauth · /api/auth/signin · /api/auth/signout · /auth/callback

Nodes

/api/nodes/register · /api/node-keys/create · /api/node-keys/list · /api/node-keys/rotate · /api/node-keys/revoke

Telemetry

/api/telemetry/ingest · /api/ops/snapshot · /api/usage/summary

Gateway

/api/v1/models · /api/v1/chat/completions · /api/v1/embeddings

Reliability

/api/router/simulate · /api/failover/simulate · /api/sla/simulate · /api/sla/v7-policy

v8

/api/readiness/check

Next engineering milestones

What to implement after v8.

Replace mock runtime responses with a real vLLM/Ollama/TGI proxy, generate Supabase types from your live database, enforce customer API quotas, add invitation acceptance, and package the node agent as a signed Linux release.

Developer Guide | UmamiEdge