Network and Ports
Packaged Windows and Linux launchers bind GRiMbot to 127.0.0.1. GRiMbOS and overlay URLs are local to that machine.
Default local ports
| Port | Service |
|---|---|
8000 |
GRiMbot HTTP API, GRiMbOS at /admin, overlay pages, health at /health |
28787 |
PC Agent local HTTP on the streaming PC. Handy posts to /v1. Other tools may POST to /voice. |
Do not expose /admin, /docs, the database, or .env to the public internet. Overlay Browser Sources should use the same origin the operator already trusts.
EventSub transport
| PUBLIC_BASE_URL | EventSub |
|---|---|
| Empty | WebSocket EventSub. This is the packaged local default. |
| Set to a public URL | Webhook EventSub. Requires a reachable HTTPS callback. |
Packaged local installs leave PUBLIC_BASE_URL empty. Do not enable webhook EventSub unless you operate a documented public URL and understand the callback path.
Two-PC and agent traffic
The PC Agent on the streaming PC needs a reachable GRiMbot URL. Packaged Core on the same PC uses http://127.0.0.1:8000. If GRiMbOS is opened through a tunnel, set GRIMBOT_AGENT_URL to the LAN address of the bot so voice and OBS agent traffic stay on the LAN.
Use private LAN examples such as http://192.168.1.10:8000. Do not publish your real addresses.
OBS WebSocket in Direct mode uses whatever host and port you enter in OBS Integration. Agent mode sends OBS commands through the PC Agent instead.
Firewall notes
Allow outbound HTTPS to Twitch, Spotify, Discord, and any AI Provider you configured. Allow localhost traffic on 8000 and 28787. Do not open those ports on a public interface for a packaged install.