Commit Graph

2577 Commits

Author SHA1 Message Date
Georgios Papagiannis 00b6886b99 docs: add Optional Security Headers via Reverse Proxy section to Caddy guide
Purely additive section in docs/reference/https/caddy.md for operators who
run Open WebUI behind a shared reverse proxy or managed hosting without
app-layer env-var access. Includes a single-layer-only warning (duplicate
headers), the five unambiguous headers with an HSTS caveat, and a pointer to
the hardening docs; CSP is intentionally left to the CONTENT_SECURITY_POLICY
env var.
2026-06-05 17:43:34 +02:00
Classic298 77bf6554ab Merge dev into main
Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
2026-06-03 23:45:47 +02:00
Classic298 969e0b33fc docs: oikb feature, kb_exec recommendation, RAG guide cleanup
- Promote oikb to a standalone "Knowledge Base Sync" feature
  (features/knowledge-base-sync/), move it out of workspace/, and
  cross-link it from Knowledge, the Features index and the OpenAPI
  tool-servers guide. Add large-corpus guidance (prefer oikb over the
  in-app Sync Directory at scale).
- Recommend ENABLE_KB_EXEC for an enhanced agentic RAG experience in
  the env reference, beginner essentials, RAG guide, RAG
  troubleshooting and Knowledge. Add a "guiding tool choice across
  mixed knowledge bases" section (kb_exec vs query_knowledge_files via
  a system prompt).
- Stop recommending RAG_SYSTEM_CONTEXT: drop the KV-cache tip from the
  performance and RAG guides and neutralise the env reference.
- Convert the Redis tutorial to actually use Redis (was Valkey
  throughout) and add a separate Valkey tutorial for those who want it.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
2026-06-03 23:41:32 +02:00
Classic298 46220422a3 docs: add curated-interface deployment pattern; fix broken MCP integration link
Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
2026-06-03 19:51:22 +02:00
Classic298 84fc24a417 docs: document native function calling env-var config
Clarify that Native (Agentic) Mode is configured via the Admin Panel (recommended) and, for env-var-managed instances, via the `function_calling` key inside `DEFAULT_MODEL_PARAMS`. Explicitly note there is no standalone `FUNCTION_CALLING_MODE` variable, a common misconception. Adds a notice to the central tools guide and a pointer from the agentic-search page.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
2026-06-03 19:30:06 +02:00
Classic298 e49c2a82d7 Update performance.md 2026-06-02 15:19:49 +02:00
Vedmaka 0539465741 Fixes typo in SSO docs page (ENABLE_OAUTH_PERSISTENT_CONFIG)
The `ENABLE_OAUTH_PERSISTENT_CONFIG` is `False` by default (https://github.com/open-webui/open-webui/blob/02dc3e689ceac915a870b373318b99c029ddf603/backend/open_webui/config.py#L143), but the documentation page says otherwise in the "Critical Configuration Notes" section (also contradicting the variable tables above that say the default is `False`)
2026-06-02 14:26:24 +02:00
Timothy Jaeryang Baek 8ddad90616 refac 2026-06-01 15:46:08 -07:00
Classic298 554b1bea2b Merge branch 'open-webui:dev' into dev 2026-06-02 00:16:48 +02:00
Classic298 8493fd452c getting-started: drop broken #docker anchor in Python compat note
The Python tab linked [Docker image](#docker), but the page's Docker content is
a TabItem with no heading anchor, so the Docusaurus build flagged it. Made it
plain emphasis instead.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
2026-06-02 00:14:40 +02:00
Classic298 c092196184 Merge pull request #1251 from Classic298/dev
Dev
2026-06-02 00:06:23 +02:00
Classic298 7c635e0da8 0.9.6 2026-06-01 23:49:54 +02:00
Classic298 8ea49373ad env-configuration: OAUTH_ALLOWED_ROLES supports * wildcard
Upstream 07cbc91: a `*` entry matches any role (allowed-roles path only).

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
2026-06-01 19:22:02 +02:00
Classic298 305b4a6b92 knowledge: list_knowledge is now lazy and paginated
Built-in tool change (upstream 0e73f7a / PR #25105): returns KB summaries by
default; pass knowledge_id with skip/count (max 200) to page one KB's files.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
2026-06-01 19:22:02 +02:00
Classic298 aaaec164e2 env-configuration: document PROFILE_IMAGE_MAX_DATA_URI_SIZE
New env var (upstream PR #25476 / 83890f1). Caps the byte length of inline
data:image base64 profile images (user avatars + model icons) to bound
Postgres/Redis bloat; unset by default (no cap), startup-only.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
2026-06-01 19:00:41 +02:00
Classic298 e1aa846d4c env-configuration: document BYPASS_RETRIEVAL_ACCESS_CONTROL
New env var (upstream ee47c9c). RAG retrieval now verifies the user can read a
file/collection before searching its vectors; this flag (default False) only
restores the old permissive behavior. Default is correct for essentially all
deployments.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
2026-06-01 18:53:09 +02:00
Classic298 8eefa86020 env-configuration: document MINERU_FILE_EXTENSIONS
New ConfigVar (upstream d4030a8a) — MinerU was hardcoded to PDF only; admins
can now route additional extensions (default `pdf`) to the MinerU extraction
engine via env var, the RAG config API, or the Documents admin settings.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
2026-06-01 00:26:44 +02:00
Classic298 c0fd8e06ab Merge pull request #1273 from xuyua9/devb/grafana-otel-compose
docs: make Grafana OTEL quick start runnable
2026-06-01 00:05:03 +02:00
Classic298 aad8537793 Merge pull request #1275 from xuyua9/docs/mcp-tools-api-xuyua9
docs: clarify MCP tools in chat API
2026-05-31 23:54:50 +02:00
Classic298 77af53ce88 Update env-configuration.mdx 2026-05-31 23:14:10 +02:00
Classic298 35498b69ca Merge pull request #1277 from open-webui/main
sync
2026-05-31 23:08:18 +02:00
Classic298 425d3ed620 Update context-window.mdx 2026-05-31 23:07:39 +02:00
xuyua9 0310a00b9a docs: clarify MCP tools in chat API 2026-05-31 23:54:55 +08:00
xuyua9 54cef99507 docs: make Grafana OTEL quick start runnable 2026-05-31 22:29:11 +08:00
Classic298 5216c27f08 Update env-configuration.mdx 2026-05-31 15:04:23 +02:00
Classic298 fb5272bdab Merge branch 'dev' into dev 2026-05-31 15:03:36 +02:00
Timothy Jaeryang Baek 317faf53a7 refac 2026-05-30 21:53:20 -05:00
Classic298 adcadb039d oikb: document the official Knowledge Base sync tool (0.9.6+)
New Workspace page introducing oikb (open-webui/oikb), the official companion
CLI/daemon that mirrors external sources into Knowledge Bases via the v0.9.6
incremental /sync/diff + /sync/cleanup endpoints. Covers quick start, the 44
connectors, exposing the daemon as an OpenAPI tool server, and how the sync
loop maps to the server-side endpoints. Cross-linked from the Knowledge sync
section. Corrects the tool-server location (External Tools / Settings → Tools,
not Settings → Connections).

Co-Authored-By: Claude Opus 4.7 <noreply@anthropic.com>
2026-05-30 15:31:53 +02:00
Classic298 82201a4ba3 Update redis.md 2026-05-29 11:28:33 +02:00
Classic298 551810d62c Update performance.md 2026-05-29 11:28:11 +02:00
Classic298 b3574bd363 Update env-configuration.mdx 2026-05-29 11:27:41 +02:00
Classic298 eb0e9e8182 Update scaling.md 2026-05-29 11:27:19 +02:00
Classic298 2d7b43e965 mcp: document MCP servers are admin-only by design (vs per-user OpenAPI)
Per-user MCP servers are deliberately not supported (issue #24620 closed as
intended): an MCP server is a stateful, capability-rich endpoint running inside
the trust boundary with the user's full scope, unlike a stateless OpenAPI URL.
Adds a dedicated section + FAQ entry explaining the admin-only design and why.

Co-Authored-By: Claude Opus 4.7 <noreply@anthropic.com>
2026-05-28 23:49:57 +02:00
Classic298 995b285077 Merge pull request #1269 from thatrobotdev/fix-hybrid-search-description
Generalize `ENABLE_RAG_HYBRID_SEARCH` description
2026-05-28 22:26:09 +02:00
Classic298 c2b60951d9 extensibility index: async backend makes pipelines-for-heavy-work obsolete; redirect to in-process or external tool servers 2026-05-28 20:29:53 +02:00
Classic298 45db3e3000 pipelines legacy warning: reference both pipe and filter replacements 2026-05-28 20:22:55 +02:00
Classic298 8921d63efd mark Pipelines legacy across all pipelines pages; drop from decision table 2026-05-28 20:20:13 +02:00
Classic298 251e20069d tools taxonomy: external tool servers, workspace tools power, open terminal info block 2026-05-28 20:11:54 +02:00
Classic298 93f1352031 add which-extension-do-i-need decision guide + pipe/pipeline disambiguation 2026-05-28 20:09:34 +02:00
James Kerrane f229df6c7e Generalize ENABLE_RAG_HYBRID_SEARCH description
Updates the ENV configuration description for `ENABLE_RAG_HYBRID_SEARCH`:
- Change "ensemble search" to "hybrid search" to match env variable name
- Generalize "ChromaDB" to "configured vector store" since hybrid search is not ChromaDB specific
- Generalize `sentence_transformers` since hybrid search works on more than just the default `sentence_transformers` models.
- Since reranking is optional (the code passes `reranking_function=None` when `RERANKING_FUNCTION` isn't configured), and it can be any encoder (not just `sentence_transformers`, generalizes reference.
2026-05-28 12:07:40 -06:00
Classic298 20f82c699b explain where payload-request data comes from 2026-05-28 19:56:21 +02:00
Classic298 06e59779af Update banners.md 2026-05-28 12:02:15 +02:00
Classic298 1128ccb91d swap default/recommended columns 2026-05-27 23:51:51 +02:00
Classic298 1fa8babf71 external tool events: no credential forwarding, use admin key 2026-05-27 23:19:42 +02:00
Classic298 868fce74cf clarify window.args injection requirements 2026-05-27 19:33:38 +02:00
Classic298 d342b50d71 python compat 2026-05-27 19:15:15 +02:00
Classic298 e1a8ebcbd6 fix 2026-05-27 00:05:36 +02:00
Classic298 8b8f26f536 plugins 2026-05-26 23:58:40 +02:00
Turrabo fca21455a1 fix: add __metadata__ fields and __event_emitter__ custom types
Adds user_prompt, system_prompt, sources to the __metadata__ example.
Expands __event_emitter__ to cover custom type forwarding through socket.io.
2026-05-25 08:23:11 +01:00
Classic298 08f071a798 Merge pull request #1264 from thatrobotdev/update-offline-mode-docs
Fix minor grammar/style errors in offline-mode.mdx
2026-05-21 20:57:37 +02:00