Skip to content

Commit

Permalink
Update usage instructions with pre-built image
Browse files Browse the repository at this point in the history
  • Loading branch information
reuben authored Oct 30, 2023
1 parent b9607d7 commit c0b277d
Showing 1 changed file with 23 additions and 9 deletions.
32 changes: 23 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
@@ -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).

0 comments on commit c0b277d

Please sign in to comment.