From c0b277d8b5491f2ae4be43d622c1931d532692cc Mon Sep 17 00:00:00 2001 From: Reuben Morais Date: Mon, 30 Oct 2023 14:53:40 +0100 Subject: [PATCH] Update usage instructions with pre-built image --- README.md | 32 +++++++++++++++++++++++--------- 1 file changed, 23 insertions(+), 9 deletions(-) diff --git a/README.md b/README.md index 9426ae7..86fe121 100644 --- a/README.md +++ b/README.md @@ -1,25 +1,39 @@ # XTTS streaming server -1. Build the Docker container: +## Running the server -```bash -$ cd server -$ docker build -t xtts-stream . -``` - -2. Run the server container: +To run a pre-built container: ```bash -$ docker run --gpus=all -e COQUI_TOS_AGREED=1 --rm -p 8000:80 xtts-stream +$ docker run --gpus=all -e COQUI_TOS_AGREED=1 --rm -p 8000:80 ghcr.io/coqui-ai/xtts-streaming-server:latest ``` Setting the `COQUI_TOS_AGREED` environment variable to `1` indicates you have read and agreed to the terms of the [CPML license](https://coqui.ai/cpml). -3. Generate audio with the test script: +## Testing the server + +1. Generate audio with the test script: ```bash $ cd test $ python -m pip install -r requirements.txt $ python test_streaming.py ``` + +## Building the container + +1. To build the Docker container: + +```bash +$ cd server +$ docker build -t xtts-stream . +``` +2. Run the server container: + +```bash +$ docker run --gpus=all -e COQUI_TOS_AGREED=1 --rm -p 8000:80 xtts-stream +``` + +Setting the `COQUI_TOS_AGREED` environment variable to `1` indicates you have read and agreed to +the terms of the [CPML license](https://coqui.ai/cpml).