Edge Cluster Deployment: Multi-Location Case Study

This case study demonstrates deploying LarkXR in an **edge cluster** scenario where rendering nodes are geographically distributed across multiple locations, each with different network structures.

## Scenario Overview

The main node is located in **Beijing**. Rendering nodes are distributed across three locations:

| Location | Network Structure |
|---|---|
| Beijing | Main node + rendering nodes on the same LAN, with a router external IP |
| Guangzhou | Each rendering node has a direct external IP |
| Inner Mongolia | Rendering nodes on the same LAN, with a router external IP |

## Beijing: Main Node Configuration

1. Deploy the main node package following either the [Cluster Intranet Deployment Guide (Windows)](https://docs.paraverse.cc/doc/247/) or [Cluster Intranet Deployment Guide (Linux Docker)](https://docs.paraverse.cc/doc/249/).
2. Enable **Proxy Mode** by following Step 1 of the [Cluster External Network Access Guide (Windows)](https://docs.paraverse.cc/doc/248/) or [Cluster External Network Access Guide (Linux Docker)](https://docs.paraverse.cc/doc/250/).
3. If using **local application storage** (default), edge rendering nodes must pull app data from the main node. Configure the external-facing data pull endpoint in `application.properties`:
   ```
   pxy.end-point=http://<external-address>:8181
   ```
   > If using an external IP or domain, all rendering node external IPs/domains must be added to the system whitelist, otherwise app sync will fail.

### Beijing Main Node: Required Ports

Port mapping must be configured on the router.

| Protocol | Port | Purpose |
|---|---|---|
| TCP | 8181 | Frontend page (nginx) and backend interface |
| TCP | 8182 | Backend page nginx forwarding |

## Beijing: Rendering Node Configuration

1. Deploy the rendering node package following the intranet deployment guide.
2. Open `LarkXRLauncher.exe` and go to **Configure Rendering Node**. Set:
   - **Admin Server URL**: intranet address of the main node (e.g., `http://192.168.0.18:8181`)
   - **Local IP**: local intranet IP of this rendering node
   - **Preferred Public IP**: external IP (e.g., `112.6.266.11`)
3. If multiple rendering nodes share the same router, each node must use a **unique audio/video port range** to avoid conflicts. Modify the port range in the rendering node configuration accordingly.

### Beijing Rendering Nodes: Required Ports

| Node | Protocol | Port Range | Purpose |
|---|---|---|---|
| Rendering Node 1 | UDP | 10011-10020 | Audio and video |
| Rendering Node 2 | UDP | 10021-10040 | Audio and video |
| Rendering Node 3 | UDP | 10041-10060 | Audio and video |

## Guangzhou: Rendering Node Configuration

Each Guangzhou rendering node has a **direct external IP**. Open `LarkXRLauncher.exe` and go to **Configure Rendering Node**. Set:

- **Admin Server URL**: external address of the Beijing main node (e.g., `http://www.larkxr.com:8181`)
- **Local IP**: the node's external IP
- **Preferred Public IP**: the node's external IP

### Guangzhou Rendering Nodes: Required Ports

| Protocol | Port | Purpose |
|---|---|---|
| TCP | 10002 | WebSocket communication |
| UDP | 10011-10040 | Audio and video |

## Inner Mongolia: Rendering Node Configuration

Inner Mongolia rendering nodes are behind a router. Each node must use a **unique WebSocket port** to avoid conflicts. Open `LarkXRLauncher.exe` and go to **Configure Rendering Node**. Set:

- **Admin Server URL**: external address of the Beijing main node
- **Local IP**: local intranet IP of the rendering node
- **Public IP**: router external IP
- **WebSocket Port**: a unique port per node (e.g., Node 1 uses `10009`, Node 2 uses `10008`)

> When configuring router port mapping, ensure that **internal and external ports are consistent** (e.g., Node 1: external `10009` -> internal `10009`).

After modifying ports, restart the rendering node service.

### Inner Mongolia Rendering Nodes: Required Ports

| Node | Protocol | Port | Purpose |
|---|---|---|---|
| Rendering Node 1 | TCP | 10009 | WebSocket communication |
| Rendering Node 1 | UDP | 10011-10020 | Audio and video |
| Rendering Node 2 | TCP | 10008 | WebSocket communication |
| Rendering Node 2 | UDP | 10021-10040 | Audio and video |