diff --git a/docs/tutorials/integrations/dev-tools/browser-search-engine.md b/docs/tutorials/integrations/dev-tools/browser-search-engine.md index ccb8d800c3..da3286e6a7 100644 --- a/docs/tutorials/integrations/dev-tools/browser-search-engine.md +++ b/docs/tutorials/integrations/dev-tools/browser-search-engine.md @@ -20,32 +20,11 @@ Open WebUI allows you to integrate directly into your web browser. This tutorial Before you begin, ensure that: - You have Chrome or another supported browser installed. -- The `WEBUI_URL` environment variable is set correctly, either using Docker environment variables or in the `.env` file as specified in the [Getting Started](https://docs.openwebui.com/reference/env-configuration) guide. +- Your Open WebUI instance is reachable from the browser at a stable URL. -### Step 1: Set the WEBUI_URL Environment Variable +### Step 1: Note your Open WebUI URL -Setting the `WEBUI_URL` environment variable ensures your browser knows where to direct queries. - -#### Using Docker Environment Variables - -If you are running Open WebUI using Docker, you can set the environment variable in your `docker run` command: - -```bash -docker run -d \ - -p 3000:8080 \ - --add-host=host.docker.internal:host-gateway \ - -v open-webui:/app/backend/data \ - --name open-webui \ - --restart always \ - -e WEBUI_URL="https://" \ - ghcr.io/open-webui/open-webui:main -``` - -Alternatively, you can add the variable to your `.env` file: - -```plaintext -WEBUI_URL=https:// -``` +The integration is entirely browser-side: the browser opens `/?q=%s` and Open WebUI reads the `q` parameter from the page URL. No environment variable is involved; `WEBUI_URL` is a server-side setting for OAuth redirects and links and plays no part here. ### Step 2: Add Open WebUI as a Custom Search Engine @@ -105,6 +84,6 @@ This command will redirect you to the Open WebUI interface with your search resu If you encounter any issues, check the following: -- Ensure the `WEBUI_URL` is correctly configured and points to a valid Open WebUI instance. +- Ensure the URL in the search-engine setting points to a running Open WebUI instance. - Double-check that the search engine URL format is correctly entered in your browser settings. - Confirm your internet connection is active and that the Open WebUI service is running smoothly. diff --git a/docs/tutorials/integrations/dev-tools/continue-dev.md b/docs/tutorials/integrations/dev-tools/continue-dev.md index 6008e675ab..3d56274ab4 100644 --- a/docs/tutorials/integrations/dev-tools/continue-dev.md +++ b/docs/tutorials/integrations/dev-tools/continue-dev.md @@ -163,7 +163,7 @@ apiBase: http://localhost:3000/api ### API Key -To authenticate with your Open WebUI instance, you'll need to generate an API key. +To authenticate with your Open WebUI instance, you'll need to generate an API key. API keys are off by default: an admin must enable them (`ENABLE_API_KEYS`), and if endpoint restrictions are on, `/api/chat/completions` and `/api/models` must be listed in `API_KEYS_ALLOWED_ENDPOINTS`. Follow the instructions in the [API Endpoints guide](/reference/api-endpoints) to create it. ```yaml diff --git a/docs/tutorials/integrations/dev-tools/firefox-sidebar.md b/docs/tutorials/integrations/dev-tools/firefox-sidebar.md index adaafe4b6c..a704bc7030 100644 --- a/docs/tutorials/integrations/dev-tools/firefox-sidebar.md +++ b/docs/tutorials/integrations/dev-tools/firefox-sidebar.md @@ -79,6 +79,12 @@ The following URL parameters can be used to customize your Open WebUI instance: - `q`: Set an initial query or prompt for the chat (e.g., `/?q=Hello%20there`) +### Other Parameters + +- `submit=false`: Prefill the `q` prompt without sending it (by default `q` is submitted immediately) +- `load-url`: Fetch a web page into the chat (e.g., `/?load-url=https://example.com`) +- `image-generation=true` and `code-interpreter=true`: Turn those features on for the chat + ### Temporary Chat Sessions - `temporary-chat`: Mark the chat as a temporary session by setting this parameter to `true` (e.g., `/?temporary-chat=true`) diff --git a/docs/tutorials/integrations/dev-tools/iterm2.md b/docs/tutorials/integrations/dev-tools/iterm2.md index e4f32338a4..786acee1ae 100644 --- a/docs/tutorials/integrations/dev-tools/iterm2.md +++ b/docs/tutorials/integrations/dev-tools/iterm2.md @@ -29,7 +29,7 @@ Unzip the file and move the application into your **Applications** folder. ### 2. Generate your Open WebUI API key -To authenticate with your Open WebUI instance, you'll need to generate an API key. +To authenticate with your Open WebUI instance, you'll need to generate an API key. API keys are off by default: an admin must enable them (`ENABLE_API_KEYS`), and if endpoint restrictions are on, `/api/chat/completions` and `/api/models` must be listed in `API_KEYS_ALLOWED_ENDPOINTS`. Follow the instructions in the [API Endpoints guide](/reference/api-endpoints) to create it. ## Configuration diff --git a/docs/tutorials/integrations/llm-providers/ipex_llm.md b/docs/tutorials/integrations/llm-providers/ipex_llm.md index bf5f5285d6..0def448eb3 100644 --- a/docs/tutorials/integrations/llm-providers/ipex_llm.md +++ b/docs/tutorials/integrations/llm-providers/ipex_llm.md @@ -37,11 +37,11 @@ If you would like to reach the Ollama service from another machine, make sure yo ## Configure Open WebUI -Access the Ollama settings through **Settings -> Connections** in the menu. By default, the **Ollama Base URL** is preset to http://localhost:11434, as illustrated in the snapshot below. To verify the status of the Ollama service connection, click the **Refresh button** located next to the textbox. If the WebUI is unable to establish a connection with the Ollama server, you will see an error message stating, `WebUI could not connect to Ollama`. +Access the Ollama settings through **Settings -> Connections** in the menu. By default, the **Ollama Base URL** is preset to http://localhost:11434 (in Docker, to `http://host.docker.internal:11434`), as illustrated in the snapshot below. To verify the status of the Ollama service connection, click the **Refresh button** located next to the textbox. If the WebUI is unable to establish a connection with the Ollama server, you will see a connection error toast. ![Open WebUI Ollama Setting Failure](https://llm-assets.readthedocs.io/en/latest/_images/open_webui_settings_0.png) -If the connection is successful, you will see a message stating `Service Connection Verified`, as illustrated below. +If the connection is successful, you will see a message stating `Server connection verified`, as illustrated below. ![Open WebUI Ollama Setting Success](https://llm-assets.readthedocs.io/en/latest/_images/open_webui_settings.png)