Listens for a wake word such as Okay Nabu, so a voice satellite in your home can start talking to Home Assistant
On this page
Good to know before you install
It has no page of its own: Home Assistant uses it for voice satellites that stream their audio. Its pre-trained wake words are licensed for non-commercial use only.
At a glance#
- What it is
- Wake Word AI
- Where it opens
- No web page It works in the background
- Updates
- Automatic A backup is taken first, and it rolls back if the update fails
- Backups
- Left out Not in the scheduled backups unless you switch it on
- Copies
- One per server
There's no step-by-step guide for openWakeWord here yet. Everything below comes straight from the app catalogue, so it's what LibrePortal really does when you install it. For using openWakeWord itself, its own documentation is the place to go: github.com/rhasspy/wyoming-openwakeword.
Addresses and ports#
openWakeWord has one port. LibrePortal picks a free port number for each when you install, so yours will differ from anyone else's. The Config tab's Network section shows them, and the app's Open button uses the right one.
| What it is | Who can reach it | With a domain |
|---|---|---|
| Wake word (Wyoming) TCP | local | Port only |
Settings#
In its config file#
openWakeWord's own settings aren't on the Config tab yet. They live in the app's config file, described here so you know they exist. How to change them.
| Setting | What it does | Starts as |
|---|---|---|
NameCFG_OPENWAKEWORD_DISPLAY_NAME |
What this app is called on your dashboards. Leave empty to use its usual name | Empty |
Show on the LibrePortal DashboardCFG_OPENWAKEWORD_SHOW_ON_DASHBOARD |
Whether this app gets a shortcut on the front page of the LibrePortal WebUI, separate from any Dashy dashboard Choices: true, false |
false |
Works with#
These are the other apps openWakeWord knows how to work with. Once it's installed, its page shows the same list with whether each one is connected. How this works.
- Grafana: Shows dashboards for the apps that have one. works with every app
- Home Assistant: Understands and answers you without a cloud.
- Prometheus: Collects metrics from the apps that can export them. works with every app
- Uptime Kuma: Watches your apps and shows when one goes down. works with every app
Privacy and security#
All clear OpenWakeWord listens for a wake word like 'okay nabu' on your own network and does not contact the internet.
What leaves this server#
Nothing leaves this server on its own.
What LibrePortal turns off#
Nothing needed switching off.
Licence: Apache-2.0 (Wyoming wrapper; the bundled pre-trained wake-word models are, I believe, CC BY-NC-SA 4.0, non-commercial: verify). Audited: 21 October 2026. See the privacy of every app and the Promise.
Sources#
Under the hood#
- It runs this image:
rhasspy/wyoming-openwakeword:2.1.0@sha256:52cb1168731a1849fc28cf339c935fde58746bbabc94226668a40ef6ddf5d42b. - It can sit behind Authelia's sign-in once Authelia is installed.
- Its own project and documentation: github.com/rhasspy/wyoming-openwakeword
Ports, settings, tools and connections on this page are read from LibrePortal v0.10.97's app catalogue each time the guide is built.