Gives Home Assistant's voice assistant a natural-sounding voice, spoken on your own server rather than by a cloud
On this page
Good to know before you install
It has no page of its own: Home Assistant on this server uses it.
At a glance#
- What it is
- Text to Speech 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 Piper here yet. Everything below comes straight from the app catalogue, so it's what LibrePortal really does when you install it. For using Piper itself, its own documentation is the place to go: github.com/OHF-Voice/wyoming-piper.
Addresses and ports#
Piper 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 |
|---|---|---|
| Text to speech (Wyoming) TCP | local | Port only |
Settings#
These are Piper's own settings on its Config tab. The settings every app shares, like backups, updates and where its data lives, are explained in App pages and settings.
| Setting | What it does | Starts as |
|---|---|---|
| Voice | The voice Home Assistant's voice assistant speaks with. Choices: One for this server's language, English (UK), Alan, English (UK), Jenny, English (US), Lessac, English (US), Amy, German, Thorsten, French, Siwis, Spanish (Spain), Davefx, Spanish (Mexico), Ald, Italian, Paola, Dutch, Pim, Dutch (Belgium), Nathalie, Portuguese (Brazil), Faber, Polish, Gosia, Swedish, NST, Danish, Talesyntese, Norwegian, Talesyntese, Finnish, Harri, Czech, Jirka, Russian, Irina, Ukrainian, Turkish, DFKI, Greek, Rapunzelina, Hungarian, Anna, Romanian, Mihai, Catalan, Ona, Welsh, Gwryw Gogleddol, Vietnamese, Vais1000, Chinese, Huayan |
auto |
In its config file#
A few more 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_PIPER_DISPLAY_NAME |
What this app is called on your dashboards. Leave empty to use its usual name | Empty |
Show on the LibrePortal DashboardCFG_PIPER_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 Piper 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 Piper turns text into speech entirely on your server. The only outside contact is downloading the voice file once, the first time it starts.
What leaves this server#
- The chosen voice is downloaded once from Hugging Face
What LibrePortal turns off#
- Hugging Face telemetry
Licence: MIT (wyoming-piper); Piper engine and some voices have their own licences (piper1-gpl is GPL-3.0). Audited: 21 October 2026. See the privacy of every app and the Promise.
Sources#
Under the hood#
- It runs this image:
rhasspy/wyoming-piper:2.5.2@sha256:7d39aafac409c2b6b09d999ed04d84c311d632e558b35baa60fad6aac722af7a. - It can sit behind Authelia's sign-in once Authelia is installed.
- Its own project and documentation: github.com/OHF-Voice/wyoming-piper
Ports, settings, tools and connections on this page are read from LibrePortal v0.10.97's app catalogue each time the guide is built.