From 5d6f08ff7a7a7730a2233a803769398bcbca7d95 Mon Sep 17 00:00:00 2001
From: Chris Margach <hcagramc@gmail.com>
Date: Tue, 8 Apr 2025 19:06:42 +0900
Subject: [PATCH] Update readme for Dockerfile

---
 README.md | 27 +++++++++++++++++++++++++++
 1 file changed, 27 insertions(+)

diff --git a/README.md b/README.md
index ab67f19..25b6ca9 100644
--- a/README.md
+++ b/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
 
+### 🐋 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
 
 - **Meeting Transcription**: Capture discussions in real-time