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

docs: build from source instructions

Browse files
Files changed (2) hide show
  1. docs/installation.md +25 -0
  2. mkdocs.yml +1 -0
docs/installation.md CHANGED
@@ -65,6 +65,18 @@ TODO: just reference the existing compose file in the repo
65
  hf-hub-cache:
66
  ```
67
 
 
 
 
 
 
 
 
 
 
 
 
 
68
  ## Docker
69
 
70
  === "CUDA"
@@ -105,6 +117,19 @@ TODO: just reference the existing compose file in the repo
105
  fedirz/faster-whisper-server:latest-cpu
106
  ```
107
 
 
 
 
 
 
 
 
 
 
 
 
 
 
108
  ## Kubernetes
109
 
110
  WARNING: it was written few months ago and may be outdated.
 
65
  hf-hub-cache:
66
  ```
67
 
68
+ ??? note "Build from source"
69
+
70
+ ```bash
71
+ # NOTE: you need to install and enable [buildx](https://github.com/docker/buildx) for multi-platform builds
72
+
73
+ # Build image with CUDA support
74
+ docker compose --file compose.cuda.yaml build
75
+
76
+ # Build image without CUDA support
77
+ docker compose --file compose.cpu.yaml build
78
+ ```
79
+
80
  ## Docker
81
 
82
  === "CUDA"
 
117
  fedirz/faster-whisper-server:latest-cpu
118
  ```
119
 
120
+ ??? note "Build from source"
121
+
122
+ ```bash
123
+ docker build --tag faster-whisper-server .
124
+
125
+ # NOTE: you need to install and enable [buildx](https://github.com/docker/buildx) for multi-platform builds
126
+ # Build image for both amd64 and arm64
127
+ docker buildx build --tag faster-whisper-server --platform linux/amd64,linux/arm64 .
128
+
129
+ # Build image without CUDA support
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.
mkdocs.yml CHANGED
@@ -50,6 +50,7 @@ nav:
50
  - API: api.md
51
  markdown_extensions:
52
  - admonition
 
53
  - pymdownx.superfences
54
  - pymdownx.tabbed:
55
  alternate_style: true
 
50
  - API: api.md
51
  markdown_extensions:
52
  - admonition
53
+ - pymdownx.details
54
  - pymdownx.superfences
55
  - pymdownx.tabbed:
56
  alternate_style: true