@@ -38,7 +38,7 @@ Migrated to `hexgrad/Kokoro-82M-v1.1-zh` with baseline adaptation based on the c
3838- [ 一条命令启动(预构建镜像) / One-command Start] ( #一条命令启动预构建镜像--one-command-start-prebuilt-image )
3939- [ 测试范围说明 / Testing Scope] ( #测试范围说明--testing-scope )
4040- [ 源码部署 / Source Deployment] ( #源码部署--source-deployment )
41- - [ 免源码部署入口 / No-source Deployment Entry ] ( #免源码部署入口--no-source-deployment-entry )
41+ - [ Unraid Docker Compose 部署 / Unraid Docker Compose Deployment ] ( #unraid-docker-compose-部署--unraid-docker-compose-deployment )
4242- [ 镜像标签策略 / Image Tagging Strategy] ( #镜像标签策略--image-tagging-strategy )
4343- [ 最小环境变量 / Minimal Environment Variables] ( #最小环境变量--minimal-environment-variables )
4444- [ 切换到 v1.0(英文模型) / Switch to v1.0] ( #切换到-v10英文模型--switch-to-v10 )
@@ -212,27 +212,13 @@ Follow the steps below. First-time deployment should work directly.
212212
213213> Tip: If you use M1/M2/M3 Mac, use ` docker/cpu` . The current GPU compose depends on CUDA and does not support Apple Silicon.
214214
215- # # 免源码部署入口 / No-source Deployment Entry
215+ # # Unraid Docker Compose 部署 / Unraid Docker Compose Deployment
216216
217- - 部署文档:` docs/deployment/unraid-and-prebuilt-images.md`
218- - Unraid / Compose Stack(GPU):` docker/unraid/stack.gpu.image.yml`
219- - Unraid / Compose Stack(CPU):` docker/unraid/stack.cpu.image.yml`
220- - Unraid CA 模板(统一 CPU/GPU):` unraid/templates/kokoro-fastapi-zh.xml`
217+ 下面是只用 Unraid 网页界面完成 Docker Compose/Stack 部署的方法。
221218
222219English:
223220
224- - Deployment guide: ` docs/deployment/unraid-and-prebuilt-images.md`
225- - Unraid / Compose Stack (GPU): ` docker/unraid/stack.gpu.image.yml`
226- - Unraid / Compose Stack (CPU): ` docker/unraid/stack.cpu.image.yml`
227- - Unraid CA template (unified CPU/GPU): ` unraid/templates/kokoro-fastapi-zh.xml`
228-
229- # ## Unraid 可视化 Docker Compose 部署(不需要编译源码)
230-
231- 下面是只用 Unraid 网页界面完成部署的方法。
232-
233- English:
234-
235- Below is a deployment method using only the Unraid web UI.
221+ Below is a Docker Compose/Stack deployment method using only the Unraid web UI.
236222
237223# ### 1) 前置条件
238224
@@ -272,33 +258,33 @@ English: Paste YAML (choose one)
272258name: kokoro-fastapi-zh-gpu
273259
274260services:
275- kokoro-fastapi:
276- image: ghcr.io/hsiang-han/kokoro-fastapi-zh-gpu:latest
277- container_name: kokoro-fastapi-zh-gpu
278- labels:
279- net.unraid.docker.icon: https://raw.githubusercontent.com/hsiang-han/Kokoro-FastAPI-zh/master/assets/unraid-icon.png
280- volumes:
281- - /mnt/user/appdata/kokoro-fastapi-zh/models:/app/api/src/models
282- - /mnt/user/appdata/kokoro-fastapi-zh/voices:/app/api/src/voices
283- ports:
284- - " 8880:8880"
285- environment:
286- - PYTHONPATH=/app:/app/api
287- - USE_GPU=true
288- - PYTHONUNBUFFERED=1
289- - REPO_ID=hexgrad/Kokoro-82M-v1.1-zh
290- - DEFAULT_VOICE=zf_094
291- - KOKORO_V1_FILE=v1_1_zh/kokoro-v1_1-zh.pth
292- - VOICES_DIR=/app/api/src/voices/v1_1_zh
293- - DEFAULT_VOICE_CODE=z
294- - API_LOG_LEVEL=DEBUG
295- deploy:
296- resources:
297- reservations:
298- devices:
299- - driver: nvidia
300- count: all
301- capabilities: [gpu]
261+ kokoro-fastapi:
262+ image: ghcr.io/hsiang-han/kokoro-fastapi-zh-gpu:latest
263+ container_name: kokoro-fastapi-zh-gpu
264+ labels:
265+ net.unraid.docker.icon: https://raw.githubusercontent.com/hsiang-han/Kokoro-FastAPI-zh/master/assets/unraid-icon.png
266+ volumes:
267+ - /mnt/user/appdata/kokoro-fastapi-zh/models:/app/api/src/models
268+ - /mnt/user/appdata/kokoro-fastapi-zh/voices:/app/api/src/voices
269+ ports:
270+ - " 8880:8880"
271+ environment:
272+ - PYTHONPATH=/app:/app/api
273+ - USE_GPU=true
274+ - PYTHONUNBUFFERED=1
275+ - REPO_ID=hexgrad/Kokoro-82M-v1.1-zh
276+ - DEFAULT_VOICE=zf_094
277+ - KOKORO_V1_FILE=v1_1_zh/kokoro-v1_1-zh.pth
278+ - VOICES_DIR=/app/api/src/voices/v1_1_zh
279+ - DEFAULT_VOICE_CODE=z
280+ - API_LOG_LEVEL=DEBUG
281+ deploy:
282+ resources:
283+ reservations:
284+ devices:
285+ - driver: nvidia
286+ count: all
287+ capabilities: [gpu]
302288` ` `
303289
304290** CPU**
@@ -307,34 +293,34 @@ services:
307293name: kokoro-fastapi-zh-cpu
308294
309295services:
310- kokoro-fastapi:
311- image: ghcr.io/hsiang-han/kokoro-fastapi-zh-cpu:latest
312- container_name: kokoro-fastapi-zh-cpu
313- labels:
314- net.unraid.docker.icon: https://raw.githubusercontent.com/hsiang-han/Kokoro-FastAPI-zh/master/assets/unraid-icon.png
315- volumes:
316- - /mnt/user/appdata/kokoro-fastapi-zh/models:/app/api/src/models
317- - /mnt/user/appdata/kokoro-fastapi-zh/voices:/app/api/src/voices
318- ports:
319- - " 8880:8880"
320- environment:
321- - PYTHONPATH=/app:/app/api
322- - USE_GPU=false
323- - PYTHONUNBUFFERED=1
324- - REPO_ID=hexgrad/Kokoro-82M-v1.1-zh
325- - DEFAULT_VOICE=zf_094
326- - KOKORO_V1_FILE=v1_1_zh/kokoro-v1_1-zh.pth
327- - VOICES_DIR=/app/api/src/voices/v1_1_zh
328- - DEFAULT_VOICE_CODE=z
329- - API_LOG_LEVEL=DEBUG
296+ kokoro-fastapi:
297+ image: ghcr.io/hsiang-han/kokoro-fastapi-zh-cpu:latest
298+ container_name: kokoro-fastapi-zh-cpu
299+ labels:
300+ net.unraid.docker.icon: https://raw.githubusercontent.com/hsiang-han/Kokoro-FastAPI-zh/master/assets/unraid-icon.png
301+ volumes:
302+ - /mnt/user/appdata/kokoro-fastapi-zh/models:/app/api/src/models
303+ - /mnt/user/appdata/kokoro-fastapi-zh/voices:/app/api/src/voices
304+ ports:
305+ - " 8880:8880"
306+ environment:
307+ - PYTHONPATH=/app:/app/api
308+ - USE_GPU=false
309+ - PYTHONUNBUFFERED=1
310+ - REPO_ID=hexgrad/Kokoro-82M-v1.1-zh
311+ - DEFAULT_VOICE=zf_094
312+ - KOKORO_V1_FILE=v1_1_zh/kokoro-v1_1-zh.pth
313+ - VOICES_DIR=/app/api/src/voices/v1_1_zh
314+ - DEFAULT_VOICE_CODE=z
315+ - API_LOG_LEVEL=DEBUG
330316` ` `
331317
332318# ### 4) 部署与验证
333319
3343201. 点击 ` Deploy`
3353212. 首次启动会自动下载模型/语音到:
336- - ` /mnt/user/appdata/kokoro-fastapi-zh/models/v1_1_zh/`
337- - ` /mnt/user/appdata/kokoro-fastapi-zh/voices/v1_1_zh/`
322+ - ` /mnt/user/appdata/kokoro-fastapi-zh/models/v1_1_zh/`
323+ - ` /mnt/user/appdata/kokoro-fastapi-zh/voices/v1_1_zh/`
3383243. 在容器日志看到 ` Uvicorn running on` 后,浏览器打开:` http://< 你的UnraidIP> :8880/docs`
3393254. 能打开接口文档页面即部署成功
340326
@@ -346,8 +332,8 @@ English:
346332
3473331. Click ` Deploy`
3483342. First startup will auto-download model/voices to:
349- - ` /mnt/user/appdata/kokoro-fastapi-zh/models/v1_1_zh/`
350- - ` /mnt/user/appdata/kokoro-fastapi-zh/voices/v1_1_zh/`
335+ - ` /mnt/user/appdata/kokoro-fastapi-zh/models/v1_1_zh/`
336+ - ` /mnt/user/appdata/kokoro-fastapi-zh/voices/v1_1_zh/`
3513373. Once logs show ` Uvicorn running on` , open ` http://< your Unraid IP> :8880/docs`
3523384. If docs page opens, deployment is successful
353339
@@ -596,9 +582,7 @@ Dockerized FastAPI wrapper for [Kokoro-82M](https://huggingface.co/hexgrad/Kokor
596582 [! [Helm Chart](https://img.shields.io/badge/Helm%20Chart-black? style=flat& logo=helm& logoColor=white)](https://github.com/remsky/Kokoro-FastAPI/wiki/Setup-Kubernetes) [! [DigitalOcean](https://img.shields.io/badge/DigitalOcean-black? style=flat& logo=digitalocean& logoColor=white)](https://github.com/remsky/Kokoro-FastAPI/wiki/Integrations-DigitalOcean) [! [SillyTavern](https://img.shields.io/badge/SillyTavern-black? style=flat& color=red)](https://github.com/remsky/Kokoro-FastAPI/wiki/Integrations-SillyTavern)
597583[! [OpenWebUI](https://img.shields.io/badge/OpenWebUI-black? style=flat& color=white)](https://github.com/remsky/Kokoro-FastAPI/wiki/Integrations-OpenWebUi)
598584
599- - Docker 免源码部署 + Unraid 上架说明: ` docs/deployment/unraid-and-prebuilt-images.md`
600585- Unraid Stack 示例: ` docker/unraid/stack.gpu.image.yml` / ` docker/unraid/stack.cpu.image.yml`
601- - Unraid CA 模板: ` unraid/templates/kokoro-fastapi-zh.xml`
602586
603587# # Get Started
604588
0 commit comments