name: linuxserver-faster-whisper
services:
  app:
    image: linuxserver/faster-whisper:3.1.0
    restart: unless-stopped
    environment:
      PUID: $PUID
      PGID: $PGID
      TZ: $TZ
      WHISPER_MODEL: ''
      LOCAL_ONLY: ''
      WHISPER_BEAM: ''
      WHISPER_LANG: ''
    x-casaos:
      envs:
        - container: PUID
          description:
            en_us: Run 'id [USER]' for the owner of the host volume directories to get the UID to use here.
        - container: PGID
          description:
            en_us: Run 'id [USER]' for the owner of the host volume directories to get the GID to use here.
        - container: TZ
          description:
            en_us: specify a timezone to use, see this list.
        - container: WHISPER_MODEL
          description:
            en_us: Whisper model that will be used for transcription. From here, all with -int8 compressed variants
        - container: LOCAL_ONLY
          description:
            en_us: If set to true, or any other value, the container will not attempt to download models from HuggingFace and will only use locally-provided models. [OPTIONAL]
        - container: WHISPER_BEAM
          description:
            en_us: Number of candidates to consider simultaneously during transcription. [OPTIONAL]
        - container: WHISPER_LANG
          description:
            en_us: Language that you will speak to the add-on. [OPTIONAL]
    ports:
      - target: 10300
        published: 10300
        protocol: tcp
    volumes:
      - type: bind
        source: /srv/lsio/faster-whisper/config
        target: /config
x-casaos:
  architectures:
    - amd64
    - arm64
  main: app
  description:
    en_us: 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.
  tagline:
    en_us: 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.
  developer: LinuxServer.io
  author: WisdomSky
  icon: ''
  thumbnail: ''
  title:
    en_us: Faster whisper
  category: LinuxServer.io
