Skip to content
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

Add docker instructions #49

Merged
merged 1 commit into from
Apr 6, 2024
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 6 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,11 @@ Depending on your use case there are different installation options.
[![Open your Home Assistant instance and show the add add-on repository dialog with a specific repository URL pre-filled.](https://my.home-assistant.io/badges/supervisor_add_addon_repository.svg)](https://my.home-assistant.io/redirect/supervisor_add_addon_repository/?repository_url=https%3A%2F%2Fgit.luolix.top%2Fhome-assistant%2Faddons-example)

- **Docker container**
Coming soon...
To run as a Docker container use the following command:
```bash
docker run ghcr.io/hugobloem/wyoming-microsoft-stt-noha:latest --<key> <value>
```
For the relevant keys please look at [the table below](#usage)

## Usage
Depending on the installation method parameters are parsed differently. However, the same options are used for each of the installation methods and can be found in the table below. Your service region and subscription key can be found on the speech service resource page (step 5 the Azure Speech service instructions).
Expand All @@ -51,4 +55,4 @@ python -m wyoming-microsoft-tts --<key> <value>
| `auto-punctuation` | Yes | Automatically add punctuation (default: `".?!"`) |
| `samples-per-chunk` | Yes | Number of samples per audio chunk (default: 1024) |
| `update-voices` | Yes | Download latest languages.json during startup |
| `debug` | Yes | Log debug messages |
| `debug` | Yes | Log debug messages |