# OpenWakeWord

OpenWakeWord is a self-hosted ai app. Wyoming protocol server for the OpenWakeWord wake word detection system that detects wake words from local audio streams for self-hosted Home Assistant-compatible voice pipelines without a web interface. It is open source and self-hosted, installable on Docker Hub and Unraid.

Canonical page: https://ourlocalhost.com/app/706/openwakeword

## Description

Wyoming protocol server for the OpenWakeWord wake word detection system that detects wake words from local audio streams for self-hosted Home Assistant-compatible voice pipelines without a web interface.

## Platform availability

Available on 1 of 9 platforms: Unraid.

## Health score

39/100 (Low), based on 3 of 4 factors.
- Maintained: 37 (last commit 357 days ago)
- Popular: 46 (204 GitHub stars)
- Easy to install: 35 (1 install platform, install notes, Docker image)

## Links

- GitHub: https://github.com/rhasspy/wyoming-openwakeword
- Docker Hub: https://hub.docker.com/r/rhasspy/wyoming-openwakeword/
- Unraid: https://ca.unraid.net/apps/openwakeword-08oe2o71yknvxn?q=openWakeWord

## Common questions

### What port should I expose for the openWakeWord container?

Expose TCP port 10400. The Docker example publishes 10400 to 10400, and the run script can be started with a 0.0.0.0:10400 URI.

### How do I use custom wake word models with the openWakeWord container?

Put the .tflite files in a directory and mount that directory into the container as /custom. Start the container with --custom-model-dir /custom.

### How can I enable verbose logging for openWakeWord?

Run the server with the --debug option. This prints lots of information to the console.

### Can I use a remote openWakeWord server in Home Assistant?

A Home Assistant user reported that remote Whisper and Piper could be configured, but openWakeWord appeared limited to local servers. The thread asks whether the integration was set up incorrectly.

---
Source: Our Local Host (https://ourlocalhost.com/app/706/openwakeword), the self-hosted and open-source app directory.