Cherry VM Studio Docs on CVMS Docs

🚧 Work in progress

Mon, 01 Jan 0001 00:00:00 +0000

🚧 Work in progress

Mon, 01 Jan 0001 00:00:00 +0000

🚧 Work in progress

Installation Guide

Mon, 01 Jan 0001 00:00:00 +0000

Installation Guide#

🚧 Work in progress

WebSockets

Mon, 01 Jan 0001 00:00:00 +0000

WebSockets#

WebSockets are a crucial element of the Cherry API, enabling frontend interface integration and synchronization.

Connection#

To connect to any WebSocket endpoint, you must include your authentication token as an access_token parameter when establishing the connection. Please note that if your token expires during an active session, you will be disconnected with error code 4401.

Disconnection codes#

Below is a short guide to common disconnect codes shared by each websocket in the application.

Account system

Mon, 01 Jan 0001 00:00:00 +0000

Account System#

Introduction#

Cherry VM Studio uses its own internal account system, fully managed from the administrative web panel. The system is integrated with Apache Guacamole to provide centralized authentication across the platform.

Learn more

The platform enforces a clear separation between administrative and client accounts.

Administrators can create and manage resources, such as virtual machines, and assign them to client accounts.
Privileged administrators have extended capabilities, including managing other user accounts and modifying system-wide settings.
Clients are limited to using assigned resources: they can start, stop, and access virtual machines but cannot create or modify any system resources themselves.

Learn more

Machines

Mon, 01 Jan 0001 00:00:00 +0000

Machines#

🚧 Work in progress

Network Panel

Mon, 01 Jan 0001 00:00:00 +0000

Network Panel#

🚧 Work in progress

Mon, 01 Jan 0001 00:00:00 +0000

🚧 Work in progress