From 68cf2126ff0b74aadd74e0dfe7af45bb6abe0f5b Mon Sep 17 00:00:00 2001 From: qaq <1937228092@qq.com> Date: Fri, 27 Jun 2025 14:49:43 +0800 Subject: [PATCH] =?UTF-8?q?=E6=B7=BB=E5=8A=A0=E8=AF=B4=E6=98=8E?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- vitepress/.vitepress/config.js | 3 +- vitepress/faq.md | 38 ++++++++++++++- vitepress/getting-started.md | 24 ++++++++-- vitepress/guide.md | 83 +++++++++++++++++++++++++++------ vitepress/index.md | 1 + vitepress/project-structure.md | 4 ++ vitepress/public/telegram.ico | Bin 0 -> 15086 bytes 7 files changed, 132 insertions(+), 21 deletions(-) create mode 100644 vitepress/public/telegram.ico diff --git a/vitepress/.vitepress/config.js b/vitepress/.vitepress/config.js index 3c2afb4..805e265 100644 --- a/vitepress/.vitepress/config.js +++ b/vitepress/.vitepress/config.js @@ -14,7 +14,8 @@ export default defineConfig({ ], socialLinks: [ - { icon: 'github', link: 'https://github.com/bqlpfy/forward-panel' } + { icon: 'github', link: 'https://github.com/bqlpfy/forward-panel' }, + { icon: 'telegram', link: 'https://t.me/+wdVDni1fdyI0YzE1'} ] } }) \ No newline at end of file diff --git a/vitepress/faq.md b/vitepress/faq.md index 69a24a7..6b370fb 100644 --- a/vitepress/faq.md +++ b/vitepress/faq.md @@ -1,5 +1,9 @@ # 常见问题 +::: tip 需要帮助？ +📱 [加入 Telegram 群组](https://t.me/+wdVDni1fdyI0YzE1) | 🐛 [GitHub Issues](https://github.com/bqlpfy/forward-panel/issues) | 🚀 [快速开始](/getting-started) +::: + ## 日志查看 ### 查看后端服务日志 @@ -60,4 +64,36 @@ docker logs springboot-backend | grep ERROR - **ERROR** - 错误信息，需要立即处理 - **WARN** - 警告信息，建议关注 - **INFO** - 一般信息，正常运行状态 -- **DEBUG** - 调试信息，详细执行过程 \ No newline at end of file +- **DEBUG** - 调试信息，详细执行过程 + +## 获取更多帮助 + +如果上述信息无法解决您的问题： + +### 社区支持 + +1. **💬 Telegram 群组**（推荐） + - [立即加入](https://t.me/+wdVDni1fdyI0YzE1) + - 实时讨论，经验分享 + - 开发者和社区用户在线答疑 + +2. **🐛 GitHub Issues** + - [报告 Bug](https://github.com/bqlpfy/forward-panel/issues/new) + - [查看已知问题](https://github.com/bqlpfy/forward-panel/issues) + - 参与功能讨论 + +### 技术支持 + +提交问题时，请提供以下信息以便快速诊断： + +- 操作系统版本 +- Docker 和 Docker Compose 版本 +- 错误日志完整内容 +- 问题复现步骤 +- 相关配置文件（隐去敏感信息） + +### 文档资源 + +- [使用指南](/guide) - 详细操作教程 +- [快速开始](/getting-started) - 安装和配置 +- [项目结构](/project-structure) - 技术架构说明 \ No newline at end of file diff --git a/vitepress/getting-started.md b/vitepress/getting-started.md index 98b66ec..17faa47 100644 --- a/vitepress/getting-started.md +++ b/vitepress/getting-started.md @@ -2,6 +2,10 @@ 本指南将帮助您快速安装和配置哆啦A梦，让您在几分钟内开始使用流量转发功能。 +::: tip 需要帮助？ +📱 [加入 Telegram 群组](https://t.me/+wdVDni1fdyI0YzE1) | 🐛 [GitHub Issues](https://github.com/bqlpfy/forward-panel/issues) | 🤔 [常见问题](/faq) +::: + ## 系统要求 在开始之前，请确保您的系统满足以下要求： @@ -185,10 +189,22 @@ docker compose ps 如果在安装过程中遇到问题： -1. 🔍 查看安装日志和错误信息 -2. 📋 检查系统要求是否满足 -3. 🐛 提交 [GitHub Issues](https://github.com/bqlpfy/forward-panel/issues) -4. 💬 参与社区讨论 +1. **💬 Telegram 群组**（推荐） + - [立即加入](https://t.me/+wdVDni1fdyI0YzE1) + - 实时技术支持，快速响应 + +2. **🔍 故障排除** + - 查看安装日志和错误信息 + - 检查系统要求是否满足 + - 验证 Docker 和网络配置 + +3. **🐛 GitHub Issues** + - [报告安装问题](https://github.com/bqlpfy/forward-panel/issues/new) + - 查看 [已知问题](https://github.com/bqlpfy/forward-panel/issues) + +4. **📖 文档资源** + - [使用指南](/guide) - 详细的操作教程 + - [常见问题](/faq) - 快速解决方案 ## 备份建议 diff --git a/vitepress/guide.md b/vitepress/guide.md index 9a5635b..ba8ce98 100644 --- a/vitepress/guide.md +++ b/vitepress/guide.md @@ -2,6 +2,10 @@ 哆啦A梦是一个基于 go-gost 的现代化转发面板，提供了直观的 Web 界面来管理网络流量转发。 +::: tip 需要帮助？ +📱 [加入 Telegram 群组](https://t.me/+wdVDni1fdyI0YzE1) | 🐛 [GitHub Issues](https://github.com/bqlpfy/forward-panel/issues) | 🤝 [参与贡献](https://github.com/bqlpfy/forward-panel/pulls) +::: + ## 项目介绍 ### 核心功能 @@ -37,12 +41,6 @@ http://your-server-ip:6366 登录后**务必立即修改默认密码**： -1. 点击右上角用户头像 -2. 选择 **"修改密码"** -3. 输入当前密码：`admin_user` -4. 设置新密码并确认 -5. 点击确定完成修改 - ## 第三步：创建节点 节点是运行转发服务的服务器，需要先创建节点才能部署转发服务。 @@ -54,7 +52,7 @@ http://your-server-ip:6366 3. 填写节点信息： - **节点名称**: 自定义名称（如：香港节点-01） - **服务器IP**: 节点服务器的IP地址 - - **状态**: 启用 + - **入口IP**: 节点服务器的IP地址 4. 点击 **"确定"** 保存节点 @@ -96,8 +94,10 @@ http://your-server-ip:6366 # 示例安装命令（实际命令请从面板复制） curl -L https://your-panel-server:6365/agent/install | bash -s -- --server=your-panel-server:6365 --token=your-node-token ``` -如果/etc/gost/下存在gost.json和config.json，安装命令会跳过生成，使用当前存在的配置 -gost执行文件会强制更新 + +### 须知 +- 安装或者更新时如果/etc/gost/下存在gost.json和config.json，安装命令会跳过生成，使用当前存在的配置 +- gost执行文件会强制更新 ### 验证安装 @@ -129,12 +129,13 @@ gost执行文件会强制更新 - **入口节点**: 选择流量入口节点 - **起始端口**: 端口范围起始值（默认1） - **结束端口**: 端口范围结束值（默认65535） -- **监听地址**: 保持默认即可（TCP/UDP 都默认 0.0.0.0） +- **监听地址**: 部分专线需要，如果不理解保持默认即可 **出口配置**（仅隧道转发类型需要）： - **协议类型**: 保持默认即可，如有特殊需求可选择： - TLS：数据过墙推荐选择 - TCP：普通场景 + - MTLS: 多路复用的TLS - **出口节点**: 选择流量出口节点 - **起始端口**: 出口端口范围起始值（默认1） - **结束端口**: 出口端口范围结束值（默认65535） @@ -289,12 +290,64 @@ gost执行文件会强制更新 ## 获取帮助 -如果在使用过程中遇到问题： +### 社区支持 -1. 📖 查看本文档的相关章节 -2. 🔍 检查系统日志和错误信息 -3. 🐛 提交 [GitHub Issues](https://github.com/bqlpfy/forward-panel/issues) -4. 💬 参与社区讨论 +如果在使用过程中遇到问题或有功能建议，推荐以下方式获取帮助： + +1. **💬 Telegram 群组**（推荐） + - [立即加入](https://t.me/+wdVDni1fdyI0YzE1) + - 实时讨论，快速回复 + - 与其他用户交流经验 + +2. **🐛 GitHub Issues** + - [报告问题](https://github.com/bqlpfy/forward-panel/issues/new) + - 查看 [已知问题](https://github.com/bqlpfy/forward-panel/issues) + - 提交功能建议 + +3. **📖 文档资源** + - [快速开始指南](/getting-started) + - [常见问题解答](/faq) + - [项目架构说明](/project-structure) + +### 故障排除 + +#### 安装相关问题 + +**问题**: Agent 安装失败 +- 检查服务器网络连接 +- 确认防火墙设置（开放 6365 端口） +- 使用 `sudo` 权限执行安装命令 + +**问题**: 节点显示离线 +- 检查 Agent 服务状态：`systemctl status gost-agent` +- 查看 Agent 日志：`journalctl -u gost-agent -f` +- 确认面板地址和端口可访问 + +#### 转发相关问题 + +**问题**: 转发无法正常工作 +- 检查端口是否被占用 +- 确认目标地址可达性 +- 验证隧道状态是否正常 + +**问题**: 流量统计异常 +- 确认转发规则配置正确 +- 检查流量计算方式设置 +- 重启相关服务进行重置 + +#### 权限相关问题 + +**问题**: 用户无法创建转发 +- 检查用户账号状态 +- 确认隧道权限分配 +- 验证流量和转发数量限制 + +### 联系开发者 + +对于紧急问题： + +- **GitHub**: [@bqlpfy](https://github.com/bqlpfy) +- **Telegram**: [加入群组](https://t.me/+wdVDni1fdyI0YzE1) 直接联系 ## 免责声明 diff --git a/vitepress/index.md b/vitepress/index.md index f2981c7..65f2a21 100644 --- a/vitepress/index.md +++ b/vitepress/index.md @@ -50,6 +50,7 @@ features: 如果您在使用过程中遇到问题或有功能建议，欢迎： +- 📱 [加入 Telegram 群组](https://t.me/+wdVDni1fdyI0YzE1) - 🐛 [报告问题](https://github.com/bqlpfy/forward-panel/issues) - 💡 [功能建议](https://github.com/bqlpfy/forward-panel/issues) - 🤝 [参与贡献](https://github.com/bqlpfy/forward-panel/pulls) diff --git a/vitepress/project-structure.md b/vitepress/project-structure.md index 6b654b9..ea7105a 100644 --- a/vitepress/project-structure.md +++ b/vitepress/project-structure.md @@ -2,6 +2,10 @@ 哆啦A梦是一个基于微服务架构的现代化网络转发面板，采用前后端分离设计，集成了多个核心组件。 +::: tip 需要帮助？ +📱 [加入 Telegram 群组](https://t.me/+wdVDni1fdyI0YzE1) | 🐛 [GitHub Issues](https://github.com/bqlpfy/forward-panel/issues) | 🚀 [快速开始](/getting-started) +::: + ## 总体架构 ``` diff --git a/vitepress/public/telegram.ico b/vitepress/public/telegram.ico new file mode 100644 index 0000000000000000000000000000000000000000..3e0067fdb3ef6e6fa9cc1633b03195bd77deb836 GIT binary patch literal 15086 zcmd6uX^>Ra6~`ZokS`SaC8DMxACf9H1`wS^7{K6Y6g7!4iK!$NQ<%gpmMF#wNg)%H zs4*Iy8HOE%h>ENQZgByIO>rsIMBGpqmH`H)*O{KBr@L={=f3xPUiZA${kmsb(p7iv z+wQ&pv)psfJ?D;L3^Ilome?Fh-BI?oT(2{X9FJTHfC})G!|8gY)=? zCdRKQ@?8JEVO9hAH@xzvBZG^-TNPaJo%;gwCan$3owzqpe`zRCUy%&dUZQlVuS^E! zP6!7Ysy+(NzidNr(G{~o%fCN4vhJ2M1`>e-=x-7u#8)jz}e(*B|w?idX3E`rDN19jy`d-2&g z3#m;SE%_Wrev6@_EVko`!KI)gwB+hh@auv8<94Ibl1qJMOK?&3!{JrGJZB(jfHzYD z^_4r}w?jwVaP;@tcyqqYoAg#_#Sg3F2X+kV4;|rWem;~rIUW7(r>+!E7xU^wXz4Y# zw{QO2uwrNkKlPJg=*xZRXIuaDym0L1c*vrzJQiGX)%|U+%=tQfOxlfY{hAjItci0Nu?AG;cud+Au-A1)bwcpaQKS;cnNsbut+k{>t}K2QO2 z(0X*7wLx6K^e_C>j|Rbq`qE&B=jcoL*wb+m|>Yk(TEA$!~OdrC==v`|W976_U)A(!4?)CoOdp>!$ zv3UOU&s6-2tx6?(GB7)Dl5NLT=*jD}jJ*5H#9+>Y%V!II{PGdpZ}!_Z?|0}*pkbnF z-|{eee$)xo{ko@9Mb`WVdsK)mLIw>JcQXIaV2!Q>(}}#e(!P8qFEZMJJ+$mv)&1G4 zIeDHfcYE%QR~>IO06$d_3EiJ>6@C^lhfTh*-mVA#p1k<=dWkJz zjL@>{RCLqb*ztPR@#X>*-S9hwzhu&a4Pj5Iy8g2k5|X}YNSydYVG|3)FLR*kBk;H6 z!q0n!-=XlsRrkKl=A3lelb$Y~zpldA8nN>t6S0|{@2_GGWZHT!f>N%@Nxp`Xw^yeCJ7}65U>~d!O@7Wc_W0+aTf^p4f#C z;1?ey8EWbsE7uir(Xv>1qsD?iWzGj|WWHbf>wndB=fsmG8_|vY-;dYpOKeB2O0<0J z%PuA(&061(ukJs#?JUk;iC)E}8Y$I|j#1|ERLtKJZuU>+2YV~c7bnJC*Z8e#d4Crrw;l4s4||Pks8Z4Ox2vwb8_}(k z*)YBD*%w5gpXu8MA^Q}uV2P1bfPY~8H%+HCN7xt2-0gUCzDk_@)R*0gH9k@R{<1)D z(Un!;9|8W&6d$&|3CEbO_q!Jm<`2LSub zfyeKl)wWypl`698CMC8$5%>a`WcnBE2~C>);BS~TOR&qYwf2(pz<;QuG}yX@-D-s% z@(0Ldmg@fGW!CqD+DB=7<$hoM$B%4ArWcy%*@M+r4gz~^>G3;dA~7Jb!DX5jv7LT> zXzb>^_AL)(SDWF@A>(JZbX&2LJW} zCuZk0w&<(iZ=?*cEgG2q@Mm`f7hg5Xi8=ck8mhp53iK#9jp)r$)~hMmc-`*7e-kD8 z{~`x?+Qwe-W;d*E&#(hSz;>`NO&)T?ZWlX=9JT^Llc=W69I?$*ttVRLncZ8Vr8% z`6TYXg>sToh;GTZC*k)N`uaWl@bj?k8U9Q$xQb~5h7rsU*#k)&SoWf_pO%=OGp-@m zEquF&@(g7LvaEpLBZ?W**+!|R;Yt}sx^x-FxpLoR7{jG*G>joq*Km$VYH7@$l+<$! zBO&z^!=M=r4I?Zyy9!+oH;g8^r*4#*j8Ar5BhS&8>{=cVmp1a^`lIP&I z>9Fat>9py#`2b5aU($SPwD?BDk-StkU*%dClkaj)Yc%CDO8T7E>D(0YBbG8WxM1pq zto3)3&)kGwA3#q!(H9+S!T;)FuhE1L`2zYrles!3vhFtD=K{PSu|^Cb?mdCN7c-w^ zALcO^@zpK+4W=a6j(~NUoF9v>zpbcshPe4TjQbeWiVs^qu}wbwV?`s@h)q1M#rWbUdu%ttIfVcTQ&0#rFZ?n%a*db`I^AEXe*Q|Gm&WPRC|- zUd$02?K$?}yfJ6wy^Q?oP_SIUSO@Zt=g_B;6|;q_hL=fsE>R;$kUo+Tdak!z5=)4JSwC$W>{DQ8lz?>mN#)zm99uPWzy z%-Bx*>wkgb+_}{D%@5{{dE!gIz}TPl9p98Keu&QhMW4Ti81TJ1o+MZ}GOe-}(uoNF`lITEXuvnk|V6D=R9He@bsMZP_U-^m=*aTnje z4H;MPEws4m0C}3aica2T#)Z&nITItfF4rG2mmDhb4uwtU?92|=&m=aT*AAF@y3Fx~ zFOol5NsRmLr796TplQz@L~?e~jWaX`eXb$v13$T28K*D*E!`7cqX>Q{P;&bU^leMXW#0J}udx&texuUqv6a{B5jR zH9quWa`<`;X8cOZz~rhdp3on>ceg#vyOZSjCfL3gybvBdVzzP8Rhnz@tI0`b?2Ey4 zHsfzEH3sCp3%R?VHD&B_%BQ8m0H61UfdOFx1m zwBmYcJB|CG-FI&-Hh#Q{tiDBNG<2!oqHF2jy1GR$EWE}pRW-=Jhb8ll?)&1^?DLSY;uDSZmeKLF`-G`jFbNWrtAaNh&mH5o%&^ldpe(;=meh+Az`o``QpQ8s3_@$L`4Z^CY$<(vanAA&>9XnA1?(U!P<#VBW6`