-
Notifications
You must be signed in to change notification settings - Fork 15
New Docker Quick Start #18
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: main
Are you sure you want to change the base?
Changes from 3 commits
32ff45f
ad8a480
0b0e1bf
7fd6abb
bd3a80e
98cfdb6
2c7e0ca
a01a650
a62d345
59cc4e7
d1dbf80
0209163
583e3fc
a66b469
9a99e6b
5d9ef71
84cbe5d
d82032d
4bd5c66
5343d98
e7a2c8a
8b59ab7
ded1cc1
a6f32da
699916b
aa27f77
2079261
ba31efe
68e76bd
96e6b02
34f6497
c2db1cd
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,56 +1,113 @@ | ||
| --- | ||
| sidebar_position: 8 | ||
| sidebar_position: 2 | ||
|
Harry-Yu-Shuhang marked this conversation as resolved.
Outdated
|
||
| --- | ||
|
|
||
| import Tabs from '@theme/Tabs'; | ||
| import TabItem from '@theme/TabItem'; | ||
|
|
||
| # Docker 部署 | ||
|
|
||
|
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. |
||
| :::danger | ||
| 由于重构幅度较大,Docker 镜像暂时还没有更新到 `v1.0.0` 版本,但是很快会更新。 | ||
| :::info 开始之前 | ||
| 请修改您的配置文件(conf.yaml),将 | ||
|
|
||
| ```yaml | ||
| 'system_config': | ||
| 'host': '127.0.0.1' | ||
| ``` | ||
|
|
||
| 的**host改为0.0.0.0** | ||
|
|
||
| 的host改成 | ||
|
Harry-Yu-Shuhang marked this conversation as resolved.
Outdated
|
||
| ::: | ||
| :::tip 关于安装方式 | ||
| 目前支持两种方式。 | ||
| - 如果您是小白,推荐您[使用Docker DeskTop](#使用docker-desktop)。 | ||
| - 如果您对Docker比较熟悉,也可以[使用终端命令](#使用终端命令)。 | ||
| ::: | ||
|
|
||
| :::caution 关于GPU支持 | ||
| 目前**仅支持CPU和Nvidia GPU**, 且GPU需要配置好Nvidia驱动, 如果还没配置好, 请[**点击这里查看配置攻略**](../../quick-start.md#nvidia-gpu-支持)。 | ||
|
|
||
| 如果您不打算使用GPU,而是**调用api**(这也是**绝大多数用户体验最好的方式**),或者使用CPU,可以忽略此步。 | ||
| ::: | ||
|
|
||
| :::warning | ||
| ⚠️ 请注意:此功能目前处于实验阶段,但在大多数情况下可以正常工作。 | ||
| :::note 关于我们的docker团队 | ||
| 我们在 docker hub 成立了[openllmvtuber团队](https://hub.docker.com/orgs/openllmvtuber/members),目前docker镜像由[@Harry_Y](https://github.com/Harry-Yu-Shuhang)维护。 | ||
| ::: | ||
|
Harry-Yu-Shuhang marked this conversation as resolved.
|
||
|
|
||
| 您可以选择自行构建 Docker 镜像,或者直接从 Docker Hub 拉取已构建的镜像:[](https://hub.docker.com/r/t41372/open-llm-vtuber) | ||
| ## 使用 Docker Desktop 安装 | ||
|
|
||
| ## 使用须知 | ||
| ### 下载 Docker Desktop | ||
|
|
||
| - 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 环境)中使用 | ||
| 访问 [Docker Desktop 下载页面](https://www.docker.com/products/docker-desktop)。 | ||
|
|
||
| ## 预装模型说明 | ||
| 点击 "Download Docker Desktop" | ||
|
|
||
| 默认镜像已预装大部分语音识别(ASR)和文本转语音(TTS)模型。但考虑到体积因素(约 8GB,会使总体积增加到 25GB)和性能表现,默认构建不包含以下模型: | ||
| - Bark TTS | ||
| - 原版 OpenAI Whisper(注意:这里指的是 Whisper,而非 WhisperCPP) | ||
|  | ||
|
|
||
| 如需在镜像中包含这些模型,请在构建时添加参数: | ||
| ```bash | ||
| --build-arg INSTALL_ORIGINAL_WHISPER=true --build-arg INSTALL_BARK=true | ||
| ``` | ||
| 根据电脑类型选择对应版本 | ||
|
|
||
| ## 部署步骤 | ||
| :::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) | ||
| ::: | ||
|
|
||
| 1. 在构建镜像前,请先检查并调整 `conf.yaml` 配置文件(当前配置会被构建进镜像) | ||
| 如果您还不确定,可以按如下方法查看系统设置: | ||
|
|
||
| 2. 构建 Docker 镜像: | ||
| ```bash | ||
| docker build -t open-llm-vtuber . | ||
| ``` | ||
| > 提示:构建过程可能需要较长时间 | ||
| <Tabs groupId="operating-systems"> | ||
| <TabItem value="windows" label="Windows"> | ||
|
|
||
| 1. 右键 **此电脑 → 属性** | ||
| 2. 在 **系统类型** 一栏查看: | ||
| - “基于 x64 的处理器” → 选择 **Windows AMD64** | ||
| - “基于 ARM 的处理器” → 选择 **Windows ARM64** | ||
|
|
||
| </TabItem> | ||
| <TabItem value="macos" label="macOS"> | ||
|
|
||
| 1. 点击屏幕左上角苹果图标 → **关于本机** | ||
| 2. 在“芯片”一栏查看: | ||
| - 显示 **Apple M1/M2/M3** → 选择 **Mac Apple Silicon** | ||
| - 显示 **Intel** → 选择 **Mac Intel Chip** | ||
|
|
||
| </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 | ||
| 双击下载好的安装包,按照提示完成安装。 | ||
|
|
||
| 安装完成后,点击 Docker Desktop 图标启动 Docker。 | ||
|
|
||
| 首次启动时,Docker Desktop 会要求您登录 Docker Hub 账号。如果您没有账号,需要先注册一个。 | ||
|
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Docker Hub login requirement may be a blocker for users in China. Line 114 states that Docker Desktop requires a Docker Hub account on first launch. The PR discussion already highlights Docker registry/mirror issues specific to China. Consider adding a note that in regions where Docker Hub is inaccessible, users may need to configure a mirror or skip the login step, and link to any relevant registry mirror guidance. 🤖 Prompt for AI Agents |
||
|
|
||
| ### 获取 Docker 镜像 | ||
|
|
||
| 点击顶部菜单的 **Search** 图标(或使用快捷键 `Ctrl + K`(Windows)或者`Cmd + K`(MacOS))。 | ||
|
|
||
|  | ||
|
|
||
| 在搜索框中输入以下内容,搜索到以后点击右侧的**Pull**按钮。 | ||
|
|
||
| ``` | ||
| openllmvtuber/open-llm-vtuber:latest | ||
| ``` | ||
|
Harry-Yu-Shuhang marked this conversation as resolved.
|
||
| 注意:请将 `$(pwd)/conf.yaml` 替换为您的配置文件实际路径 | ||
|
|
||
| 5. 访问 `localhost:12393` 进行测试 | ||
|  | ||
|
|
||
| ### 运行 Docker 镜像 | ||
|
|
||
| 点击**Images**, 找到**openllmvtuber/open-llm-vtuber**, 点击右侧的运行按钮。 | ||
|  | ||
|
|
||
| ### 运行 Docker 容器 | ||
|
|
||
| 点开"Optional settings", 按照下图配置, | ||
|  | ||
|
|
||
| 然后等待,第一次拉取会比较慢。 | ||
|
|
||
|
|
||
| ## 使用终端命令安装 | ||
Uh oh!
There was an error while loading. Please reload this page.