### [faster-whisper-server](https://github.com/fedirz/faster-whisper-server)

> Handle: `stt`<br/>
> URL: [http://localhost:34151](http://localhost:34151)

`faster-whisper-server` is an OpenAI API-compatible Speech-to-Text server backed by [faster-whisper](https://github.com/SYSTRAN/faster-whisper). It exposes the `/v1/audio/transcriptions` endpoint.

> [!NOTE]
> Harbor also ships [Speaches](./2.2.14-Backend&colon-Speaches.md) — a newer OpenAI-compatible STT/TTS server that supersedes `faster-whisper-server`. Consider using `speaches` for new setups.

---

#### Starting

```bash
# [Optional] pre-pull the image
harbor pull stt

# Start the service
harbor up stt
```

On first start the service will download the configured STT model from Hugging Face. Track progress in the service logs:

```bash
docker logs $(harbor ps stt) -f
```

#### Configuration

```bash
# Get/set the STT model to use
harbor stt model
harbor stt model openai/whisper-large-v3

# Get/set the docker tag to use
harbor stt version
harbor stt version latest
```

Run the following command to see all available config options:

```bash
harbor config ls | grep HARBOR_STT

# Port on the host where OpenAI-compatible API will be exposed
HARBOR_STT_HOST_PORT      34151
# Docker tag to use for the image (platform suffix appended automatically)
HARBOR_STT_VERSION        latest
# STT model in user/repo format
HARBOR_STT_MODEL          Systran/faster-distil-whisper-large-v3
```

See Harbor's [environment configuration guide](./1.-Harbor-User-Guide.md#environment-variables) to set arbitrary environment variables for the service.
