GitHub 加速计划 speedtest 使用指南

核心功能模块解析

如何快速了解项目架构？

GitHub 加速计划 speedtest 项目采用模块化设计，主要包含以下核心功能模块：

后端服务模块

位于 backend/ 目录，包含多个 PHP 文件，主要负责处理网络测速的核心逻辑。

• getIP.php：获取用户 IP 地址的功能文件
• getIP_util.php：IP 地址处理相关的工具类

前端展示模块

包含多个 HTML 示例文件和 JavaScript 文件，提供不同风格的测速界面。

• index.html：项目默认首页
• speedtest.js：测速核心逻辑实现
• speedtest_worker.js：后台运行的测速工作线程

结果处理模块

位于 results/ 目录，负责测试结果的存储和展示。

• index.php：测试结果展示页面
• json.php：以 JSON 格式返回测试结果
• telemetry.php：测试数据统计相关功能

Docker 部署模块

位于 docker/ 目录，提供容器化部署相关文件。

• entrypoint.sh：Docker 容器启动脚本
• servers.json：服务器配置文件

各模块之间如何协同工作？

⚙️ 工作流程：

1. 用户通过前端页面发起测速请求
2. 后端服务模块处理请求并执行测速
3. 结果处理模块存储并展示测试结果
4. Docker 部署模块提供便捷的部署方式

快速上手流程

如何在 5 分钟内启动项目？

第一步：获取项目代码

git clone https://gitcode.com/gh_mirrors/spe/speedtest
cd speedtest

第二步：选择启动方式

提示：根据你的环境选择合适的启动方式

方式一：直接通过浏览器访问

1. 将项目文件放置在 Web 服务器根目录
2. 打开浏览器访问 index.html 文件

方式二：使用 Docker 部署

1. 确保已安装 Docker 环境
2. 执行以下命令构建并启动容器：

docker build -t speedtest .
docker run -p 8080:80 speedtest

3. 打开浏览器访问 http://localhost:8080

第三步：开始测速

1. 在打开的页面中，点击"开始测试"按钮
2. 等待测试完成，查看上传/下载速度结果

常见问题

Q: 为什么页面无法加载？ A: 请检查 Web 服务器是否正确配置，确保 PHP 环境正常运行。

Q: 测试结果不准确怎么办？ A: 建议多次测试取平均值，并确保测试时关闭其他网络应用。

个性化配置指南

如何根据需求调整测试参数？

服务器配置

修改 docker/servers.json 文件，添加或修改服务器信息：

1. 打开 docker/servers.json 文件
2. 按照现有格式添加新服务器信息
3. 保存文件并重启服务

前端界面定制

选择不同的示例页面满足个性化需求：

• example-singleServer-pretty.html：简洁美观的单服务器测试界面
• example-multipleServers-full.html：多服务器测试界面
• example-singleServer-chart.html：带图表展示的测试界面

结果存储配置

修改 results/telemetry_settings.php 文件，配置测试结果的存储方式：

1. 打开 results/telemetry_settings.php 文件
2. 根据注释提示修改数据库连接信息
3. 导入对应的数据库脚本（telemetry_mysql.sql 或 telemetry_postgresql.sql）

场景化配置方案

家庭用户配置

适合普通家庭网络测试需求：

1. 使用默认配置，选择 example-singleServer-pretty.html 界面
2. 无需修改服务器配置，使用默认服务器

企业用户配置

适合企业内部网络测试需求：

1. 添加内部服务器到 docker/servers.json
2. 配置数据库存储测试结果，便于统计分析
3. 使用 example-singleServer-chart.html 查看详细测试数据

常见问题

Q: 如何添加自定义服务器？ A: 编辑 docker/servers.json 文件，添加服务器名称、URL 和距离等信息。

Q: 如何修改测试时长？ A: 编辑 speedtest.js 文件，调整 testDuration 相关参数。

提示：更多高级配置选项，请参考项目中的 doc.md 和 doc_docker.md 文件。

通过以上指南，你已经掌握了 GitHub 加速计划 speedtest 项目的核心功能和使用方法。根据实际需求进行适当配置，可以获得更准确的网络测速结果。