Logo

Hydris Documentation

Home Assistant for The Outdoors

Installing

Download the latest Windows desktop release, extract it, and run the application.

Download the latest Mac desktop release and extract it.

macOS will say that Apple cannot verify the app. To allow it:

  1. Open System SettingsPrivacy & Security
  2. Scroll down to the message saying the app "was blocked to protect your Mac"
  3. Click Open Anyway

Download the macOS binary and run:

chmod +x hydris
./hydris

If macOS blocks the unsigned binary, remove the quarantine attribute:

xattr -d com.apple.quarantine hydris

Hydris starts on localhost:50051 with a web UI at http://localhost:50051

Download the Windows executable and run:

./hydris.exe

Hydris starts on localhost:50051 with a web UI at http://localhost:50051

Download the Linux binary (x86_64 or ARM):

chmod +x hydris
./hydris

Hydris starts on localhost:50051 with a web UI at http://localhost:50051

  1. On your Android device, open the latest release in your browser
  2. Download the .apk file
  3. When prompted, allow installation from unknown sources
  4. Tap the downloaded APK to install

Run Hydris using Docker:

docker run -p 50051:50051 -ti ghcr.io/projectqai/hydris:latest

To persist world state across restarts, add a volume:

docker run -p 50051:50051 -v hydris-data:/data -ti ghcr.io/projectqai/hydris:latest -w /data/world.yaml

Hydris starts on localhost:50051 with a web UI at http://localhost:50051

Deploy Hydris to your cluster using the manifest from the repo:

kubectl apply -f https://raw.githubusercontent.com/projectqai/hydris/main/scripts/deploy.yaml

Getting Started

On this page