Add docker support

2026-03-22 11:17:17 +08:00 · 2025-01-09 19:46:43 +00:00
parent db6348d4c7
commit eef817ff8e
8 changed files with 360 additions and 4 deletions
--- a/README.md
+++ b/README.md
@@ -17,9 +17,45 @@ We would like to officially thank [WarmShao](https://github.com/warmshao) for hi

 **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.

-<video src="https://github.com/user-attachments/assets/56bc7080-f2e3-4367-af22-6bf2245ff6cb" controls="controls"  >Your browser does not support playing this video!</video>
+**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
+<video src="https://github.com/user-attachments/assets/56bc7080-f2e3-4367-af22-6bf2245ff6cb" controls="controls">Your browser does not support playing this video!</video>
+
+## Installation Options
+
+### Option 1: Docker Installation (Recommended)
+
+1. **Prerequisites:**
+   - Docker and Docker Compose installed on your system
+   - Git to clone the repository
+
+2. **Setup:**
+   ```bash
+   # Clone the repository
+   git clone <repository-url>
+   cd browser-use-webui
+
+   # Copy and configure environment variables
+   cp .env.example .env
+   # Edit .env with your preferred text editor and add your API keys
+   ```
+
+3. **Run with Docker:**
+   ```bash
+   # Build and start the container with default settings (browser closes after AI tasks)
+   docker compose up --build
+
+   # Or run with persistent browser (browser stays open between AI tasks)
+   CHROME_PERSISTENT_SESSION=true docker compose up --build
+   ```
+
+4. **Access the Application:**
+   - WebUI: `http://localhost:7788`
+   - VNC Viewer (to see browser interactions): `http://localhost:6080/vnc.html`
+   
+   Default VNC password is "vncpassword". You can change it by setting the `VNC_PASSWORD` environment variable in your `.env` file.
+
+### Option 2: Local Installation

 Read the [quickstart guide](https://docs.browser-use.com/quickstart#prepare-the-environment) or follow the steps below to get started.

@@ -51,6 +87,59 @@ playwright install

 ## Usage

+### Docker Setup
+1. **Environment Variables:**
+   - All configuration is done through the `.env` file
+   - Available environment variables:
+     ```
+     # LLM API Keys
+     OPENAI_API_KEY=your_key_here
+     ANTHROPIC_API_KEY=your_key_here
+     GOOGLE_API_KEY=your_key_here
+
+     # Browser Settings
+     CHROME_PERSISTENT_SESSION=true   # Set to true to keep browser open between AI tasks
+     RESOLUTION=1920x1080x24         # Custom resolution format: WIDTHxHEIGHTxDEPTH
+     RESOLUTION_WIDTH=1920           # Custom width in pixels
+     RESOLUTION_HEIGHT=1080          # Custom height in pixels
+
+     # VNC Settings
+     VNC_PASSWORD=your_vnc_password  # Optional, defaults to "vncpassword"
+     ```
+
+2. **Browser Persistence Modes:**
+   - **Default Mode (CHROME_PERSISTENT_SESSION=false):**
+     - Browser opens and closes with each AI task
+     - Clean state for each interaction
+     - Lower resource usage
+
+   - **Persistent Mode (CHROME_PERSISTENT_SESSION=true):**
+     - Browser stays open between AI tasks
+     - Maintains history and state
+     - Allows viewing previous AI interactions
+     - Set in `.env` file or via environment variable when starting container
+
+3. **Viewing Browser Interactions:**
+   - Access the noVNC viewer at `http://localhost:6080/vnc.html`
+   - Enter the VNC password (default: "vncpassword" or what you set in VNC_PASSWORD)
+   - You can now see all browser interactions in real-time
+
+4. **Container Management:**
+   ```bash
+   # Start with persistent browser
+   CHROME_PERSISTENT_SESSION=true docker compose up -d
+
+   # Start with default mode (browser closes after tasks)
+   docker compose up -d
+
+   # View logs
+   docker compose logs -f
+
+   # Stop the container
+   docker compose down
+   ```
+
+### Local Setup
 1.  **Run the WebUI:**
    ```bash
    python webui.py --ip 127.0.0.1 --port 7788
@@ -129,4 +218,4 @@ CHROME_USER_DATA="~/Library/Application Support/Google/Chrome/Profile 1"

 ## Changelog

- [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).
+- [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).