Skip to content

Add Docker Support and Documentation #297

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 3 commits into
base: master
Choose a base branch
from

Conversation

esauvisky
Copy link

I'm setting up a local voice assistant for home automation and noticed that, unlike other Wyoming services (Whisper, Piper, OpenWakeWord), there is no official Docker Hub image for Wyoming Satellite. This creates some confusion for users coming from Home Assistant, where containerized deployments are common.

This PR introduces:

  • Documentation on how to deploy a Wyoming Satellite instance using Docker.
  • Examples for both docker run and docker-compose.
  • Installation of alsa-utils within the container to ensure audio-related commands work out of the box.

Important

For this to be fully functional, the image built by this repository's Dockerfile needs to be published to Docker Hub as rhasspy/wyoming-satellite.

Next Steps

If this PR is well received and an official image is made available, I’d be happy to contribute further improvements. To begin, I would restructure the documentation to better clarify this repository’s role within the Wyoming ecosystem, ensuring users have a clear understanding of how different services interact. For example, rather than including installation instructions for Wyoming OpenWakeWord, we could simply link to its repository, reducing confusion for users who are still getting familiar with the system.

Additionally, I could set up a GitHub Actions workflow to automate the build and push process for the Docker image, ensuring that updates are automatically published to ghcr.io or Docker Hub whenever a commit or tag is pushed to the master branch. Let me know.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant