docs: refresh install/update guidance and bump v0.1.4.post4
This commit is contained in:
31
README.md
31
README.md
@@ -122,6 +122,29 @@ uv tool install nanobot-ai
|
|||||||
pip install nanobot-ai
|
pip install nanobot-ai
|
||||||
```
|
```
|
||||||
|
|
||||||
|
### Update to latest version
|
||||||
|
|
||||||
|
**PyPI / pip**
|
||||||
|
|
||||||
|
```bash
|
||||||
|
pip install -U nanobot-ai
|
||||||
|
nanobot --version
|
||||||
|
```
|
||||||
|
|
||||||
|
**uv**
|
||||||
|
|
||||||
|
```bash
|
||||||
|
uv tool upgrade nanobot-ai
|
||||||
|
nanobot --version
|
||||||
|
```
|
||||||
|
|
||||||
|
**Using WhatsApp?** Rebuild the local bridge after upgrading:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
rm -rf ~/.nanobot/bridge
|
||||||
|
nanobot channels login
|
||||||
|
```
|
||||||
|
|
||||||
## 🚀 Quick Start
|
## 🚀 Quick Start
|
||||||
|
|
||||||
> [!TIP]
|
> [!TIP]
|
||||||
@@ -374,7 +397,7 @@ pip install nanobot-ai[matrix]
|
|||||||
|
|
||||||
| Option | Description |
|
| Option | Description |
|
||||||
|--------|-------------|
|
|--------|-------------|
|
||||||
| `allowFrom` | User IDs allowed to interact. Empty = all senders. |
|
| `allowFrom` | User IDs allowed to interact. Empty denies all; use `["*"]` to allow everyone. |
|
||||||
| `groupPolicy` | `open` (default), `mention`, or `allowlist`. |
|
| `groupPolicy` | `open` (default), `mention`, or `allowlist`. |
|
||||||
| `groupAllowFrom` | Room allowlist (used when policy is `allowlist`). |
|
| `groupAllowFrom` | Room allowlist (used when policy is `allowlist`). |
|
||||||
| `allowRoomMentions` | Accept `@room` mentions in mention mode. |
|
| `allowRoomMentions` | Accept `@room` mentions in mention mode. |
|
||||||
@@ -428,7 +451,7 @@ nanobot gateway
|
|||||||
```
|
```
|
||||||
|
|
||||||
> WhatsApp bridge updates are not applied automatically for existing installations.
|
> WhatsApp bridge updates are not applied automatically for existing installations.
|
||||||
> If you upgrade nanobot and need the latest WhatsApp bridge, run:
|
> After upgrading nanobot, rebuild the local bridge with:
|
||||||
> `rm -rf ~/.nanobot/bridge && nanobot channels login`
|
> `rm -rf ~/.nanobot/bridge && nanobot channels login`
|
||||||
|
|
||||||
</details>
|
</details>
|
||||||
@@ -900,13 +923,13 @@ MCP tools are automatically discovered and registered on startup. The LLM can us
|
|||||||
|
|
||||||
> [!TIP]
|
> [!TIP]
|
||||||
> For production deployments, set `"restrictToWorkspace": true` in your config to sandbox the agent.
|
> For production deployments, set `"restrictToWorkspace": true` in your config to sandbox the agent.
|
||||||
> **Change in source / post-`v0.1.4.post3`:** In `v0.1.4.post3` and earlier, an empty `allowFrom` means "allow all senders". In newer versions (including building from source), **empty `allowFrom` denies all access by default**. To allow all senders, set `"allowFrom": ["*"]`.
|
> In `v0.1.4.post3` and earlier, an empty `allowFrom` allowed all senders. Since `v0.1.4.post4`, empty `allowFrom` denies all access by default. To allow all senders, set `"allowFrom": ["*"]`.
|
||||||
|
|
||||||
| Option | Default | Description |
|
| Option | Default | Description |
|
||||||
|--------|---------|-------------|
|
|--------|---------|-------------|
|
||||||
| `tools.restrictToWorkspace` | `false` | When `true`, restricts **all** agent tools (shell, file read/write/edit, list) to the workspace directory. Prevents path traversal and out-of-scope access. |
|
| `tools.restrictToWorkspace` | `false` | When `true`, restricts **all** agent tools (shell, file read/write/edit, list) to the workspace directory. Prevents path traversal and out-of-scope access. |
|
||||||
| `tools.exec.pathAppend` | `""` | Extra directories to append to `PATH` when running shell commands (e.g. `/usr/sbin` for `ufw`). |
|
| `tools.exec.pathAppend` | `""` | Extra directories to append to `PATH` when running shell commands (e.g. `/usr/sbin` for `ufw`). |
|
||||||
| `channels.*.allowFrom` | `[]` (allow all) | Whitelist of user IDs. Empty = allow everyone; non-empty = only listed users can interact. |
|
| `channels.*.allowFrom` | `[]` (deny all) | Whitelist of user IDs. Empty denies all; use `["*"]` to allow everyone. |
|
||||||
|
|
||||||
|
|
||||||
## 🧩 Multiple Instances
|
## 🧩 Multiple Instances
|
||||||
|
|||||||
@@ -55,7 +55,7 @@ chmod 600 ~/.nanobot/config.json
|
|||||||
```
|
```
|
||||||
|
|
||||||
**Security Notes:**
|
**Security Notes:**
|
||||||
- In `v0.1.4.post3` and earlier, an empty `allowFrom` allows all users. In newer versions (including source builds), **empty `allowFrom` denies all access** — set `["*"]` to explicitly allow everyone.
|
- In `v0.1.4.post3` and earlier, an empty `allowFrom` allowed all users. Since `v0.1.4.post4`, empty `allowFrom` denies all access by default — set `["*"]` to explicitly allow everyone.
|
||||||
- Get your Telegram user ID from `@userinfobot`
|
- Get your Telegram user ID from `@userinfobot`
|
||||||
- Use full phone numbers with country code for WhatsApp
|
- Use full phone numbers with country code for WhatsApp
|
||||||
- Review access logs regularly for unauthorized access attempts
|
- Review access logs regularly for unauthorized access attempts
|
||||||
@@ -212,7 +212,7 @@ If you suspect a security breach:
|
|||||||
- Input length limits on HTTP requests
|
- Input length limits on HTTP requests
|
||||||
|
|
||||||
✅ **Authentication**
|
✅ **Authentication**
|
||||||
- Allow-list based access control — in `v0.1.4.post3` and earlier empty means allow all; in newer versions empty means deny all (`["*"]` to explicitly allow all)
|
- Allow-list based access control — in `v0.1.4.post3` and earlier empty `allowFrom` allowed all; since `v0.1.4.post4` it denies all (`["*"]` explicitly allows all)
|
||||||
- Failed authentication attempt logging
|
- Failed authentication attempt logging
|
||||||
|
|
||||||
✅ **Resource Protection**
|
✅ **Resource Protection**
|
||||||
|
|||||||
Reference in New Issue
Block a user