linuxserver/faster-whisper 镜像文档

镜像概述和主要用途

linuxserver/faster-whisper 是基于 Faster-whisper 的Docker镜像。Faster-whisper是OpenAI Whisper模型的重新实现，使用CTranslate2作为Transformer模型的快速推理引擎。本容器提供了一个基于Wyoming协议的faster-whisper服务器，主要用于语音转文本(STT)任务。

LinuxServer.io团队提供的该容器具有以下特点：

• 定期及时的应用更新
• 简单的用户映射(PGID, PUID)
• 带有s6覆盖层的自定义基础镜像
• 每周基础操作系统更新，在整个LinuxServer.io生态系统中共享通用层，以最小化空间使用、停机时间和带宽
• 定期安全更新

核心功能和特性

• 高性能语音识别：基于CTranslate2优化的Whisper模型，提供比原始Whisper更快的推理速度
• Wyoming协议支持：可与Home Assistant等支持Wyoming协议的语音助手集成
• 多架构支持：x86-64和arm64架构
• GPU加速：提供支持Nvidia GPU的镜像版本
• 灵活的模型选择：支持多种Whisper模型和-int8压缩变体
• 可配置的转录参数：支持设置语言、beam数量等参数
• 本地模型支持：可使用本地提供的模型，无需从HuggingFace下载

支持的架构

该镜像利用docker manifest实现多平台支持。只需拉取 lscr.io/linuxserver/faster-whisper:latest 即可获取适合您架构的正确镜像，也可以通过标签拉取特定架构的镜像。

支持的架构：

版本标签

使用场景和适用范围

• Home Assistant语音助手集成：作为本地语音转文本服务
• 语音内容转录：将音频文件或实时音频转录为文本
• 语音命令识别：用于构建本地语音控制应用
• 多语言语音识别：支持多种语言的语音识别需求
• 资源受限环境：通过-int8模型变体在低资源设备上运行

应用设置

Home Assistant集成

要与Home Assistant Assist 一起使用，添加Wyoming集成并提供Whisper运行的主机名/IP和端口。

GPU支持设置

使用带有Nvidia GPU的gpu标签时，确保将容器设置为使用nvidia运行时，并且在主机上安装了Nvidia Container Toolkit，并使用正确的GPU暴露设置运行容器。有关更多详细信息，请参阅Nvidia Container Toolkit文档。

只读操作

此镜像可以在只读容器文件系统下运行。有关详细信息，请阅读文档。

详细的使用方法和配置说明

Docker Compose (推荐)

yaml
---
services:
  faster-whisper:
    image: lscr.io/linuxserver/faster-whisper:latest
    container_name: faster-whisper
    environment:
      - PUID=1000
      - PGID=1000
      - TZ=Etc/UTC
      - WHISPER_MODEL=tiny-int8
      - LOCAL_ONLY= #可选
      - WHISPER_BEAM=1 #可选
      - WHISPER_LANG=en #可选
    volumes:
      - /path/to/faster-whisper/data:/config
    ports:
      - ***:***
    restart: unless-stopped

Docker CLI

bash
docker run -d \
  --name=faster-whisper \
  -e PUID=1000 \
  -e PGID=1000 \
  -e TZ=Etc/UTC \
  -e WHISPER_MODEL=tiny-int8 \
  -e LOCAL_ONLY= `#可选` \
  -e WHISPER_BEAM=1 `#可选` \
  -e WHISPER_LANG=en `#可选` \
  -p ***:*** \
  -v /path/to/faster-whisper/data:/config \
  --restart unless-stopped \
  lscr.io/linuxserver/faster-whisper:latest

GPU支持的Docker Run示例

bash
docker run -d \
  --name=faster-whisper \
  --runtime=nvidia \
  -e NVIDIA_VISIBLE_DEVICES=all \
  -e PUID=1000 \
  -e PGID=1000 \
  -e TZ=Etc/UTC \
  -e WHISPER_MODEL=base-int8 \
  -p ***:*** \
  -v /path/to/faster-whisper/data:/config \
  --restart unless-stopped \
  lscr.io/linuxserver/faster-whisper:gpu

参数说明

容器通过运行时传递的参数进行配置。这些参数用冒号分隔，表示<外部>:<内部>。例如，-p 8080:80会将容器内的80端口暴露到主机的8080端口。

网络参数

环境变量

卷参数

其他参数

环境变量从文件读取 (Docker secrets)

可以通过使用特殊的前缀FILE__从文件设置任何环境变量。

例如：

bash
-e FILE__MYVAR=/run/secrets/mysecretvariable

这将根据/run/secrets/mysecretvariable文件的内容设置环境变量MYVAR。

用户/组标识符

使用卷(-v标志)时，主机操作系统和容器之间可能会出现权限问题。通过指定用户PUID和组PGID，可以避免此问题。

确保主机上的任何卷目录都由您指定的相同用户拥有，权限问题就会迎刃而解。

在此示例中PUID=1000和PGID=1000，可以使用id your_user命令查找您的用户ID和组ID：

bash
id your_user

示例输出：

text
uid=1000(your_user) gid=1000(your_user) groups=1000(your_user)

Docker Mods

我们发布了各种Docker Mods以启用容器内的附加功能。可通过上方动态徽章访问此镜像可用的Mods列表以及可应用于任何LinuxServer.io镜像的通用Mods。

支持信息

• 容器运行时的Shell访问：

  bash
  docker exec -it faster-whisper /bin/bash
  

• 实时监控容器日志：

  bash
  docker logs -f faster-whisper
  

• 容器版本号：

  bash
  docker inspect -f '{{ index .Config.Labels "build_version" }}' faster-whisper
  

• 镜像版本号：

  bash
  docker inspect -f '{{ index .Config.Labels "build_version" }}' lscr.io/linuxserver/faster-whisper:latest
  

更新信息

大多数镜像都是静态的、版本化的，需要更新镜像并重新创建容器才能更新内部的应用程序。除了某些例外情况(在相关的readme.md中注明)，我们不建议或支持在容器内更新应用程序。请查阅上方的应用设置部分，了解是否推荐对镜像进行更新。

使用Docker Compose更新

• 更新镜像：

  • 所有镜像：

    bash
    docker-compose pull
    

  • 单个镜像：

    bash
    docker-compose pull faster-whisper
    

• 更新容器：

  • 所有容器：

    bash
    docker-compose up -d
    

  • 单个容器：

    bash
    docker-compose up -d faster-whisper
    

• 也可以删除旧的悬空镜像：

  bash
  docker image prune
  

使用Docker Run更新

• 更新镜像：

  bash
  docker pull lscr.io/linuxserver/faster-whisper:latest
  

• 停止运行中的容器：

  bash
  docker stop faster-whisper
  

• 删除容器：

  bash
  docker rm faster-whisper
  

• 使用上述相同的docker run参数重新创建新容器(如果正确映射到主机文件夹，您的/config文件夹和设置将被保留)

• 也可以删除旧的悬空镜像：

  bash
  docker image prune
  

镜像更新通知 - Diun (Docker Image Update Notifier)

[!TIP] 我们推荐使用Diun进行更新通知。不推荐或支持其他自动更新容器的工具。

本地构建

如果您想对这些镜像进行本地修改以用于开发目的或自定义逻辑：

bash
git clone [***]
cd docker-faster-whisper
docker build \
  --no-cache \
  --pull \
  -t lscr.io/linuxserver/faster-whisper:latest .

可以使用lscr.io/linuxserver/qemu-static在x86_64硬件上构建ARM变体，反之亦然：

bash
docker run --rm --privileged lscr.io/linuxserver/qemu-static --reset

注册后，可以使用-f Dockerfile.aarch64指定要使用的dockerfile。

版本历史

• 20.08.25: - 添加gpu-legacy分支，支持Turing之前的显卡
• 10.08.25: - 添加本地模式支持
• 30.12.24: - 为非GPU构建添加arm64支持
• 05.12.24: - 从Github发布版构建，而非Pypi
• 18.07.24: - 基于Ubuntu Noble重建
• 19.05.24: - 在GPU分支上将CUDA升级到12
• 08.01.24: - 添加GPU分支
• 25.11.23: - 初始发布