Update readme for Dockerfile
This commit is contained in:
parent
583a26da88
commit
5d6f08ff7a
1 changed files with 27 additions and 0 deletions
27
README.md
27
README.md
|
|
@ -250,6 +250,33 @@ To deploy WhisperLiveKit in production:
|
||||||
|
|
||||||
4. **HTTPS Support**: For secure deployments, use "wss://" instead of "ws://" in WebSocket URL
|
4. **HTTPS Support**: For secure deployments, use "wss://" instead of "ws://" in WebSocket URL
|
||||||
|
|
||||||
|
### 🐋 Docker
|
||||||
|
|
||||||
|
A basic Dockerfile is provided which allows re-use of python package installation options. See below useage examples:
|
||||||
|
|
||||||
|
***NOTE:** For **larger** models, ensure that your **docker runtime** has enough **memory** available.*
|
||||||
|
|
||||||
|
#### All defaults
|
||||||
|
- Create a reuseable image with only the basics and then run as a named container.
|
||||||
|
```bash
|
||||||
|
docker build -t whisperlivekit-defaults .
|
||||||
|
docker create --gpus all --name whisperlivekit -p 8000:8000 whisperlivekit-defaults
|
||||||
|
docker start -i whisperlivekit
|
||||||
|
```
|
||||||
|
|
||||||
|
#### Customization
|
||||||
|
- Customise the container options.
|
||||||
|
```bash
|
||||||
|
docker build -t whisperlivekit-defaults .
|
||||||
|
docker create --gpus all --name whisperlivekit-base -p 8000:8000 whisperlivekit-defaults --model base
|
||||||
|
docker start -i whisperlivekit-base
|
||||||
|
```
|
||||||
|
|
||||||
|
- `--build-arg` Options
|
||||||
|
- `EXTRAS="whisper-timestamped"` - Add extras to the image's installation (no spaces). Remember to set necessary container options!
|
||||||
|
- `HF_PRECACHE_DIR=./.cache/` - Pre-load a model cache for faster first-time start
|
||||||
|
- `HF_TOKEN=./token` - Add your Hugging Face Hub access token to download gated models
|
||||||
|
|
||||||
## 🔮 Use Cases
|
## 🔮 Use Cases
|
||||||
|
|
||||||
- **Meeting Transcription**: Capture discussions in real-time
|
- **Meeting Transcription**: Capture discussions in real-time
|
||||||
|
|
|
||||||
Loading…
Reference in a new issue