76 lines
2.1 KiB
Markdown
76 lines
2.1 KiB
Markdown
 
|
# How to Deploy nanobot Gateway
|
||
|
|
|
||
|
|
The nanobot gateway is the process that keeps WebUI, chat apps, automations,
|
||
|
|
heartbeat jobs, Dream, and WebSocket delivery online.
|
||
|
|
|
||
|
|
## What you will build
|
||
|
|
|
||
|
|
- a verified nanobot config
|
||
|
|
- a gateway process
|
||
|
|
- an optional Docker, systemd, or macOS LaunchAgent deployment
|
||
|
|
|
||
|
|
## When to use this
|
||
|
|
|
||
|
|
Use this when nanobot should keep running after a single CLI turn: chat apps,
|
||
|
|
browser sessions, background automations, local triggers, and server-side
|
||
|
|
integrations all depend on a live gateway.
|
||
|
|
|
||
|
|
## Install
|
||
|
|
|
||
|
|
```bash
|
||
|
|
python -m pip install nanobot-ai
|
||
|
|
nanobot onboard --wizard
|
||
|
|
nanobot status
|
||
|
|
nanobot agent -m "Hello!"
|
||
|
|
```
|
||
|
|
|
||
|
|
## Minimal working example
|
||
|
|
|
||
|
|
Run the gateway in the foreground:
|
||
|
|
|
||
|
|
```bash
|
||
|
|
nanobot gateway
|
||
|
|
```
|
||
|
|
|
||
|
|
For WebUI background usage:
|
||
|
|
|
||
|
|
```bash
|
||
|
|
nanobot webui --background
|
||
|
|
nanobot gateway status
|
||
|
|
nanobot gateway logs
|
||
|
|
```
|
||
|
|
|
||
|
|
## Production notes
|
||
|
|
|
||
|
|
- Docker Compose is the most repeatable Linux container path.
|
||
|
|
- systemd user services are useful for Linux user-level gateway deployments.
|
||
|
|
- macOS LaunchAgent keeps the gateway alive after login.
|
||
|
|
- Persist config, workspace, sessions, memory files, channel login state, and
|
||
|
|
generated artifacts.
|
||
|
|
- Restart the gateway after editing `config.json`.
|
||
|
|
|
||
|
|
## Security notes
|
||
|
|
|
||
|
|
- Plan ports before exposing services. Gateway health defaults to `18790`,
|
||
|
|
WebUI/WebSocket defaults to `8765`, and `nanobot serve` defaults to `8900`.
|
||
|
|
- Bind externally only when you have configured tokens or API keys.
|
||
|
|
- Keep chat access control intentional before deploying.
|
||
|
|
- Use Docker or Linux sandboxing when shell tools are enabled for unattended
|
||
|
|
work.
|
||
|
|
|
||
|
|
## Troubleshooting
|
||
|
|
|
||
|
|
- Use the same `--config` and `--workspace` flags for status checks and service
|
||
|
|
startup.
|
||
|
|
- Check logs with `docker compose logs`, `journalctl`, LaunchAgent logs, or
|
||
|
|
`nanobot gateway --verbose`.
|
||
|
|
- If Docker port publishing does not work, confirm the service is not bound only
|
||
|
|
to container loopback.
|
||
|
|
|
||
|
|
## Related nanobot docs
|
||
|
|
|
||
|
|
- [Deploy a long-running AI agent gateway](./deploy-ai-agent-gateway.md)
|
||
|
|
- [Deployment](../deployment.md)
|
||
|
|
- [Multiple Instances](../multiple-instances.md)
|
||
|
|
- [Configuration](../configuration.md)
|