OpenWebUI/docs
1
0
Fork 0
mirror of https://github.com/open-webui/docs synced 2025-06-16 11:28:36 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

Merge pull request #178 from silentoplayz/silentoplayz-doc-patch

Browse Source 
Updates images.md & web_search.md
This commit is contained in:
Justin Hayes 2024-08-11 13:16:36 -04:00 committed by GitHub
commit dded06273f
2 changed files with 54 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

36
docs/tutorial/images.md
View File

@ -55,13 +55,47 @@ ComfyUI provides an alternative interface for managing and interacting with imag
### Configuring Open WebUI ### Configuring Open WebUI
1. In Open WebUI, navigate to the **Admin Panel** > **Settings** > **Images** menu. 1. Navigate to the **Admin Panel** > **Settings** > **Images** menu in Open WebUI.
2. Set the `Image Generation Engine` field to `ComfyUI`. 2. Set the `Image Generation Engine` field to `ComfyUI`.
3. In the API URL field, enter the address where ComfyUI's API is accessible: 3. In the API URL field, enter the address where ComfyUI's API is accessible:
``` ```
http://<your_comfyui_address>:8188/ http://<your_comfyui_address>:8188/
``` ```
Set the environment variable `COMFYUI_BASE_URL` to this address to ensure proper integration. Set the environment variable `COMFYUI_BASE_URL` to this address to ensure proper integration.
4. Verify the connection.
5. Save changes.
## Configuring for FLUX-Schnell & Flux-Dev models:
To enable ComfyUI Flux mode, add the following environment variables to your Docker-compose.yml file for Open WebUI:
```yaml
COMFYUI_BASE_URL="http://host.docker.internal:8188"
COMFYUI_CFG_SCALE="3.5"
COMFYUI_SAMPLER="euler"
COMFYUI_SCHEDULER="simple"
COMFYUI_SD3="false"
COMFYUI_FLUX="true" # Enables ComfyUI Flux mode.
COMFYUI_FLUX_WEIGHT_DTYPE="fp8_e4m3fn" # Ignored if Flux is not enabled. Sets the weight precision for Flux.
COMFYUI_FLUX_FP8_CLIP="true # Enable 8-bit precision for the Flux text encoder.
```
**Important Notes:**
* Flux mode has a completely different workflow that is not compatible with other models. Make sure you understand the implications before enabling it.
* A recent version of ComfyUI is required.
* Specific model checkpoints and files must be present in your ComfyUI installation.
### Model Checkpoints and Files
The following files are required for Flux mode:
* Model checkpoints (sft extension) in both `models/checkpoints` and `models/unet` directories. You can download the Flux variant from the [black-forest-labs HuggingFace page](https://huggingface.co/black-forest-labs).
* `clip_l.safetensors` in the `models/clip` directory. Download from [here](https://huggingface.co/comfyanonymous/flux_text_encoders/tree/main).
* `t5xxl_fp16.safetensors` in the `models/clip` directory, unless `COMFYUI_FLUX_FP8_CLIP` is enabled. Download from [here](https://huggingface.co/comfyanonymous/flux_text_encoders/tree/main).
* `ae.sft` in the `models/vae` directory. Download from [here](https://huggingface.co/black-forest-labs/FLUX.1-schnell/blob/main/ae.safetensors).
**Additional Requirements:**
* If `COMFYUI_FLUX_FP8_CLIP` is set to `true`, the `t5xxl_fp8_e4m3fn.safetensors` file must exist in the `models/clip` directory. Download from [here](https://huggingface.co/comfyanonymous/flux_text_encoders/tree/main).
## OpenAI DALL·E ## OpenAI DALL·E

24
docs/tutorial/web_search.md
View File

@ -5,11 +5,15 @@ title: "Web Search"
# Web Search # Web Search
## Overview
This guide provides instructions on how to set up web search capabilities in Open WebUI using various search engines.
## SearXNG (Docker) ## SearXNG (Docker)
This guide outlines how to connect SearXNG to Open WebUI for web search capabilities. SearXNG is a metasearch engine that aggregates results from multiple search engines.
### 1. Searxng Configuration ### 1. SearXNG Configuration
Create a folder named `searxng` in the same directory as your compose files. This folder will contain your Searxng configuration files. Refer to the [Searxng documentation](https://docs.searxng.org/) for configuration instructions. Create a folder named `searxng` in the same directory as your compose files. This folder will contain your Searxng configuration files. Refer to the [Searxng documentation](https://docs.searxng.org/) for configuration instructions.
@ -150,9 +154,15 @@ You can run SearXNG directly using `docker run`:
docker run -d --name searxng -p 8080:8080 -v ./searxng:/etc/searxng --restart always searxng/searxng:latest docker run -d --name searxng -p 8080:8080 -v ./searxng:/etc/searxng --restart always searxng/searxng:latest
``` ```
### 4. GUI configuration ### 4. GUI Configuration
1. Navigate to: `Admin Panel` -> `Settings` -> `Web Search`
2. Toggle `Enable Web Search`
3. Set `Web Search Engine` from dropdown menu to `searxng`
4. Set `Searxng Query URL` to examples given: `https://<search.domain.com>/search?q=<query>` or `http://<searxng.local>/search?q=<query>`. **Do note the `/search?q=<query>` part is mandatory.**
5. Adjust the `Search Result Count` and `Concurrent Requests` values accordingly
6. Save changes
Navigate to **Admin Settings > Web Search**:
![SearXNG GUI Configuration](/img/tutorial_searxng_config.png) ![SearXNG GUI Configuration](/img/tutorial_searxng_config.png)
### 5. Using Web Search in a Chat ### 5. Using Web Search in a Chat
@ -165,12 +175,14 @@ Here you can toggle Web Search On/Off.
#### Note #### Note
You will have to expicitly toggle this On/Off in a chat. You will have to explicitly toggle this On/Off in a chat.
This is enabled on a per session basis eg. reloading the page, changing to another chat will toggle off. This is enabled on a per session basis eg. reloading the page, changing to another chat will toggle off.
## Google PSE API ## Google PSE API
### Setup
1. Go to Google Developers, use [Programmable Search Engine](https://developers.google.com/custom-search), and log on or create account. 1. Go to Google Developers, use [Programmable Search Engine](https://developers.google.com/custom-search), and log on or create account.
2. Go to [control panel](https://programmablesearchengine.google.com/controlpanel/all) and click `Add` button 2. Go to [control panel](https://programmablesearchengine.google.com/controlpanel/all) and click `Add` button
3. Enter a search engine name, set the other properties to suit your needs, verify you're not a robot and click `Create` button. 3. Enter a search engine name, set the other properties to suit your needs, verify you're not a robot and click `Create` button.
@ -178,7 +190,7 @@ This is enabled on a per session basis eg. reloading the page, changing to anoth
5. With `API key` and `Search engine ID`, open `Open WebUI Admin panel` and click `Settings` tab, and then click `Web Search` 5. With `API key` and `Search engine ID`, open `Open WebUI Admin panel` and click `Settings` tab, and then click `Web Search`
6. Enable `Web search` and Set `Web Search Engine` to `google_pse` 6. Enable `Web search` and Set `Web Search Engine` to `google_pse`
7. Fill `Google PSE API Key` with the `API key` and `Google PSE Engine Id` (# 4) 7. Fill `Google PSE API Key` with the `API key` and `Google PSE Engine Id` (# 4)
8. click `Save` 8. Click `Save`
![Open WebUI Admin panel](../../static/img/tutorial_google_pse1.png) ![Open WebUI Admin panel](../../static/img/tutorial_google_pse1.png)