openvibers/openvibe.link Commits
Document the current installer command and pre-release download override
Changes
@@@ -113,8 +113,9 @@ pattern (dry-run), an H.264 byte stream from a child process (`rpicam-vid`, `ffm## install.sh and CI--`install/install.sh` (`curl -fsSL https://openvibe.bot/install | sh -s -- <CODE>`): detect OS/arch, download the release--binary and the plugin bundle, create a Python virtual environment for plugins, install the service, pair with the code.++`install/install.sh` (`curl -fsSL https://openvibe.bot/install | sh -s -- --robot rob_... --code ABCD-1234 --driver adeept`):++detect OS/arch, download the release binary and the plugin bundle, create a Python virtual environment for plugins,++install the service, pair with the code.CI: `go vet`, `go test ./...` (race detector), cross-compile every target, Python plugin tests, and a release workflow ontags that attaches the binaries.@@@ -44,6 +44,10 @@ again upgrades and keeps the credential. Options: `--no-service`, `--version vX.directory holding the release files). `OPENVIBE_NODE_BASE` overrides the download location, `OPENVIBE_SERVER` theserver.++The installer downloads the binary, the plugin bundle and `SHA256SUMS` from `releases/latest/download`, which GitHub++resolves only to the latest full release, so a host whose release is still a pre-release needs `OPENVIBE_NODE_BASE` or++`--version TAG`.++Requirements: `python3` with `venv` (`sudo apt install python3 python3-venv`), `curl` or `wget`. For the Adeept camera,`rpicam-apps` (preinstalled on Raspberry Pi OS). For Cozmo's voice, `espeak-ng`. `ffmpeg` is optional (better videofrom plugins that send JPEG frames).
@@ -113,8 +113,9 @@ pattern (dry-run), an H.264 byte stream from a child process (`rpicam-vid`, `ffm
@@ -113,8 +113,9 @@ pattern (dry-run), an H.264 byte stream from a child process (`rpicam-vid`, `ffm
## install.sh and CI
## install.sh and CI
-`install/install.sh` (`curl -fsSL https://openvibe.bot/install | sh -s -- <CODE>`): detect OS/arch, download the release
-binary and the plugin bundle, create a Python virtual environment for plugins, install the service, pair with the code.
+`install/install.sh` (`curl -fsSL https://openvibe.bot/install | sh -s -- --robot rob_... --code ABCD-1234 --driver adeept`):
+detect OS/arch, download the release binary and the plugin bundle, create a Python virtual environment for plugins,
+install the service, pair with the code.
CI: `go vet`, `go test ./...` (race detector), cross-compile every target, Python plugin tests, and a release workflow on
CI: `go vet`, `go test ./...` (race detector), cross-compile every target, Python plugin tests, and a release workflow on
tags that attaches the binaries.
tags that attaches the binaries.
@@ -44,6 +44,10 @@ again upgrades and keeps the credential. Options: `--no-service`, `--version vX.
@@ -44,6 +44,10 @@ again upgrades and keeps the credential. Options: `--no-service`, `--version vX.
directory holding the release files). `OPENVIBE_NODE_BASE` overrides the download location, `OPENVIBE_SERVER` the
directory holding the release files). `OPENVIBE_NODE_BASE` overrides the download location, `OPENVIBE_SERVER` the
server.
server.
+The installer downloads the binary, the plugin bundle and `SHA256SUMS` from `releases/latest/download`, which GitHub
+resolves only to the latest full release, so a host whose release is still a pre-release needs `OPENVIBE_NODE_BASE` or
+`--version TAG`.
+
Requirements: `python3` with `venv` (`sudo apt install python3 python3-venv`), `curl` or `wget`. For the Adeept camera,
Requirements: `python3` with `venv` (`sudo apt install python3 python3-venv`), `curl` or `wget`. For the Adeept camera,
`rpicam-apps` (preinstalled on Raspberry Pi OS). For Cozmo's voice, `espeak-ng`. `ffmpeg` is optional (better video
`rpicam-apps` (preinstalled on Raspberry Pi OS). For Cozmo's voice, `espeak-ng`. `ffmpeg` is optional (better video
from plugins that send JPEG frames).
from plugins that send JPEG frames).