OVOS Wyoming Docker

A collection of Docker images for running OVOS services using the Wyoming Protocol. Use these images to run TTS, STT, and wake word services with Docker and Docker Compose.

---

Getting started

Build the images

Build all images manually:

./build.sh

Or build them with Docker Compose:

docker compose build

Add to Home Assistant

Add the services to Home Assistant with the Wyoming integration.

Add the OVOS agent with the Ollama integration.

Point your Wyoming satellites to OVOS.

---

Compose setup

Edit docker-compose.yml to fit your setup. Below is an example with multiple TTS, STT, and wake word services.

Set ${CONFIG_BASE_DIR} to the path that holds your mycroft.conf file.

services:
  ovos-assist-agent:
    image: ovos-persona/ovos-core
    restart: always
    container_name: ovos_core_persona
    # network_mode: host in order to be able to connect to the bus
    network_mode: host
    #ports:
    #  - 8337:8337
    
  wyoming-ovos-tts-sam:
    image: jarbasai/ovos-wyoming-tts-sam:latest
    container_name: wyoming-ovos-tts-sam
    restart: unless-stopped
    volumes:
      - ${CONFIG_BASE_DIR}/mycroft.conf:/etc/mycroft/mycroft.conf
    ports:
      - 10605:8080

  wyoming-ovos-tts-nos:
    image: jarbasai/ovos-wyoming-tts-nos:latest
    container_name: wyoming-ovos-tts-nos
    restart: unless-stopped
    volumes:
      - ${CONFIG_BASE_DIR}/mycroft.conf:/etc/mycroft/mycroft.conf
    ports:
      - 10604:8080

  wyoming-ovos-tts-mimic:
    image: jarbasai/ovos-wyoming-tts-mimic:latest
    container_name: wyoming-ovos-tts-mimic
    restart: unless-stopped
    volumes:
      - ${CONFIG_BASE_DIR}/mycroft.conf:/etc/mycroft/mycroft.conf
    ports:
      - 10603:8080

  wyoming-ovos-tts-google-tx:
    image: jarbasai/ovos-wyoming-tts-google-tx:latest
    container_name: wyoming-ovos-tts-google-tx
    restart: unless-stopped
    volumes:
      - ${CONFIG_BASE_DIR}/mycroft/mycroft.conf:/etc/mycroft/mycroft.conf
    ports:
      - 10602:8080

  wyoming-ovos-tts-matxa:
    image: jarbasai/ovos-wyoming-tts-matxa:latest
    container_name: wyoming-ovos-tts-matxa
    restart: unless-stopped
    volumes:
      - ${CONFIG_BASE_DIR}/mycroft/mycroft.conf:/etc/mycroft/mycroft.conf
    ports:
      - 10601:8080

  wyoming-ovos-tts-servers:
    image: jarbasai/ovos-wyoming-tts-servers:latest
    container_name: wyoming-ovos-tts-servers
    restart: unless-stopped
    volumes:
      - ${CONFIG_BASE_DIR}/mycroft/mycroft.conf:/etc/mycroft/mycroft.conf
    ports:
      - 10600:8080

  wyoming-ovos-stt-servers:
    image: jarbasai/ovos-wyoming-stt-servers:latest
    container_name: wyoming-ovos-stt-servers
    restart: unless-stopped
    volumes:
      - ${CONFIG_BASE_DIR}/mycroft/mycroft.conf:/etc/mycroft/mycroft.conf
    ports:
      - 10501:8080

  wyoming-ovos-chromium-stt:
    image: jarbasai/ovos-wyoming-chromium:latest
    container_name: wyoming-ovos-chromium-stt
    restart: unless-stopped
    volumes:
      - ${CONFIG_BASE_DIR}/mycroft/mycroft.conf:/etc/mycroft/mycroft.conf
    ports:
      - 10500:8080

  wyoming-ovos-wakewords:
    image: jarbasai/ovos-wyoming-wakewords:latest
    container_name: wyoming-ovos-wakewords
    restart: unless-stopped
    volumes:
      - ${CONFIG_BASE_DIR}/mycroft/mycroft.conf:/etc/mycroft/mycroft.conf
    ports:
      - 10900:8080

---

Configuration

All services use a shared mycroft.conf file. This file is usually at:

/etc/mycroft/mycroft.conf

Set ${CONFIG_BASE_DIR} to the base directory that holds your config, for example:

export CONFIG_BASE_DIR=$HOME/.config/mycroft

---

Testing

After all services start, test them with a Wyoming-compatible client.

---

Feedback and contributions

Pull requests are welcome. For a major change, open an issue first to discuss the change.

---

Related projects

• OpenVoiceOS/ovos-core — the OVOS assistant core these images run.
• Rhasspy/wyoming — the Wyoming Protocol used by these services.

Credits

Developed by TigreGótico for OpenVoiceOS.

This project was funded through the NGI0 Commons Fund, a fund established by NLnet with financial support from the European Commission's Next Generation Internet programme, under the aegis of DG Communications Networks, Content and Technology under grant agreement No 101135429.