README.md

MeshCentral Documentation

Welcome to the documentation for MeshCentral — an open-source, web-based remote device management platform, enhanced with OpenFrame multi-tenant support and AI-driven MSP automation by Flamingo.

---

📚 Table of Contents

• Getting Started
• Development
• Reference Architecture
• Architecture Diagrams
• Quick Links

---

🚀 Getting Started

New to MeshCentral? Start here:

• Introduction — What MeshCentral is, key features, and the OpenFrame integration
• Prerequisites — System requirements, supported OS, ports, and database options
• Quick Start Guide — Install and launch MeshCentral in under 5 minutes
• First Steps — Configure your server, enroll devices, and explore core features

---

🛠 Development

Resources for contributors and developers extending MeshCentral:

• Development Overview — Technology stack, repository structure, and documentation index
• Environment Setup — IDE configuration, VS Code settings, and debug launch config
• Local Development Guide — Clone, install, run locally, debug, and nodemon workflow
• Architecture Overview — System design, component map, agent communication flow, and design decisions
• Security Guidelines — TLS, MFA, ACL bitmasks, crypto, secrets management, and security checklist
• Testing Guide — Running the diagnostic test suite, writing new tests, integration testing
• Contributing Guidelines — Code style, branch naming, commit format, PR process, and review checklist

---

📖 Reference Architecture

Auto-generated technical reference documentation for all major subsystems:

Remote Desktop Stack

• RFB and Display — noVNC RFB protocol engine and HTML5 Canvas renderer
• Decoders — Framebuffer decoding (Raw, Tight, ZRLE, JPEG, Hextile, etc.)
• Compression — Zlib deflate/inflate via pako
• Crypto Components — AES-EAX, DES, RSA, Diffie-Hellman, LegacyCrypto
• Input Handlers — Keyboard normalization and gesture handling
• Websock — Buffered WebSocket abstraction layer
• Utility — Cursor management and event abstraction

Terminal Stack

• Xterm — Xterm.js terminal engine (ANSI/VT100, addons, rendering)
• Xterm Addon Image — Inline image rendering (SIXEL, OSC 1337)

UI Layer

• Bootstrap Components — Modal, Dropdown, Tooltip, Tabs, and UI primitives
• UI Components — ModernCard, ModernModal, IconUploadComponent
• Charts — Dashboard and analytics charting
• Marked — Markdown rendering pipeline
• Localization — i18n DOM translation engine

RDP Protocol

• Cliprdr — RDP clipboard virtual channel (format negotiation, PDU handling)

---

🗂 Architecture Diagrams

Visual Mermaid diagrams for all subsystems are available in:

docs/diagrams/architecture/

Key diagrams include:

• docs/diagrams/architecture/README.mmd — Top-level architecture overview
• docs/diagrams/architecture/xterm.mmd — Xterm terminal architecture
• docs/diagrams/architecture/rfb-and-display.mmd — RFB and display pipeline
• docs/diagrams/architecture/charts.mmd — Charts module structure
• docs/diagrams/architecture/crypto-components.mmd — Crypto layer
• docs/diagrams/architecture/websock.mmd — WebSocket abstraction
• docs/diagrams/architecture/cliprdr.mmd — RDP clipboard virtual channel
• docs/diagrams/architecture/bootstrap-components.mmd — Bootstrap UI components
• docs/diagrams/architecture/decoders.mmd — Framebuffer decoder pipeline
• docs/diagrams/architecture/compression.mmd — Compression module
• docs/diagrams/architecture/localization.mmd — Localization system
• docs/diagrams/architecture/input-handlers.mmd — Input handling layer

---

🔗 Quick Links

• Project README — Main project overview and quick start
• Contributing Guidelines — How to contribute
• OpenMSP Community (Slack) — Questions, discussions, and support
• Join Slack — Community invite link
• Flamingo Platform — AI-powered MSP platform
• OpenFrame — Unified AI-driven MSP interface
• GitHub Repository — Source code

---

Documentation generated by 🦩 Flamingo AI Technical Writer