MAC -- MBM AI Cloud Logo

User Guide

  • 1. Getting Started
    • 1.1. System Requirements
    • 1.2. Installation
      • 1.2.1. Step 1: Clone the Repository
      • 1.2.2. Step 2: Configure Environment
      • 1.2.3. Step 3: Start the Platform
      • 1.2.4. Step 4: Open in Browser
      • 1.2.5. Step 5: First Login
    • 1.3. Building the MBM Book Workspace Image
    • 1.4. Stopping the Platform
  • 2. Authentication
    • 2.1. User Roles
    • 2.2. Account Verification (First-Time Sign-Up)
    • 2.3. Login Process
    • 2.4. Multi-Language Support
    • 2.5. Password Security
    • 2.6. API Key Authentication
  • 3. Platform Features
    • 3.1. AI Chat
    • 3.2. MBM Book (Cloud IDE & Notebooks)
    • 3.3. RAG (Document-Aware AI Chat)
    • 3.4. Doubts Forum (Q&A)
    • 3.5. File Sharing
    • 3.6. Voice Chat (STT + TTS)
    • 3.7. Multilingual Interface
    • 3.8. Theme System
    • 3.9. Progressive Web App (PWA)
  • 4. Student Guide
    • 4.1. Logging In
    • 4.2. Dashboard
    • 4.3. Using AI Chat
    • 4.4. Using MBM Book (Notebooks)
    • 4.5. Using the Doubts Forum
    • 4.6. Downloading Shared Files
    • 4.7. Changing Settings
    • 4.8. Installing as PWA
  • 5. Faculty Guide
    • 5.1. Faculty-Specific Features
    • 5.2. Uploading Shared Files
    • 5.3. AI Chat for Teaching
  • 6. Administrator Guide
    • 6.1. Admin Dashboard
    • 6.2. Admin Panel
      • 6.2.1. User Management
      • 6.2.2. Registry Management
      • 6.2.3. Feature Flags
      • 6.2.4. Quota Management
      • 6.2.5. Guardrails
      • 6.2.6. Audit Log
    • 6.3. Cluster Management
    • 6.4. Hardware Monitoring
    • 6.5. Network Tools
    • 6.6. Academic Structure
    • 6.7. System Configuration
    • 6.8. First-Boot Setup

Technical Reference

  • 1. Architecture
    • 1.1. Technology Stack
    • 1.2. Docker Services
    • 1.3. Project Structure
    • 1.4. Database Schema
    • 1.5. Nginx Routing
    • 1.6. Security Architecture
  • 2. API Reference
    • 2.1. Authentication Endpoints
      • 2.1.1. Admin User Endpoints
      • 2.1.2. Registry Endpoints
    • 2.2. AI Query Endpoints
    • 2.3. RAG Endpoints
    • 2.4. Notebook Endpoints
      • 2.4.1. WebSocket Protocol (Notebooks)
    • 2.5. Additional Endpoints
    • 2.6. Interactive API Documentation
  • 3. Deployment
    • 3.1. Production Deployment
      • 3.1.1. Step 1: Environment Configuration
      • 3.1.2. Step 2: Start All Services
      • 3.1.3. Step 3: Run Database Migrations
      • 3.1.4. Step 4: Verify Health
    • 3.2. Worker Node Setup (Multi-PC Cluster)
    • 3.3. Windows Installer
    • 3.4. Docker Commands Reference
    • 3.5. HTTPS Configuration
    • 3.6. Backup and Recovery
  • 4. Configuration
    • 4.1. Core Settings
    • 4.2. Database Configuration
    • 4.3. Authentication Settings
    • 4.4. LLM Inference Settings
    • 4.5. External Services
    • 4.6. Rate Limiting
    • 4.7. Cluster Settings
    • 4.8. CORS Settings
    • 4.9. GPU Configuration

Appendices

  • Frequently Asked Questions
    • General
    • Authentication
    • AI Chat
    • MBM Book
    • Troubleshooting
  • Changelog
    • v2.0.0 – 2026-04-29
      • Added
      • Changed
    • v1.0.0 – 2026-04-26
      • Added
  • License
    • MBM Open License
      • Terms and Conditions
      • Spirit of This License
MAC -- MBM AI Cloud
  • Search

© Copyright 2026, MBM University (Mugneeram Bangur Memorial University), Jodhpur.

Built with Sphinx using a theme provided by Read the Docs.