Merge pull request #411 from roryeckel/playwright

Document Playwright Environment Variables
This commit is contained in:
Timothy Jaeryang Baek 2025-03-15 17:32:37 +00:00 committed by GitHub
commit ce060b0285
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194

View File

@ -1202,6 +1202,41 @@ When enabling `GOOGLE_DRIVE_INTEGRATION`, ensure that you have configured `GOOGL
- `bing` - Uses the [Bing](https://www.bing.com/) search engine.
- Persistence: This environment variable is a `PersistentConfig` variable.
### Web Loader Configuration
#### `RAG_WEB_LOADER_ENGINE`
- Type: `str`
- Default: `safe_web`
- Description: Specifies the loader to use for retrieving and processing web content. Options include:
- `safe_web` - Uses the `requests` module with enhanced error handling.
- `playwright` - Uses Playwright for more advanced web page rendering and interaction.
- Persistence: This environment variable is a `PersistentConfig` variable.
:::info
When using `playwright`, you have two options:
1. If `PLAYWRIGHT_WS_URI` is not set, Playwright with Chromium dependencies will be automatically installed in the Open WebUI container on launch.
2. If `PLAYWRIGHT_WS_URI` is set, Open WebUI will connect to a remote browser instance instead of installing dependencies locally.
:::
#### `PLAYWRIGHT_WS_URI`
- Type: `str`
- Default: `None`
- Description: Specifies the WebSocket URI of a remote Playwright browser instance. When set, Open WebUI will use this remote browser instead of installing browser dependencies locally. This is particularly useful in containerized environments where you want to keep the Open WebUI container lightweight and separate browser concerns. Example: `ws://playwright:3000`
- Persistence: This environment variable is a `PersistentConfig` variable.
:::tip
Using a remote Playwright browser via `PLAYWRIGHT_WS_URI` can be beneficial for:
- Reducing the size of the Open WebUI container
- Using a different browser other than the default Chromium
- Connecting to a non-headless (GUI) browser
:::
#### `SEARXNG_QUERY_URL`
- Type: `str`