Skip to content

Commit bc336f2

Browse files
committed
update README to include locally built image instructions for docker compose
1 parent 1c13ae6 commit bc336f2

File tree

1 file changed

+32
-1
lines changed

1 file changed

+32
-1
lines changed

README.md

Lines changed: 32 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ audio in memory instead of saving it to the filesystem. If you have large media
1919

2020
* file permissions and user handling
2121
* Further software integrations
22-
* Persistent Queue
22+
* Persistent Queue
2323
* Translation and more advanced media checking (don't run if file already has subs, for example)
2424
* A basic web ui to queue transcription and view queued/in progress tasks.
2525
* Support for different models of whisper? (faster-whisper, openai whisper)
@@ -31,6 +31,10 @@ audio in memory instead of saving it to the filesystem. If you have large media
3131

3232
### Docker Compose
3333

34+
#### Pre-built image
35+
36+
If you encounter illegal instruction errors when the model attempts to run, you may need to build the image locally. See [Locally built image](#locally-built-image)
37+
3438
```yaml
3539
version: "3.8"
3640
services:
@@ -50,6 +54,33 @@ volumes:
5054
models:
5155
```
5256
57+
#### Locally built image
58+
59+
In many cases you may want or even *need* to build the image locally. Building locally can give you better optimizations
60+
for your specific hardware.
61+
Unfortunately, this means you will need to manually trigger rebuilds (`docker compose build`) and change versions
62+
yourself instead of letting a service like watchtower pull newer images for you.
63+
64+
```yaml
65+
version: "3.8"
66+
services:
67+
subgen:
68+
build:
69+
context: https://github.com/khakers/go-subgen.git
70+
restart: unless-stopped
71+
ports:
72+
- "8095:8095"
73+
volumes:
74+
# Path must be identical to the path in your other services
75+
- /path/to/your/media:/media
76+
# Models will be downloaded to this directory
77+
- models:/models
78+
environment:
79+
- MODEL_TYPE=base_en
80+
volumes:
81+
models:
82+
```
83+
5384
## Web API Endpoints
5485

5586
### Healthcheck

0 commit comments

Comments
 (0)