Run builder

README.md

@@ -94,11 +94,13 @@ services:
       - 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
       - PIPER_PROCS=1 #optional
+      - STREAMING= #optional
     volumes:
       - /path/to/piper/data:/config
     ports:
@@ -115,11 +117,13 @@ docker run -d \
   -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 PIPER_PROCS=1 `#optional` \
+  -e STREAMING= `#optional` \
   -p 10200:10200 \
   -v /path/to/piper/data:/config \
   --restart unless-stopped \
@@ -137,11 +141,13 @@ Containers are configured using parameters passed at runtime (such as those abov
 | `-e PGID=1000` | for GroupID - see below for explanation |
 | `-e TZ=Etc/UTC` | specify a timezone to use, see this [list](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones#List). |
 | `-e PIPER_VOICE=en_US-lessac-medium` | The [Piper voice](https://huggingface.co/rhasspy/piper-voices/tree/main) 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 PIPER_PROCS=1` | Number of Piper processes to run simultaneously. |
+| `-e STREAMING=` | Setting to `true`, or any other value, will enable 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](https://docs.linuxserver.io/misc/read-only/). |
 
@@ -307,6 +313,7 @@ Once registered you can define the dockerfile to use with `-f Dockerfile.aarch64
 
 ## Versions
 
+* **29.08.25:** - Add streaming support & support for local only mode.
 * **26.11.24:** - Add GPU branch.
 * **18.07.24:** - Rebase to Ubuntu Noble.
 * **25.11.23:** - Initial Release.