Add Docker Support and Documentation #297
Open
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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:
docker run
anddocker-compose
.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 themaster
branch. Let me know.