TTS WebUI

| | | | | :------------------------------------------------------------------------------------------------------: | :------------------------------------------------------------------------------------------------------: | :------------------------------------------------------------------------------------------------------: |

| | | | | :-----------------------------------------: | :-----------------------------------------: | :-------------------------------: |

| .png) | .png) | .png) | | :-----------------------------------------: | :-----------------------------------------: | :-------------------------------: |

| .png) | .png) | .png) | | :-----------------------------------------: | :-----------------------------------------: | :-------------------------------: |

Installation

Using TTS WebUI Ignition (Recommended)

TTS WebUI Ignition is the new installer and launcher for TTS WebUI.

On Windows:

winget install TTS-WebUI.Ignition

For other platforms, download the latest release from the releases page or build it from source using the instructions in the repository.

Using the Installer (Legacy)

Current base installation size is around 10.7 GB. Each model will require 2-8 GB of space in addition.

• Download the latest version and extract it.
• Run start_tts_webui.bat or start_tts_webui.sh to start the server. It will ask you to select the GPU/Chip you are using. Once everything has installed, it will start the Gradio server at http://localhost:7770 and the React UI at http://localhost:3000.
• Output log will be available in the installer_scripts/output.log file.
• Note: The start script sets up a conda environment and a python virtual environment. Thus you don't need to make a venv before that, and in fact, launching from another venv might break this script.

Manual installation

Prerequisites:

• git
• Python 3.10 or 3.11 (3.12 not supported yet)
• PyTorch
• ffmpeg (with vorbis support)
• (Optional) NodeJS 22.9.0 for React UI
• SQLite (bundled with Python) for database support

1. Clone the repository:

   git clone https://github.com/rsxdalv/tts-webui.git
   cd tts-webui
   

2. Install required packages:

    pip install -r requirements.txt
    

3. Run the server:

   python server.py --no-react
   

4. For React UI:

   cd react-ui
   npm install
   npm run build
   cd ..
   python server.py
   

For detailed manual installation instructions, please refer to the Manual Installation Guide.

Docker Setup

tts-webui can also be ran inside of a Docker container. Using CUDA inside of docker requires NVIDIA Container Toolkit. To get started, pull the image from GitHub Container Registry:

docker pull ghcr.io/rsxdalv/tts-webui:main

Once the image has been pulled it can be started with Docker Compose: The ports are 7770 (env:TTS_PORT) for the Gradio backend and 3000 (env:UI_PORT) for the React front end.

docker compose up -d

The container will take some time to generate the first output while models are downloaded in the background. The status of this download can be verified by checking the container logs:

docker logs tts-webui

Building the image yourself

If you wish to build your own docker container, you can use the included Dockerfile:

docker build -t tts-webui .

Please note that the docker-compose needs to be edited to use the image you just built.

Changelog

May:

• Add virtual environment system (uv), preventing extension conflicts.

April:

• Add torchcodec CPU to requirements
• Upgrade PyTorch to 2.11.0
• Update pin TorchAudio to 2.7.0

March:

• feat: Next.js 13.5 → 16.2.1 Upgrade

December:

• Minor bug fixes and improvements
• refactor: extract bark config loading to separate function from WebUI
• chore: remove postgres from tts-webui as it is a heavy dependency not needed for most users
• feat: add database API server to manage generated audio files and metadata

November:

• Add extension marketplace directly in the Gradio UI using iframe
• Move voices-tortoise to voices/tortoise/ (and maha-tts to voices/maha_tts/)
• feat: add comprehensive test suite for tts_webui modules
• feat: implement install button for extension marketplace
• feat: add button to check dependencies in extension management UI
• feat(cli): add extension-manager command to launch GUI tool
• chore: remove uv from google colab
• chore: move logging directory to installer_scripts/logs/
• feat: add ability to disable decorator extensions via config.json

October:

• Update Gradio to 5.49.1
• Update @gradio/client to 1.19.1
• Fix Chatterbox installation issues, paths and streaming errors in Silly Tavern
• Create new extension category - Conversational AI
• Reorganize environment variables, new dotenv manager
• Convert more of the UI into extensions and simplify base server
• Add API_KEY to OpenAI TTS API extension
• feat: support new extensions format - tabsInGroups
• feat: add External Extensions Installer to manage and install external extensions via JSON
• feat: Add links to TTS WebUI Extension Catalog in documentation and installer UI
• feat: Add Log Viewer extension to view and manage log files

Past Changes

See the 2025 Changelog for a detailed list of changes in 2025.

See the 2024 Changelog for a detailed list of changes in 2024.

See the 2023 Changelog for a detailed list of changes in 2023.

Extensions

Extensions are available to install from the webui itself, or using React UI. They can also be installed using the extension manager or the External Extensions Installer (a built-in tool for adding custom extensions from JSON).

Internally, extensions are just python packages that are installed using pip. Multiple extensions can be installed at the same time, but there might be compatibility issues between them. After installing or updating an extension, you need to restart the app to load it.

For a curated list of community-created extensions, visit the TTS WebUI Extension Catalog. You can also find information on publishing your own extensions there.

Updates need to be done manually by using the mini-control panel:

Integrations

Silly Tavern

1. Update OpenAI TTS API extension to latest version 2. Start the API and test it with Python Requests (OpenAI client might not be installed thus the Test with Python OpenAI client might fail)

3. Once you can see the audio generates successfully, go to Silly Tavern, and add a new TTS API Default provider endpoint: http://localhost:7778/v1/audio/speech 4. Test it out!

Text Generation WebUI (oobabooga/text-generation-webui)

1. Install https://github.com/rsxdalv/text-to-tts-webui extension in text-generation-webui 2. Start the API and test it with Python Requests 3. Configure using the panel:

OpenWebUI

1. Enable OpenAI API extension in TTS WebUI 2. Start the API and test it with Python Requests 3. Once you can see the audio generates successfully, go to OpenWebUI, and add a new TTS API Default provider endpoint: http://localhost:7778/v1/audio/speech 4. Test it out!

OpenAI Compatible APIs

Using the instructions above, you can install an OpenAI compatible API, and use it with Silly Tavern or other OpenAI compatible clients.

Compatibility / Errors

Red messages in console

These messages:

---- requires ----, but you have ---- which is incompatible.

Are completely normal. It's both a limitation of pip and because this Web UI combines a lot of different AI projects together. Since the projects are not always compatible with each other, they will complain about the other projects being installed. This is normal and expected. And in the end, despite the warnings/errors the projects will work together. It's not clear if this situation will ever be resolvable, but that is the hope.

Extra Voices for Bark, Prompt Samples

Bark Readme

README_Bark.md

Info about managing models, caches and system space for AI projects

https://github.com/rsxdalv/tts-webui/discussions/186#discussioncomment-7291274

Open Source Libraries

This project utilizes the following open source libraries:

• suno-ai/bark - MIT License
• Description: Inference code for Bark model.
• Repository: suno/bark
• tortoise-tts - Apache-2.0 License
• Description: A flexible text-to-speech synthesis library for various platforms.
• Repository: neonbjb/tortoise-tts
• ffmpeg - LGPL License
• Description: A complete and cross-platform solution for video and audio processing.
• Repository: FFmpeg
• Use: Encoding Vorbis Ogg files
• ffmpeg-python - Apache 2.0 License
• Description: Python bindings for FFmpeg library for handling multimedia files.
• Repository: kkroening/ffmpeg-python
• audiocraft - MIT License
• Description: A library for audio generation and MusicGen.
• Repository: facebookresearch/audiocraft
• vocos - MIT License
• Description: An improved decoder for encodec samples
• Repository: charactr-platform/vocos
• RVC - MIT License
• Description: An easy-to-use Voice Conversion framework based on VITS.
• Repository: RVC-Project/Retrieval-based-Voice-Conversion-WebUI

Ethical and Responsible Use

This technology is intended for enablement and creativity, not for harm.

By engaging with this AI model, you acknowledge and agree to abide by these guidelines, employing the AI model in a responsible, ethical, and legal manner.

• Non-Malicious Intent: Do not use this AI model for malicious, harmful, or unlawful activities. It should only be used for lawful and ethical purposes that promote positive engagement, knowledge sharing, and constructive conversations.
• No Impersonation: Do not use this AI model to impersonate or misrepresent yourself as someone else, including individuals, organizations, or entities. It should not be used to deceive, defraud, or manipulate others.
• No Fraudulent Activities: This AI model must not be used for fraudulent purposes, such as financial scams, phishing attempts, or any form of deceitful practices aimed at acquiring sensitive information, monetary gain, or unauthorized access to systems.
• Legal Compliance: Ensure that your use of this AI model complies with applicable laws, regulations, and policies regarding AI usage, data protection, privacy, intellectual property, and any other relevant legal obligations in your jurisdiction.
• Acknowledgement: By engaging with this AI model, you acknowledge and agree to abide by these guidelines, using the AI model in a responsible, ethical, and legal manner.

License

Codebase and Dependencies

The codebase is licensed under MIT. However, it's important to note that when installing the dependencies, you will also be subject to their respective licenses. Although most of these licenses are permissive, there may be some that are not. Therefore, it's essential to understand that the permissive license only applies to the codebase itself, not the entire project.

That being said, the goal is to maintain MIT compatibility throughout the project. If you come across a dependency that is not compatible with the MIT license, please feel free to open an issue and bring it to our attention.

Known non-permissive dependencies: | Library | License | Notes | |-------------|-------------------|-------------------------------------------------------------------------------------------| | encodec | CC BY-NC 4.0 | Newer versions are MIT, but need to be installed manually | | diffq | CC BY-NC 4.0 | Optional in the future, not necessary to run, can be uninstalled, should be updated with demucs | | lameenc | GPL License | Future versions will make it LGPL, but need to be installed manually | | unidecode | GPL License | Not mission critical, c