TeleBox 是基于 Node.js 与 TypeScript 构建的现代化 Telegram Bot 开发框架,提供强大的插件系统和丰富的功能模块。
📝 说明: 以下步骤适用于 Debian / Ubuntu 系统,其他发行版或 macOS 请根据平台调整包管理命令(如
yum/brew)。
💻 点击展开命令详情
# 🔄 更新系统包列表
sudo apt update
# 📦 安装必需的基础工具
sudo apt install -y curl git build-essential📋 安装组件说明:
curl- 用于下载 Node.js 安装脚本git- 版本控制工具,用于克隆项目build-essential- 编译工具链,用于构建原生模块
🚀 点击展开安装步骤
# 📥 下载并执行 Node.js 20.x 安装脚本
curl -fsSL https://deb.nodesource.com/setup_20.x | sudo -E bash -
# 📦 安装 Node.js 和 npm
sudo apt-get install -y nodejs本项目中已提供了 .nvmrc 文件,通常 Node.js 版本管理工具会自动识别并在当前工作区/运行目录切换到该版本。
✅ 验证安装:
node --version # 应显示 v20.x.x
npm --version # 应显示对应的 npm 版本📥 点击展开克隆步骤
# 📁 创建项目目录
mkdir -p ~/telebox
# 📂 进入项目目录
cd ~/telebox
# 🔄 克隆 TeleBox 项目
git clone https://github.com/TeleBoxDev/TeleBox.git .📋 目录结构:
~/telebox/
├── src/ # 源代码
├── plugins/ # 插件目录
├── package.json # 项目配置
└── README.md # 项目文档
⚡ 点击展开安装过程
# 📥 安装所有项目依赖
npm install🔄 安装过程说明:
- 自动下载并安装
package.json中定义的所有依赖 - 安装完成后生成
node_modules/目录
⏱️ 预计耗时: 2-5 分钟(取决于网络速度)
🔐 点击展开配置步骤
# 📂 确保在项目目录
cd ~/telebox
# 🚀 启动 TeleBox
npm start📝 配置流程:
-
🔑 API 凭据配置
需要填写:api_id 和 api_hash💡 从 my.telegram.org 获取 API 凭据
-
📱 选择登录方式
Use QR code login? [y/N]:- 输入
y使用二维码登录:在手机 Telegram 中扫描屏幕上的二维码 - 输入
N或直接回车使用手机号登录
- 输入
-
📱 手机号登录(如选择手机号登录)
Enter phone number (+86...): Enter the verification code: Enter 2FA password (if any):按顺序输入手机号、收到的验证码、密码(如开启两步验证)
-
✅ 登录成功确认
[INFO] - [Signed in successfully as xxx]🎉 看到此消息表示登录成功,按
CTRL+C停止
🔄 点击展开 PM2 部署步骤
📦 安装 PM2 进程管理器:
# 全局安装 PM2
npm install -g pm2🚀 启动 TeleBox 服务:
# 使用 PM2 启动服务
pm2 start "npm start" --name telebox
# 保存 PM2 配置
pm2 save
# 设置开机自启动
sudo pm2 startup systemd📊 监控和管理:
# 查看服务状态
pm2 status
# 查看运行日志
pm2 logs telebox
# 可选插件
## pm2-logrotate 日志管理及分割
pm2 install pm2-logrotate
# 🔄 重启服务
pm2 restart telebox
# 🛑 停止服务
pm2 stop telebox🎯 PM2 管理命令:
pm2 list- 📋 查看所有进程pm2 monit- 📊 实时监控面板pm2 reload telebox- 🔄 无缝重载pm2 delete telebox- 🗑️ 删除进程