# brando1972/openmsp architecture

> Architecture diagram of the GitHub repository brando1972/openmsp, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2026-11-21). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/brando1972/openmsp
- Repository: https://github.com/brando1972/openmsp

## Overview

OpenMSP/ApexMSP is a multi-tenant PSA and RMM platform. An operator signs into the React console, which presents client, device, billing, support, and security workflows through the API control plane; a cross-platform Go agent enrolls devices and reports telemetry. The API also exposes real-time WebSocket events and supports network monitoring, backups, MDM, remote support, and other documented capabilities. Several route implementations were not sampled, so those feature branches are represented at their exact route paths without inferred internal call chains.

Main entry points: [`apps/api/src/server.ts`](https://github.com/brando1972/openmsp/blob/main/apps/api/src/server.ts) (HTTP API), [`apps/console/src/App.tsx`](https://github.com/brando1972/openmsp/blob/main/apps/console/src/App.tsx) (Console workspace), [`apps/agent/cmd/agent/main.go`](https://github.com/brando1972/openmsp/blob/main/apps/agent/cmd/agent/main.go) (Native device agent), [`apps/api/src/ws/manager.ts`](https://github.com/brando1972/openmsp/blob/main/apps/api/src/ws/manager.ts) (WebSocket manager)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_console["Operator console"]
  node_console_app["Console workspace<br/>[App.tsx]"]
  node_console_state["Console state<br/>[AppContext.tsx]"]
  node_console_billing["Billing context<br/>[BillingContext.tsx]"]
  node_console_clients["Client management<br/>[ClientsView.tsx]"]
  node_console_backup["Backup dashboard"]
  node_console_mdm["MDM console<br/>[MdmView.tsx]"]
  node_console_security["Security console"]
  node_console_network["Network map<br/>[NetworkMapView.tsx]"]
  node_console_remote["Remote support"]
  node_console_tickets["PSA tickets<br/>[PSATicketsView.tsx]"]
  node_console_dispatch["Dispatch PWA<br/>[DispatchApp.tsx]"]
end

subgraph group_control["API control plane"]
  node_api_server["HTTP API<br/>[server.ts]"]
  node_api_auth["Authentication<br/>[auth.ts]"]
  node_api_store[("Application store<br/>[store.ts]")]
  node_api_billing["Billing engine<br/>[engine.ts]"]
  node_api_agents["Agent routes<br/>[agents.ts]"]
  node_api_backups["Backup routes<br/>[backups.ts]"]
  node_api_security["Security routes<br/>[security.ts]"]
  node_api_installers["Installer routes<br/>[installers.ts]"]
  node_api_mdm["MDM routes<br/>[mdm.ts]"]
  node_api_mesh["Mesh routes<br/>[mesh.ts]"]
  node_api_net["Network routes<br/>[net.ts]"]
  node_api_tickets["Ticket routes<br/>[tickets.ts]"]
  node_api_billing_routes["Billing routes<br/>[billing.ts]"]
  node_api_ws["WebSocket manager<br/>[manager.ts]"]
  node_api_monitoring["Monitoring engine<br/>[checkmkEngine.ts]"]
  node_api_tunnel["Tunnel transport<br/>[tunnelWs.ts]"]
end

subgraph group_endpoint["Device agent"]
  node_agent["Native device agent<br/>[main.go]"]
  node_agent_backup["Agent backup engine<br/>[engine.go]"]
  node_agent_security["SOAR worker<br/>[soar_worker.go]"]
  node_agent_client["API client<br/>[client.go]"]
end

subgraph group_platform["Platform integrations"]
  node_mesh_client["MeshCentral client<br/>[meshClient.ts]"]
end

node_operator(("MSP operator"))
node_payment["Stripe"]

node_operator -->|"uses"| node_console_app
node_console_app -->|"loads state"| node_console_state
node_console_app -->|"renders"| node_console_clients
node_console_app -->|"renders"| node_console_backup
node_console_app -->|"renders"| node_console_mdm
node_console_app -->|"renders"| node_console_security
node_console_app -->|"renders"| node_console_network
node_console_app -->|"renders"| node_console_tickets
node_console_state -.->|"calls API"| node_api_server
node_console_billing -.->|"requests billing"| node_api_server
node_api_server -->|"uses middleware"| node_api_auth
node_api_server -->|"routes requests"| node_api_agents
node_api_server -->|"routes requests"| node_api_backups
node_api_server -->|"routes requests"| node_api_security
node_api_server -->|"routes requests"| node_api_installers
node_api_server -->|"routes requests"| node_api_mdm
node_api_server -->|"routes requests"| node_api_mesh
node_api_server -->|"routes requests"| node_api_net
node_api_server -->|"routes requests"| node_api_tickets
node_api_server -->|"routes requests"| node_api_billing_routes
node_api_server -->|"initializes"| node_api_ws
node_api_ws -->|"dispatches upgrades"| node_api_tunnel
node_api_billing -->|"reads and writes"| node_api_store
node_api_monitoring -->|"reads and writes"| node_api_store
node_api_monitoring -->|"broadcasts events"| node_api_ws
node_agent -.->|"uses client"| node_agent_client
node_agent -.->|"runs backups"| node_agent_backup
node_agent -.->|"runs response"| node_agent_security
node_agent -.->|"enrolls and reports"| node_api_agents
node_api_mesh -.->|"uses MeshCentral"| node_mesh_client
node_api_billing_routes -.->|"charges payments"| node_payment

click node_console_app "https://github.com/brando1972/openmsp/blob/main/apps/console/src/App.tsx"
click node_console_state "https://github.com/brando1972/openmsp/blob/main/apps/console/src/data/AppContext.tsx"
click node_console_billing "https://github.com/brando1972/openmsp/blob/main/apps/console/src/data/BillingContext.tsx"
click node_console_clients "https://github.com/brando1972/openmsp/blob/main/apps/console/src/components/clients/ClientsView.tsx"
click node_console_backup "https://github.com/brando1972/openmsp/blob/main/apps/console/src/components/backups/BackupDashboardView.tsx"
click node_console_mdm "https://github.com/brando1972/openmsp/blob/main/apps/console/src/components/mdm/MdmView.tsx"
click node_console_security "https://github.com/brando1972/openmsp/blob/main/apps/console/src/components/security/SecuritySocView.tsx"
click node_console_network "https://github.com/brando1972/openmsp/blob/main/apps/console/src/components/network/NetworkMapView.tsx"
click node_console_remote "https://github.com/brando1972/openmsp/blob/main/apps/console/src/components/remoteSupport/RemoteSupportView.tsx"
click node_console_tickets "https://github.com/brando1972/openmsp/blob/main/apps/console/src/components/psa/PSATicketsView.tsx"
click node_console_dispatch "https://github.com/brando1972/openmsp/blob/main/apps/console/src/components/dispatch/DispatchApp.tsx"
click node_api_server "https://github.com/brando1972/openmsp/blob/main/apps/api/src/server.ts"
click node_api_auth "https://github.com/brando1972/openmsp/blob/main/apps/api/src/middleware/auth.ts"
click node_api_store "https://github.com/brando1972/openmsp/blob/main/apps/api/src/db/store.ts"
click node_api_billing "https://github.com/brando1972/openmsp/blob/main/apps/api/src/billing/engine.ts"
click node_api_agents "https://github.com/brando1972/openmsp/blob/main/apps/api/src/routes/agents.ts"
click node_api_backups "https://github.com/brando1972/openmsp/blob/main/apps/api/src/routes/backups.ts"
click node_api_security "https://github.com/brando1972/openmsp/blob/main/apps/api/src/routes/security.ts"
click node_api_installers "https://github.com/brando1972/openmsp/blob/main/apps/api/src/routes/installers.ts"
click node_api_mdm "https://github.com/brando1972/openmsp/blob/main/apps/api/src/routes/mdm.ts"
click node_api_mesh "https://github.com/brando1972/openmsp/blob/main/apps/api/src/routes/mesh.ts"
click node_api_net "https://github.com/brando1972/openmsp/blob/main/apps/api/src/routes/net.ts"
click node_api_tickets "https://github.com/brando1972/openmsp/blob/main/apps/api/src/routes/tickets.ts"
click node_api_billing_routes "https://github.com/brando1972/openmsp/blob/main/apps/api/src/routes/billing.ts"
click node_api_ws "https://github.com/brando1972/openmsp/blob/main/apps/api/src/ws/manager.ts"
click node_api_monitoring "https://github.com/brando1972/openmsp/blob/main/apps/api/src/net/checkmkEngine.ts"
click node_api_tunnel "https://github.com/brando1972/openmsp/blob/main/apps/api/src/net/tunnelWs.ts"
click node_agent "https://github.com/brando1972/openmsp/blob/main/apps/agent/cmd/agent/main.go"
click node_agent_backup "https://github.com/brando1972/openmsp/blob/main/apps/agent/internal/backup/engine.go"
click node_agent_security "https://github.com/brando1972/openmsp/blob/main/apps/agent/internal/security/soar_worker.go"
click node_agent_client "https://github.com/brando1972/openmsp/blob/main/apps/agent/internal/client/client.go"
click node_mesh_client "https://github.com/brando1972/openmsp/blob/main/apps/api/src/mesh/meshClient.ts"

classDef toneNeutral fill:#f8fafc,stroke:#334155,stroke-width:1.5px,color:#0f172a
classDef toneBlue fill:#dbeafe,stroke:#2563eb,stroke-width:1.5px,color:#172554
classDef toneAmber fill:#fef3c7,stroke:#d97706,stroke-width:1.5px,color:#78350f
classDef toneMint fill:#dcfce7,stroke:#16a34a,stroke-width:1.5px,color:#14532d
classDef toneRose fill:#ffe4e6,stroke:#e11d48,stroke-width:1.5px,color:#881337
classDef toneIndigo fill:#e0e7ff,stroke:#4f46e5,stroke-width:1.5px,color:#312e81
classDef toneTeal fill:#ccfbf1,stroke:#0f766e,stroke-width:1.5px,color:#134e4a
class node_console_app,node_console_state,node_console_billing,node_console_clients,node_console_backup,node_console_mdm,node_console_security,node_console_network,node_console_remote,node_console_tickets,node_console_dispatch toneBlue
class node_api_server,node_api_auth,node_api_store,node_api_billing,node_api_agents,node_api_backups,node_api_security,node_api_installers,node_api_mdm,node_api_mesh,node_api_net,node_api_tickets,node_api_billing_routes,node_api_ws,node_api_monitoring,node_api_tunnel toneAmber
class node_agent,node_agent_backup,node_agent_security,node_agent_client toneMint
class node_mesh_client toneRose
class node_operator,node_payment toneIndigo
```

## Components

### Operator console

- [Console workspace](https://github.com/brando1972/openmsp/blob/main/apps/console/src/App.tsx): `apps/console/src/App.tsx`
- [Console state](https://github.com/brando1972/openmsp/blob/main/apps/console/src/data/AppContext.tsx): `apps/console/src/data/AppContext.tsx`
- [Billing context](https://github.com/brando1972/openmsp/blob/main/apps/console/src/data/BillingContext.tsx): `apps/console/src/data/BillingContext.tsx`
- [Client management](https://github.com/brando1972/openmsp/blob/main/apps/console/src/components/clients/ClientsView.tsx): `apps/console/src/components/clients/ClientsView.tsx`
- [Backup dashboard](https://github.com/brando1972/openmsp/blob/main/apps/console/src/components/backups/BackupDashboardView.tsx): `apps/console/src/components/backups/BackupDashboardView.tsx`
- [MDM console](https://github.com/brando1972/openmsp/blob/main/apps/console/src/components/mdm/MdmView.tsx): `apps/console/src/components/mdm/MdmView.tsx`
- [Security console](https://github.com/brando1972/openmsp/blob/main/apps/console/src/components/security/SecuritySocView.tsx): `apps/console/src/components/security/SecuritySocView.tsx`
- [Network map](https://github.com/brando1972/openmsp/blob/main/apps/console/src/components/network/NetworkMapView.tsx): `apps/console/src/components/network/NetworkMapView.tsx`
- [Remote support](https://github.com/brando1972/openmsp/blob/main/apps/console/src/components/remoteSupport/RemoteSupportView.tsx): `apps/console/src/components/remoteSupport/RemoteSupportView.tsx`
- [PSA tickets](https://github.com/brando1972/openmsp/blob/main/apps/console/src/components/psa/PSATicketsView.tsx): `apps/console/src/components/psa/PSATicketsView.tsx`
- [Dispatch PWA](https://github.com/brando1972/openmsp/blob/main/apps/console/src/components/dispatch/DispatchApp.tsx): `apps/console/src/components/dispatch/DispatchApp.tsx`

### API control plane

- [HTTP API](https://github.com/brando1972/openmsp/blob/main/apps/api/src/server.ts): `apps/api/src/server.ts`
- [Authentication](https://github.com/brando1972/openmsp/blob/main/apps/api/src/middleware/auth.ts): `apps/api/src/middleware/auth.ts`
- [Application store](https://github.com/brando1972/openmsp/blob/main/apps/api/src/db/store.ts): `apps/api/src/db/store.ts`
- [Billing engine](https://github.com/brando1972/openmsp/blob/main/apps/api/src/billing/engine.ts): `apps/api/src/billing/engine.ts`
- [Agent routes](https://github.com/brando1972/openmsp/blob/main/apps/api/src/routes/agents.ts): `apps/api/src/routes/agents.ts`
- [Backup routes](https://github.com/brando1972/openmsp/blob/main/apps/api/src/routes/backups.ts): `apps/api/src/routes/backups.ts`
- [Security routes](https://github.com/brando1972/openmsp/blob/main/apps/api/src/routes/security.ts): `apps/api/src/routes/security.ts`
- [Installer routes](https://github.com/brando1972/openmsp/blob/main/apps/api/src/routes/installers.ts): `apps/api/src/routes/installers.ts`
- [MDM routes](https://github.com/brando1972/openmsp/blob/main/apps/api/src/routes/mdm.ts): `apps/api/src/routes/mdm.ts`
- [Mesh routes](https://github.com/brando1972/openmsp/blob/main/apps/api/src/routes/mesh.ts): `apps/api/src/routes/mesh.ts`
- [Network routes](https://github.com/brando1972/openmsp/blob/main/apps/api/src/routes/net.ts): `apps/api/src/routes/net.ts`
- [Ticket routes](https://github.com/brando1972/openmsp/blob/main/apps/api/src/routes/tickets.ts): `apps/api/src/routes/tickets.ts`
- [Billing routes](https://github.com/brando1972/openmsp/blob/main/apps/api/src/routes/billing.ts): `apps/api/src/routes/billing.ts`
- [WebSocket manager](https://github.com/brando1972/openmsp/blob/main/apps/api/src/ws/manager.ts): `apps/api/src/ws/manager.ts`
- [Monitoring engine](https://github.com/brando1972/openmsp/blob/main/apps/api/src/net/checkmkEngine.ts): `apps/api/src/net/checkmkEngine.ts`
- [Tunnel transport](https://github.com/brando1972/openmsp/blob/main/apps/api/src/net/tunnelWs.ts): `apps/api/src/net/tunnelWs.ts`

### Device agent

- [Native device agent](https://github.com/brando1972/openmsp/blob/main/apps/agent/cmd/agent/main.go): `apps/agent/cmd/agent/main.go`
- [Agent backup engine](https://github.com/brando1972/openmsp/blob/main/apps/agent/internal/backup/engine.go): `apps/agent/internal/backup/engine.go`
- [SOAR worker](https://github.com/brando1972/openmsp/blob/main/apps/agent/internal/security/soar_worker.go): `apps/agent/internal/security/soar_worker.go`
- [API client](https://github.com/brando1972/openmsp/blob/main/apps/agent/internal/client/client.go): `apps/agent/internal/client/client.go`

### Platform integrations

- [MeshCentral client](https://github.com/brando1972/openmsp/blob/main/apps/api/src/mesh/meshClient.ts): `apps/api/src/mesh/meshClient.ts`

### Other components

- **MSP operator**
- **Stripe**

## Connections

- MSP operator → Console workspace: uses
- Console workspace → Console state: loads state (evidence: `apps/console/src/App.tsx`)
- Console workspace → Client management: renders (evidence: `apps/console/src/App.tsx`)
- Console workspace → Backup dashboard: renders (evidence: `apps/console/src/App.tsx`)
- Console workspace → MDM console: renders (evidence: `apps/console/src/App.tsx`)
- Console workspace → Security console: renders (evidence: `apps/console/src/App.tsx`)
- Console workspace → Network map: renders (evidence: `apps/console/src/App.tsx`)
- Console workspace → PSA tickets: renders (evidence: `apps/console/src/App.tsx`)
- Console state → HTTP API: calls API
- Billing context → HTTP API: requests billing
- HTTP API → Authentication: uses middleware (evidence: `apps/api/src/server.ts`)
- HTTP API → Agent routes: routes requests (evidence: `apps/api/src/server.ts`)
- HTTP API → Backup routes: routes requests (evidence: `apps/api/src/server.ts`)
- HTTP API → Security routes: routes requests (evidence: `apps/api/src/server.ts`)
- HTTP API → Installer routes: routes requests (evidence: `apps/api/src/server.ts`)
- HTTP API → MDM routes: routes requests (evidence: `apps/api/src/server.ts`)
- HTTP API → Mesh routes: routes requests (evidence: `apps/api/src/server.ts`)
- HTTP API → Network routes: routes requests (evidence: `apps/api/src/server.ts`)
- HTTP API → Ticket routes: routes requests (evidence: `apps/api/src/server.ts`)
- HTTP API → Billing routes: routes requests (evidence: `apps/api/src/server.ts`)
- HTTP API → WebSocket manager: initializes (evidence: `apps/api/src/server.ts`)
- WebSocket manager → Tunnel transport: dispatches upgrades (evidence: `apps/api/src/ws/manager.ts`)
- Billing engine → Application store: reads and writes (evidence: `apps/api/src/billing/engine.ts`)
- Monitoring engine → Application store: reads and writes (evidence: `apps/api/src/net/checkmkEngine.ts`)
- Monitoring engine → WebSocket manager: broadcasts events (evidence: `apps/api/src/net/checkmkEngine.ts`)
- Native device agent → API client: uses client
- Native device agent → Agent backup engine: runs backups
- Native device agent → SOAR worker: runs response
- Native device agent → Agent routes: enrolls and reports
- Mesh routes → MeshCentral client: uses MeshCentral
- Billing routes → Stripe: charges payments
