e663240d23 | ||
---|---|---|
.github/ISSUE_TEMPLATE | ||
buildroot@5a65958d83 | ||
buildroot-external | ||
documentation | ||
logs | ||
release | ||
scripts | ||
.gitignore | ||
.gitmodules | ||
Jenkinsfile | ||
LICENSE | ||
Makefile | ||
README.md |
README.md
Open Voice Operating System - Buildroot Edition
A minimalistic Linux OS bringing the open source voice assistant ovos-core to embedded, low-spec headless and/or small (touch)screen devices.
System.
OpenVoiceOS - Full 64 Bit distribution
- Linux kernel 6.1.x (LTS)
- Buildroot 2023.02.x (LTS) (With some modification here and there)
- OVOS framework / software package utilizing ovos-docker containers (Currently latest alpha/development version)
- Raspberry Pi 3|3b|3b+
- Raspberry Pi 4
- x86_64 Intel based computers (UEFI based)
- Open Virtual Appliance (UEFI based)
Stats:
Getting started.
Only use x86_64 based architecture/ hardware to build the image.
The following example Build environment has been tested :
- Architecture: x86_64
- Hardware: Intel Core i5 processor, 8GB RAM, 240GB SSD (you can build on less RAM (2GB) and slower storage but more RAM, faster storage = quicker image building)
- OS: Ubuntu 22.04 LTS desktop
Installing System Build Dependencies
Buildroot dependencies must be installed as a prerequisite, assuming apt:
sudo apt-get install -y
bash
bc
binutils
build-essential
bzip2
cpio
diffutils
file
findutils
gzip
libarchive-tools
make
patch
perl
rsync
sed
tar
unzip
wget
which
The following firewall ports need to be allowed to the internet.
In addition to the usual http/https ports (tcp 80, tcp 443) a couple of other ports need to be allowed to the internet :
- tcp 9418 (git).
- tcp 21 (ftp PASV) and random ports for DATA channel. This can be optional but better to have this allowed along with the corresponding random data channel ports. (knowledge of firewalls required)
Getting the code.
First, get the code on your system! The simplest method is via git.
- cd ~/
- git clone --recurse-submodules https://github.com/OpenVoiceOS/OpenVoiceOS.git
- cd OpenVoiceOS
Building the image.
Building the image(s) can be done by utilizing a proper Makefile;
To see the available commands, just run: 'make help'
As example to build the rpi4 version;
- make clean
- make rpi4_64
When everything goes fine the created images/files will be available within the release directory.
Documentation.
More information and instructions can be found within the "documentation" folder.
Credits
Mycroft AI (@MycroftAI)
Buildroot (@buildroot)
HelloChatterbox (@hellochatterbox)
HassOS (@home-assistant)
Inspired by;
HassOS (@home-assistant)