Skip to content
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions docs/features/auth/sso/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -139,6 +139,7 @@ You can configure the following environment variables to match the roles returne
1. `OAUTH_ROLES_CLAIM` - The claim that contains the roles. Defaults to `roles`. Can also be nested, for example `user.roles`.
1. `OAUTH_ALLOWED_ROLES` - A comma-separated list of roles that are allowed to log in (receive open webui role `user`).
1. `OAUTH_ADMIN_ROLES` - A comma-separated list of roles that are allowed to log in as an admin (receive open webui role `admin`).
1. `OAUTH_ROLES_SEPARATOR` - Allows specifying an alternative sparator for the `OAUTH_*_ROLES` variables.

:::info

Expand Down
6 changes: 6 additions & 0 deletions docs/getting-started/env-configuration.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -3426,6 +3426,12 @@ If `OAUTH_PICTURE_CLAIM` is set to `''` (empty string), then the OAuth picture c
- Description: Sets the roles that are considered administrators.
- Persistence: This environment variable is a `PersistentConfig` variable.

#### `OAUTH_ROLES_SEPARATOR`

- Type: `str`
- Default: `,`
- Description: Sets the separator used for splitting the `OAUTH_*_ROLES` variables.

#### `OAUTH_ALLOWED_DOMAINS`

- Type: `str`
Expand Down
6 changes: 6 additions & 0 deletions docs/getting-started/quick-start/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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';
Expand Down Expand Up @@ -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>
Expand Down
46 changes: 46 additions & 0 deletions docs/getting-started/quick-start/tab-docker/WSL.md
Original file line number Diff line number Diff line change
@@ -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.
Loading