Skip to content

Commit

Permalink
[quickstart] Add Quickstart using ovos-installer
Browse files Browse the repository at this point in the history
  • Loading branch information
goldyfruit committed Nov 29, 2023
1 parent 2f08e77 commit 235749b
Show file tree
Hide file tree
Showing 2 changed files with 34 additions and 0 deletions.
33 changes: 33 additions & 0 deletions docs/quickstart.md
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
```
1 change: 1 addition & 0 deletions mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -155,6 +155,7 @@ nav:
- Glossary:
- Terms: about/glossary/terms.md
- Components: about/glossary/components.md
- Quickstart: quickstart.md
- Getting started:
- Run OVOS within containers:
- Docker or Podman: getting-started/docker/index.md
Expand Down

0 comments on commit 235749b

Please sign in to comment.