Faster-whisper is a reimplementation of OpenAI's Whisper model using CTranslate2, which is a fast inference engine for Transformer models. This container provides a Wyoming protocol server for faster-whisper.
lscr.io/linuxserver/faster-whisper:latest should retrieve the correct image for your arch, but you can also pull specific arch images via tags.
The architectures supported by this image are:
This image provides various versions that are available via tags. Please read the descriptions carefully and exercise caution when using unstable or development tags.
|Releases with Nvidia GPU support
For use with Home Assistant Assist, add the Wyoming integration and supply the hostname/IP and port that Whisper is running add-on."
When using the
gpu tag with Nvidia GPUs, make sure you set the container to use the
nvidia runtime and that you have the Nvidia Container Toolkit installed on the host and that you run the container with the correct GPU(s) exposed. See the Nvidia Container Toolkit docs for more details.
For more information see the faster-whisper docs,
To help you get started creating a container from this image you can either use docker-compose or the docker cli.
docker-compose (recommended, click here for more info)¶
- WHISPER_BEAM=1 #optional
- WHISPER_LANG=en #optional
docker cli (click here for more info)¶
Containers are configured using parameters passed at runtime (such as those above). These parameters are separated by a colon and indicate
<external>:<internal> respectively. For example,
-p 8080:80 would expose port
80 from inside the container to be accessible from the host's IP on port
8080 outside the container.
|Wyoming connection port.
Environment Variables (
|for UserID - see below for explanation
|for GroupID - see below for explanation
|specify a timezone to use, see this list.
|Whisper model that will be used for transcription. From
medium, all with
-int8 compressed variants
|Number of candidates to consider simultaneously during transcription.
|Language that you will speak to the add-on.
Volume Mappings (
|Local path for Whisper config files.
Environment variables from files (Docker secrets)¶
You can set any environment variable from a file by using a special prepend
As an example:
Will set the environment variable
MYVAR based on the contents of the
Umask for running applications¶
For all of our images we provide the ability to override the default umask settings for services started within the containers using the optional
-e UMASK=022 setting. Keep in mind umask is not chmod it subtracts from permissions based on it's value it does not add. Please read up here before asking for support.
User / Group Identifiers¶
When using volumes (
-v flags), permissions issues can arise between the host OS and the container, we avoid this issue by allowing you to specify the user
PUID and group
Ensure any volume directories on the host are owned by the same user you specify and any permissions issues will vanish like magic.
In this instance
PGID=1000, to find yours use
id your_user as below:
We publish various Docker Mods to enable additional functionality within the containers. The list of Mods available for this image (if any) as well as universal mods that can be applied to any one of our images can be accessed via the dynamic badges above.
Shell access whilst the container is running:
To monitor the logs of the container in realtime:
Container version number:
Image version number:
Most of our images are static, versioned, and require an image update and container recreation to update the app inside. With some exceptions (noted in the relevant readme.md), we do not recommend or support updating apps inside the container. Please consult the Application Setup section above to see if it is recommended for the image.
Below are the instructions for updating containers:
Via Docker Compose¶
You can also remove the old dangling images:
Via Docker Run¶
Update the image:
Stop the running container:
Delete the container:
Recreate a new container with the same docker run parameters as instructed above (if mapped correctly to a host folder, your
/configfolder and settings will be preserved)
You can also remove the old dangling images:
Image Update Notifications - Diun (Docker Image Update Notifier)¶
We recommend Diun for update notifications. Other tools that automatically update containers unattended are not recommended or supported.
If you want to make local modifications to these images for development purposes or just to customize the logic:
The ARM variants can be built on x86_64 hardware using
Once registered you can define the dockerfile to use with
- 25.11.23: - Initial Release.