使用说明

## 应用场景
针对LarkXR部署，由于缺乏公网IP和端口映射能力，我们特别设计了一套高效的端口转发解决方案，以实现便捷的内网穿透功能。
要求：管理节点能够访问互联网、larkXR升级到V3.3.2.5.
## 使用方法
**1. 创建转发代理服务。**
访问开发者平台 https://www.pingxingyun.com/console/#/ 以创建转发代理服务。
首先，您需要添加一个转发代理的Key，这需要您设定一个Key名称，通常以项目名称作为标识。
完成设置后，系统将生成内网穿透所需的clientId和clientKey信息。
**2. 创建转发端口**
在转发代理服务条目中，点击“添加端口”来创建转发端口，您需要指定内网地址。
例如，如果您在内网中通过  http://192.168.0.28:8181  访问服务，
那么在配置中只需填写 192.168.0.28:8181。并提供相应的备注信息。
配置完成后，系统将分配一个外网访问地址，例如  https://turn.pingxingyun.com:20005
后续将LarkXR配置好之后，互联网用户就可以使用该网址来访问您的内网服务。
**3. 配置LarkXR 代理转发Server**
请将获得的clientKey信息配置到您内网部署的LarkXR管理节点 larkxr-center/application.properties中，注意LarkXR的版本需要升级到3.3.2.5及以上版本。
配置如下：
```yaml
#使用NAT转发解决无公网IP问题时开启
pxy.nat-proxy.enable=true #设置为true
#LarkXR管理节点作为NAT客户端模式
#Nat Servre Ip或域名
pxy.nat-proxy.client-mode.server-host=turn.pingxingyun.com #固定地址
pxy.nat-proxy.client-mode.server-port=20001 #此处信息无需修改
#NatServer提供的clientKey
pxy.nat-proxy.client-mode.client-key={{上述申请转发代理信息返回的clientKey}}
```
**4. 配置LarkXR 渲染服务器 ICE Server**
在 larkxr-render/application.properties 文件中增加以下配置：
```yaml
pxy.ice.server.uri=turn:turn.pingxingyun.com:3478    // TURN 服务器地址:端口 此处无需修改
pxy.ice.server.username={{上述申请转发代理信息返回的clientId}}
pxy.ice.server.password={{上述申请转发代理信息返回的clientKey}}
```
**5. 互联网访问LarkXR**
使用第二步骤中，生成出的外网访问地址，例如  https://turn.pingxingyun.com:20005 ，并可以正确访问应用。

## 收费规则
1. **系统端口占用计费**：一旦创建转发代理端口，将从创建时刻起按分钟计费，这类似于阿里云的弹性IP服务计费模式。 系统将在夜间自动进行一次计费分割。或者结束服务时记一次费用。**目前免费开放使用**。
2. **按量计费**：当您将转发代理端口配置到LarkXR中，并开始访问页面时，我们将根据实际使用时长进行计费。这包括浏览应用列表和进入应用的操作。计费单价会根据您的系统支持的总并发成正比增加。系统将在夜间自动进行一次计费分割。或者结束服务时记一次费用。

## 欠费规则
1. 欠费后停用clientKey，服务不可用。
充值后，激活clientKey，服务立即恢复
2. 欠费7天后删除clientKey，删除旗下的端口映射数据。服务不可用。
充值后，服务依旧不可用。若想继续使用，需要重新申请