BearFrps 是一个基于 frp/frps 的多用户动态连接管理平台。平台提供用户端、管理端和公网展示页，用户可以自助申请 frpc 配置和启动脚本，管理员可以查看连接、端口池和用户状态。
- 作者：BearFrps课程设计小组
- 课程：武汉大学开源软件与技术课程 2026
- Git 仓库地址：https://github.com/Muleizhang/BearFrps.git
- 许可证：Apache License 2.0
- 用户注册、登录、余额充值和 frpc 专属令牌轮换。
- TCP、HTTP、XTCP 代理配置生成，XTCP 同时生成 stcp fallback 和 visitor 配置。
- 自动分配公网端口，支持 TCP 单端口、连续端口和自动端口模式。
- frps 插件回调校验用户令牌、代理归属、端口和轮换版本。
- 管理端查看用户、代理和端口池，支持启停和删除连接。
- 公网展示页聚合在线 demo 服务入口。
flowchart LR
Browser["浏览器\n/user /admin /show"] --> FastAPI["FastAPI 后端\nbackend/main.py"]
FastAPI --> Routes["API 路由\n用户 / 管理 / 展示"]
Routes --> Store["进程内 Store\nUser / Proxy / PortPool"]
Store --> Storage["本地持久化\nSQLite + users.json"]
Routes --> Renderer["脚本渲染\nfrpc.toml / 启动脚本"]
Renderer --> UserHost["用户本机\nfrpc + demo 服务"]
UserHost --> Frps["frps\n公网转发入口"]
Frps --> Plugin["HTTP 插件回调\n/frps-plugin"]
Plugin --> Store
Poller["UsagePoller\n状态和流量轮询"] --> FrpsAdmin["frps admin API"]
FrpsAdmin --> Frps
Poller --> Store
Public["公网访问者"] --> Frps
Frps --> UserHost
python -m venv .venv
. .venv/bin/activate
pip install -r requirements.txt
python -m uvicorn backend.main:app --host 127.0.0.1 --port 8000打开以下页面：
实际部署时还需要启动 frps。frps/start.sh 会按 frps/frps.toml 启动本地 frps，并让 frps 插件回调后端 /frps-plugin。
核心配置由环境变量控制，默认值在 backend/config.py 中集中定义。常用项包括：
| 配置项 | 说明 |
|---|---|
SERVER_PUBLIC_HOST |
展示给用户的公网地址 |
BACKEND_PORT |
FastAPI 后端端口 |
FRPS_BIND_PORT |
frps 控制端口 |
FRPS_ADMIN_API_URL |
frps 管理 API 地址 |
FRPS_AUTH_TOKEN |
frps 内部认证令牌 |
ALLOCATABLE_PORT_RANGE_START / ALLOCATABLE_PORT_RANGE_END |
可分配公网 TCP 端口池 |
FREE_RECHARGE_AMOUNT_MB |
免费充值流量 |
MAX_CONNECTIONS_PER_USER |
单用户最大连接数 |
- 全局完整文档：汇总项目背景、项目分工、架构、接口、运行方式、测试、Doxygen 注释规范、文档生成、许可证和开源合规。
- 口头报告与演示提纲：整理课堂报告和现场演示的讲解顺序。
- Doxygen HTML 文档：运行
./tools/generate_doxygen.sh后打开docs/doxygen/html/index.html。
BearFrps 根项目采用 Apache License 2.0。frp 和 frp-Android 也使用 Apache License 2.0，许可证兼容。第三方组件和许可证记录见 SBOM.json 和 NOTICE。
修改 frp-Android/ 中的上游源码时，保留原许可证和版权声明，在修改文件中添加清晰的修改说明，并同步更新 NOTICE 与合规审计记录。
.venv/bin/python -m pytest -q
node --check frontend/mock_api.js
.venv/bin/python tools/check_comment_ratio.py
git diff --check源码文件头参考 Doxygen 规范，使用 @file、@brief、@author、@course、@date、@version、@copyright 和 @details 标记。作者统一为 BearFrps课程设计小组，课程统一为 武汉大学开源软件与技术课程 2026。
项目提供 Doxyfile。本机安装 Doxygen 和 Graphviz 后，可以生成 HTML API 文档：
./tools/generate_doxygen.sh生成结果位于 docs/doxygen/html/index.html。docs/doxygen/ 已加入 .gitignore，需要浏览时在本地重新生成即可。