Update README.md
Browse files
README.md
CHANGED
|
@@ -1,6 +1,4 @@
|
|
| 1 |
-
<img src="./assets/web-ui.png" alt="Browser Use Web UI" width="full"/>
|
| 2 |
|
| 3 |
-
<br/>
|
| 4 |
|
| 5 |
## Installation Options
|
| 6 |
|
|
@@ -67,95 +65,3 @@ playwright install
|
|
| 67 |
Default VNC password is "vncpassword". You can change it by setting the `VNC_PASSWORD` environment variable in your `.env` file.
|
| 68 |
|
| 69 |
|
| 70 |
-
## Usage
|
| 71 |
-
|
| 72 |
-
### Local Setup
|
| 73 |
-
1. Copy `.env.example` to `.env` and set your environment variables, including API keys for the LLM. `cp .env.example .env`
|
| 74 |
-
2. **Run the WebUI:**
|
| 75 |
-
```bash
|
| 76 |
-
python webui.py --ip 127.0.0.1 --port 7788
|
| 77 |
-
```
|
| 78 |
-
4. WebUI options:
|
| 79 |
-
- `--ip`: The IP address to bind the WebUI to. Default is `127.0.0.1`.
|
| 80 |
-
- `--port`: The port to bind the WebUI to. Default is `7788`.
|
| 81 |
-
- `--theme`: The theme for the user interface. Default is `Ocean`.
|
| 82 |
-
- **Default**: The standard theme with a balanced design.
|
| 83 |
-
- **Soft**: A gentle, muted color scheme for a relaxed viewing experience.
|
| 84 |
-
- **Monochrome**: A grayscale theme with minimal color for simplicity and focus.
|
| 85 |
-
- **Glass**: A sleek, semi-transparent design for a modern appearance.
|
| 86 |
-
- **Origin**: A classic, retro-inspired theme for a nostalgic feel.
|
| 87 |
-
- **Citrus**: A vibrant, citrus-inspired palette with bright and fresh colors.
|
| 88 |
-
- **Ocean** (default): A blue, ocean-inspired theme providing a calming effect.
|
| 89 |
-
- `--dark-mode`: Enables dark mode for the user interface.
|
| 90 |
-
3. **Access the WebUI:** Open your web browser and navigate to `http://127.0.0.1:7788`.
|
| 91 |
-
4. **Using Your Own Browser(Optional):**
|
| 92 |
-
- Set `CHROME_PATH` to the executable path of your browser and `CHROME_USER_DATA` to the user data directory of your browser.
|
| 93 |
-
- Windows
|
| 94 |
-
```env
|
| 95 |
-
CHROME_PATH="C:\Program Files\Google\Chrome\Application\chrome.exe"
|
| 96 |
-
CHROME_USER_DATA="C:\Users\YourUsername\AppData\Local\Google\Chrome\User Data"
|
| 97 |
-
```
|
| 98 |
-
> Note: Replace `YourUsername` with your actual Windows username for Windows systems.
|
| 99 |
-
- Mac
|
| 100 |
-
```env
|
| 101 |
-
CHROME_PATH="/Applications/Google Chrome.app/Contents/MacOS/Google Chrome"
|
| 102 |
-
CHROME_USER_DATA="~/Library/Application Support/Google/Chrome/Profile 1"
|
| 103 |
-
```
|
| 104 |
-
- Close all Chrome windows
|
| 105 |
-
- 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.
|
| 106 |
-
- Check the "Use Own Browser" option within the Browser Settings.
|
| 107 |
-
5. **Keep Browser Open(Optional):**
|
| 108 |
-
- Set `CHROME_PERSISTENT_SESSION=true` in the `.env` file.
|
| 109 |
-
|
| 110 |
-
### Docker Setup
|
| 111 |
-
1. **Environment Variables:**
|
| 112 |
-
- All configuration is done through the `.env` file
|
| 113 |
-
- Available environment variables:
|
| 114 |
-
```
|
| 115 |
-
# LLM API Keys
|
| 116 |
-
OPENAI_API_KEY=your_key_here
|
| 117 |
-
ANTHROPIC_API_KEY=your_key_here
|
| 118 |
-
GOOGLE_API_KEY=your_key_here
|
| 119 |
-
|
| 120 |
-
# Browser Settings
|
| 121 |
-
CHROME_PERSISTENT_SESSION=true # Set to true to keep browser open between AI tasks
|
| 122 |
-
RESOLUTION=1920x1080x24 # Custom resolution format: WIDTHxHEIGHTxDEPTH
|
| 123 |
-
RESOLUTION_WIDTH=1920 # Custom width in pixels
|
| 124 |
-
RESOLUTION_HEIGHT=1080 # Custom height in pixels
|
| 125 |
-
|
| 126 |
-
# VNC Settings
|
| 127 |
-
VNC_PASSWORD=your_vnc_password # Optional, defaults to "vncpassword"
|
| 128 |
-
```
|
| 129 |
-
|
| 130 |
-
2. **Browser Persistence Modes:**
|
| 131 |
-
- **Default Mode (CHROME_PERSISTENT_SESSION=false):**
|
| 132 |
-
- Browser opens and closes with each AI task
|
| 133 |
-
- Clean state for each interaction
|
| 134 |
-
- Lower resource usage
|
| 135 |
-
|
| 136 |
-
- **Persistent Mode (CHROME_PERSISTENT_SESSION=true):**
|
| 137 |
-
- Browser stays open between AI tasks
|
| 138 |
-
- Maintains history and state
|
| 139 |
-
- Allows viewing previous AI interactions
|
| 140 |
-
- Set in `.env` file or via environment variable when starting container
|
| 141 |
-
|
| 142 |
-
3. **Viewing Browser Interactions:**
|
| 143 |
-
- Access the noVNC viewer at `http://localhost:6080/vnc.html`
|
| 144 |
-
- Enter the VNC password (default: "vncpassword" or what you set in VNC_PASSWORD)
|
| 145 |
-
- You can now see all browser interactions in real-time
|
| 146 |
-
|
| 147 |
-
4. **Container Management:**
|
| 148 |
-
```bash
|
| 149 |
-
# Start with persistent browser
|
| 150 |
-
CHROME_PERSISTENT_SESSION=true docker compose up -d
|
| 151 |
-
|
| 152 |
-
# Start with default mode (browser closes after tasks)
|
| 153 |
-
docker compose up -d
|
| 154 |
-
|
| 155 |
-
# View logs
|
| 156 |
-
docker compose logs -f
|
| 157 |
-
|
| 158 |
-
# Stop the container
|
| 159 |
-
docker compose down
|
| 160 |
-
```
|
| 161 |
-
|
|
|
|
|
|
|
| 1 |
|
|
|
|
| 2 |
|
| 3 |
## Installation Options
|
| 4 |
|
|
|
|
| 65 |
Default VNC password is "vncpassword". You can change it by setting the `VNC_PASSWORD` environment variable in your `.env` file.
|
| 66 |
|
| 67 |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|