langmart-gateway-type3 3.0.1 → 3.0.3

package/README.md

@@ -1,5 +1,7 @@
 # Gateway Type 3 - Seller-Managed Gateway
 
+[![npm version](https://badge.fury.io/js/langmart-gateway-type3.svg)](https://www.npmjs.com/package/langmart-gateway-type3)
+
 ## Overview
 Type 3 Gateway is a seller-managed gateway client that runs on the seller's infrastructure. It connects to the marketplace via WebSocket and uses the seller's own API keys to fulfill requests.
 
@@ -18,42 +20,249 @@ Type 3 Gateway is a seller-managed gateway client that runs on the seller's infr
 - **Interactive CLI UI** with chat interface and model management
 - **Intelligent Image Generation** with keyword-based auto-detection
 - **Terminal Image Preview** for generated images
+- **DevOps Mode**: Full session management with bash, SSH, and system tools
+
+---
+
+## 🚀 Quick Install (Recommended)
+
+### Linux/macOS
+
+Install the gateway on any Linux/macOS server with a single command:
+
+```bash
+# Using unpkg CDN (recommended)
+curl -fsSL https://unpkg.com/langmart-gateway-type3/scripts/install.sh | bash -s -- \
+  --marketplace-url ws://your-marketplace:8081 \
+  --api-key YOUR_API_KEY \
+  --full \
+  --service
+```
+
+### Windows (PowerShell)
+
+Install on Windows using PowerShell:
+
+```powershell
+# One-liner installation
+$env:MARKETPLACE_URL="ws://your-marketplace:8081"; $env:GATEWAY_API_KEY="YOUR_API_KEY"; iwr -useb https://unpkg.com/langmart-gateway-type3/scripts/install.ps1 | iex
+
+# Or download and run with parameters
+iwr -OutFile install.ps1 https://unpkg.com/langmart-gateway-type3/scripts/install.ps1
+.\install.ps1 -MarketplaceUrl "ws://your-marketplace:8081" -ApiKey "YOUR_API_KEY" -Full -Service
+```
+
+### Install Options
+
+#### Linux/macOS (Bash)
+
+| Option | Description | Default |
+|--------|-------------|---------|
+| `--marketplace-url URL` | Marketplace WebSocket URL | `ws://localhost:8081` |
+| `--api-key KEY` | Gateway API key for authentication | (none) |
+| `--port PORT` | Gateway port | `8083` |
+| `--install-dir DIR` | Installation directory | `/opt/langmart-gateway` |
+| `--capabilities CAPS` | Capabilities: `session,llm` or `llm` | `llm` |
+| `--full` | Enable full capabilities (DevOps + LLM) | (disabled) |
+| `--service` | Install as systemd service | (disabled) |
+
+#### Windows (PowerShell)
+
+| Parameter | Description | Default |
+|-----------|-------------|---------|
+| `-MarketplaceUrl URL` | Marketplace WebSocket URL | `ws://localhost:8081` |
+| `-ApiKey KEY` | Gateway API key for authentication | (none) |
+| `-Port PORT` | Gateway port | `8083` |
+| `-InstallDir DIR` | Installation directory | `C:\langmart-gateway` |
+| `-Capabilities CAPS` | Capabilities: `session,llm` or `llm` | `llm` |
+| `-Full` | Enable full capabilities (DevOps + LLM) | (disabled) |
+| `-Service` | Install as Windows Service (requires nssm) | (disabled) |
+
+### Examples
+
+#### Linux/macOS
+
+```bash
+# LLM routing only (default)
+curl -fsSL https://unpkg.com/langmart-gateway-type3/scripts/install.sh | bash -s -- \
+  --marketplace-url ws://10.0.1.117:8081 \
+  --api-key sk-test-inference-key
+
+# Full DevOps mode with systemd service
+curl -fsSL https://unpkg.com/langmart-gateway-type3/scripts/install.sh | bash -s -- \
+  --marketplace-url ws://10.0.1.117:8081 \
+  --api-key sk-test-inference-key \
+  --full \
+  --service
+
+# Custom port and directory
+curl -fsSL https://unpkg.com/langmart-gateway-type3/scripts/install.sh | bash -s -- \
+  --marketplace-url ws://10.0.1.117:8081 \
+  --api-key sk-test-inference-key \
+  --port 9000 \
+  --install-dir /home/user/gateway
+```
+
+#### Windows
+
+```powershell
+# LLM routing only (default)
+.\install.ps1 -MarketplaceUrl "ws://10.0.1.117:8081" -ApiKey "sk-test-inference-key"
+
+# Full DevOps mode with Windows Service
+.\install.ps1 -MarketplaceUrl "ws://10.0.1.117:8081" -ApiKey "sk-test-inference-key" -Full -Service
+
+# Custom port and directory
+.\install.ps1 -MarketplaceUrl "ws://10.0.1.117:8081" -ApiKey "sk-test-inference-key" -Port 9000 -InstallDir "D:\gateway"
+```
+
+### Alternative CDN
+
+```bash
+# Linux/macOS - Using jsdelivr
+curl -fsSL https://cdn.jsdelivr.net/npm/langmart-gateway-type3/scripts/install.sh | bash -s -- [OPTIONS]
+```
+
+```powershell
+# Windows - Using jsdelivr
+iwr -useb https://cdn.jsdelivr.net/npm/langmart-gateway-type3/scripts/install.ps1 | iex
+```
+
+---
+
+## 📦 Manual Installation
 
-## Installation
+### Option 1: npm install
 
 ```bash
+# Create installation directory
+mkdir -p /opt/langmart-gateway && cd /opt/langmart-gateway
+
+# Initialize and install
+npm init -y
+npm install langmart-gateway-type3
+
+# Create .env file
+cat > .env << EOF
+INSTANCE_ID=gw3-$(hostname)-$(date +%s | tail -c 5)
+GATEWAY_PORT=8083
+MARKETPLACE_URL=ws://your-marketplace:8081
+GATEWAY_API_KEY=your-api-key
+GATEWAY_CAPABILITIES=llm
+NODE_ENV=production
+EOF
+
+# Start the gateway
+node node_modules/langmart-gateway-type3/dist/index-server.js
+```
+
+### Option 2: Clone and Build
+
+```bash
+# Clone the repository
+git clone https://github.com/YiHuangDB/LangMartDesign.git
+cd LangMartDesign/gateway-type3
+
 # Install dependencies
 npm install
 
 # Build TypeScript
 npm run build
+
+# Configure
+cp .env.example .env
+# Edit .env with your settings
+
+# Start
+npm start
 ```
 
-## Configuration
+---
+
+## ⚙️ Configuration
+
+### Environment Variables
 
-Environment variables:
 ```bash
-GATEWAY3_ID=gw3-seller-001           # Gateway identifier
-GATEWAY3_API_KEY=sk-test-001         # Marketplace API key
-MARKETPLACE_URL=ws://localhost:8090   # Marketplace WebSocket URL
+# Gateway identification
+INSTANCE_ID=gw3-server-001           # Gateway identifier (auto-generated if not set)
+GATEWAY_PORT=8083                     # Gateway HTTP/WebSocket port
+
+# Marketplace connection
+MARKETPLACE_URL=ws://localhost:8081   # Marketplace WebSocket URL
+GATEWAY_API_KEY=sk-your-key          # Marketplace API key
+
+# Capabilities
+GATEWAY_CAPABILITIES=llm              # "llm" or "session,llm" for full DevOps
 
-# Provider API Keys (seller's own keys)
+# Local vault (for storing provider API keys)
+VAULT_PATH=.vault/credentials.enc     # Encrypted vault path
+VAULT_PASSWORD=random-secure-password # Vault encryption password
+
+# Provider API Keys (seller's own keys - stored in vault)
 OPENAI_API_KEY=sk-...                # OpenAI API key
 ANTHROPIC_API_KEY=sk-ant-...         # Anthropic API key
-GOOGLE_API_KEY=...                   # Google API key
-DEEPSEEK_API_KEY=sk-...             # DeepSeek API key
+GROQ_API_KEY=gsk_...                 # Groq API key
+```
+
+### Capability Modes
+
+| Mode | GATEWAY_CAPABILITIES | Description |
+|------|---------------------|-------------|
+| **LLM Only** | `llm` | Routes LLM requests to providers (default) |
+| **Full DevOps** | `session,llm` | LLM routing + bash, SSH, file ops, system tools |
+
+---
+
+## 🏃 Running
+
+### Manual Start
+
+```bash
+cd /opt/langmart-gateway
+
+# If installed via npm
+./start.sh
+
+# Or directly
+node node_modules/langmart-gateway-type3/dist/index-server.js
 ```
 
-## Running
+### Systemd Service
+
+If installed with `--service`:
 
 ```bash
-# Development mode (with TypeScript)
-npm run dev
+# Start
+sudo systemctl start langmart-gateway
 
-# Production mode (compiled JavaScript)
-npm start
+# Stop
+sudo systemctl stop langmart-gateway
+
+# Status
+sudo systemctl status langmart-gateway
+
+# Logs
+sudo journalctl -u langmart-gateway -f
 ```
 
+### Verify Installation
+
+```bash
+# Health check
+curl http://localhost:8083/health
+
+# Expected response:
+{
+  "status": "healthy",
+  "gatewayId": "gw3-server-12345",
+  "capabilities": ["session", "llm"],
+  "tools": 18
+}
+```
+
+---
+
 ## How It Works
 
 1. **Connection**: Gateway connects to marketplace via WebSocket

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "langmart-gateway-type3",
-  "version": "3.0.1",
+  "version": "3.0.3",
   "description": "LangMart Type 3 Gateway - Seller-Managed Gateway with Local Vault",
   "main": "dist/index-server.js",
   "types": "dist/index-server.d.ts",
@@ -102,6 +102,7 @@
     "scripts/stop.sh",
     "scripts/status.sh",
     "scripts/install.sh",
+    "scripts/install.ps1",
     ".env.example",
     "README.md"
   ],

package/scripts/install.ps1

@@ -0,0 +1,367 @@
+# Installation Script for LangMart Gateway Type 3 (Windows)
+# Run this script ON the target Windows server to install the gateway
+#
+# Usage (from PowerShell - recommended):
+#   iwr -useb https://unpkg.com/langmart-gateway-type3/scripts/install.ps1 | iex
+#
+# Or with parameters:
+#   $env:MARKETPLACE_URL="ws://your-server:8081"; $env:GATEWAY_API_KEY="your-key"; iwr -useb https://unpkg.com/langmart-gateway-type3/scripts/install.ps1 | iex
+#
+# Or download and run:
+#   .\install.ps1 -MarketplaceUrl "ws://localhost:8081" -ApiKey "your-key" -Full -Service
+#
+# Parameters:
+#   -MarketplaceUrl    Marketplace WebSocket URL (default: ws://localhost:8081)
+#   -ApiKey            Gateway API key for authentication
+#   -Port              Gateway port (default: 8083)
+#   -InstallDir        Installation directory (default: C:\langmart-gateway)
+#   -Capabilities      Gateway capabilities: session,llm or llm (default: llm)
+#   -Full              Enable full capabilities (DevOps + LLM routing)
+#   -Service           Install as Windows Service
+
+[CmdletBinding()]
+param(
+    [string]$MarketplaceUrl = $env:MARKETPLACE_URL,
+    [string]$ApiKey = $env:GATEWAY_API_KEY,
+    [int]$Port = 8083,
+    [string]$InstallDir = "C:\langmart-gateway",
+    [string]$Capabilities = "",
+    [switch]$Full,
+    [switch]$Service,
+    [switch]$Help
+)
+
+# Set defaults if not provided
+if ([string]::IsNullOrEmpty($MarketplaceUrl)) {
+    $MarketplaceUrl = "ws://localhost:8081"
+}
+
+# Colors for output
+function Write-ColorOutput($ForegroundColor) {
+    $fc = $host.UI.RawUI.ForegroundColor
+    $host.UI.RawUI.ForegroundColor = $ForegroundColor
+    if ($args) {
+        Write-Output $args
+    }
+    $host.UI.RawUI.ForegroundColor = $fc
+}
+
+function Write-Info { Write-Host $args -ForegroundColor Cyan }
+function Write-Success { Write-Host $args -ForegroundColor Green }
+function Write-Warning { Write-Host $args -ForegroundColor Yellow }
+function Write-Error { Write-Host $args -ForegroundColor Red }
+
+# Show help
+if ($Help) {
+    Write-Host @"
+LangMart Gateway Type 3 - Windows Installation Script
+
+Usage: .\install.ps1 [OPTIONS]
+
+Options:
+  -MarketplaceUrl URL    Marketplace WebSocket URL (default: ws://localhost:8081)
+  -ApiKey KEY           Gateway API key for authentication
+  -Port PORT            Gateway port (default: 8083)
+  -InstallDir DIR       Installation directory (default: C:\langmart-gateway)
+  -Capabilities CAPS    Gateway capabilities: session,llm or llm (default: llm)
+  -Full                 Enable full capabilities (DevOps + LLM routing)
+  -Service              Install as Windows Service
+  -Help                 Show this help message
+
+Examples:
+  # Basic installation (LLM routing only)
+  .\install.ps1 -MarketplaceUrl "ws://10.0.1.117:8081" -ApiKey "sk-test-key"
+
+  # Full DevOps mode with Windows Service
+  .\install.ps1 -MarketplaceUrl "ws://10.0.1.117:8081" -ApiKey "sk-test-key" -Full -Service
+
+  # One-liner from web (set env vars first)
+  `$env:MARKETPLACE_URL="ws://10.0.1.117:8081"; `$env:GATEWAY_API_KEY="sk-test-key"; iwr -useb https://unpkg.com/langmart-gateway-type3/scripts/install.ps1 | iex
+"@
+    exit 0
+}
+
+Write-Host ""
+Write-Host "===============================================================" -ForegroundColor Blue
+Write-Host "     LangMart Gateway Type 3 - Windows Installation           " -ForegroundColor Blue
+Write-Host "===============================================================" -ForegroundColor Blue
+Write-Host ""
+
+# Set capabilities
+if ($Full) {
+    $Capabilities = "session,llm"
+}
+if ([string]::IsNullOrEmpty($Capabilities)) {
+    $Capabilities = "llm"
+}
+
+# Check if running as Administrator
+$isAdmin = ([Security.Principal.WindowsPrincipal] [Security.Principal.WindowsIdentity]::GetCurrent()).IsInRole([Security.Principal.WindowsBuiltInRole]::Administrator)
+if (-not $isAdmin -and $Service) {
+    Write-Warning "Warning: Not running as Administrator. Service installation may fail."
+    Write-Warning "Please run PowerShell as Administrator for service installation."
+}
+
+# Step 1: Check Node.js installation
+Write-Info "[1/6] Checking Node.js installation..."
+
+$nodeVersion = $null
+try {
+    $nodeVersion = & node -v 2>$null
+} catch {
+    $nodeVersion = $null
+}
+
+if ([string]::IsNullOrEmpty($nodeVersion)) {
+    Write-Warning "Node.js not found. Installing Node.js..."
+
+    # Download and install Node.js using winget or chocolatey
+    $hasWinget = Get-Command winget -ErrorAction SilentlyContinue
+    $hasChoco = Get-Command choco -ErrorAction SilentlyContinue
+
+    if ($hasWinget) {
+        Write-Info "Installing Node.js via winget..."
+        winget install OpenJS.NodeJS.LTS --accept-package-agreements --accept-source-agreements
+    } elseif ($hasChoco) {
+        Write-Info "Installing Node.js via Chocolatey..."
+        choco install nodejs-lts -y
+    } else {
+        Write-Error "Please install Node.js manually from https://nodejs.org/"
+        Write-Error "Or install winget/chocolatey first."
+        exit 1
+    }
+
+    # Refresh PATH
+    $env:Path = [System.Environment]::GetEnvironmentVariable("Path","Machine") + ";" + [System.Environment]::GetEnvironmentVariable("Path","User")
+
+    $nodeVersion = & node -v 2>$null
+    if ([string]::IsNullOrEmpty($nodeVersion)) {
+        Write-Error "Node.js installation failed. Please install manually and try again."
+        exit 1
+    }
+}
+
+Write-Success "Node.js $nodeVersion installed"
+
+# Check npm
+$npmVersion = & npm -v 2>$null
+if ([string]::IsNullOrEmpty($npmVersion)) {
+    Write-Error "npm not found. Please reinstall Node.js."
+    exit 1
+}
+Write-Success "npm v$npmVersion installed"
+
+# Step 2: Create installation directory
+Write-Info "[2/6] Creating installation directory..."
+
+if (-not (Test-Path $InstallDir)) {
+    New-Item -ItemType Directory -Path $InstallDir -Force | Out-Null
+}
+Set-Location $InstallDir
+Write-Success "Directory created: $InstallDir"
+
+# Step 3: Initialize npm project
+Write-Info "[3/6] Initializing npm project..."
+
+if (-not (Test-Path "package.json")) {
+    @{
+        name = "langmart-gateway-instance"
+        version = "1.0.0"
+        private = $true
+    } | ConvertTo-Json | Set-Content "package.json"
+}
+Write-Success "npm project initialized"
+
+# Step 4: Install the gateway package
+Write-Info "[4/6] Installing langmart-gateway-type3..."
+
+npm install langmart-gateway-type3@latest
+if ($LASTEXITCODE -ne 0) {
+    Write-Error "Failed to install langmart-gateway-type3 package"
+    exit 1
+}
+Write-Success "Gateway package installed"
+
+# Step 5: Create environment file
+Write-Info "[5/6] Creating environment configuration..."
+
+# Generate instance ID
+$instanceId = "gw3-$($env:COMPUTERNAME.ToLower())-$(Get-Date -Format 'HHmm')"
+
+# Generate vault password
+$vaultPassword = -join ((65..90) + (97..122) + (48..57) | Get-Random -Count 32 | ForEach-Object {[char]$_})
+
+$envContent = @"
+# LangMart Gateway Type 3 Configuration
+# Generated by install.ps1 on $(Get-Date)
+
+# Gateway identification
+INSTANCE_ID=$instanceId
+GATEWAY_PORT=$Port
+
+# Marketplace connection
+MARKETPLACE_URL=$MarketplaceUrl
+
+# Gateway authentication
+GATEWAY_API_KEY=$ApiKey
+
+# Gateway capabilities (session,llm = full DevOps mode, llm = LLM routing only)
+GATEWAY_CAPABILITIES=$Capabilities
+
+# Local vault configuration
+VAULT_PATH=.vault\credentials.enc
+VAULT_PASSWORD=$vaultPassword
+
+# Environment
+NODE_ENV=production
+"@
+
+$envContent | Set-Content ".env"
+Write-Success "Environment file created"
+
+# Create start script
+$startScript = @'
+@echo off
+cd /d "%~dp0"
+
+:: Load environment variables from .env
+for /f "usebackq tokens=1,* delims==" %%a in (".env") do (
+    if not "%%a"=="" if not "%%a:~0,1%"=="#" set "%%a=%%b"
+)
+
+:: Start the gateway
+if exist "node_modules\langmart-gateway-type3" (
+    node node_modules\langmart-gateway-type3\dist\index-server.js
+) else (
+    node dist\index-server.js
+)
+'@
+$startScript | Set-Content "start.bat"
+
+# Create PowerShell start script
+$startPs1 = @'
+# Load environment variables
+Get-Content .env | ForEach-Object {
+    if ($_ -match '^([^#][^=]+)=(.*)$') {
+        [Environment]::SetEnvironmentVariable($matches[1], $matches[2], "Process")
+    }
+}
+
+# Start the gateway
+if (Test-Path "node_modules\langmart-gateway-type3") {
+    node node_modules\langmart-gateway-type3\dist\index-server.js
+} else {
+    node dist\index-server.js
+}
+'@
+$startPs1 | Set-Content "start.ps1"
+
+# Create stop script
+$stopScript = @'
+@echo off
+for /f "tokens=5" %%a in ('netstat -ano ^| findstr :8083 ^| findstr LISTENING') do (
+    taskkill /PID %%a /F
+    echo Gateway stopped (PID: %%a)
+    goto :done
+)
+echo Gateway not running
+:done
+'@
+$stopScript | Set-Content "stop.bat"
+
+Write-Success "Start/stop scripts created"
+
+# Step 6: Install as Windows Service (optional)
+if ($Service) {
+    Write-Info "[6/6] Installing Windows Service..."
+
+    # Check for nssm (Non-Sucking Service Manager)
+    $hasNssm = Get-Command nssm -ErrorAction SilentlyContinue
+
+    if (-not $hasNssm) {
+        Write-Warning "nssm not found. Installing via chocolatey..."
+        if (Get-Command choco -ErrorAction SilentlyContinue) {
+            choco install nssm -y
+            $env:Path = [System.Environment]::GetEnvironmentVariable("Path","Machine") + ";" + [System.Environment]::GetEnvironmentVariable("Path","User")
+        } else {
+            Write-Warning "Cannot install nssm automatically. Please install manually:"
+            Write-Warning "  choco install nssm"
+            Write-Warning "  Or download from https://nssm.cc/"
+            Write-Warning ""
+            Write-Warning "Then run: nssm install LangMartGateway"
+        }
+    }
+
+    $hasNssm = Get-Command nssm -ErrorAction SilentlyContinue
+    if ($hasNssm) {
+        # Remove existing service if present
+        nssm stop LangMartGateway 2>$null
+        nssm remove LangMartGateway confirm 2>$null
+
+        # Install new service
+        $nodePath = (Get-Command node).Source
+        $scriptPath = Join-Path $InstallDir "node_modules\langmart-gateway-type3\dist\index-server.js"
+
+        nssm install LangMartGateway $nodePath $scriptPath
+        nssm set LangMartGateway AppDirectory $InstallDir
+        nssm set LangMartGateway DisplayName "LangMart Gateway Type 3"
+        nssm set LangMartGateway Description "LangMart Type 3 Gateway - Seller-Managed Gateway"
+        nssm set LangMartGateway Start SERVICE_AUTO_START
+
+        # Set environment variables for the service
+        $envVars = @(
+            "INSTANCE_ID=$instanceId",
+            "GATEWAY_PORT=$Port",
+            "MARKETPLACE_URL=$MarketplaceUrl",
+            "GATEWAY_API_KEY=$ApiKey",
+            "GATEWAY_CAPABILITIES=$Capabilities",
+            "NODE_ENV=production"
+        ) -join "`n"
+        nssm set LangMartGateway AppEnvironmentExtra $envVars
+
+        Write-Success "Windows Service installed"
+        Write-Info "  Start:   nssm start LangMartGateway"
+        Write-Info "  Stop:    nssm stop LangMartGateway"
+        Write-Info "  Status:  nssm status LangMartGateway"
+        Write-Info "  Logs:    nssm edit LangMartGateway (configure stdout/stderr)"
+    }
+} else {
+    Write-Info "[6/6] Skipping Windows Service installation..."
+}
+
+Write-Host ""
+Write-Host "===============================================================" -ForegroundColor Green
+Write-Host "           Installation Complete!                              " -ForegroundColor Green
+Write-Host "===============================================================" -ForegroundColor Green
+Write-Host ""
+Write-Info "Installation Directory: $InstallDir"
+Write-Info "Gateway Port: $Port"
+Write-Info "Marketplace URL: $MarketplaceUrl"
+
+if ($Capabilities -eq "session,llm") {
+    Write-Info "Mode: Full (DevOps + LLM Routing)"
+} else {
+    Write-Info "Mode: LLM Routing Only"
+}
+
+Write-Host ""
+if ([string]::IsNullOrEmpty($ApiKey)) {
+    Write-Warning "Before starting, configure your API key:"
+    Write-Info "  1. Edit $InstallDir\.env"
+    Write-Info "  2. Set GATEWAY_API_KEY=your-api-key"
+    Write-Host ""
+}
+
+Write-Warning "To start the gateway:"
+if ($Service) {
+    Write-Info "  nssm start LangMartGateway"
+} else {
+    Write-Info "  cd $InstallDir"
+    Write-Info "  .\start.ps1"
+    Write-Info "  # Or: .\start.bat"
+}
+
+Write-Host ""
+Write-Warning "To verify installation:"
+Write-Info "  Invoke-RestMethod http://localhost:$Port/health"
+Write-Host ""