-
Notifications
You must be signed in to change notification settings - Fork 13
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
[quickstart] Add Quickstart using ovos-installer
- Loading branch information
1 parent
2f08e77
commit 235749b
Showing
2 changed files
with
34 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,33 @@ | ||
# Quickstart | ||
|
||
A nice, simple and intuitive way to install Open Voice OS and/or HiveMind using Bash, Whiptail (Newt) and Ansible. | ||
|
||
`curl`, `git` and `sudo` packages must be installed before running the installer. | ||
|
||
```shell | ||
sh -c "curl -s https://raw.githubusercontent.com/OpenVoiceOS/ovos-installer/main/installer.sh -o installer.sh && chmod +x installer.sh && sudo ./installer.sh" | ||
``` | ||
|
||
Then follow the instructions display on screen. | ||
|
||
## 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. | ||
|
||
```shell | ||
mkdir -p ~/.config/ovos-installer | ||
cat <<EOF > ~/.config/ovos-installer/scenario.yaml | ||
--- | ||
uninstall: false | ||
method: containers | ||
channel: development | ||
profile: ovos | ||
features: | ||
skills: true | ||
gui: true | ||
rapsberry_pi_tuning: true | ||
share_telemetry: true | ||
EOF | ||
``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters