diff --git a/README.md b/README.md index fa1442c..376bad0 100644 --- a/README.md +++ b/README.md @@ -2,22 +2,33 @@ ## Быстрый старт -### 1. Настройка .env +### 1. Настройка переменных -```bash -# OpenRouter API Key -OPENROUTER_API_KEY=ваш_ключ_openrouter +В Dokploy при создании Docker Compose проекта добавьте переменные: -# Модель (любая с OpenRouter) -LLM_MODEL_NAME=google/gemini-2.0-flash-001 -``` +| Переменная | Значение | +|------------|----------| +| `OPENROUTER_API_KEY` | Ваш API ключ OpenRouter | +| `LLM_MODEL_NAME` | Модель (например: `google/gemini-2.0-flash-001`) | -### 2. Развёртывание в Dokploy +### 2. Файлы для загрузки + +- `docker-compose.yml` +- `Dockerfile` + +### 3. Развёртывание 1. Создайте Docker Compose проект в Dokploy -2. Загрузите файлы: `docker-compose.yml`, `Dockerfile`, `.env` -3. Добавьте домен `browser.home` в настройках Dokploy -4. Разверните +2. Загрузите `docker-compose.yml` и `Dockerfile` +3. Добавьте переменные окружения в UI Dokploy +4. Добавьте домен `browser.home` в настройках +5. Разверните + +## Порт + +**8383** - internal port контейнера + +Dokploy автоматически пробросит на внешний порт через Traefik. ## n8n интеграция @@ -26,7 +37,7 @@ LLM_MODEL_NAME=google/gemini-2.0-flash-001 **Создать задачу:** ``` POST http://browser.home/api/tasks -Body: {"task": "твоя задача"} +Body: {"task": "твоя задача", "max_steps": 20} ``` **Получить результат:** @@ -39,16 +50,17 @@ GET http://browser.home/api/tasks/{task_id} GET http://browser.home/api/health ``` -## Web UI - -- `http://browser.home` - Task Viewer -- `http://browser.home/dashboard` - Dashboard - ## API Endpoints | Method | Endpoint | Описание | |--------|----------|---------| -| GET | `/api/health` | Проверка | -| POST | `/api/tasks` | Задача | +| GET | `/api/health` | Проверка сервера | +| POST | `/api/tasks` | Создать задачу | | GET | `/api/tasks/{id}` | Результат | | GET | `/api/skills` | Навыки | +| POST | `/api/skills/{name}/run` | Запустить навык | + +## Web UI + +- `http://browser.home` - Task Viewer +- `http://browser.home/dashboard` - Dashboard diff --git a/docker-compose.yml b/docker-compose.yml index 3936c5e..d8e3518 100644 --- a/docker-compose.yml +++ b/docker-compose.yml @@ -7,15 +7,12 @@ services: dockerfile: Dockerfile image: browser-use-mcp:latest container_name: browser-use - env_file: - - .env + ports: + - "8383:8383" environment: - LLM__PROVIDER=openrouter - LLM__MODEL_NAME=${LLM_MODEL_NAME} - LLM__API_KEY=${OPENROUTER_API_KEY} - - MCP_LLM_PROVIDER=openrouter - - MCP_LLM_MODEL_NAME=${LLM_MODEL_NAME} - - MCP_LLM_API_KEY=${OPENROUTER_API_KEY} volumes: - browser-data:/root/.config/mcp-server-browser-use - browser-skills:/root/.config/browser-skills