Cluster External Network Access Guide (Linux Docker)

After completing the cluster intranet deployment on Linux Docker, configure external network access. Two modes are available: **Direct Connection Mode** and **Proxy Mode**.

For cluster deployments, **Proxy Mode is strongly recommended** because not all machines in the cluster may have public IP addresses. [Learn more about Direct Connection vs. Proxy Mode](https://www.pingxingyun.com/contribute/detail?topicId=10105&categoryId=3)

## Proxy Mode

In Proxy Mode, external traffic is relayed through the management node. Rendering nodes do not need individual public IPs or open WebSocket ports.

### Configuration Steps

1. **Enable WebSocket proxy on the management node** - Open the file `larkxr-center-docker/admin/application.yaml`. Search for the keyword `proxy` and set `enable` to `true`.

After saving, restart the admin Docker service:
   ```
   sh stop.sh
   sh start.sh
   ```

![Management node YAML config - proxy enabled](https://docs.pingxingyun.com/media/202503/0d4d1d603ecb4b258f3c4011067576098621.png)

2. **Set the preferred public IP on the rendering node** - Open the file `larkxr-render-docker/application.properties`. Search for the keyword `pxy.host.prefer-public-ip` and set it to the external IP address of the rendering server.

After saving, restart the render Docker service:
   ```
   sh stop.sh
   sh start.sh
   ```

## Required Ports

| Node | Protocol | Port | Requirement | Purpose |
|---|---|---|---|---|
| Management Node | TCP | 8181 | **Required** | Frontend page (nginx) and backend interface |
| Management Node | TCP | 8182 | Not required | Backend page nginx forwarding |
| Rendering Node | UDP | 10011-10040 | **Required** | Audio and video streaming (one port per concurrency) |

## Direct Connection Mode

If the rendering server has a public IP address, Direct Connection Mode can also be used. Note that for HTTPS/WSS access, the rendering node must be configured with an SSL certificate.

For Direct Connection Mode, the following additional port must be opened on the rendering node:

| Node | Protocol | Port | Requirement | Purpose |
|---|---|---|---|---|
| Rendering Node | TCP | 10002 | **Required** | WebSocket communication |