Simple Cluster Version: Package Structure & Deployment Overview

The LarkXR Simple Cluster Edition requires a minimum of two servers to deploy. Download the package from [Paraverse Dev Center](https://paraverse.cc/larkxr-resource/) and extract it. The package contains platform-specific directories for the management node (`larkxr-center-xx`) and the rendering node (`larkxr-render-xx`).

![LarkXR Simple Cluster package file structure](https://docs.paraverse.cc/media/202504/71f2eb17f6a64986ae21b3719521a8e11530.png)

## Minimum Deployment Requirements

A minimum of two servers are needed:

- **Management Node** — Can be a non-GPU server. Supports Windows, Linux, or Ubuntu Docker. Deploy the `larkxr-center-xx` package. If using Linux, the base environment must be set up manually.
- **GPU Rendering Node** — Supports Windows or Ubuntu. Deploy the `larkxr-render-xx` package.

Once the minimum cluster is running, additional GPU nodes can be dynamically added by deploying more `larkxr-render-xx` packages.

## larkxr-center-windows Directory

| Folder / File | Description |
|---|---|
| `admin` | Management service |
| `appli` | Default storage folder for applications |
| `JDK` | Java runtime environment |
| `mysql` | Database folder for data storage |
| `nginx` | Reverse proxy and static page mapping |
| `redis` | Caching service |
| `Tools` | Toolkits loaded at program startup |
| `application.properties` | Main configuration file |
| `LarkXRLauncher.exe` | Startup manager |
| `other` | Environment dependencies for the startup manager |

## larkxr-center-linux Directory

| Folder / File | Description |
|---|---|
| `admin` | Management service |
| `appli` | Default storage folder for applications |
| `native` | Environment dependency library |
| `nginx` | Reverse proxy and static page mapping |
| `Readme.txt` | **Important:** Follow the steps in this file to set up the required infrastructure |

## larkxr-center-ubuntu-docker Directory

| Folder / File | Description |
|---|---|
| `admin` | Management service |
| `appli` | Default storage folder for applications |
| `mysql` | Database folder for data storage |
| `nginx` | Reverse proxy and static page mapping |
| `redis` | Caching service |
| `docker-compose.yml` | Docker configuration file |
| `start.sh` | Script to start all services |
| `stop.sh` | Script to stop all services |

## larkxr-render-windows Directory

| Folder / File | Description |
|---|---|
| `AgentServer` | Synchronization and proxy service; handles node registration and communication with the master node |
| `appli` | Default storage folder for applications |
| `JDK` | Java runtime environment |
| `lib` | Third-party library files |
| `RenderServer` | Core rendering service |
| `ssl-cert` | SSL certificate folder for HTTPS direct-connection mode |
| `Tools` | Toolkits loaded at program startup |
| `application.properties` | Main configuration file |
| `LarkXRLauncher.exe` | Startup manager |

## larkxr-render-ubuntu Directory

| Folder / File | Description |
|---|---|
| `agentServer` | Synchronization and proxy service |
| `native` | Environment dependency library |
| `renderserver` | Core rendering service |
| `Tools` | Toolkits loaded at program startup |
| `application.properties` | Main configuration file |
| `Readme.txt` | **Important:** Follow the steps in this file to set up the required infrastructure |