Skip to content

Commit ba31efe

Browse files
committed
Add Docker local build guide and links
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.
1 parent 2079261 commit ba31efe

4 files changed

Lines changed: 119 additions & 0 deletions

File tree

Lines changed: 54 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,54 @@
1+
---
2+
sidebar_position: 2
3+
---
4+
5+
# Docker 本地构建指南
6+
7+
> 如果你想要的是使用我们提供的 docker 镜像部署 Open-LLM-VTuber 项目,可以看看 [Docker 部署](../../user-guide/backend/docker.md)
8+
9+
## 说明
10+
- 项目的多架构镜像构建与推送已由 GitHub Actions 自动完成。
11+
- 本文档仅用于开发者本地构建调试镜像,不使用 `docker buildx`
12+
13+
## 本地环境要求
14+
- 已安装 `git`
15+
- 已安装 Docker(建议 Docker Engine 24+ 或 Docker Desktop 最新稳定版)
16+
- 可选:已安装 Docker Compose 插件(仅在你需要 `docker compose` 时)
17+
- 建议预留至少 `10GB` 可用磁盘空间(首次构建会下载较多依赖)
18+
19+
可用以下命令自检:
20+
```
21+
git --version
22+
docker --version
23+
docker compose version
24+
```
25+
26+
## 获取代码
27+
```
28+
git clone https://github.com/Open-LLM-VTuber/Open-LLM-VTuber.git
29+
cd Open-LLM-VTuber
30+
```
31+
32+
## 本地构建镜像(单架构)
33+
在项目根目录执行:
34+
```
35+
docker build -t openllmvtuber/open-llm-vtuber:local -f dockerfile .
36+
```
37+
38+
如需自定义镜像名或标签,替换 `openllmvtuber/open-llm-vtuber:local` 即可。
39+
40+
## 可选:本地运行验证
41+
运行前请确认 `conf/conf.yaml` 已存在:
42+
```
43+
docker run --rm -it \
44+
-p 12393:12393 \
45+
-v "$(pwd)/conf:/app/conf" \
46+
-v "$(pwd)/models:/app/models" \
47+
openllmvtuber/open-llm-vtuber:local
48+
```
49+
50+
## 清理本地 Docker 数据
51+
```
52+
docker system prune -a --volumes
53+
```
54+

docs/user-guide/backend/docker.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,11 @@ import TabItem from '@theme/TabItem';
77

88
# Docker 部署
99

10+
> 关于本地构建 docker 镜像,参考 [Docker 本地构建指南](../../development-guide/backend/docker.mdx)
11+
12+
## 关于我们的docker团队
13+
我们在 docker hub 成立了[openllmvtuber团队](https://hub.docker.com/orgs/openllmvtuber/members),目前docker镜像由[@Harry_Y](https://github.com/Harry-Yu-Shuhang)维护。
14+
1015
## 下载配置文件
1116

1217
### git下载(适合有git基础的用户)
Lines changed: 54 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,54 @@
1+
---
2+
sidebar_position: 2
3+
---
4+
5+
# Docker Local Build Guide
6+
7+
> If you want to deploy Open-LLM-VTuber using our pre-built Docker images, see [Docker Deployment](../../user-guide/backend/docker.md)
8+
9+
## Notes
10+
- Multi-architecture image builds and pushes are automatically handled by GitHub Actions.
11+
- This document is only for developers who want to build debug images locally, without using `docker buildx`.
12+
13+
## Local Environment Requirements
14+
- `git` installed
15+
- Docker installed (Docker Engine 24+ or the latest stable Docker Desktop recommended)
16+
- Optional: Docker Compose plugin installed (only if you need `docker compose`)
17+
- At least `10GB` of free disk space recommended (first build downloads many dependencies)
18+
19+
You can verify your environment with these commands:
20+
```
21+
git --version
22+
docker --version
23+
docker compose version
24+
```
25+
26+
## Get the Code
27+
```
28+
git clone https://github.com/Open-LLM-VTuber/Open-LLM-VTuber.git
29+
cd Open-LLM-VTuber
30+
```
31+
32+
## Build Image Locally (Single Architecture)
33+
Run in the project root directory:
34+
```
35+
docker build -t openllmvtuber/open-llm-vtuber:local -f dockerfile .
36+
```
37+
38+
To customize the image name or tag, replace `openllmvtuber/open-llm-vtuber:local` as needed.
39+
40+
## Optional: Local Run Verification
41+
Before running, ensure `conf/conf.yaml` exists:
42+
```
43+
docker run --rm -it \
44+
-p 12393:12393 \
45+
-v "$(pwd)/conf:/app/conf" \
46+
-v "$(pwd)/models:/app/models" \
47+
openllmvtuber/open-llm-vtuber:local
48+
```
49+
50+
## Clean Up Local Docker Data
51+
```
52+
docker system prune -a --volumes
53+
```
54+

i18n/en/docusaurus-plugin-content-docs/current/user-guide/backend/docker.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,12 @@ import TabItem from '@theme/TabItem';
77

88
# Docker Deployment
99

10+
> For building Docker images locally, refer to the [Docker Local Build Guide](../../development-guide/backend/docker.mdx)
11+
12+
## About Our Docker Team
13+
We have established the [openllmvtuber team](https://hub.docker.com/orgs/openllmvtuber/members) on Docker Hub.
14+
The Docker images are currently maintained by [@Harry_Y](https://github.com/Harry-Yu-Shuhang).
15+
1016
## Download configuration files
1117

1218
### Git clone (for users familiar with git)

0 commit comments

Comments
 (0)