Get Started#

This page is the entry point for running the Text To Speech microservice. Pick one of the two deployment paths and follow the linked guide.

Before You Begin#

Confirm that your machine meets the System Requirements.
Review the Configuration Guide if you plan to change models, runtimes, devices, or precision.

Run in Docker (Recommended)

The container image exposes the API on host port 8011 and mounts shared folders for models, storage, and the Hugging Face cache.

See Run with Docker Compose for the full step-by-step guide.

Quick start:

docker compose up -d --build
curl --noproxy '*' http://127.0.0.1:8011/health

If you hit permission errors on models/, storage/, or .cache/huggingface/, see Troubleshooting.

Run on the Host

Run the service directly with Python. This path is useful for development or when you do not want to use Docker.

See Run on the Host for the full step-by-step guide.

Quick start:

python -m venv .venv
source .venv/bin/activate
pip install -r requirements.txt
python main.py

Once the service is running:

curl --noproxy '*' http://127.0.0.1:8011/health

Expected response:

{"status": "ok"}