Commit @59bd630bd0dc3eae65f021b9d3fc6c8baf2cb349 - yjyoon/whisper_server

Fedir Zadniprovskyi 01-12

docs: update docker compose instructions

@59bd630bd0dc3eae65f021b9d3fc6c8baf2cb349

ed0943f

59bd630

docs/installation.md

--- docs/installation.md

+++ docs/installation.md


 ## Docker Compose (Recommended)
 
-TODO: just reference the existing compose file in the repo
+!!! note
+
+    I'm using newer Docker Compsose features. If you are using an older version of Docker Compose, you may need need to update.
+
+Download the necessary Docker Compose files
+
 === "CUDA"
 
-    ```yaml
-    # https://docs.nvidia.com/datacenter/cloud-native/container-toolkit/latest/install-guide.html
-    services:
-      faster-whisper-server:
-        image: fedirz/faster-whisper-server:latest-cuda
-        name: faster-whisper-server
-        restart: unless-stopped
-        ports:
-          - 8000:8000
-        volumes:
-          - hf-hub-cache:/home/ubuntu/.cache/huggingface/hub
-        deploy:
-          resources:
-            reservations:
-              devices:
-                - capabilities: ["gpu"]
-    volumes:
-      hf-hub-cache:
+    ```bash
+    curl --silent --remote-name https://raw.githubusercontent.com/fedirz/faster-whisper-server/master/compose.yaml
+    curl --silent --remote-name https://raw.githubusercontent.com/fedirz/faster-whisper-server/master/compose.cuda.yaml
+    export COMPOSE_FILE=compose.cuda.yaml
     ```
 
 === "CUDA (with CDI feature enabled)"
 
-    ```yaml
-    # https://docs.nvidia.com/datacenter/cloud-native/container-toolkit/latest/install-guide.html
-    services:
-      faster-whisper-server:
-        image: fedirz/faster-whisper-server:latest-cuda
-        name: faster-whisper-server
-        restart: unless-stopped
-        ports:
-          - 8000:8000
-        volumes:
-          - hf-hub-cache:/home/ubuntu/.cache/huggingface/hub
-        deploy:
-          resources:
-            reservations:
-              # https://docs.docker.com/reference/cli/dockerd/#enable-cdi-devices
-              # https://docs.nvidia.com/datacenter/cloud-native/container-toolkit/latest/cdi-support.html
-              devices:
-                - driver: cdi
-                  device_ids:
-                  - nvidia.com/gpu=all
-    volumes:
-      hf-hub-cache:
+    ```bash
+    curl --silent --remote-name https://raw.githubusercontent.com/fedirz/faster-whisper-server/master/compose.yaml
+    curl --silent --remote-name https://raw.githubusercontent.com/fedirz/faster-whisper-server/master/compose.cuda.yaml
+    curl --silent --remote-name https://raw.githubusercontent.com/fedirz/faster-whisper-server/master/compose.cuda-cdi.yaml
+    export COMPOSE_FILE=compose.cuda-cdi.yaml
     ```
 
 === "CPU"
 
-    ```yaml
-    services:
-      faster-whisper-server:
-        image: fedirz/faster-whisper-server:latest-cpu
-        name: faster-whisper-server
-        restart: unless-stopped
-        ports:
-          - 8000:8000
-        volumes:
-          - hf-hub-cache:/home/ubuntu/.cache/huggingface/hub
-    volumes:
-      hf-hub-cache:
+    ```bash
+    curl --silent --remote-name https://raw.githubusercontent.com/fedirz/faster-whisper-server/master/compose.yaml
+    curl --silent --remote-name https://raw.githubusercontent.com/fedirz/faster-whisper-server/master/compose.cpu.yaml
+    export COMPOSE_FILE=compose.cpu.yaml
     ```
+
+Start the service
+
+```bash
+docker compose up --detach
+```
 
 ??? note "Build from source"
 

     # Build image without CUDA support
     docker build --tag faster-whisper-server --build-arg BASE_IMAGE=ubuntu:24.04 .
     ```
-
-## Kubernetes
-
-WARNING: it was written few months ago and may be outdated.
-Please refer to this [blog post](https://substratus.ai/blog/deploying-faster-whisper-on-k8s)
 
 ## Python (requires Python 3.12+ and `uv` package manager)
 

Add a comment

Open 0
Closed 0

List

...	...	@@ -1,69 +1,41 @@
1	1	## Docker Compose (Recommended)
2	2
3		-TODO: just reference the existing compose file in the repo
	3	+!!! note
	4	+
	5	+ I'm using newer Docker Compsose features. If you are using an older version of Docker Compose, you may need need to update.
	6	+
	7	+Download the necessary Docker Compose files
	8	+
4	9	=== "CUDA"
5	10
6		- ```yaml
7		- # https://docs.nvidia.com/datacenter/cloud-native/container-toolkit/latest/install-guide.html
8		- services:
9		- faster-whisper-server:
10		- image: fedirz/faster-whisper-server:latest-cuda
11		- name: faster-whisper-server
12		- restart: unless-stopped
13		- ports:
14		- - 8000:8000
15		- volumes:
16		- - hf-hub-cache:/home/ubuntu/.cache/huggingface/hub
17		- deploy:
18		- resources:
19		- reservations:
20		- devices:
21		- - capabilities: ["gpu"]
22		- volumes:
23		- hf-hub-cache:
	11	+ ```bash
	12	+ curl --silent --remote-name https://raw.githubusercontent.com/fedirz/faster-whisper-server/master/compose.yaml
	13	+ curl --silent --remote-name https://raw.githubusercontent.com/fedirz/faster-whisper-server/master/compose.cuda.yaml
	14	+ export COMPOSE_FILE=compose.cuda.yaml
24	15	```
25	16
26	17	=== "CUDA (with CDI feature enabled)"
27	18
28		- ```yaml
29		- # https://docs.nvidia.com/datacenter/cloud-native/container-toolkit/latest/install-guide.html
30		- services:
31		- faster-whisper-server:
32		- image: fedirz/faster-whisper-server:latest-cuda
33		- name: faster-whisper-server
34		- restart: unless-stopped
35		- ports:
36		- - 8000:8000
37		- volumes:
38		- - hf-hub-cache:/home/ubuntu/.cache/huggingface/hub
39		- deploy:
40		- resources:
41		- reservations:
42		- # https://docs.docker.com/reference/cli/dockerd/#enable-cdi-devices
43		- # https://docs.nvidia.com/datacenter/cloud-native/container-toolkit/latest/cdi-support.html
44		- devices:
45		- - driver: cdi
46		- device_ids:
47		- - nvidia.com/gpu=all
48		- volumes:
49		- hf-hub-cache:
	19	+ ```bash
	20	+ curl --silent --remote-name https://raw.githubusercontent.com/fedirz/faster-whisper-server/master/compose.yaml
	21	+ curl --silent --remote-name https://raw.githubusercontent.com/fedirz/faster-whisper-server/master/compose.cuda.yaml
	22	+ curl --silent --remote-name https://raw.githubusercontent.com/fedirz/faster-whisper-server/master/compose.cuda-cdi.yaml
	23	+ export COMPOSE_FILE=compose.cuda-cdi.yaml
50	24	```
51	25
52	26	=== "CPU"
53	27
54		- ```yaml
55		- services:
56		- faster-whisper-server:
57		- image: fedirz/faster-whisper-server:latest-cpu
58		- name: faster-whisper-server
59		- restart: unless-stopped
60		- ports:
61		- - 8000:8000
62		- volumes:
63		- - hf-hub-cache:/home/ubuntu/.cache/huggingface/hub
64		- volumes:
65		- hf-hub-cache:
	28	+ ```bash
	29	+ curl --silent --remote-name https://raw.githubusercontent.com/fedirz/faster-whisper-server/master/compose.yaml
	30	+ curl --silent --remote-name https://raw.githubusercontent.com/fedirz/faster-whisper-server/master/compose.cpu.yaml
	31	+ export COMPOSE_FILE=compose.cpu.yaml
66	32	```
	33	+
	34	+Start the service
	35	+
	36	+```bash
	37	+docker compose up --detach
	38	+```
67	39
68	40	??? note "Build from source"
69	41
...	...	@@ -129,11 +101,6 @@
129	101	# Build image without CUDA support
130	102	docker build --tag faster-whisper-server --build-arg BASE_IMAGE=ubuntu:24.04 .
131	103	```
132		-
133		-## Kubernetes
134		-
135		-WARNING: it was written few months ago and may be outdated.
136		-Please refer to this [blog post](https://substratus.ai/blog/deploying-faster-whisper-on-k8s)
137	104
138	105	## Python (requires Python 3.12+ and `uv` package manager)
139	106

Delete comment