How bigbluebutton/greenlight works
Main System Components
a. Frontend Layer:
• React-based SPA (located in /app/javascript)
• Key modules:
• User Management
• Room Management
• Recording Management
• Admin Panel
• Authentication System
b. Backend Layer:
• Ruby on Rails API (located in /app/controllers/api/v1)
• Key services:
• BigBlueButton Integration Service
• User Management Service
• Recording Management Service
• Meeting Management Service
c. Data Layer:
• Database (PostgreSQL based on config/database.yml)
• Active Storage for file handling
• External Storage for recordings
d. External Services:
• BigBlueButton Server
• Email Service
• Storage Service
Component Relationships
Client Layer → API Layer → Service Layer → Data Layer
• ↓ ↓
• External Services BigBlueButton Server
Detailed Component Breakdown
• Blue: Frontend components
• Green: Backend API endpoints
• Yellow: Services
• Red: External systems
• Purple: Data stores
Key Workflows to Highlight
Critical paths:
• User Authentication Flow
• Room Creation and Management
• Meeting Start/Join Flow
• Recording Management Flow
• Admin Management Flow
Specific Implementation Details
Technical elements:
• WebSocket connections (Action Cable)
• API Routes structure
• Service-based architecture
• Multi-tenant support
• Role-based access control
Architectural Patterns to Emphasize
Patterns:
• MVC Architecture (Backend)
• Component-based Architecture (Frontend)
• Service-oriented Architecture
• RESTful API design
• Event-driven architecture (WebSocket)
Security Layer
Security components:
• Authentication system
• Authorization (Role Permissions)
• API security
• Session management
Integration Points
Clearly mark:
• BigBlueButton API integration
• Storage service integration
• Email service integration
• External authentication providers
Key Considerations:
• Technical details but avoid overwhelming complexity
• Use clear labeling and consistent notation
• Both synchronous and asynchronous communication paths
• Scalability points and potential bottlenecks
This system design should reflect Greenlight's nature as a modern web application that serves as a management interface for BigBlueButton, emphasizing its role in handling user management, room coordination, and recording management while integrating with external services.