diff --git a/website/README.md b/website/README.md new file mode 100644 index 00000000..21b8c760 --- /dev/null +++ b/website/README.md @@ -0,0 +1,241 @@ +# Wu-Lazy-Cloud-Network 官方网站 + +这是 Wu-Lazy-Cloud-Network 项目的官方网站,基于 Vue 3 + Element Plus 构建。 + +## 🚀 快速开始 + +### 环境要求 + +- Node.js 16.0+ +- npm 8.0+ 或 yarn 1.22+ + +### 安装依赖 + +```bash +# 使用 npm +npm install + +# 或使用 yarn +yarn install +``` + +### 开发模式 + +```bash +# 启动开发服务器 +npm run dev + +# 或使用 yarn +yarn dev +``` + +开发服务器将在 `http://localhost:3000` 启动。 + +### 构建生产版本 + +```bash +# 构建生产版本 +npm run build + +# 或使用 yarn +yarn build +``` + +构建文件将输出到 `dist` 目录。 + +### 预览生产版本 + +```bash +# 预览生产版本 +npm run preview + +# 或使用 yarn +yarn preview +``` + +## 📁 项目结构 + +``` +website/ +├── public/ # 静态资源 +├── src/ +│ ├── assets/ # 资源文件 +│ │ ├── images/ # 图片资源 +│ │ └── styles/ # 样式文件 +│ ├── components/ # 公共组件 +│ │ ├── Header.vue # 头部导航 +│ │ └── Footer.vue # 底部组件 +│ ├── router/ # 路由配置 +│ │ └── index.js +│ ├── stores/ # 状态管理 +│ ├── utils/ # 工具函数 +│ │ └── index.js +│ ├── views/ # 页面组件 +│ │ ├── Home.vue # 首页 +│ │ ├── Features.vue # 功能特性 +│ │ ├── Architecture.vue # 系统架构 +│ │ ├── Docs.vue # 使用文档 +│ │ ├── Download.vue # 下载安装 +│ │ └── About.vue # 关于我们 +│ ├── App.vue # 根组件 +│ └── main.js # 入口文件 +├── index.html # HTML 模板 +├── package.json # 项目配置 +├── vite.config.js # Vite 配置 +└── README.md # 项目说明 +``` + +## 🎨 页面说明 + +### 首页 (Home.vue) +- 项目介绍和核心功能展示 +- 技术栈和快速开始指南 +- 统计数据展示 + +### 功能特性 (Features.vue) +- 详细的功能介绍 +- 内网穿透、网络代理、流量监控等功能说明 +- 安全特性展示 + +### 系统架构 (Architecture.vue) +- 整体架构图 +- 模块架构说明 +- 数据流架构 +- 技术栈介绍 + +### 使用文档 (Docs.vue) +- 快速开始指南 +- 安装部署说明 +- 配置参数详解 +- 使用指南和故障排除 + +### 下载安装 (Download.vue) +- 版本信息 +- 多种下载方式 +- 部署指南 +- 系统要求 + +### 关于我们 (About.vue) +- 项目背景和核心价值 +- 开发团队介绍 +- 技术栈详情 +- 发展路线图 +- 联系方式 + +## 🛠️ 技术栈 + +- **Vue 3**: 渐进式 JavaScript 框架 +- **Vue Router**: 官方路由管理器 +- **Pinia**: 状态管理库 +- **Element Plus**: Vue 3 组件库 +- **Vite**: 下一代前端构建工具 +- **SCSS**: CSS 预处理器 +- **Prism.js**: 代码高亮 +- **Marked**: Markdown 解析器 + +## 🎯 主要功能 + +### 响应式设计 +- 支持桌面端和移动端 +- 自适应布局 +- 触摸友好的交互 + +### 代码高亮 +- 支持多种编程语言 +- 语法高亮显示 +- 复制代码功能 + +### 性能优化 +- 路由懒加载 +- 组件按需加载 +- 图片懒加载 +- 代码分割 + +### SEO 友好 +- 语义化 HTML +- Meta 标签优化 +- 结构化数据 + +## 🔧 开发指南 + +### 添加新页面 + +1. 在 `src/views/` 目录下创建新的 Vue 组件 +2. 在 `src/router/index.js` 中添加路由配置 +3. 在 `src/components/Header.vue` 中添加导航链接 + +### 添加新组件 + +1. 在 `src/components/` 目录下创建组件 +2. 在需要使用的页面中导入并使用 + +### 样式开发 + +- 使用 SCSS 编写样式 +- 遵循 BEM 命名规范 +- 使用 CSS 变量管理主题色彩 +- 响应式设计使用媒体查询 + +### 代码规范 + +- 使用 ESLint 进行代码检查 +- 使用 Prettier 进行代码格式化 +- 遵循 Vue 3 组合式 API 规范 +- 组件命名使用 PascalCase +- 文件名使用 kebab-case + +## 📦 构建部署 + +### 构建生产版本 + +```bash +npm run build +``` + +### 部署到静态服务器 + +构建完成后,将 `dist` 目录的内容部署到 Web 服务器即可。 + +### Docker 部署 + +```dockerfile +# 使用 nginx 镜像 +FROM nginx:alpine + +# 复制构建文件 +COPY dist/ /usr/share/nginx/html/ + +# 复制 nginx 配置 +COPY nginx.conf /etc/nginx/nginx.conf + +# 暴露端口 +EXPOSE 80 + +# 启动 nginx +CMD ["nginx", "-g", "daemon off;"] +``` + +## 🤝 贡献指南 + +1. Fork 本仓库 +2. 创建特性分支 (`git checkout -b feature/AmazingFeature`) +3. 提交更改 (`git commit -m 'Add some AmazingFeature'`) +4. 推送到分支 (`git push origin feature/AmazingFeature`) +5. 打开 Pull Request + +## 📄 许可证 + +本项目采用 [Apache License 2.0](LICENSE) 许可证。 + +## 📞 联系我们 + +- **邮箱**: 1207537021@qq.com +- **项目地址**: + - [Gitee](https://gitee.com/wujiawei1207537021/wu-lazy-cloud-network) + - [GitHub](https://github.com/wujiawei1207537021/wu-lazy-cloud-network) + +--- + +**版本**: 1.0.0 +**更新时间**: 2024年12月 +**维护者**: 吴佳伟 \ No newline at end of file diff --git a/website/index.html b/website/index.html new file mode 100644 index 00000000..0c6deef0 --- /dev/null +++ b/website/index.html @@ -0,0 +1,16 @@ + + +
+ + + + + + ++ 了解 Wu-Lazy-Cloud-Network 项目的背景、团队和愿景 +
+基于现代化技术栈的高性能网络穿透和代理工具
++ Wu-Lazy-Cloud-Network 是一个基于 Spring Boot 3.5.0 和 JDK 24 开发的高性能网络穿透和代理工具。 + 项目起源于对现有网络穿透工具的不足之处的思考,旨在提供一个更加稳定、高效、易用的解决方案。 +
+ +专业的开发团队,致力于提供优质的网络解决方案
+项目负责人 & 主要开发者
++ 拥有多年 Java 开发经验,专注于高性能网络应用开发。 + 负责项目的整体架构设计、核心功能开发和性能优化。 +
+采用现代化的技术栈,确保高性能和可靠性
+现代化的应用框架,提供快速开发和部署能力
+高性能异步网络框架,支持高并发连接处理
+最新的 Java 开发工具包,提供优秀的性能表现
+主数据库,存储配置和监控数据
+开发环境数据库,轻量级嵌入式数据库
+轻量级 ORM 框架,提供类型安全的数据库操作
+容器化部署,提供一致的运行环境
+构建自动化工具,管理项目依赖
+应用监控和管理,提供健康检查和指标
+项目的未来发展规划和功能演进
+2024年12月
+2025年Q1
+2025年Q2
+欢迎反馈建议、报告问题或参与项目贡献
+查看详细的使用文档、API 文档和开发指南
++ 基于现代化的技术栈,采用模块化设计,提供高性能和可靠性 +
+采用分层架构设计,各模块职责清晰,便于维护和扩展
+松耦合的模块化设计,支持独立开发和部署
+公共基础模块,提供接口定义、枚举常量、适配器等
+服务端核心模块,提供网络服务、客户端管理、端口映射等功能
+客户端核心模块,提供连接管理、本地服务、端口转发等功能
+代理协议模块,提供 HTTP 和 SOCKS 代理服务
+清晰的数据流向,支持高效的数据传输和处理
+外部用户连接到服务端访客端口
+服务端创建访客通道,通过心跳通道转发数据
+客户端接收数据并转发给本地服务
+本地服务响应数据,通过心跳通道返回给访客
+应用程序发起代理请求
+代理客户端接收请求并转发
+代理服务端处理请求并访问目标服务器
+目标服务器处理请求并返回响应
+采用现代化的技术栈,确保高性能和可靠性
+现代化的应用框架,提供快速开发和部署能力
+高性能异步网络框架,支持高并发连接处理
+最新的 Java 开发工具包,提供优秀的性能表现
+主数据库,存储配置和监控数据
+开发环境数据库,轻量级嵌入式数据库
+轻量级 ORM 框架,提供类型安全的数据库操作
+容器化部署,提供一致的运行环境
+构建自动化工具,管理项目依赖
+应用监控和管理,提供健康检查和指标
++ 详细的使用指南和配置说明,帮助您快速上手 Wu-Lazy-Cloud-Network +
+几分钟内完成部署和配置
+使用 Docker 快速启动服务端
+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
+ 配置客户端连接到服务端
+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
+ 通过 Web 界面进行配置和管理
+# 服务端管理界面
+http://127.0.0.1:6001/netty-server-ui/index.html
+
+# 客户端管理界面
+http://127.0.0.1:6004/netty-client-local-ui/index.html
+ 支持多种部署方式,满足不同环境需求
+推荐使用 Docker 进行部署,简单快速
+# 拉取镜像
+docker pull registry.cn-hangzhou.aliyuncs.com/wu-lazy/wu-lazy-cloud-heartbeat-server:1.3.1-JDK24
+
+# 启动容器
+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
+ # 拉取镜像
+docker pull registry.cn-hangzhou.aliyuncs.com/wu-lazy/wu-lazy-cloud-heartbeat-client-start:1.3.1-JDK24
+
+# 启动容器
+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
+ 从源码编译部署,适合开发环境
+# 克隆项目
+git clone https://gitee.com/wujiawei1207537021/wu-lazy-cloud-network.git
+cd wu-lazy-cloud-network
+
+# 编译项目
+mvn clean package -DskipTests
+
+# 启动服务端
+cd wu-lazy-cloud-heartbeat-start/wu-lazy-cloud-heartbeat-server-start
+java -jar target/wu-lazy-cloud-heartbeat-server-start-1.3.1-JDK24.jar
+
+# 启动客户端
+cd ../wu-lazy-cloud-heartbeat-client-start
+java -jar target/wu-lazy-cloud-heartbeat-client-start-1.3.1-JDK24.jar
+ 详细的配置参数说明和使用示例
+spring:
+ lazy:
+ netty:
+ server:
+ mode: standalone # 模式:standalone/cluster
+ node-id: default # 节点ID
+ node-host: 127.0.0.1 # 节点主机
+ node-port: 7001 # 节点端口
+ enable-flow-control: true # 启用流量控制
+ enable-token-verification: false # 启用Token验证
+ tcp:
+ port: 7001 # TCP端口
+ udp:
+ port: 7001 # UDP端口
+ | 参数 | +说明 | +默认值 | +
|---|---|---|
| mode | +运行模式,支持 standalone 和 cluster | +standalone | +
| node-id | +节点唯一标识 | +default | +
| node-host | +节点主机地址 | +127.0.0.1 | +
| node-port | +节点监听端口 | +7001 | +
| enable-flow-control | +是否启用流量控制 | +true | +
spring:
+ lazy:
+ netty:
+ client:
+ client-id: your-client-id # 客户端ID
+ inet-host: 127.0.0.1 # 服务端地址
+ inet-port: 7001 # 服务端端口
+ enable: true # 启用客户端连接
+ | 参数 | +说明 | +默认值 | +
|---|---|---|
| client-id | +客户端唯一标识 | +- | +
| inet-host | +服务端 IP 地址 | +127.0.0.1 | +
| inet-port | +服务端 TCP 端口 | +7001 | +
| enable | +是否启用客户端连接 | +true | +
spring:
+ lazy:
+ netty:
+ protocol:
+ proxy:
+ authentication: true # 启用代理认证
+ enable-proxy-log: false # 启用代理日志
+ socket-protocol-proxy:
+ port: 9001 # SOCKS代理端口
+ http-protocol-proxy:
+ port: 8001 # HTTP代理端口
+ | 参数 | +说明 | +默认值 | +
|---|---|---|
| authentication | +是否启用代理认证 | +true | +
| enable-proxy-log | +是否启用代理日志 | +false | +
| socket-protocol-proxy.port | +SOCKS 代理端口 | +9001 | +
| http-protocol-proxy.port | +HTTP 代理端口 | +8001 | +
详细的功能使用说明和最佳实践
+http://服务端IP:19080 访问客户端本地 18080 端口localhost:13306 访问远程 3306 端口# 系统代理设置 (Mac)
+networksetup -setwebproxy "Wi-Fi" 127.0.0.1 8001
+networksetup -setsecurewebproxy "Wi-Fi" 127.0.0.1 8001
+
+# 使用 curl 测试代理
+curl -x http://127.0.0.1:8001 http://httpbin.org/ip
+ 常见问题解决方案和调试技巧
+# 检查网络连接
+ping YOUR_SERVER_IP
+
+# 检查端口是否开放
+telnet YOUR_SERVER_IP 7001
+
+# 查看客户端日志
+docker logs wlcn-client
+ + 选择适合您的部署方式,快速开始使用 Wu-Lazy-Cloud-Network +
+详细的部署说明和最佳实践
+# 拉取镜像
+docker pull registry.cn-hangzhou.aliyuncs.com/wu-lazy/wu-lazy-cloud-heartbeat-server:1.3.1-JDK24
+
+# 启动容器
+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
+ # 拉取镜像
+docker pull registry.cn-hangzhou.aliyuncs.com/wu-lazy/wu-lazy-cloud-heartbeat-client-start:1.3.1-JDK24
+
+# 启动容器(替换 YOUR_SERVER_IP 为实际服务端 IP)
+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
+ http://服务端IP:6001/netty-server-ui/index.htmlhttp://客户端IP:6004/netty-client-local-ui/index.html# 克隆项目
+git clone https://gitee.com/wujiawei1207537021/wu-lazy-cloud-network.git
+cd wu-lazy-cloud-network
+
+# 切换到稳定版本
+git checkout v1.3.1-JDK24
+ # 编译所有模块
+mvn clean package -DskipTests
+
+# 或者编译特定模块
+mvn clean package -pl wu-lazy-cloud-heartbeat-server-start -am -DskipTests
+mvn clean package -pl wu-lazy-cloud-heartbeat-client-start -am -DskipTests
+ # 启动服务端
+cd wu-lazy-cloud-heartbeat-start/wu-lazy-cloud-heartbeat-server-start
+java -jar target/wu-lazy-cloud-heartbeat-server-start-1.3.1-JDK24.jar
+
+# 启动客户端
+cd ../wu-lazy-cloud-heartbeat-client-start
+java -jar target/wu-lazy-cloud-heartbeat-client-start-1.3.1-JDK24.jar
+ 支持多节点集群部署,提供高可用性和负载均衡
+ +spring:
+ lazy:
+ netty:
+ server:
+ mode: cluster
+ node-id: node-1
+ node-host: 192.168.1.100
+ node-port: 7001
+ # 启动集群服务端
+cd wu-lazy-cloud-heartbeat-start/wu-lazy-cloud-heartbeat-server-cluster-start
+java -jar target/wu-lazy-cloud-heartbeat-server-cluster-start-1.3.1-JDK24.jar
+ 确保您的环境满足运行要求
++ 提供完整的内网穿透和网络代理解决方案,支持多种协议和部署模式 +
++ 支持多种穿透模式,将内网服务安全地暴露到公网,实现远程访问和调试。 +
+ +将内网服务映射到公网,实现远程访问
+# 配置示例
+visitor_port: 19080
+real_host: 192.168.1.100
+real_port: 18080
+ 本地端口映射到远程服务端端口
+# 配置示例
+local_port: 13306
+remote_port: 3306
+ 不同网络间的端口映射,实现异地组网
+# 配置示例
+client_a_port: 8080
+client_b_port: 9090
+ + 提供 HTTP 和 SOCKS 代理服务,支持异地组网和网络加速。 +
+ +spring:
+ lazy:
+ netty:
+ protocol:
+ proxy:
+ authentication: true
+ enable-proxy-log: false
+ socket-protocol-proxy:
+ port: 9001
+ http-protocol-proxy:
+ port: 8001
+ + 实时监控网络流量使用情况,提供详细的统计报表和分析。 +
+ ++ 支持虚拟路由和流量转发,实现灵活的网络配置。 +
+ +创建虚拟 IP 地址,将流量代理到目标地址
+# 虚拟路由配置
+virtual_ip: 10.0.0.100
+target_host: 192.168.1.100
+target_port: 8080
+ 多重安全机制,保障数据传输和访问安全
++ 基于 Spring Boot 3.5.0 和 JDK 24 开发,支持 TCP、HTTP、SOCKS 协议, + 提供完整的内网穿透、网络代理、流量监控等功能。 +
+提供完整的内网穿透和网络代理解决方案
++ 支持多种穿透模式,将内网服务安全地暴露到公网,实现远程访问和调试。 +
++ 提供 HTTP 和 SOCKS 代理服务,支持异地组网和网络加速。 +
++ 实时监控网络流量使用情况,提供详细的统计报表和分析。 +
++ 支持虚拟路由和流量转发,实现灵活的网络配置。 +
+基于现代化的技术栈,提供高性能和可靠性
+现代化的应用框架,提供快速开发和部署能力
+高性能异步网络框架,支持高并发连接处理
+轻量级 ORM 框架,提供类型安全的数据库操作
+最新的 Java 开发工具包,提供优秀的性能表现
+几分钟内完成部署和配置
+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
+ 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
+ # 服务端管理界面
+http://127.0.0.1:6001/netty-server-ui/index.html
+
+# 客户端管理界面
+http://127.0.0.1:6004/netty-client-local-ui/index.html
+ + 加入数千名开发者,体验高性能的网络穿透和代理服务 +
+