Init: Migrate SimpleRemoter (Since v1.3.1) to Gitea
This commit is contained in:
614
docs/AgentManual.md
Normal file
614
docs/AgentManual.md
Normal file
@@ -0,0 +1,614 @@
|
||||
# YAMA 代理商运营手册
|
||||
|
||||
> 下级授权管理与 FRP 代理配置
|
||||
|
||||
---
|
||||
|
||||
## 目标读者
|
||||
|
||||
- 有下级客户需要管理的代理商
|
||||
- 需要为下级生成授权
|
||||
- 需要提供 FRP 代理服务
|
||||
|
||||
> 基础功能请参阅[日常使用手册](UserManual.md)
|
||||
|
||||
---
|
||||
|
||||
## 第一部分:代理商角色
|
||||
|
||||
### 1. 您的角色定位
|
||||
|
||||
作为代理商,您在授权链中扮演中间角色:
|
||||
|
||||
```
|
||||
您的上级(为您提供授权)
|
||||
│
|
||||
↓
|
||||
您(代理商)
|
||||
│
|
||||
↓
|
||||
您的下级(您为他们提供授权和服务)
|
||||
```
|
||||
|
||||
**您的职责:**
|
||||
- 管理您的下级客户
|
||||
- 为下级生成和分发授权
|
||||
- 可选:为下级提供 FRP 代理服务
|
||||
- 提供技术支持和售后服务
|
||||
|
||||
### 2. 权限范围
|
||||
|
||||
您为下级授权时,受以下限制:
|
||||
|
||||
| 限制项 | 规则 |
|
||||
|--------|------|
|
||||
| 有效期 | 不超过您自己的有效期 |
|
||||
| 并发数限制 | 不超过上级为您设置的并发数限制 |
|
||||
| 功能权限 | 不超过您被授予的权限 |
|
||||
|
||||
**示例:**
|
||||
- 您的有效期到 2026-12-31
|
||||
- 您可以为下级设置最长到 2026-12-31 的有效期
|
||||
- 上级为您设置的并发数限制是 500
|
||||
- 您为下级设置的并发数限制不能超过 500
|
||||
|
||||
### 3. 收益模式参考
|
||||
|
||||
常见的代理商收益模式:
|
||||
|
||||
| 模式 | 说明 |
|
||||
|------|------|
|
||||
| 按授权收费 | 每个授权收取一次性费用 |
|
||||
| 按并发数收费 | 根据分配的并发数定价 |
|
||||
| 按服务期限收费 | 月付/季付/年付不同价格 |
|
||||
| FRP 增值服务 | 为无服务器的下级提供 FRP 代理 |
|
||||
| 技术支持服务 | 提供部署、运维支持 |
|
||||
|
||||
---
|
||||
|
||||
## 第二部分:下级管理流程
|
||||
|
||||
### 4. 发展下级的标准流程
|
||||
|
||||
```
|
||||
步骤 1:下级联系您,表达需求
|
||||
↓
|
||||
步骤 2:下级下载并运行 YAMA.exe
|
||||
↓
|
||||
步骤 3:下级发送序列号给您
|
||||
↓
|
||||
步骤 4:您评估需求,生成授权
|
||||
↓
|
||||
步骤 5:您将 *.lic 文件发送给下级
|
||||
↓
|
||||
步骤 6:下级导入授权,开始使用
|
||||
```
|
||||
|
||||
### 5. 获取下级序列号
|
||||
|
||||
#### 5.1 指导下级获取序列号
|
||||
|
||||
指导下级完成以下步骤:
|
||||
1. 下载并运行 YAMA.exe(首次运行会提示未授权,属正常现象)
|
||||
2. 点击菜单 **其他** → **申请授权**
|
||||
3. 首次会显示使用条款,确认本软件仅限合法正当使用
|
||||
4. 点击"确认"后显示序列号并复制
|
||||
|
||||
> **提示**:导入授权后,该菜单会变为 **其他** → **序列号**
|
||||
|
||||
**序列号格式:** `XXXX-XXXX-XXXX-XXXX`(16 位十六进制,分 4 组)
|
||||
|
||||
#### 5.2 序列号传递建议
|
||||
|
||||
| 方式 | 建议 |
|
||||
|------|------|
|
||||
| 微信/QQ | 直接复制文本发送 |
|
||||
| 邮件 | 主题注明"YAMA序列号" |
|
||||
| 截图 | 确保序列号完整清晰 |
|
||||
|
||||
**重要**:序列号是生成授权的必要信息,请下级准确提供。
|
||||
|
||||
### 6. 评估下级需求
|
||||
|
||||
在生成授权前,了解下级的需求:
|
||||
|
||||
| 问题 | 影响 |
|
||||
|------|------|
|
||||
| 预计受管端数量 | 决定分配的并发数 |
|
||||
| 计划使用期限 | 决定授权有效期 |
|
||||
| 有无公网服务器 | 决定是否需要分配 FRP |
|
||||
|
||||
---
|
||||
|
||||
## 第三部分:生成授权
|
||||
|
||||
### 7. 打开授权生成界面
|
||||
|
||||
点击菜单 **工具** → **口令生成**
|
||||
|
||||
### 8. 填写授权信息
|
||||
|
||||
#### 8.1 基本信息
|
||||
|
||||
| 字段 | 说明 | 示例 |
|
||||
|------|------|------|
|
||||
| 序列号 | 下级提供的设备序列号 | b40f-638f-ebc8-6d54 |
|
||||
| 备注 | 便于识别的说明 | "张三-华东区代理" |
|
||||
|
||||
**备注建议格式:** `客户名-地区/用途`
|
||||
|
||||
#### 8.2 有效期设置
|
||||
|
||||
| 字段 | 说明 |
|
||||
|------|------|
|
||||
| 起始日期 | 授权生效日期(可以是今天或将来某天) |
|
||||
| 结束日期 | 授权过期日期(不超过您的有效期) |
|
||||
|
||||
**常见期限类型:**
|
||||
|
||||
| 类型 | 期限 | 适用场景 |
|
||||
|------|------|---------|
|
||||
| 试用期 | 7-15 天 | 新客户体验 |
|
||||
| 月付 | 1 个月 | 短期需求 |
|
||||
| 季付 | 3 个月 | 一般客户 |
|
||||
| 半年付 | 6 个月 | 稳定客户 |
|
||||
| 年付 | 12 个月 | 长期合作 |
|
||||
|
||||
#### 8.3 并发数设置
|
||||
|
||||
设置下级可同时管理的受管端数量上限。
|
||||
|
||||
**规划建议:**
|
||||
- 小型客户:10-50
|
||||
- 中型客户:50-200
|
||||
- 大型客户:200+
|
||||
- 预留 10-20% 余量应对增长
|
||||
|
||||
### 9. 分配 FRP 端口
|
||||
|
||||
#### 9.1 何时需要分配 FRP
|
||||
|
||||
在以下情况为下级分配 FRP:
|
||||
- 下级没有公网服务器
|
||||
- 下级希望简化网络配置
|
||||
- 下级网络环境复杂
|
||||
|
||||
#### 9.2 分配方式
|
||||
|
||||
**自动分配(推荐):**
|
||||
1. 勾选"FRP 代理"选项
|
||||
2. 系统自动从可用端口池分配
|
||||
3. 无需手动指定端口号
|
||||
|
||||
**手动指定:**
|
||||
1. 勾选"FRP 代理"选项
|
||||
2. 取消"自动分配"
|
||||
3. 输入指定端口号
|
||||
|
||||
**注意**:手动指定需确保端口在您配置的范围内且未被占用。
|
||||
|
||||
#### 9.3 记录分配信息
|
||||
|
||||
建议维护一份分配记录表:
|
||||
|
||||
| 下级 | 序列号 | 端口 | 并发数 | 有效期 | 备注 |
|
||||
|------|-------|------|--------|--------|------|
|
||||
| 张三 | b40f-... | 20001 | 100 | 2026-12-31 | 华东区 |
|
||||
| 李四 | a12c-... | 20002 | 50 | 2026-06-30 | 试用 |
|
||||
|
||||
### 10. 生成授权
|
||||
|
||||
1. 确认所有信息无误
|
||||
2. 点击"生成"按钮
|
||||
3. 授权信息保存到本地数据库
|
||||
|
||||
### 11. 发送给下级
|
||||
|
||||
有两种方式将授权发送给下级:
|
||||
|
||||
#### 方式 A:在线发送(推荐)
|
||||
|
||||
如果下级使用您通过 **工具** → **主控生成** 分发的程序:
|
||||
|
||||
1. 下级程序已硬编码您的地址,启动后会自动连接到您
|
||||
2. 您在主机列表中可以看到已连接但未授权的下级
|
||||
3. 右键点击该主机 → **发送授权**
|
||||
4. 选择已生成的授权记录
|
||||
5. 通知下级重启程序
|
||||
|
||||
**下级重启流程(如授权包含 FRP):**
|
||||
- 第一次重启:验证授权,提示"授权成功",同时收到 FRP 配置
|
||||
- 第二次重启:应用 FRP 配置,开始使用 FRP 代理
|
||||
|
||||
**优点:** 无需传输文件,操作简便,适合大量下级管理
|
||||
|
||||
#### 方式 B:离线发送(lic 文件)
|
||||
|
||||
如果下级无法先连接到您(如网络原因):
|
||||
|
||||
1. 在授权生成界面点击"导出"按钮
|
||||
2. 生成 `*.lic` 文件(建议命名:`客户名_日期.lic`)
|
||||
3. 通过微信/QQ/邮件发送给下级
|
||||
4. 附带导入说明:
|
||||
|
||||
```
|
||||
请按以下步骤导入授权:
|
||||
1. 运行 YAMA.exe
|
||||
2. 点击菜单"工具" → "导入口令..."
|
||||
3. 选择 *.lic 文件
|
||||
4. 重启程序使授权生效
|
||||
|
||||
如有问题请联系我。
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 第四部分:FRP 代理服务
|
||||
|
||||
> 为没有公网服务器的下级提供代理服务
|
||||
|
||||
### 12. FRP 工作原理
|
||||
|
||||
当下级没有公网服务器时,可以通过您的 FRP 服务实现连接:
|
||||
|
||||
```
|
||||
下级的受管端
|
||||
│
|
||||
│ 连接
|
||||
↓
|
||||
您的 FRP 服务器(公网)
|
||||
│
|
||||
│ 转发
|
||||
↓
|
||||
下级的 YAMA 程序
|
||||
```
|
||||
|
||||
**数据流向:**
|
||||
1. 受管端连接您的服务器的指定端口(如 20001)
|
||||
2. FRP 服务将流量转发给下级的 YAMA
|
||||
3. 下级 YAMA 通过 FRP 客户端接收数据
|
||||
|
||||
### 13. 配置 FRP 服务
|
||||
|
||||
#### 13.1 系统要求
|
||||
|
||||
| 要求 | 说明 |
|
||||
|------|------|
|
||||
| 操作系统 | Windows 10 / Server 2016 或更高版本 |
|
||||
| 架构 | 必须是 64 位系统 |
|
||||
| 网络 | 服务器具有公网 IP |
|
||||
|
||||
**注意**:32 位系统或 Windows 7/Server 2012 等旧系统不支持 FRP 功能。
|
||||
|
||||
#### 13.2 打开配置界面
|
||||
|
||||
点击菜单 **扩展** → **下级FRP代理设置**
|
||||
|
||||
#### 13.3 启用服务
|
||||
|
||||
勾选 **"启用为下级提供 FRP 代理"**
|
||||
|
||||
#### 13.4 选择 FRPS 模式
|
||||
|
||||
**方式 A:本地运行 FRPS(推荐)**
|
||||
|
||||
勾选"FRPS 运行在本机"
|
||||
|
||||
| 优点 | 说明 |
|
||||
|------|------|
|
||||
| 简单 | 程序自动管理 FRPS |
|
||||
| 集成 | 无需额外部署 |
|
||||
| 便捷 | 配置自动生效 |
|
||||
|
||||
**方式 B:使用外部 FRPS**
|
||||
|
||||
如果您已有独立的 FRPS 服务器:
|
||||
1. 取消勾选"FRPS 运行在本机"
|
||||
2. 填写 FRPS 服务器地址
|
||||
3. 填写 FRPS 端口
|
||||
4. 填写认证 Token(需与 FRPS 配置一致)
|
||||
|
||||
#### 13.5 设置端口和密钥
|
||||
|
||||
| 设置项 | 说明 | 建议值 |
|
||||
|--------|------|-------|
|
||||
| FRPS 端口 | FRPS 服务监听端口 | 7000 |
|
||||
| 认证 Token | 安全密钥 | 使用复杂随机字符串 |
|
||||
|
||||
**Token 建议:** 使用 16 位以上包含字母数字的随机字符串。
|
||||
|
||||
#### 13.6 设置分配范围
|
||||
|
||||
| 设置项 | 说明 | 建议值 |
|
||||
|--------|------|-------|
|
||||
| 起始端口 | 分配给下级的最小端口 | 20000 |
|
||||
| 结束端口 | 分配给下级的最大端口 | 29999 |
|
||||
|
||||
**容量计算:** 端口范围 20000-29999 可容纳 10000 个下级。
|
||||
|
||||
### 14. 开放防火墙
|
||||
|
||||
FRP 服务需要开放以下端口:
|
||||
|
||||
| 端口 | 用途 |
|
||||
|------|------|
|
||||
| 7000(FRPS 端口) | FRP 服务监听 |
|
||||
| 20000-29999(分配范围) | 下级映射端口 |
|
||||
|
||||
#### 14.1 Windows 防火墙
|
||||
|
||||
1. 打开"Windows Defender 防火墙"
|
||||
2. 点击"高级设置"
|
||||
3. 选择"入站规则" → "新建规则"
|
||||
4. 选择"端口" → "TCP"
|
||||
5. 输入端口:`7000, 20000-29999`
|
||||
6. 选择"允许连接"
|
||||
7. 完成
|
||||
|
||||
#### 14.2 云服务器安全组
|
||||
|
||||
以阿里云/腾讯云为例:
|
||||
|
||||
1. 登录云控制台
|
||||
2. 找到安全组配置
|
||||
3. 添加入站规则:
|
||||
- 协议:TCP
|
||||
- 端口:7000
|
||||
- 端口:20000-29999
|
||||
4. 保存配置
|
||||
|
||||
### 15. 验证 FRP 服务
|
||||
|
||||
#### 15.1 检查运行状态
|
||||
|
||||
如果选择"本地运行 FRPS":
|
||||
- 状态栏应显示 FRP 服务状态
|
||||
- 可查看日志文件 `Bin/frps.log`
|
||||
|
||||
#### 15.2 测试下级连接
|
||||
|
||||
1. 为测试下级生成授权(包含 FRP)
|
||||
2. 下级导入授权
|
||||
3. 确认下级状态栏显示 FRP 连接成功
|
||||
4. 下级生成受管程序并测试
|
||||
|
||||
---
|
||||
|
||||
## 第五部分:授权管理
|
||||
|
||||
### 16. 查看已发放授权
|
||||
|
||||
点击菜单 **工具** → **授权管理**
|
||||
|
||||
授权列表显示以下信息:
|
||||
|
||||
| 列名 | 说明 |
|
||||
|------|------|
|
||||
| 序列号 | 下级设备序列号 |
|
||||
| 备注 | 自定义说明 |
|
||||
| 有效期 | 起始日期 - 结束日期 |
|
||||
| 并发数 | 分配的并发上限 |
|
||||
| FRP 端口 | 分配的 FRP 端口(如有) |
|
||||
| 状态 | 有效/过期/禁用 |
|
||||
|
||||
**筛选功能:**
|
||||
- 按状态筛选:有效/过期/全部
|
||||
- 按关键词搜索:序列号、备注
|
||||
|
||||
### 17. 授权续期
|
||||
|
||||
当下级授权即将过期时:
|
||||
|
||||
1. 在授权列表中找到目标授权
|
||||
2. 双击或点击"编辑"
|
||||
3. 修改结束日期
|
||||
4. 保存更改
|
||||
|
||||
**下级更新授权:**
|
||||
- 下级重启程序即可自动获取新的有效期(通过网络验证)
|
||||
- 通常**无需重新发送 lic 文件**
|
||||
|
||||
> **注意**:只有当下级的序列号(SN)发生变化时,才需要重新生成并发送授权文件。
|
||||
|
||||
### 18. 授权撤销
|
||||
|
||||
#### 18.1 何时需要撤销
|
||||
|
||||
- 下级未按时付费
|
||||
- 下级违反使用协议
|
||||
- 下级主动要求取消
|
||||
|
||||
#### 18.2 撤销方式
|
||||
|
||||
**方式一:禁用授权**
|
||||
1. 在授权列表选中目标
|
||||
2. 点击"禁用"
|
||||
3. 下级下次验证时授权失效
|
||||
|
||||
**方式二:删除授权**
|
||||
1. 在授权列表选中目标
|
||||
2. 点击"删除"
|
||||
3. 授权记录从数据库移除
|
||||
|
||||
#### 18.3 撤销后的影响
|
||||
|
||||
- 下级程序在下次联网验证时失效
|
||||
- 已连接的受管端保持连接直到断开
|
||||
- 下级无法生成新的受管程序
|
||||
|
||||
### 19. 端口回收
|
||||
|
||||
当下级不再使用 FRP 时:
|
||||
|
||||
1. 记录下级占用的端口号
|
||||
2. 撤销或删除该下级授权
|
||||
3. 端口自动回到可用池
|
||||
4. 可分配给新下级使用
|
||||
|
||||
---
|
||||
|
||||
## 第六部分:日常运维
|
||||
|
||||
### 20. 监控下级状态
|
||||
|
||||
#### 20.1 定期检查
|
||||
|
||||
建议定期检查:
|
||||
- 下级授权到期情况
|
||||
- FRP 端口使用率
|
||||
- 异常连接情况
|
||||
|
||||
#### 20.2 日志查看
|
||||
|
||||
FRP 相关日志位置:
|
||||
- `Bin/frps.log` - FRPS 服务日志
|
||||
- 包含下级连接/断开记录
|
||||
|
||||
### 21. 常见问题处理
|
||||
|
||||
| 下级反馈 | 可能原因 | 处理方法 |
|
||||
|---------|---------|---------|
|
||||
| 无法导入授权 | 序列号不匹配 | 确认序列号,重新生成 |
|
||||
| 授权显示无效 | 有效期问题 | 检查日期设置 |
|
||||
| FRP 连接失败 | 防火墙/网络 | 检查端口开放 |
|
||||
| 授权已过期 | 到期未续费 | 续期后下级重启程序即可 |
|
||||
| 并发数超限 | 超过分配限制 | 升级授权或释放连接 |
|
||||
| 受管端连不上 | 地址端口错误 | 检查下级设置 |
|
||||
|
||||
### 22. 备份与恢复
|
||||
|
||||
#### 22.1 定期备份
|
||||
|
||||
建议备份以下数据:
|
||||
|
||||
| 数据 | 位置 | 说明 |
|
||||
|------|------|------|
|
||||
| 配置信息 | 注册表 `HKCU\Software\YAMA` | 可导出为 .reg 文件 |
|
||||
| 授权数据库 | `%APPDATA%\YAMA\licenses.db` | SQLite 数据库 |
|
||||
|
||||
**备份频率:** 每周或每次重要操作后
|
||||
|
||||
**注册表导出方法:**
|
||||
1. 运行 `regedit`
|
||||
2. 导航到 `HKEY_CURRENT_USER\Software\YAMA`
|
||||
3. 右键 → 导出 → 保存为 .reg 文件
|
||||
|
||||
#### 22.2 恢复方法
|
||||
|
||||
1. 停止 YAMA 程序
|
||||
2. 双击 .reg 文件导入注册表配置
|
||||
3. 将 `licenses.db` 复制到 `%APPDATA%\YAMA\`
|
||||
4. 重新启动程序
|
||||
5. 验证数据恢复正确
|
||||
|
||||
---
|
||||
|
||||
## 第七部分:进阶功能
|
||||
|
||||
### 23. 下级成为代理商
|
||||
|
||||
如果您的授权支持,您的下级也可以发展自己的下级:
|
||||
|
||||
```
|
||||
您(一级代理)
|
||||
│
|
||||
└── 下级 A(二级代理)
|
||||
│
|
||||
├── A 的下级 1
|
||||
└── A 的下级 2
|
||||
```
|
||||
|
||||
**前提条件:**
|
||||
- 您的授权支持多级
|
||||
- 为下级开通代理权限
|
||||
|
||||
### 24. 批量管理
|
||||
|
||||
#### 24.1 批量生成
|
||||
|
||||
如需为多个下级生成授权:
|
||||
1. 收集所有序列号
|
||||
2. 逐个生成授权
|
||||
3. 批量导出文件
|
||||
4. 分别发送
|
||||
|
||||
#### 24.2 批量续期
|
||||
|
||||
对于到期的授权:
|
||||
1. 筛选即将过期的授权
|
||||
2. 逐个编辑延长有效期
|
||||
3. 通知下级重启程序以更新授权
|
||||
|
||||
> 续期无需重新发送 lic 文件,下级重启即可通过网络获取新的有效期。
|
||||
|
||||
### 25. 数据统计
|
||||
|
||||
建议自行记录统计以下数据:
|
||||
|
||||
| 统计项 | 用途 |
|
||||
|--------|------|
|
||||
| 下级数量 | 业务规模 |
|
||||
| 端口使用率 | 资源规划 |
|
||||
| 到期预警 | 续费提醒 |
|
||||
| 收入记录 | 财务管理 |
|
||||
|
||||
---
|
||||
|
||||
## 附录
|
||||
|
||||
### A. 定价建议参考
|
||||
|
||||
定价时可考虑以下因素:
|
||||
|
||||
| 因素 | 说明 |
|
||||
|------|------|
|
||||
| 并发数档位 | 10/50/100/500/不限 |
|
||||
| 有效期 | 月/季/半年/年 |
|
||||
| FRP 服务 | 是否包含、带宽限制 |
|
||||
| 技术支持 | 基础/高级/VIP |
|
||||
|
||||
### B. 常用话术模板
|
||||
|
||||
**获取序列号:**
|
||||
```
|
||||
请运行 YAMA.exe,点击菜单"其他" → "申请授权"。
|
||||
首次需确认使用条款,之后即可查看序列号。
|
||||
将序列号发送给我即可。
|
||||
```
|
||||
|
||||
**发送授权文件:**
|
||||
```
|
||||
附件是您的授权文件,请按以下步骤导入:
|
||||
1. 运行 YAMA.exe
|
||||
2. 点击菜单"工具" → "导入口令..."
|
||||
3. 选择附件中的 *.lic 文件
|
||||
4. 关闭并重启程序
|
||||
5. 检查状态栏确认授权生效
|
||||
|
||||
如有问题随时联系我。
|
||||
```
|
||||
|
||||
**续期通知:**
|
||||
```
|
||||
您的 YAMA 授权将于 [日期] 到期。
|
||||
如需续期,请在到期前联系我。
|
||||
续期后重启程序即可自动更新,无需重新导入文件。
|
||||
```
|
||||
|
||||
### C. 技术支持
|
||||
|
||||
如遇到本手册未涵盖的问题:
|
||||
|
||||
| 渠道 | 联系方式 |
|
||||
|------|---------|
|
||||
| QQ | 962914132 |
|
||||
| Telegram | [@doge_grandfather](https://t.me/doge_grandfather) |
|
||||
|
||||
---
|
||||
|
||||
## 相关文档
|
||||
|
||||
- [快速部署指南](QuickStart.md) - 首次部署
|
||||
- [多级网络搭建指南](NetworkSetup.md) - 网络架构详解
|
||||
- [日常使用手册](UserManual.md) - 远程管理功能
|
||||
- [定制化开发指南](CustomizationGuide.md) - 二次开发(技术型客户)
|
||||
Reference in New Issue
Block a user