README.md

🎉 Open Voice OS and HiveMind Installer 🎉

Welcome to the world of Open Voice OS and HiveMind! Get ready for a straightforward journey into voice tech.

🚀 Quickstart

Before we begin, make sure you have curl, git, and sudo installed. Here’s your installation incantation:

sudo sh -c "$(curl -fsSL https://raw.githubusercontent.com/OpenVoiceOS/ovos-installer/main/installer.sh)"

👉 Start your Open Voice OS journey!

🐧 Supported Linux distributions

Distribution	Version
AlmaLinux	>= 8
Arch	rolling
CentOS	>= 8
Debian GNU/Linux	>= 10
EndeavourOS	rolling
Fedora	>= 37
Linux Mint	>= 21
openSUSE Leap	>= 15
openSUSE Tumbleweed	rolling
openSUSE Slowroll	rolling
Manjaro	rolling
Raspbian	10
Raspberry Pi OS	>= 11
Rocky Linux	>=8
Ubuntu	>=20.04
WSL2	20.04
Zorin OS	>= 16

rolling as rolling Linux distribution which means that there is no specific version.

🔄 Update

To update the current Open Voice OS instance, backup your ~/.config/mycroft/mycroft.conf or ~/ovos/config/mycroft.conf (only if required) and re-run installer but answer "No" to the "Do you want to uninstall Open Voice OS?" question.

⚙️ Start & Stop the services

When the virtualenv method as being choose (default) during the installation process, few systemd unit files have being created in order to manages the different components as services.

📋 List the systemd unit files

systemctl --user list-units "*ovos*"
systemctl list-units "*ovos*"

Only one service is running as root; ovos-phal-admin.

🟢 Start Open Voice OS

systemctl --user start ovos
sudo systemctl start ovos-phal-admin

🔴 Stop Open Voice OS

systemctl --user stop ovos
sudo systemctl stop ovos-phal-admin

🤖 Automated install

The installer supports a non-interactive (automated) process of installation by using a scenario file, this file must be created under the ~/.config/ovos-installer/ directory and should be named scenario.yaml.

Here is an example of a scenario to install Open Voice OS within Docker containers on a Raspberry Pi 4B with default skills and GUI support.

mkdir -p ~/.config/ovos-installer
cat <<EOF > ~/.config/ovos-installer/scenario.yaml
---
uninstall: false
method: containers
channel: development
profile: ovos
features:
  skills: true
  extra_skills: false
  gui: true
rapsberry_pi_tuning: true
share_telemetry: true
EOF

Few scenarios are available as example in the scenarios directory of this repository.

❌ Uninstall

To uninstall Open Voice OS run the installer with the --uninstall option (non-interactive) or simply run the installer and answer "Yes" to the "Do you want to uninstall Open Voice OS?" question.

sh -c "curl -s https://raw.githubusercontent.com/OpenVoiceOS/ovos-installer/main/installer.sh -o installer.sh && chmod +x installer.sh && sudo ./installer.sh --uninstall && rm installer.sh"

🖼️ Screenshots