You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+83-38
Original file line number
Diff line number
Diff line change
@@ -11,7 +11,7 @@ This project builds upon the foundation of the [browser-use](https://github.com/
11
11
12
12
We would like to officially thank [WarmShao](https://github.com/warmshao) for his contribution to this project.
13
13
14
-
**WebUI:** is built on Gradio and supports a most of `browser-use` functionalities. This UI is designed to be user-friendly and enables easy interaction with the browser agent.
14
+
**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.
15
15
16
16
**Expanded LLM Support:** We've integrated support for various Large Language Models (LLMs), including: Gemini, OpenAI, Azure OpenAI, Anthropic, DeepSeek, Ollama etc. And we plan to add support for even more models in the future.
17
17
@@ -21,81 +21,126 @@ We would like to officially thank [WarmShao](https://github.com/warmshao) for hi
21
21
22
22
<videosrc="https://github.com/user-attachments/assets/56bc7080-f2e3-4367-af22-6bf2245ff6cb"controls="controls">Your browser does not support playing this video!</video>
23
23
24
-
## Installation Options
24
+
## Installation Guide
25
+
26
+
### Prerequisites
27
+
- Python 3.11 or higher
28
+
- Git (for cloning the repository)
25
29
26
30
### Option 1: Local Installation
27
31
28
32
Read the [quickstart guide](https://docs.browser-use.com/quickstart#prepare-the-environment) or follow the steps below to get started.
# Or run with persistent browser (browser stays open between AI tasks)
79
-
CHROME_PERSISTENT_SESSION=true docker compose up --build
80
-
```
99
+
2. Create and configure environment file:
100
+
- Windows (Command Prompt):
101
+
```bash
102
+
copy .env.example .env
103
+
```
104
+
- macOS/Linux/Windows (PowerShell):
105
+
```bash
106
+
cp .env.example .env
107
+
```
108
+
Edit `.env` with your preferred text editor and add your API keys
81
109
110
+
feature/arm64-support
82
111
4.**Access the Application:**
83
112
- WebUI: `http://localhost:7788`
84
113
- VNC Viewer (to see browser interactions): `http://localhost:6080/vnc.html`
85
114
- Direct VNC access is available on port 5901 (especially useful for Mac users)
86
115
87
116
Default VNC password is "vncpassword". You can change it by setting the `VNC_PASSWORD` environment variable in your `.env` file.
88
117
118
+
3. Run with Docker:
119
+
```bash
120
+
# Build and start the container with default settings (browser closes after AI tasks)
121
+
docker compose up --build
122
+
```
123
+
```bash
124
+
# Or run with persistent browser (browser stays open between AI tasks)
125
+
CHROME_PERSISTENT_SESSION=true docker compose up --build
126
+
```
127
+
128
+
129
+
4. Access the Application:
130
+
- Web Interface: Open `http://localhost:7788` in your browser
131
+
- VNC Viewer (for watching browser interactions): Open `http://localhost:6080/vnc.html`
132
+
- Default VNC password: "youvncpassword"
133
+
- Can be changed by setting `VNC_PASSWORD` in your `.env` file
89
134
90
135
## Usage
91
136
92
137
### Local Setup
93
-
1.Copy `.env.example` to `.env` and set your environment variables, including API keys for the LLM. `cp .env.example .env`
94
-
2.**Run the WebUI:**
138
+
1.**Run the WebUI:**
139
+
After completing the installation steps above, start the application:
95
140
```bash
96
141
python webui.py --ip 127.0.0.1 --port 7788
97
142
```
98
-
4. WebUI options:
143
+
2. WebUI options:
99
144
- `--ip`: The IP address to bind the WebUI to. Default is `127.0.0.1`.
100
145
- `--port`: The port to bind the WebUI to. Default is `7788`.
101
146
- `--theme`: The theme for the user interface. Default is `Ocean`.
@@ -109,7 +154,7 @@ playwright install
109
154
- `--dark-mode`: Enables dark mode for the user interface.
110
155
3. **Access the WebUI:** Open your web browser and navigate to `http://127.0.0.1:7788`.
111
156
4. **Using Your Own Browser(Optional):**
112
-
- Set `CHROME_PATH` to the executable path of your browser and `CHROME_USER_DATA` to the user data directory of your browser.
157
+
- Set `CHROME_PATH` to the executable path of your browser and `CHROME_USER_DATA` to the user data directory of your browser. Leave `CHROME_USER_DATA` empty if you want to use local user data.
- 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.
@@ -185,6 +230,6 @@ playwright install
185
230
```
186
231
187
232
## Changelog
188
-
233
+
- [x] **2025/01/26:** Thanks to @vvincent1234. Now browser-use-webui can combine with DeepSeek-r1 to engage in deep thinking!
189
234
- [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).
190
-
- [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).
235
+
- [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).
0 commit comments