What it is

• OpenAI-compatible TTS API based on hexgrad/Kokoro-82M-v1.1-zh (Chinese optimized TTS model hexgrad/Kokoro-82M-v1.1-zh · Hugging Face )

• Exposes:

  • /v1/audio/speech

  • docs (Swagger)

  • web (web UI)

Template details

• App name: Kokoro-FastAPI-zh

• Template URL:
  https://raw.githubusercontent.com/hsiang-han/unraid_templates/main/templates/kokoro-fastapi-zh.xml

• Icon URL:
  https://raw.githubusercontent.com/hsiang-han/unraid_templates/main/assets/unraid-icon.png

• Project URL:
  https://github.com/hsiang-han/Kokoro-FastAPI-zh

• Support URL:
  https://github.com/hsiang-han/Kokoro-FastAPI-zh/issues

Container image strategy

• Default repository (CPU):
  ghcr.io/hsiang-han/kokoro-fastapi-zh-cpu:latest

• Optional NVIDIA GPU mode:

  1. Change Repository to
     ghcr.io/hsiang-han/kokoro-fastapi-zh-gpu:latest

  2. Set USE_GPU=true

  3. Add Extra Parameters: --gpus=all --runtime=nvidia

Default mappings / settings

• Port: 8880

• Host paths:

  • /mnt/user/appdata/kokoro-fastapi-zh/models -> /app/api/src/models

  • /mnt/user/appdata/kokoro-fastapi-zh/voices -> /app/api/src/voices

• API docs: http://[IP]:[PORT:8880]/docs

• Web UI: http://[IP]:[PORT:8880]/web

Edited March 3Mar 3 by hsiang

The container runs as a non-root user appuser (UID 1000). If the mounted host directories are not owned by UID 1000, the container cannot write to them, and you may see an error like:

PermissionError: [Errno 13] Permission denied: 'api/src/models/v1_1_zh'

Fix (run once in the Unraid terminal before first deployment):

```

# 1. Create mount directories

mkdir -p /mnt/user/appdata/kokoro-fastapi-zh/models/v1_1_zh

mkdir -p /mnt/user/appdata/kokoro-fastapi-zh/voices/v1_1_zh

# 2. Set owner to UID 1000 (container appuser)

chown -R 1000:1000 /mnt/user/appdata/kokoro-fastapi-zh

# 3. Set read/write permissions

chmod -R 775 /mnt/user/appdata/kokoro-fastapi-zh

```

Note: The Unraid terminal runs as root by default, so you can execute these commands directly. This is only required once before the first deployment.

Edited March 2Mar 2 by Monkey_66