Installation
Podman Compose is currently the recommended installation method. The Compose file runs three containers: the HyperVibes application server and web UI, a PostgreSQL database, and an OpenCode instance.
Linux is currently the only supported platform. macOS and Windows may be supported in the future, but for now we recommend installing HyperVibes in its own separate Linux virtual machine.
Podman Compose install (recommended)
Install Podman, podman-compose, curl, openssl, and GNU sed. Create a
private installation directory, then download the Compose file for the release
you want. Replace v0.3.0 with the release tag you intend to run.
umask 077 && curl -fsSLo podman-compose.yaml https://raw.githubusercontent.com/idft/hypervibes/v0.3.0/podman-compose.yaml
Generate unique secrets before the first start:
KEY=$(openssl rand -hex 32) && CTRL=$(openssl rand -hex 32) && OC=$(openssl rand -hex 32) && DB=$(openssl rand -hex 32) && sed -i -e "s/REPLACE_KEY/$KEY/" -e "s/REPLACE_CTRL/$CTRL/" -e "s/REPLACE_OC/$OC/" -e "s/REPLACE_DB/$DB/" podman-compose.yaml
Start the stack:
podman-compose up -d
When the services are healthy, open http://127.0.0.1:3003. Continue with Quick Start.
The Compose file contains generated secrets. Keep it private and back it up
with the database. Do not run the secret-generation command against an
existing installation. podman-compose down preserves data volumes; do not use
podman-compose down -v unless you intend to delete the database, provider
credentials, and generated workspaces.
Run from source
Install Rust, Node.js 20 or later, pnpm, Podman, and podman-compose. Start
the development services, including the dedicated test database, from the
repository root:
podman-compose -f podman-compose.dev.yaml up -d
Configure the local application using .env.example, then run HyperVibes from
the repository root:
cargo run
The development application uses the same local web address, http://127.0.0.1:3003, unless its configuration changes the bind address or port. See Testing for the test database and test commands.