Piper

Piper is a fast, local neural text to speech system that sounds great and is optimized for the Raspberry Pi 4. This container provides a Wyoming protocol server for Piper.

Image details

Pulls: 373k

Architectures: amd64, arm64

Image size: 121 MB

Latest: 2.3.1

User: linuxserver

Created: Nov 30, 2023

Updated: 10 hours ago

Status: active

Source details

Repo: rhasspy/wyoming-piper

Stars: 191

Forks: 57

Language: Python

License: MIT

Latest: v2.3.1 · 6 days ago

Updated: 6 days ago

Configuration

Type

Container

Platform

linux

Image

linuxserver/piper:latest

Ports

10200:10200/tcp

Volumes

/config : /srv/lsio/piper/config

Env vars

PUID=1000PGID=1000TZ=Etc/UTCPIPER_VOICE=en_US-lessac-mediumLOCAL_ONLY=PIPER_LENGTH=1.0PIPER_NOISE=0.667PIPER_NOISEW=0.333PIPER_SPEAKER=0NO_STREAMING=

Restart

unless-stopped

Template by technorabilia

Notes

Portainer App Templates by Technorabilia, based on data provided by LinuxServer.io.

Ensure to create the following volume directories on the host file system, or modify the paths in the volume mapping section under the advanced options below, as needed.

mkdir -p /srv/lsio/piper/config

Installation

Ensure both Docker and Portainer are installed, and up-to-date
Log into your Portainer web UI
Under Settings → App Templates, paste the below URL
Head to Home → App Templates, and the list of apps will show up
Select the app you wish to deploy, fill in any config options, and hit Deploy

Template Import URL

https://raw.githubusercontent.com/Lissy93/portainer-templates/main/templates.json

Show Me

docker run -d --name Piper \
  -p 10200:10200/tcp \
  -e 'PUID=1000' \
  -e 'PGID=1000' \
  -e 'TZ=Etc/UTC' \
  -e 'PIPER_VOICE=en_US-lessac-medium' \
  -e 'LOCAL_ONLY=' \
  -e 'PIPER_LENGTH=1.0' \
  -e 'PIPER_NOISE=0.667' \
  -e 'PIPER_NOISEW=0.333' \
  -e 'PIPER_SPEAKER=0' \
  -e 'NO_STREAMING=' \
  -v /srv/lsio/piper/config:/config \
  --restart=unless-stopped \
  linuxserver/piper:latest

Save this file as compose.yaml and run docker compose up -d
Use this only as a guide.

services:
  piper:
    image: linuxserver/piper:latest
    ports:
      - 10200:10200/tcp
    volumes:
      - /srv/lsio/piper/config:/config
    environment:
      PUID: '1000'
      PGID: '1000'
      TZ: Etc/UTC
      PIPER_VOICE: en_US-lessac-medium
      LOCAL_ONLY: ''
      PIPER_LENGTH: '1.0'
      PIPER_NOISE: '0.667'
      PIPER_NOISEW: '0.333'
      PIPER_SPEAKER: '0'
      NO_STREAMING: ''
    restart: unless-stopped

Save this file as piper-stack.yml, then from a manager node, run docker stack deploy -c piper-stack.yml piper

version: '3.8'
services:
  piper:
    image: linuxserver/piper:latest
    ports:
      - 10200:10200/tcp
    volumes:
      - /srv/lsio/piper/config:/config
    environment:
      PUID: '1000'
      PGID: '1000'
      TZ: Etc/UTC
      PIPER_VOICE: en_US-lessac-medium
      LOCAL_ONLY: ''
      PIPER_LENGTH: '1.0'
      PIPER_NOISE: '0.667'
      PIPER_NOISEW: '0.333'
      PIPER_SPEAKER: '0'
      NO_STREAMING: ''
    deploy:
      restart_policy:
        condition: any

Save each file below into a folder, then run kubectl apply -f .
Written for k3s, but works on any cluster: bind mounts use hostPath, named volumes get a persistent volume claim, and ports are exposed via a LoadBalancer service.

`piper-deployment.yaml`

apiVersion: apps/v1
kind: Deployment
metadata:
  name: piper
  labels:
    app: piper
spec:
  replicas: 1
  selector:
    matchLabels:
      app: piper
  template:
    metadata:
      labels:
        app: piper
    spec:
      containers:
        - name: piper
          image: linuxserver/piper:latest
          env:
            - name: PUID
              value: '1000'
            - name: PGID
              value: '1000'
            - name: TZ
              value: Etc/UTC
            - name: PIPER_VOICE
              value: en_US-lessac-medium
            - name: LOCAL_ONLY
              value: ''
            - name: PIPER_LENGTH
              value: '1.0'
            - name: PIPER_NOISE
              value: '0.667'
            - name: PIPER_NOISEW
              value: '0.333'
            - name: PIPER_SPEAKER
              value: '0'
            - name: NO_STREAMING
              value: ''
          ports:
            - containerPort: 10200
              protocol: TCP
          volumeMounts:
            - name: piper-data-0
              mountPath: /config
      volumes:
        - name: piper-data-0
          hostPath:
            path: /srv/lsio/piper/config

`piper-service.yaml`

apiVersion: v1
kind: Service
metadata:
  name: piper
spec:
  type: LoadBalancer
  selector:
    app: piper
  ports:
    - name: 10200-tcp
      port: 10200
      targetPort: 10200
      protocol: TCP

Save this file as ~/.config/containers/systemd/piper.container

[Unit]
Description=Piper

[Container]
Image=linuxserver/piper:latest
ContainerName=piper
PublishPort=10200:10200/tcp
Environment=PUID=1000
Environment=PGID=1000
Environment=TZ=Etc/UTC
Environment=PIPER_VOICE=en_US-lessac-medium
Environment=LOCAL_ONLY=
Environment=PIPER_LENGTH=1.0
Environment=PIPER_NOISE=0.667
Environment=PIPER_NOISEW=0.333
Environment=PIPER_SPEAKER=0
Environment=NO_STREAMING=
Volume=/srv/lsio/piper/config:/config

[Service]
Restart=always

[Install]
WantedBy=default.target

Then reload systemd and start the service:

systemctl --user daemon-reload
systemctl --user start piper

For a system-wide service, use /etc/containers/systemd/ and drop --user.

For more installation options, see the Documentation in our GitHub repo

For app-specific guidance, check Piper's own repo at rhasspy/wyoming-piper

The LinuxServer.io team brings you another container release featuring:

regular and timely application updates
easy user mappings (PGID, PUID)
custom base image with s6 overlay
weekly base OS updates with common layers across the entire LinuxServer.io ecosystem to minimise space usage, down time and bandwidth
regular security updates

Find us at:

Blog - all the things you can do with our containers including How-To guides, opinions and much more!
Discord - realtime support / chat with the community and the team.
Discourse - post on our community forum.
GitHub - view the source for all of our repositories.
Open Collective - please consider helping us by either donating or contributing to our budget

linuxserver/piper

Piper is a fast, local neural text to speech system that sounds great and is optimized for the Raspberry Pi 4. This container provides a Wyoming protocol server for Piper.

Supported Architectures

We utilise the docker manifest for multi-platform awareness. More information is available from docker here and our announcement here.
Simply pulling lscr.io/linuxserver/piper:latest should retrieve the correct image for your arch, but you can also pull specific arch images via tags.
The architectures supported by this image are:
| Architecture | Available | Tag | | :----: | :----: | ---- | | x86-64 | ✅ | amd64-\ | | arm64 | ✅ | arm64v8-\ |

Application Setup

For use with Home Assistant Assist, add the Wyoming integration and supply the hostname/IP and port that piper is running add-on."
For more information see the wyoming piper docs,

Read-Only Operation

This image can be run with a read-only container filesystem. For details please read the docs.

Usage

To help you get started creating a container from this image you can either use docker-compose or the docker cli.
>!NOTE >Unless a parameter is flagged as 'optional', it is mandatory and a value must be provided.

docker-compose (recommended, click here for more info)

---
services:
  piper:
    image: lscr.io/linuxserver/piper:latest
    container_name: piper
    environment:
      - PUID=1000
      - PGID=1000
      - TZ=Etc/UTC
      - PIPER_VOICE=en_US-lessac-medium
      - LOCAL_ONLY= #optional
      - PIPER_LENGTH=1.0 #optional
      - PIPER_NOISE=0.667 #optional
      - PIPER_NOISEW=0.333 #optional
      - PIPER_SPEAKER=0 #optional
      - NO_STREAMING= #optional
    volumes:
      - /path/to/piper/data:/config
    ports:
      - 10200:10200
    restart: unless-stopped

docker cli (click here for more info)

docker run -d \
  --name=piper \
  -e PUID=1000 \
  -e PGID=1000 \
  -e TZ=Etc/UTC \
  -e PIPER_VOICE=en_US-lessac-medium \
  -e LOCAL_ONLY= `#optional` \
  -e PIPER_LENGTH=1.0 `#optional` \
  -e PIPER_NOISE=0.667 `#optional` \
  -e PIPER_NOISEW=0.333 `#optional` \
  -e PIPER_SPEAKER=0 `#optional` \
  -e NO_STREAMING= `#optional` \
  -p 10200:10200 \
  -v /path/to/piper/data:/config \
  --restart unless-stopped \
  lscr.io/linuxserver/piper:latest

Parameters

Containers are configured using parameters passed at runtime (such as those above). These parameters are separated by a colon and indicate <external>:<internal> respectively. For example, -p 8080:80 would expose port 80 from inside the container to be accessible from the host's IP on port 8080 outside the container.
| Parameter | Function | | :----: | --- | | -p 10200:10200 | Wyoming connection port. | | -e PUID=1000 | for UserID - see below for explanation | | -e PGID=1000 | for GroupID - see below for explanation | | -e TZ=Etc/UTC | specify a timezone to use, see this list. | | -e PIPER_VOICE=en_US-lessac-medium | The Piper voice to use, in the format <language>-<name>-<quality> | | -e LOCAL_ONLY= | 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. | | -e PIPER_LENGTH=1.0 | Voice speaking rate, 1.0 is default with < 1.0 being faster and > 1.0 being slower. | | -e PIPER_NOISE=0.667 | Controls the variability of the voice by adding noise. Values above 1 will start to degrade audio. | | -e PIPER_NOISEW=0.333 | Controls the variability of speaking cadence. Values above 1 produce extreme stutters and pauses. | | -e PIPER_SPEAKER=0 | Speaker number to use if the voice supports multiple speakers. | | -e NO_STREAMING= | Setting to true, or any other value, will disable support for streaming audio on sentence boundaries. | | -v /config | Local path for piper config files. | | --read-only=true | Run container with a read-only filesystem. Please read the docs. |

Environment variables from files (Docker secrets)

You can set any environment variable from a file by using a special prepend FILE__.
As an example:

-e FILE__MYVAR=/run/secrets/mysecretvariable

Will set the environment variable MYVAR based on the contents of the /run/secrets/mysecretvariable file.

Umask for running applications

For all of our images we provide the ability to override the default umask settings for services started within the containers using the optional -e UMASK=022 setting. Keep in mind umask is not chmod it subtracts from permissions based on it's value it does not add. Please read up here before asking for support.

User / Group Identifiers

When using volumes (-v flags), permissions issues can arise between the host OS and the container, we avoid this issue by allowing you to specify the user PUID and group PGID.
Ensure any volume directories on the host are owned by the same user you specify and any permissions issues will vanish like magic.
In this instance PUID=1000 and PGID=1000, to find yours use id your_user as below:

id your_user

Example output:

uid=1000(your_user) gid=1000(your_user) groups=1000(your_user)

Docker Mods

We publish various Docker Mods to enable additional functionality within the containers. The list of Mods available for this image (if any) as well as universal mods that can be applied to any one of our images can be accessed via the dynamic badges above.

Support Info

Shell access whilst the container is running:

```bash
docker exec -it piper /bin/bash
```

To monitor the logs of the container in realtime:

```bash
docker logs -f piper
```

Container version number:

```bash
docker inspect -f '{{ index .Config.Labels "build_version" }}' piper
```

Image version number:

```bash
docker inspect -f '{{ index .Config.Labels "build_version" }}' lscr.io/linuxserver/piper:latest
```

Updating Info

Most of our images are static, versioned, and require an image update and container recreation to update the app inside. With some exceptions (noted in the relevant readme.md), we do not recommend or support updating apps inside the container. Please consult the Application Setup section above to see if it is recommended for the image.
Below are the instructions for updating containers:

Via Docker Compose

Update images:

* All images:

    ```bash
    docker-compose pull
    ```

* Single image:

    ```bash
    docker-compose pull piper
    ```

Update containers:

* All containers:

    ```bash
    docker-compose up -d
    ```

* Single container:

    ```bash
    docker-compose up -d piper
    ```

You can also remove the old dangling images:

```bash
docker image prune
```

Via Docker Run

Update the image:

```bash
docker pull lscr.io/linuxserver/piper:latest
```

Stop the running container:

```bash
docker stop piper
```

Delete the container:

```bash
docker rm piper
```

Recreate a new container with the same docker run parameters as instructed above (if mapped correctly to a host folder, your /config folder and settings will be preserved)
You can also remove the old dangling images:

```bash
docker image prune
```

Image Update Notifications - Diun (Docker Image Update Notifier)

>!TIP >We recommend Diun for update notifications. Other tools that automatically update containers unattended are not recommended or supported.

Building locally

If you want to make local modifications to these images for development purposes or just to customize the logic:

git clone https://github.com/linuxserver/docker-piper.git
cd docker-piper
docker build \
  --no-cache \
  --pull \
  -t lscr.io/linuxserver/piper:latest .

The ARM variants can be built on x8664 hardware and vice versa using lscr.io/linuxserver/qemu-static
docker run --rm --privileged lscr.io/linuxserver/qemu-static --reset

Once registered you can define the dockerfile to use with -f Dockerfile.aarch64.
Versions
29.08.25: - Add support for local only mode.
10.08.25: - Add streaming support.
18.07.24: - Rebase to Ubuntu Noble.
25.11.23: - Initial Release.

Serve Piper on your own domain behind Caddy, Nginx or Traefik. Fill in your domain and copy the result. It's a starting point, some apps need their own base URL or extra headers set too.

Proxy Domain App port Upstream

Proxying piper.example.com to http://Piper:10200

Add this to your Caddyfile

piper.example.com {
	reverse_proxy http://Piper:10200
}

Check the logs first

Nine times out of ten the logs tell you exactly what went wrong.

In Portainer, go to Containers, click the container, then Logs. Or run docker logs Piper
Exit codes help too: 137 means killed, usually out of memory. 126 or 127 means the command inside the image is broken.

Port already in use

If deployment fails with "Bind for 0.0.0.0:10200 failed: port is already allocated", something else on your server is using that port.

Find what's using it: sudo ss -tlnp | grep :10200
Stop the other service, or pick a different host port. In 10200:10200 only the left number is yours to change, the right one belongs to the app.

Running but the page won't load

The container is up but nothing appears in your browser.

Use your server's real IP: http://your-server-ip:10200. The 0.0.0.0 link Portainer shows isn't a real address.
Give it a minute after first deploy, Piper can take a while to initialise.
Make sure your firewall allows the port, e.g. sudo ufw allow 10200

Permission denied on volumes

If the logs show "permission denied", the app can't write to its data folder on the host.

Fix the ownership: sudo chown -R 1000:1000 /srv/lsio/piper/config
Or set the PUID and PGID variables (defaults 1000:1000) to match your own user, found with id $USER

Image won't pull

Test the pull directly on the host: docker pull linuxserver/piper:latest

"manifest unknown" means the tag no longer exists. This template uses latest, so try pinning a specific version instead.
"toomanyrequests" is the Docker Hub rate limit. Log in with docker login to raise it.
"no space left on device" means a full disk. Reclaim space with docker system prune

"exec format error"

This means the image was built for a different CPU architecture than your server.

This image supports: amd64, arm64
Check yours with uname -m: x86_64 is amd64, aarch64 is arm64. Raspberry Pi and other ARM boards are the usual culprits.

Container keeps restarting

The unless-stopped restart policy relaunches the app after every crash, so the real error can scroll past.

Check the logs right after a restart, the last few lines before it died are the useful ones.
Get the exit code with docker inspect Piper --format '{{.State.ExitCode}}'
Still stuck? Redeploy once with the restart policy set to no so the failure stays visible.

Required settings are blank

LOCAL_ONLY, NO_STREAMING have no default value, and Piper may crash or misbehave if left empty.

Fill them in on the deploy screen before hitting deploy.

Raise an issue

Found something which isn't working as it should? Here's how to report it.

Bug within the app: Open an issue on rhasspy/wyoming-piper
Template not working: Open an issue on technorabilia/portainer-templates
This website not working: Open an issue on lissy93/portainer-templates

Similar apps

Faster-whisper Machine Learning