EdgeStream Hub – WebUI

The EdgeStream Hub WebUI is the web-based management interface for EdgeStream Hub. It provides operators with a secure, modern UI for configuring, monitoring, and operating an EdgeStream deployment running on an appliance or edge node.

---

✨ Features

• React + TypeScript single-page application
• Built with Vite for fast development and optimized production builds
• Real-time updates via GraphQL subscriptions (WebSockets)
• Deep integration with EdgeStream API, Vector, and InfluxDB
• CSP-hardened (no inline scripts required)
• Distributed as a Debian (.deb) package

---

🧱 Tech Stack

• React (TypeScript)
• Vite
• Mantine UI
• pnpm
• nginx (reverse proxy)
• Debian packaging

---

🚀 Running Locally (Development)

Prerequisites

• Node.js 18+
• pnpm

Install pnpm if required:

npm install -g pnpm

Install dependencies:

pnpm install

Run the development server:

pnpm dev

The UI will be available at:

http://localhost:3000

---

⚙️ Configuration

Runtime configuration is loaded from JSON files deployed alongside the static assets:

/opt/edgestream-webui/html/
├── config.json
├── config-local.json
├── config-staging.json

These files allow environment-specific configuration without rebuilding the UI.

---

🏗️ Production Build

pnpm build

Build output:

dist/
├── index.html
├── assets/
│   ├── index-<hash>.js
│   ├── index-<hash>.css
│   └── *.svg

---

🔐 Authentication

The WebUI supports two authentication modes, selected at runtime.

Local Authentication

• Username/password handled by EdgeStream API
• JWT stored in localStorage
• Designed for offline or air‑gapped environments

Auth0 Authentication

• OAuth2 / OIDC via Auth0
• Token validation performed by the API
• Auth mode stored as authenticator=auth0

The UI adapts behavior automatically based on the active auth mode.

---

📦 Debian Packaging

The WebUI is distributed as a Debian package for EdgeStream appliances.

Typical install layout:

/opt/edgestream-webui/html/

High-level packaging flow:

pnpm build
dpkg-buildpackage -us -uc

Resulting artifact:

edgestream-webui_<version>_all.deb

---

🗂 Repository Structure

src/
├── app/            # App bootstrap, providers, store
├── assets/         # Static images and icons
├── components/     # Shared UI components
├── features/       # Feature-oriented modules
├── pages/          # Route-level pages
├── service/        # API / GraphQL client logic
├── theme/          # Mantine theme configuration

---

📄 License

EdgeStream WebUI is licensed under the Functional Source License 1.1, ALv2 Future License (FSL-1.1-ALv2).

See:

• LICENSE for full terms
• COMMERCIAL.md for commercial licensing requirements