dasemu/Transcriptarr
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Update README.md

Browse Source
This commit is contained in:
McCloudS
2023-01-30 14:58:38 -07:00
committed by GitHub
parent a2e6f79ecf
commit d9f3aba829
1 changed files with 12 additions and 21 deletions
Download Patch File Download Diff File Expand all files Collapse all files

33
README.md
View File

@@ -53,27 +53,18 @@ It should look like:
![Alt text](WebhookSettings.png?raw=true "Webhook Settings")
The docker-compose/Dockerfile settings are relatively straight forward (and poorly commented).
ARG WHISPER_MODEL medium this can be tiny, base, small, medium, large
ARG WHISPER_SPEEDUP False this adds the option -su "speed up audio by x2 (reduced accuracy)"
ARG WHISPER_THREADS 4 number of threads to use during computation
ARG WHISPER_PROCESSORS 1 number of processors to use during computation
ARG PROCADDEDMEDIA True will gen subtitles for all media added regardless of existing external/embedded subtitles
ARG PROCMEDIAONPLAY True will gen subtitles for all played media regardless of existing external/embedded subtitles
ARG NAMESUBLANG aa use 2 letter codes @ https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes // makes it easier to see which subtitles are generated by subgen -- names file like: "Community - S03E18 - Course Listing Unavailable.aa.subgen.srt"
ARG UPDATEREPO True pulls and merges whisper.cpp on every start
NAMESUBLANG allows you to pick what it will name the subtitle. Instead of using EN, I'm using AA, so it doesn't mix with exiting external EN subs, and AA will populate higher on the list in Plex.
The following environment variables are optional in Docker-compose. They will default to the values listed below.
| Variable | Default Value | Description |
|-----------------------|---------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| WHISPER_MODEL | medium | this can be tiny, base, small, medium, large |
| WHISPER_SPEEDUP | False | this adds the option -su "speed up audio by x2 (reduced accuracy)" |
| WHISPER_THREADS | 4 | number of threads to use during computation |
| WHISPER_PROCESSORS | 1 | number of processors to use during computation |
| PROCADDEDMEDIA | True | will gen subtitles for all media added regardless of existing external/embedded subtitles (based off of SKIPIFINTERNALSUBLANG) |
| PROCMEDIAONPLAY | False | will gen subtitles for all played media regardless of existing external/embedded subtitles (based off of SKIPIFINTERNALSUBLANG) |
| NAMESUBLANG | aa | allows you to pick what it will name the subtitle. Instead of using EN, I'm using AA, so it doesn't mix with exiting external EN subs, and AA will populate higher on the list in Plex. |
| UPDATEREPO | True | pulls and merges whisper.cpp on every start |
| SKIPIFINTERNALSUBLANG | eng | Will not generate a subtitle if the file has an internal sub matching the 3 letter code of this variable (See https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) |
## Docker Volumes
You MUST mount your media volumes in subgen the same way Plex sees them. For example, if Plex uses "/Share/media/TV:/tv" you must have that identical volume in subgen.