OpenVoiceOS/ovos-installer provides an Ansible-driven, text-based installer for the Open Voice OS (OVOS) and HiveMind voice assistant platforms. It targets users seeking a streamlined, automated setup process for these privacy-focused, customizable voice assistants, offering both interactive and scenario-based deployment options.

How It Works

This project leverages Ansible for robust system configuration and orchestration, presenting users with an intuitive Text-based User Interface (TUI). It supports two primary installation methods: provisioning a Python virtual environment (defaulting to Python 3.11 managed by uv) or deploying within Docker containers. This modular approach allows for flexibility across different user needs and environments.

Quick Start & Requirements

The installer can be run directly via a shell command: sudo sh -c "$(curl -fsSL https://raw.githubusercontent.com/OpenVoiceOS/ovos-installer/main/installer.sh)" Prerequisites include curl, git, and sudo. For macOS installations, Homebrew, Xcode Command Line Tools, and microphone permissions are required. The installer manages Python versions using uv, targeting 3.11 by default, but this can be overridden via the OVOS_VENV_PYTHON environment variable. Users can inspect the script by downloading it first (sudo sh installer.sh).

Highlighted Details

• Cross-Platform Support: Offers robust installation for a wide array of Linux distributions (Debian, Ubuntu, Fedora, Arch, RHEL derivatives, etc.) and macOS (Intel + Apple Silicon) using launchd service management.
• Automated Deployment: Supports non-interactive installations via a scenario.yaml configuration file, enabling scripting and multi-device deployments, including options for Docker, testing/alpha channels, and Raspberry Pi-specific tuning.
• Audio Calibration: Includes a dedicated tool (scripts/audio-calibrate.sh) to tune microphone input for optimal wake word detection.
• Modular Ansible Roles: The installation process is broken down into granular Ansible roles covering system facts, sound setup, virtual environment provisioning, container deployment, service management, and extensive performance/storage tuning.

Maintenance & Community

No specific details regarding notable contributors, sponsorships, or community channels (like Discord/Slack) were present in the provided documentation.

Licensing & Compatibility

The license type and any compatibility notes for commercial use or closed-source linking were not explicitly stated in the provided documentation.

Limitations & Caveats

The installer supports alpha and testing release channels, indicating potential instability for production environments. macOS installations have a specific support matrix, and Raspberry Pi tuning may involve overclocking prompts. Uninstall functionality is also provided.