Images¶

Pre-build images

Open Voice OS provides pre-build images available on Docker Hub. These images are referenced by default within the docker-compose.*.yml files.

Open Voice OS is a sofisticated piece of software which has several components. These components have been split into containers to provide a better isolation and a microservices approach.

GUI images size

The GUI container images are larger than the other images as they need many QT libraries and GStreamer plugins in order to provide all the features supported by the voice assistant.

Supported CPU architectures¶

Container images could be used for different CPU architectures using the multi-platform images feature.

CPU architecture	Description
`amd64`	Such as AMD and Intel processors
`aarch64`	Such as Raspberry Pi 64-bit SoC
`armv7l`	Such as Raspberry Pi 32-bit SoC (not supported because of `onnxruntime`¹)

Containers¶

The list below is not exhaustive and doesn't mention anything about skill containers, but it is a fair list of the main components currently supported in ovos-docker.

Container	Description
`ovos_messagebus`	Read more about ovos-messagebus
`ovos_phal`	Read more about ovos-phal
`ovos_phal_admin`	Read more about ovos-phal admin variant
`ovos_audio`	Read more about ovos-audio
`ovos_listener`	Read more about ovos-listener
`ovos_core`	Read more about ovos-core
`ovos_cli`	Read more about ovos-cli
`ovos_gui_websocket`	Read more about ovos-gui-messagebus
`ovos_gui`	Read more about ovos-gui
`hivemind_listener`	Read more about hivemind-listener
`hivemind_cli`	Read more about hivemind-cli

Tags¶

Container image tags allows you to deploy a specific version of Open Voice OS, it could be an untested version based on nigthly build or a stable version.

Image tag	Description
`alpha`	Nightly build based on alpha releases from PyPi
`0.0.8a`	Nightly build based on alpha releases from PyPi
`stable`	Build at every new stable release
`0.0.8`	Build at every new stable release

Stable release

As Open Voice OS doesn't have a stable release for version 0.0.8 which has been designed to work with containers, there is no stable or 0.0.8 tags available yet.

Volumes¶

To allow data persistence, Docker or Podman volumes are required, they will prevent downloading the requirements everytime the containers are re-created.

Volume	Description
`ovos_gui_file`	Share QML files from skills between the GUI message bus and the GUI client
`ovos_listener_records`	Wake words and utterances recorded samples
`ovos_local_state`	Moslty used to store logs from the different components
`ovos_models`	Models downloaded by `precise-lite` wake word plugin
`ovos_nltk`	Punkt Python package required by NLTK
`ovos_tts_cache`	`.wav` and `.pho` files acting as cache from TTS transcription
`ovos_vosk`	Models downloaded by VOSK during the initial boot

ovos_listener_records allows you to store samples of wake words and utterances which could help you to build or improve models.

Enable samples recording

By default the recording features are disabled, "record_wake_words": true and "save_utterances": true will have to be added to the listener section of mycroft.conf to enable these capabilities.

~/ovos/config/mycroft.conf

{
"listener": {
    "record_wake_words": true,
    "save_utterances": true
  }
}

But first thing's first you need to have Open Voice OS's containers up and running. Follow the guide.

https://github.com/microsoft/onnxruntime/issues/15337 ↩