mirror of
https://github.com/open-webui/docs.git
synced 2026-01-02 17:59:41 +07:00
Merge pull request #792 from open-webui/main
This commit is contained in:
@@ -737,9 +737,34 @@ 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.
|
||||
|
||||
:::warning
|
||||
|
||||
The JSON data structure of `TOOL_SERVER_CONNECTIONS` might evolve over time as new features are added.
|
||||
|
||||
:::
|
||||
|
||||
### Autocomplete
|
||||
|
||||
#### `ENABLE_AUTOCOMPLETE_GENERATION`
|
||||
|
||||
@@ -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:
|
||||
<DockerSwarm />
|
||||
</div>
|
||||
</TabItem>
|
||||
<TabItem value="wsl" label="WSL">
|
||||
<div className='mt-5'>
|
||||
<WSL />
|
||||
</div>
|
||||
</TabItem>
|
||||
</Tabs>
|
||||
|
||||
</TabItem>
|
||||
|
||||
46
docs/getting-started/quick-start/tab-docker/WSL.md
Normal file
46
docs/getting-started/quick-start/tab-docker/WSL.md
Normal file
@@ -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.
|
||||
Reference in New Issue
Block a user