Virtufin WebSocket Manager Documentation

Welcome to the Virtufin WebSocket Manager documentation. This service provides WebSocket connection management with both REST APIs and gRPC services.

Quick Start

Default Port Configuration

• HTTP/REST APIs: Port 5001 (supports HTTP/1.1 and HTTP/2)
• gRPC Services: Port 5002 (HTTP/2 plaintext, no TLS required)

Basic Usage

# Start with default ports
dotnet run --project src/Virtufin.WebSocketManager

# Customize ports
dotnet run --project src/Virtufin.WebSocketManager -- --http-port 8080 --grpc-port 8081

Documentation Sections

• Getting Started - Basic setup and configuration
• API Reference - Complete API documentation
• Migration Guide - Port separation migration guide
• Deployment - Container and cloud deployment

Key Features

• Dual Port Architecture: Separate ports for HTTP/REST and gRPC services
• Plaintext HTTP/2: gRPC without TLS certificate requirements
• Dapr Integration: Built-in pub/sub and state management
• Distributed Storage: WebSocket connections stored in Dapr state store
• Health Checking: Built-in health checks for monitoring

Getting Help

• Review the migration guide for port configuration changes
• Check the README for comprehensive documentation
• Contact the development team for specific issues