Merged
Conversation
- outlet() for /api/chat/completions runs inline only for non-streaming API requests today; streaming support is not yet there. Update the filter reference, filter tutorial, and API endpoints page to reflect this and stop over-promising inline outlet for all API traffic. - Expand the Disk I/O Latency section with concrete NFS/SMB/Azure Files guidance: recommend moving webui.db to local disk, migrating to PostgreSQL, or (as a workaround) DATABASE_POOL_SIZE=1 plus DATABASE_SQLITE_PRAGMA_BUSY_TIMEOUT=30000. https://claude.ai/code/session_01K54Vwr1NMczgh9vmQkWe17
Strengthen the NFS/SQLite guidance to state plainly that the only officially supported configurations are PostgreSQL or SQLite on directly-attached SSD/NVMe. NFS, SMB, Azure Files, CephFS, network PVCs, and any other remote / low-IOPS storage are explicitly not recommended for SQLite. Anything other than local SSD should use PostgreSQL. https://claude.ai/code/session_01K54Vwr1NMczgh9vmQkWe17
Make it explicit that SQLite over NFS/SMB/network filesystems being unsupported is a stance from the SQLite project itself (SQLite FAQ #5), not an Open WebUI policy. Open WebUI inherits the constraint because it uses SQLite — and database corruption risk on those filesystems is also called out by SQLite upstream. https://claude.ai/code/session_01K54Vwr1NMczgh9vmQkWe17
…vior Previous revisions of the outlet documentation overstated inline execution during /api/chat/completions. Based on a line-level audit of backend/open_webui/utils/middleware.py (dev 493f2384 and main 9bd84258): - On main (and any release cut from it), /api/chat/completions does not invoke outlet() at all. /api/chat/completed remains the only path. - On dev, outlet() can fire inline but only when chat_id AND id are both present, the chat is owned by the caller, and the request is non-streaming. Even then, the inline handler updates the DB row and emits a chat:outlet WS event but does not rewrite the HTTP response body, so pure API consumers don't see the filtered output over HTTP. - Streaming requests that satisfy the event_emitter gate are designed for WebUI-style clients: the server consumes the stream itself and routes via the user's WebSocket, leaving the HTTP streaming caller with an effectively empty body. Docs now explicitly split the matrix by release, drop the local:<uuid> "synthesize IDs in inlet()" workaround (the ownership check and the unchanged HTTP response body mean it was never the reliable escape hatch it looked like), and point API integrations at /api/chat/completed as the supported surface today. https://claude.ai/code/session_01K54Vwr1NMczgh9vmQkWe17
ℹ️ Documentation PR Guidelines👋 Welcome! This is an automated message posted on all new documentation PRs to help guide our contributors. Just because this comment appeared doesn't mean you have done anything wrong! Please ensure you're using the correct branches: Target branch (where you're merging TO):
Source branch (where you're merging FROM):
If your docs PR depends on a pending PR in open-webui/open-webui:
Please adjust your PR target branch, source branch, and/or draft status accordingly if needed. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
No description provided.