docs: improve README with provider info and Docker examples
This commit is contained in:
parent
5ea4025b01
commit
99339c7be9
51
README.md
51
README.md
@ -130,16 +130,6 @@ nanobot agent -m "What is 2+2?"
|
|||||||
|
|
||||||
That's it! You have a working AI assistant in 2 minutes.
|
That's it! You have a working AI assistant in 2 minutes.
|
||||||
|
|
||||||
## 🐳 Docker
|
|
||||||
|
|
||||||
```bash
|
|
||||||
docker build -t nanobot .
|
|
||||||
docker run --rm nanobot onboard
|
|
||||||
docker run -v ~/.nanobot:/root/.nanobot -p 18790:18790 nanobot
|
|
||||||
```
|
|
||||||
|
|
||||||
Mount `~/.nanobot` so your config and workspace persist across runs. Edit `~/.nanobot/config.json` on the host to add API keys, then restart the container.
|
|
||||||
|
|
||||||
## 🖥️ Local Models (vLLM)
|
## 🖥️ Local Models (vLLM)
|
||||||
|
|
||||||
Run nanobot with your own local models using vLLM or any OpenAI-compatible server.
|
Run nanobot with your own local models using vLLM or any OpenAI-compatible server.
|
||||||
@ -257,6 +247,20 @@ nanobot gateway
|
|||||||
|
|
||||||
## ⚙️ Configuration
|
## ⚙️ Configuration
|
||||||
|
|
||||||
|
Config file: `~/.nanobot/config.json`
|
||||||
|
|
||||||
|
### Providers
|
||||||
|
|
||||||
|
| Provider | Purpose | Get API Key |
|
||||||
|
|----------|---------|-------------|
|
||||||
|
| `openrouter` | LLM (recommended, access to all models) | [openrouter.ai](https://openrouter.ai) |
|
||||||
|
| `anthropic` | LLM (Claude direct) | [console.anthropic.com](https://console.anthropic.com) |
|
||||||
|
| `openai` | LLM (GPT direct) | [platform.openai.com](https://platform.openai.com) |
|
||||||
|
| `groq` | LLM + **Voice transcription** (Whisper) | [console.groq.com](https://console.groq.com) |
|
||||||
|
| `gemini` | LLM (Gemini direct) | [aistudio.google.com](https://aistudio.google.com) |
|
||||||
|
|
||||||
|
> **Note**: Groq provides free voice transcription via Whisper. If configured, Telegram voice messages will be automatically transcribed.
|
||||||
|
|
||||||
<details>
|
<details>
|
||||||
<summary><b>Full config example</b></summary>
|
<summary><b>Full config example</b></summary>
|
||||||
|
|
||||||
@ -270,6 +274,9 @@ nanobot gateway
|
|||||||
"providers": {
|
"providers": {
|
||||||
"openrouter": {
|
"openrouter": {
|
||||||
"apiKey": "sk-or-v1-xxx"
|
"apiKey": "sk-or-v1-xxx"
|
||||||
|
},
|
||||||
|
"groq": {
|
||||||
|
"apiKey": "gsk_xxx"
|
||||||
}
|
}
|
||||||
},
|
},
|
||||||
"channels": {
|
"channels": {
|
||||||
@ -323,6 +330,30 @@ nanobot cron remove <job_id>
|
|||||||
|
|
||||||
</details>
|
</details>
|
||||||
|
|
||||||
|
## 🐳 Docker
|
||||||
|
|
||||||
|
Build and run nanobot in a container:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
# Build the image
|
||||||
|
docker build -t nanobot .
|
||||||
|
|
||||||
|
# Initialize config (first time only)
|
||||||
|
docker run -v ~/.nanobot:/root/.nanobot --rm nanobot onboard
|
||||||
|
|
||||||
|
# Edit config on host to add API keys
|
||||||
|
vim ~/.nanobot/config.json
|
||||||
|
|
||||||
|
# Run gateway (connects to Telegram/WhatsApp)
|
||||||
|
docker run -v ~/.nanobot:/root/.nanobot -p 18790:18790 nanobot gateway
|
||||||
|
|
||||||
|
# Or run a single command
|
||||||
|
docker run -v ~/.nanobot:/root/.nanobot --rm nanobot agent -m "Hello!"
|
||||||
|
docker run -v ~/.nanobot:/root/.nanobot --rm nanobot status
|
||||||
|
```
|
||||||
|
|
||||||
|
> **Tip**: Mount `~/.nanobot` so your config and workspace persist across container restarts.
|
||||||
|
|
||||||
## 📁 Project Structure
|
## 📁 Project Structure
|
||||||
|
|
||||||
```
|
```
|
||||||
|
|||||||
Loading…
x
Reference in New Issue
Block a user