New Docker Quick Start#18
Conversation
Summary of ChangesHello @Harry-Yu-Shuhang, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed! This pull request significantly enhances the project's documentation by integrating Docker as a primary quick-start option and overhauling the Docker deployment guide. The changes aim to simplify the setup process for new users, particularly those unfamiliar with command-line Docker, by providing a comprehensive, step-by-step guide for Docker Desktop, alongside practical advice for common issues like network access in certain regions. Highlights
Using Gemini Code AssistThe full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips. Invoking Gemini You can request assistance from Gemini at any point by creating a comment using either
Customization To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a Limitations & Feedback Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here. You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension. Footnotes
|
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Code Review
您好，感谢您为改善 Docker 快速启动文档所做的贡献。新的面向初学者的 Docker Desktop 指南写得非常清晰易懂，这是一个很棒的改进。
我的反馈主要集中在 docs/user-guide/backend/docker.md 文件上。在重构文档以方便新用户的同时，一些对高级用户至关重要的信息（如命令行部署指令）以及所有用户都应了解的系统要求（如 GPU 支持、镜像大小）被意外移除了。我提供了一些具体的建议来补充这些缺失的内容，以确保文档的完整性，能够服务于所有不同技术水平的用户。
除此之外，还有一些小的拼写和格式建议，以提高文档的专业性。请查看具体的评论。谢谢！
| import TabItem from '@theme/TabItem'; | ||
|
|
||
| # Docker 部署 | ||
|
|
There was a problem hiding this comment.
您好，这次更新移除了旧文档中的“使用须知”和“预装模型说明”部分，其中包含了一些关键信息，例如：
- 镜像体积
- 对 NVIDIA GPU 的要求及 NVIDIA Container Toolkit
- 远程部署时需要 HTTPS
- 默认预装的模型以及如何包含可选模型
这些信息对于用户评估硬件需求、环境配置和功能选择至关重要，即使是使用 Docker Desktop 的用户也需要了解。建议在文档开头位置重新加入一个“部署要求”或“注意事项”部分，以确保用户能够顺利部署。
docs/user-guide/backend/docker.md
Outdated
| - 首次启动时，Docker Desktop 会要求您登录 Docker Hub 账号。如果您没有账号，需要先注册一个。 | ||
|
|
||
| 5. 访问 `localhost:12393` 进行测试 | ||
| ## 使用终端命令 No newline at end of file |
There was a problem hiding this comment.
您好，感谢您更新 Docker 文档。新的 Docker Desktop 指南写得非常清晰。不过，我注意到 ## 使用终端命令 部分目前是空的，并且之前版本中关于 docker build 和 docker run 的命令行指令被移除了。这部分内容对于习惯使用命令行的用户来说非常重要，建议您将这部分内容补充完整，以便所有用户都能找到适合自己的部署方式。
docs/user-guide/backend/docker.md
Outdated
| :::danger | ||
| 由于重构幅度较大，Docker 镜像暂时还没有更新到 `v1.0.0` 版本，但是很快会更新。 | ||
| :::info 关于安装方式的说明 | ||
| 目前有两种安装方式，如果您是小白，推荐您[使用Docker DeskTop](#使用docker-desktop)。如果您对Docker比较熟悉，也可以[使用终端命令](#使用终端命令)。 |
There was a problem hiding this comment.
这里有一个小的拼写建议，DeskTop 应该是 Desktop。
| 目前有两种安装方式，如果您是小白，推荐您[使用Docker DeskTop](#使用docker-desktop)。如果您对Docker比较熟悉，也可以[使用终端命令](#使用终端命令)。 | |
| 目前有两种安装方式，如果您是小白，推荐您[使用Docker Desktop](#使用docker-desktop)。如果您对Docker比较熟悉，也可以[使用终端命令](#使用终端命令)。 |
docs/user-guide/backend/docker.md
Outdated
| :::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)。 |
There was a problem hiding this comment.
为了与文档其他部分保持一致，建议将 docker hub 和 docker镜像 中的 docker 大写为 Docker，即 Docker Hub 和 Docker镜像。
| 我们在 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 -> 3rd
Change the relative path to an absolute path
For easier import in English docker readme.
Update slidebar position to new version.
Not absolute path
|
Finished. Looking forward to making OLV easier to use with docker. |
|
Also this PR in main repo. Docker merge to main (not dev) branch |
Add a new developer-facing guide for local Docker image builds (single-architecture) in docs/development-guide/backend/docker.mdx and its English i18n counterpart. The guide explains environment requirements, build and run commands, and cleanup steps for local debugging without using docker buildx. Also update user-guide/backend/docker.md and its English i18n file to reference the new local build guide.
|
? 我居然没 review 过这个 pr? 怎么可能？我记忆错乱了？ |
📝 WalkthroughWalkthroughThis pull request introduces comprehensive Docker documentation for the Open-LLM-VTuber project, adds a Docker quick-start section to the main documentation, substantially reorganizes the Docker deployment user guide, and updates sidebar navigation positions across multiple backend documentation files to reflect the new content hierarchy. Changes
Estimated code review effort🎯 3 (Moderate) | ⏱️ ~20 minutes Poem
🚥 Pre-merge checks | ✅ 3✅ Passed checks (3 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing touches🧪 Generate unit tests (beta)
Tip Issue Planner is now in beta. Read the docs and try it out! Share your feedback on Discord. Comment |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 5
🤖 Fix all issues with AI agents
In `@docs/quick-start.md`:
- Around line 76-82: The Markdown table in docs/quick-start.md inside the
:::note block is missing required blank lines which breaks rendering; add a
blank line before the table header and a blank line after the table end (and
ensure there's a blank line between the :::note opening and the table and
between the table and ::: note closing) so the table renders correctly in
Markdown processors—update the note block containing the platform table
accordingly.
In `@docs/user-guide/backend/docker.md`:
- Around line 209-210: The README uses the ambiguous placeholder `cd
OLV-Docker-Config\Path`; replace it with an explicit instruction: tell users to
change `OLV-Docker-Config\Path` to the actual directory name (e.g.,
`OLV-Docker-Config` or `OLV-Docker-Config/subdir`) and prefer a clear example
using a real folder name or variable like `<your-config-path>` so the `cd`
command (`cd OLV-Docker-Config\Path`) is unambiguous; ensure you mention
platform-specific path separators if relevant.
In `@i18n/en/docusaurus-plugin-content-docs/current/quick-start.md`:
- Around line 68-74: The Markdown table inside the :::note block is missing the
required blank lines before and after the table which breaks MD058; update the
quick-start note by inserting a blank line immediately before the table and
another blank line immediately after the table (i.e., add an empty line between
the ":::note ..." opener and the "| Platform ..." line, and an empty line
between the table's closing row and the ":::" closing marker) so the table
conforms to Markdown standards and renders correctly.
In `@i18n/en/docusaurus-plugin-content-docs/current/user-guide/backend/docker.md`:
- Around line 209-210: The command `cd OLV-Docker-Config\Path` is ambiguous
because `\Path` is a placeholder; update the text in docker.md to show a clear,
real example and indicate it must be replaced by the user's actual directory
(e.g., `cd OLV-Docker-Config` or `cd OLV-Docker-Config\my-config-folder`), or
explicitly add a note like "replace `<PATH>` with your config directory" so
readers know to substitute their directory name (locate the string `cd
OLV-Docker-Config\Path` and replace or annotate it accordingly).
- Line 29: Update the GitHub URL referenced in the markdown link text (the
string "https://github.com/Open-LLM-Vtuber/OLV-Docker-Config") to the correct
repository casing "https://github.com/Open-LLM-VTuber/OLV-Docker-Config" so the
link points to Open-LLM-VTuber/OLV-Docker-Config (note capital 'V' in VTuber) in
the file where the markdown link appears.
🧹 Nitpick comments (3)
i18n/en/docusaurus-plugin-content-docs/current/user-guide/backend/docker.md (1)
33-33: Consider adding alt text to images for accessibility.Several images are missing alternative text, which impacts accessibility for users with screen readers. While Docusaurus may handle this differently, it's good practice to include descriptive alt text.
Also applies to: 76-76, 78-78, 120-120, 122-122, 130-130, 168-168, 171-171, 175-175, 178-178
docs/user-guide/backend/docker.md (2)
124-126: Add language specification to code block.The code block is missing a language identifier. Adding
textor an appropriate language identifier improves syntax highlighting and clarity.📝 Proposed fix
-``` +```text openllmvtuber/open-llm-vtuber:latest</details> --- `33-33`: **Consider adding alt text to images for accessibility.** Several images are missing alternative text, which impacts accessibility for users with screen readers. While this is flagged as a minor issue, it's good practice to include descriptive alt text for all images. Also applies to: 76-76, 167-167, 170-170, 175-175, 178-178 </blockquote></details> </blockquote></details> <!-- This is an auto-generated comment by CodeRabbit for review status -->
| cd OLV-Docker-Config\Path | ||
| ``` |
There was a problem hiding this comment.
Clarify placeholder path for users.
The command cd OLV-Docker-Config\Path contains \Path which appears to be a placeholder. Users might be confused about what this should be replaced with. Consider making this more explicit or using the actual directory name.
💡 建议的修正
-cd OLV-Docker-Config\Path
+cd OLV-Docker-Config或者如果需要进入子目录：
-cd OLV-Docker-Config\Path
+cd OLV-Docker-Config # 进入下载的配置文件目录📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| cd OLV-Docker-Config\Path | |
| ``` | |
| cd OLV-Docker-Config |
🤖 Prompt for AI Agents
In `@docs/user-guide/backend/docker.md` around lines 209 - 210, The README uses
the ambiguous placeholder `cd OLV-Docker-Config\Path`; replace it with an
explicit instruction: tell users to change `OLV-Docker-Config\Path` to the
actual directory name (e.g., `OLV-Docker-Config` or `OLV-Docker-Config/subdir`)
and prefer a clear example using a real folder name or variable like
`<your-config-path>` so the `cd` command (`cd OLV-Docker-Config\Path`) is
unambiguous; ensure you mention platform-specific path separators if relevant.
There was a problem hiding this comment.
我觉得 AI 这里说的挺有道理。你这里写的是什么意思呢？为什么后面会有个 \Path?
There was a problem hiding this comment.
🧩 Analysis chain
@t41372 让我帮忙查看一下 OLV-Docker-Config 仓库的结构，看看这个 \Path 是否是一个实际存在的子目录，还是一个占位符错误。
🏁 Script executed:
#!/bin/bash
# Clone the OLV-Docker-Config repository to check its structure
git clone https://github.com/Open-LLM-VTuber/OLV-Docker-Config /tmp/olv-docker-config 2>&1
# List the directory structure
echo "=== Directory structure of OLV-Docker-Config ==="
tree -L 2 /tmp/olv-docker-config || find /tmp/olv-docker-config -maxdepth 2 -type f -o -type d
# Check if docker-compose.yml exists and where
echo -e "\n=== Location of docker-compose.yml ==="
find /tmp/olv-docker-config -name "docker-compose.yml" -o -name "docker-compose.yaml"
Length of output: 1251
@t41372 我查看了 OLV-Docker-Config 仓库的结构，发现 docker-compose.yml 文件就在仓库的根目录下，并没有名为 Path 的子目录。
仓库结构如下：
OLV-Docker-Config/
├── docker-compose.yml ← 在根目录
├── conf.yaml
├── avatars/
├── backgrounds/
├── characters/
├── config_templates/
├── live2d-models/
└── model_dict.json
所以这里的 cd OLV-Docker-Config\Path 中的 \Path 确实是一个错误或者未删除的占位符。正确的命令应该是：
cd OLV-Docker-ConfigCodeRabbit 的建议是正确的。建议 @Harry-Yu-Shuhang 修改第 209 行，将命令改为：
cd OLV-Docker-Config或者如果想更明确，可以加上注释：
cd OLV-Docker-Config # 进入下载的配置文件目录
i18n/en/docusaurus-plugin-content-docs/current/user-guide/backend/docker.md
Show resolved
Hide resolved
| cd OLV-Docker-Config\Path | ||
| ``` |
There was a problem hiding this comment.
Clarify placeholder path for users.
The command cd OLV-Docker-Config\Path contains \Path which appears to be a placeholder. Users might be confused about what this should be replaced with. Consider making this more explicit or using the actual directory name.
💡 Suggested clarification
-cd OLV-Docker-Config\Path
+cd OLV-Docker-ConfigOr if a subdirectory is intended:
-cd OLV-Docker-Config\Path
+cd OLV-Docker-Config # Navigate to the downloaded configuration directory📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| cd OLV-Docker-Config\Path | |
| ``` | |
| cd OLV-Docker-Config |
🤖 Prompt for AI Agents
In `@i18n/en/docusaurus-plugin-content-docs/current/user-guide/backend/docker.md`
around lines 209 - 210, The command `cd OLV-Docker-Config\Path` is ambiguous
because `\Path` is a placeholder; update the text in docker.md to show a clear,
real example and indicate it must be replaced by the user's actual directory
(e.g., `cd OLV-Docker-Config` or `cd OLV-Docker-Config\my-config-folder`), or
explicitly add a note like "replace `<PATH>` with your config directory" so
readers know to substitute their directory name (locate the string `cd
OLV-Docker-Config\Path` and replace or annotate it accordingly).
t41372
left a comment
t41372
left a comment
There was a problem hiding this comment.
从这个 AI code review 里的 path 问题开始，我简单重新阅读了一下这个 docker 文档，然后我意识到这整个文档写的相当一言难尽...
你不觉得这个文档假定的目标用户相当奇怪吗？写文档必须要考虑的就是目标受众，受众预期之类的不是吗？到底是什么样的人会看我们的文档，他们能否以最快速度，最准确的了解到我们尝试传达的信息？
其实来看 docker 页面的就两种人，一种是我们这种原本就懂 docker 的。一种是什么都不懂，quick start 页面看了你的推荐进来的纯小白。
对于原本就懂的，这些人电脑里几乎肯定有 docker，就算没有，也不用 (且也不该) 看我们的文档来学怎么安装 docker。这个文档几乎把这群人关注的重点和垃圾信息混在了一起。实际上这些人只需要知道三件事: 1. 下载 config。2. 看看 conf.yaml 设置项。3. docker compose up -d，完事。会主动来看 docker 文档的人 (还有期待我们做 docker 支持的人) 几乎都是这样的人。结果我们强迫他们读一堆奇奇怪怪的东西，然后从文档中提取出并不完整的，一共就几行字的核心信息...
看你 quick start 推荐来的小白，docker 真的是最简单的部署方式吗？仔细看了一下，文档中似乎没有提到镜像源，我感觉我可以预见这个文档出去之后像洪水一般的和某个墙相关的问题了... 对于 linux 用户，我们还得单独提到 nvidia container toolket 的事。我们 v1 的 docker 实现问题其实一直都很多，比如换 asr / tts 非常困难之类的。说不定我是错的 (如果我错了，请纠正)，但我不完全认为对连 docker 都没安装的小白，是 v1 最简单的部署方式。
其实我们的 docker 版本问题很多，不是吗？比如里面包含的 asr tts 模型，比如支持的奇奇怪怪的东西之类的。docker 版本能用的功能实际上是 OLV 全部功能的子集，而且还有诸如 GPU 加速，更新，配置文件等等问题。我们真的应该给小白推荐 docker 部署吗？我是持怀疑态度的，但或许我有考虑不周的点。
另外还有很多细节，我就不一个一个写了。我之后来改吧。这些东西解释起来比我自己重写一遍更累(
这样的文档不能合并。我们可能有不少类似水平的，存在奇奇怪怪问题的文档页面，但我希望避免这么快的往里面堆屎。
| cd OLV-Docker-Config\Path | ||
| ``` |
There was a problem hiding this comment.
我觉得 AI 这里说的挺有道理。你这里写的是什么意思呢？为什么后面会有个 \Path?
2 participants
Update Docker in quick start, which is the easiest way for beginners.
Summary by CodeRabbit