Skip to content

Architecture Overview

Wisdoverse Nexus is a Rust-first collaboration platform organized as a monorepo. The public architecture is intentionally described from the repository state, not from future product plans.

System Shape

text
Client apps and SDKs
  apps/web
  apps/mobile
  sdk/typescript
  sdk/python
        |
        v
Gateway
  crates/nexis-gateway
  HTTP routes
  WebSocket endpoint
  metrics
  OpenAPI document
        |
        v
Domain crates
  nexis-protocol
  nexis-ai
  nexis-context
  nexis-plugin
  nexis-meeting
  nexis-doc
  nexis-task
  nexis-calendar
  nexis-memory
  nexis-skills

Core Areas

AreaCurrent repository pathsResponsibility
Gatewaycrates/nexis-gatewayHTTP routing, WebSocket upgrade, metrics, middleware, API docs
Protocolcrates/nexis-protocolShared identity, message, permission, and tenant primitives
AI integrationcrates/nexis-ai, crates/nexis-mcpProvider and MCP integration surfaces
Context and memorycrates/nexis-context, crates/nexis-memory, crates/nexis-vectorContext windows, memory structures, vector integration boundaries
Collaboration domainscrates/nexis-meeting, crates/nexis-doc, crates/nexis-task, crates/nexis-calendarMeeting, document, task, and calendar domain modules
Plugin and skillscrates/nexis-plugin, crates/nexis-skillsExtensibility and skill execution model
Appsapps/web, apps/mobileWeb and mobile clients
SDKssdk/typescript, sdk/pythonClient integration packages
Deploymentdocker-compose.yml, deploy/, docker/Local gateway stack and deployment assets

Gateway Surface

The gateway currently exposes:

EndpointPurpose
GET /healthBasic liveness response
GET /metricsPrometheus metrics
GET /openapi.jsonGateway OpenAPI document
GET /docsSwagger UI for the OpenAPI document
GET /wsWebSocket upgrade endpoint
POST /v1/roomsCreate a room
GET /v1/roomsList rooms
GET /v1/rooms/:idRead room state
DELETE /v1/rooms/:idDelete a room
POST /v1/messagesSend a message
GET/POST /v1/searchSearch messages when search service is configured

Collaboration-specific endpoints are registered under /v1/collaboration/*.

WebSocket Authentication

The preferred WebSocket authentication pattern is first-message authentication. Legacy query-token authentication is still accepted by the gateway with a deprecation warning. New clients should avoid putting tokens in URLs because URLs can be logged by infrastructure.

Local Deployment Model

The root docker-compose.yml runs the gateway with local persistent storage:

bash
docker compose up -d
curl http://localhost:8080/health

The development compose file under deploy/docker-compose.yml adds PostgreSQL, Redis, Prometheus, and Grafana for local integration work:

bash
docker compose -f deploy/docker-compose.yml up -d

Production Guidance

Production operators should treat this repository as deployable source and complete their own environment-specific hardening:

  • TLS termination and HSTS at the edge
  • Secret injection through a secrets manager
  • Explicit CORS origins
  • Database backups and restore testing
  • Metrics, logs, and alerting retention
  • CPU, memory, and file descriptor limits
  • Load tests in the target environment

See Deployment, Monitoring, and Security Overview.

Architecture Decisions

Significant design decisions are tracked in ADRs.

Source-available under the Wisdoverse Nexus Business Source License 1.1.