From 77512adca9b1919904c5b1a5677ad9bbc1f65de4 Mon Sep 17 00:00:00 2001 From: wehub-resource-sync Date: Mon, 13 Jul 2026 10:42:27 +0000 Subject: [PATCH] docs: preserve upstream English README --- README.en.md | 151 +++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 151 insertions(+) create mode 100644 README.en.md diff --git a/README.en.md b/README.en.md new file mode 100644 index 0000000..e5a24ea --- /dev/null +++ b/README.en.md @@ -0,0 +1,151 @@ +Browser Use Web UI + +
+ +[![GitHub stars](https://img.shields.io/github/stars/browser-use/web-ui?style=social)](https://github.com/browser-use/web-ui/stargazers) +[![Discord](https://img.shields.io/discord/1303749220842340412?color=7289DA&label=Discord&logo=discord&logoColor=white)](https://link.browser-use.com/discord) +[![Documentation](https://img.shields.io/badge/Documentation-📕-blue)](https://docs.browser-use.com) +[![WarmShao](https://img.shields.io/twitter/follow/warmshao?style=social)](https://x.com/warmshao) + +This project builds upon the foundation of the [browser-use](https://github.com/browser-use/browser-use), which is designed to make websites accessible for AI agents. + +We would like to officially thank [WarmShao](https://github.com/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. + + + +## Installation Guide + +### Option 1: Local Installation + +Read the [quickstart guide](https://docs.browser-use.com/quickstart#prepare-the-environment) or follow the steps below to get started. + +#### Step 1: Clone the Repository +```bash +git clone https://github.com/browser-use/web-ui.git +cd web-ui +``` + +#### Step 2: Set Up Python Environment +We recommend using [uv](https://docs.astral.sh/uv/) for managing the Python environment. + +Using uv (recommended): +```bash +uv venv --python 3.11 +``` + +Activate the virtual environment: +- Windows (Command Prompt): +```cmd +.venv\Scripts\activate +``` +- Windows (PowerShell): +```powershell +.\.venv\Scripts\Activate.ps1 +``` +- macOS/Linux: +```bash +source .venv/bin/activate +``` + +#### Step 3: Install Dependencies +Install Python packages: +```bash +uv pip install -r requirements.txt +``` + +Install Browsers in playwright. +```bash +playwright install --with-deps +``` +Or you can install specific browsers by running: +```bash +playwright install chromium --with-deps +``` + +#### Step 4: Configure Environment +1. Create a copy of the example environment file: +- Windows (Command Prompt): +```bash +copy .env.example .env +``` +- macOS/Linux/Windows (PowerShell): +```bash +cp .env.example .env +``` +2. 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:** + ```bash + 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 + ```env + 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 + ```env + 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 +- Docker and Docker Compose installed + - [Docker Desktop](https://www.docker.com/products/docker-desktop/) (For Windows/macOS) + - [Docker Engine](https://docs.docker.com/engine/install/) and [Docker Compose](https://docs.docker.com/compose/install/) (For Linux) + +#### Step 1: Clone the Repository +```bash +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: +- Windows (Command Prompt): +```bash +copy .env.example .env +``` +- macOS/Linux/Windows (PowerShell): +```bash +cp .env.example .env +``` +2. Open `.env` in your preferred text editor and add your API keys and other settings + +#### Step 3: Docker Build and Run +```bash +docker compose up --build +``` +For ARM64 systems (e.g., Apple Silicon Macs), please run follow command: +```bash +TARGETPLATFORM=linux/arm64 docker compose up --build +``` + +#### Step 4: Enjoy the web-ui and vnc +- Web-UI: Open `http://localhost:7788` in your browser +- VNC Viewer (for watching browser interactions): Open `http://localhost:6080/vnc.html` + - Default VNC password: "youvncpassword" + - Can be changed by setting `VNC_PASSWORD` in your `.env` file + +## Changelog +- [x] **2025/01/26:** Thanks to @vvincent1234. Now browser-use-webui can combine with DeepSeek-r1 to engage in deep thinking! +- [x] **2025/01/10:** Thanks to @casistack. Now we have Docker Setup option and also Support keep browser open between tasks.[Video tutorial demo](https://github.com/browser-use/web-ui/issues/1#issuecomment-2582511750). +- [x] **2025/01/06:** Thanks to @richard-devbot. A New and Well-Designed WebUI is released. [Video tutorial demo](https://github.com/warmshao/browser-use-webui/issues/1#issuecomment-2573393113).