Skip to content

README.md

Latest commit

 

History

History
201 lines (129 loc) · 5.82 KB

README.md

File metadata and controls

201 lines (129 loc) · 5.82 KB

🚀 TeleBox Scripts

TeleBox 官方脚本仓库

帮你更快完成 TeleBox 安装、首次登录，以及后台运行，新手也能按步骤直接上手。

⚡ 立即开始 • 📦 脚本说明 • ❓ 常见问题 • 📚 相关链接

👋 这是什么？

这个仓库提供了 TeleBox 的一键安装脚本，适合想快速部署 TeleBox 的用户使用。

如果你不想手动执行一长串命令，而是希望：

  • 自动准备依赖环境
  • 自动下载 TeleBox
  • 自动安装项目依赖
  • 按提示完成 Telegram 登录
  • 安装完成后按需选择是否启用后台运行

那你直接使用这里的脚本即可。

✅ 使用前准备

开始前请先确认：

  1. 你有一台 Linux 主机
  2. 网络可以访问 GitHub、Telegram 和 NodeSource
  3. 你已经准备好 Telegram 的 api_id 和 api_hash
  4. 至少有 512MB RAM 和 1GB 可用空间

Telegram API 申请地址：https://my.telegram.org/auth?to=apps

如果你无法申请自己的 Telegram API，可以使用 https://t.me/TeleBox_API 频道中的 API

🚀 快速开始

方式一：安装到本机（推荐大多数用户）

适合：

  • Debian / Ubuntu 服务器
  • 想直接把 TeleBox 安装到当前系统中
  • 想自己查看目录、手动管理文件
wget https://raw.githubusercontent.com/TeleBoxOrg/TeleBox_Scripts/refs/heads/main/Install/telebox.sh -O telebox.sh && chmod +x telebox.sh && bash telebox.sh

方式二：安装到 Docker 容器

适合：

  • 你知道如何熟练使用与维护 Docker 容器
  • 想把 TeleBox 和系统环境隔离开
  • 想用容器方式部署和迁移
wget https://raw.githubusercontent.com/TeleBoxOrg/TeleBox_Scripts/refs/heads/main/Install/docker_telebox.sh -O docker_telebox.sh && chmod +x docker_telebox.sh && bash docker_telebox.sh

📦 脚本说明

Install/telebox.sh

本地安装脚本，当前基于 Debian / Ubuntu 的 apt 流程。

它会自动完成：

  1. 安装基础依赖：curl、git、build-essential、screen
  2. 安装 Node.js 24.x
  3. 克隆官方仓库 https://github.com/TeleBoxOrg/TeleBox.git
  4. 执行 npm install
  5. 启动 npm start，进入首次登录流程

Install/docker_telebox.sh

Docker 安装脚本，适合想用容器部署的用户。

它会分两阶段完成：

  1. 启动交互式容器，完成首次登录
  2. 登录完成后会提示你是否立即启用 推荐的 PM2 后台运行

🧭 安装后会发生什么？

无论你使用哪种方式，首次安装的核心流程基本一致：

  1. 准备系统依赖
  2. 安装 Node.js 24.x
  3. 下载 TeleBox 主仓库
  4. 安装项目依赖
  5. 首次运行 npm start
  6. 填写 api_id 和 api_hash
  7. 选择以下任意一种登录方式：
    • 二维码登录：在 Telegram 客户端中扫码登录
    • 手机号登录：依次输入手机号、验证码，以及两步验证密码（如果开启了 2FA）

🔐 首次登录说明

首次启动时，脚本不会跳过官方登录流程。

你需要按提示完成：

  • 输入 Telegram api_id
  • 输入 Telegram api_hash
  • 选择 二维码登录 或 手机号登录
  • 如使用手机号登录，继续输入验证码与 2FA 密码（如已开启）

首次登录完成后，你可以根据脚本提示选择是否立即启用 PM2 后台运行。

💡 安装完成后的常用命令

PM2 后台运行

PM2 可以把 TeleBox 放到后台持续运行。简单理解就是：

  • 你关闭终端后，TeleBox 依然会继续运行
  • 你断开 SSH 连接后，TeleBox 不会马上停止
  • 后续查看状态、日志、重启都会更方便

安装脚本完成后会提示你是否立即启用 推荐的 PM2 后台运行。

如果你暂时不启用 PM2，那么这次启动的 TeleBox 不会长期常驻；关闭终端或退出当前会话后，它就不会继续运行。

如果你在安装时选择了跳过，之后仍然可以手动执行：

# 安装 PM2
npm install -g pm2

# 启动 TeleBox
cd ~/telebox && pm2 start "npm start" --name telebox && pm2 save

# 查看状态
pm2 status

# 查看日志
pm2 logs telebox

# 重启服务
pm2 restart telebox

# 停止服务
pm2 stop telebox

Docker 常用操作

Docker 版本安装完成后，常见操作包括：

# 查看日志
docker logs -f telebox

# 重启容器
docker restart telebox

# 停止容器
docker stop telebox

如果你在安装时自定义了容器名，请把上面的 telebox 替换成你自己的容器名。

❓ 常见问题

1. 为什么安装失败？

优先检查这几项：

  • 是否能正常访问 GitHub、Telegram、NodeSource
  • 是否为 Debian / Ubuntu（本机脚本）
  • 是否已经安装并可使用 Docker（Docker 脚本）
  • Node.js 是否成功安装为 24.x

2. 为什么启动后卡在登录？

这通常不是卡住，而是在等待你完成官方登录流程。请根据终端提示：

  • 输入 api_id / api_hash
  • 选择二维码登录或手机号登录
  • 按要求完成验证

3. Docker 版本和本机版本有什么区别？

  • 本机版本：直接安装到当前 Linux 系统，适合大多数普通用户
  • Docker 版本：运行在容器内，适合已经熟悉 Docker 或想隔离环境的用户

📚 相关链接

主仓库 安装指南 问题反馈