diff --git a/docs/tutorial/openedai-speech-integration.md b/docs/tutorial/openedai-speech-integration.md index c631114..16b87c5 100644 --- a/docs/tutorial/openedai-speech-integration.md +++ b/docs/tutorial/openedai-speech-integration.md @@ -6,6 +6,11 @@ title: "Integrating OpenedAI-Speech with 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** --------------- @@ -13,6 +18,9 @@ Integrating `openedai-speech` into Open WebUI using Docker Desktop * Open WebUI running in a Docker container * A basic understanding of Docker and Docker Compose +**Option 1: Using Docker Compose** +--------------------------------- + **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. +**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`** --------------------------------------------------------- @@ -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. * 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. -:::