open-webui/docs
1
0
Fork 0
mirror of https://github.com/open-webui/docs.git synced 2026-07-20 15:38:19 -04:00
Code Issues 37 Packages Projects Releases Wiki Activity

[PR #501] [MERGED] Update env-configuration.md #560

New Issue
Closed
opened 2026-02-15 17:17:39 -05:00 by yindo · 0 comments
yindo commented 2026-02-15 17:17:39 -05:00
Owner
Copy Link
Copy Source

📋 Pull Request Information

Original PR: https://github.com/open-webui/docs/pull/501
Author: @silentoplayz
Created: 4/15/2025
Status: ✅ Merged
Merged: 4/15/2025
Merged by: @tjbck

Base: main ← Head: main

📝 Commits (6)

  • e62759b Update env-configuration.md
  • dcf2dc1 Update env-configuration.md
  • 6a70edd Update env-configuration.md
  • 3e62a11 Update env-configuration.md
  • 72963f3 Update env-configuration.md
  • 8f58c85 Update env-configuration.md

📊 Changes

1 file changed (+1131 additions, -493 deletions)

View changed files

📝 docs/getting-started/env-configuration.md (+1131 -493)

📄 Description

This PR focuses on adding many missing PersistentConfig environment variables to the env-configuration.md documentation page. Many environment variables have been rearranged within their respective categories as well.

I skipped adding or documenting the following environment variables:

    - DEFAULT_PROMPT_SUGGESTIONS
    - EVALUATION_ARENA_MODELS
    - MODEL_ORDER_LIST
    - OAUTH_GROUPS_CLAIM
    - OLLAMA_API_CONFIGS
    - OPENAI_API_CONFIGS
    - TOOL_SERVER_CONNECTIONS
    - USER_PERMISSIONS
    - WEB_SEARCH_DOMAIN_FILTER_LIST

The env vars above are likely PersistentConfig env vars, but I was told that most of these should be set via the WebUI settings rather than as an env var.

Other undocumented environment variables (not from backend/open_webui/config.py):

    - AIOHTTP_CLIENT_TIMEOUT_TOOL_SERVER_DATA (default: '10', type: str) (in files: env.py)
    - AUDIT_EXCLUDED_PATHS (default: '/chats,/chat,/folders', type: str) (in files: env.py)
    - AUDIT_LOG_FILE_ROTATION_SIZE (default: '10MB', type: str) (in files: env.py)
    - AUDIT_LOG_LEVEL (default: 'NONE', type: str) (in files: env.py)
    - DATABASE_SCHEMA (default: None) (in files: env.py)
    - DOCKER (default: 'False', type: str) (in files: env.py)
    - ENABLE_OTEL (default: 'False', type: str) (in files: env.py)
    - HF_HUB_OFFLINE (default: None) (in files: env.py)
    - MAX_BODY_LOG_SIZE (default: None) (in files: env.py)
    - OTEL_EXPORTER_OTLP_ENDPOINT (default: 'http://localhost:4317', type: str) (in files: env.py)
    - OTEL_RESOURCE_ATTRIBUTES (default: '', type: str) (in files: env.py)
    - OTEL_SERVICE_NAME (default: 'open-webui', type: str) (in files: env.py)
    - OTEL_TRACES_SAMPLER (default: 'parentbased_always_on', type: str) (in files: env.py)
    - TRUSTED_SIGNATURE_KEY (default: '', type: str) (in files: env.py)
    - WEBSOCKET_REDIS_LOCK_TIMEOUT (default: '60', type: str) (in files: env.py)

🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.

## 📋 Pull Request Information **Original PR:** https://github.com/open-webui/docs/pull/501 **Author:** [@silentoplayz](https://github.com/silentoplayz) **Created:** 4/15/2025 **Status:** ✅ Merged **Merged:** 4/15/2025 **Merged by:** [@tjbck](https://github.com/tjbck) **Base:** `main` ← **Head:** `main` --- ### 📝 Commits (6) - [`e62759b`](https://github.com/open-webui/docs/commit/e62759bf0d40d7ea319bfea421792e468994114f) Update env-configuration.md - [`dcf2dc1`](https://github.com/open-webui/docs/commit/dcf2dc1697f514ab0c899ce43bc77e125ff7ee71) Update env-configuration.md - [`6a70edd`](https://github.com/open-webui/docs/commit/6a70edd5c9b46a56b606213e65da18a4bd977309) Update env-configuration.md - [`3e62a11`](https://github.com/open-webui/docs/commit/3e62a1165a80570295e67e0dfec35818cb999417) Update env-configuration.md - [`72963f3`](https://github.com/open-webui/docs/commit/72963f3665befface803de806cc4199b6ef7f9e3) Update env-configuration.md - [`8f58c85`](https://github.com/open-webui/docs/commit/8f58c85ad2e44dc964428cd8e1afcd5347d0d5a5) Update env-configuration.md ### 📊 Changes **1 file changed** (+1131 additions, -493 deletions) <details> <summary>View changed files</summary> 📝 `docs/getting-started/env-configuration.md` (+1131 -493) </details> ### 📄 Description This PR focuses on adding many missing PersistentConfig environment variables to the `env-configuration.md` documentation page. Many environment variables have been rearranged within their respective categories as well. I skipped adding or documenting the following environment variables: ``` - DEFAULT_PROMPT_SUGGESTIONS - EVALUATION_ARENA_MODELS - MODEL_ORDER_LIST - OAUTH_GROUPS_CLAIM - OLLAMA_API_CONFIGS - OPENAI_API_CONFIGS - TOOL_SERVER_CONNECTIONS - USER_PERMISSIONS - WEB_SEARCH_DOMAIN_FILTER_LIST ``` The env vars above are likely `PersistentConfig` env vars, but I was told that most of these should be set via the WebUI settings rather than as an env var. Other undocumented environment variables (not from [backend/open_webui/config.py](https://github.com/open-webui/open-webui/blob/main/backend/open_webui/config.py)): ``` - AIOHTTP_CLIENT_TIMEOUT_TOOL_SERVER_DATA (default: '10', type: str) (in files: env.py) - AUDIT_EXCLUDED_PATHS (default: '/chats,/chat,/folders', type: str) (in files: env.py) - AUDIT_LOG_FILE_ROTATION_SIZE (default: '10MB', type: str) (in files: env.py) - AUDIT_LOG_LEVEL (default: 'NONE', type: str) (in files: env.py) - DATABASE_SCHEMA (default: None) (in files: env.py) - DOCKER (default: 'False', type: str) (in files: env.py) - ENABLE_OTEL (default: 'False', type: str) (in files: env.py) - HF_HUB_OFFLINE (default: None) (in files: env.py) - MAX_BODY_LOG_SIZE (default: None) (in files: env.py) - OTEL_EXPORTER_OTLP_ENDPOINT (default: 'http://localhost:4317', type: str) (in files: env.py) - OTEL_RESOURCE_ATTRIBUTES (default: '', type: str) (in files: env.py) - OTEL_SERVICE_NAME (default: 'open-webui', type: str) (in files: env.py) - OTEL_TRACES_SAMPLER (default: 'parentbased_always_on', type: str) (in files: env.py) - TRUSTED_SIGNATURE_KEY (default: '', type: str) (in files: env.py) - WEBSOCKET_REDIS_LOCK_TIMEOUT (default: '60', type: str) (in files: env.py) ``` --- <sub>🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.</sub>
yindo added the pull-request label 2026-02-15 17:17:39 -05:00
yindo closed this issue 2026-02-15 17:17:39 -05:00
Sign in to join this conversation.
No Branch/Tag Specified
Branches Tags
Labels
Clear labels
bug
documentation
documentation
duplicate
enhancement
enhancement
good first issue
good first issue
good first issue
help wanted
pull-request
Mirrored from GitHub Pull Request
No Label pull-request
Milestone
No items
No Milestone
Projects
Clear projects
No project
Assignees
Clear assignees
yindo
No Assignees
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: open-webui/docs#560
Delete Branch "%!s()"

Deleting a branch is permanent. Although the deleted branch may continue to exist for a short time before it actually gets removed, it CANNOT be undone in most cases. Continue?