nanobot/webui/README.md
chengyongru bad584cb0e fix(webui): allow LAN access when host is 0.0.0.0
The webui bootstrap endpoint (/webui/bootstrap) rejected all non-localhost
connections with HTTP 403, preventing the embedded webui from working when
accessed from another device on the LAN — even when host was set to 0.0.0.0.

Skip the localhost check when the server is explicitly bound to 0.0.0.0 or ::,
since that signals intent to accept external connections.
2026-05-06 23:00:23 +08:00

2.6 KiB

nanobot webui

The browser front-end for the nanobot gateway. It is built with Vite + React 18 + TypeScript + Tailwind 3 + shadcn/ui, talks to the gateway over the WebSocket multiplex protocol, and reads session metadata from the embedded REST surface on the same port.

For the project overview, install guide, and general docs map, see the root README.md.

Current status

Note

The standalone WebUI development workflow currently requires a source checkout.

WebUI changes in the GitHub repository may land before they are included in the next packaged release, so source installs and published package versions are not yet guaranteed to move in lockstep.

Layout

webui/                 source tree (this directory)
nanobot/web/dist/      build output served by the gateway

Develop from source

1. Install nanobot from source

From the repository root:

pip install -e .

2. Enable the WebSocket channel

In ~/.nanobot/config.json:

{ "channels": { "websocket": { "enabled": true } } }

3. Start the gateway

In one terminal:

nanobot gateway

4. Start the WebUI dev server

In another terminal:

cd webui
bun install            # npm install also works
bun run dev

Then open http://127.0.0.1:5173.

By default, the dev server proxies /api, /webui, /auth, and WebSocket traffic to http://127.0.0.1:8765.

If your gateway listens on a non-default port, point the dev server at it:

NANOBOT_API_URL=http://127.0.0.1:9000 bun run dev

Access from another device (LAN)

To use the webui from another device on the same network, set host to "0.0.0.0" in ~/.nanobot/config.json:

{
  "channels": {
    "websocket": {
      "enabled": true,
      "host": "0.0.0.0",
      "port": 8765
    }
  }
}

Then open http://<your-ip>:8765 on the other device. When host is "0.0.0.0", the bootstrap endpoint accepts requests from any source instead of restricting to localhost.

Note: This exposes the gateway to all interfaces. Only use on trusted networks.

Build for packaged runtime

cd webui
bun run build

This writes the production assets to ../nanobot/web/dist, which is the directory served by nanobot gateway and bundled into the Python wheel.

If you are cutting a release, run the build before packaging so the published wheel contains the current WebUI assets.

Test

cd webui
bun run test

Acknowledgements

  • agent-chat-ui for UI and interaction inspiration across the chat surface.