Update readme for Dockerfile
Browse files
README.md
CHANGED
@@ -250,6 +250,33 @@ To deploy WhisperLiveKit in production:
|
|
250 |
|
251 |
4. **HTTPS Support**: For secure deployments, use "wss://" instead of "ws://" in WebSocket URL
|
252 |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
253 |
## 🔮 Use Cases
|
254 |
|
255 |
- **Meeting Transcription**: Capture discussions in real-time
|
|
|
250 |
|
251 |
4. **HTTPS Support**: For secure deployments, use "wss://" instead of "ws://" in WebSocket URL
|
252 |
|
253 |
+
### 🐋 Docker
|
254 |
+
|
255 |
+
A basic Dockerfile is provided which allows re-use of python package installation options. See below useage examples:
|
256 |
+
|
257 |
+
***NOTE:** For **larger** models, ensure that your **docker runtime** has enough **memory** available.*
|
258 |
+
|
259 |
+
#### All defaults
|
260 |
+
- Create a reuseable image with only the basics and then run as a named container.
|
261 |
+
```bash
|
262 |
+
docker build -t whisperlivekit-defaults .
|
263 |
+
docker create --gpus all --name whisperlivekit -p 8000:8000 whisperlivekit-defaults
|
264 |
+
docker start -i whisperlivekit
|
265 |
+
```
|
266 |
+
|
267 |
+
#### Customization
|
268 |
+
- Customise the container options.
|
269 |
+
```bash
|
270 |
+
docker build -t whisperlivekit-defaults .
|
271 |
+
docker create --gpus all --name whisperlivekit-base -p 8000:8000 whisperlivekit-defaults --model base
|
272 |
+
docker start -i whisperlivekit-base
|
273 |
+
```
|
274 |
+
|
275 |
+
- `--build-arg` Options
|
276 |
+
- `EXTRAS="whisper-timestamped"` - Add extras to the image's installation (no spaces). Remember to set necessary container options!
|
277 |
+
- `HF_PRECACHE_DIR=./.cache/` - Pre-load a model cache for faster first-time start
|
278 |
+
- `HF_TOKEN=./token` - Add your Hugging Face Hub access token to download gated models
|
279 |
+
|
280 |
## 🔮 Use Cases
|
281 |
|
282 |
- **Meeting Transcription**: Capture discussions in real-time
|