MeshCentral Agent

Cross-platform endpoint agent for remote management, automation, and secure connectivity in the OpenFrame ecosystem.

• Overview
• Quick Start
• Architecture
• Security

MeshCentral is a powerful open-source remote management and monitoring solution that provides secure, web-based access to computers and devices across networks. Originally developed by Ylian Saint-Hilaire, MeshCentral offers comprehensive remote desktop, terminal access, file management, and device control capabilities.

• Remote Desktop & Terminal: Full graphical desktop control and command-line access
• File Management: Upload, download, and manage files on remote devices
• Hardware Monitoring: Track CPU, memory, disk usage, and system health
• Multi-Platform Support: Windows, macOS, Linux, and more
• Secure Communication: End-to-end encryption with TLS 1.3
• Web-Based Interface: No client software required - manage from any browser
• Intel AMT Support: Hardware-level management for compatible devices

In OpenFrame, the MeshCentral agent is seamlessly integrated to provide:

• Unified device management through OpenFrame UI
• Automated agent deployment and configuration
• Centralized authentication via JWT tokens
• Real-time monitoring and alerting through Kafka and Pinot
• Plugin-based extensibility for custom automation

• GitHub Repository: github.com/Ylianst/MeshCentral

• Remote management of endpoints (Windows, macOS, Linux)
• Integrated installation through OpenFrame UI - no manual setup required
• Secure integration with OpenFrame Gateway
• JWT-based authentication and enrollment secrets
• Sandbox model for plugins and scripts
• Auto-update support with signed binaries
• Extensible for automation and monitoring

MeshAgent runs on endpoints and connects securely to OpenFrame Gateway:

flowchart LR
    subgraph OpenFrame Frontend
        OUI[Openframe UI / AI agent]
    end
    
    OUI -- Remote Control --> G[OpenFrame Gateway]
    
    subgraph OpenFrame Backend
        G -- Remote Control --> API[(MeshCentral Service API)]
        API --> DB[(DB)]
        DB --> S[Stream]
        S --> K[(Kafka)]
        K --> C[(Cassandra)]
        K --> P[(Pinot Analytics)]
        API <-- Connect to device / Remote Control --> G
    end
    
    G <-- Connect to device / Remote Control --> FA[MeshCentral Agent]
    

    style OUI fill:#FFC109,stroke:#1A1A1A,color:#FAFAFA
    style G fill:#666666,stroke:#1A1A1A,color:#FAFAFA

No manual installation required! The MeshCentral agent is automatically installed and configured when you deploy it through the OpenFrame UI.

Requirements:

• OpenFrame instance running with MeshCentral service enabled
• Access to OpenFrame UI
• Supported operating system on target endpoints:
  • Linux: Ubuntu, Debian, CentOS, RHEL, Fedora
  • macOS: 10.14+ (Mojave and later)
  • Windows: Windows 7, Windows 10, Windows 11, Windows Server 2016+

1. Log in to OpenFrame UI

2. Navigate to the Devices tab

   • Click on "Devices" in the left sidebar
   • Click "Add Device" or "Enroll New Device" button

3. Get the installation link

   • OpenFrame will generate a unique enrollment link/script for your device
   • This link contains:
     • MeshCentral agent installer
     • Pre-configured connection settings (Gateway URL, enrollment token)
     • Auto-configuration for OpenFrame integration

4. Install the agent on your endpoint

   For Linux/macOS:

   curl -L https://your-openframe-instance/api/devices/enroll/<enrollment-token> | sudo bash

   For Windows (PowerShell as Administrator):

   Invoke-WebRequest -Uri "https://your-openframe-instance/api/devices/enroll/<enrollment-token>" -UseBasicParsing | Invoke-Expression

5. Verify installation

   • The device should appear in the OpenFrame Devices list within 1-2 minutes
   • Status will change from "Pending" to "Online" once connected
   • You can now manage the device remotely through OpenFrame UI

The installation script automatically:

• Downloads the appropriate MeshCentral agent for your OS
• Configures the agent to connect to your OpenFrame Gateway
• Sets up JWT-based authentication
• Registers the device in OpenFrame
• Starts the agent service
• Enables auto-update functionality

• TLS 1.2 enforced for all transport
• JWT authentication via OpenFrame Gateway
• Enrollment secrets or pre-shared keys supported
• Sandbox model for plugins and scripts
• Auto-update support with signed binaries

Found a vulnerability? Email [email protected] instead of opening a public issue.

This project is licensed under the Flamingo Unified License v1.0 (LICENSE.md).