Installation

📋 目录

• 环境要求
• 安装说明
  • 方法一：Docker Compose 部署（推荐）
  • 方法二：手动安装
• 部署后配置
  • 测试后端应用
  • 接入 API

---

环境要求

Docker Compose 部署

• Docker 和 Docker Compose

手动安装

• Node.js 版本 22 或更高
• MongoDB 数据库 版本 8 或更高

---

安装说明

方法一：Docker Compose 部署（推荐）

1. 下载必要文件

   wget https://raw.githubusercontent.com/1812z/RunTime_Tracker/master/docker-compose.yml
   wget https://raw.githubusercontent.com/1812z/RunTime_Tracker/master/.example.env -O .env
   chmod 646 .env

2. 配置参数

   手动配置

   编辑 .env 文件，修改以下配置：

   • SECRET：设置你的密钥（用于 API 认证）
   • MONGODB_URI：数据库连接信息（默认已配置好，可修改密码）
   • 其他参数可暂时保持默认(运行后支持网页后台配置工具)

   网页配置(需要先确保后端访问正常，因此先转到3.启动服务)

   打开 在线配置工具，输入服务器 URL 即可配置

   ⚠️ 注意：不支持 HTTP 连接，请使用 HTTPS，为此你需要先配置好反代，确保能访问后端

3. 启动服务

   # 启动所有服务
   docker-compose up -d
   
   # 查看服务状态
   docker-compose ps
   
   # 查看日志
   docker-compose logs -f

4. 完成部署

   ➡️ 继续进行 部署后配置

---

方法二：手动安装

1. 准备环境

   • 安装 Node.js v22+ 和 MongoDB v8+
   • 创建一个空的数据库供应用使用

2. 获取项目代码

   # 克隆项目仓库
   git clone https://github.com/1812z/RunTime_Tracker.git
   cd RunTime_Tracker
   
   # 安装项目依赖
   npm install

3. 配置环境变量

   # 复制环境变量示例文件
   cp .example.env .env
   
   # 编辑 .env 文件
   vi .env

配置以下关键参数：

• PORT：应用运行的端口号（默认 3000）
• MONGODB_URI：MongoDB 连接字符串
  • 格式：mongodb://admin:password@mongodb:27017/deviceStats?authSource=admin
• SECRET：API 认证密钥

4. 启动应用

   项目提供多种启动方式，推荐使用 PM2 以守护进程运行：

   # 推荐：使用 PM2 启动（进程守护）
   npm run pm2
   
   # 使用 PM2 但不作为守护进程
   npm run pm2-no-daemon
   
   # 开发/测试：直接使用 Node.js 启动
   npm run test
   # 或
   node index.js

⚠️ 确保防火墙或安全组已开放 PORT 中设置的端口

5. 完成部署

   ➡️ 继续进行 部署后配置

---

部署后配置

测试后端应用

访问后端服务地址：

• 服务器部署：http://your-server-ip:3000

💡 提示：生产环境建议配合反向代理（Nginx/Caddy）使用

API 接入前端应用

⚠️ 重要：API 端点无法直接在浏览器中打开，需要通过前端组件进行访问

服务	地址	配置说明
API	http://localhost:3000/api	填入前端环境变量 ⚠️ 必须保留 /api 后缀
Admin	http://localhost:3000/admin	✅ 无需额外配置

📚 点击这里部署前端 前端配置文档

💡 如需使用在线管理后台，请访问 在线配置工具

---