dashboard-nanobot/dashboard-edge/README.md

60 lines
1.3 KiB
Markdown

# dashboard-edge
`dashboard-edge` is the execution-plane service for Dashboard Nanobot.
It is designed to run on every managed node and bridge Dashboard control requests to local Docker or native Bot runtimes.
## Local development
```bash
cd dashboard-edge
python -m venv .venv
source .venv/bin/activate
pip install -r requirements.txt
python main.py
```
If your configured pip mirror is unavailable, install with the official index:
```bash
pip install -r requirements.txt -i https://pypi.org/simple
```
Default server:
- Host: `0.0.0.0`
- Port: `8010`
- Dev reload: enabled by default in `./scripts/dev-edge.sh`
Native local development:
```bash
cd /Users/jiliu/WorkSpace/dashboard-nanobot
bash scripts/dev-edge-native.sh
```
By default, the native launcher will auto-detect:
- `engines/nanobot-v0.1.4-post5/.venv/bin/python -m nanobot.cli.commands gateway`
when that virtualenv exists. You can still override it with `EDGE_NATIVE_COMMAND`.
Environment variables:
- `EDGE_HOST`
- `EDGE_PORT`
- `EDGE_RELOAD`
- `EDGE_AUTH_TOKEN`
- `EDGE_NODE_ID`
- `EDGE_NODE_NAME`
- `EDGE_BOTS_WORKSPACE_ROOT`
- `EDGE_BASE_IMAGE`
- `EDGE_RUNTIME_KIND`
- `EDGE_NATIVE_COMMAND`
- `EDGE_NATIVE_DASHBOARD_URL`
- `EDGE_NATIVE_DASHBOARD_HOST`
- `EDGE_NATIVE_DASHBOARD_PORT`
- `EDGE_NATIVE_WORKDIR`
- `EDGE_UPLOAD_MAX_MB`
- `EDGE_ALLOWED_ATTACHMENT_EXTENSIONS`