Skip to content
Open
Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
32 commits
Select commit Hold shift + click to select a range
32ff45f
Docker Init
Harry-Yu-Shuhang Sep 21, 2025
ad8a480
TO Run Docker Image Part
Harry-Yu-Shuhang Sep 21, 2025
0b0e1bf
Remind user to modify conf.yaml before start
Harry-Yu-Shuhang Sep 21, 2025
7fd6abb
Update docker.md
Harry-Yu-Shuhang Sep 24, 2025
bd3a80e
魔法上网更新
Harry-Yu-Shuhang Oct 12, 2025
98cfdb6
Merge branch 'Open-LLM-VTuber:main' into main
Harry-Yu-Shuhang Nov 18, 2025
2c7e0ca
sildebar position adjust
Harry-Yu-Shuhang Nov 23, 2025
a01a650
Merge branch 'main' of https://github.com/Harry-Yu-Shuhang/open-llm-v…
Harry-Yu-Shuhang Nov 23, 2025
a62d345
add conf download
Harry-Yu-Shuhang Nov 26, 2025
59cc4e7
docker顺序更改
Harry-Yu-Shuhang Nov 29, 2025
d1dbf80
update to new docker file readme
Harry-Yu-Shuhang Dec 30, 2025
0209163
Add update docker Chinese
Harry-Yu-Shuhang Dec 30, 2025
583e3fc
Update docker.md
Harry-Yu-Shuhang Dec 31, 2025
a66b469
add llm config
Harry-Yu-Shuhang Jan 3, 2026
9a99e6b
More precise description
Harry-Yu-Shuhang Jan 4, 2026
5d9ef71
Update docker.md
Harry-Yu-Shuhang Jan 12, 2026
84cbe5d
Update docker.md
Harry-Yu-Shuhang Jan 12, 2026
d82032d
Update docker terminal
Harry-Yu-Shuhang Jan 12, 2026
4bd5c66
Update docker.md
Harry-Yu-Shuhang Jan 15, 2026
5343d98
Update docker.md
Harry-Yu-Shuhang Jan 15, 2026
e7a2c8a
Revert English docker
Harry-Yu-Shuhang Jan 15, 2026
8b59ab7
File path improve
Harry-Yu-Shuhang Jan 16, 2026
ded1cc1
Move docker image to static folder
Harry-Yu-Shuhang Jan 16, 2026
a6f32da
English Readme slidebar change
Harry-Yu-Shuhang Jan 16, 2026
699916b
English Readme Finish
Harry-Yu-Shuhang Jan 16, 2026
aa27f77
Change file path to relative path
Harry-Yu-Shuhang Jan 16, 2026
2079261
Add Docker Update Readme
Harry-Yu-Shuhang Jan 16, 2026
ba31efe
Add Docker local build guide and links
t41372 Feb 8, 2026
68e76bd
Merge branch 'main' into main
t41372 Feb 11, 2026
96e6b02
Delete unnecessary \Path
Harry-Yu-Shuhang Feb 25, 2026
34f6497
Merge branch 'main' of https://github.com/Harry-Yu-Shuhang/open-llm-v…
Harry-Yu-Shuhang Feb 25, 2026
c2db1cd
删除多余的括号
Harry-Yu-Shuhang Feb 25, 2026
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 14 additions & 0 deletions docs/quick-start.md
Original file line number Diff line number Diff line change
Expand Up @@ -63,6 +63,20 @@ Groq Whisper API、OpenAI API 等国外大模型/推理平台 API 一般无法

对于本快速开始文档选择的组件,你需要一个速度正常的 CPU (ASR),一个 Ollama 支持的 GPU (LLM),以及网路链接 (TTS)。

## Docker快速启动

:::info 说明
Docker是**最适合小白**的部署方式,它可以一键部署所有组件,无需手动配置。
:::

:::warning 中国大陆网络提示
中国大陆地区拉取镜像时可能会遇到网络问题(包括 Docker Hub 访问缓慢或 DNS 解析异常)。
如果遇到拉取失败/速度极慢,建议参考[这个镜像汇总仓库](https://github.com/dongyubin/DockerHub?tab=readme-ov-file)寻找可用镜像源与配置方法。
:::

如果你对 Docker 感兴趣,请移步[Docker 部署指南](/docs/user-guide/backend/docker.md)。

如果不感兴趣,您也可以跳转到常规配置方法,从下一步,也就是[环境准备](#环境准备)步骤开始。

## 环境准备

Expand Down
77 changes: 41 additions & 36 deletions docs/user-guide/backend/docker.md
Original file line number Diff line number Diff line change
@@ -1,56 +1,61 @@
---
sidebar_position: 8
sidebar_position: 2
Comment thread
Harry-Yu-Shuhang marked this conversation as resolved.
Outdated
---

import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';

# Docker 部署

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

high

您好,这次更新移除了旧文档中的“使用须知”和“预装模型说明”部分,其中包含了一些关键信息,例如:

  • 镜像体积
  • 对 NVIDIA GPU 的要求及 NVIDIA Container Toolkit
  • 远程部署时需要 HTTPS
  • 默认预装的模型以及如何包含可选模型

这些信息对于用户评估硬件需求、环境配置和功能选择至关重要,即使是使用 Docker Desktop 的用户也需要了解。建议在文档开头位置重新加入一个“部署要求”或“注意事项”部分,以确保用户能够顺利部署。

:::danger
由于重构幅度较大,Docker 镜像暂时还没有更新到 `v1.0.0` 版本,但是很快会更新
:::info 关于安装方式的说明
目前有两种安装方式,如果您是小白,推荐您[使用Docker DeskTop](#使用docker-desktop)。如果您对Docker比较熟悉,也可以[使用终端命令](#使用终端命令)
Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

medium

这里有一个小的拼写建议,DeskTop 应该是 Desktop

Suggested change
目前有两种安装方式,如果您是小白,推荐您[使用Docker DeskTop](#使用docker-desktop)。如果您对Docker比较熟悉,也可以[使用终端命令](#使用终端命令)
目前有两种安装方式,如果您是小白,推荐您[使用Docker Desktop](#使用docker-desktop)。如果您对Docker比较熟悉,也可以[使用终端命令](#使用终端命令)

:::

:::warning
⚠️ 请注意:此功能目前处于实验阶段,但在大多数情况下可以正常工作
:::note
我们在 docker hub 成立了[openllmvtuber团队](https://hub.docker.com/orgs/openllmvtuber/members),目前docker镜像由[@Harry_Y](https://github.com/Harry-Yu-Shuhang)维护。如果docker镜像有问题,可以联系他(邮箱: yushuhang@163.com)
Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

medium

为了与文档其他部分保持一致,建议将 docker hubdocker镜像 中的 docker 大写为 Docker,即 Docker HubDocker镜像

Suggested change
我们在 docker hub 成立了[openllmvtuber团队](https://hub.docker.com/orgs/openllmvtuber/members)目前docker镜像由[@Harry_Y](https://github.com/Harry-Yu-Shuhang)维护。如果docker镜像有问题,可以联系他(邮箱: yushuhang@163.com)。
我们在 Docker Hub 成立了[openllmvtuber团队](https://hub.docker.com/orgs/openllmvtuber/members)目前Docker镜像由[@Harry_Y](https://github.com/Harry-Yu-Shuhang)维护。如果Docker镜像有问题,可以联系他(邮箱: yushuhang@163.com)。

:::

您可以选择自行构建 Docker 镜像,或者直接从 Docker Hub 拉取已构建的镜像:[![](https://img.shields.io/badge/t41372%2FOpen--LLM--VTuber-%25230db7ed.svg?logo=docker&logoColor=blue&labelColor=white&color=blue)](https://hub.docker.com/r/t41372/open-llm-vtuber)
## 使用Docker Desktop

### 下载 Docker Desktop

## 使用须知
- 访问 [Docker Desktop 下载页面](https://www.docker.com/products/docker-desktop)。
- 点击 "Download Docker Desktop"
![alt text](./docker_img/download_docker_desktop.png)
- 根据电脑类型选择对应版本

- Docker 镜像体积较大(约 13GB),且某些可选模型在使用时需要额外下载,会占用更多存储空间
- 仅支持 NVIDIA GPU 的设备
- 需要安装并配置 [NVIDIA Container Toolkit](https://docs.nvidia.com/datacenter/cloud-native/container-toolkit/latest/install-guide.html) 以支持 GPU 直通
- 目前存在的问题:容器停止后部分模型需要重新下载(该问题将在后续版本修复)
- 不建议在 ARM 架构的设备上构建镜像,因为依赖项 gRPC 可能会出现构建失败的情况([相关 issue](https://github.com/grpc/grpc/issues/34998))
- 如需在远程服务器上运行,必须配置 HTTPS。这是因为前端网页的麦克风/摄像头/屏幕录制功能只能在安全上下文(localhost 或 HTTPS 环境)中使用
:::tip 如何选择适用于自己电脑的版本
- **Mac Apple Silicon** → 新款 Mac (M1/M2/M3 芯片)
- **Mac Intel Chip** → 老款 Mac (Intel 处理器)
- **Windows AMD64** → 大部分 Windows 电脑 (Intel/AMD 64 位)
- **Windows ARM64** → 少见,仅 ARM 架构 Windows (如 Surface Pro X)
:::

## 预装模型说明
如果您还不确定,可以按如下方法查看系统设置:

默认镜像已预装大部分语音识别(ASR)和文本转语音(TTS)模型。但考虑到体积因素(约 8GB,会使总体积增加到 25GB)和性能表现,默认构建不包含以下模型:
- Bark TTS
- 原版 OpenAI Whisper(注意:这里指的是 Whisper,而非 WhisperCPP)
<Tabs groupId="operating-systems">
<TabItem value="windows" label="Windows">

如需在镜像中包含这些模型,请在构建时添加参数:
```bash
--build-arg INSTALL_ORIGINAL_WHISPER=true --build-arg INSTALL_BARK=true
```
1. 右键 **此电脑 → 属性**
2. 在 **系统类型** 一栏查看:
- “基于 x64 的处理器” → 选择 **Windows AMD64**
- “基于 ARM 的处理器” → 选择 **Windows ARM64**

## 部署步骤
</TabItem>
<TabItem value="macos" label="macOS">

1. 在构建镜像前,请先检查并调整 `conf.yaml` 配置文件(当前配置会被构建进镜像)
1. 点击屏幕左上角苹果图标 → **关于本机**
2. 在“芯片”一栏查看:
- 显示 **Apple M1/M2/M3** → 选择 **Mac Apple Silicon**
- 显示 **Intel** → 选择 **Mac Intel Chip**

2. 构建 Docker 镜像:
```bash
docker build -t open-llm-vtuber .
```
> 提示:构建过程可能需要较长时间
</TabItem>
</Tabs>

3. 准备 `conf.yaml` 配置文件
您可以从项目仓库获取,或直接通过此[链接](https://raw.githubusercontent.com/t41372/Open-LLM-VTuber/main/conf.yaml)下载
### 启动 Docker Desktop

4. 运行容器:
```bash
docker run -it --net=host --rm -v $(pwd)/conf.yaml:/app/conf.yaml -p 12393:12393 open-llm-vtuber
```
注意:请将 `$(pwd)/conf.yaml` 替换为您的配置文件实际路径
- 双击下载好的安装包,按照提示完成安装。
- 安装完成后,点击 Docker Desktop 图标启动 Docker。
- 首次启动时,Docker Desktop 会要求您登录 Docker Hub 账号。如果您没有账号,需要先注册一个。

5. 访问 `localhost:12393` 进行测试
## 使用终端命令
Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

high

您好,感谢您更新 Docker 文档。新的 Docker Desktop 指南写得非常清晰。不过,我注意到 ## 使用终端命令 部分目前是空的,并且之前版本中关于 docker builddocker run 的命令行指令被移除了。这部分内容对于习惯使用命令行的用户来说非常重要,建议您将这部分内容补充完整,以便所有用户都能找到适合自己的部署方式。

Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.