diff --git a/docs/contributing.mdx b/docs/contributing.mdx index d8d7392b..5e4111b7 100644 --- a/docs/contributing.mdx +++ b/docs/contributing.mdx @@ -29,7 +29,7 @@ Looking to contribute? Great! Here's how you can help: docker run -d -p 3000:8080 -v open-webui:/app/backend/data --name open-webui ghcr.io/open-webui/open-webui:dev ``` -**Keep it updated regularly** — the dev branch moves fast! If Docker doesn't work for you, the [Local Development Guide](/getting-started/advanced-topics/development) is another great option. +**Keep it updated regularly** — the dev branch moves fast! If Docker doesn't work for you, the [Local Development Guide](/getting-started/development) is another great option. By testing dev builds, you help us catch bugs before stable releases. Report issues on [GitHub](https://github.com/open-webui/open-webui/issues) with clear reproduction steps. **We cannot deliver high-quality releases without community testing.** diff --git a/docs/faq.mdx b/docs/faq.mdx index 81467d59..8d3ffde1 100644 --- a/docs/faq.mdx +++ b/docs/faq.mdx @@ -158,7 +158,7 @@ docker run -d -p 3000:8080 -e HF_ENDPOINT=https://hf-mirror.com/ --add-host=host ### Q: Why are my reasoning model's thinking blocks showing as raw text instead of being hidden? -**A:** This happens if the model's thinking tags are not recognized by Open WebUI. You can customize the tags in the model's Advanced Parameters. For more details, see the **[Reasoning & Thinking Models](/features/chat-features/reasoning-models)** guide. +**A:** This happens if the model's thinking tags are not recognized by Open WebUI. You can customize the tags in the model's Advanced Parameters. For more details, see the **[Reasoning & Thinking Models](/features/chat-conversations/chat-features/reasoning-models)** guide. ### Q: RAG with Open WebUI is very bad or not working at all. Why? @@ -193,7 +193,7 @@ def wait_for_processing(token, file_id): time.sleep(2) # Wait before checking again ``` -For complete workflow examples, see the **[API Endpoints documentation](/getting-started/api-endpoints#checking-file-processing-status)** and the **[RAG Troubleshooting guide](/troubleshooting/rag#9-api-file-upload-the-content-provided-is-empty-error)**. +For complete workflow examples, see the **[API Endpoints documentation](/reference/api-endpoints#checking-file-processing-status)** and the **[RAG Troubleshooting guide](/troubleshooting/rag#9-api-file-upload-the-content-provided-is-empty-error)**. ### Q: I asked the model what it is and it gave the wrong answer. Is Open WebUI routing to the wrong model? @@ -249,7 +249,7 @@ For more optimization tips, see the **[Performance Tips Guide](troubleshooting/p ### Q: Why doesn't Open WebUI natively support [Provider X]'s proprietary API? -**A:** Open WebUI is highly modular with a plugin system including tools, functions, and most notably **[pipes](/features/plugin/functions/pipe)**. These modular pipes allow you to add support for virtually any provider you want—you can build your own or choose from the many [community-built](https://openwebui.com/) and usually well-maintained ones already available. +**A:** Open WebUI is highly modular with a plugin system including tools, functions, and most notably **[pipes](/features/extensibility/plugin/functions/pipe)**. These modular pipes allow you to add support for virtually any provider you want—you can build your own or choose from the many [community-built](https://openwebui.com/) and usually well-maintained ones already available. That said, Open WebUI's core is built around **universal protocols**, not specific providers. Our stance is to support standard, widely-adopted APIs like the **OpenAI Chat Completions protocol**. diff --git a/docs/features/access-security/analytics/index.mdx b/docs/features/access-security/analytics/index.mdx index 076a6c44..1e9cfaac 100644 --- a/docs/features/access-security/analytics/index.mdx +++ b/docs/features/access-security/analytics/index.mdx @@ -1,5 +1,4 @@ ---- -slug: /features/analytics/ +--- sidebar_position: 1050 title: "Analytics" --- @@ -49,7 +48,7 @@ Your selected time period is **automatically saved** and persists across browser ### Group Filtering -If you have [user groups](/features/rbac/groups) configured, the Analytics dashboard allows filtering by group: +If you have [user groups](/features/access-security/rbac/groups) configured, the Analytics dashboard allows filtering by group: - Use the **group dropdown** next to the time period selector - Select a specific group to view analytics **only for users in that group** @@ -232,7 +231,7 @@ Example for GPT-4: - Compare **message counts** across models to see adoption rates - Check **token efficiency** (tokens per message) to identify verbose models - Monitor **trends** in the timeline chart after introducing new models -- Combine with the [Evaluation feature](/features/evaluation/) for quality insights +- Combine with the [Evaluation feature](/features/access-security/evaluation/) for quality insights ### 3. Cost Management @@ -403,6 +402,6 @@ Whether you're managing a personal instance or a large organizational deployment ## Related Features -- [**Evaluation**](/features/evaluation/) - Measure model quality through user feedback +- [**Evaluation**](/features/access-security/evaluation/) - Measure model quality through user feedback - [**RBAC**](../rbac/index.mdx) - Control access to models and features per user -- [**Data Controls**](/features/data-controls/) - Manage chat history and exports +- [**Data Controls**](/features/chat-conversations/data-controls/) - Manage chat history and exports diff --git a/docs/features/access-security/auth/ldap.mdx b/docs/features/access-security/auth/ldap.mdx index 592c3958..c0dbd407 100644 --- a/docs/features/access-security/auth/ldap.mdx +++ b/docs/features/access-security/auth/ldap.mdx @@ -1,5 +1,4 @@ ---- -slug: /features/auth/ldap +--- sidebar_position: 2 title: "LDAP Authentication" --- diff --git a/docs/features/access-security/auth/scim.mdx b/docs/features/access-security/auth/scim.mdx index c13d5191..293f1a1c 100644 --- a/docs/features/access-security/auth/scim.mdx +++ b/docs/features/access-security/auth/scim.mdx @@ -1,5 +1,4 @@ ---- -slug: /features/auth/scim +--- sidebar_position: 3 title: "SCIM 2.0" --- @@ -224,4 +223,4 @@ SCIM works best when combined with SSO (Single Sign-On). A typical setup include This ensures users are automatically created and can immediately authenticate using their corporate credentials. -For SSO configuration, see the [SSO documentation](https://docs.openwebui.com/features/auth/sso/). +For SSO configuration, see the [SSO documentation](https://docs.openwebui.com/features/access-security/auth/sso/). diff --git a/docs/features/access-security/auth/sso/index.mdx b/docs/features/access-security/auth/sso/index.mdx index ee667d3f..f8c7bf69 100644 --- a/docs/features/access-security/auth/sso/index.mdx +++ b/docs/features/access-security/auth/sso/index.mdx @@ -1,12 +1,11 @@ ---- -slug: /features/auth/sso/ +--- sidebar_position: 1 title: "SSO (OAuth, OIDC, Trusted Header)" --- :::info -For more information about all environment variables, check out the [environment variable docs page](https://docs.openwebui.com/getting-started/env-configuration/). +For more information about all environment variables, check out the [environment variable docs page](https://docs.openwebui.com/reference/env-configuration/). It is highly recommended to check the environment variable page, to get more details about how to set the variable and what values are expected. ::: @@ -22,7 +21,7 @@ Check out our [troubleshooting guide](https://docs.openwebui.com/troubleshooting Right now, you can only configure **one** OpenID Connect (OIDC) provider at a time via `OPENID_PROVIDER_URL`. You cannot have Microsoft **and** Google as OIDC providers simultaneously. -*However, there is a community workaround for using both! See our [Dual OAuth Tutorial](/tutorials/tips/dual-oauth-configuration) for more details.* +*However, there is a community workaround for using both! See our [Dual OAuth Tutorial](/tutorials/integrations/auth-identity/dual-oauth-configuration) for more details.* ::: ## OAuth Configuration Overview @@ -52,7 +51,7 @@ You cannot have Microsoft **and** Google as OIDC providers simultaneously. - Set `ENABLE_OAUTH_PERSISTENT_CONFIG=false` to always read from environment variables - Update settings through the Admin Panel instead of environment variables -3. **Required Variables**: Always verify you're using the exact variable names from the [environment configuration documentation](https://docs.openwebui.com/getting-started/env-configuration/). Common mistakes include using non-existent variables like `OIDC_CONFIG`. +3. **Required Variables**: Always verify you're using the exact variable names from the [environment configuration documentation](https://docs.openwebui.com/reference/env-configuration/). Common mistakes include using non-existent variables like `OIDC_CONFIG`. ::: @@ -69,7 +68,7 @@ To solve issues related to large tokens (e.g., with AD FS group claims exceeding This system is enabled by default but can be fine-tuned with the environment variables detailed above. -For more information, check out the [environment variable docs page](https://docs.openwebui.com/getting-started/env-configuration/). +For more information, check out the [environment variable docs page](https://docs.openwebui.com/reference/env-configuration/). ### OAuth Token Exchange for External Applications @@ -77,7 +76,7 @@ Open WebUI also supports **OAuth Token Exchange**, allowing external application **Example use case:** A CLI tool that has obtained an OAuth access token from your identity provider can exchange it for an Open WebUI token to make API calls to Open WebUI. -To enable this feature, set `ENABLE_OAUTH_TOKEN_EXCHANGE=true`. See the [`ENABLE_OAUTH_TOKEN_EXCHANGE`](/getting-started/env-configuration#enable_oauth_token_exchange) environment variable documentation for details on usage, request/response examples, and security considerations. +To enable this feature, set `ENABLE_OAUTH_TOKEN_EXCHANGE=true`. See the [`ENABLE_OAUTH_TOKEN_EXCHANGE`](/reference/env-configuration#enable_oauth_token_exchange) environment variable documentation for details on usage, request/response examples, and security considerations. ### Google @@ -175,7 +174,7 @@ The following environment variables are used: ::: :::tip Community Workaround: Multi-Provider OAuth -If you need to support both Microsoft and Google simultaneously, check out our **[Dual OAuth Configuration Tutorial](/tutorials/tips/dual-oauth-configuration)**. +If you need to support both Microsoft and Google simultaneously, check out our **[Dual OAuth Configuration Tutorial](/tutorials/integrations/auth-identity/dual-oauth-configuration)**. ::: ### OAuth Role Management diff --git a/docs/features/access-security/auth/sso/keycloak.mdx b/docs/features/access-security/auth/sso/keycloak.mdx index c7fcc866..a3d1e761 100644 --- a/docs/features/access-security/auth/sso/keycloak.mdx +++ b/docs/features/access-security/auth/sso/keycloak.mdx @@ -1,5 +1,4 @@ ---- -slug: /features/auth/sso/keycloak +--- title: "Keycloak" --- diff --git a/docs/features/access-security/evaluation/index.mdx b/docs/features/access-security/evaluation/index.mdx index 027cb1a6..88fcea23 100644 --- a/docs/features/access-security/evaluation/index.mdx +++ b/docs/features/access-security/evaluation/index.mdx @@ -1,5 +1,4 @@ ---- -slug: /features/evaluation/ +--- sidebar_position: 1100 title: "Evaluation" --- diff --git a/docs/features/access-security/interface/banners.md b/docs/features/access-security/interface/banners.md index 3a4f0f04..c6de17b8 100644 --- a/docs/features/access-security/interface/banners.md +++ b/docs/features/access-security/interface/banners.md @@ -1,5 +1,4 @@ ---- -slug: /features/interface/banners +--- sidebar_position: 13 title: "Customizable Banners" --- diff --git a/docs/features/access-security/interface/webhooks.md b/docs/features/access-security/interface/webhooks.md index 55323e6c..86c0a935 100644 --- a/docs/features/access-security/interface/webhooks.md +++ b/docs/features/access-security/interface/webhooks.md @@ -1,5 +1,4 @@ ---- -slug: /features/interface/webhooks +--- sidebar_position: 17 title: "Webhook Integrations" --- @@ -36,7 +35,7 @@ You can configure the admin webhook in two ways: #### Option 2: Through Environment Variables -You can also set the webhook URL using the `WEBHOOK_URL` environment variable. For more details, refer to the [Environment Variable Configuration](https://docs.openwebui.com/getting-started/env-configuration/#webhook_url) documentation. +You can also set the webhook URL using the `WEBHOOK_URL` environment variable. For more details, refer to the [Environment Variable Configuration](https://docs.openwebui.com/reference/env-configuration/#webhook_url) documentation. ### Payload Format diff --git a/docs/features/access-security/rbac/groups.md b/docs/features/access-security/rbac/groups.md index c0529f0a..b178f137 100644 --- a/docs/features/access-security/rbac/groups.md +++ b/docs/features/access-security/rbac/groups.md @@ -1,5 +1,4 @@ ---- -slug: /features/rbac/groups +--- sidebar_position: 3 title: "Groups" --- @@ -71,7 +70,7 @@ You can restrict access to specific objects (like a proprietary Model or sensiti 2. **Grant Access**: Select the specific **Groups** or **individual users** that should have "Read" or "Write" access. The redesigned access control UI makes it easy to add multiple groups or users at once. :::tip Knowledge Scoping for Models -Beyond visibility, knowledge access is also scoped by model configuration. When a model has **attached knowledge bases**, it can only access those specific KBs (not all user-accessible KBs). See [Knowledge Scoping with Native Function Calling](/features/workspace/knowledge#knowledge-scoping-with-native-function-calling) for details. +Beyond visibility, knowledge access is also scoped by model configuration. When a model has **attached knowledge bases**, it can only access those specific KBs (not all user-accessible KBs). See [Knowledge Scoping with Native Function Calling](/features/ai-knowledge/knowledge#knowledge-scoping-with-native-function-calling) for details. ::: ### Access Grant System diff --git a/docs/features/access-security/rbac/index.mdx b/docs/features/access-security/rbac/index.mdx index 7d64e33e..b06d7e41 100644 --- a/docs/features/access-security/rbac/index.mdx +++ b/docs/features/access-security/rbac/index.mdx @@ -1,5 +1,4 @@ ---- -slug: /features/rbac/ +--- sidebar_position: 100 title: "Role-Based Access Control (RBAC)" --- diff --git a/docs/features/access-security/rbac/permissions.md b/docs/features/access-security/rbac/permissions.md index 24a3abca..41d7cd93 100644 --- a/docs/features/access-security/rbac/permissions.md +++ b/docs/features/access-security/rbac/permissions.md @@ -1,5 +1,4 @@ ---- -slug: /features/rbac/permissions +--- sidebar_position: 3 title: "Permissions" --- @@ -149,4 +148,4 @@ While the UI is the recommended way to manage permissions, initial defaults can * `ENABLE_WEB_SEARCH=True` * `USER_PERMISSIONS_CHAT_FILE_UPLOAD=True` -See the [Environment Configuration](/getting-started/env-configuration) guide for a complete list of valid variables. +See the [Environment Configuration](/reference/env-configuration) guide for a complete list of valid variables. diff --git a/docs/features/access-security/rbac/roles.md b/docs/features/access-security/rbac/roles.md index a154941c..153844a4 100644 --- a/docs/features/access-security/rbac/roles.md +++ b/docs/features/access-security/rbac/roles.md @@ -1,5 +1,4 @@ ---- -slug: /features/rbac/roles +--- sidebar_position: 3 title: "Roles" --- @@ -159,5 +158,5 @@ spec: - **One-Time Operation**: This is a one-time operation on first startup. Subsequent restarts with the same environment variables will not modify the existing admin account. ::: -For complete documentation on these environment variables, see the [Environment Configuration Guide](/getting-started/env-configuration#webui_admin_email). +For complete documentation on these environment variables, see the [Environment Configuration Guide](/reference/env-configuration#webui_admin_email). diff --git a/docs/features/ai-knowledge/channels/index.md b/docs/features/ai-knowledge/channels/index.md index 597a2922..e287f892 100644 --- a/docs/features/ai-knowledge/channels/index.md +++ b/docs/features/ai-knowledge/channels/index.md @@ -1,5 +1,4 @@ ---- -slug: /features/channels/ +--- sidebar_position: 1000 title: "Channels" --- @@ -169,7 +168,7 @@ Channels support granular access control: ## Native Channel Awareness (Agentic) -When using a model with **Native Function Calling** enabled (see the [**Central Tool Calling Guide**](/features/plugin/tools#tool-calling-modes-default-vs-native)), models can navigate and search through your organization's channels autonomously. +When using a model with **Native Function Calling** enabled (see the [**Central Tool Calling Guide**](/features/extensibility/plugin/tools#tool-calling-modes-default-vs-native)), models can navigate and search through your organization's channels autonomously. ### Available Channel Tools: - **`search_channels`**: The model can find channels by name or description to identify where relevant discussions might be happening. diff --git a/docs/features/ai-knowledge/knowledge.md b/docs/features/ai-knowledge/knowledge.md index c9f4ab13..03e60d1d 100644 --- a/docs/features/ai-knowledge/knowledge.md +++ b/docs/features/ai-knowledge/knowledge.md @@ -1,5 +1,4 @@ ---- -slug: /features/workspace/knowledge +--- sidebar_position: 4 title: "Knowledge" --- @@ -114,7 +113,7 @@ The Knowledge Base tools require the **Knowledge Base** category to be enabled f ::: :::info Central Tool Documentation -For complete details on all built-in agentic tools and how to configure them, see the [**Native/Agentic Mode Tools Guide**](/features/plugin/tools#built-in-system-tools-nativeagentic-mode). +For complete details on all built-in agentic tools and how to configure them, see the [**Native/Agentic Mode Tools Guide**](/features/extensibility/plugin/tools#built-in-system-tools-nativeagentic-mode). ::: ### Setting Up Your Knowledge Base @@ -145,7 +144,7 @@ Key API endpoints: :::warning Important: Async File Processing When uploading files via API, processing happens asynchronously. You **must** wait for file processing to complete before adding files to a knowledge base, or you will receive an "empty content" error. -For detailed examples and proper workflow handling, see the [API Endpoints documentation](/getting-started/api-endpoints#-retrieval-augmented-generation-rag). +For detailed examples and proper workflow handling, see the [API Endpoints documentation](/reference/api-endpoints#-retrieval-augmented-generation-rag). ::: ## Summary diff --git a/docs/features/ai-knowledge/models.md b/docs/features/ai-knowledge/models.md index 2f44f059..bdee42d3 100644 --- a/docs/features/ai-knowledge/models.md +++ b/docs/features/ai-knowledge/models.md @@ -1,5 +1,4 @@ ---- -slug: /features/workspace/models +--- sidebar_position: 2 title: "Models" sidebar_label: "Models" @@ -73,22 +72,22 @@ Clicking **Show** on **Advanced Params** allows you to fine-tune the inference g You can transform a generic model into a specialized agent by toggling specific capabilities and binding resources. -- **Knowledge**: Instead of manually selecting documents for every chat, you can bind a specific knowledgebase **Collection** or **File** to this model. Whenever this model is selected, RAG (Retrieval Augmented Generation) is automatically active for those specific files. Click on attached items to toggle between **Focused Retrieval** (RAG chunks) and **Using Entire Document** (full content injection). See [Full Context vs Focused Retrieval](/features/workspace/knowledge#full-context-vs-focused-retrieval) for details. +- **Knowledge**: Instead of manually selecting documents for every chat, you can bind a specific knowledgebase **Collection** or **File** to this model. Whenever this model is selected, RAG (Retrieval Augmented Generation) is automatically active for those specific files. Click on attached items to toggle between **Focused Retrieval** (RAG chunks) and **Using Entire Document** (full content injection). See [Full Context vs Focused Retrieval](/features/ai-knowledge/knowledge#full-context-vs-focused-retrieval) for details. - **Tools**: Force specific tools to be enabled by default (e.g., always enable the **Calculator** tool for a "Math Bot"). -- **Skills**: Bind [Skills](/features/workspace/skills) to this model so their manifests are always injected. The model can load full skill instructions on-demand via the `view_skill` builtin tool. +- **Skills**: Bind [Skills](/features/ai-knowledge/skills) to this model so their manifests are always injected. The model can load full skill instructions on-demand via the `view_skill` builtin tool. - **Filters**: Attach specific Pipelines/Filters (e.g., a Profanity Filter or PII Redaction script) to run exclusively on this model. - **Actions**: Attach actionable scripts like `Add to Memories` or `Button` triggers. - **Capabilities**: Granularly control what the model is allowed to do: - **Vision**: Toggle to enable image analysis capabilities (requires a vision-capable Base Model). - **Web Search**: Enable the model to access the configured search provider (e.g., Google, SearxNG) for real-time information. - **File Upload**: Allow users to upload files to this model. - - **File Context**: When enabled (default), attached files are processed via RAG and their content is injected into the conversation. When disabled, file content is **not** extracted or injected—the model receives no file content unless it retrieves it via builtin tools. Only visible when File Upload is enabled. See [File Context vs Builtin Tools](/features/rag#file-context-vs-builtin-tools) for details. - - **Code Interpreter**: Enable Python code execution. See [Python Code Execution](/features/chat-features/code-execution/python) for details. + - **File Context**: When enabled (default), attached files are processed via RAG and their content is injected into the conversation. When disabled, file content is **not** extracted or injected—the model receives no file content unless it retrieves it via builtin tools. Only visible when File Upload is enabled. See [File Context vs Builtin Tools](/features/chat-conversations/rag#file-context-vs-builtin-tools) for details. + - **Code Interpreter**: Enable Python code execution. See [Python Code Execution](/features/chat-conversations/chat-features/code-execution/python) for details. - **Image Generation**: Enable image generation integration. - **Usage / Citations**: Toggle usage tracking or source citations. - **Status Updates**: Show visible progress steps in the chat UI (e.g., "Searching web...", "Reading file...") during generation. Useful for slower, complex tasks. - - **Builtin Tools**: When enabled (default), automatically injects system tools (timestamps, memory, chat history, knowledge base queries, notes, etc.) in [Native Function Calling mode](/features/plugin/tools#disabling-builtin-tools-per-model). When enabled, you can further control which **tool categories** are available (Time, Memory, Chats, Notes, Knowledge, Channels) via checkboxes in the Model Editor. Disable the main toggle if the model doesn't support function calling or you need to save context window tokens. Note: This is separate from **File Context**—see [File Context vs Builtin Tools](/features/rag#file-context-vs-builtin-tools) for the difference. -- **TTS Voice**: Set a specific Text-to-Speech voice for this model. When users read responses aloud, this voice will be used instead of the global default. Useful for giving different personas distinct voices. Leave empty to use the user's settings or system default. See [Per-Model TTS Voice](/features/audio/text-to-speech/openai-tts-integration#per-model-tts-voice) for details. + - **Builtin Tools**: When enabled (default), automatically injects system tools (timestamps, memory, chat history, knowledge base queries, notes, etc.) in [Native Function Calling mode](/features/extensibility/plugin/tools#disabling-builtin-tools-per-model). When enabled, you can further control which **tool categories** are available (Time, Memory, Chats, Notes, Knowledge, Channels) via checkboxes in the Model Editor. Disable the main toggle if the model doesn't support function calling or you need to save context window tokens. Note: This is separate from **File Context**—see [File Context vs Builtin Tools](/features/chat-conversations/rag#file-context-vs-builtin-tools) for the difference. +- **TTS Voice**: Set a specific Text-to-Speech voice for this model. When users read responses aloud, this voice will be used instead of the global default. Useful for giving different personas distinct voices. Leave empty to use the user's settings or system default. See [Per-Model TTS Voice](/features/media-generation/audio/text-to-speech/openai-tts-integration#per-model-tts-voice) for details. - **Default Features**: Force specific toggles (like Web Search) to be "On" immediately when a user starts a chat with this model. ## Model Management diff --git a/docs/features/ai-knowledge/notes.md b/docs/features/ai-knowledge/notes.md index e17b1511..1a8ea6ac 100644 --- a/docs/features/ai-knowledge/notes.md +++ b/docs/features/ai-knowledge/notes.md @@ -1,5 +1,4 @@ ---- -slug: /features/notes +--- sidebar_position: 1300 title: "Notes" --- @@ -102,7 +101,7 @@ Open WebUI provides several ways to export and manage your notes via the **More :::info Admin Visibility Notes are considered **workspace items**, just like models, knowledge, prompts, and tools. By default (`BYPASS_ADMIN_ACCESS_CONTROL=True`), administrators can see **all users' notes** under the "All" and "Shared with you" filters. -To prevent admins from seeing notes they were not explicitly shared with, set `BYPASS_ADMIN_ACCESS_CONTROL` to `False`. This also restricts admin access to other workspace items (models, knowledge, prompts, tools). See the [Environment Configuration](/getting-started/env-configuration#bypass_admin_access_control) for details. +To prevent admins from seeing notes they were not explicitly shared with, set `BYPASS_ADMIN_ACCESS_CONTROL` to `False`. This also restricts admin access to other workspace items (models, knowledge, prompts, tools). See the [Environment Configuration](/reference/env-configuration#bypass_admin_access_control) for details. ::: ### Download @@ -170,7 +169,7 @@ These can also be configured in **Admin Panel > Settings > Users > Default Permi ## Native Note Management (Agentic) -If you are using a model with **Native Function Calling** enabled (see the [**Central Tool Calling Guide**](/features/plugin/tools#tool-calling-modes-default-vs-native)), the AI can interact with your Notes workspace autonomously using built-in system tools. +If you are using a model with **Native Function Calling** enabled (see the [**Central Tool Calling Guide**](/features/extensibility/plugin/tools#tool-calling-modes-default-vs-native)), the AI can interact with your Notes workspace autonomously using built-in system tools. ### Available Note Tools: - **`search_notes`**: The model can search your entire library of notes by title and content. diff --git a/docs/features/ai-knowledge/prompts.md b/docs/features/ai-knowledge/prompts.md index 48c7cc26..7cfeb058 100644 --- a/docs/features/ai-knowledge/prompts.md +++ b/docs/features/ai-knowledge/prompts.md @@ -1,5 +1,4 @@ ---- -slug: /features/workspace/prompts +--- sidebar_position: 3 title: "Prompts" --- @@ -12,7 +11,7 @@ The Prompts interface provides several key features for managing your custom pro * **Create**: Design new prompts with customizable names, tags, access levels, and content. * **Share**: Share prompts with other users based on configured access permissions. -* **Access Control**: Set visibility and usage permissions for each prompt (refer to [Permissions](/features/rbac/permissions) for more details). +* **Access Control**: Set visibility and usage permissions for each prompt (refer to [Permissions](/features/access-security/rbac/permissions) for more details). * **Slash Commands**: Quickly access prompts using custom slash commands during chat sessions. * **Versioning & History**: Track every change with a full version history, allowing you to compare and revert to previous versions. * **Tags & Filtering**: Organize your prompts using tags and easily filter through your collection in the workspace. @@ -281,7 +280,7 @@ When editing an existing prompt, you will see a **History** sidebar (on desktop) Prompt management is controlled by the following permission settings: * **Prompts Access**: Users need the `USER_PERMISSIONS_WORKSPACE_PROMPTS_ACCESS` permission to create and manage prompts. -* For detailed information about configuring permissions, refer to the [Permissions documentation](/features/rbac/permissions). +* For detailed information about configuring permissions, refer to the [Permissions documentation](/features/access-security/rbac/permissions). ### Best Practices diff --git a/docs/features/ai-knowledge/skills.md b/docs/features/ai-knowledge/skills.md index a9cddc73..c69c4363 100644 --- a/docs/features/ai-knowledge/skills.md +++ b/docs/features/ai-knowledge/skills.md @@ -1,11 +1,10 @@ ---- -slug: /features/workspace/skills +--- sidebar_position: 6 title: "Skills" sidebar_label: "Skills" --- -Skills are reusable, markdown-based instruction sets that you can attach to models or invoke on-the-fly in chat. Unlike [Tools](/features/plugin/tools) (which are executable Python scripts), Skills are **plain-text instructions** that teach a model *how* to approach a task — such as code review guidelines, writing style rules, or troubleshooting playbooks. +Skills are reusable, markdown-based instruction sets that you can attach to models or invoke on-the-fly in chat. Unlike [Tools](/features/extensibility/plugin/tools) (which are executable Python scripts), Skills are **plain-text instructions** that teach a model *how* to approach a task — such as code review guidelines, writing style rules, or troubleshooting playbooks. ## How Skills Work @@ -89,7 +88,7 @@ Each skill has an **active/inactive toggle** visible on the list page. Inactive The backend you choose affects what your skills can do — from simple text transformations (Pyodide) to full OS-level shell access (Open Terminal). Each has different trade-offs in library support, isolation, persistence, and multi-user safety. -See the [Code Execution overview](/features/chat-features/code-execution) for a detailed comparison of all available backends and guidance on choosing the right one for your deployment. +See the [Code Execution overview](/features/chat-conversations/chat-features/code-execution) for a detailed comparison of all available backends and guidance on choosing the right one for your deployment. ### Setting Up Open Terminal @@ -97,11 +96,11 @@ Open Terminal is a FastAPI application that automatically exposes an [OpenAPI sp **1. Start an Open Terminal instance** -Follow the [Open Terminal setup guide](/features/open-terminal#getting-started) to launch an instance using Docker or pip. +Follow the [Open Terminal setup guide](/features/extensibility/open-terminal#getting-started) to launch an instance using Docker or pip. **2. Connect to Open WebUI** -Add your Open Terminal instance as a Tool Server by following the [OpenAPI Tool Server Integration Guide](/features/plugin/tools/openapi-servers/open-webui). You can connect it as: +Add your Open Terminal instance as a Tool Server by following the [OpenAPI Tool Server Integration Guide](/features/extensibility/plugin/tools/openapi-servers/open-webui). You can connect it as: - A **User Tool Server** (in **Settings → Tools**) — connects from your browser, ideal for personal or local instances - A **Global Tool Server** (in **Admin Settings → Tools**) — connects from the backend, available to all users @@ -109,14 +108,14 @@ Add your Open Terminal instance as a Tool Server by following the [OpenAPI Tool Once connected, the Open Terminal tools (execute, file upload, file download) appear automatically in the chat interface. :::tip -For the best experience, pair Open Terminal with a [Skill](/features/workspace/skills) that teaches the model how to use the tool effectively — for example, instructing it to always check exit codes, handle errors gracefully, and use streaming for long-running commands. +For the best experience, pair Open Terminal with a [Skill](/features/ai-knowledge/skills) that teaches the model how to use the tool effectively — for example, instructing it to always check exit codes, handle errors gracefully, and use streaming for long-running commands. ::: -See the [Open Terminal documentation](/features/open-terminal) for the full API reference and detailed setup instructions. +See the [Open Terminal documentation](/features/extensibility/open-terminal) for the full API reference and detailed setup instructions. ## Access Control -Skills use the same [Access Control](/features/rbac) system as other workspace resources: +Skills use the same [Access Control](/features/access-security/rbac) system as other workspace resources: - **Private by default**: Only the creator can see and edit a new skill. - **Share with users or groups**: Use the **Access** button in the skill editor to grant `read` or `write` access to specific users or groups. @@ -128,4 +127,4 @@ Skills use the same [Access Control](/features/rbac) system as other workspace r - **Sharing → Share Skills**: Required to share skills with individual users or groups. - **Sharing → Public Skills**: Required to make skills publicly accessible. -See [Permissions](/features/rbac/permissions) for details on how to configure these. +See [Permissions](/features/access-security/rbac/permissions) for details on how to configure these. diff --git a/docs/features/chat-conversations/chat-features/autocomplete.md b/docs/features/chat-conversations/chat-features/autocomplete.md index bed83da4..bcf1da52 100644 --- a/docs/features/chat-conversations/chat-features/autocomplete.md +++ b/docs/features/chat-conversations/chat-features/autocomplete.md @@ -1,5 +1,4 @@ ---- -slug: /features/chat-features/autocomplete +--- sidebar_position: 5 title: "Autocomplete" --- diff --git a/docs/features/chat-conversations/chat-features/chat-params.md b/docs/features/chat-conversations/chat-features/chat-params.md index 85409f3c..e0ce7b41 100644 --- a/docs/features/chat-conversations/chat-features/chat-params.md +++ b/docs/features/chat-conversations/chat-features/chat-params.md @@ -1,5 +1,4 @@ ---- -slug: /features/chat-features/chat-params +--- sidebar_position: 6 title: "Chat Parameters" --- diff --git a/docs/features/chat-conversations/chat-features/chatshare.md b/docs/features/chat-conversations/chat-features/chatshare.md index 57abc643..3ef42fdf 100644 --- a/docs/features/chat-conversations/chat-features/chatshare.md +++ b/docs/features/chat-conversations/chat-features/chatshare.md @@ -1,5 +1,4 @@ ---- -slug: /features/chat-features/chatshare +--- sidebar_position: 3 title: "Chat Sharing" --- @@ -116,4 +115,4 @@ Once deleted, the shared link will no longer be valid, and users will not be abl Open WebUI provides a centralized dashboard to manage every chat conversation you have shared. From there you can search through your shared history, re-copy links, or revoke access instantly. -For details on the management dashboard, see [Shared Chats Management](/features/data-controls/shared-chats). +For details on the management dashboard, see [Shared Chats Management](/features/chat-conversations/data-controls/shared-chats). diff --git a/docs/features/chat-conversations/chat-features/code-execution/artifacts.md b/docs/features/chat-conversations/chat-features/code-execution/artifacts.md index 758733d0..5d2bcd2f 100644 --- a/docs/features/chat-conversations/chat-features/code-execution/artifacts.md +++ b/docs/features/chat-conversations/chat-features/code-execution/artifacts.md @@ -1,5 +1,4 @@ ---- -slug: /features/chat-features/code-execution/artifacts +--- sidebar_position: 2 title: "Artifacts" --- diff --git a/docs/features/chat-conversations/chat-features/code-execution/index.md b/docs/features/chat-conversations/chat-features/code-execution/index.md index 641c266c..fffb88a6 100644 --- a/docs/features/chat-conversations/chat-features/code-execution/index.md +++ b/docs/features/chat-conversations/chat-features/code-execution/index.md @@ -1,5 +1,4 @@ ---- -slug: /features/chat-features/code-execution/ +--- sidebar_position: 1 title: "Code Execution" --- @@ -50,13 +49,13 @@ If you are running a multi-user or organizational deployment, **Jupyter is not r ### Open Terminal -[Open Terminal](/features/open-terminal) is a lightweight API for running shell commands remotely inside a Docker container. It provides full OS-level access — any language, any tool, any shell command — with container-level isolation. +[Open Terminal](/features/extensibility/open-terminal) is a lightweight API for running shell commands remotely inside a Docker container. It provides full OS-level access — any language, any tool, any shell command — with container-level isolation. - **Full shell access** — models can install packages, run scripts in any language, use system tools like ffmpeg, git, curl, etc. - **Container isolation** — runs in its own Docker container, separate from Open WebUI and other services. - **Rich pre-installed toolset** — the Docker image comes with Python 3.12, data science libraries, build tools, networking utilities, and more. -Open Terminal is connected to Open WebUI as an easy to connect [OpenAPI Tool Server](/features/plugin/tools/openapi-servers/open-webui), not as a built-in code execution engine. +Open Terminal is connected to Open WebUI as an easy to connect [OpenAPI Tool Server](/features/extensibility/plugin/tools/openapi-servers/open-webui), not as a built-in code execution engine. :::note Open Terminal currently operates as a **single shared instance** — there is no automatic per-user container provisioning yet. Each user connects to the same container unless separate instances are deployed manually. diff --git a/docs/features/chat-conversations/chat-features/code-execution/mermaid.md b/docs/features/chat-conversations/chat-features/code-execution/mermaid.md index b4dfa9c2..6f4de5d8 100644 --- a/docs/features/chat-conversations/chat-features/code-execution/mermaid.md +++ b/docs/features/chat-conversations/chat-features/code-execution/mermaid.md @@ -1,5 +1,4 @@ ---- -slug: /features/chat-features/code-execution/mermaid +--- sidebar_position: 4 title: "MermaidJS Rendering" --- diff --git a/docs/features/chat-conversations/chat-features/code-execution/python.md b/docs/features/chat-conversations/chat-features/code-execution/python.md index 4c521404..04e8d51f 100644 --- a/docs/features/chat-conversations/chat-features/code-execution/python.md +++ b/docs/features/chat-conversations/chat-features/code-execution/python.md @@ -1,5 +1,4 @@ ---- -slug: /features/chat-features/code-execution/python +--- sidebar_position: 3 title: "Python Code Execution" --- @@ -49,7 +48,7 @@ These settings can be configured at **Admin Panel → Settings → Code Executio | `CODE_INTERPRETER_PROMPT_TEMPLATE` | (built-in) | Custom prompt template for code interpreter | | `CODE_INTERPRETER_BLACKLISTED_MODULES` | `""` | Comma-separated list of blocked Python modules | -For Jupyter configuration, see the [Jupyter Notebook Integration](/tutorials/integrations/jupyter) tutorial. +For Jupyter configuration, see the [Jupyter Notebook Integration](/tutorials/integrations/dev-tools/jupyter) tutorial. ### Native Function Calling (Native Mode) @@ -63,7 +62,7 @@ When using **Native function calling mode** with a capable model (e.g., GPT-5, C 2. Model must have `code_interpreter` capability enabled 3. Model must use **Native** function calling mode (set in model's advanced params) -For more details on builtin tools and native mode, see the [Tool Development Guide](/features/plugin/tools#built-in-system-tools-nativeagentic-mode). +For more details on builtin tools and native mode, see the [Tool Development Guide](/features/extensibility/plugin/tools#built-in-system-tools-nativeagentic-mode). ## Displaying Images Inline (matplotlib, etc.) @@ -224,6 +223,6 @@ This is a known compatibility issue between Edge's enhanced security mode and We ## Further Reading - [Pyodide Documentation](https://pyodide.org/en/stable/) -- [Jupyter Notebook Integration](/tutorials/integrations/jupyter) -- [Environment Configuration](/getting-started/env-configuration) (search for `CODE_INTERPRETER`) +- [Jupyter Notebook Integration](/tutorials/integrations/dev-tools/jupyter) +- [Environment Configuration](/reference/env-configuration) (search for `CODE_INTERPRETER`) diff --git a/docs/features/chat-conversations/chat-features/conversation-organization.md b/docs/features/chat-conversations/chat-features/conversation-organization.md index 18849e81..ef19841f 100644 --- a/docs/features/chat-conversations/chat-features/conversation-organization.md +++ b/docs/features/chat-conversations/chat-features/conversation-organization.md @@ -1,5 +1,4 @@ ---- -slug: /features/chat-features/conversation-organization +--- sidebar_position: 4 title: "Folders & Projects" --- @@ -13,7 +12,7 @@ Open WebUI provides powerful folder-based organization that turns simple chat co Folders are enabled by default. Administrators can control this feature via: - **Admin Panel**: The folders feature is controlled globally alongside other features. -- **Environment Variable**: [`ENABLE_FOLDERS`](/getting-started/env-configuration#enable_folders) - Set to `True` (default) to enable or `False` to disable. +- **Environment Variable**: [`ENABLE_FOLDERS`](/reference/env-configuration#enable_folders) - Set to `True` (default) to enable or `False` to disable. ## Core Features @@ -126,5 +125,5 @@ If you frequently discuss topics like "marketing" or "development," tag conversa | Setting | Description | |---------|-------------| -| [`ENABLE_FOLDERS`](/getting-started/env-configuration#enable_folders) | Enable/disable the folders feature globally (Default: `True`) | -| [`USER_PERMISSIONS_FEATURES_FOLDERS`](/getting-started/env-configuration#user_permissions_features_folders) | Control user-level access to the folders feature (Default: `True`) | +| [`ENABLE_FOLDERS`](/reference/env-configuration#enable_folders) | Enable/disable the folders feature globally (Default: `True`) | +| [`USER_PERMISSIONS_FEATURES_FOLDERS`](/reference/env-configuration#user_permissions_features_folders) | Control user-level access to the folders feature (Default: `True`) | diff --git a/docs/features/chat-conversations/chat-features/follow-up-prompts.md b/docs/features/chat-conversations/chat-features/follow-up-prompts.md index d73b8476..d85f29cc 100644 --- a/docs/features/chat-conversations/chat-features/follow-up-prompts.md +++ b/docs/features/chat-conversations/chat-features/follow-up-prompts.md @@ -1,5 +1,4 @@ ---- -slug: /features/chat-features/follow-up-prompts +--- sidebar_position: 9 title: "Follow-Up Prompts" --- @@ -16,7 +15,7 @@ Configure follow-up prompt behavior in **Settings > Interface** under the **Chat **Default: On** -Automatically generates follow-up question suggestions after each response. These suggestions are generated by the [task model](/getting-started/env-configuration#task_model) based on the conversation context. +Automatically generates follow-up question suggestions after each response. These suggestions are generated by the [task model](/reference/env-configuration#task_model) based on the conversation context. - **On**: Follow-up prompts are generated after each model response - **Off**: No follow-up suggestions are generated diff --git a/docs/features/chat-conversations/chat-features/history-search.mdx b/docs/features/chat-conversations/chat-features/history-search.mdx index 1232f6e4..24a9a27a 100644 --- a/docs/features/chat-conversations/chat-features/history-search.mdx +++ b/docs/features/chat-conversations/chat-features/history-search.mdx @@ -1,5 +1,4 @@ ---- -slug: /features/chat-features/history-search +--- sidebar_position: 10 title: "History & Search" --- @@ -32,7 +31,7 @@ You can search through your conversations using the global search bar in the sid ## Native Conversation Search (Agentic) -When using a model with **Native Function Calling** enabled (see the [**Central Tool Calling Guide**](/features/plugin/tools#tool-calling-modes-default-vs-native)), models can search through your chat history autonomously. +When using a model with **Native Function Calling** enabled (see the [**Central Tool Calling Guide**](/features/extensibility/plugin/tools#tool-calling-modes-default-vs-native)), models can search through your chat history autonomously. ### Available History Tools: - **`search_chats`**: Simple text search across chat titles and message content. Returns matching chat IDs and snippets. diff --git a/docs/features/chat-conversations/chat-features/index.mdx b/docs/features/chat-conversations/chat-features/index.mdx index ab777262..77d62757 100644 --- a/docs/features/chat-conversations/chat-features/index.mdx +++ b/docs/features/chat-conversations/chat-features/index.mdx @@ -1,5 +1,4 @@ ---- -slug: /features/chat-features/ +--- sidebar_position: 1 title: "Chat Features" --- @@ -27,4 +26,4 @@ Open WebUI provides a comprehensive set of chat features designed to enhance you - **[🧠 Reasoning & Thinking Models](./reasoning-models.mdx)**: Specialized support for models that generate internal chains of thought using thinking tags. - **[💬 Follow-Up Prompts](./follow-up-prompts.md)**: Automatic generation of suggested follow-up questions after model responses. -- **Skill Mentions**: Use `$` in the chat input to mention and activate [Skills](/features/workspace/skills) on-the-fly, injecting their manifests into the conversation. +- **Skill Mentions**: Use `$` in the chat input to mention and activate [Skills](/features/ai-knowledge/skills) on-the-fly, injecting their manifests into the conversation. diff --git a/docs/features/chat-conversations/chat-features/message-queue.mdx b/docs/features/chat-conversations/chat-features/message-queue.mdx index 1616cc1f..93e9e356 100644 --- a/docs/features/chat-conversations/chat-features/message-queue.mdx +++ b/docs/features/chat-conversations/chat-features/message-queue.mdx @@ -1,5 +1,4 @@ ---- -slug: /features/chat-features/message-queue +--- sidebar_position: 10 title: "Message Queue" --- diff --git a/docs/features/chat-conversations/chat-features/multi-model-chats.mdx b/docs/features/chat-conversations/chat-features/multi-model-chats.mdx index 50875b5e..04d6d9e2 100644 --- a/docs/features/chat-conversations/chat-features/multi-model-chats.mdx +++ b/docs/features/chat-conversations/chat-features/multi-model-chats.mdx @@ -1,5 +1,4 @@ ---- -slug: /features/chat-features/multi-model-chats +--- sidebar_position: 2 title: "Multi-Model Chats" --- diff --git a/docs/features/chat-conversations/chat-features/reasoning-models.mdx b/docs/features/chat-conversations/chat-features/reasoning-models.mdx index 67fb3a68..2c9a6108 100644 --- a/docs/features/chat-conversations/chat-features/reasoning-models.mdx +++ b/docs/features/chat-conversations/chat-features/reasoning-models.mdx @@ -1,5 +1,4 @@ ---- -slug: /features/chat-features/reasoning-models +--- sidebar_position: 10 title: "Reasoning & Thinking Models" --- @@ -352,7 +351,7 @@ There is no standard way for storing reasoning content as part of the API payloa **Workarounds:** -1. **Use a Pipe Function**: Create a custom [pipe function](/features/pipelines/pipes) that converts Open WebUI's text-based thinking format to Anthropic's structured thinking blocks before sending requests to the Anthropic API. +1. **Use a Pipe Function**: Create a custom [pipe function](/features/extensibility/pipelines/pipes) that converts Open WebUI's text-based thinking format to Anthropic's structured thinking blocks before sending requests to the Anthropic API. 2. **Disable Extended Thinking**: If you don't need extended thinking for tool-calling workflows, disable it to avoid the format mismatch. diff --git a/docs/features/chat-conversations/chat-features/temporal-awareness.mdx b/docs/features/chat-conversations/chat-features/temporal-awareness.mdx index e04976ce..9c84effb 100644 --- a/docs/features/chat-conversations/chat-features/temporal-awareness.mdx +++ b/docs/features/chat-conversations/chat-features/temporal-awareness.mdx @@ -1,5 +1,4 @@ ---- -slug: /features/chat-features/temporal-awareness +--- sidebar_position: 11 title: "Temporal Awareness" --- @@ -15,13 +14,13 @@ By default, Open WebUI injects temporal variables into the model's environment v - **`CURRENT_TIME`**: Injected as HH:MM. - **`CURRENT_WEEKDAY`**: (e.g., Monday, Tuesday). -These variables can be manually used in [**Prompts**](/features/workspace/prompts) or [**Model Files**](/features/workspace/models) using the `{{CURRENT_DATE}}` syntax. +These variables can be manually used in [**Prompts**](/features/ai-knowledge/prompts) or [**Model Files**](/features/ai-knowledge/models) using the `{{CURRENT_DATE}}` syntax. --- ## Native Temporal Tools (Agentic) -When using a model with **Native Function Calling** enabled (see the [**Central Tool Calling Guide**](/features/plugin/tools#tool-calling-modes-default-vs-native)), models gain granular control over time calculations and queries. +When using a model with **Native Function Calling** enabled (see the [**Central Tool Calling Guide**](/features/extensibility/plugin/tools#tool-calling-modes-default-vs-native)), models gain granular control over time calculations and queries. ### Available Time Tools: - **`get_current_timestamp`**: The model can retrieve the exact current Unix timestamp (UTC) and ISO date string. diff --git a/docs/features/chat-conversations/chat-features/url-params.md b/docs/features/chat-conversations/chat-features/url-params.md index 3a7c26c0..e5c86e5e 100644 --- a/docs/features/chat-conversations/chat-features/url-params.md +++ b/docs/features/chat-conversations/chat-features/url-params.md @@ -1,5 +1,4 @@ ---- -slug: /features/chat-features/url-params +--- sidebar_position: 7 title: "URL Parameters" --- @@ -26,7 +25,7 @@ The following table lists the available URL parameters, their function, and exam ### 1. **Models and Model Selection** -- **Description**: The `models` and `model` parameters allow you to specify which [language models](/features/workspace/models) should be used for a particular chat session. +- **Description**: The `models` and `model` parameters allow you to specify which [language models](/features/ai-knowledge/models) should be used for a particular chat session. - **How to Set**: You can use either `models` for multiple models or `model` for a single model. - **Example**: - `/?models=model1,model2` – This initializes the chat with `model1` and `model2`. @@ -55,7 +54,7 @@ The following table lists the available URL parameters, their function, and exam ### 5. **Tool Selection** -- **Description**: The `tools` or `tool-ids` parameters specify which [tools](/features/plugin/tools) to activate within the chat. +- **Description**: The `tools` or `tool-ids` parameters specify which [tools](/features/extensibility/plugin/tools) to activate within the chat. - **How to Set**: Provide a comma-separated list of tool IDs as the parameter’s value. - **Example**: `/?tools=tool1,tool2` or `/?tool-ids=tool1,tool2` - **Behavior**: Each tool ID is matched and activated within the session for user interaction. diff --git a/docs/features/chat-conversations/data-controls/archived-chats.md b/docs/features/chat-conversations/data-controls/archived-chats.md index 8c6c25a3..1af64bed 100644 --- a/docs/features/chat-conversations/data-controls/archived-chats.md +++ b/docs/features/chat-conversations/data-controls/archived-chats.md @@ -1,5 +1,4 @@ ---- -slug: /features/data-controls/archived-chats +--- sidebar_position: 3 title: "📦 Archived Chats" --- diff --git a/docs/features/chat-conversations/data-controls/files.md b/docs/features/chat-conversations/data-controls/files.md index 1311e0ef..b5ecbf6b 100644 --- a/docs/features/chat-conversations/data-controls/files.md +++ b/docs/features/chat-conversations/data-controls/files.md @@ -1,5 +1,4 @@ ---- -slug: /features/data-controls/files +--- sidebar_position: 5 title: "📁 File Management" --- diff --git a/docs/features/chat-conversations/data-controls/import-export.md b/docs/features/chat-conversations/data-controls/import-export.md index f93f9d21..30f4063c 100644 --- a/docs/features/chat-conversations/data-controls/import-export.md +++ b/docs/features/chat-conversations/data-controls/import-export.md @@ -1,5 +1,4 @@ ---- -slug: /features/data-controls/import-export +--- sidebar_position: 4 title: "💾 Import & Export" --- diff --git a/docs/features/chat-conversations/data-controls/index.mdx b/docs/features/chat-conversations/data-controls/index.mdx index c2b6b469..ab737fb5 100644 --- a/docs/features/chat-conversations/data-controls/index.mdx +++ b/docs/features/chat-conversations/data-controls/index.mdx @@ -1,5 +1,4 @@ ---- -slug: /features/data-controls/ +--- sidebar_position: 15 title: "Data Controls" --- diff --git a/docs/features/chat-conversations/data-controls/shared-chats.md b/docs/features/chat-conversations/data-controls/shared-chats.md index ab62083b..ce911fae 100644 --- a/docs/features/chat-conversations/data-controls/shared-chats.md +++ b/docs/features/chat-conversations/data-controls/shared-chats.md @@ -1,5 +1,4 @@ ---- -slug: /features/data-controls/shared-chats +--- sidebar_position: 2 title: "🔗 Shared Chats" --- @@ -7,7 +6,7 @@ title: "🔗 Shared Chats" Open WebUI provides a centralized dashboard to manage every chat conversation you have shared. This feature allows users to audit their shared content and quickly revoke access if needed. :::info -This page documents the **management dashboard** for shared chats. For information on how to share chats, see [Chat Sharing](/features/chat-features/chatshare). +This page documents the **management dashboard** for shared chats. For information on how to share chats, see [Chat Sharing](/features/chat-conversations/chat-features/chatshare). ::: ## Accessing the Management Dashboard @@ -39,7 +38,7 @@ The **Shared Chats** modal provides a unified interface for your public content: **A:** No. Unsharing only deletes the public link. Your original chat history remains completely intact. **Q: Can I manage chats I've shared on the community platform here?** -**A:** No. This dashboard manages links generated on your local instance. For community-shared content, see [Deleting Shared Chats](/features/chat-features/chatshare#deleting-shared-chats). +**A:** No. This dashboard manages links generated on your local instance. For community-shared content, see [Deleting Shared Chats](/features/chat-conversations/chat-features/chatshare#deleting-shared-chats). **Q: If I delete my original chat, what happens to the shared link?** **A:** Deleting a chat also immediately invalidates and deletes any associated share links. diff --git a/docs/features/chat-conversations/direct-connections.mdx b/docs/features/chat-conversations/direct-connections.mdx index 2b8be63f..91c2ee71 100644 --- a/docs/features/chat-conversations/direct-connections.mdx +++ b/docs/features/chat-conversations/direct-connections.mdx @@ -1,5 +1,4 @@ ---- -slug: /features/experimental/direct-connections +--- sidebar_position: 1510 title: "Direct Connections" --- diff --git a/docs/features/chat-conversations/memory.mdx b/docs/features/chat-conversations/memory.mdx index dbf43d69..296f35a8 100644 --- a/docs/features/chat-conversations/memory.mdx +++ b/docs/features/chat-conversations/memory.mdx @@ -1,5 +1,4 @@ ---- -slug: /features/memory +--- sidebar_position: 700 title: "Memory & Personalization" --- @@ -24,7 +23,7 @@ Users can manually add, edit, or delete memories by navigating to: ### 2. Native Memory Tools (Agentic Mode) -When using a model with **Native Function Calling (Agentic Mode)** enabled, quality models can manage your memory autonomously using three built-in tools. For a detailed breakdown of how administrators can configure and manage these system-level tools, see the [**Central Tool Calling Guide**](/features/plugin/tools#tool-calling-modes-default-vs-native). +When using a model with **Native Function Calling (Agentic Mode)** enabled, quality models can manage your memory autonomously using three built-in tools. For a detailed breakdown of how administrators can configure and manage these system-level tools, see the [**Central Tool Calling Guide**](/features/extensibility/plugin/tools#tool-calling-modes-default-vs-native). :::tip Quality Models for Memory Management Autonomous memory management works best with frontier models (GPT-5, Claude 4.5+, Gemini 3+) that can intelligently decide what facts are worth saving and when to recall relevant memories. Small local models may struggle with appropriate memory selection. @@ -49,7 +48,7 @@ Autonomous memory management works best with frontier models (GPT-5, Claude 4.5+ 4. **Per-Model Category Toggle**: Ensure the **Memory** category is enabled for the model in **Workspace > Models > Edit > Builtin Tools** (enabled by default). :::info Central Tool Documentation -For complete details on all built-in agentic tools (including memory, web search, and knowledge bases) and how to configure them, see the [**Native/Agentic Mode Tools Guide**](/features/plugin/tools#built-in-system-tools-nativeagentic-mode). +For complete details on all built-in agentic tools (including memory, web search, and knowledge bases) and how to configure them, see the [**Native/Agentic Mode Tools Guide**](/features/extensibility/plugin/tools#built-in-system-tools-nativeagentic-mode). ::: ## Administrative Controls @@ -59,12 +58,12 @@ Administrators have full control over the Memory feature, including the ability ### Global Toggle The Memory feature can be toggled on or off for the entire instance. When disabled, the "Personalization" tab is hidden from all users, and the memory-related API endpoints are blocked. - **Admin UI**: Admin Panel > Settings > General > Features > **Memories** -- **Environment Variable**: [`ENABLE_MEMORIES`](/getting-started/env-configuration#enable_memories) (Default: `True`) +- **Environment Variable**: [`ENABLE_MEMORIES`](/reference/env-configuration#enable_memories) (Default: `True`) ### Granular Permissions Administrators can also control Memory access on a per-role or per-group basis from the Permissions interface. - **Admin UI**: Admin Panel > Users > Permissions > Features > **Memories** -- **Environment Variable**: [`USER_PERMISSIONS_FEATURES_MEMORIES`](/getting-started/env-configuration#user_permissions_features_memories) (Default: `True`) +- **Environment Variable**: [`USER_PERMISSIONS_FEATURES_MEMORIES`](/reference/env-configuration#user_permissions_features_memories) (Default: `True`) ## Privacy & Security diff --git a/docs/features/chat-conversations/rag/document-extraction/apachetika.md b/docs/features/chat-conversations/rag/document-extraction/apachetika.md index 57fde3a3..24039f74 100644 --- a/docs/features/chat-conversations/rag/document-extraction/apachetika.md +++ b/docs/features/chat-conversations/rag/document-extraction/apachetika.md @@ -1,5 +1,4 @@ ---- -slug: /features/rag/document-extraction/apachetika +--- sidebar_position: 2 title: "Apache Tika Extraction" --- diff --git a/docs/features/chat-conversations/rag/document-extraction/docling.md b/docs/features/chat-conversations/rag/document-extraction/docling.md index 26714d6b..014aa9a3 100644 --- a/docs/features/chat-conversations/rag/document-extraction/docling.md +++ b/docs/features/chat-conversations/rag/document-extraction/docling.md @@ -1,5 +1,4 @@ ---- -slug: /features/rag/document-extraction/docling +--- sidebar_position: 3 title: "Docling Document Extraction" --- diff --git a/docs/features/chat-conversations/rag/document-extraction/index.md b/docs/features/chat-conversations/rag/document-extraction/index.md index 7b528e46..74e5e15a 100644 --- a/docs/features/chat-conversations/rag/document-extraction/index.md +++ b/docs/features/chat-conversations/rag/document-extraction/index.md @@ -1,5 +1,4 @@ ---- -slug: /features/rag/document-extraction/ +--- sidebar_position: 1 title: "Document Extraction" --- diff --git a/docs/features/chat-conversations/rag/document-extraction/mistral-ocr.md b/docs/features/chat-conversations/rag/document-extraction/mistral-ocr.md index 1ed110f8..b5d5cdcf 100644 --- a/docs/features/chat-conversations/rag/document-extraction/mistral-ocr.md +++ b/docs/features/chat-conversations/rag/document-extraction/mistral-ocr.md @@ -1,5 +1,4 @@ ---- -slug: /features/rag/document-extraction/mistral-ocr +--- sidebar_position: 4 title: "Mistral OCR" --- diff --git a/docs/features/chat-conversations/rag/index.md b/docs/features/chat-conversations/rag/index.md index c10b6779..df17335e 100644 --- a/docs/features/chat-conversations/rag/index.md +++ b/docs/features/chat-conversations/rag/index.md @@ -1,5 +1,4 @@ ---- -slug: /features/rag/ +--- sidebar_position: 1 title: "Retrieval Augmented Generation (RAG)" --- @@ -19,7 +18,7 @@ One of the key advantages of RAG is its ability to access and integrate informat Local documents must first be uploaded via the Documents section of the Workspace area to access them using the `#` symbol before a query. Click on the formatted URL in the that appears above the chat box. Once selected, a document icon appears above `Send a message`, indicating successful retrieval. :::tip Bulk File Management -Need to clean up multiple uploaded documents or audit your storage? You can now use the centralized **[File Manager](/features/data-controls/files)** located in **Settings > Data Controls > Manage Files**. Deleting files there will automatically clean up their corresponding RAG embeddings. +Need to clean up multiple uploaded documents or audit your storage? You can now use the centralized **[File Manager](/features/chat-conversations/data-controls/files)** located in **Settings > Data Controls > Manage Files**. Deleting files there will automatically clean up their corresponding RAG embeddings. ::: You can also load documents into the workspace area with their access by starting a prompt with `#`, followed by a URL. This can help incorporate web content directly into your conversations. @@ -170,7 +169,7 @@ When File Context is disabled, file content is **not automatically extracted or ::: :::tip Per-File Retrieval Mode -Individual files and knowledge bases can also be set to bypass RAG entirely using the **"Using Entire Document"** toggle. This injects the full file content into every message regardless of native function calling settings. See [Full Context vs Focused Retrieval](/features/workspace/knowledge#full-context-vs-focused-retrieval) for details. +Individual files and knowledge bases can also be set to bypass RAG entirely using the **"Using Entire Document"** toggle. This injects the full file content into every message regardless of native function calling settings. See [Full Context vs Focused Retrieval](/features/ai-knowledge/knowledge#full-context-vs-focused-retrieval) for details. ::: :::info @@ -242,7 +241,7 @@ When using **Temporary Chat**, document processing is restricted to **frontend-o ## Google Drive Integration -When paired with a Google Cloud project that has the Google Picker API and Google Drive API enabled, this feature allows users to directly access their Drive files from the chat interface and upload documents, slides, sheets and more and uploads them as context to your chat. Can be enabled `Admin Panel` > `Settings` > `Documents` menu. Must set [`GOOGLE_DRIVE_API_KEY and GOOGLE_DRIVE_CLIENT_ID`](/getting-started/env-configuration) environment variables to use. +When paired with a Google Cloud project that has the Google Picker API and Google Drive API enabled, this feature allows users to directly access their Drive files from the chat interface and upload documents, slides, sheets and more and uploads them as context to your chat. Can be enabled `Admin Panel` > `Settings` > `Documents` menu. Must set [`GOOGLE_DRIVE_API_KEY and GOOGLE_DRIVE_CLIENT_ID`](/reference/env-configuration) environment variables to use. ### Detailed Instructions diff --git a/docs/features/chat-conversations/web-search/agentic-search.mdx b/docs/features/chat-conversations/web-search/agentic-search.mdx index b545283d..b5dd2ff2 100644 --- a/docs/features/chat-conversations/web-search/agentic-search.mdx +++ b/docs/features/chat-conversations/web-search/agentic-search.mdx @@ -1,5 +1,4 @@ ---- -slug: /features/web-search/agentic-search +--- sidebar_position: 1 title: "Agentic Search & URL Fetching" --- @@ -13,7 +12,7 @@ Agentic web search works best with frontier models like **GPT-5**, **Claude 4.5+ ::: :::info Central Tool Documentation -For comprehensive information about all built-in agentic tools (including web search, knowledge bases, memory, and more), see the [**Native/Agentic Mode Tools Guide**](/features/plugin/tools#built-in-system-tools-nativeagentic-mode). +For comprehensive information about all built-in agentic tools (including web search, knowledge bases, memory, and more), see the [**Native/Agentic Mode Tools Guide**](/features/extensibility/plugin/tools#built-in-system-tools-nativeagentic-mode). ::: ## Native Mode vs. Traditional RAG @@ -28,7 +27,7 @@ For comprehensive information about all built-in agentic tools (including web se ## How to Enable Agentic Behavior -To unlock these features, your model must support native tool calling and have strong reasoning capabilities (e.g., GPT-5, Claude 4.5 Sonnet, Gemini 3 Flash, MiniMax M2.5). Administrator-level configuration for these built-in system tools is handled via the [**Central Tool Calling Guide**](/features/plugin/tools#tool-calling-modes-default-vs-native). +To unlock these features, your model must support native tool calling and have strong reasoning capabilities (e.g., GPT-5, Claude 4.5 Sonnet, Gemini 3 Flash, MiniMax M2.5). Administrator-level configuration for these built-in system tools is handled via the [**Central Tool Calling Guide**](/features/extensibility/plugin/tools#tool-calling-modes-default-vs-native). 1. **Enable Web Search Globally**: Ensure a search engine is configured in **Admin Panel → Settings → Web Search**. 2. **Enable Model Capability**: In **Admin Panel → Settings → Models**, select your model and enable the **Web Search** capability. @@ -145,10 +144,10 @@ This cycle repeats autonomously until the model has comprehensive, verified info This iterative loop of **Thought → Action → Thought** continues until the model has sufficient information to answer your request with maximum accuracy. :::info Learn More About Interleaved Thinking -For more details on how Interleaved Thinking works across all agentic tools (not just web search), see the [**Interleaved Thinking Guide**](/features/plugin/tools#interleaved-thinking). +For more details on how Interleaved Thinking works across all agentic tools (not just web search), see the [**Interleaved Thinking Guide**](/features/extensibility/plugin/tools#interleaved-thinking). ::: ## Next Steps - **Save your findings**: Learn how to [save web search results directly to your Knowledge Base](./save-to-knowledge). -- **Troubleshoot**: If you encounter issues, check the [Web Search Troubleshooting Guide](../../troubleshooting/web-search). +- **Troubleshoot**: If you encounter issues, check the [Web Search Troubleshooting Guide](/troubleshooting/web-search). diff --git a/docs/features/chat-conversations/web-search/providers/bing.md b/docs/features/chat-conversations/web-search/providers/bing.md index b21638c7..a06ff5f8 100644 --- a/docs/features/chat-conversations/web-search/providers/bing.md +++ b/docs/features/chat-conversations/web-search/providers/bing.md @@ -1,5 +1,4 @@ ---- -slug: /features/web-search/bing +--- sidebar_position: 2 title: "Bing" --- @@ -12,13 +11,13 @@ This tutorial is a community contribution and is not supported by the Open WebUI :::tip -For a comprehensive list of all environment variables related to Web Search (including concurrency settings, result counts, and more), please refer to the [Environment Configuration documentation](../../getting-started/env-configuration#web-search). +For a comprehensive list of all environment variables related to Web Search (including concurrency settings, result counts, and more), please refer to the [Environment Configuration documentation](/reference/env-configuration#web-search). ::: :::tip Troubleshooting -Having issues with web search? Check out the [Web Search Troubleshooting Guide](../../troubleshooting/web-search) for solutions to common problems like proxy configuration, connection timeouts, and empty content. +Having issues with web search? Check out the [Web Search Troubleshooting Guide](/troubleshooting/web-search) for solutions to common problems like proxy configuration, connection timeouts, and empty content. ::: diff --git a/docs/features/chat-conversations/web-search/providers/brave.md b/docs/features/chat-conversations/web-search/providers/brave.md index 30218c3f..f19c440c 100644 --- a/docs/features/chat-conversations/web-search/providers/brave.md +++ b/docs/features/chat-conversations/web-search/providers/brave.md @@ -1,5 +1,4 @@ ---- -slug: /features/web-search/brave +--- sidebar_position: 3 title: "Brave" --- @@ -12,13 +11,13 @@ This tutorial is a community contribution and is not supported by the Open WebUI :::tip -For a comprehensive list of all environment variables related to Web Search (including concurrency settings, result counts, and more), please refer to the [Environment Configuration documentation](../../getting-started/env-configuration#web-search). +For a comprehensive list of all environment variables related to Web Search (including concurrency settings, result counts, and more), please refer to the [Environment Configuration documentation](/reference/env-configuration#web-search). ::: :::tip Troubleshooting -Having issues with web search? Check out the [Web Search Troubleshooting Guide](../../troubleshooting/web-search) for solutions to common problems like proxy configuration, connection timeouts, and empty content. +Having issues with web search? Check out the [Web Search Troubleshooting Guide](/troubleshooting/web-search) for solutions to common problems like proxy configuration, connection timeouts, and empty content. ::: diff --git a/docs/features/chat-conversations/web-search/providers/ddgs.mdx b/docs/features/chat-conversations/web-search/providers/ddgs.mdx index 1211a101..59fb73c9 100644 --- a/docs/features/chat-conversations/web-search/providers/ddgs.mdx +++ b/docs/features/chat-conversations/web-search/providers/ddgs.mdx @@ -1,5 +1,4 @@ ---- -slug: /features/web-search/ddgs +--- sidebar_position: 4 title: "DDGS" --- @@ -12,13 +11,13 @@ This tutorial is a community contribution and is not supported by the Open WebUI :::tip -For a comprehensive list of all environment variables related to Web Search (including concurrency settings, result counts, and more), please refer to the [Environment Configuration documentation](../../getting-started/env-configuration#web-search). +For a comprehensive list of all environment variables related to Web Search (including concurrency settings, result counts, and more), please refer to the [Environment Configuration documentation](/reference/env-configuration#web-search). ::: :::tip Troubleshooting -Having issues with web search? Check out the [Web Search Troubleshooting Guide](../../troubleshooting/web-search) for solutions to common problems like proxy configuration, connection timeouts, and empty content. +Having issues with web search? Check out the [Web Search Troubleshooting Guide](/troubleshooting/web-search) for solutions to common problems like proxy configuration, connection timeouts, and empty content. ::: diff --git a/docs/features/chat-conversations/web-search/providers/exa.md b/docs/features/chat-conversations/web-search/providers/exa.md index 35c533f6..65f02352 100644 --- a/docs/features/chat-conversations/web-search/providers/exa.md +++ b/docs/features/chat-conversations/web-search/providers/exa.md @@ -1,5 +1,4 @@ ---- -slug: /features/web-search/exa +--- sidebar_position: 5 title: "Exa AI" --- @@ -12,13 +11,13 @@ This tutorial is a community contribution and is not supported by the Open WebUI :::tip -For a comprehensive list of all environment variables related to Web Search (including concurrency settings, result counts, and more), please refer to the [Environment Configuration documentation](../../getting-started/env-configuration#web-search). +For a comprehensive list of all environment variables related to Web Search (including concurrency settings, result counts, and more), please refer to the [Environment Configuration documentation](/reference/env-configuration#web-search). ::: :::tip Troubleshooting -Having issues with web search? Check out the [Web Search Troubleshooting Guide](../../troubleshooting/web-search) for solutions to common problems like proxy configuration, connection timeouts, and empty content. +Having issues with web search? Check out the [Web Search Troubleshooting Guide](/troubleshooting/web-search) for solutions to common problems like proxy configuration, connection timeouts, and empty content. ::: diff --git a/docs/features/chat-conversations/web-search/providers/external.md b/docs/features/chat-conversations/web-search/providers/external.md index 3c2a7c99..24fe7aed 100644 --- a/docs/features/chat-conversations/web-search/providers/external.md +++ b/docs/features/chat-conversations/web-search/providers/external.md @@ -1,5 +1,4 @@ ---- -slug: /features/web-search/external +--- sidebar_position: 19 title: "External" --- @@ -12,13 +11,13 @@ This tutorial is a community contribution and is not supported by the Open WebUI :::tip -For a comprehensive list of all environment variables related to Web Search (including concurrency settings, result counts, and more), please refer to the [Environment Configuration documentation](../../getting-started/env-configuration#web-search). +For a comprehensive list of all environment variables related to Web Search (including concurrency settings, result counts, and more), please refer to the [Environment Configuration documentation](/reference/env-configuration#web-search). ::: :::tip Troubleshooting -Having issues with web search? Check out the [Web Search Troubleshooting Guide](../../troubleshooting/web-search) for solutions to common problems like proxy configuration, connection timeouts, and empty content. +Having issues with web search? Check out the [Web Search Troubleshooting Guide](/troubleshooting/web-search) for solutions to common problems like proxy configuration, connection timeouts, and empty content. ::: diff --git a/docs/features/chat-conversations/web-search/providers/google-pse.md b/docs/features/chat-conversations/web-search/providers/google-pse.md index 974714e7..e8500c61 100644 --- a/docs/features/chat-conversations/web-search/providers/google-pse.md +++ b/docs/features/chat-conversations/web-search/providers/google-pse.md @@ -1,5 +1,4 @@ ---- -slug: /features/web-search/google-pse +--- sidebar_position: 6 title: "Google PSE" --- @@ -18,13 +17,13 @@ This tutorial is a community contribution and is not supported by the Open WebUI :::tip -For a comprehensive list of all environment variables related to Web Search (including concurrency settings, result counts, and more), please refer to the [Environment Configuration documentation](../../getting-started/env-configuration#web-search). +For a comprehensive list of all environment variables related to Web Search (including concurrency settings, result counts, and more), please refer to the [Environment Configuration documentation](/reference/env-configuration#web-search). ::: :::tip Troubleshooting -Having issues with web search? Check out the [Web Search Troubleshooting Guide](../../troubleshooting/web-search) for solutions to common problems like proxy configuration, connection timeouts, and empty content. +Having issues with web search? Check out the [Web Search Troubleshooting Guide](/troubleshooting/web-search) for solutions to common problems like proxy configuration, connection timeouts, and empty content. ::: diff --git a/docs/features/chat-conversations/web-search/providers/jina.md b/docs/features/chat-conversations/web-search/providers/jina.md index 2458efe6..ed59ac6c 100644 --- a/docs/features/chat-conversations/web-search/providers/jina.md +++ b/docs/features/chat-conversations/web-search/providers/jina.md @@ -1,5 +1,4 @@ ---- -slug: /features/web-search/jina +--- sidebar_position: 7 title: "Jina" --- @@ -12,13 +11,13 @@ This tutorial is a community contribution and is not supported by the Open WebUI :::tip -For a comprehensive list of all environment variables related to Web Search (including concurrency settings, result counts, and more), please refer to the [Environment Configuration documentation](../../getting-started/env-configuration#web-search). +For a comprehensive list of all environment variables related to Web Search (including concurrency settings, result counts, and more), please refer to the [Environment Configuration documentation](/reference/env-configuration#web-search). ::: :::tip Troubleshooting -Having issues with web search? Check out the [Web Search Troubleshooting Guide](../../troubleshooting/web-search) for solutions to common problems like proxy configuration, connection timeouts, and empty content. +Having issues with web search? Check out the [Web Search Troubleshooting Guide](/troubleshooting/web-search) for solutions to common problems like proxy configuration, connection timeouts, and empty content. ::: diff --git a/docs/features/chat-conversations/web-search/providers/kagi.md b/docs/features/chat-conversations/web-search/providers/kagi.md index 002b114f..edc4491e 100644 --- a/docs/features/chat-conversations/web-search/providers/kagi.md +++ b/docs/features/chat-conversations/web-search/providers/kagi.md @@ -1,5 +1,4 @@ ---- -slug: /features/web-search/kagi +--- sidebar_position: 8 title: "Kagi" --- @@ -12,12 +11,12 @@ This tutorial is a community contribution and is not supported by the Open WebUI :::tip -For a comprehensive list of all environment variables related to Web Search (including concurrency settings, result counts, and more), please refer to the [Environment Configuration documentation](../../getting-started/env-configuration#web-search). +For a comprehensive list of all environment variables related to Web Search (including concurrency settings, result counts, and more), please refer to the [Environment Configuration documentation](/reference/env-configuration#web-search). ::: :::tip Troubleshooting -Having issues with web search? Check out the [Web Search Troubleshooting Guide](../../troubleshooting/web-search) for solutions to common problems like proxy configuration, connection timeouts, and empty content. +Having issues with web search? Check out the [Web Search Troubleshooting Guide](/troubleshooting/web-search) for solutions to common problems like proxy configuration, connection timeouts, and empty content. ::: diff --git a/docs/features/chat-conversations/web-search/providers/mojeek.md b/docs/features/chat-conversations/web-search/providers/mojeek.md index 7b973b3a..81f45be4 100644 --- a/docs/features/chat-conversations/web-search/providers/mojeek.md +++ b/docs/features/chat-conversations/web-search/providers/mojeek.md @@ -1,5 +1,4 @@ ---- -slug: /features/web-search/mojeek +--- sidebar_position: 9 title: "Mojeek" --- @@ -12,13 +11,13 @@ This tutorial is a community contribution and is not supported by the Open WebUI :::tip -For a comprehensive list of all environment variables related to Web Search (including concurrency settings, result counts, and more), please refer to the [Environment Configuration documentation](../../getting-started/env-configuration#web-search). +For a comprehensive list of all environment variables related to Web Search (including concurrency settings, result counts, and more), please refer to the [Environment Configuration documentation](/reference/env-configuration#web-search). ::: :::tip Troubleshooting -Having issues with web search? Check out the [Web Search Troubleshooting Guide](../../troubleshooting/web-search) for solutions to common problems like proxy configuration, connection timeouts, and empty content. +Having issues with web search? Check out the [Web Search Troubleshooting Guide](/troubleshooting/web-search) for solutions to common problems like proxy configuration, connection timeouts, and empty content. ::: diff --git a/docs/features/chat-conversations/web-search/providers/ollama-cloud.mdx b/docs/features/chat-conversations/web-search/providers/ollama-cloud.mdx index 92a16df3..73b56e56 100644 --- a/docs/features/chat-conversations/web-search/providers/ollama-cloud.mdx +++ b/docs/features/chat-conversations/web-search/providers/ollama-cloud.mdx @@ -1,5 +1,4 @@ ---- -slug: /features/web-search/ollama-cloud +--- sidebar_position: 10 title: "Ollama Cloud Web Search" --- @@ -12,12 +11,12 @@ This tutorial is a community contribution and is not supported by the Open WebUI :::tip -For a comprehensive list of all environment variables related to Web Search (including concurrency settings, result counts, and more), please refer to the [Environment Configuration documentation](../../getting-started/env-configuration#web-search). +For a comprehensive list of all environment variables related to Web Search (including concurrency settings, result counts, and more), please refer to the [Environment Configuration documentation](/reference/env-configuration#web-search). ::: :::tip Troubleshooting -Having issues with web search? Check out the [Web Search Troubleshooting Guide](../../troubleshooting/web-search) for solutions to common problems like proxy configuration, connection timeouts, and empty content. +Having issues with web search? Check out the [Web Search Troubleshooting Guide](/troubleshooting/web-search) for solutions to common problems like proxy configuration, connection timeouts, and empty content. ::: diff --git a/docs/features/chat-conversations/web-search/providers/perplexity.mdx b/docs/features/chat-conversations/web-search/providers/perplexity.mdx index 6ee6775c..f23e0042 100644 --- a/docs/features/chat-conversations/web-search/providers/perplexity.mdx +++ b/docs/features/chat-conversations/web-search/providers/perplexity.mdx @@ -1,5 +1,4 @@ ---- -slug: /features/web-search/perplexity +--- sidebar_position: 20 title: "Perplexity" --- @@ -12,13 +11,13 @@ This tutorial is a community contribution and is not supported by the Open WebUI :::tip -For a comprehensive list of all environment variables related to Web Search (including concurrency settings, result counts, and more), please refer to the [Environment Configuration documentation](../../getting-started/env-configuration#web-search). +For a comprehensive list of all environment variables related to Web Search (including concurrency settings, result counts, and more), please refer to the [Environment Configuration documentation](/reference/env-configuration#web-search). ::: :::tip Troubleshooting -Having issues with web search? Check out the [Web Search Troubleshooting Guide](../../troubleshooting/web-search) for solutions to common problems like proxy configuration, connection timeouts, and empty content. +Having issues with web search? Check out the [Web Search Troubleshooting Guide](/troubleshooting/web-search) for solutions to common problems like proxy configuration, connection timeouts, and empty content. ::: diff --git a/docs/features/chat-conversations/web-search/providers/perplexity_search.mdx b/docs/features/chat-conversations/web-search/providers/perplexity_search.mdx index e9cdc2d8..4c7bcd09 100644 --- a/docs/features/chat-conversations/web-search/providers/perplexity_search.mdx +++ b/docs/features/chat-conversations/web-search/providers/perplexity_search.mdx @@ -1,5 +1,4 @@ ---- -slug: /features/web-search/perplexity_search +--- sidebar_position: 21 title: "Perplexity Search" --- @@ -12,13 +11,13 @@ This tutorial is a community contribution and is not supported by the Open WebUI :::tip -For a comprehensive list of all environment variables related to Web Search (including concurrency settings, result counts, and more), please refer to the [Environment Configuration documentation](../../getting-started/env-configuration#web-search). +For a comprehensive list of all environment variables related to Web Search (including concurrency settings, result counts, and more), please refer to the [Environment Configuration documentation](/reference/env-configuration#web-search). ::: :::tip Troubleshooting -Having issues with web search? Check out the [Web Search Troubleshooting Guide](../../troubleshooting/web-search) for solutions to common problems like proxy configuration, connection timeouts, and empty content. +Having issues with web search? Check out the [Web Search Troubleshooting Guide](/troubleshooting/web-search) for solutions to common problems like proxy configuration, connection timeouts, and empty content. ::: diff --git a/docs/features/chat-conversations/web-search/providers/searchapi.md b/docs/features/chat-conversations/web-search/providers/searchapi.md index e782e2f2..fc0e9036 100644 --- a/docs/features/chat-conversations/web-search/providers/searchapi.md +++ b/docs/features/chat-conversations/web-search/providers/searchapi.md @@ -1,5 +1,4 @@ ---- -slug: /features/web-search/searchapi +--- sidebar_position: 11 title: "SearchApi" --- @@ -12,13 +11,13 @@ This tutorial is a community contribution and is not supported by the Open WebUI :::tip -For a comprehensive list of all environment variables related to Web Search (including concurrency settings, result counts, and more), please refer to the [Environment Configuration documentation](../../getting-started/env-configuration#web-search). +For a comprehensive list of all environment variables related to Web Search (including concurrency settings, result counts, and more), please refer to the [Environment Configuration documentation](/reference/env-configuration#web-search). ::: :::tip Troubleshooting -Having issues with web search? Check out the [Web Search Troubleshooting Guide](../../troubleshooting/web-search) for solutions to common problems like proxy configuration, connection timeouts, and empty content. +Having issues with web search? Check out the [Web Search Troubleshooting Guide](/troubleshooting/web-search) for solutions to common problems like proxy configuration, connection timeouts, and empty content. ::: diff --git a/docs/features/chat-conversations/web-search/providers/searxng.md b/docs/features/chat-conversations/web-search/providers/searxng.md index 116b2826..d2715c91 100644 --- a/docs/features/chat-conversations/web-search/providers/searxng.md +++ b/docs/features/chat-conversations/web-search/providers/searxng.md @@ -1,5 +1,4 @@ ---- -slug: /features/web-search/searxng +--- sidebar_position: 12 title: "SearXNG" --- @@ -12,7 +11,7 @@ This tutorial is a community contribution and is not supported by the Open WebUI :::tip -For a comprehensive list of all environment variables related to Web Search (including concurrency settings, result counts, and more), please refer to the [Environment Configuration documentation](../../getting-started/env-configuration#web-search). +For a comprehensive list of all environment variables related to Web Search (including concurrency settings, result counts, and more), please refer to the [Environment Configuration documentation](/reference/env-configuration#web-search). ::: @@ -348,7 +347,7 @@ docker exec -it open-webui curl http://host.docker.internal:8080/search?q=this+i :::tip Troubleshooting -Having issues with web search? Check out the [Web Search Troubleshooting Guide](../../troubleshooting/web-search) for solutions to common problems, including proxy configuration, connection timeouts, and empty content issues. +Having issues with web search? Check out the [Web Search Troubleshooting Guide](/troubleshooting/web-search) for solutions to common problems, including proxy configuration, connection timeouts, and empty content issues. ::: diff --git a/docs/features/chat-conversations/web-search/providers/serpapi.md b/docs/features/chat-conversations/web-search/providers/serpapi.md index 5b64c8e2..8faa346f 100644 --- a/docs/features/chat-conversations/web-search/providers/serpapi.md +++ b/docs/features/chat-conversations/web-search/providers/serpapi.md @@ -1,5 +1,4 @@ ---- -slug: /features/web-search/serpapi +--- sidebar_position: 13 title: "SerpApi" --- @@ -12,13 +11,13 @@ This tutorial is a community contribution and is not supported by the Open WebUI :::tip -For a comprehensive list of all environment variables related to Web Search (including concurrency settings, result counts, and more), please refer to the [Environment Configuration documentation](../../getting-started/env-configuration#web-search). +For a comprehensive list of all environment variables related to Web Search (including concurrency settings, result counts, and more), please refer to the [Environment Configuration documentation](/reference/env-configuration#web-search). ::: :::tip Troubleshooting -Having issues with web search? Check out the [Web Search Troubleshooting Guide](../../troubleshooting/web-search) for solutions to common problems like proxy configuration, connection timeouts, and empty content. +Having issues with web search? Check out the [Web Search Troubleshooting Guide](/troubleshooting/web-search) for solutions to common problems like proxy configuration, connection timeouts, and empty content. ::: diff --git a/docs/features/chat-conversations/web-search/providers/serper.md b/docs/features/chat-conversations/web-search/providers/serper.md index c9b3b243..b05cf6ca 100644 --- a/docs/features/chat-conversations/web-search/providers/serper.md +++ b/docs/features/chat-conversations/web-search/providers/serper.md @@ -1,5 +1,4 @@ ---- -slug: /features/web-search/serper +--- sidebar_position: 14 title: "Serper" --- @@ -12,12 +11,12 @@ This tutorial is a community contribution and is not supported by the Open WebUI :::tip -For a comprehensive list of all environment variables related to Web Search (including concurrency settings, result counts, and more), please refer to the [Environment Configuration documentation](../../getting-started/env-configuration#web-search). +For a comprehensive list of all environment variables related to Web Search (including concurrency settings, result counts, and more), please refer to the [Environment Configuration documentation](/reference/env-configuration#web-search). ::: :::tip Troubleshooting -Having issues with web search? Check out the [Web Search Troubleshooting Guide](../../troubleshooting/web-search) for solutions to common problems like proxy configuration, connection timeouts, and empty content. +Having issues with web search? Check out the [Web Search Troubleshooting Guide](/troubleshooting/web-search) for solutions to common problems like proxy configuration, connection timeouts, and empty content. ::: diff --git a/docs/features/chat-conversations/web-search/providers/serply.md b/docs/features/chat-conversations/web-search/providers/serply.md index 97b75abc..24548a18 100644 --- a/docs/features/chat-conversations/web-search/providers/serply.md +++ b/docs/features/chat-conversations/web-search/providers/serply.md @@ -1,5 +1,4 @@ ---- -slug: /features/web-search/serply +--- sidebar_position: 15 title: "Serply" --- @@ -12,12 +11,12 @@ This tutorial is a community contribution and is not supported by the Open WebUI :::tip -For a comprehensive list of all environment variables related to Web Search (including concurrency settings, result counts, and more), please refer to the [Environment Configuration documentation](../../getting-started/env-configuration#web-search). +For a comprehensive list of all environment variables related to Web Search (including concurrency settings, result counts, and more), please refer to the [Environment Configuration documentation](/reference/env-configuration#web-search). ::: :::tip Troubleshooting -Having issues with web search? Check out the [Web Search Troubleshooting Guide](../../troubleshooting/web-search) for solutions to common problems like proxy configuration, connection timeouts, and empty content. +Having issues with web search? Check out the [Web Search Troubleshooting Guide](/troubleshooting/web-search) for solutions to common problems like proxy configuration, connection timeouts, and empty content. ::: diff --git a/docs/features/chat-conversations/web-search/providers/serpstack.md b/docs/features/chat-conversations/web-search/providers/serpstack.md index cee32cfa..bbdc3a81 100644 --- a/docs/features/chat-conversations/web-search/providers/serpstack.md +++ b/docs/features/chat-conversations/web-search/providers/serpstack.md @@ -1,5 +1,4 @@ ---- -slug: /features/web-search/serpstack +--- sidebar_position: 16 title: "Serpstack" --- @@ -12,12 +11,12 @@ This tutorial is a community contribution and is not supported by the Open WebUI :::tip -For a comprehensive list of all environment variables related to Web Search (including concurrency settings, result counts, and more), please refer to the [Environment Configuration documentation](../../getting-started/env-configuration#web-search). +For a comprehensive list of all environment variables related to Web Search (including concurrency settings, result counts, and more), please refer to the [Environment Configuration documentation](/reference/env-configuration#web-search). ::: :::tip Troubleshooting -Having issues with web search? Check out the [Web Search Troubleshooting Guide](../../troubleshooting/web-search) for solutions to common problems like proxy configuration, connection timeouts, and empty content. +Having issues with web search? Check out the [Web Search Troubleshooting Guide](/troubleshooting/web-search) for solutions to common problems like proxy configuration, connection timeouts, and empty content. ::: diff --git a/docs/features/chat-conversations/web-search/providers/tavily.md b/docs/features/chat-conversations/web-search/providers/tavily.md index 1ec9d77e..68bce336 100644 --- a/docs/features/chat-conversations/web-search/providers/tavily.md +++ b/docs/features/chat-conversations/web-search/providers/tavily.md @@ -1,5 +1,4 @@ ---- -slug: /features/web-search/tavily +--- sidebar_position: 17 title: "Tavily" --- @@ -12,13 +11,13 @@ This tutorial is a community contribution and is not supported by the Open WebUI :::tip -For a comprehensive list of all environment variables related to Web Search (including concurrency settings, result counts, and more), please refer to the [Environment Configuration documentation](../../getting-started/env-configuration#web-search). +For a comprehensive list of all environment variables related to Web Search (including concurrency settings, result counts, and more), please refer to the [Environment Configuration documentation](/reference/env-configuration#web-search). ::: :::tip Troubleshooting -Having issues with web search? Check out the [Web Search Troubleshooting Guide](../../troubleshooting/web-search) for solutions to common problems like proxy configuration, connection timeouts, and empty content. +Having issues with web search? Check out the [Web Search Troubleshooting Guide](/troubleshooting/web-search) for solutions to common problems like proxy configuration, connection timeouts, and empty content. ::: @@ -79,7 +78,7 @@ Ensure you have: ``` See [Environment Variable Configuration](https://docs.openwebui.com/environment). -- **RAG Integration**: Combine Tavily results with local data using Retrieval Augmented Generation. Refer to [RAG Documentation](https://docs.openwebui.com/features/rag). +- **RAG Integration**: Combine Tavily results with local data using Retrieval Augmented Generation. Refer to [RAG Documentation](https://docs.openwebui.com/features/chat-conversations/rag). ## Troubleshooting diff --git a/docs/features/chat-conversations/web-search/providers/yacy.md b/docs/features/chat-conversations/web-search/providers/yacy.md index a3b42e71..7464a3b6 100644 --- a/docs/features/chat-conversations/web-search/providers/yacy.md +++ b/docs/features/chat-conversations/web-search/providers/yacy.md @@ -1,5 +1,4 @@ ---- -slug: /features/web-search/yacy +--- sidebar_position: 18 title: "Yacy" --- @@ -12,13 +11,13 @@ This tutorial is a community contribution and is not supported by the Open WebUI :::tip -For a comprehensive list of all environment variables related to Web Search (including concurrency settings, result counts, and more), please refer to the [Environment Configuration documentation](../../getting-started/env-configuration#web-search). +For a comprehensive list of all environment variables related to Web Search (including concurrency settings, result counts, and more), please refer to the [Environment Configuration documentation](/reference/env-configuration#web-search). ::: :::tip Troubleshooting -Having issues with web search? Check out the [Web Search Troubleshooting Guide](../../troubleshooting/web-search) for solutions to common problems like proxy configuration, connection timeouts, and empty content. +Having issues with web search? Check out the [Web Search Troubleshooting Guide](/troubleshooting/web-search) for solutions to common problems like proxy configuration, connection timeouts, and empty content. ::: diff --git a/docs/features/chat-conversations/web-search/providers/yandex.md b/docs/features/chat-conversations/web-search/providers/yandex.md index 1c7dcf68..3b0c81e4 100644 --- a/docs/features/chat-conversations/web-search/providers/yandex.md +++ b/docs/features/chat-conversations/web-search/providers/yandex.md @@ -1,5 +1,4 @@ ---- -slug: /features/web-search/yandex +--- sidebar_position: 14 title: "Yandex" --- @@ -12,13 +11,13 @@ This tutorial is a community contribution and is not supported by the Open WebUI :::tip -For a comprehensive list of all environment variables related to Web Search (including concurrency settings, result counts, and more), please refer to the [Environment Configuration documentation](../../getting-started/env-configuration#web-search). +For a comprehensive list of all environment variables related to Web Search (including concurrency settings, result counts, and more), please refer to the [Environment Configuration documentation](/reference/env-configuration#web-search). ::: :::tip Troubleshooting -Having issues with web search? Check out the [Web Search Troubleshooting Guide](../../troubleshooting/web-search) for solutions to common problems like proxy configuration, connection timeouts, and empty content. +Having issues with web search? Check out the [Web Search Troubleshooting Guide](/troubleshooting/web-search) for solutions to common problems like proxy configuration, connection timeouts, and empty content. ::: diff --git a/docs/features/chat-conversations/web-search/save-to-knowledge.mdx b/docs/features/chat-conversations/web-search/save-to-knowledge.mdx index ac0bd9a6..9319bdae 100644 --- a/docs/features/chat-conversations/web-search/save-to-knowledge.mdx +++ b/docs/features/chat-conversations/web-search/save-to-knowledge.mdx @@ -1,5 +1,4 @@ ---- -slug: /features/web-search/save-to-knowledge +--- sidebar_position: 10 title: "Save Search Results to Knowledge" --- diff --git a/docs/features/extensibility/mcp.mdx b/docs/features/extensibility/mcp.mdx index ecab12df..cdf542a8 100644 --- a/docs/features/extensibility/mcp.mdx +++ b/docs/features/extensibility/mcp.mdx @@ -1,5 +1,4 @@ ---- -slug: /features/mcp +--- title: Model Context Protocol (MCP) sidebar_position: 1200 --- @@ -48,7 +47,7 @@ Choose **OpenAPI** if you want: Choose **MCP (Streamable HTTP)** if you need: * A **common tool protocol** already used by your MCP servers/clients. -* **Streamed** protocol communication over HTTP (Note: This refers to MCP's transport-level streaming, not Open WebUI's [UI event system](/features/plugin/development/events) which is only available for native Python tools). +* **Streamed** protocol communication over HTTP (Note: This refers to MCP's transport-level streaming, not Open WebUI's [UI event system](/features/extensibility/plugin/development/events) which is only available for native Python tools). > You don’t have to pick one: many teams expose OpenAPI internally and **wrap MCP** at the edge for specific clients. diff --git a/docs/features/extensibility/open-terminal/index.md b/docs/features/extensibility/open-terminal/index.md index 643bace4..cf7130d9 100644 --- a/docs/features/extensibility/open-terminal/index.md +++ b/docs/features/extensibility/open-terminal/index.md @@ -1,5 +1,4 @@ ---- -slug: /features/open-terminal/ +--- sidebar_position: 5 title: "Open Terminal" --- @@ -14,7 +13,7 @@ This page is up-to-date with Open Terminal release version [v0.1.10](https://git ## Overview -[Open Terminal](https://github.com/open-webui/open-terminal) is a lightweight API for running shell commands remotely — with real-time streaming and secure access. When connected to Open WebUI as a [Tool](/features/plugin/tools), it gives models full shell access, file management, and the ability to execute arbitrary commands in an isolated environment. +[Open Terminal](https://github.com/open-webui/open-terminal) is a lightweight API for running shell commands remotely — with real-time streaming and secure access. When connected to Open WebUI as a [Tool](/features/extensibility/plugin/tools), it gives models full shell access, file management, and the ability to execute arbitrary commands in an isolated environment. Unlike Pyodide (browser-based, limited libraries) or Jupyter (shared environment, no per-user isolation), Open Terminal runs in its own Docker container with full OS-level capabilities. This makes it ideal for tasks that require: @@ -111,12 +110,12 @@ When no API key is provided, Open Terminal generates a random key using a crypto ## Connecting to Open WebUI -Open Terminal is a FastAPI application and automatically exposes an OpenAPI specification at `/openapi.json`. This means it works out of the box as an [OpenAPI Tool Server](/features/plugin/tools/openapi-servers/open-webui) — no manual tool creation required. +Open Terminal is a FastAPI application and automatically exposes an OpenAPI specification at `/openapi.json`. This means it works out of the box as an [OpenAPI Tool Server](/features/extensibility/plugin/tools/openapi-servers/open-webui) — no manual tool creation required. - **As a User Tool Server**: Add it in **Settings → Tools** to connect directly from your browser. Ideal for personal or local instances. - **As a Global Tool Server**: Add it in **Admin Settings → Tools** to make it available to all users across the deployment. -For step-by-step instructions with screenshots, see the [OpenAPI Tool Server Integration Guide](/features/plugin/tools/openapi-servers/open-webui). +For step-by-step instructions with screenshots, see the [OpenAPI Tool Server Integration Guide](/features/extensibility/plugin/tools/openapi-servers/open-webui). ## API Reference @@ -252,6 +251,6 @@ Returns service status. No authentication required. - [Open Terminal GitHub Repository](https://github.com/open-webui/open-terminal) - [Interactive API Documentation](http://localhost:8000/docs) (available when running locally) -- [Python Code Execution](/features/chat-features/code-execution/python) — Pyodide and Jupyter backends -- [Jupyter Integration Tutorial](/tutorials/integrations/jupyter) — Setting up Jupyter as a code execution backend -- [Skills](/features/workspace/skills) — Using skills with code execution +- [Python Code Execution](/features/chat-conversations/chat-features/code-execution/python) — Pyodide and Jupyter backends +- [Jupyter Integration Tutorial](/tutorials/integrations/dev-tools/jupyter) — Setting up Jupyter as a code execution backend +- [Skills](/features/ai-knowledge/skills) — Using skills with code execution diff --git a/docs/features/extensibility/pipelines/filters.md b/docs/features/extensibility/pipelines/filters.md index 8c42d876..24c197c0 100644 --- a/docs/features/extensibility/pipelines/filters.md +++ b/docs/features/extensibility/pipelines/filters.md @@ -1,5 +1,4 @@ ---- -slug: /features/pipelines/filters +--- sidebar_position: 2 title: "Filters" --- diff --git a/docs/features/extensibility/pipelines/index.mdx b/docs/features/extensibility/pipelines/index.mdx index aa330059..d27376ae 100644 --- a/docs/features/extensibility/pipelines/index.mdx +++ b/docs/features/extensibility/pipelines/index.mdx @@ -1,5 +1,4 @@ ---- -slug: /features/pipelines/ +--- sidebar_position: 1 title: "Pipelines" --- diff --git a/docs/features/extensibility/pipelines/pipes.md b/docs/features/extensibility/pipelines/pipes.md index ff504b43..849b297b 100644 --- a/docs/features/extensibility/pipelines/pipes.md +++ b/docs/features/extensibility/pipelines/pipes.md @@ -1,5 +1,4 @@ ---- -slug: /features/pipelines/pipes +--- sidebar_position: 3 title: "Pipes" --- diff --git a/docs/features/extensibility/pipelines/tutorials.md b/docs/features/extensibility/pipelines/tutorials.md index dd22cb20..9d7302b7 100644 --- a/docs/features/extensibility/pipelines/tutorials.md +++ b/docs/features/extensibility/pipelines/tutorials.md @@ -1,5 +1,4 @@ ---- -slug: /features/pipelines/tutorials +--- sidebar_position: 5 title: "Tutorials" --- diff --git a/docs/features/extensibility/pipelines/valves.md b/docs/features/extensibility/pipelines/valves.md index f8f8b6fe..6e333d3d 100644 --- a/docs/features/extensibility/pipelines/valves.md +++ b/docs/features/extensibility/pipelines/valves.md @@ -1,12 +1,11 @@ ---- -slug: /features/pipelines/valves +--- sidebar_position: 4 title: "Valves" --- ## Valves -`Valves` (see the dedicated [Valves & UserValves](/features/plugin/development/valves) page) can also be set for `Pipeline`. In short, `Valves` are input variables that are set per pipeline. +`Valves` (see the dedicated [Valves & UserValves](/features/extensibility/plugin/development/valves) page) can also be set for `Pipeline`. In short, `Valves` are input variables that are set per pipeline. `Valves` are set as a subclass of the `Pipeline` class, and initialized as part of the `__init__` method of the `Pipeline` class. diff --git a/docs/features/extensibility/plugin/development/events.mdx b/docs/features/extensibility/plugin/development/events.mdx index 920d1252..2fa22a6f 100644 --- a/docs/features/extensibility/plugin/development/events.mdx +++ b/docs/features/extensibility/plugin/development/events.mdx @@ -1,5 +1,4 @@ ---- -slug: /features/plugin/development/events +--- sidebar_position: 3 title: "Events" --- @@ -118,7 +117,7 @@ Below is a comprehensive table of **all supported `type` values** for events, al | `chat:message:files`,
`files` | Set or overwrite message files (for uploads, output) | `{files: [...]}` | | `chat:title` | Set (or update) the chat conversation title | Topic string OR `{title: ...}` | | `chat:tags` | Update the set of tags for a chat | Tag array or object | -| `source`,
`citation` | Add a source/citation, or code execution result | For code: See [below.](/features/plugin/development/events#source-or-citation-and-code-execution) | +| `source`,
`citation` | Add a source/citation, or code execution result | For code: See [below.](/features/extensibility/plugin/development/events#source-or-citation-and-code-execution) | | `notification` | Show a notification ("toast") in the UI | `{type: "info" or "success" or "error" or "warning", content: "..."}` | | `confirmation`
(needs `__event_call__`) | Ask for confirmation (OK/Cancel dialog) | `{title: "...", message: "..."}` | | `input`
(needs `__event_call__`) | Request simple user input ("input box" dialog) | `{title: "...", message: "...", placeholder: "...", value: ...}` | diff --git a/docs/features/extensibility/plugin/development/reserved-args.mdx b/docs/features/extensibility/plugin/development/reserved-args.mdx index 3f41aa20..b17068d6 100644 --- a/docs/features/extensibility/plugin/development/reserved-args.mdx +++ b/docs/features/extensibility/plugin/development/reserved-args.mdx @@ -1,5 +1,4 @@ ---- -slug: /features/plugin/development/reserved-args +--- sidebar_position: 999 title: "Reserved Arguments" --- @@ -329,7 +328,7 @@ Note that the same files dict can also be accessed via `__metadata__["files"]` ( ### `__request__` -An instance of `fastapi.Request`. You can read more in the [migration page](/features/plugin/migration/) or in [fastapi's documentation](https://fastapi.tiangolo.com/reference/request/). +An instance of `fastapi.Request`. You can read more in the [migration page](/features/extensibility/plugin/migration/) or in [fastapi's documentation](https://fastapi.tiangolo.com/reference/request/). ### `__task__` diff --git a/docs/features/extensibility/plugin/development/rich-ui.mdx b/docs/features/extensibility/plugin/development/rich-ui.mdx index e4d11f9f..719d6775 100644 --- a/docs/features/extensibility/plugin/development/rich-ui.mdx +++ b/docs/features/extensibility/plugin/development/rich-ui.mdx @@ -1,5 +1,4 @@ ---- -slug: /features/plugin/development/rich-ui +--- sidebar_position: 4 title: "Rich UI Embedding" --- diff --git a/docs/features/extensibility/plugin/development/valves.mdx b/docs/features/extensibility/plugin/development/valves.mdx index bb6d7919..22c3ccf1 100644 --- a/docs/features/extensibility/plugin/development/valves.mdx +++ b/docs/features/extensibility/plugin/development/valves.mdx @@ -1,5 +1,4 @@ ---- -slug: /features/plugin/development/valves +--- sidebar_position: 3 title: "Valves" --- diff --git a/docs/features/extensibility/plugin/functions/action.mdx b/docs/features/extensibility/plugin/functions/action.mdx index 15b3dfba..9d088be5 100644 --- a/docs/features/extensibility/plugin/functions/action.mdx +++ b/docs/features/extensibility/plugin/functions/action.mdx @@ -1,5 +1,4 @@ ---- -slug: /features/plugin/functions/action +--- sidebar_position: 2 title: "Action Function" --- @@ -65,7 +64,7 @@ Actions can utilize Open WebUI's real-time event system for interactive experien ### Event Emitter (`__event_emitter__`) -**For more information about Events and Event emitters, see [Events and Event Emitters](https://docs.openwebui.com/features/plugin/events/).** +**For more information about Events and Event emitters, see [Events and Event Emitters](https://docs.openwebui.com/features/extensibility/plugin/events/).** Send real-time updates to the frontend during action execution: @@ -317,6 +316,6 @@ Actions integrate seamlessly with other Open WebUI features: - **Files** - Actions can process uploaded files and generate new ones - **Memory** - Actions can access conversation history and context - **Permissions** - Actions respect user roles and access controls -- **[Rich UI Embedding](/features/plugin/development/rich-ui)** - Actions can return HTML content that renders as interactive iframes in the chat +- **[Rich UI Embedding](/features/extensibility/plugin/development/rich-ui)** - Actions can return HTML content that renders as interactive iframes in the chat For more examples and community-contributed actions, visit [https://openwebui.com/search](https://openwebui.com/search) where you can discover, download, and explore custom functions built by the Open WebUI community. diff --git a/docs/features/extensibility/plugin/functions/filter.mdx b/docs/features/extensibility/plugin/functions/filter.mdx index 72d66ce8..c1815e88 100644 --- a/docs/features/extensibility/plugin/functions/filter.mdx +++ b/docs/features/extensibility/plugin/functions/filter.mdx @@ -1,5 +1,4 @@ ---- -slug: /features/plugin/functions/filter +--- sidebar_position: 3 title: "Filter Function" --- diff --git a/docs/features/extensibility/plugin/functions/index.mdx b/docs/features/extensibility/plugin/functions/index.mdx index a3b9db56..f6548f42 100644 --- a/docs/features/extensibility/plugin/functions/index.mdx +++ b/docs/features/extensibility/plugin/functions/index.mdx @@ -1,5 +1,4 @@ ---- -slug: /features/plugin/functions/ +--- sidebar_position: 1 title: "Functions" --- diff --git a/docs/features/extensibility/plugin/functions/pipe.mdx b/docs/features/extensibility/plugin/functions/pipe.mdx index 06650ae8..52c573da 100644 --- a/docs/features/extensibility/plugin/functions/pipe.mdx +++ b/docs/features/extensibility/plugin/functions/pipe.mdx @@ -1,5 +1,4 @@ ---- -slug: /features/plugin/functions/pipe +--- sidebar_position: 4 title: "Pipe Function" --- diff --git a/docs/features/extensibility/plugin/index.mdx b/docs/features/extensibility/plugin/index.mdx index ab4aab86..20842e2d 100644 --- a/docs/features/extensibility/plugin/index.mdx +++ b/docs/features/extensibility/plugin/index.mdx @@ -1,5 +1,4 @@ ---- -slug: /features/plugin/ +--- sidebar_position: 300 title: "Tools & Functions (Plugins)" --- diff --git a/docs/features/extensibility/plugin/migration/index.mdx b/docs/features/extensibility/plugin/migration/index.mdx index 123ef40d..8602a54f 100644 --- a/docs/features/extensibility/plugin/migration/index.mdx +++ b/docs/features/extensibility/plugin/migration/index.mdx @@ -1,5 +1,4 @@ ---- -slug: /features/plugin/migration/ +--- sidebar_position: 9999 title: "Migrating Tools & Functions: 0.4 to 0.5" --- diff --git a/docs/features/extensibility/plugin/tools/development.mdx b/docs/features/extensibility/plugin/tools/development.mdx index a966fcfc..27bf55bc 100644 --- a/docs/features/extensibility/plugin/tools/development.mdx +++ b/docs/features/extensibility/plugin/tools/development.mdx @@ -1,5 +1,4 @@ ---- -slug: /features/plugin/tools/development +--- sidebar_position: 2 title: "Development" --- @@ -57,7 +56,7 @@ Each tool must have type hints for arguments. The types may also be nested, such ### Valves and UserValves - (optional, but HIGHLY encouraged) -Valves and UserValves are used for specifying customizable settings of the Tool, you can read more on the dedicated [Valves & UserValves page](/features/plugin/development/valves). +Valves and UserValves are used for specifying customizable settings of the Tool, you can read more on the dedicated [Valves & UserValves page](/features/extensibility/plugin/development/valves). ### Optional Arguments Below is a list of optional arguments your tools can depend on: @@ -70,7 +69,7 @@ Below is a list of optional arguments your tools can depend on: - `__model__`: A dictionary with model information - `__oauth_token__`: A dictionary containing the user's valid, automatically refreshed OAuth token payload. This is the **new, recommended, and secure** way to access user tokens for making authenticated API calls. The dictionary typically contains `access_token`, `id_token`, and other provider-specific data. -For more information about `__oauth_token__` and how to configure this token to be sent to tools, check out the OAuth section in the [environment variable docs page](https://docs.openwebui.com/getting-started/env-configuration/) and the [SSO documentation](https://docs.openwebui.com/features/auth/). +For more information about `__oauth_token__` and how to configure this token to be sent to tools, check out the OAuth section in the [environment variable docs page](https://docs.openwebui.com/reference/env-configuration/) and the [SSO documentation](https://docs.openwebui.com/features/auth/). Just add them as argument to any method of your Tool class just like `__user__` in the example above. @@ -131,7 +130,7 @@ Before using event emitters, you must understand these critical limitations: - **Native Mode (Agentic Mode)** (`function_calling = "native"`): **Limited event emitter support** - many event types don't work properly due to native function calling bypassing Open WebUI's custom tool processing pipeline **When to Use Each Mode:** -For a comprehensive guide on choosing a function calling mode, including model requirements and administrator setup, refer to the [**Central Tool Calling Guide**](/features/plugin/tools#tool-calling-modes-default-vs-native). +For a comprehensive guide on choosing a function calling mode, including model requirements and administrator setup, refer to the [**Central Tool Calling Guide**](/features/extensibility/plugin/tools#tool-calling-modes-default-vs-native). In general: - **Use Default Mode** when you need full event emitter functionality, complex tool interactions, or real-time UI updates. @@ -147,7 +146,7 @@ You can configure the function calling mode in two places: If the model seems to be unable to call the tool, make sure it is enabled (either via the Model page or via the `+` sign next to the chat input field). :::info Native Mode & Built-in Tools -When writing custom tools, be aware that Open WebUI also provides **built-in system tools** when Native Mode is enabled. For details on built-in tools, function calling modes, and model requirements, see the [**Tool Calling Modes Guide**](/features/plugin/tools#tool-calling-modes-default-vs-native). +When writing custom tools, be aware that Open WebUI also provides **built-in system tools** when Native Mode is enabled. For details on built-in tools, function calling modes, and model requirements, see the [**Tool Calling Modes Guide**](/features/extensibility/plugin/tools#tool-calling-modes-default-vs-native). ::: @@ -1499,7 +1498,7 @@ from typing import Optional, Callable, Awaitable ### Rich UI Element Embedding -Tools and Actions can return HTML content that renders as interactive iframes directly in the chat. For full documentation, examples, security considerations, and CORS configuration, see the dedicated **[Rich UI Embedding](/features/plugin/development/rich-ui)** guide. +Tools and Actions can return HTML content that renders as interactive iframes directly in the chat. For full documentation, examples, security considerations, and CORS configuration, see the dedicated **[Rich UI Embedding](/features/extensibility/plugin/development/rich-ui)** guide. ## External packages @@ -1514,7 +1513,7 @@ When multiple tools define different versions of the same package (e.g., Tool A **The only robust solution to this problem is to use an OpenAPI tool server.** -We strongly recommend using an [OpenAPI tool server](/features/plugin/tools/openapi-servers/) to avoid these dependency conflicts. +We strongly recommend using an [OpenAPI tool server](/features/extensibility/plugin/tools/openapi-servers/) to avoid these dependency conflicts. ::: diff --git a/docs/features/extensibility/plugin/tools/index.mdx b/docs/features/extensibility/plugin/tools/index.mdx index 1aa04c8e..a5aca6d5 100644 --- a/docs/features/extensibility/plugin/tools/index.mdx +++ b/docs/features/extensibility/plugin/tools/index.mdx @@ -1,5 +1,4 @@ ---- -slug: /features/plugin/tools/ +--- sidebar_position: 1 title: "Tools" --- @@ -283,7 +282,7 @@ For the full RAG pipeline with hybrid search and reranking, use the **File Conte 2. **Or disable Native Function Calling** for that model to restore automatic RAG injection. 3. **Or use "Full Context" mode** for attached knowledge (click on the attachment and select "Use Entire Document") which always injects the full content. -See [Knowledge Scoping with Native Function Calling](/features/workspace/knowledge#knowledge-scoping-with-native-function-calling) for more details. +See [Knowledge Scoping with Native Function Calling](/features/ai-knowledge/knowledge#knowledge-scoping-with-native-function-calling) for more details. ::: **Why use these?** It allows for **Deep Research** (searching the web multiple times, or querying knowledge bases), **Contextual Awareness** (looking up previous chats or notes), **Dynamic Personalization** (saving facts), and **Precise Automation** (generating content based on existing notes or documents). @@ -346,7 +345,7 @@ Enabling a per-model category toggle does **not** override global feature flags. - **File Context** = Whether Open WebUI extracts and injects file content (RAG processing) - **Builtin Tools** = Whether the model gets tools to autonomously search/retrieve additional content -See [File Context vs Builtin Tools](/features/rag#file-context-vs-builtin-tools) for a detailed comparison. +See [File Context vs Builtin Tools](/features/chat-conversations/rag#file-context-vs-builtin-tools) for a detailed comparison. ::: ### Interleaved Thinking {#interleaved-thinking} diff --git a/docs/features/extensibility/plugin/tools/openapi-servers/faq.mdx b/docs/features/extensibility/plugin/tools/openapi-servers/faq.mdx index 219c4a34..85e77a9f 100644 --- a/docs/features/extensibility/plugin/tools/openapi-servers/faq.mdx +++ b/docs/features/extensibility/plugin/tools/openapi-servers/faq.mdx @@ -1,5 +1,4 @@ ---- -slug: /features/plugin/tools/openapi-servers/faq +--- sidebar_position: 10 title: "FAQ" --- diff --git a/docs/features/extensibility/plugin/tools/openapi-servers/index.mdx b/docs/features/extensibility/plugin/tools/openapi-servers/index.mdx index 54bdca3b..8fb9a67f 100644 --- a/docs/features/extensibility/plugin/tools/openapi-servers/index.mdx +++ b/docs/features/extensibility/plugin/tools/openapi-servers/index.mdx @@ -1,5 +1,4 @@ ---- -slug: /features/plugin/tools/openapi-servers/ +--- sidebar_position: 400 title: "OpenAPI Tool Servers" --- @@ -30,10 +29,10 @@ By leveraging OpenAPI, we eliminate the need for a proprietary or unfamiliar com While OpenAPI tools are powerful for extending Open WebUI with external services, they have some constraints compared to native Python tools: -- **One-way events only**: OpenAPI tools can emit status updates, notifications, and other [one-way events](/features/plugin/development/events#-external-tool-events) via the REST endpoint. Open WebUI passes `X-Open-WebUI-Chat-Id` and `X-Open-WebUI-Message-Id` headers to enable this. However, interactive events (user input prompts, confirmations) are only available for native Python tools. +- **One-way events only**: OpenAPI tools can emit status updates, notifications, and other [one-way events](/features/extensibility/plugin/development/events#-external-tool-events) via the REST endpoint. Open WebUI passes `X-Open-WebUI-Chat-Id` and `X-Open-WebUI-Message-Id` headers to enable this. However, interactive events (user input prompts, confirmations) are only available for native Python tools. - **No streaming output**: Tool responses are returned as complete results, not streamed token-by-token. -If you need interactive UI feedback (confirmations, user input prompts), consider implementing your tool as a [native Python Tool](/features/plugin/tools/development) instead. +If you need interactive UI feedback (confirmations, user input prompts), consider implementing your tool as a [native Python Tool](/features/extensibility/plugin/tools/development) instead. ## 🚀 Quickstart diff --git a/docs/features/extensibility/plugin/tools/openapi-servers/mcp.mdx b/docs/features/extensibility/plugin/tools/openapi-servers/mcp.mdx index d0204dad..a388fafd 100644 --- a/docs/features/extensibility/plugin/tools/openapi-servers/mcp.mdx +++ b/docs/features/extensibility/plugin/tools/openapi-servers/mcp.mdx @@ -1,5 +1,4 @@ ---- -slug: /features/plugin/tools/openapi-servers/mcp +--- sidebar_position: 3 title: "MCP Support" --- @@ -47,7 +46,7 @@ So even though adding mcpo might at first seem like "just one more layer"—in r ✨ With mcpo, your local-only AI tools become cloud-ready, UI-friendly, and instantly interoperable—without changing a single line of tool server code. :::tip -**Events Supported**: While mcpo exposes MCP tools as OpenAPI endpoints, they can still emit events (status updates, notifications) via Open WebUI's [event REST endpoint](/features/plugin/development/events#-external-tool-events). Open WebUI automatically passes the required `X-Open-WebUI-Chat-Id` and `X-Open-WebUI-Message-Id` headers to your tool. However, interactive events requiring user input are only available for native Python tools. +**Events Supported**: While mcpo exposes MCP tools as OpenAPI endpoints, they can still emit events (status updates, notifications) via Open WebUI's [event REST endpoint](/features/extensibility/plugin/development/events#-external-tool-events). Open WebUI automatically passes the required `X-Open-WebUI-Chat-Id` and `X-Open-WebUI-Message-Id` headers to your tool. However, interactive events requiring user input are only available for native Python tools. ::: ### ✅ Quickstart: Running the Proxy Locally diff --git a/docs/features/extensibility/plugin/tools/openapi-servers/open-webui.mdx b/docs/features/extensibility/plugin/tools/openapi-servers/open-webui.mdx index 489ee77a..cc9861c1 100644 --- a/docs/features/extensibility/plugin/tools/openapi-servers/open-webui.mdx +++ b/docs/features/extensibility/plugin/tools/openapi-servers/open-webui.mdx @@ -1,5 +1,4 @@ ---- -slug: /features/plugin/tools/openapi-servers/open-webui +--- sidebar_position: 1 title: "Open WebUI Integration" --- diff --git a/docs/features/index.mdx b/docs/features/index.mdx index b7f44d14..54f7723b 100644 --- a/docs/features/index.mdx +++ b/docs/features/index.mdx @@ -15,13 +15,13 @@ import { TopBanners } from "@site/src/components/TopBanners"; - 🤝 **Universal API Compatibility**: Effortlessly integrate with any backend that follows the **OpenAI Chat Completions protocol**. This includes official OpenAI endpoints alongside dozens of third-party and local providers. The API URL can be customized to integrate Open WebUI seamlessly into your existing infrastructure. [See Setup Guide](/getting-started/quick-start). -- 🛡️ **Granular Permissions and User Groups**: By allowing administrators to create detailed user roles, user groups, and permissions across the workspace, we ensure a secure user environment for all users involved. This granularity not only enhances security, but also allows for customized user experiences, fostering a sense of ownership and responsibility amongst users. [Learn more about RBAC](/features/rbac). +- 🛡️ **Granular Permissions and User Groups**: By allowing administrators to create detailed user roles, user groups, and permissions across the workspace, we ensure a secure user environment for all users involved. This granularity not only enhances security, but also allows for customized user experiences, fostering a sense of ownership and responsibility amongst users. [Learn more about RBAC](/features/access-security/rbac). -- 🔐 **SCIM 2.0 Provisioning**: Enterprise-grade user and group provisioning through SCIM 2.0 protocol, enabling seamless integration with identity providers like Okta, Azure AD, and Google Workspace for automated user lifecycle management. [Read the SCIM Guide](/features/auth/scim). +- 🔐 **SCIM 2.0 Provisioning**: Enterprise-grade user and group provisioning through SCIM 2.0 protocol, enabling seamless integration with identity providers like Okta, Azure AD, and Google Workspace for automated user lifecycle management. [Read the SCIM Guide](/features/access-security/auth/scim). -- 📂 **Centralized File Management**: A unified dashboard to search, view, and manage all your uploaded documents in one place. Includes automated cleanup of Knowledge Base associations and vector embeddings when deleting files. [Learn about File Management](/features/data-controls/files). +- 📂 **Centralized File Management**: A unified dashboard to search, view, and manage all your uploaded documents in one place. Includes automated cleanup of Knowledge Base associations and vector embeddings when deleting files. [Learn about File Management](/features/chat-conversations/data-controls/files). -- 💬 **Shared Chat Management**: A centralized interface to audit every conversation you've ever shared. Easily search through your shared history, re-copy links, or revoke (unshare) access instantly from a single location. [Learn about Shared Chats](/features/data-controls/shared-chats). +- 💬 **Shared Chat Management**: A centralized interface to audit every conversation you've ever shared. Easily search through your shared history, re-copy links, or revoke (unshare) access instantly from a single location. [Learn about Shared Chats](/features/chat-conversations/data-controls/shared-chats). - 📱 **Responsive Design**: Enjoy a seamless experience across desktop PCs, laptops, and mobile devices. @@ -35,13 +35,13 @@ import { TopBanners } from "@site/src/components/TopBanners"; - ✒️🔢 **Full Markdown and LaTeX Support**: Elevate your LLM experience with comprehensive Markdown, LaTex, and Rich Text capabilities for enriched interaction. [Explore Interface Features](/category/interface). -- 🧩 **Model Builder**: Easily create custom models from base Ollama models directly from Open WebUI. Create and add custom characters and agents, customize model elements, and import models effortlessly through [Open WebUI Community](https://openwebui.com/) integration. [Learn more about Models](/features/workspace/models). +- 🧩 **Model Builder**: Easily create custom models from base Ollama models directly from Open WebUI. Create and add custom characters and agents, customize model elements, and import models effortlessly through [Open WebUI Community](https://openwebui.com/) integration. [Learn more about Models](/features/ai-knowledge/models). -- 📚 **Advanced RAG Integration with Multiple Vector Databases**: Dive into the future of chat interactions with cutting-edge Retrieval Augmented Generation (RAG) technology. Choose from 9 vector database options: ChromaDB (default), PostgreSQL with PGVector, Qdrant, Milvus, Elasticsearch, OpenSearch, Pinecone, S3Vector, and Oracle 23ai. Documents can be loaded into the `Documents` tab of the Workspace and accessed using the pound key [`#`] before a query, or by starting the prompt with [`#`] followed by a URL for webpage content integration. [Learn more about RAG](/features/rag). +- 📚 **Advanced RAG Integration with Multiple Vector Databases**: Dive into the future of chat interactions with cutting-edge Retrieval Augmented Generation (RAG) technology. Choose from 9 vector database options: ChromaDB (default), PostgreSQL with PGVector, Qdrant, Milvus, Elasticsearch, OpenSearch, Pinecone, S3Vector, and Oracle 23ai. Documents can be loaded into the `Documents` tab of the Workspace and accessed using the pound key [`#`] before a query, or by starting the prompt with [`#`] followed by a URL for webpage content integration. [Learn more about RAG](/features/chat-conversations/rag). -- 📄 **Advanced Document Extraction with Multiple Engines**: Extract text and data from various document formats including PDFs, Word documents, Excel spreadsheets, PowerPoint presentations, and more using your choice of extraction engines: Apache Tika, Docling, Azure Document Intelligence, Mistral OCR, or external custom (self-built) content extraction engines/document loaders. Advanced document processing capabilities enable seamless integration with your knowledge base, preserving structure and formatting while supporting OCR for scanned documents and images. [Read about Document Extraction](/features/rag/document-extraction). +- 📄 **Advanced Document Extraction with Multiple Engines**: Extract text and data from various document formats including PDFs, Word documents, Excel spreadsheets, PowerPoint presentations, and more using your choice of extraction engines: Apache Tika, Docling, Azure Document Intelligence, Mistral OCR, or external custom (self-built) content extraction engines/document loaders. Advanced document processing capabilities enable seamless integration with your knowledge base, preserving structure and formatting while supporting OCR for scanned documents and images. [Read about Document Extraction](/features/chat-conversations/rag/document-extraction). -- 🔍 **Web Search for RAG & Agentic Research**: Perform web searches using 15+ providers including SearXNG, Google PSE, Brave Search, Kagi, Mojeek, Bocha, Tavily, Perplexity, and more. When using **Native Function Calling**, models can perform multiple searches sequentially and use the `fetch_url` tool to read full page content for deep research. [Learn about Agentic Search](/features/web-search/agentic-search). +- 🔍 **Web Search for RAG & Agentic Research**: Perform web searches using 15+ providers including SearXNG, Google PSE, Brave Search, Kagi, Mojeek, Bocha, Tavily, Perplexity, and more. When using **Native Function Calling**, models can perform multiple searches sequentially and use the `fetch_url` tool to read full page content for deep research. [Learn about Agentic Search](/features/chat-conversations/web-search/agentic-search). - 🌐 **Web Browsing & URL Fetching**: Integrate websites by using the `#` command or allow the model to independently visit links using the `fetch_url` tool in Native Mode, extracting full text content for precise analysis. @@ -49,19 +49,19 @@ import { TopBanners } from "@site/src/components/TopBanners"; - ⚙️ **Concurrent Model Utilization**: Effortlessly engage with multiple models simultaneously, harnessing their unique strengths for optimal responses. Leverage a diverse set of model modalities in parallel to enhance your experience. -- 🔐 **Role-Based Access Control (RBAC)**: Ensure secure access with restricted permissions. Only authorized individuals can access your Ollama, while model creation and pulling rights are exclusively reserved for administrators. [Learn more about RBAC](/features/rbac). +- 🔐 **Role-Based Access Control (RBAC)**: Ensure secure access with restricted permissions. Only authorized individuals can access your Ollama, while model creation and pulling rights are exclusively reserved for administrators. [Learn more about RBAC](/features/access-security/rbac). - 🌐🌍 **Multilingual Support**: Experience Open WebUI in your preferred language with our internationalization (`i18n`) support. We invite you to join us in expanding our supported languages! We're actively seeking contributors! -- 💾 **Persistent Artifact Storage**: Built-in key-value storage API for artifacts, enabling features like journals, trackers, leaderboards, and collaborative tools with both personal and shared data scopes that persist across sessions. [Explore Chat Features](/features/chat-features). +- 💾 **Persistent Artifact Storage**: Built-in key-value storage API for artifacts, enabling features like journals, trackers, leaderboards, and collaborative tools with both personal and shared data scopes that persist across sessions. [Explore Chat Features](/features/chat-conversations/chat-features). -- ☁️ **Cloud Storage Integration**: Native support for cloud storage backends including Amazon S3 (with S3-compatible providers), Google Cloud Storage, and Microsoft Azure Blob Storage for scalable file storage and data management. [See Storage Config](/getting-started/env-configuration#cloud-storage). +- ☁️ **Cloud Storage Integration**: Native support for cloud storage backends including Amazon S3 (with S3-compatible providers), Google Cloud Storage, and Microsoft Azure Blob Storage for scalable file storage and data management. [See Storage Config](/reference/env-configuration#cloud-storage). -- ☁️ **Enterprise Cloud Integration**: Seamlessly import documents from Google Drive and OneDrive/SharePoint directly through the file picker interface, enabling smooth workflows with enterprise cloud storage solutions. [Learn more in Environment Config](/getting-started/env-configuration#onedrive) and check out the [SharePoint Guide](/tutorials/integrations/onedrive-sharepoint/). +- ☁️ **Enterprise Cloud Integration**: Seamlessly import documents from Google Drive and OneDrive/SharePoint directly through the file picker interface, enabling smooth workflows with enterprise cloud storage solutions. [Learn more in Environment Config](/reference/env-configuration#onedrive) and check out the [SharePoint Guide](/tutorials/integrations/onedrive-sharepoint/). -- 📊 **Production Observability with OpenTelemetry**: Built-in OpenTelemetry support for comprehensive monitoring with traces, metrics, and logs export to your existing observability stack (Prometheus, Grafana, Jaeger, etc.), enabling production-grade monitoring and debugging. [See Observability Config](/getting-started/env-configuration/#opentelemetry-configuration). +- 📊 **Production Observability with OpenTelemetry**: Built-in OpenTelemetry support for comprehensive monitoring with traces, metrics, and logs export to your existing observability stack (Prometheus, Grafana, Jaeger, etc.), enabling production-grade monitoring and debugging. [See Observability Config](/reference/env-configuration/#opentelemetry-configuration). -- 🔒 **Encrypted Database Support**: Optional at-rest encryption for SQLite databases using SQLCipher, providing enhanced security for sensitive data in smaller deployments without requiring PostgreSQL infrastructure. [See Database Encryption](/getting-started/env-configuration#encrypted-sqlite-with-sqlcipher). +- 🔒 **Encrypted Database Support**: Optional at-rest encryption for SQLite databases using SQLCipher, providing enhanced security for sensitive data in smaller deployments without requiring PostgreSQL infrastructure. [See Database Encryption](/reference/env-configuration#encrypted-sqlite-with-sqlcipher). - ⚖️ **Horizontal Scalability for Production**: Redis-backed session management and WebSocket support enabling multi-worker and multi-node deployments behind load balancers for high-availability production environments. [See Advanced Topics](/getting-started/advanced-topics) and our [Multi-Replica Guide](/troubleshooting/multi-replica). @@ -73,9 +73,9 @@ import { TopBanners } from "@site/src/components/TopBanners"; ### 🔧 Pipelines Support -- 🔧 **Pipelines Framework**: Seamlessly integrate and customize your Open WebUI experience with our modular plugin framework for enhanced customization and functionality (https://github.com/open-webui/pipelines). Our framework allows for the easy addition of custom logic and integration of Python libraries, from AI agents to home automation APIs. Perfect for plugin and tool development, as well as creating custom functions and filters. [Learn more about Pipelines](/features/pipelines). +- 🔧 **Pipelines Framework**: Seamlessly integrate and customize your Open WebUI experience with our modular plugin framework for enhanced customization and functionality (https://github.com/open-webui/pipelines). Our framework allows for the easy addition of custom logic and integration of Python libraries, from AI agents to home automation APIs. Perfect for plugin and tool development, as well as creating custom functions and filters. [Learn more about Pipelines](/features/extensibility/pipelines). -- �️ **Native Python Function Calling**: Access the power of Python directly within Open WebUI with native function calling. Easily integrate custom code to build unique features like custom RAG pipelines, web search tools, and even agent-like actions via a built-in code editor to seamlessly develop and integrate function code within the `Tools` and `Functions` workspace. [Learn more about Tools](/features/plugin/tools). +- �️ **Native Python Function Calling**: Access the power of Python directly within Open WebUI with native function calling. Easily integrate custom code to build unique features like custom RAG pipelines, web search tools, and even agent-like actions via a built-in code editor to seamlessly develop and integrate function code within the `Tools` and `Functions` workspace. [Learn more about Tools](/features/extensibility/plugin/tools). - �📥 **Upload Pipeline**: Pipelines can be uploaded directly from the `Admin Panel` > `Settings` > `Pipelines` menu, streamlining the pipeline management process. @@ -122,7 +122,7 @@ import { TopBanners } from "@site/src/components/TopBanners"; - 🖼️ **Custom Background Support**: Set a custom background from Settings > Interface to personalize your experience. -- 📝 **Rich Banners with Markdown**: Create visually engaging announcements with markdown support in banners, enabling richer and more dynamic content. [See Banners Documentation](/features/interface/banners). +- 📝 **Rich Banners with Markdown**: Create visually engaging announcements with markdown support in banners, enabling richer and more dynamic content. [See Banners Documentation](/features/access-security/interface/banners). - 💻 **Code Syntax Highlighting**: Our syntax highlighting feature enhances code readability, providing a clear and concise view of your code. @@ -168,11 +168,11 @@ import { TopBanners } from "@site/src/components/TopBanners"; - 🔔 **Chat Completion Notifications**: Stay updated with instant in-UI notifications when a chat finishes in a non-active tab, ensuring you never miss a completed response. -- 📝 **Message Queue**: Continue composing messages while the AI is generating a response. Your messages are queued and automatically sent together when the current response completes. Edit, delete, or send queued messages immediately. [Learn about Message Queue](/features/chat-features/message-queue). +- 📝 **Message Queue**: Continue composing messages while the AI is generating a response. Your messages are queued and automatically sent together when the current response completes. Edit, delete, or send queued messages immediately. [Learn about Message Queue](/features/chat-conversations/chat-features/message-queue). -- 🌐 **Notification Webhook Integration**: Receive timely updates for long-running chats or external integration needs with configurable webhook notifications, even when your tab is closed. [Learn more about Webhooks](/features/interface/webhooks). +- 🌐 **Notification Webhook Integration**: Receive timely updates for long-running chats or external integration needs with configurable webhook notifications, even when your tab is closed. [Learn more about Webhooks](/features/access-security/interface/webhooks). -- 📚 **Channels (Beta)**: Explore real-time collaboration between users and AIs with Discord/Slack-style chat rooms, build bots for channels, and unlock asynchronous communication for proactive multi-agent workflows. [See Channels](/features/channels). +- 📚 **Channels (Beta)**: Explore real-time collaboration between users and AIs with Discord/Slack-style chat rooms, build bots for channels, and unlock asynchronous communication for proactive multi-agent workflows. [See Channels](/features/ai-knowledge/channels). - 🖊️ **Typing Indicators in Channels**: Enhance collaboration with real-time typing indicators in channels, keeping everyone engaged and informed. @@ -238,7 +238,7 @@ import { TopBanners } from "@site/src/components/TopBanners"; - Please note that the `{{USER_LOCATION}}` prompt variable requires a secure connection over HTTPS. To utilize this particular prompt variable, please ensure that `{{USER_LOCATION}}` is toggled on from the `Settings` > `Interface` menu. - Please note that the `{{CLIPBOARD}}` prompt variables requires access to your device's clipboard. -- 🧠 **Memory Feature & Tools (Experimental)**: Manage information you want your LLMs to remember via `Settings` > `Personalization` > `Memory`. Capable models can now use `add_memory`, `search_memories`, and `replace_memory_content` tools to dynamically store, retrieve, and update facts about you during chat sessions. [Learn more about Memory](/features/memory). +- 🧠 **Memory Feature & Tools (Experimental)**: Manage information you want your LLMs to remember via `Settings` > `Personalization` > `Memory`. Capable models can now use `add_memory`, `search_memories`, and `replace_memory_content` tools to dynamically store, retrieve, and update facts about you during chat sessions. [Learn more about Memory](/features/chat-conversations/memory). --- @@ -288,7 +288,7 @@ import { TopBanners } from "@site/src/components/TopBanners"; ### 👥 Collaboration -- 🗨️ **Local Chat Sharing**: Generate and share chat links between users in an efficient and seamless manner. Includes a **centralized management interface** in Settings to view, copy links, or unshare conversations at any time. [Learn more about Chat Sharing](/features/chat-features/chatshare). +- 🗨️ **Local Chat Sharing**: Generate and share chat links between users in an efficient and seamless manner. Includes a **centralized management interface** in Settings to view, copy links, or unshare conversations at any time. [Learn more about Chat Sharing](/features/chat-conversations/chat-features/chatshare). - 👍👎 **RLHF Annotation**: Enhance the impact of your messages by rating them with either a thumbs up or thumbs down AMD provide a rating for the response on a scale of 1-10, followed by the option to provide textual feedback, facilitating the creation of datasets for Reinforcement Learning from Human Feedback (`RLHF`). Utilize your messages to train or fine-tune models, all while ensuring the confidentiality of locally saved data. @@ -301,7 +301,7 @@ import { TopBanners } from "@site/src/components/TopBanners"; - ⚔️ **Model Evaluation Arena**: Conduct blind A/B testing of models directly from the Admin Settings for a true side-by-side comparison, making it easier to find the best model for your needs. -- 🎯 **Topic-Based Rankings**: Discover more accurate rankings with our experimental topic-based re-ranking system, which adjusts leaderboard standings based on tag similarity in feedback. [Learn more about Evaluation](/features/evaluation). +- 🎯 **Topic-Based Rankings**: Discover more accurate rankings with our experimental topic-based re-ranking system, which adjusts leaderboard standings based on tag similarity in feedback. [Learn more about Evaluation](/features/access-security/evaluation). - 📂 **Unified and Collaborative Workspace** : Access and manage all your model files, prompts, documents, tools, and functions in one convenient location, while also enabling multiple users to collaborate and contribute to models, knowledge, prompts, or tools, streamlining your workflow and enhancing teamwork. @@ -428,17 +428,17 @@ import { TopBanners } from "@site/src/components/TopBanners"; - 👥 **Active Users Indicator**: Monitor the number of active users and which models are being utilized by whom to assist in gauging when performance may be impacted due to a high number of users. -- 📊 **Analytics Dashboard**: Comprehensive usage insights for administrators including message volume, token consumption, user activity, and model performance metrics with interactive time-series charts and detailed breakdowns. Track costs, identify trends, and make data-driven decisions about resource allocation. [Learn more about Analytics](/features/analytics). +- 📊 **Analytics Dashboard**: Comprehensive usage insights for administrators including message volume, token consumption, user activity, and model performance metrics with interactive time-series charts and detailed breakdowns. Track costs, identify trends, and make data-driven decisions about resource allocation. [Learn more about Analytics](/features/access-security/analytics). - 🔒 **Default Sign-Up Role**: Specify the default role for new sign-ups to `pending`, `user`, or `admin`, providing flexibility in managing user permissions and access levels for new users. -- 🤖 **Bulk Model Management & Filtering**: Administrators can effortlessly manage large model collections from external providers with tools to bulk enable/disable models and filter the admin list by status (Enabled, Disabled, Hidden, etc.) to maintain a clean workspace. [Learn about Admin Models](/features/workspace/models#global-model-management-admin). +- 🤖 **Bulk Model Management & Filtering**: Administrators can effortlessly manage large model collections from external providers with tools to bulk enable/disable models and filter the admin list by status (Enabled, Disabled, Hidden, etc.) to maintain a clean workspace. [Learn about Admin Models](/features/ai-knowledge/models#global-model-management-admin). - 🔒 **Prevent New Sign-Ups**: Enable the option to disable new user sign-ups, restricting access to the platform and maintaining a fixed number of users. - 🔒 **Prevent Chat Deletion**: Ability for admins to toggle a setting that prevents all users from deleting their chat messages, ensuring that all chat messages are retained for audit or compliance purposes. -- 🔗 **Webhook Integration**: Subscribe to new user sign-up events via webhook (compatible with `Discord`, `Google Chat`, `Slack` and `Microsoft Teams`), providing real-time notifications and automation capabilities. [See Webhook Guide](/features/interface/webhooks). +- 🔗 **Webhook Integration**: Subscribe to new user sign-up events via webhook (compatible with `Discord`, `Google Chat`, `Slack` and `Microsoft Teams`), providing real-time notifications and automation capabilities. [See Webhook Guide](/features/access-security/interface/webhooks). - 📣 **Configurable Notification Banners**: Admins can create customizable banners with persistence in config.json, featuring options for content, background color (`info`, `warning`, `error`, or `success`), and dismissibility. Banners are accessible only to logged-in users, ensuring the confidentiality of sensitive information. @@ -462,9 +462,9 @@ import { TopBanners } from "@site/src/components/TopBanners"; - 🔐 **Group-Based Access Control**: Set granular access to models, knowledge, prompts, and tools based on user groups, allowing for more controlled and secure environments. -- 🛠️ **Granular User Permissions**: Easily manage workspace permissions, including file uploads, deletions, edits, and temporary chats, as well as model, knowledge, prompt, and tool creation. [See User Permissions Config](/getting-started/env-configuration/#user-permissions). +- 🛠️ **Granular User Permissions**: Easily manage workspace permissions, including file uploads, deletions, edits, and temporary chats, as well as model, knowledge, prompt, and tool creation. [See User Permissions Config](/reference/env-configuration/#user-permissions). -- 🔑 **LDAP Authentication**: Enhance security and scalability with LDAP support for user management. [Learn more about LDAP](/features/auth/ldap). +- 🔑 **LDAP Authentication**: Enhance security and scalability with LDAP support for user management. [Learn more about LDAP](/features/access-security/auth/ldap). - 🔐 **SCIM 2.0 Provisioning**: Automate user and group lifecycle management through SCIM 2.0 protocol integration with identity providers like Okta, Azure AD, and Google Workspace, reducing administrative overhead and ensuring synchronized user management across systems. diff --git a/docs/features/media-generation/audio/speech-to-text/env-variables.md b/docs/features/media-generation/audio/speech-to-text/env-variables.md index 6bf21abd..d9efb9df 100644 --- a/docs/features/media-generation/audio/speech-to-text/env-variables.md +++ b/docs/features/media-generation/audio/speech-to-text/env-variables.md @@ -1,5 +1,4 @@ ---- -slug: /features/audio/speech-to-text/env-variables +--- sidebar_position: 2 title: "Environment Variables" --- @@ -8,7 +7,7 @@ title: "Environment Variables" :::info -For a complete list of all Open WebUI environment variables, see the [Environment Variable Configuration](https://docs.openwebui.com/getting-started/env-configuration) page. +For a complete list of all Open WebUI environment variables, see the [Environment Variable Configuration](https://docs.openwebui.com/reference/env-configuration) page. ::: diff --git a/docs/features/media-generation/audio/speech-to-text/mistral-voxtral-integration.md b/docs/features/media-generation/audio/speech-to-text/mistral-voxtral-integration.md index c1f653ac..f844d0ec 100644 --- a/docs/features/media-generation/audio/speech-to-text/mistral-voxtral-integration.md +++ b/docs/features/media-generation/audio/speech-to-text/mistral-voxtral-integration.md @@ -1,5 +1,4 @@ ---- -slug: /features/audio/speech-to-text/mistral-voxtral-integration +--- sidebar_position: 2 title: "Mistral Voxtral STT" --- diff --git a/docs/features/media-generation/audio/speech-to-text/openai-stt-integration.md b/docs/features/media-generation/audio/speech-to-text/openai-stt-integration.md index a41cfc19..ab1d59d8 100644 --- a/docs/features/media-generation/audio/speech-to-text/openai-stt-integration.md +++ b/docs/features/media-generation/audio/speech-to-text/openai-stt-integration.md @@ -1,5 +1,4 @@ ---- -slug: /features/audio/speech-to-text/openai-stt-integration +--- sidebar_position: 0 title: "OpenAI STT Integration" --- @@ -9,7 +8,7 @@ title: "OpenAI STT Integration" This guide covers how to use OpenAI's Whisper API for Speech-to-Text with Open WebUI. This provides cloud-based transcription without needing local GPU resources. :::tip Looking for TTS? -See the companion guide: [Using OpenAI for Text-to-Speech](/features/audio/text-to-speech/openai-tts-integration) +See the companion guide: [Using OpenAI for Text-to-Speech](/features/media-generation/audio/text-to-speech/openai-tts-integration) ::: ## Requirements diff --git a/docs/features/media-generation/audio/speech-to-text/stt-config.md b/docs/features/media-generation/audio/speech-to-text/stt-config.md index fc117d6a..67de9fa3 100644 --- a/docs/features/media-generation/audio/speech-to-text/stt-config.md +++ b/docs/features/media-generation/audio/speech-to-text/stt-config.md @@ -1,5 +1,4 @@ ---- -slug: /features/audio/speech-to-text/stt-config +--- sidebar_position: 1 title: "Configuration" --- @@ -16,9 +15,9 @@ The following speech-to-text providers are supported: | Service | API Key Required | Guide | |---------|------------------|-------| -| Local Whisper (default) | ❌ | Built-in, see [Environment Variables](/features/audio/speech-to-text/env-variables) | -| OpenAI (Whisper API) | ✅ | [OpenAI STT Guide](/features/audio/speech-to-text/openai-stt-integration) | -| Mistral (Voxtral) | ✅ | [Mistral Voxtral Guide](/features/audio/speech-to-text/mistral-voxtral-integration) | +| Local Whisper (default) | ❌ | Built-in, see [Environment Variables](/features/media-generation/audio/speech-to-text/env-variables) | +| OpenAI (Whisper API) | ✅ | [OpenAI STT Guide](/features/media-generation/audio/speech-to-text/openai-stt-integration) | +| Mistral (Voxtral) | ✅ | [Mistral Voxtral Guide](/features/media-generation/audio/speech-to-text/mistral-voxtral-integration) | | Deepgram | ✅ | — | | Azure | ✅ | — | diff --git a/docs/features/media-generation/audio/text-to-speech/Kokoro-FastAPI-integration.md b/docs/features/media-generation/audio/text-to-speech/Kokoro-FastAPI-integration.md index 94fabafa..248d2c94 100644 --- a/docs/features/media-generation/audio/text-to-speech/Kokoro-FastAPI-integration.md +++ b/docs/features/media-generation/audio/text-to-speech/Kokoro-FastAPI-integration.md @@ -1,5 +1,4 @@ ---- -slug: /features/audio/text-to-speech/Kokoro-FastAPI-integration +--- sidebar_position: 2 title: "Kokoro-FastAPI Using Docker" --- diff --git a/docs/features/media-generation/audio/text-to-speech/chatterbox-tts-api-integration.md b/docs/features/media-generation/audio/text-to-speech/chatterbox-tts-api-integration.md index 24e565ec..33ccc432 100644 --- a/docs/features/media-generation/audio/text-to-speech/chatterbox-tts-api-integration.md +++ b/docs/features/media-generation/audio/text-to-speech/chatterbox-tts-api-integration.md @@ -1,5 +1,4 @@ ---- -slug: /features/audio/text-to-speech/chatterbox-tts-api-integration +--- sidebar_position: 3 title: "Chatterbox TTS — Voice Cloning" --- @@ -245,7 +244,7 @@ Chatterbox has higher memory requirements than other TTS solutions: - **Recommended:** 8GB+ RAM - **GPU:** NVIDIA CUDA or Apple M-series (MPS) recommended -If you experience memory issues, consider using a lighter alternative like [OpenAI Edge TTS](/features/audio/text-to-speech/openai-edge-tts-integration) or [Kokoro-FastAPI](/features/audio/text-to-speech/Kokoro-FastAPI-integration). +If you experience memory issues, consider using a lighter alternative like [OpenAI Edge TTS](/features/media-generation/audio/text-to-speech/openai-edge-tts-integration) or [Kokoro-FastAPI](/features/media-generation/audio/text-to-speech/Kokoro-FastAPI-integration). ### Docker Networking diff --git a/docs/features/media-generation/audio/text-to-speech/kokoro-web-integration.md b/docs/features/media-generation/audio/text-to-speech/kokoro-web-integration.md index acda68dc..7c66f61b 100644 --- a/docs/features/media-generation/audio/text-to-speech/kokoro-web-integration.md +++ b/docs/features/media-generation/audio/text-to-speech/kokoro-web-integration.md @@ -1,5 +1,4 @@ ---- -slug: /features/audio/text-to-speech/kokoro-web-integration +--- sidebar_position: 2 title: "Kokoro Web - Effortless TTS for Open WebUI" --- diff --git a/docs/features/media-generation/audio/text-to-speech/openai-edge-tts-integration.md b/docs/features/media-generation/audio/text-to-speech/openai-edge-tts-integration.md index fea433d5..232a1993 100644 --- a/docs/features/media-generation/audio/text-to-speech/openai-edge-tts-integration.md +++ b/docs/features/media-generation/audio/text-to-speech/openai-edge-tts-integration.md @@ -1,5 +1,4 @@ ---- -slug: /features/audio/text-to-speech/openai-edge-tts-integration +--- sidebar_position: 1 title: "Edge TTS Using Docker" --- diff --git a/docs/features/media-generation/audio/text-to-speech/openai-tts-integration.md b/docs/features/media-generation/audio/text-to-speech/openai-tts-integration.md index a86d879e..0a4450d0 100644 --- a/docs/features/media-generation/audio/text-to-speech/openai-tts-integration.md +++ b/docs/features/media-generation/audio/text-to-speech/openai-tts-integration.md @@ -1,5 +1,4 @@ ---- -slug: /features/audio/text-to-speech/openai-tts-integration +--- sidebar_position: 0 title: "OpenAI TTS Integration" --- @@ -9,7 +8,7 @@ title: "OpenAI TTS Integration" This guide covers how to use OpenAI's official Text-to-Speech API with Open WebUI. This is the simplest setup if you already have an OpenAI API key. :::tip Looking for STT? -See the companion guide: [Using OpenAI for Speech-to-Text](/features/audio/speech-to-text/openai-stt-integration) +See the companion guide: [Using OpenAI for Speech-to-Text](/features/media-generation/audio/speech-to-text/openai-stt-integration) ::: ## Requirements @@ -159,5 +158,5 @@ For more troubleshooting, see the [Audio Troubleshooting Guide](/troubleshooting OpenAI charges per character for TTS. See [OpenAI Pricing](https://platform.openai.com/docs/pricing) for current rates. Note that `tts-1-hd` costs more than `tts-1`. :::info -For a free alternative, consider [OpenAI Edge TTS](/features/audio/text-to-speech/openai-edge-tts-integration) which uses Microsoft's free Edge browser TTS. +For a free alternative, consider [OpenAI Edge TTS](/features/media-generation/audio/text-to-speech/openai-edge-tts-integration) which uses Microsoft's free Edge browser TTS. ::: diff --git a/docs/features/media-generation/audio/text-to-speech/openedai-speech-integration.md b/docs/features/media-generation/audio/text-to-speech/openedai-speech-integration.md index 2f5d5acd..d3e3681f 100644 --- a/docs/features/media-generation/audio/text-to-speech/openedai-speech-integration.md +++ b/docs/features/media-generation/audio/text-to-speech/openedai-speech-integration.md @@ -1,5 +1,4 @@ ---- -slug: /features/audio/text-to-speech/openedai-speech-integration +--- sidebar_position: 2 title: "Openedai-speech Using Docker" --- @@ -237,7 +236,7 @@ The configuration files, which define the available voices and their properties, ## Additional Resources -For more information on configuring Open WebUI to use `openedai-speech`, including setting environment variables, see the [Open WebUI documentation](https://docs.openwebui.com/getting-started/env-configuration#text-to-speech). +For more information on configuring Open WebUI to use `openedai-speech`, including setting environment variables, see the [Open WebUI documentation](https://docs.openwebui.com/reference/env-configuration#text-to-speech). For more information about `openedai-speech`, please visit the [GitHub repository](https://github.com/matatonic/openedai-speech). diff --git a/docs/features/media-generation/image-generation-and-editing/automatic1111.md b/docs/features/media-generation/image-generation-and-editing/automatic1111.md index 07ab829a..ed6a1b65 100644 --- a/docs/features/media-generation/image-generation-and-editing/automatic1111.md +++ b/docs/features/media-generation/image-generation-and-editing/automatic1111.md @@ -1,5 +1,4 @@ ---- -slug: /features/image-generation-and-editing/automatic1111 +--- sidebar_position: 2 title: "AUTOMATIC1111" --- diff --git a/docs/features/media-generation/image-generation-and-editing/comfyui.md b/docs/features/media-generation/image-generation-and-editing/comfyui.md index d0f7152e..e9103a0a 100644 --- a/docs/features/media-generation/image-generation-and-editing/comfyui.md +++ b/docs/features/media-generation/image-generation-and-editing/comfyui.md @@ -1,5 +1,4 @@ ---- -slug: /features/image-generation-and-editing/comfyui +--- sidebar_position: 3 title: "ComfyUI" --- diff --git a/docs/features/media-generation/image-generation-and-editing/gemini.mdx b/docs/features/media-generation/image-generation-and-editing/gemini.mdx index 40c412d2..ea954434 100644 --- a/docs/features/media-generation/image-generation-and-editing/gemini.mdx +++ b/docs/features/media-generation/image-generation-and-editing/gemini.mdx @@ -1,5 +1,4 @@ ---- -slug: /features/image-generation-and-editing/gemini +--- sidebar_position: 5 title: "Gemini" --- diff --git a/docs/features/media-generation/image-generation-and-editing/image-router.md b/docs/features/media-generation/image-generation-and-editing/image-router.md index cc47508f..63865275 100644 --- a/docs/features/media-generation/image-generation-and-editing/image-router.md +++ b/docs/features/media-generation/image-generation-and-editing/image-router.md @@ -1,5 +1,4 @@ ---- -slug: /features/image-generation-and-editing/image-router +--- sidebar_position: 6 title: "Image Router" --- diff --git a/docs/features/media-generation/image-generation-and-editing/openai.md b/docs/features/media-generation/image-generation-and-editing/openai.md index de73ae93..28d5cc30 100644 --- a/docs/features/media-generation/image-generation-and-editing/openai.md +++ b/docs/features/media-generation/image-generation-and-editing/openai.md @@ -1,5 +1,4 @@ ---- -slug: /features/image-generation-and-editing/openai +--- sidebar_position: 4 title: "OpenAI" --- diff --git a/docs/features/media-generation/image-generation-and-editing/usage.md b/docs/features/media-generation/image-generation-and-editing/usage.md index 654c9b8c..019da5a1 100644 --- a/docs/features/media-generation/image-generation-and-editing/usage.md +++ b/docs/features/media-generation/image-generation-and-editing/usage.md @@ -1,5 +1,4 @@ ---- -slug: /features/image-generation-and-editing/usage +--- sidebar_position: 1 title: "Usage" --- @@ -16,7 +15,7 @@ Before you can use image generation, you must ensure that the **Image Generation ## Native Tool-Based Generation (Agentic) -If your model is configured with **Native Function Calling** (see the [**Central Tool Calling Guide**](/features/plugin/tools#tool-calling-modes-default-vs-native)), it can invoke image generation directly as a tool. +If your model is configured with **Native Function Calling** (see the [**Central Tool Calling Guide**](/features/extensibility/plugin/tools#tool-calling-modes-default-vs-native)), it can invoke image generation directly as a tool. ### How it works: - **Requirements**: diff --git a/docs/getting-started/development.md b/docs/getting-started/development.md index ab1a303d..1ef0e4b3 100644 --- a/docs/getting-started/development.md +++ b/docs/getting-started/development.md @@ -1,5 +1,4 @@ --- -slug: /getting-started/advanced-topics/development sidebar_position: 3 title: "Local Development Guide" --- @@ -311,7 +310,7 @@ If you find that **icons or other static assets are failing to load**, it is oft **Solution:** You need to configure the `CORS_ALLOW_ORIGIN` environment variable in your backend. -- Check the [Environment Configuration](/getting-started/env-configuration#cors_allow_origin) guide for details on how to set `CORS_ALLOW_ORIGIN` to allow requests from your frontend's URL (e.g., `http://localhost:5173`). +- Check the [Environment Configuration](/reference/env-configuration#cors_allow_origin) guide for details on how to set `CORS_ALLOW_ORIGIN` to allow requests from your frontend's URL (e.g., `http://localhost:5173`). - In a development environment, you can often set this in your `backend/dev.sh` script or your `.env` file. ## Contributing to Open WebUI diff --git a/docs/getting-started/quick-start/connect-a-provider/starting-with-functions.mdx b/docs/getting-started/quick-start/connect-a-provider/starting-with-functions.mdx index f3a4f762..1281633f 100644 --- a/docs/getting-started/quick-start/connect-a-provider/starting-with-functions.mdx +++ b/docs/getting-started/quick-start/connect-a-provider/starting-with-functions.mdx @@ -1,5 +1,4 @@ --- -slug: /getting-started/quick-start/starting-with-functions sidebar_position: 6 title: "Functions" --- @@ -101,11 +100,11 @@ Some functions need credentials (like Anthropic’s API key): Ready to build your own? Check out our detailed development guides: -* **[Functions Overview](/features/plugin/functions/)**: Learn the basics of the Functions system. -* **[Pipes Guide](/features/plugin/functions/pipe)**: Create custom model providers and logic pipelines. -* **[Filters Guide](/features/plugin/functions/filter)**: Intercept and modify messages (Input/Output guards). -* **[Actions Guide](/features/plugin/functions/action)**: Add buttons/actions to messages. -* **[Tools Guide](/features/plugin/tools/)**: Build tools for LLMs to use (RAG, APIs). +* **[Functions Overview](/features/extensibility/plugin/functions/)**: Learn the basics of the Functions system. +* **[Pipes Guide](/features/extensibility/plugin/functions/pipe)**: Create custom model providers and logic pipelines. +* **[Filters Guide](/features/extensibility/plugin/functions/filter)**: Intercept and modify messages (Input/Output guards). +* **[Actions Guide](/features/extensibility/plugin/functions/action)**: Add buttons/actions to messages. +* **[Tools Guide](/features/extensibility/plugin/tools/)**: Build tools for LLMs to use (RAG, APIs). * **[Community Registry](https://openwebui.com/search)**: Browse hundreds of community-made functions. diff --git a/docs/getting-started/quick-start/connect-a-provider/starting-with-llama-cpp.mdx b/docs/getting-started/quick-start/connect-a-provider/starting-with-llama-cpp.mdx index 9037749a..70539760 100644 --- a/docs/getting-started/quick-start/connect-a-provider/starting-with-llama-cpp.mdx +++ b/docs/getting-started/quick-start/connect-a-provider/starting-with-llama-cpp.mdx @@ -1,5 +1,4 @@ --- -slug: /getting-started/quick-start/starting-with-llama-cpp sidebar_position: 3 title: "Llama.cpp" --- @@ -90,7 +89,7 @@ http://127.0.0.1:10000 ``` :::tip -Open WebUI also supports the experimental [Open Responses](/getting-started/quick-start/starting-with-open-responses) specification for providers that implement it. +Open WebUI also supports the experimental [Open Responses](/getting-started/quick-start/connect-a-provider/starting-with-open-responses) specification for providers that implement it. ::: --- diff --git a/docs/getting-started/quick-start/connect-a-provider/starting-with-ollama.mdx b/docs/getting-started/quick-start/connect-a-provider/starting-with-ollama.mdx index 2e09bb2b..9c1f5d0c 100644 --- a/docs/getting-started/quick-start/connect-a-provider/starting-with-ollama.mdx +++ b/docs/getting-started/quick-start/connect-a-provider/starting-with-ollama.mdx @@ -1,5 +1,4 @@ --- -slug: /getting-started/quick-start/starting-with-ollama sidebar_position: 1 title: "Ollama" --- @@ -16,7 +15,7 @@ Open WebUI is designed to be **Protocol-Oriented**. This means that when we refe While some tools may offer basic compatibility, this connection type is optimized for the unique features of the Ollama service, such as native model management and pulling directly through the Admin UI. -If your backend is primarily based on the OpenAI standard (like LocalAI or Docker Model Runner), we recommend using the [OpenAI-Compatible Server Guide](/getting-started/quick-start/starting-with-openai-compatible) for the best experience. +If your backend is primarily based on the OpenAI standard (like LocalAI or Docker Model Runner), we recommend using the [OpenAI-Compatible Server Guide](/getting-started/quick-start/connect-a-provider/starting-with-openai-compatible) for the best experience. --- @@ -93,7 +92,7 @@ ollama serve --reasoning-parser deepseek_r1 This ensures that thinking blocks are properly separated from the final answer and displayed in a collapsible section in Open WebUI. :::tip -The `deepseek_r1` parser works for most reasoning models, including Qwen3. If you encounter issues, see our [Reasoning & Thinking Models Guide](/features/chat-features/reasoning-models) for alternative parsers and detailed troubleshooting steps. +The `deepseek_r1` parser works for most reasoning models, including Qwen3. If you encounter issues, see our [Reasoning & Thinking Models Guide](/features/chat-conversations/chat-features/reasoning-models) for alternative parsers and detailed troubleshooting steps. ::: --- diff --git a/docs/getting-started/quick-start/connect-a-provider/starting-with-open-responses.mdx b/docs/getting-started/quick-start/connect-a-provider/starting-with-open-responses.mdx index 93ff090f..237f3159 100644 --- a/docs/getting-started/quick-start/connect-a-provider/starting-with-open-responses.mdx +++ b/docs/getting-started/quick-start/connect-a-provider/starting-with-open-responses.mdx @@ -1,5 +1,4 @@ --- -slug: /getting-started/quick-start/starting-with-open-responses sidebar_position: 7 title: "Open Responses" diff --git a/docs/getting-started/quick-start/connect-a-provider/starting-with-openai-compatible.mdx b/docs/getting-started/quick-start/connect-a-provider/starting-with-openai-compatible.mdx index e36ee443..954fa499 100644 --- a/docs/getting-started/quick-start/connect-a-provider/starting-with-openai-compatible.mdx +++ b/docs/getting-started/quick-start/connect-a-provider/starting-with-openai-compatible.mdx @@ -1,5 +1,4 @@ --- -slug: /getting-started/quick-start/starting-with-openai-compatible sidebar_position: 5 title: "OpenAI-Compatible" @@ -20,7 +19,7 @@ This means that while Open WebUI handles the **interface and tools**, it expects - **We Support Protocols**: Any provider that follows widely adopted API standards (like Groq, OpenRouter, OpenAI, Mistral, Perplexity and many more) is natively supported. We also have experimental support for **[Open Responses](https://www.openresponses.org/)**. - **We Avoid Proprietary APIs**: We do not implement provider-specific, non-standard APIs in the core to maintain a universal, maintainable codebase. For unsupported providers, use a pipe or middleware proxy. -If you are using a provider that requires a proprietary API, we recommend using a **[pipe](/features/plugin/functions/pipe)** (browse [community pipes](https://openwebui.com/)) or a middleware proxy like LiteLLM or OpenRouter to bridge them to a supported protocol. +If you are using a provider that requires a proprietary API, we recommend using a **[pipe](/features/extensibility/plugin/functions/pipe)** (browse [community pipes](https://openwebui.com/)) or a middleware proxy like LiteLLM or OpenRouter to bridge them to a supported protocol. For a detailed explanation of why we've made this architectural decision, see our **[FAQ: Why doesn't Open WebUI natively support proprietary APIs?](/faq#q-why-doesnt-open-webui-natively-support-provider-xs-proprietary-api)** diff --git a/docs/getting-started/quick-start/connect-a-provider/starting-with-openai.mdx b/docs/getting-started/quick-start/connect-a-provider/starting-with-openai.mdx index 04b8e54b..9a44eccc 100644 --- a/docs/getting-started/quick-start/connect-a-provider/starting-with-openai.mdx +++ b/docs/getting-started/quick-start/connect-a-provider/starting-with-openai.mdx @@ -1,5 +1,4 @@ --- -slug: /getting-started/quick-start/starting-with-openai sidebar_position: 2 title: "OpenAI" diff --git a/docs/getting-started/quick-start/connect-a-provider/starting-with-vllm.mdx b/docs/getting-started/quick-start/connect-a-provider/starting-with-vllm.mdx index 4ec38583..73889963 100644 --- a/docs/getting-started/quick-start/connect-a-provider/starting-with-vllm.mdx +++ b/docs/getting-started/quick-start/connect-a-provider/starting-with-vllm.mdx @@ -1,5 +1,4 @@ --- -slug: /getting-started/quick-start/starting-with-vllm sidebar_position: 4 title: "vLLM" --- @@ -9,7 +8,7 @@ title: "vLLM" vLLM provides an **OpenAI-compatible API** (Chat Completions), making it easy to connect to Open WebUI. This guide will show you how to connect your vLLM server. :::tip -Open WebUI also supports the experimental [Open Responses](/getting-started/quick-start/starting-with-open-responses) specification for providers that implement it. +Open WebUI also supports the experimental [Open Responses](/getting-started/quick-start/connect-a-provider/starting-with-open-responses) specification for providers that implement it. ::: --- diff --git a/docs/getting-started/quick-start/index.mdx b/docs/getting-started/quick-start/index.mdx index c0e4f4f7..5b0d7b37 100644 --- a/docs/getting-started/quick-start/index.mdx +++ b/docs/getting-started/quick-start/index.mdx @@ -167,10 +167,10 @@ After installing, visit: You are now ready to start using Open WebUI! ## Using Open WebUI with Ollama -If you're using Open WebUI with Ollama, be sure to check out our [Starting with Ollama Guide](/getting-started/quick-start/starting-with-ollama) to learn how to manage your Ollama instances with Open WebUI. +If you're using Open WebUI with Ollama, be sure to check out our [Starting with Ollama Guide](/getting-started/quick-start/connect-a-provider/starting-with-ollama) to learn how to manage your Ollama instances with Open WebUI. ## Experimental: Open Responses -Open WebUI has experimental support for the [Open Responses](https://www.openresponses.org/) specification. See the [Starting with Open Responses Guide](/getting-started/quick-start/starting-with-open-responses) to learn how to enable it. +Open WebUI has experimental support for the [Open Responses](https://www.openresponses.org/) specification. See the [Starting with Open Responses Guide](/getting-started/quick-start/connect-a-provider/starting-with-open-responses) to learn how to enable it. ## Help Us Improve Open WebUI 🧪 diff --git a/docs/getting-started/quick-start/tab-docker/DockerSwarm.md b/docs/getting-started/quick-start/tab-docker/DockerSwarm.md index bd4644d6..62c32c60 100644 --- a/docs/getting-started/quick-start/tab-docker/DockerSwarm.md +++ b/docs/getting-started/quick-start/tab-docker/DockerSwarm.md @@ -3,7 +3,7 @@ This installation method requires knowledge on Docker Swarms, as it utilizes a stack file to deploy 3 seperate containers as services in a Docker Swarm. It includes isolated containers of ChromaDB, Ollama, and OpenWebUI. -Additionally, there are pre-filled [Environment Variables](https://docs.openwebui.com/getting-started/env-configuration) to further illustrate the setup. +Additionally, there are pre-filled [Environment Variables](https://docs.openwebui.com/reference/env-configuration) to further illustrate the setup. Choose the appropriate command based on your hardware setup: diff --git a/docs/getting-started/quick-start/tab-kubernetes/Helm.md b/docs/getting-started/quick-start/tab-kubernetes/Helm.md index e665db93..811c513c 100644 --- a/docs/getting-started/quick-start/tab-kubernetes/Helm.md +++ b/docs/getting-started/quick-start/tab-kubernetes/Helm.md @@ -32,7 +32,7 @@ Helm helps you manage Kubernetes applications. :::warning If you intend to scale Open WebUI using multiple nodes/pods/workers in a clustered environment, you need to setup a NoSQL key-value database. -There are some [environment variables](https://docs.openwebui.com/getting-started/env-configuration/) that need to be set to the same value for all service-instances, otherwise consistency problems, faulty sessions and other issues will occur! +There are some [environment variables](https://docs.openwebui.com/reference/env-configuration/) that need to be set to the same value for all service-instances, otherwise consistency problems, faulty sessions and other issues will occur! ::: diff --git a/docs/getting-started/updating.mdx b/docs/getting-started/updating.mdx index fa36527c..e4175556 100644 --- a/docs/getting-started/updating.mdx +++ b/docs/getting-started/updating.mdx @@ -213,7 +213,7 @@ volumes: - Keep the same key across updates to maintain sessions ::: -For complete environment variable documentation, see [Environment Configuration](https://docs.openwebui.com/getting-started/env-configuration#security-variables). +For complete environment variable documentation, see [Environment Configuration](https://docs.openwebui.com/reference/env-configuration#security-variables). ## Automated Update Tools @@ -504,7 +504,7 @@ docker run --rm -v open-webui:/data alpine ls -lah /data 1. Stop Open WebUI: `docker stop open-webui` 2. Backup volume: `docker run --rm -v open-webui:/data -v $(pwd):/backup alpine tar czf /backup/openwebui-backup.tar.gz /data` 3. Restore from backup if needed -4. Check [Manual Migration Guide](../troubleshooting/manual-database-migration.md) for database issues +4. Check [Manual Migration Guide](/troubleshooting/manual-database-migration.md) for database issues ### Watchtower Updates Too Frequently @@ -629,7 +629,7 @@ If the interface looks broken or old after updating: ## Additional Resources - [Open WebUI GitHub Releases](https://github.com/open-webui/open-webui/releases) - Version history and changelogs -- [Environment Configuration Guide](https://docs.openwebui.com/getting-started/env-configuration) - All environment variables -- [Manual Database Migration](../troubleshooting/manual-database-migration.md) - Fix database issues after updates +- [Environment Configuration Guide](https://docs.openwebui.com/reference/env-configuration) - All environment variables +- [Manual Database Migration](/troubleshooting/manual-database-migration.md) - Fix database issues after updates - [Watchtower Documentation](https://watchtower.nickfedor.com/) - Advanced Watchtower configuration - [WUD Documentation](https://getwud.github.io/wud/) - What's Up Docker setup guide diff --git a/docs/intro.mdx b/docs/intro.mdx index 02c3de0a..a08cc682 100644 --- a/docs/intro.mdx +++ b/docs/intro.mdx @@ -11,7 +11,7 @@ import { SponsorList } from "@site/src/components/SponsorList"; # Open WebUI -**Open WebUI is an [extensible](https://docs.openwebui.com/features/plugin/), feature-rich, and user-friendly self-hosted AI platform designed to operate entirely offline.** It is built around universal standards, supporting **Ollama** and **OpenAI-compatible Protocols** (specifically Chat Completions). This protocol-first approach makes it a powerful, provider-agnostic AI deployment solution for both local and cloud-based models. +**Open WebUI is an [extensible](https://docs.openwebui.com/features/extensibility/plugin/), feature-rich, and user-friendly self-hosted AI platform designed to operate entirely offline.** It is built around universal standards, supporting **Ollama** and **OpenAI-compatible Protocols** (specifically Chat Completions). This protocol-first approach makes it a powerful, provider-agnostic AI deployment solution for both local and cloud-based models. [![Open WebUI Banner](/images/banner.png)](https://openwebui.com) @@ -134,7 +134,7 @@ docker run -d -p 3000:8080 -v open-webui:/app/backend/data --name open-webui --r :::note Alternative: Local Development Setup -If Docker doesn't work for your environment, you can also run the latest development code using the [Local Development Guide](/getting-started/advanced-topics/development). Conversely, if you prefer Docker over a local setup, the dev image is the easiest way to test. +If Docker doesn't work for your environment, you can also run the latest development code using the [Local Development Guide](/getting-started/development). Conversely, if you prefer Docker over a local setup, the dev image is the easiest way to test. ::: diff --git a/docs/reference/api-endpoints.md b/docs/reference/api-endpoints.md index ef769c47..5ae2367e 100644 --- a/docs/reference/api-endpoints.md +++ b/docs/reference/api-endpoints.md @@ -1,5 +1,4 @@ --- -slug: /getting-started/api-endpoints sidebar_position: 400 title: "API Endpoints" --- @@ -216,7 +215,7 @@ The `outlet()` function only runs when the WebUI calls `/api/chat/completed` aft ``` :::tip -For more details on writing filters that work with API requests, see the [Filter Function documentation](/features/plugin/functions/filter#-filter-behavior-with-api-requests). +For more details on writing filters that work with API requests, see the [Filter Function documentation](/features/extensibility/plugin/functions/filter#-filter-behavior-with-api-requests). ::: ### 🦙 Ollama API Proxy Support diff --git a/docs/reference/env-configuration.mdx b/docs/reference/env-configuration.mdx index b14ad89e..358bf998 100644 --- a/docs/reference/env-configuration.mdx +++ b/docs/reference/env-configuration.mdx @@ -1,5 +1,4 @@ --- -slug: /getting-started/env-configuration sidebar_position: 1 title: "Environment Variable Configuration" --- @@ -159,7 +158,7 @@ After the admin account is created, sign-up is automatically disabled for securi :::danger -This should **only** ever be set to `False` when [ENABLE_OAUTH_SIGNUP](https://docs.openwebui.com/getting-started/env-configuration/#enable_oauth_signup) +This should **only** ever be set to `False` when [ENABLE_OAUTH_SIGNUP](https://docs.openwebui.com/reference/env-configuration/#enable_oauth_signup) is also being used and set to `True`. **Never disable this if OAUTH/SSO is not being used.** Failure to do so will result in the inability to login. ::: @@ -250,7 +249,7 @@ is also being used and set to `True`. **Never disable this if OAUTH/SSO is not b - Type: `bool` - Default: `True` -- Description: Enables or disables the [memory feature](/features/memory), allowing models to store and retrieve long-term information about users. +- Description: Enables or disables the [memory feature](/features/chat-conversations/memory), allowing models to store and retrieve long-term information about users. - Persistence: This environment variable is a `PersistentConfig` variable. #### `WEBHOOK_URL` @@ -1238,7 +1237,7 @@ For API Key creation (and the API keys themselves) to work, you need **both**: 1. Enable API keys globally using this setting (`ENABLE_API_KEYS`) 2. Grant the "API Keys" permission to users via Default Permissions or User Groups -**Note:** Administrators are not exempt—they must also be granted the permission via a User Group to use API keys. See the [Authentication Setup for API Key](/getting-started/advanced-topics/monitoring#authentication-setup-for-api-key-) guide for detailed setup instructions. +**Note:** Administrators are not exempt—they must also be granted the permission via a User Group to use API keys. See the [Authentication Setup for API Key](/reference/monitoring#authentication-setup-for-api-key-) guide for detailed setup instructions. ::: @@ -1360,7 +1359,7 @@ If enabled, the following headers are forwarded: - `X-OpenWebUI-Chat-Id` - `X-OpenWebUI-Message-Id` -This enables per-user authorization, auditing, rate limiting, and request tracing on external services. The chat and message ID headers are also required for [external tool event emitting](/features/plugin/development/events#-external-tool-events). +This enables per-user authorization, auditing, rate limiting, and request tracing on external services. The chat and message ID headers are also required for [external tool event emitting](/features/extensibility/plugin/development/events#-external-tool-events). #### `FORWARD_USER_INFO_HEADER_USER_NAME` @@ -1396,7 +1395,7 @@ This enables per-user authorization, auditing, rate limiting, and request tracin - Type: `str` - Default: `X-OpenWebUI-Message-Id` -- Description: Customizes the header name used to forward the current message ID. This header is required for [external tool event emitting](/features/plugin/development/events#-external-tool-events). +- Description: Customizes the header name used to forward the current message ID. This header is required for [external tool event emitting](/features/extensibility/plugin/development/events#-external-tool-events). :::tip Custom Header Prefix Use these variables when integrating with services that require specific header naming conventions. For example, AWS Bedrock AgentCore requires headers prefixed with `X-Amzn-Bedrock-AgentCore-Runtime-Custom-`: @@ -1608,7 +1607,7 @@ If `OFFLINE_MODE` is enabled, this `ENABLE_VERSION_UPDATE_CHECK` flag is always - OAuth authentication providers - Web search and RAG with external APIs -Read more about `offline mode` in the [offline mode guide](/tutorials/offline-mode). +Read more about `offline mode` in the [offline mode guide](/tutorials/maintenance/offline-mode). ::: @@ -2752,7 +2751,7 @@ Provide a clear and direct response to the user's query, including inline citati - Type: `int` - Default: `0` -- Description: Chunks smaller than this threshold will be intelligently merged with neighboring chunks when possible. This helps prevent tiny, low-quality fragments that can hurt retrieval performance and waste embedding resources. This feature only works when `ENABLE_MARKDOWN_HEADER_TEXT_SPLITTER` is enabled. Set to `0` to disable merging. For more information on the benefits and configuration, see the [RAG guide](/features/rag#chunking-configuration). +- Description: Chunks smaller than this threshold will be intelligently merged with neighboring chunks when possible. This helps prevent tiny, low-quality fragments that can hurt retrieval performance and waste embedding resources. This feature only works when `ENABLE_MARKDOWN_HEADER_TEXT_SPLITTER` is enabled. Set to `0` to disable merging. For more information on the benefits and configuration, see the [RAG guide](/features/chat-conversations/rag#chunking-configuration). - Persistence: This environment variable is a `PersistentConfig` variable. #### `RAG_TEXT_SPLITTER` @@ -3402,7 +3401,7 @@ the search query. Example: `http://searxng.local/search?q=` :::info -Brave's free tier enforces a rate limit of 1 request per second. Open WebUI automatically retries requests that receive HTTP 429 rate limit errors after a 1-second delay. For free tier users, set `WEB_SEARCH_CONCURRENT_REQUESTS` to `1` to ensure sequential request processing. See the [Brave web search documentation](/features/web-search/brave) for more details. +Brave's free tier enforces a rate limit of 1 request per second. Open WebUI automatically retries requests that receive HTTP 429 rate limit errors after a 1-second delay. For free tier users, set `WEB_SEARCH_CONCURRENT_REQUESTS` to `1` to ensure sequential request processing. See the [Brave web search documentation](/features/chat-conversations/web-search/providers/brave) for more details. ::: @@ -4240,7 +4239,7 @@ Strictly return in JSON format: :::tip -For a detailed setup guide and example configuration, please refer to the [Gemini Image Generation Guide](/features/image-generation-and-editing/gemini). +For a detailed setup guide and example configuration, please refer to the [Gemini Image Generation Guide](/features/media-generation/image-generation-and-editing/gemini). ::: @@ -4615,18 +4614,18 @@ In any production environment running more than one instance of Open WebUI (e.g. #### `WEBUI_AUTH_TRUSTED_EMAIL_HEADER` - Type: `str` -- Description: Defines the trusted request header for authentication. See [SSO docs](/features/auth/sso). +- Description: Defines the trusted request header for authentication. See [SSO docs](/features/access-security/auth/sso). #### `WEBUI_AUTH_TRUSTED_NAME_HEADER` - Type: `str` - Description: Defines the trusted request header for the username of anyone registering with the -`WEBUI_AUTH_TRUSTED_EMAIL_HEADER` header. See [SSO docs](/features/auth/sso). +`WEBUI_AUTH_TRUSTED_EMAIL_HEADER` header. See [SSO docs](/features/access-security/auth/sso). #### `WEBUI_AUTH_TRUSTED_GROUPS_HEADER` - Type: `str` -- Description: Defines the trusted request header containing a comma-separated list of group memberships for the user when using trusted header authentication. See [SSO docs](/features/auth/sso). +- Description: Defines the trusted request header containing a comma-separated list of group memberships for the user when using trusted header authentication. See [SSO docs](/features/access-security/auth/sso). ### Google @@ -5247,7 +5246,7 @@ This is useful when you need a JWT access token for downstream validation or whe - Type: `str` - Default: `True` -- Description: Enables or disables user permission to use the [memory feature](/features/memory). +- Description: Enables or disables user permission to use the [memory feature](/features/chat-conversations/memory). - Persistence: This environment variable is a `PersistentConfig` variable. #### `USER_PERMISSIONS_FEATURES_FOLDERS` @@ -5284,7 +5283,7 @@ For API Key creation (and the API keys themselves) to work, you need **both**: 1. Grant the "API Keys" permission to users via this setting or User Groups 2. Enable API keys globally using `ENABLE_API_KEYS` -**Note:** Administrators are not exempt—they must also be granted the permission via a User Group to use API keys. See the [Authentication Setup for API Key](/getting-started/advanced-topics/monitoring#authentication-setup-for-api-key-) guide for detailed setup instructions. +**Note:** Administrators are not exempt—they must also be granted the permission via a User Group to use API keys. See the [Authentication Setup for API Key](/reference/monitoring#authentication-setup-for-api-key-) guide for detailed setup instructions. ::: diff --git a/docs/reference/https-encryption.md b/docs/reference/https-encryption.md index f47f039b..432ac860 100644 --- a/docs/reference/https-encryption.md +++ b/docs/reference/https-encryption.md @@ -1,5 +1,4 @@ --- -slug: /getting-started/advanced-topics/https-encryption sidebar_position: 6 title: "Enabling HTTPS Encryption" --- diff --git a/docs/reference/monitoring/index.md b/docs/reference/monitoring/index.md index 55d5c90e..2a7402db 100644 --- a/docs/reference/monitoring/index.md +++ b/docs/reference/monitoring/index.md @@ -1,5 +1,4 @@ --- -slug: /getting-started/advanced-topics/monitoring sidebar_position: 6 title: "API Keys & Monitoring" --- @@ -70,7 +69,7 @@ To go beyond basic availability, you can monitor the `/api/models` endpoint. Thi **API Endpoint Details:** -See the [Open WebUI API documentation](https://docs.openwebui.com/getting-started/api-endpoints/#-retrieve-all-models) for full details about the `/api/models` endpoint and its response structure. +See the [Open WebUI API documentation](https://docs.openwebui.com/reference/api-endpoints/#-retrieve-all-models) for full details about the `/api/models` endpoint and its response structure. **How to Test with `curl` (Authenticated):** @@ -181,8 +180,8 @@ This approach limits the potential impact if the monitoring API key is compromis If you don't see the API key generation option in your account settings: -- **Check global setting**: Verify that an administrator has enabled API keys globally under **Admin Panel** > **Settings** > **General** > **Enable API Keys**. See [`ENABLE_API_KEYS`](/getting-started/env-configuration#enable_api_keys). -- **Check your permissions**: Verify that your user account or group has been granted the "API Keys" feature permission under **Features Permissions**. See [`USER_PERMISSIONS_FEATURES_API_KEYS`](/getting-started/env-configuration#user_permissions_features_api_keys). +- **Check global setting**: Verify that an administrator has enabled API keys globally under **Admin Panel** > **Settings** > **General** > **Enable API Keys**. See [`ENABLE_API_KEYS`](/reference/env-configuration#enable_api_keys). +- **Check your permissions**: Verify that your user account or group has been granted the "API Keys" feature permission under **Features Permissions**. See [`USER_PERMISSIONS_FEATURES_API_KEYS`](/reference/env-configuration#user_permissions_features_api_keys). ### Using Uptime Kuma for Model Connectivity Monitoring 🐻 diff --git a/docs/reference/monitoring/otel.md b/docs/reference/monitoring/otel.md index 640ca74c..01c51f23 100644 --- a/docs/reference/monitoring/otel.md +++ b/docs/reference/monitoring/otel.md @@ -1,5 +1,4 @@ --- -slug: /getting-started/advanced-topics/monitoring/opentelemetry sidebar_position: 7 title: "OpenTelemetry" --- diff --git a/docs/reference/network-diagrams.mdx b/docs/reference/network-diagrams.mdx index 60fcad85..d09a30f3 100644 --- a/docs/reference/network-diagrams.mdx +++ b/docs/reference/network-diagrams.mdx @@ -1,5 +1,4 @@ --- -slug: /getting-started/advanced-topics/network-diagrams sidebar_position: 3 title: "Network Diagrams" --- diff --git a/docs/troubleshooting/audio.mdx b/docs/troubleshooting/audio.mdx index 8748dbd8..52df8a58 100644 --- a/docs/troubleshooting/audio.mdx +++ b/docs/troubleshooting/audio.mdx @@ -99,7 +99,7 @@ services: - AUDIO_TTS_OPENAI_API_KEY=not-needed ``` -→ See full guide: [OpenAI Edge TTS](/features/audio/text-to-speech/openai-edge-tts-integration) +→ See full guide: [OpenAI Edge TTS](/features/media-generation/audio/text-to-speech/openai-edge-tts-integration) ### Browser-Only Setup (No Backend Config Needed) @@ -191,7 +191,7 @@ docker exec open-webui bash -lc "pip show datasets" ``` :::tip -Consider using an external TTS service like [OpenAI Edge TTS](/features/audio/text-to-speech/openai-edge-tts-integration) or [Kokoro](/features/audio/text-to-speech/Kokoro-FastAPI-integration) instead of local Transformers TTS to avoid these dependency conflicts. +Consider using an external TTS service like [OpenAI Edge TTS](/features/media-generation/audio/text-to-speech/openai-edge-tts-integration) or [Kokoro](/features/media-generation/audio/text-to-speech/Kokoro-FastAPI-integration) instead of local Transformers TTS to avoid these dependency conflicts. ::: #### 2. Using External TTS Instead of Local @@ -423,7 +423,7 @@ curl http://your-tts-service:port/health | `AUDIO_STT_OPENAI_API_KEY` | API key for OpenAI-compatible STT | | `DEEPGRAM_API_KEY` | Deepgram API key | -For a complete list of audio environment variables, see [Environment Variable Configuration](/getting-started/env-configuration#audio). +For a complete list of audio environment variables, see [Environment Variable Configuration](/reference/env-configuration#audio). --- diff --git a/docs/troubleshooting/connection-error.mdx b/docs/troubleshooting/connection-error.mdx index bb344ae2..6d1af6ee 100644 --- a/docs/troubleshooting/connection-error.mdx +++ b/docs/troubleshooting/connection-error.mdx @@ -269,7 +269,7 @@ Manual database manipulation should be a last resort. Always back up your databa | `RESET_CONFIG_ON_START` | `false` | Reset database config to env var values on startup | | `ENABLE_PERSISTENT_CONFIG` | `true` | Whether database config takes precedence over env vars | -See the [Environment Configuration](/getting-started/env-configuration#aiohttp_client_timeout_model_list) documentation for more details. +See the [Environment Configuration](/reference/env-configuration#aiohttp_client_timeout_model_list) documentation for more details. ## 🐢 Slow Performance or Timeouts on Low-Spec Hardware @@ -287,7 +287,7 @@ Disable database session sharing: DATABASE_ENABLE_SESSION_SHARING=false ``` -For PostgreSQL on adequate hardware, enabling this setting may improve performance. See the [DATABASE_ENABLE_SESSION_SHARING](/getting-started/env-configuration#database_enable_session_sharing) documentation for details. +For PostgreSQL on adequate hardware, enabling this setting may improve performance. See the [DATABASE_ENABLE_SESSION_SHARING](/reference/env-configuration#database_enable_session_sharing) documentation for details. ## 🔒 SSL Connection Issue with Hugging Face @@ -355,7 +355,7 @@ If you are having trouble connecting to MCP tools (e.g. "Failed to connect to MC * **Authentication**: Ensure you aren't using "Bearer" without a token. * **Filters**: Try adding a comma to the Function Name Filter List. -See the [MCP Feature Documentation](/features/mcp#troubleshooting) for detailed troubleshooting steps. +See the [MCP Feature Documentation](/features/extensibility/mcp#troubleshooting) for detailed troubleshooting steps. ## 🔐 SSL/TLS Errors with Web Search diff --git a/docs/troubleshooting/image-generation.md b/docs/troubleshooting/image-generation.md index 40796d26..9debb962 100644 --- a/docs/troubleshooting/image-generation.md +++ b/docs/troubleshooting/image-generation.md @@ -64,8 +64,8 @@ For advanced configuration, you can set the following environment variables. **Gemini** - `IMAGES_GEMINI_API_KEY`: API Key for Gemini. -- [View Gemini Configuration Guide](/features/image-generation-and-editing/gemini) +- [View Gemini Configuration Guide](/features/media-generation/image-generation-and-editing/gemini) :::tip -For a complete list of environment variables and detailed configuration options, please refer to the [Environment Configuration Guide](/getting-started/env-configuration). +For a complete list of environment variables and detailed configuration options, please refer to the [Environment Configuration Guide](/reference/env-configuration). ::: diff --git a/docs/troubleshooting/index.mdx b/docs/troubleshooting/index.mdx index 046c3056..eaaefa7f 100644 --- a/docs/troubleshooting/index.mdx +++ b/docs/troubleshooting/index.mdx @@ -11,7 +11,7 @@ import { TopBanners } from "@site/src/components/TopBanners"; Encountering issues? Don't worry, we're here to help! 😊 Start with this important step: - 🔄 Make sure you're using the **latest version** of the software. -- 💾 **Check for Configuration Persistence:** Open WebUI prioritizes settings stored in its internal database over environment variables for certain settings (marked as `PersistentConfig`). If your environment changes (like `ENABLE_SIGNUP=True`) seem to be ignored, see the **[Environment Variable Configuration](/getting-started/env-configuration#important-note-on-persistentconfig-environment-variables)** page for how to force updates or manually edit the database. +- 💾 **Check for Configuration Persistence:** Open WebUI prioritizes settings stored in its internal database over environment variables for certain settings (marked as `PersistentConfig`). If your environment changes (like `ENABLE_SIGNUP=True`) seem to be ignored, see the **[Environment Variable Configuration](/reference/env-configuration#important-note-on-persistentconfig-environment-variables)** page for how to force updates or manually edit the database. With this project constantly evolving, updates and fixes are regularly added. Keeping your software up-to-date is crucial to take advantage of all the enhancements and fixes, ensuring the best possible experience. 🚀 diff --git a/docs/troubleshooting/manual-database-migration.md b/docs/troubleshooting/manual-database-migration.md index cedfa5f9..c173740f 100644 --- a/docs/troubleshooting/manual-database-migration.md +++ b/docs/troubleshooting/manual-database-migration.md @@ -481,7 +481,7 @@ There are three ways to resolve this, listed from safest to most lossy: #### Option 1: Restore from Backup (Recommended) -Restore your database from the backup you created in [Step 1](#step-1-backup-your-database), then run `alembic upgrade head` on the clean backup. This guarantees the full migration — including all data backfills — completes correctly. +Restore your database from the backup you created in [Step 1](#step-1-create-and-verify-backup), then run `alembic upgrade head` on the clean backup. This guarantees the full migration — including all data backfills — completes correctly. #### Option 2: Drop the Table and Re-Run diff --git a/docs/troubleshooting/multi-replica.mdx b/docs/troubleshooting/multi-replica.mdx index a51e8093..5be15724 100644 --- a/docs/troubleshooting/multi-replica.mdx +++ b/docs/troubleshooting/multi-replica.mdx @@ -11,12 +11,12 @@ This guide addresses common issues encountered when deploying Open WebUI in **mu Before troubleshooting specific errors, ensure your deployment meets these **absolute requirements** for a multi-replica setup. Missing any of these will cause instability, login loops, or data loss. -1. **Shared Secret Key:** [`WEBUI_SECRET_KEY`](/getting-started/env-configuration#webui_secret_key) **MUST** be identical on all replicas. -2. **External Database:** You **MUST** use an external PostgreSQL database (see [`DATABASE_URL`](/getting-started/env-configuration#database_url)). SQLite is **NOT** supported for multiple instances. -3. **Redis for WebSockets:** [`ENABLE_WEBSOCKET_SUPPORT=True`](/getting-started/env-configuration#enable_websocket_support) and [`WEBSOCKET_MANAGER=redis`](/getting-started/env-configuration#websocket_manager) with a valid [`WEBSOCKET_REDIS_URL`](/getting-started/env-configuration#websocket_redis_url) are required. +1. **Shared Secret Key:** [`WEBUI_SECRET_KEY`](/reference/env-configuration#webui_secret_key) **MUST** be identical on all replicas. +2. **External Database:** You **MUST** use an external PostgreSQL database (see [`DATABASE_URL`](/reference/env-configuration#database_url)). SQLite is **NOT** supported for multiple instances. +3. **Redis for WebSockets:** [`ENABLE_WEBSOCKET_SUPPORT=True`](/reference/env-configuration#enable_websocket_support) and [`WEBSOCKET_MANAGER=redis`](/reference/env-configuration#websocket_manager) with a valid [`WEBSOCKET_REDIS_URL`](/reference/env-configuration#websocket_redis_url) are required. 4. **Shared Storage:** A persistent volume (RWX / ReadWriteMany if possible, or ensuring all replicas map to the same underlying storage for `data/`) is critical for RAG (uploads/vectors) and generated images. -5. **External Vector Database (Recommended):** While embedded Chroma works with shared storage, using a dedicated external Vector DB (e.g., [PGVector](/getting-started/env-configuration#pgvector_db_url), Milvus, Qdrant) is **highly recommended** to avoid file locking issues and improve performance. -6. **Database Session Sharing (Optional):** For PostgreSQL deployments with adequate resources, consider enabling [`DATABASE_ENABLE_SESSION_SHARING=True`](/getting-started/env-configuration#database_enable_session_sharing) to improve performance under high concurrency. +5. **External Vector Database (Recommended):** While embedded Chroma works with shared storage, using a dedicated external Vector DB (e.g., [PGVector](/reference/env-configuration#pgvector_db_url), Milvus, Qdrant) is **highly recommended** to avoid file locking issues and improve performance. +6. **Database Session Sharing (Optional):** For PostgreSQL deployments with adequate resources, consider enabling [`DATABASE_ENABLE_SESSION_SHARING=True`](/reference/env-configuration#database_enable_session_sharing) to improve performance under high concurrency. --- @@ -54,7 +54,7 @@ env: - **Missing Redis:** WebSockets are defaulting to in-memory, so events on Replica A (e.g., LLM generation finish) are not broadcast to the user connected to Replica B. **Solution:** -1. **Configure CORS:** Ensure [`CORS_ALLOW_ORIGIN`](/getting-started/env-configuration#cors_allow_origin) includes your public domain *and* http/https variations. +1. **Configure CORS:** Ensure [`CORS_ALLOW_ORIGIN`](/reference/env-configuration#cors_allow_origin) includes your public domain *and* http/https variations. If you see logs like `engineio.base_server:_log_error_once:354 - https://yourdomain.com is not an accepted origin`, you must update this variable. It accepts a **semicolon-separated list** of allowed origins. @@ -143,7 +143,7 @@ Enabling session sharing can improve performance under high concurrency: DATABASE_ENABLE_SESSION_SHARING=true ``` -See [DATABASE_ENABLE_SESSION_SHARING](/getting-started/env-configuration#database_enable_session_sharing) for details. +See [DATABASE_ENABLE_SESSION_SHARING](/reference/env-configuration#database_enable_session_sharing) for details. #### Connection Pool Sizing @@ -172,7 +172,7 @@ For example, with `DATABASE_POOL_SIZE=15`, `DATABASE_POOL_MAX_OVERFLOW=20`, 3 re ::: -See [DATABASE_POOL_SIZE](/getting-started/env-configuration#database_pool_size) for details. +See [DATABASE_POOL_SIZE](/reference/env-configuration#database_pool_size) for details. --- @@ -213,7 +213,7 @@ While Open WebUI is designed to be stateless with proper Redis configuration, en ## Related Documentation -- [Environment Variable Configuration](/getting-started/env-configuration) +- [Environment Variable Configuration](/reference/env-configuration) - [Optimization, Performance & RAM Usage](/troubleshooting/performance) - [Troubleshooting Connection Errors](/troubleshooting/connection-error) - [Logging Configuration](/getting-started/advanced-topics/logging) diff --git a/docs/troubleshooting/performance.md b/docs/troubleshooting/performance.md index 05040fa0..9fe16ffe 100644 --- a/docs/troubleshooting/performance.md +++ b/docs/troubleshooting/performance.md @@ -91,7 +91,7 @@ By default, Open WebUI saves chats **after generation is complete**. While savin - **Env Var**: `ENABLE_REALTIME_CHAT_SAVE=False` (Default) - **Effect**: Chats are saved only when the generation is complete (or periodically). -- **Recommendation**: **DO NOT ENABLE `ENABLE_REALTIME_CHAT_SAVE` in production.** It is highly recommended to keep this `False` to prevent database connection exhaustion and severe performance degradation under concurrent load. See the [Environment Variable Configuration](/getting-started/env-configuration#enable_realtime_chat_save) for details. +- **Recommendation**: **DO NOT ENABLE `ENABLE_REALTIME_CHAT_SAVE` in production.** It is highly recommended to keep this `False` to prevent database connection exhaustion and severe performance degradation under concurrent load. See the [Environment Variable Configuration](/reference/env-configuration#enable_realtime_chat_save) for details. ### Database Session Sharing @@ -367,22 +367,22 @@ If resource usage is critical, disable automated features that constantly trigge ## 🔗 Environment Variable References -For detailed information on all available variables, see the [Environment Configuration](/getting-started/env-configuration) guide. +For detailed information on all available variables, see the [Environment Configuration](/reference/env-configuration) guide. | Variable | Description & Link | | :--- | :--- | -| `TASK_MODEL` | [Task Model (Local)](/getting-started/env-configuration#task_model) | -| `TASK_MODEL_EXTERNAL` | [Task Model (External)](/getting-started/env-configuration#task_model_external) | -| `ENABLE_BASE_MODELS_CACHE` | [Cache Model List](/getting-started/env-configuration#enable_base_models_cache) | -| `MODELS_CACHE_TTL` | [Model Cache TTL](/getting-started/env-configuration#models_cache_ttl) | -| `ENABLE_QUERIES_CACHE` | [Queries Cache](/getting-started/env-configuration#enable_queries_cache) | -| `DATABASE_URL` | [Database URL](/getting-started/env-configuration#database_url) | -| `ENABLE_REALTIME_CHAT_SAVE` | [Realtime Chat Save](/getting-started/env-configuration#enable_realtime_chat_save) | -| `CHAT_RESPONSE_STREAM_DELTA_CHUNK_SIZE` | [Streaming Chunk Size](/getting-started/env-configuration#chat_response_stream_delta_chunk_size) | -| `THREAD_POOL_SIZE` | [Thread Pool Size](/getting-started/env-configuration#thread_pool_size) | -| `RAG_EMBEDDING_ENGINE` | [Embedding Engine](/getting-started/env-configuration#rag_embedding_engine) | -| `AUDIO_STT_ENGINE` | [STT Engine](/getting-started/env-configuration#audio_stt_engine) | -| `ENABLE_IMAGE_GENERATION` | [Image Generation](/getting-started/env-configuration#enable_image_generation) | -| `ENABLE_AUTOCOMPLETE_GENERATION` | [Autocomplete](/getting-started/env-configuration#enable_autocomplete_generation) | -| `RAG_SYSTEM_CONTEXT` | [RAG System Context](/getting-started/env-configuration#rag_system_context) | -| `DATABASE_ENABLE_SESSION_SHARING` | [Database Session Sharing](/getting-started/env-configuration#database_enable_session_sharing) | +| `TASK_MODEL` | [Task Model (Local)](/reference/env-configuration#task_model) | +| `TASK_MODEL_EXTERNAL` | [Task Model (External)](/reference/env-configuration#task_model_external) | +| `ENABLE_BASE_MODELS_CACHE` | [Cache Model List](/reference/env-configuration#enable_base_models_cache) | +| `MODELS_CACHE_TTL` | [Model Cache TTL](/reference/env-configuration#models_cache_ttl) | +| `ENABLE_QUERIES_CACHE` | [Queries Cache](/reference/env-configuration#enable_queries_cache) | +| `DATABASE_URL` | [Database URL](/reference/env-configuration#database_url) | +| `ENABLE_REALTIME_CHAT_SAVE` | [Realtime Chat Save](/reference/env-configuration#enable_realtime_chat_save) | +| `CHAT_RESPONSE_STREAM_DELTA_CHUNK_SIZE` | [Streaming Chunk Size](/reference/env-configuration#chat_response_stream_delta_chunk_size) | +| `THREAD_POOL_SIZE` | [Thread Pool Size](/reference/env-configuration#thread_pool_size) | +| `RAG_EMBEDDING_ENGINE` | [Embedding Engine](/reference/env-configuration#rag_embedding_engine) | +| `AUDIO_STT_ENGINE` | [STT Engine](/reference/env-configuration#audio_stt_engine) | +| `ENABLE_IMAGE_GENERATION` | [Image Generation](/reference/env-configuration#enable_image_generation) | +| `ENABLE_AUTOCOMPLETE_GENERATION` | [Autocomplete](/reference/env-configuration#enable_autocomplete_generation) | +| `RAG_SYSTEM_CONTEXT` | [RAG System Context](/reference/env-configuration#rag_system_context) | +| `DATABASE_ENABLE_SESSION_SHARING` | [Database Session Sharing](/reference/env-configuration#database_enable_session_sharing) | diff --git a/docs/troubleshooting/rag.mdx b/docs/troubleshooting/rag.mdx index c818c30d..5488c75f 100644 --- a/docs/troubleshooting/rag.mdx +++ b/docs/troubleshooting/rag.mdx @@ -144,7 +144,7 @@ Open WebUI implements various limits to ensure system stability and prevent abus * **Max File Size:** Controlled by `RAG_FILE_MAX_SIZE` (default: Unlimited). Configurable in **Admin Panel > Settings > Documents > General > Max Upload Size**. * **Max File Count:** Controlled by `RAG_FILE_MAX_COUNT` (default: Unlimited). Configurable in **Admin Panel > Settings > Documents > General > Max Upload Count**. * **Allowed File Extensions:** Controlled by `RAG_ALLOWED_FILE_EXTENSIONS` (default: All). Configurable in **Admin Panel > Settings > Documents > General > Allowed File Extensions**. -* **Folder Uploads:** Subject to the `FOLDER_MAX_FILE_COUNT` [environment variable](/getting-started/env-configuration/#folder_max_file_count) (defaults to 100). This limit applies to the number of files directly associated with a folder. +* **Folder Uploads:** Subject to the `FOLDER_MAX_FILE_COUNT` [environment variable](/reference/env-configuration/#folder_max_file_count) (defaults to 100). This limit applies to the number of files directly associated with a folder. * **Knowledge Base Uploads:** * **File Limit:** Subject to the same `RAG_FILE_MAX_SIZE` limit as chats, but **not** subject to the `RAG_FILE_MAX_COUNT` limit, allowing for unlimited file uploads. * **RAG Enforcement:** All files uploaded to a Knowledge Base are automatically indexed. However, similar to chat uploads, Knowledge Bases can also be used in **Full Context Mode** (accessible in chat settings), which feeds the full document content to the model instead of using vector search retrieval. @@ -238,7 +238,7 @@ def wait_for_processing(token, file_id, timeout=300): | `failed` | Processing failed (check error field) | :::tip -For complete API workflow examples including proper status checking, see the [API Endpoints documentation](/getting-started/api-endpoints#checking-file-processing-status). +For complete API workflow examples including proper status checking, see the [API Endpoints documentation](/reference/api-endpoints#checking-file-processing-status). ::: --- @@ -353,7 +353,7 @@ If you are running a version with this fix and still experiencing worker death, RAG_EMBEDDING_MODEL=nomic-embed-text ``` -4. **Optionally set a safety timeout** via [`RAG_EMBEDDING_TIMEOUT`](/getting-started/env-configuration#rag_embedding_timeout) to abort abnormally long embedding operations (does not affect health checks). +4. **Optionally set a safety timeout** via [`RAG_EMBEDDING_TIMEOUT`](/reference/env-configuration#rag_embedding_timeout) to abort abnormally long embedding operations (does not affect health checks). --- diff --git a/docs/troubleshooting/sso.mdx b/docs/troubleshooting/sso.mdx index 41efc800..36d4a711 100644 --- a/docs/troubleshooting/sso.mdx +++ b/docs/troubleshooting/sso.mdx @@ -62,7 +62,7 @@ ENABLE_OAUTH_SIGNUP=true ``` ✅ Solutions: -- **Always reference the official [environment configuration documentation](https://docs.openwebui.com/getting-started/env-configuration/)** for exact variable names +- **Always reference the official [environment configuration documentation](https://docs.openwebui.com/reference/env-configuration/)** for exact variable names - Double-check your deployment environment: - Ensure all required environment variables are set exactly as documented - If self-hosting, confirm these variables are present in your Docker Compose, Kubernetes manifest, or `.env` file diff --git a/docs/troubleshooting/web-search.mdx b/docs/troubleshooting/web-search.mdx index 1738ec9f..b2e963e3 100644 --- a/docs/troubleshooting/web-search.mdx +++ b/docs/troubleshooting/web-search.mdx @@ -23,7 +23,7 @@ This happens because the web content fetcher doesn't use your `http_proxy`/`http 2. Enable **Trust Proxy Environment** 3. Save changes -Alternatively, set the environment variable [`WEB_SEARCH_TRUST_ENV`](../getting-started/env-configuration#web_search_trust_env): +Alternatively, set the environment variable [`WEB_SEARCH_TRUST_ENV`](/reference/env-configuration#web_search_trust_env): ```bash WEB_SEARCH_TRUST_ENV=True @@ -90,7 +90,7 @@ If web searches are timing out: ## Environment Variables Reference -For a comprehensive list of all web search environment variables, see the [Environment Configuration documentation](../getting-started/env-configuration#web-search). +For a comprehensive list of all web search environment variables, see the [Environment Configuration documentation](/reference/env-configuration#web-search). Key variables: @@ -111,4 +111,4 @@ If you're still experiencing problems: 1. Check the Open WebUI logs for detailed error messages 2. Verify your search engine configuration is correct 3. Test connectivity from the Open WebUI container to your search engine -4. Review all [Web Search environment variables](../getting-started/env-configuration#web-search) for additional configuration options +4. Review all [Web Search environment variables](/reference/env-configuration#web-search) for additional configuration options diff --git a/docs/tutorials/https/caddy.md b/docs/tutorials/https/caddy.md index b1431a15..8d2a39d3 100644 --- a/docs/tutorials/https/caddy.md +++ b/docs/tutorials/https/caddy.md @@ -56,7 +56,7 @@ cd ~/open-webui ### Installing OpenWebUI -Create a `docker-compose.yml` file in the `~/open-webui` directory. I've left in a commented section for setting some environment varibles for Qdrant, but you can follow that for any other [environment variables](https://docs.openwebui.com/getting-started/env-configuration) you might need to set. +Create a `docker-compose.yml` file in the `~/open-webui` directory. I've left in a commented section for setting some environment varibles for Qdrant, but you can follow that for any other [environment variables](https://docs.openwebui.com/reference/env-configuration) you might need to set. ```yaml services: diff --git a/docs/tutorials/integrations/auth-identity/dual-oauth-configuration.mdx b/docs/tutorials/integrations/auth-identity/dual-oauth-configuration.mdx index 96f148aa..e7ce2eea 100644 --- a/docs/tutorials/integrations/auth-identity/dual-oauth-configuration.mdx +++ b/docs/tutorials/integrations/auth-identity/dual-oauth-configuration.mdx @@ -1,5 +1,4 @@ --- -slug: /tutorials/tips/dual-oauth-configuration title: "Dual OAuth Setup" sidebar_label: Dual OAuth Configuration sidebar_position: 100 diff --git a/docs/tutorials/integrations/auth-identity/entra-group-name-sync.md b/docs/tutorials/integrations/auth-identity/entra-group-name-sync.md index 26ac2c04..5c1fdaf9 100644 --- a/docs/tutorials/integrations/auth-identity/entra-group-name-sync.md +++ b/docs/tutorials/integrations/auth-identity/entra-group-name-sync.md @@ -17,7 +17,7 @@ This tutorial explains how to configure Microsoft Entra ID to return group **nam ## Prerequisites -- An Open WebUI instance configured with [Microsoft OAuth](/features/auth/sso#microsoft) +- An Open WebUI instance configured with [Microsoft OAuth](/features/access-security/auth/sso#microsoft) - An Azure account with permissions to modify App Registrations - Access to the Microsoft Entra admin center - Basic understanding of Microsoft Entra ID application configuration @@ -30,7 +30,7 @@ To get human-readable group names in Open WebUI, you need to: 2. Modify the application manifest to use `cloud_displayname` 3. Set `groupMembershipClaims` to `ApplicationGroup` only 4. Assign security groups to the Enterprise Application -5. Configure Open WebUI environment variables for [OAuth Group Management](/features/auth/sso#oauth-group-management) +5. Configure Open WebUI environment variables for [OAuth Group Management](/features/access-security/auth/sso#oauth-group-management) :::info Key Requirement @@ -140,7 +140,7 @@ Ensure your App Registration has the required Microsoft Graph permissions: ## Step 5: Configure Open WebUI Environment Variables -Configure the following environment variables for your Open WebUI deployment. For more details on each variable, see the [environment variable documentation](/getting-started/env-configuration). +Configure the following environment variables for your Open WebUI deployment. For more details on each variable, see the [environment variable documentation](/reference/env-configuration). ```bash # Required: Your public WebUI address @@ -201,9 +201,9 @@ Admin users' group memberships are **not** automatically updated via OAuth group ## Additional Resources -- [SSO (OAuth, OIDC, Trusted Header)](/features/auth/sso) - OAuth configuration overview -- [OAuth Group Management](/features/auth/sso#oauth-group-management) - Group synchronization details -- [Groups](/features/rbac/groups) - Group management in Open WebUI +- [SSO (OAuth, OIDC, Trusted Header)](/features/access-security/auth/sso) - OAuth configuration overview +- [OAuth Group Management](/features/access-security/auth/sso#oauth-group-management) - Group synchronization details +- [Groups](/features/access-security/rbac/groups) - Group management in Open WebUI - [SSO Troubleshooting Guide](/troubleshooting/sso) - Common OAuth issues and solutions -- [Environment Configuration](/getting-started/env-configuration) - All environment variables +- [Environment Configuration](/reference/env-configuration) - All environment variables - [Microsoft Optional Claims Documentation](https://learn.microsoft.com/en-us/entra/identity-platform/optional-claims) - Microsoft's official documentation diff --git a/docs/tutorials/integrations/auth-identity/okta-oidc-sso.md b/docs/tutorials/integrations/auth-identity/okta-oidc-sso.md index f5f2e375..8cd36e68 100644 --- a/docs/tutorials/integrations/auth-identity/okta-oidc-sso.md +++ b/docs/tutorials/integrations/auth-identity/okta-oidc-sso.md @@ -214,5 +214,5 @@ Restart your Open WebUI instance after setting these environment variables. * **Groups Not Syncing:** Verify that the `OAUTH_GROUP_CLAIM` environment variable matches the claim name configured in the Okta ID Token settings. Ensure the user has logged out and back in after group changes - a login flow is required to update OIDC. Remember admin groups are not synced. * **Configuration Errors:** Review the Open WebUI server logs for detailed error messages related to OIDC configuration. -* Refer to the official [Open WebUI SSO Documentation](/features/auth/sso). +* Refer to the official [Open WebUI SSO Documentation](/features/access-security/auth/sso). * Consult the [Okta Developer Documentation](https://developer.okta.com/docs/). diff --git a/docs/tutorials/integrations/dev-tools/browser-search-engine.md b/docs/tutorials/integrations/dev-tools/browser-search-engine.md index 173a6519..686a7b6c 100644 --- a/docs/tutorials/integrations/dev-tools/browser-search-engine.md +++ b/docs/tutorials/integrations/dev-tools/browser-search-engine.md @@ -20,7 +20,7 @@ Open WebUI allows you to integrate directly into your web browser. This tutorial Before you begin, ensure that: - You have Chrome or another supported browser installed. -- The `WEBUI_URL` environment variable is set correctly, either using Docker environment variables or in the `.env` file as specified in the [Getting Started](https://docs.openwebui.com/getting-started/env-configuration) guide. +- The `WEBUI_URL` environment variable is set correctly, either using Docker environment variables or in the `.env` file as specified in the [Getting Started](https://docs.openwebui.com/reference/env-configuration) guide. ### Step 1: Set the WEBUI_URL Environment Variable diff --git a/docs/tutorials/integrations/dev-tools/continue-dev.md b/docs/tutorials/integrations/dev-tools/continue-dev.md index bd8fdd5f..65f61005 100644 --- a/docs/tutorials/integrations/dev-tools/continue-dev.md +++ b/docs/tutorials/integrations/dev-tools/continue-dev.md @@ -153,7 +153,7 @@ env: This is a crucial step: you need to direct the continue.dev extension requests to your Open WebUI instance. Either use an actual domain name if the instance is hosted somewhere (e.g., `https://example.com/api`) or your localhost setup (e.g., `http://localhost:3000/api`). -You can find more information about the URLs in the [API Endpoints guide](/getting-started/api-endpoints). +You can find more information about the URLs in the [API Endpoints guide](/reference/api-endpoints). ```yaml apiBase: http://localhost:3000/api @@ -164,7 +164,7 @@ apiBase: http://localhost:3000/api ### API Key To authenticate with your Open WebUI instance, you'll need to generate an API key. -Follow the instructions in [this guide](https://docs.openwebui.com/getting-started/advanced-topics/monitoring#authentication-setup-for-api-key-) to create it. +Follow the instructions in [this guide](https://docs.openwebui.com/reference/monitoring#authentication-setup-for-api-key-) to create it. ```yaml apiKey: YOUR_OPEN_WEBUI_API_KEY diff --git a/docs/tutorials/integrations/dev-tools/firefox-sidebar.md b/docs/tutorials/integrations/dev-tools/firefox-sidebar.md index 72d0b706..b7fa38f6 100644 --- a/docs/tutorials/integrations/dev-tools/firefox-sidebar.md +++ b/docs/tutorials/integrations/dev-tools/firefox-sidebar.md @@ -84,7 +84,7 @@ The following URL parameters can be used to customize your Open WebUI instance: - `temporary-chat`: Mark the chat as a temporary session by setting this parameter to `true` (e.g., `/?temporary-chat=true`) - *Note: Document processing is frontend-only in temporary chats. Complex files requiring backend parsing may not work.* -See https://docs.openwebui.com/features/chat-features/url-params for more info on URL parameters and how to use them. +See https://docs.openwebui.com/features/chat-conversations/chat-features/url-params for more info on URL parameters and how to use them. ## Additional about:config Settings diff --git a/docs/tutorials/integrations/dev-tools/iterm2.md b/docs/tutorials/integrations/dev-tools/iterm2.md index 55e94854..6355e6f4 100644 --- a/docs/tutorials/integrations/dev-tools/iterm2.md +++ b/docs/tutorials/integrations/dev-tools/iterm2.md @@ -18,7 +18,7 @@ Whenever you forget a command or need a quick bash script for a repetitive task, ## Why connect to your Open WebUI instance? -Open WebUI provides a simple and straightforward way to interact with your LLMs via its [API Endpoints](/getting-started/api-endpoints). This is particularly beneficial if you are running your own LLMs locally. Furthermore, you can leverage all your implemented features, monitoring, and other capabilities. +Open WebUI provides a simple and straightforward way to interact with your LLMs via its [API Endpoints](/reference/api-endpoints). This is particularly beneficial if you are running your own LLMs locally. Furthermore, you can leverage all your implemented features, monitoring, and other capabilities. ## Prerequisites @@ -30,7 +30,7 @@ Unzip the file and move the application into your **Applications** folder. ### 2. Generate your Open WebUI API key To authenticate with your Open WebUI instance, you'll need to generate an API key. -Follow the instructions in [this guide](https://docs.openwebui.com/getting-started/advanced-topics/monitoring#authentication-setup-for-api-key-) to create it. +Follow the instructions in [this guide](https://docs.openwebui.com/reference/monitoring#authentication-setup-for-api-key-) to create it. ## Configuration @@ -92,7 +92,7 @@ Set your preferred amount of tokens here. Typically, your inference tool will al This is a crucial step: you need to direct the iTerm2 AI plugin requests to your Open WebUI instance. Either use an actual domain name if the instance is hosted somewhere (e.g., `https://example.com/api/chat/completions`) or your localhost setup (e.g., `http://localhost:8080/api/chat/completions`). -You can find more information about the URLs in the [API Endpoints guide](/getting-started/api-endpoints). +You can find more information about the URLs in the [API Endpoints guide](/reference/api-endpoints). --- diff --git a/docs/tutorials/integrations/dev-tools/jupyter.md b/docs/tutorials/integrations/dev-tools/jupyter.md index b99ea5e9..da0310bc 100644 --- a/docs/tutorials/integrations/dev-tools/jupyter.md +++ b/docs/tutorials/integrations/dev-tools/jupyter.md @@ -1,5 +1,4 @@ --- -slug: /tutorials/integrations/jupyter sidebar_position: 321 title: "Jupyter Notebook Integration" --- diff --git a/docs/tutorials/integrations/redis.md b/docs/tutorials/integrations/redis.md index 7bdde626..afd199aa 100644 --- a/docs/tutorials/integrations/redis.md +++ b/docs/tutorials/integrations/redis.md @@ -625,7 +625,7 @@ REDIS_KEY_PREFIX="openwebui-dev" - [Redis Documentation](https://redis.io/docs) - [Valkey Documentation](https://valkey.io/docs/) - [Docker Compose Documentation](https://docs.docker.com/compose/overview/) -- [Open WebUI Environment Variables](https://docs.openwebui.com/getting-started/env-configuration/) +- [Open WebUI Environment Variables](https://docs.openwebui.com/reference/env-configuration/) - [sysctl Documentation](https://man7.org/linux/man-pages/man8/sysctl.8.html) ### Getting Help diff --git a/docs/tutorials/maintenance/offline-mode.mdx b/docs/tutorials/maintenance/offline-mode.mdx index 5d957e4c..b3a4a8fe 100644 --- a/docs/tutorials/maintenance/offline-mode.mdx +++ b/docs/tutorials/maintenance/offline-mode.mdx @@ -1,5 +1,4 @@ --- -slug: /tutorials/offline-mode sidebar_position: 300 title: "Offline Mode" --- @@ -78,7 +77,7 @@ Consider if you need to start the application offline from the beginning of your ### I: Speech-To-Text -The local `whisper` installation does not include the model by default. In this regard, you can follow the [guide](/features/audio/speech-to-text/stt-config) only partially if you want to use an external model/provider. To use the local `whisper` application, you must first download the model of your choice (e.g. [Huggingface - Systran](https://huggingface.co/Systran)). +The local `whisper` installation does not include the model by default. In this regard, you can follow the [guide](/features/media-generation/audio/speech-to-text/stt-config) only partially if you want to use an external model/provider. To use the local `whisper` application, you must first download the model of your choice (e.g. [Huggingface - Systran](https://huggingface.co/Systran)). ```python from faster_whisper import WhisperModel @@ -93,7 +92,7 @@ faster_whisper_kwargs = { WhisperModel(**faster_whisper_kwargs) ``` -The contents of the download directory must be copied to `/app/backend/data/cache/whisper/models/` within your Open WebUI deployment. It makes sense to directly declare your `whisper` model via the [environment variable](https://docs.openwebui.com/getting-started/env-configuration#whisper_model), like this: `WHISPER_MODEL=Systran/faster-whisper-large-v3`. +The contents of the download directory must be copied to `/app/backend/data/cache/whisper/models/` within your Open WebUI deployment. It makes sense to directly declare your `whisper` model via the [environment variable](https://docs.openwebui.com/reference/env-configuration#whisper_model), like this: `WHISPER_MODEL=Systran/faster-whisper-large-v3`. ### I: Text-To-Speech @@ -101,7 +100,7 @@ The default local transformer can already handle the text-to-speech function. If ### I: Embedding Model -For various purposes, you will need an embedding model (e.g. [RAG](/features/rag)). You will first have to download such a model of your choice (e.g. [Huggingface - sentence-transformers](https://huggingface.co/sentence-transformers)). +For various purposes, you will need an embedding model (e.g. [RAG](/features/chat-conversations/rag)). You will first have to download such a model of your choice (e.g. [Huggingface - sentence-transformers](https://huggingface.co/sentence-transformers)). ```python from huggingface_hub import snapshot_download @@ -109,7 +108,7 @@ from huggingface_hub import snapshot_download snapshot_download(repo_id="sentence-transformers/all-MiniLM-L6-v2", cache_dir="/path/of/your/choice") ``` -The contents of the download directory must be copied to `/app/backend/data/cache/embedding/models/` within your Open WebUI deployment. It makes sense to directly declare your embedding model via the [environment variable](https://docs.openwebui.com/getting-started/env-configuration#rag_embedding_model), like this: `RAG_EMBEDDING_MODEL=sentence-transformers/all-MiniLM-L6-v2`. +The contents of the download directory must be copied to `/app/backend/data/cache/embedding/models/` within your Open WebUI deployment. It makes sense to directly declare your embedding model via the [environment variable](https://docs.openwebui.com/reference/env-configuration#rag_embedding_model), like this: `RAG_EMBEDDING_MODEL=sentence-transformers/all-MiniLM-L6-v2`. ## Approach II diff --git a/docs/tutorials/maintenance/s3-storage.md b/docs/tutorials/maintenance/s3-storage.md index ad5844ec..d79a0b7d 100644 --- a/docs/tutorials/maintenance/s3-storage.md +++ b/docs/tutorials/maintenance/s3-storage.md @@ -52,7 +52,7 @@ In order to configure this option, you need to gather the following environment For a complete list of the available S3 endpoint URLs, see: [Amazon S3 Regular Endpoints](https://docs.aws.amazon.com/general/latest/gr/s3.html) -See all the `Cloud Storage` configuration options in the [Open-WebUI Cloud Storage Config](https://docs.openwebui.com/getting-started/env-configuration#cloud-storage) documentation. +See all the `Cloud Storage` configuration options in the [Open-WebUI Cloud Storage Config](https://docs.openwebui.com/reference/env-configuration#cloud-storage) documentation. ## 2. Run Open-WebUI diff --git a/docs/tutorials/tips/sqlite-database.md b/docs/tutorials/tips/sqlite-database.md index 34fa28a8..818bd174 100644 --- a/docs/tutorials/tips/sqlite-database.md +++ b/docs/tutorials/tips/sqlite-database.md @@ -895,5 +895,5 @@ To use SQLCipher with existing data, you must either: | `DATABASE_POOL_TIMEOUT` | `30` | Pool connection timeout in seconds | | `DATABASE_POOL_RECYCLE` | `3600` | Pool connection recycle time in seconds | -For more details, see the [Environment Variable Configuration](/getting-started/env-configuration) documentation. +For more details, see the [Environment Variable Configuration](/reference/env-configuration) documentation.