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: <div class="rdm-tbl-wrap"><table class="rdm-tbl"><thead><tr><th>Library</th><th>License</th><th>Notes</th></tr></thead><tbody><tr><td>encodec</td><td>CC BY-NC 4.0</td><td>Newer versions are MIT, but need to be installed manually</td></tr><tr><td>diffq</td><td>CC BY-NC 4.0</td><td>Optional in the future, not necessary to run, can be uninstalled, should be updated with demucs</td></tr><tr><td>lameenc</td><td>GPL License</td><td>Future versions will make it LGPL, but need to be installed manually</td></tr><tr><td>unidecode</td><td>GPL License</td><td>Not mission critical, can be replaced with another library, issue: https://github.com/neonbjb/tortoise-tts/issues/494</td></tr></tbody></table></div>

Installation

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
   

    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 .

Examples

</div>

Screenshots

</div>

Extra Voices for Bark, Prompt Samples

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.

Supported Models

\* These models are not installed by default, instead they are available as extensions.

</div>

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