web-ui README

The project's README from github.com/browser-use/web-ui. As one markdown file: README.md.

Browser Use Web UI

GitHub stars Discord Documentation WarmShao

This project builds upon the foundation of the browser-use, which is designed to make websites accessible for AI agents.

We would like to officially thank WarmShao for his contribution to this project.

WebUI: is built on Gradio and supports most of browser-use functionalities. This UI is designed to be user-friendly and enables easy interaction with the browser agent.

Expanded LLM Support: We've integrated support for various Large Language Models (LLMs), including: Google, OpenAI, Azure OpenAI, Anthropic, DeepSeek, Ollama etc. And we plan to add support for even more models in the future.

Custom Browser Support: You can use your own browser with our tool, eliminating the need to re-login to sites or deal with other authentication challenges. This feature also supports high-definition screen recording.

Persistent Browser Sessions: You can choose to keep the browser window open between AI tasks, allowing you to see the complete history and state of AI interactions.

Your browser does not support playing this video!

Installation Guide

Option 1: Local Installation

Read the quickstart guide or follow the steps below to get started.

Step 1: Clone the Repository

git clone https://github.com/browser-use/web-ui.git
cd web-ui

Step 2: Set Up Python Environment

We recommend using uv for managing the Python environment.

Using uv (recommended):

uv venv --python 3.11

Activate the virtual environment:

.venv\Scripts\activate
.\.venv\Scripts\Activate.ps1
source .venv/bin/activate

Step 3: Install Dependencies

Install Python packages:

uv pip install -r requirements.txt

Install Browsers in playwright.

playwright install --with-deps

Or you can install specific browsers by running:

playwright install chromium --with-deps

Step 4: Configure Environment

  1. Create a copy of the example environment file:
copy .env.example .env
cp .env.example .env
  1. Open .env in your preferred text editor and add your API keys and other settings

Step 5: Enjoy the web-ui

  1. Run the WebUI:
    python webui.py --ip 127.0.0.1 --port 7788
    
  2. Access the WebUI: Open your web browser and navigate to http://127.0.0.1:7788.
  3. Using Your Own Browser(Optional):
    • Set BROWSER_PATH to the executable path of your browser and BROWSER_USER_DATA to the user data directory of your browser. Leave BROWSER_USER_DATA empty if you want to use local user data.
      • Windows
         BROWSER_PATH="C:\Program Files\Google\Chrome\Application\chrome.exe"
         BROWSER_USER_DATA="C:\Users\YourUsername\AppData\Local\Google\Chrome\User Data"
        

        Note: Replace YourUsername with your actual Windows username for Windows systems.

      • Mac
         BROWSER_PATH="/Applications/Google Chrome.app/Contents/MacOS/Google Chrome"
         BROWSER_USER_DATA="/Users/YourUsername/Library/Application Support/Google/Chrome"
        
    • Close all Chrome windows
    • Open the WebUI in a non-Chrome browser, such as Firefox or Edge. This is important because the persistent browser context will use the Chrome data when running the agent.
    • Check the "Use Own Browser" option within the Browser Settings.

Option 2: Docker Installation

Prerequisites

Step 1: Clone the Repository

git clone https://github.com/browser-use/web-ui.git
cd web-ui

Step 2: Configure Environment

  1. Create a copy of the example environment file:
copy .env.example .env
cp .env.example .env
  1. Open .env in your preferred text editor and add your API keys and other settings

Step 3: Docker Build and Run

docker compose up --build

For ARM64 systems (e.g., Apple Silicon Macs), please run follow command:

TARGETPLATFORM=linux/arm64 docker compose up --build

Step 4: Enjoy the web-ui and vnc

Changelog

web-ui (browser-use/web-ui)

Searching Database…

16.6K ·GitHub
这是做什么的?这是 browser-use 库的一个 Gradio 网页界面:你给 AI 智能体下达一个任务,然后看它实际操作一个真实的浏览器。它支持多种大语言模型——OpenAI、Anthropic、Google、Azure OpenAI、DeepSeek、Ollama 等等。
所以它是基于 browser-use 的一个应用,不是那个库本身?没错——browser-use 库让 AI 智能体能够访问和操作网站,而这个项目把它包装成了一个基于浏览器的界面。自动化的活儿由库来完成,web-ui 就是它的控制面板。
我怎么把它跑起来?克隆仓库,配置一个 Python 环境(推荐用 uv),安装所需的包和 Playwright 浏览器,把 .env.example 复制为 .env 并填入你的 API 密钥,然后启动 WebUI,在浏览器里打开它。
可以用哪些 AI 模型来驱动智能体——我必须付费购买 API 吗?你可以在 .env 里填入 OpenAI、Anthropic、Google、Azure OpenAI 或 DeepSeek 的 API 密钥——或者把它指向 Ollama,在本地免费运行模型。以后还会支持更多服务商。
它是跑在我自己的电脑上,还是云端?跑在你自己的电脑上:安装步骤覆盖 Windows、macOS 和 Linux,针对 Apple Silicon Mac 这类 ARM64 系统还提供了专用的 Docker 命令。
我能让智能体用我自己平时那个 Chrome,保留所有登录状态吗?可以:在 .env 里设置 BROWSERPATH 和 BROWSERUSERDATA,然后在设置里勾选 'Use Own Browser',就能保留你的登录状态。在 Windows 上,请先关掉所有 Chrome 窗口,再用非 Chrome 的浏览器打开 WebUI。
任务之间浏览器会一直开着吗?会——持久化浏览器会话可以让浏览器窗口在 AI 任务之间保持打开,方便你查看智能体操作的完整历史记录和状态。
我怎么看到智能体正在做什么?用 Docker 方式部署时自带一个 VNC 查看器,你可以实时观看智能体操作的浏览器;默认密码是 'youvncpassword',可以通过 .env 里的 VNCPASSWORD 修改。
它能录下智能体的操作吗?可以——自定义浏览器功能支持对智能体的会话进行高清录屏。
Size
18.9 MB
Stars
16.6K
Age
1y
Commits · 90 Days