Skip to content

feat: Docker Compose proxy default and custom-container docs - #101

Draft
JarbasAl wants to merge 1 commit into
devfrom
feat/docker-compose
Draft

feat: Docker Compose proxy default and custom-container docs#101
JarbasAl wants to merge 1 commit into
devfrom
feat/docker-compose

Conversation

@JarbasAl

@JarbasAl JarbasAl commented Jun 10, 2026

Copy link
Copy Markdown
Member

Summary

  • Dockerfile: python:3.11-slim base with ovos-tts-server[audio] + ovos-tts-plugin-server (proxy)
  • docker-compose.yml: docker compose up immediately serves TTS by proxying to the public OVOS community Piper servers — no local model required. Healthcheck on /status.
  • config/mycroft.conf: committed example; with no host set, the proxy plugin rotates across PUBLIC_TTS_SERVERS with automatic failover.
  • docs/custom-container.md: layer-on-top guide (example: ovos-tts-plugin-piper), compose-override pattern, MCP ([mcp] extra + --mcp flag) and UTCP documented.

Public endpoints used

  • https://pipertts.ziggyai.online, https://tts.smartgic.io/piper
  • Source: PUBLIC_TTS_SERVERS constant in ovos-tts-server-plugin ovos_tts_plugin_server/__init__.py

How to test

docker compose config   # clean
docker compose up -d --build
curl http://localhost:8080/status
curl "http://localhost:8080/v2/synthesize?utterance=hello%20world" -o hello.wav

Validated locally (real outputs):

$ docker ps --format "{{.Names}} {{.Status}}"
wt-dc-tts-ovos-tts-1 Up About a minute (healthy)

$ curl -s http://localhost:8080/status
{"status":"ok","plugin":"ovos-tts-plugin-server","gradio":false}

$ curl -s -w "\nHTTP %{http_code} in %{time_total}s, %{size_download} bytes\n" \
    -o tts-test.wav "http://localhost:8080/v2/synthesize?utterance=hello%20world"
HTTP 200 in 15.111697s, 36396 bytes

$ file tts-test.wav
tts-test.wav: RIFF (little-endian) data, WAVE audio, Microsoft PCM, 16 bit, mono 22050 Hz

End-to-end synthesis through the public Piper proxy confirmed working.

Blog draft

A text-to-speech API in one command.
The new docker-compose.yml turns ovos-tts-server into a drop-in TTS microservice: docker compose up and you have /v2/synthesize returning WAV audio, proxied through the public OVOS community Piper servers — no model download, no GPU. The same server also speaks MaryTTS, ElevenLabs, OpenAI, Polly, Azure and more via its compat layers, and exposes MCP/UTCP endpoints so your agents can talk too. Going local? Layer ovos-tts-plugin-piper on the image as shown in docs/custom-container.md.

🤖 Generated with Claude Code

@coderabbitai

coderabbitai Bot commented Jun 10, 2026

Copy link
Copy Markdown
Contributor

Important

Review skipped

Draft detected.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: 4eafe02d-575a-417b-808c-83837d4ee962

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Use the checkbox below for a quick retry:

  • 🔍 Trigger review
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch feat/docker-compose

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

@github-actions

github-actions Bot commented Jun 10, 2026

Copy link
Copy Markdown

Look what I found! The automated check results are in. 🔍

I've aggregated the results of the automated checks for this PR below.

🔍 Lint

The automated gnomes have finished their shift. 🍄

ruff: issues found — see job log

📋 Repo Health

Checking if the repo is following its diet. 🥗

✅ All required files present.

Latest Version: 1.1.0a2

ovos_tts_server/version.py — Version file
README.md — README
LICENSE.md — License file (consider renaming to LICENSE)
pyproject.toml — pyproject.toml
⚠️ setup.py — setup.py
CHANGELOG.md — Changelog
ovos_tts_server/version.py has valid version block markers

📊 Coverage

Checking the integrity of our test cases. 💎

98.9% total coverage (threshold: 90.0%)

Per-file coverage (5 files)
File Coverage Missing lines
ovos_tts_server/__main__.py 94.1% 1
ovos_tts_server/__init__.py 100.0% 0
ovos_tts_server/audio_utils.py 100.0% 0
ovos_tts_server/routers/__init__.py 100.0% 0
ovos_tts_server/version.py 100.0% 0

Full report: download the coverage-report artifact.

🏷️ Release Preview

The release notes are being proofread by the gnomes. 🍄

Current: 1.1.0a2Next: 1.2.0a1

Signal Value
Label feature
PR title feat: Docker Compose proxy default and custom-container docs
Bump minor

✅ PR title follows conventional commit format.


🚀 Release Channel Compatibility

Predicted next version: 1.2.0a1

Channel Status Note Current Constraint
Stable Not in channel -
Testing Not in channel -
Alpha Not in channel -

🔒 Security (pip-audit)

A detailed security audit of your contribution. 📝

✅ No known vulnerabilities found (70 packages scanned).

⚖️ License Check

Ensuring no copyleft violations in this PR. ⬅️

✅ No license violations found (51 packages).

License distribution: 12× MIT, 12× MIT License, 6× Apache-2.0, 5× Apache Software License, 4× BSD-3-Clause, 2× ISC License (ISCL), 2× PSF-2.0, 2× Python Software Foundation License, +6 more

Full breakdown — 51 packages
Package Version License URL
annotated-doc 0.0.4 MIT link
annotated-types 0.7.0 MIT License link
anyio 4.13.0 MIT link
audioop-lts 0.2.2 PSF-2.0 link
build 1.5.0 MIT link
certifi 2026.5.20 Mozilla Public License 2.0 (MPL 2.0) link
charset-normalizer 3.4.7 MIT link
click 8.4.1 BSD-3-Clause link
combo_lock 0.3.1 Apache-2.0 link
fastapi 0.136.3 MIT link
filelock 3.29.3 MIT link
h11 0.16.0 MIT License link
idna 3.18 BSD-3-Clause link
importlib_metadata 9.0.0 Apache-2.0 link
json-database 0.10.1 MIT link
kthread 0.2.3 MIT License link
langcodes 3.5.1 MIT License link
markdown-it-py 4.2.0 MIT License link
mdurl 0.1.2 MIT License link
memory-tempfile 2.2.3 MIT License link
ovos-config 2.1.1 Apache-2.0 link
ovos-plugin-manager 2.2.0 Apache-2.0 link
ovos-tts-server 1.1.0a2 Apache-2.0 link
ovos-utils 0.8.5 Apache-2.0 link
ovos_bus_client 1.5.0 Apache Software License link
packaging 26.2 Apache-2.0 OR BSD-2-Clause link
pexpect 4.9.0 ISC License (ISCL) link
ptyprocess 0.7.0 ISC License (ISCL) link
pydantic 2.13.4 MIT link
pydantic_core 2.46.4 MIT link
pyee 12.1.1 MIT License link
Pygments 2.20.0 BSD-2-Clause link
pyproject_hooks 1.2.0 MIT License link
python-dateutil 2.9.0.post0 Apache Software License; BSD License link
PyYAML 6.0.3 MIT License link
quebra-frases 0.3.7 Apache Software License link
regex 2026.5.9 Apache-2.0 AND CNRI-Python link
requests 2.34.2 Apache Software License link
rich 13.9.4 MIT License link
rich-click 1.9.8 MIT License

Copyright (c) 2022 Phil Ewels

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
| link |
| six | 1.17.0 | MIT License | link |
| standard-aifc | 3.13.0 | Python Software Foundation License | link |
| standard-chunk | 3.13.0 | Python Software Foundation License | link |
| starlette | 1.2.1 | BSD-3-Clause | link |
| typing-inspection | 0.4.2 | MIT | link |
| typing_extensions | 4.15.0 | PSF-2.0 | link |
| urllib3 | 2.7.0 | MIT | link |
| uvicorn | 0.49.0 | BSD-3-Clause | link |
| watchdog | 6.0.0 | Apache Software License | link |
| websocket-client | 1.9.0 | Apache Software License | link |
| zipp | 4.1.0 | MIT | link |

Policy: Apache 2.0 (universal donor). StrongCopyleft / NetworkCopyleft / WeakCopyleft / Other / Error categories fail. MPL allowed.

🔨 Build Tests

Checking the blueprint against the actual construction. 📐

✅ All versions pass

Python Build Install Tests
3.10
3.11
3.12
3.13
3.14

Providing clarity through automated analysis 🔍

- Dockerfile: python:3.11-slim base, installs ovos-tts-server[audio]
  and ovos-tts-plugin-server (proxy)
- docker-compose.yml: builds image, mounts config/mycroft.conf, exposes
  :8080, healthcheck on /status; default proxies to public Piper TTS at
  https://tts.smartgic.io/piper (source: ovos-tts-plugin-server PUBLIC_TTS_SERVERS)
- config/mycroft.conf: example proxy config pointing at public server
- docs/custom-container.md: layer-on-top instructions using
  ovos-tts-plugin-piper; MCP/UTCP extras documented

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
@JarbasAl
JarbasAl force-pushed the feat/docker-compose branch from c601653 to a311ae9 Compare June 10, 2026 23:27
@github-actions github-actions Bot added feature and removed feature labels Jun 10, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant