OpenWebUI/docs
1
0
Fork 0
mirror of https://github.com/open-webui/docs synced 2025-06-16 11:28:36 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

Update openedai-speech-integration.md

Browse Source 
Updates
This commit is contained in:
silentoplayz 2024-06-09 17:46:23 +00:00 committed by GitHub
parent e87a43ed4a
commit dd0a110ca2
1 changed files with 26 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

27
docs/tutorial/openedai-speech-integration.md
View File

@ -6,6 +6,11 @@ title: "Integrating OpenedAI-Speech with Open WebUI using Docker Desktop"
Integrating `openedai-speech` into Open WebUI using Docker Desktop Integrating `openedai-speech` into Open WebUI using Docker Desktop
================================================================ ================================================================
**What is `openedai-speech`?**
-----------------------------
`openedai-speech` is an OpenAI API compatible text-to-speech server that uses Coqui AI's `xtts_v2` and/or `Piper TTS` as the backend. It's a free, private, text-to-speech server that allows for custom voice cloning and is compatible with the OpenAI audio/speech API.
**Prerequisites** **Prerequisites**
--------------- ---------------
@ -13,6 +18,9 @@ Integrating `openedai-speech` into Open WebUI using Docker Desktop
* Open WebUI running in a Docker container * Open WebUI running in a Docker container
* A basic understanding of Docker and Docker Compose * A basic understanding of Docker and Docker Compose
**Option 1: Using Docker Compose**
---------------------------------
**Step 1: Create a new folder for the `openedai-speech` service** **Step 1: Create a new folder for the `openedai-speech` service**
--------------------------------------------------------- ---------------------------------------------------------
@ -61,6 +69,19 @@ docker compose up -d
``` ```
This will start the `openedai-speech` service in the background. This will start the `openedai-speech` service in the background.
**Option 2: Using Docker Run Commands**
-------------------------------------
You can also use the following Docker run commands to start the `openedai-speech` service in detached mode:
**With GPU (Nvidia) support:**
```bash
docker run -d --gpus=all -p 8000:8000 -v tts-voices:/app/voices -v tts-config:/app/config --name openedai-speech ghcr.io/matatonic/openedai-speech:latest
```
**Alternative without GPU support:**
```bash
docker run -d -p 8000:8000 -v tts-voices:/app/voices -v tts-config:/app/config --name openedai-speech ghcr.io/matatonic/openedai-speech-min:latest
```
**Step 5: Configure Open WebUI to use `openedai-speech`** **Step 5: Configure Open WebUI to use `openedai-speech`**
--------------------------------------------------------- ---------------------------------------------------------
@ -97,5 +118,9 @@ If you encounter any issues, make sure that:
* `host.docker.internal` is required since `openedai-speech` is exposed via `localhost` on your PC, but `open-webui` cannot normally access this from within its container. * `host.docker.internal` is required since `openedai-speech` is exposed via `localhost` on your PC, but `open-webui` cannot normally access this from within its container.
* The API key is set to a dummy value, as `openedai-speech` doesn't require an API key. * The API key is set to a dummy value, as `openedai-speech` doesn't require an API key.
**Additional Resources**
-------------------------
For more information on `openedai-speech`, please visit the [GitHub repository](https://github.com/matatonic/openedai-speech).
Note: You can change the port number in the `docker-compose.yml` file to any open and usable port, but make sure to update the **API Base URL** in Open WebUI Admin Audio settings accordingly. Note: You can change the port number in the `docker-compose.yml` file to any open and usable port, but make sure to update the **API Base URL** in Open WebUI Admin Audio settings accordingly.
:::