From 376d2b411703e7094b51822e1575b23d922f71a1 Mon Sep 17 00:00:00 2001 From: 0x1d Date: Mon, 27 Oct 2025 15:34:03 +0100 Subject: [PATCH] feat: add deployment info to website --- public/index.html | 94 ++++++++++++++++++++++++++++++++++++++++++++++- 1 file changed, 93 insertions(+), 1 deletion(-) diff --git a/public/index.html b/public/index.html index eba223d..80c3340 100644 --- a/public/index.html +++ b/public/index.html @@ -29,6 +29,7 @@ Registry UI Apps + Deployment Docs @@ -455,6 +456,79 @@ curl http://localhost:3002/health +
+
+

Deployment

+

Complete deployment configurations for running the SPORE stack

+

Repository: spore-deployment

+ +
+
+

Docker Compose

+

Simple deployment with docker-compose for development and production with one command: docker compose up -d

+
+
+

Nomad Orchestration

+

Production-ready deployment with HashiCorp Nomad for multi-node clustering, rolling updates, and advanced resource management

+
+
+

Complete Stack

+

All SPORE services included: mosquitto MQTT broker, gateway, registry, UI, and LEDLab with proper networking and volumes

+
+
+

MQTT Integration

+

Built-in Mosquitto broker for message routing and event streaming with WebSocket support

+
+
+

Data Persistence

+

All data persisted in local directories for registry data, MQTT data, and firmware storage

+
+
+

Health Monitoring

+

Built-in service discovery, health checks, and real-time status monitoring for all services

+
+
+ +
+

Quick Start

+ 
# Clone the deployment repository
+git clone https://git.dcentral.systems/iot/spore-deployment.git
+cd spore-deployment
+
+# Start all services with Docker Compose
+docker compose up -d
+
+# Or start with Nomad (production)
+make nomad-start
+make nomad-job-run
+
+ +
+

Services

+
    +
  • mosquitto - MQTT broker (port 1883, WebSocket 9001)
    • +
  • spore-gateway - Node discovery and WebSocket gateway (port 3001, UDP 4210)
    • +
  • spore-registry - Firmware registry service (port 8090)
    • +
  • spore-ledlab - LED animation studio (port 8080)
    • +
  • spore-ui - Web UI for cluster management (port 3000)
    • +
+
+ +
+

Access Points

+

Once deployed, access the services at:

+
    +
  • Web UI: http://localhost:3000
    • +
  • LED Lab: http://localhost:8080
    • +
  • Registry API: http://localhost:8090
    • +
  • Gateway API: http://localhost:3001
    • +
  • MQTT Broker: tcp://localhost:1883
    • +
  • Nomad UI: http://localhost:4646 (Nomad deployments only)
    • +
+
+
+
+

Documentation

@@ -511,6 +585,14 @@ curl http://localhost:3002/health
  • PixelStream Controller - Required SPORE node firmware
    • +
    +

    SPORE Deployment

    + +
    @@ -561,6 +643,15 @@ npm start # Open browser http://localhost:3000
    +
    +

    SPORE Deployment

    + 
    # Docker Compose (dev)
+docker compose up -d
+
+# Nomad (production)
+make nomad-start
+make nomad-job-run
    +
    @@ -576,7 +667,8 @@ http://localhost:3000 spore-gateway · spore-registry · spore-ui · - spore-ledlab + spore-ledlab · + spore-deployment