[update] 添加文档

2026-02-04 15:05:54 +08:00 · 2025-08-11 16:44:48 +08:00
parent 0aaf8a47ec
commit fc05d9a09b
5 changed files with 2363 additions and 0 deletions
--- a/使用文档.md
+++ b/使用文档.md
@@ -0,0 +1,247 @@
+# Wu-Lazy-Cloud-Network 使用文档
+
+## 🚀 快速开始
+
+### 1. 环境准备
+
+- **Java**: JDK 13+ (推荐 JDK 24)
+- **内存**: 最小 512MB
+- **网络**: 服务端需要公网 IP
+
+### 2. Docker 快速部署
+
+#### 启动服务端
+```bash
+docker run -d -it -p 6001:6001 -p 7001:7001 -p 8001:8001 -p 9001:9001 \
+  --name wlcn-server \
+  registry.cn-hangzhou.aliyuncs.com/wu-lazy/wu-lazy-cloud-heartbeat-server:1.3.1-JDK24
+```
+
+#### 启动客户端
+```bash
+docker run -d -it --privileged -p 6004:6004 \
+  --name wlcn-client \
+  --restart=always \
+  -e spring.lazy.netty.client.inet-host=YOUR_SERVER_IP \
+  -e spring.lazy.netty.client.inet-port=7001 \
+  -e spring.lazy.netty.client.client-id="your-client-id" \
+  registry.cn-hangzhou.aliyuncs.com/wu-lazy/wu-lazy-cloud-heartbeat-client-start:1.3.1-JDK24
+```
+
+### 3. 访问管理界面
+
+- **服务端管理**: http://127.0.0.1:6001/netty-server-ui/index.html
+- **客户端管理**: http://127.0.0.1:6004/netty-client-local-ui/index.html
+
+**默认登录信息**:
+- 用户名: `admin`
+- 密码: `admin`
+
+## 📋 功能使用
+
+### 内网穿透
+
+#### 服务端渗透客户端（内网穿透）
+
+1. **配置端口池**
+   - 进入服务端管理界面
+   - 找到"服务端渗透端口池管理"
+   - 添加需要开放的端口
+
+2. **配置客户端映射**
+   - 找到"服务端渗透客户端映射"
+   - 设置访客端口 → 客户端真实端口
+   - 例如: 19080 → 18080
+
+3. **访问测试**
+   - 通过 `http://服务端IP:19080` 访问客户端本地 18080 端口
+
+#### 客户端渗透服务端
+
+1. **配置客户端端口池**
+   - 进入客户端管理界面
+   - 找到"客户端渗透端口池管理"
+   - 添加本地端口
+
+2. **配置渗透映射**
+   - 找到"客户端渗透服务端映射"
+   - 设置本地端口 → 远程端口
+   - 例如: 13306 → 3306
+
+### 代理功能
+
+#### HTTP 代理
+
+**服务端代理**:
+- 地址: `127.0.0.1:8001`
+- 用途: 通过服务端访问网络
+
+**客户端代理**:
+- 地址: `127.0.0.1:8002`
+- 用途: 通过客户端访问网络
+
+#### SOCKS 代理
+
+**服务端代理**:
+- 地址: `127.0.0.1:9001`
+- 协议: SOCKS5
+
+**客户端代理**:
+- 地址: `127.0.0.1:9002`
+- 协议: SOCKS5
+
+### 路由管理
+
+#### 虚拟路由
+
+1. **创建虚拟 IP**
+   - 在路由管理界面创建虚拟 IP
+   - 配置代理目标 IP 和端口
+
+2. **使用虚拟路由**
+   - 系统自动将虚拟 IP 流量代理到目标地址
+
+## 🔧 常用配置
+
+### 服务端配置
+
+```yaml
+spring:
+  lazy:
+    netty:
+      server:
+        mode: standalone  # standalone/cluster
+        node-id: default
+        node-host: 127.0.0.1
+        node-port: 7001
+        enable-flow-control: true
+        enable-token-verification: false
+```
+
+### 客户端配置
+
+```yaml
+spring:
+  lazy:
+    netty:
+      client:
+        client-id: your-client-id
+        inet-host: 127.0.0.1
+        inet-port: 7001
+        enable: true
+```
+
+### 代理配置
+
+```yaml
+spring:
+  lazy:
+    netty:
+      protocol:
+        proxy:
+          authentication: true
+          enable-proxy-log: false
+          socket-protocol-proxy:
+            port: 9001
+          http-protocol-proxy:
+            port: 8001
+```
+
+## 📊 监控功能
+
+### 流量监控
+
+- **实时流量**: 查看每个客户端的实时流量
+- **流量统计**: 按日统计流量使用情况
+- **端口监控**: 监控各端口的使用情况
+
+### 报表功能
+
+- **日流量报表**: 查看每日流量统计
+- **客户端排行**: 按流量使用量排行
+- **端口分析**: 分析端口使用情况
+
+## 🐛 常见问题
+
+### 1. 客户端连接失败
+
+**检查项**:
+- 服务端 IP 和端口是否正确
+- 网络连接是否正常
+- 防火墙是否阻止连接
+
+**解决方案**:
+```bash
+# 检查网络连接
+ping YOUR_SERVER_IP
+
+# 检查端口是否开放
+telnet YOUR_SERVER_IP 7001
+
+# 查看客户端日志
+docker logs wlcn-client
+```
+
+### 2. 内网穿透不工作
+
+**检查项**:
+- 端口映射配置是否正确
+- 目标服务是否正在运行
+- 防火墙规则是否允许
+
+**解决方案**:
+- 确认映射配置: 访客端口 → 客户端端口
+- 检查目标服务状态
+- 测试本地端口访问
+
+### 3. 代理连接失败
+
+**检查项**:
+- 代理地址和端口是否正确
+- 代理认证信息是否正确
+- 网络连接是否正常
+
+**解决方案**:
+- 验证代理配置信息
+- 检查认证设置
+- 测试网络连接
+
+## 🔒 安全建议
+
+### 1. 认证配置
+
+- 启用 Token 验证
+- 配置 AppKey/AppSecret
+- 设置代理认证
+
+### 2. 网络安全
+
+- 使用 HTTPS 访问管理界面
+- 配置防火墙规则
+- 定期更新密码
+
+### 3. 数据安全
+
+- 定期备份配置数据
+- 监控异常访问
+- 记录操作日志
+
+## 📞 获取帮助
+
+### 联系方式
+- **作者**: 吴佳伟
+- **邮箱**: 1207537021@qq.com
+- **项目地址**: 
+  - [Gitee](https://gitee.com/wujiawei1207537021/wu-lazy-cloud-network)
+  - [GitHub](https://github.com/wujiawei1207537021/wu-lazy-cloud-network)
+
+### 文档资源
+- [项目说明文档](项目说明文档.md)
+- [安装指南](install.md)
+- [代理使用指南](Proxy.md)
+- [版本更新记录](version.md)
+
+---
+
+**版本**: 1.3.1-JDK24  
+**更新时间**: 2024年