Skip to content

Commit

Permalink
Update spacing in the readme
Browse files Browse the repository at this point in the history
  • Loading branch information
jteijema committed Jan 14, 2025
1 parent 55ea0db commit aefd525
Showing 1 changed file with 10 additions and 10 deletions.
20 changes: 10 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,26 +24,26 @@ Dockerized FastAPI wrapper for [Kokoro-82M](https://huggingface.co/hexgrad/Kokor
The service can be accessed through either the API endpoints or the Gradio web interface.

1. Install prerequisites:
- Install [Docker Desktop](https://www.docker.com/products/docker-desktop/)
- Clone the repository:
- Install [Docker Desktop](https://www.docker.com/products/docker-desktop/)
- Clone the repository:
```bash
git clone https://github.com/remsky/Kokoro-FastAPI.git
cd Kokoro-FastAPI
```

2. Start the service:

- Using Docker Compose (Full setup including UI):
- Using Docker Compose (Full setup including UI):
```bash
cd docker/gpu # OR
# cd docker/cpu # Run this or the above
docker compose up --build
```
Once started:
- The API will be available at http://localhost:8880
- The UI can be accessed at http://localhost:7860
- The API will be available at http://localhost:8880
- The UI can be accessed at http://localhost:7860

- OR run the API alone using Docker (model + voice packs baked in):
- OR run the API alone using Docker (model + voice packs baked in):
```bash
docker run -p 8880:8880 ghcr.io/remsky/kokoro-fastapi-cpu:latest # CPU
docker run --gpus all -p 8880:8880 ghcr.io/remsky/kokoro-fastapi-gpu:latest # Nvidia GPU
Expand All @@ -53,17 +53,17 @@ The service can be accessed through either the API endpoints or the Gradio web i

3. Running the UI Docker Service:

- If you only want to run the Gradio web interface separately and connect it to an existing API service:
- If you only want to run the Gradio web interface separately and connect it to an existing API service:
```bash
docker run -p 7860:7860 \
-e API_HOST=<api-hostname-or-ip> \
-e API_PORT=8880 \
ghcr.io/remsky/kokoro-fastapi-ui:v0.1.0
```

- Replace `<api-hostname-or-ip>` with:
- `kokoro-tts` if the UI container is running in the same Docker Compose setup.
- `localhost` if the API is running on your local machine.
- Replace `<api-hostname-or-ip>` with:
- `kokoro-tts` if the UI container is running in the same Docker Compose setup.
- `localhost` if the API is running on your local machine.


4. Run locally as an OpenAI-Compatible Speech Endpoint
Expand Down

0 comments on commit aefd525

Please sign in to comment.