The docs said ~/.hanzo-bot/hanzo-bot.json (and ~/.hanzo-bot-<profile>, hanzo-bot.plugin.json), which nothing reads: src/config/paths.ts resolves ~/.bot, bot.json and ~/.bot-<profile>, and plugins ship bot.plugin.json. Every such path in docs/ now names what the code opens. Co-authored-by: Hanzo Dev <[email protected]>
3.6 KiB
summary, read_when, title
| summary | read_when | title | ||
|---|---|---|---|---|
| Run HanzoBot Gateway on exe.dev (VM + HTTPS proxy) for remote access |
|
exe.dev |
exe.dev
Goal: HanzoBot Gateway running on an exe.dev VM, reachable from your laptop via: https://<vm-name>.exe.xyz
This page assumes exe.dev's default exeuntu image. If you picked a different distro, map packages accordingly.
Beginner quick path
- https://exe.new/hanzo-bot
- Fill in your auth key/token as needed
- Click on "Agent" next to your VM, and wait...
- ???
- Profit
What you need
- exe.dev account
ssh exe.devaccess to exe.dev virtual machines (optional)
Automated Install with Shelley
Shelley, exe.dev's agent, can install HanzoBot instantly with our prompt. The prompt used is as below:
Set up HanzoBot (https://docs.hanzo-bot.ai/install) on this VM. Use the non-interactive and accept-risk flags for hanzo-bot onboarding. Add the supplied auth or token as needed. Configure nginx to forward from the default port 18789 to the root location on the default enabled site config, making sure to enable Websocket support. Pairing is done by "hanzo-bot devices list" and "hanzo-bot devices approve <request id>". Make sure the dashboard shows that HanzoBot's health is OK. exe.dev handles forwarding from port 8000 to port 80/443 and HTTPS for us, so the final "reachable" should be <vm-name>.exe.xyz, without port specification.
Manual installation
1) Create the VM
From your device:
ssh exe.dev new
Then connect:
ssh <vm-name>.exe.xyz
Tip: keep this VM stateful. HanzoBot stores state under ~/.bot/ and ~/.bot/workspace/.
2) Install prerequisites (on the VM)
sudo apt-get update
sudo apt-get install -y git curl jq ca-certificates openssl
3) Install HanzoBot
Run the HanzoBot install script:
curl -fsSL https://hanzo-bot.ai/install.sh | bash
4) Setup nginx to proxy HanzoBot to port 8000
Edit /etc/nginx/sites-enabled/default with
server {
listen 80 default_server;
listen [::]:80 default_server;
listen 8000;
listen [::]:8000;
server_name _;
location / {
proxy_pass http://127.0.0.1:18789;
proxy_http_version 1.1;
# WebSocket support
proxy_set_header Upgrade $http_upgrade;
proxy_set_header Connection "upgrade";
# Standard proxy headers
proxy_set_header Host $host;
proxy_set_header X-Real-IP $remote_addr;
proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
proxy_set_header X-Forwarded-Proto $scheme;
# Timeout settings for long-lived connections
proxy_read_timeout 86400s;
proxy_send_timeout 86400s;
}
}
5) Access HanzoBot and grant privileges
Access https://<vm-name>.exe.xyz/ (see the Control UI output from onboarding). If it prompts for auth, paste the
token from gateway.auth.token on the VM (retrieve with hanzo-bot config get gateway.auth.token, or generate one
with hanzo-bot doctor --generate-gateway-token). Approve devices with hanzo-bot devices list and
hanzo-bot devices approve <requestId>. When in doubt, use Shelley from your browser!
Remote Access
Remote access is handled by exe.dev's authentication. By
default, HTTP traffic from port 8000 is forwarded to https://<vm-name>.exe.xyz
with email auth.
Updating
npm i -g hanzo-bot@latest
hanzo-bot doctor
hanzo-bot gateway restart
hanzo-bot health
Guide: Updating