From 3f19a66f5cb5a131b881cb7baa93280ae09374f2 Mon Sep 17 00:00:00 2001 From: MathisRouget Date: Fri, 31 Oct 2025 11:31:04 +0100 Subject: [PATCH 1/3] docs: fix inadequate tool server connections json --- docs/getting-started/env-configuration.mdx | 21 ++++++++++++++++++++- 1 file changed, 20 insertions(+), 1 deletion(-) diff --git a/docs/getting-started/env-configuration.mdx b/docs/getting-started/env-configuration.mdx index bebb89ed..c9336d1c 100644 --- a/docs/getting-started/env-configuration.mdx +++ b/docs/getting-started/env-configuration.mdx @@ -737,7 +737,26 @@ The format for the JSON response is strictly: - Type: `str` (JSON array) - Default: `[]` - Description: Specifies a JSON array of tool server connection configurations. Each connection should define the necessary parameters to connect to external tool servers that implement the OpenAPI/MCPO protocol. The JSON must be properly formatted or it will fallback to an empty array. -- Example: `'[{"name": "example-server", "url": "https://api.example.com", "api_key": "your-key"}]'` +- Example: +```json +[ + { + "type": "openapi", + "url": "example-url", + "spec_type": "url", + "spec": "", + "path": "openapi.json", + "auth_type": "none", + "key": "", + "config": { "enable": true }, + "info": { + "id": "", + "name": "example-server", + "description": "MCP server description." + } + } +] +``` - Persistence: This environment variable is a `PersistentConfig` variable. ### Autocomplete From bf46b617980d4804f7e14af4deb18e98b1b94c35 Mon Sep 17 00:00:00 2001 From: MathisRouget Date: Sun, 2 Nov 2025 11:47:35 +0100 Subject: [PATCH 2/3] docs: add warning about tool connections data structure possible evolution overtime --- docs/getting-started/env-configuration.mdx | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/docs/getting-started/env-configuration.mdx b/docs/getting-started/env-configuration.mdx index c9336d1c..d68c33f1 100644 --- a/docs/getting-started/env-configuration.mdx +++ b/docs/getting-started/env-configuration.mdx @@ -759,6 +759,12 @@ The format for the JSON response is strictly: ``` - Persistence: This environment variable is a `PersistentConfig` variable. +:::warning + +The JSON data structure of `TOOL_SERVER_CONNECTIONS` might evolve over time as new features are added. + +::: + ### Autocomplete #### `ENABLE_AUTOCOMPLETE_GENERATION` From 5e30c6763cf66d508bfa16ad0fe6ea62ccbb06cb Mon Sep 17 00:00:00 2001 From: silentoplayz Date: Tue, 4 Nov 2025 14:17:05 -0500 Subject: [PATCH 3/3] feat(docs): add WSL-specific documentation for Docker Adds a new tab to the Docker quick start guide with instructions for setting up Open WebUI in a WSL environment. This should help users who are new to WSL and Docker get up and running more easily. --- docs/getting-started/quick-start/index.mdx | 6 +++ .../quick-start/tab-docker/WSL.md | 46 +++++++++++++++++++ 2 files changed, 52 insertions(+) create mode 100644 docs/getting-started/quick-start/tab-docker/WSL.md diff --git a/docs/getting-started/quick-start/index.mdx b/docs/getting-started/quick-start/index.mdx index a68baca8..a5c26235 100644 --- a/docs/getting-started/quick-start/index.mdx +++ b/docs/getting-started/quick-start/index.mdx @@ -12,6 +12,7 @@ import Podman from './tab-docker/Podman.md'; import PodmanKubePlay from './tab-docker/PodmanKubePlay.md'; import ManualDocker from './tab-docker/ManualDocker.md'; import DockerSwarm from './tab-docker/DockerSwarm.md'; +import WSL from './tab-docker/WSL.md'; import DockerUpdating from './tab-docker/DockerUpdating.md'; import Helm from './tab-kubernetes/Helm.md'; import Venv from './tab-python/Venv.md'; @@ -71,6 +72,11 @@ Choose your preferred installation method below: + +
+ +
+ diff --git a/docs/getting-started/quick-start/tab-docker/WSL.md b/docs/getting-started/quick-start/tab-docker/WSL.md new file mode 100644 index 00000000..49e93e8b --- /dev/null +++ b/docs/getting-started/quick-start/tab-docker/WSL.md @@ -0,0 +1,46 @@ +## Using Docker with WSL (Windows Subsystem for Linux) + +This guide provides instructions for setting up Docker and running Open WebUI in a Windows Subsystem for Linux (WSL) environment. + +### Step 1: Install WSL + +If you haven't already, install WSL by following the official Microsoft documentation: + +[Install WSL](https://learn.microsoft.com/en-us/windows/wsl/install) + +### Step 2: Install Docker Desktop + +Docker Desktop is the easiest way to get Docker running in a WSL environment. It handles the integration between Windows and WSL automatically. + +1. **Download Docker Desktop:** + [https://www.docker.com/products/docker-desktop/](https://www.docker.com/products/docker-desktop/) + +2. **Install Docker Desktop:** + Follow the installation instructions, making sure to select the "WSL 2" backend during the setup process. + +### Step 3: Configure Docker Desktop for WSL + +1. **Open Docker Desktop:** + Start the Docker Desktop application. + +2. **Enable WSL Integration:** + - Go to **Settings > Resources > WSL Integration**. + - Make sure the "Enable integration with my default WSL distro" checkbox is selected. + - If you are using a non-default WSL distribution, select it from the list. + +### Step 4: Run Open WebUI + +Now you can run Open WebUI by following the standard Docker instructions from within your WSL terminal. + +```bash +docker pull ghcr.io/open-webui/open-webui:main +docker run -d -p 3000:8080 -v open-webui:/app/backend/data --name open-webui ghcr.io/open-webui/open-webui:main +``` + +### Important Notes + +- **Run Docker Commands in WSL:** + Always run `docker` commands from your WSL terminal, not from PowerShell or Command Prompt. + +- **File System Access:** + When using volume mounts (`-v`), make sure the paths are accessible from your WSL distribution.