Subvert

借助 OpenAI，可在几秒钟内为视频生成字幕、章节和摘要。

🚧 该项目目前仍处于开发阶段，如有问题请 提交 Issue 🚧

快速开始

你需要：

• 在本地机器上安装 Docker
• 一个 OpenAI API 密钥

Subvert 封装在一个独立的 Docker 镜像中，只需一行命令即可启动：

docker run -it -p 80:8080 -e OPENAI_API_KEY=sk-123abc aschmelyun/subvert

这将启动一个运行该应用的服务器，并使其可通过 http://localhost 在你的机器上访问。

工作原理

选择要处理的视频文件后，你可以决定是否同时生成章节和摘要。

你的视频会被上传到一个 API，使用 FFmpeg 提取音频，然后发送到 OpenAI 的 Whisper 模型 进行转录，输出为常见的 vtt 格式。

如果你选择了生成章节或摘要，该转录文本将进一步发送到 ChatGPT 模型，以你指定的长度生成简洁的章节，并生成一段适合 YouTube 描述的简短摘要。

配置

你可以通过在命令中添加额外的 -e 标志来传递 环境变量，从而调整容器中的几个参数。当前支持的环境变量如下：

• OPENAI_API_KEY (必需) - 设置用于与 OpenAI API 通信的密钥。无默认值。
• UPLOAD_MAX_FILESIZE - 修改 PHP 的 UPLOAD_MAX_FILESIZE 设置。默认值：256M
• MEMORY_LIMIT - 修改 PHP 的 MEMORY_LIMIT 设置。默认值：512M

从源码启动

如果你的本地机器已安装 PHP 8.1+ 和 npm，也可以直接从源代码启动应用程序。

首先，将此仓库克隆到你希望的位置。然后进入 src 目录并运行：

./startup.sh

你也可以单独执行 startup.sh 脚本中的每条命令，效果相同。

部署

由于该项目包含在一个 Dockerfile 中，因此可以立即部署到任何已预装 Docker 的服务器上。此外，Subvert 的 Docker 镜像也可以在 AWS、Azure、GCP、Fly.io 等云平台上运行。

注意：该镜像目前仅暴露不安全的 :80 HTTP 端口。

许可证

MIT 许可证 (MIT)。请参阅 许可证文件

Subvert 快速上手指南

Subvert 是一个利用 OpenAI 技术，能在数秒内为视频自动生成字幕、章节和摘要的开源工具。

环境准备

在开始之前，请确保你的本地机器满足以下条件：

• Docker: 已安装并正在运行（推荐最新稳定版）。
  • 国内用户可参考 Docker 官方中文文档 或使用国内镜像源加速安装。
• OpenAI API Key: 你需要拥有一个有效的 OpenAI API 密钥以调用 Whisper 和 ChatGPT 模型。
  • 获取地址：OpenAI API Keys

注意：本项目目前处于开发阶段（Work-in-Progress），如遇 Bug 请在 GitHub 仓库提交 Issue。

安装步骤

Subvert 被封装在单个 Docker 镜像中，无需复杂配置，只需一行命令即可启动服务。

在终端中执行以下命令（请将 sk-123abc 替换为你真实的 OpenAI API Key）：

docker run -it -p 80:8080 -e OPENAI_API_KEY=sk-123abc aschmelyun/subvert

参数说明：

• -p 80:8080: 将容器的 8080 端口映射到本地的 80 端口。
• -e OPENAI_API_KEY=...: 设置必要的环境变量，用于连接 OpenAI 服务。

启动成功后，服务将在本地运行。

基本使用

1. 访问界面：打开浏览器，访问 http://localhost。
2. 上传视频：在网页界面中选择你要处理的视频文件。
3. 选择功能：勾选是否需要生成“章节（Chapters）”和“摘要（Summary）”。
4. 开始处理：
   • 系统会自动提取音频并使用 OpenAI Whisper 模型生成标准 .vtt 格式字幕。
   • 若选择了章节或摘要，转录文本将进一步发送给 ChatGPT 模型，生成精简的章节标记和适合 YouTube 描述的简短摘要。
5. 下载结果：处理完成后，下载生成的字幕文件及相关元数据。

---

进阶配置（可选）

如果需要调整文件大小限制或内存限制，可以通过添加 -e 参数来覆盖默认值：

docker run -it -p 80:8080 \
  -e OPENAI_API_KEY=sk-123abc \
  -e UPLOAD_MAX_FILESIZE=512M \
  -e MEMORY_LIMIT=1G \
  aschmelyun/subvert

• UPLOAD_MAX_FILESIZE: 修改 PHP 上传文件大小限制（默认 256M）。
• MEMORY_LIMIT: 修改 PHP 内存限制（默认 512M）。