> ## Documentation Index
> Fetch the complete documentation index at: https://mintlify.com/open-webui/open-webui/llms.txt
> Use this file to discover all available pages before exploring further.

# Configuration

> Complete guide to configuring Open WebUI environment variables and settings

# Configuration Guide

Open WebUI can be configured through environment variables, providing flexibility for different deployment scenarios. This guide covers all major configuration options.

## Setting Environment Variables

<Tabs>
  <Tab title="Docker">
    Use the `-e` flag to set environment variables:

    ```bash theme={null}
    docker run -d -p 3000:8080 \
      -e OLLAMA_BASE_URL=http://ollama:11434 \
      -e WEBUI_SECRET_KEY=your_secret_key \
      -e ENABLE_SIGNUP=False \
      -v open-webui:/app/backend/data \
      --name open-webui \
      ghcr.io/open-webui/open-webui:main
    ```
  </Tab>

  <Tab title="Docker Compose">
    Add variables to the `environment` section:

    ```yaml theme={null}
    services:
      open-webui:
        image: ghcr.io/open-webui/open-webui:main
        environment:
          - OLLAMA_BASE_URL=http://ollama:11434
          - WEBUI_SECRET_KEY=your_secret_key
          - ENABLE_SIGNUP=False
    ```
  </Tab>

  <Tab title=".env File">
    Create a `.env` file in your project directory:

    ```bash theme={null}
    OLLAMA_BASE_URL=http://localhost:11434
    OPENAI_API_BASE_URL=
    OPENAI_API_KEY=
    WEBUI_SECRET_KEY=
    CORS_ALLOW_ORIGIN=*
    SCARF_NO_ANALYTICS=true
    DO_NOT_TRACK=true
    ANONYMIZED_TELEMETRY=false
    ```

    Reference it in Docker Compose:

    ```yaml theme={null}
    services:
      open-webui:
        env_file:
          - .env
    ```
  </Tab>

  <Tab title="Python/pip">
    Export variables before running:

    ```bash theme={null}
    export OLLAMA_BASE_URL=http://localhost:11434
    export WEBUI_SECRET_KEY=your_secret_key
    open-webui serve
    ```
  </Tab>
</Tabs>

***

## Core Configuration

### Application Settings

| Variable             | Description                              | Default             |
| -------------------- | ---------------------------------------- | ------------------- |
| `WEBUI_NAME`         | Application name displayed in UI         | `Open WebUI`        |
| `WEBUI_URL`          | Base URL for the application             | -                   |
| `ENV`                | Environment mode (`dev`, `test`, `prod`) | `dev`               |
| `DATA_DIR`           | Directory for storing data               | `/app/backend/data` |
| `FRONTEND_BUILD_DIR` | Frontend build directory                 | `/app/build`        |
| `ENABLE_SIGNUP`      | Allow new user registrations             | `True`              |
| `ENABLE_LOGIN_FORM`  | Show login form                          | `True`              |
| `DEFAULT_LOCALE`     | Default UI language                      | -                   |

<Warning>
  Always set `ENABLE_SIGNUP=False` after creating your admin account to prevent unauthorized access.
</Warning>

### Security Settings

| Variable                         | Description                                      | Default      |
| -------------------------------- | ------------------------------------------------ | ------------ |
| `WEBUI_SECRET_KEY`               | Secret key for sessions (required in production) | `t0p-s3cr3t` |
| `WEBUI_AUTH`                     | Enable authentication                            | `True`       |
| `JWT_EXPIRES_IN`                 | JWT token expiration time                        | `4w`         |
| `ENABLE_API_KEYS`                | Allow users to create API keys                   | `False`      |
| `WEBUI_SESSION_COOKIE_SAME_SITE` | Cookie SameSite attribute                        | `lax`        |
| `WEBUI_SESSION_COOKIE_SECURE`    | Require HTTPS for cookies                        | `false`      |

<CodeGroup>
  ```bash Production Security theme={null}
  # Secure configuration for production
  WEBUI_SECRET_KEY=$(openssl rand -base64 32)
  WEBUI_AUTH=True
  ENABLE_SIGNUP=False
  WEBUI_SESSION_COOKIE_SECURE=True
  JWT_EXPIRES_IN=1w
  ```

  ```bash Development theme={null}
  # Development configuration
  WEBUI_SECRET_KEY=dev_secret_key
  WEBUI_AUTH=True
  ENABLE_SIGNUP=True
  ```
</CodeGroup>

***

## Model Provider Configuration

### Ollama Settings

| Variable             | Description                                   | Default                  |
| -------------------- | --------------------------------------------- | ------------------------ |
| `ENABLE_OLLAMA_API`  | Enable Ollama integration                     | `True`                   |
| `OLLAMA_BASE_URL`    | Ollama server URL                             | `http://localhost:11434` |
| `OLLAMA_BASE_URLS`   | Multiple Ollama servers (semicolon-separated) | -                        |
| `OLLAMA_API_CONFIGS` | API configurations per server                 | `{}`                     |

<CodeGroup>
  ```bash Single Server theme={null}
  OLLAMA_BASE_URL=http://localhost:11434
  ```

  ```bash Multiple Servers theme={null}
  OLLAMA_BASE_URLS=http://ollama1:11434;http://ollama2:11434;http://ollama3:11434
  ```

  ```bash Remote Server theme={null}
  OLLAMA_BASE_URL=https://ollama.example.com
  ```
</CodeGroup>

### OpenAI API Settings

| Variable               | Description                             | Default                     |
| ---------------------- | --------------------------------------- | --------------------------- |
| `ENABLE_OPENAI_API`    | Enable OpenAI integration               | `True`                      |
| `OPENAI_API_KEY`       | OpenAI API key                          | -                           |
| `OPENAI_API_BASE_URL`  | OpenAI API endpoint                     | `https://api.openai.com/v1` |
| `OPENAI_API_KEYS`      | Multiple API keys (semicolon-separated) | -                           |
| `OPENAI_API_BASE_URLS` | Multiple API endpoints                  | -                           |

<CodeGroup>
  ```bash OpenAI theme={null}
  OPENAI_API_KEY=sk-...
  OPENAI_API_BASE_URL=https://api.openai.com/v1
  ```

  ```bash Azure OpenAI theme={null}
  OPENAI_API_KEY=your_azure_key
  OPENAI_API_BASE_URL=https://your-resource.openai.azure.com/openai/deployments/your-deployment
  ```

  ```bash Multiple Providers theme={null}
  OPENAI_API_KEYS=sk-key1;sk-key2;sk-key3
  OPENAI_API_BASE_URLS=https://api.openai.com/v1;https://api.groq.com/v1;https://api.together.xyz/v1
  ```
</CodeGroup>

***

## Database Configuration

### SQLite (Default)

```bash theme={null}
DATABASE_URL=sqlite:///app/backend/data/webui.db
DATABASE_ENABLE_SQLITE_WAL=False
```

### PostgreSQL

```bash theme={null}
DATABASE_URL=postgresql://user:password@host:5432/database
```

Or use individual variables:

```bash theme={null}
DATABASE_TYPE=postgresql
DATABASE_USER=openwebui
DATABASE_PASSWORD=your_password
DATABASE_HOST=postgres
DATABASE_PORT=5432
DATABASE_NAME=openwebui
```

### Database Pool Settings

| Variable                     | Description                       | Default |
| ---------------------------- | --------------------------------- | ------- |
| `DATABASE_POOL_SIZE`         | Connection pool size              | -       |
| `DATABASE_POOL_MAX_OVERFLOW` | Max overflow connections          | `0`     |
| `DATABASE_POOL_TIMEOUT`      | Connection timeout (seconds)      | `30`    |
| `DATABASE_POOL_RECYCLE`      | Connection recycle time (seconds) | `3600`  |
| `ENABLE_DB_MIGRATIONS`       | Auto-run database migrations      | `True`  |

<Tip>
  For production PostgreSQL deployments, configure pool settings based on your load:

  ```bash theme={null}
  DATABASE_POOL_SIZE=20
  DATABASE_POOL_MAX_OVERFLOW=10
  DATABASE_POOL_TIMEOUT=30
  ```
</Tip>

***

## Redis Configuration

Redis is required for horizontal scaling and multi-worker deployments.

| Variable               | Description                      | Default      |
| ---------------------- | -------------------------------- | ------------ |
| `REDIS_URL`            | Redis connection URL             | -            |
| `REDIS_CLUSTER`        | Use Redis Cluster                | `False`      |
| `REDIS_KEY_PREFIX`     | Key prefix for namespacing       | `open-webui` |
| `REDIS_SENTINEL_HOSTS` | Sentinel hosts (comma-separated) | -            |
| `REDIS_SENTINEL_PORT`  | Sentinel port                    | `26379`      |

<CodeGroup>
  ```bash Single Redis theme={null}
  REDIS_URL=redis://localhost:6379/0
  REDIS_KEY_PREFIX=open-webui
  ```

  ```bash Redis Cluster theme={null}
  REDIS_URL=redis://localhost:6379/0
  REDIS_CLUSTER=True
  ```

  ```bash Redis Sentinel theme={null}
  REDIS_SENTINEL_HOSTS=sentinel1,sentinel2,sentinel3
  REDIS_SENTINEL_PORT=26379
  REDIS_KEY_PREFIX=open-webui
  ```
</CodeGroup>

***

## Storage Configuration

### Local Storage (Default)

```bash theme={null}
STORAGE_PROVIDER=local
DATA_DIR=/app/backend/data
```

### Amazon S3

```bash theme={null}
STORAGE_PROVIDER=s3
S3_ACCESS_KEY_ID=your_access_key
S3_SECRET_ACCESS_KEY=your_secret_key
S3_REGION_NAME=us-east-1
S3_BUCKET_NAME=open-webui
S3_ENDPOINT_URL=https://s3.amazonaws.com
```

### Google Cloud Storage

```bash theme={null}
STORAGE_PROVIDER=gcs
GCS_BUCKET_NAME=open-webui
GOOGLE_APPLICATION_CREDENTIALS_JSON='{"type":"service_account",...}'
```

### Azure Blob Storage

```bash theme={null}
STORAGE_PROVIDER=azure
AZURE_STORAGE_ENDPOINT=https://account.blob.core.windows.net
AZURE_STORAGE_CONTAINER_NAME=open-webui
AZURE_STORAGE_KEY=your_storage_key
```

***

## RAG & Vector Database

### Vector Database Options

Open WebUI supports multiple vector databases for RAG:

* ChromaDB (default)
* PGVector
* Qdrant
* Milvus
* Elasticsearch
* OpenSearch
* Pinecone
* S3Vector
* Oracle 23ai

Configuration is typically done through the Admin Panel UI.

### RAG Settings

| Variable                | Description                            | Default |
| ----------------------- | -------------------------------------- | ------- |
| `RAG_EMBEDDING_TIMEOUT` | Embedding generation timeout           | -       |
| `RAG_SYSTEM_CONTEXT`    | Include RAG context in system messages | `False` |
| `ENABLE_QUERIES_CACHE`  | Cache query results                    | `False` |

***

## Authentication & OAuth

### OAuth Providers

<Tabs>
  <Tab title="Google OAuth">
    ```bash theme={null}
    GOOGLE_CLIENT_ID=your_client_id.apps.googleusercontent.com
    GOOGLE_CLIENT_SECRET=your_client_secret
    GOOGLE_REDIRECT_URI=http://localhost:3000/oauth/google/callback
    ENABLE_OAUTH_SIGNUP=True
    ```
  </Tab>

  <Tab title="Microsoft OAuth">
    ```bash theme={null}
    MICROSOFT_CLIENT_ID=your_client_id
    MICROSOFT_CLIENT_SECRET=your_client_secret
    MICROSOFT_CLIENT_TENANT_ID=your_tenant_id
    MICROSOFT_REDIRECT_URI=http://localhost:3000/oauth/microsoft/callback
    ENABLE_OAUTH_SIGNUP=True
    ```
  </Tab>

  <Tab title="GitHub OAuth">
    ```bash theme={null}
    GITHUB_CLIENT_ID=your_client_id
    GITHUB_CLIENT_SECRET=your_client_secret
    GITHUB_CLIENT_REDIRECT_URI=http://localhost:3000/oauth/github/callback
    ENABLE_OAUTH_SIGNUP=True
    ```
  </Tab>

  <Tab title="Generic OIDC">
    ```bash theme={null}
    OAUTH_CLIENT_ID=your_client_id
    OAUTH_CLIENT_SECRET=your_client_secret
    OPENID_PROVIDER_URL=https://auth.example.com/.well-known/openid-configuration
    OPENID_REDIRECT_URI=http://localhost:3000/oauth/oidc/callback
    OAUTH_PROVIDER_NAME=SSO
    ENABLE_OAUTH_SIGNUP=True
    ```
  </Tab>
</Tabs>

### LDAP/Active Directory

LDAP integration is configured through the Admin Panel UI.

### SCIM 2.0 Provisioning

```bash theme={null}
ENABLE_SCIM=True
SCIM_TOKEN=your_scim_bearer_token
SCIM_AUTH_PROVIDER=oidc
```

***

## User Permissions

### Default User Role

```bash theme={null}
# Options: admin, user, pending
DEFAULT_USER_ROLE=pending
```

### Chat Permissions

```bash theme={null}
# Chat controls
USER_PERMISSIONS_CHAT_FILE_UPLOAD=True
USER_PERMISSIONS_CHAT_DELETE=True
USER_PERMISSIONS_CHAT_EDIT=True
USER_PERMISSIONS_CHAT_TEMPORARY=True

# Advanced features
USER_PERMISSIONS_CHAT_MULTIPLE_MODELS=True
USER_PERMISSIONS_CHAT_CALL=True
```

### Workspace Permissions

```bash theme={null}
# Access to workspace features
USER_PERMISSIONS_WORKSPACE_MODELS_ACCESS=False
USER_PERMISSIONS_WORKSPACE_KNOWLEDGE_ACCESS=False
USER_PERMISSIONS_WORKSPACE_PROMPTS_ACCESS=False
USER_PERMISSIONS_WORKSPACE_TOOLS_ACCESS=False

# Sharing permissions
USER_PERMISSIONS_WORKSPACE_MODELS_ALLOW_SHARING=False
USER_PERMISSIONS_WORKSPACE_PROMPTS_ALLOW_SHARING=False
```

***

## Performance & Scaling

### Worker Configuration

```bash theme={null}
# Number of uvicorn worker processes
UVICORN_WORKERS=1
```

<Warning>
  When using multiple workers (`UVICORN_WORKERS > 1`), you must configure Redis for session management:

  ```bash theme={null}
  UVICORN_WORKERS=4
  REDIS_URL=redis://localhost:6379/0
  ```
</Warning>

### WebSocket Configuration

```bash theme={null}
ENABLE_WEBSOCKET_SUPPORT=True
WEBSOCKET_MANAGER=
WEBSOCKET_REDIS_URL=redis://localhost:6379/0
```

### Caching

```bash theme={null}
# Model list caching (seconds)
MODELS_CACHE_TTL=1

# Query caching
ENABLE_QUERIES_CACHE=False

# Base models cache
ENABLE_BASE_MODELS_CACHE=False
```

***

## Observability

### OpenTelemetry

```bash theme={null}
ENABLE_OTEL=True
ENABLE_OTEL_TRACES=True
ENABLE_OTEL_METRICS=True
ENABLE_OTEL_LOGS=True

OTEL_EXPORTER_OTLP_ENDPOINT=http://localhost:4317
OTEL_SERVICE_NAME=open-webui
OTEL_TRACES_SAMPLER=parentbased_always_on
```

### Audit Logging

```bash theme={null}
ENABLE_AUDIT_LOGS_FILE=True
AUDIT_LOGS_FILE_PATH=/app/backend/data/audit.log
AUDIT_LOG_FILE_ROTATION_SIZE=10MB
AUDIT_LOG_LEVEL=METADATA
```

### General Logging

```bash theme={null}
GLOBAL_LOG_LEVEL=INFO
LOG_FORMAT=json
```

***

## Network & CORS

```bash theme={null}
# CORS configuration
CORS_ALLOW_ORIGIN=*

# Forwarded IPs (for proxy setups)
FORWARDED_ALLOW_IPS=*

# Forward user info headers
ENABLE_FORWARD_USER_INFO_HEADERS=False
```

***

## Advanced Features

### Image Generation

Configure through Admin Panel UI. Supports:

* OpenAI DALL-E
* Google Gemini
* ComfyUI (local)
* AUTOMATIC1111 (local)

### Web Search

Configure search providers through Admin Panel UI. Supports 15+ providers including:

* SearXNG
* Google Programmable Search Engine
* Brave Search
* DuckDuckGo
* Tavily
* Perplexity

### Tool/Function Calling

```bash theme={null}
# Enable pip install for function requirements
ENABLE_PIP_INSTALL_FRONTMATTER_REQUIREMENTS=True

# Pip options
PIP_OPTIONS=--no-cache-dir
```

***

## Environment-Specific Examples

<CodeGroup>
  ```bash Development theme={null}
  # Development environment
  ENV=dev
  WEBUI_SECRET_KEY=dev_secret
  ENABLE_SIGNUP=True
  OLLAMA_BASE_URL=http://localhost:11434
  DATABASE_URL=sqlite:///app/backend/data/webui.db
  GLOBAL_LOG_LEVEL=DEBUG
  ```

  ```bash Production (Single Instance) theme={null}
  # Production - single server
  ENV=prod
  WEBUI_SECRET_KEY=$(openssl rand -base64 32)
  ENABLE_SIGNUP=False
  OLLAMA_BASE_URL=http://ollama:11434
  DATABASE_URL=postgresql://user:pass@db:5432/openwebui
  WEBUI_SESSION_COOKIE_SECURE=True
  GLOBAL_LOG_LEVEL=INFO
  ENABLE_OTEL=True
  ```

  ```bash Production (Multi-Worker) theme={null}
  # Production - horizontal scaling
  ENV=prod
  WEBUI_SECRET_KEY=$(openssl rand -base64 32)
  ENABLE_SIGNUP=False
  UVICORN_WORKERS=4
  REDIS_URL=redis://redis:6379/0
  DATABASE_URL=postgresql://user:pass@db:5432/openwebui
  STORAGE_PROVIDER=s3
  S3_BUCKET_NAME=open-webui
  ENABLE_WEBSOCKET_SUPPORT=True
  WEBSOCKET_REDIS_URL=redis://redis:6379/1
  ```

  ```bash Enterprise theme={null}
  # Enterprise deployment
  ENV=prod
  WEBUI_SECRET_KEY=$(openssl rand -base64 32)
  ENABLE_SIGNUP=False
  DEFAULT_USER_ROLE=pending

  # OAuth
  ENABLE_OAUTH_SIGNUP=True
  OAUTH_CLIENT_ID=your_client_id
  OAUTH_CLIENT_SECRET=your_secret
  OPENID_PROVIDER_URL=https://auth.company.com/.well-known/openid-configuration

  # SCIM
  ENABLE_SCIM=True
  SCIM_TOKEN=your_scim_token

  # Database & Storage
  DATABASE_URL=postgresql://user:pass@db:5432/openwebui
  STORAGE_PROVIDER=s3
  REDIS_URL=redis://redis-cluster:6379/0

  # Observability
  ENABLE_OTEL=True
  OTEL_EXPORTER_OTLP_ENDPOINT=https://otel-collector.company.com:4317
  ```
</CodeGroup>

***

## Next Steps

<CardGroup cols={2}>
  <Card title="User Management" icon="users" href="/admin/users">
    Set up roles, permissions, and access control
  </Card>

  <Card title="Model Configuration" icon="brain" href="/admin/models">
    Configure and manage AI models
  </Card>

  <Card title="API Reference" icon="code" href="/api">
    Integrate Open WebUI programmatically
  </Card>

  <Card title="Troubleshooting" icon="wrench" href="/troubleshooting">
    Common issues and solutions
  </Card>
</CardGroup>

***

<Note>
  For a complete list of all environment variables, see the [source code](https://github.com/open-webui/open-webui/blob/main/backend/open_webui/env.py) or check your `.env.example` file.
</Note>