diff --git a/README.md b/README.md index d3760ac..5effd4b 100644 --- a/README.md +++ b/README.md @@ -1,13 +1,11 @@ # NHSD Service Status Dashboard -A web-based status feed aggregator for the North Hills School District IT department. Provides a single-pane-of-glass view of vendor service health across 26 platforms, plus live WAN throughput graphs and FortiGate health monitoring. +A web-based status feed aggregator for the North Hills School District IT department. Provides a single-pane-of-glass view of vendor service health across 26 platforms. ## Features - **Vendor status cards** — real-time health for all district platforms, color-coded and sortable by severity -- **WAN throughput graphs** — live RX/TX graphs for Crown Castle and Comcast WAN links, pulled from the FortiGate API -- **FortiGate health panel** — hostname, firmware version, uptime, CPU, and memory utilization -- **Auto-refresh** — vendor status refreshes every 2 minutes; throughput every 30 seconds +- **Auto-refresh** — vendor status refreshes every 2 minutes - **Glanceable design** — optimized for a wall-mounted monitor; status obvious from across the room ## Prerequisites @@ -40,20 +38,10 @@ Edit `backend/.env`: AZURE_TENANT_ID=your-tenant-id AZURE_CLIENT_ID=your-client-id AZURE_CLIENT_SECRET=your-client-secret - -# FortiGate — WAN throughput and system health -FORTIGATE_HOST=10.1.20.1 -FORTIGATE_API_TOKEN=your-api-token -FORTIGATE_WAN1_INTERFACE=port25 -FORTIGATE_WAN1_LABEL=Crown Castle -FORTIGATE_WAN2_INTERFACE=port8 -FORTIGATE_WAN2_LABEL=Comcast ``` **Microsoft 365**: Create an app registration in Azure AD with `ServiceHealth.Read.All` permission (application, not delegated). -**FortiGate**: Create a read-only API token under **System → Administrators → Create New → REST API Admin**. Only Monitor access is required — no configuration access needed. - ### 3. Start the backend ```bash @@ -82,8 +70,6 @@ Use the helper scripts in `scripts/` to install the backend and Caddy as NSSM se | Endpoint | Description | |---|---| | `GET /api/status` | All vendor status (array) | -| `GET /api/throughput` | WAN throughput history (array of 30-min data points) | -| `GET /api/fortigate-health` | FortiGate hostname, version, uptime, CPU, memory | | `GET /api/health` | Backend liveness check | ## Adding a New Vendor