Fedir Zadniprovskyi commited on
Commit
82175fe
·
1 Parent(s): d1eca8b

docs: update docker compose instructions

Browse files
Files changed (1) hide show
  1. docs/installation.md +25 -58
docs/installation.md CHANGED
@@ -1,70 +1,42 @@
1
  ## Docker Compose (Recommended)
2
 
3
- TODO: just reference the existing compose file in the repo
 
 
 
 
 
4
  === "CUDA"
5
 
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:
24
  ```
25
 
26
  === "CUDA (with CDI feature enabled)"
27
 
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:
50
  ```
51
 
52
  === "CPU"
53
 
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:
66
  ```
67
 
 
 
 
 
 
 
68
  ??? note "Build from source"
69
 
70
  ```bash
@@ -130,11 +102,6 @@ TODO: just reference the existing compose file in the repo
130
  docker build --tag faster-whisper-server --build-arg BASE_IMAGE=ubuntu:24.04 .
131
  ```
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
-
138
  ## Python (requires Python 3.12+ and `uv` package manager)
139
 
140
  ```bash
 
1
  ## Docker Compose (Recommended)
2
 
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
+
9
  === "CUDA"
10
 
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
 
 
 
 
 
 
 
 
 
 
 
 
 
 
15
  ```
16
 
17
  === "CUDA (with CDI feature enabled)"
18
 
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
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
24
  ```
25
 
26
  === "CPU"
27
 
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
 
 
 
 
 
 
 
 
32
  ```
33
 
34
+ Start the service
35
+
36
+ ```bash
37
+ docker compose up --detach
38
+ ```
39
+
40
  ??? note "Build from source"
41
 
42
  ```bash
 
102
  docker build --tag faster-whisper-server --build-arg BASE_IMAGE=ubuntu:24.04 .
103
  ```
104
 
 
 
 
 
 
105
  ## Python (requires Python 3.12+ and `uv` package manager)
106
 
107
  ```bash