From 741a575d6216ddb8a566e2d64ee9a7b24061f9dc Mon Sep 17 00:00:00 2001 From: rohoswagger Date: Fri, 27 Mar 2026 15:48:36 -0700 Subject: [PATCH] docs: add include-citations attribute and update CDN to v1.1 - Add include-citations to configuration reference in both overview and deployment docs - Add warning about private document access when citations are enabled - Update CDN URLs from widget/1.0 to widget/1.1 - Add Source Citations to features list - Add include-citations to full customization example --- deployment/configuration/website_widget.mdx | 26 ++++++++++++++++++++- overview/onyx_anywhere/website_widget.mdx | 13 ++++++++++- 2 files changed, 37 insertions(+), 2 deletions(-) diff --git a/deployment/configuration/website_widget.mdx b/deployment/configuration/website_widget.mdx index ad4ae39b..88e8b322 100644 --- a/deployment/configuration/website_widget.mdx +++ b/deployment/configuration/website_widget.mdx @@ -22,7 +22,7 @@ For Onyx Cloud users, the widget is served from Onyx's CDN. Simply add the follo ```html - + + +``` + + + **Be mindful of document access when enabling citations.** The widget will cite any documents accessible to the + configured agent or API key. If the agent has access to private or internal documents, + citation links may point to resources that end users do not have permission to view. + + To avoid exposing private document links, either scope the agent's document access to only public-facing sources, + or disable citations for public-facing widget deployments. + ## API Key Security diff --git a/overview/onyx_anywhere/website_widget.mdx b/overview/onyx_anywhere/website_widget.mdx index 69fa4b0e..6aa5b983 100644 --- a/overview/onyx_anywhere/website_widget.mdx +++ b/overview/onyx_anywhere/website_widget.mdx @@ -21,6 +21,7 @@ providing your visitors instant access to AI-powered conversations without leavi - **Real-time Streaming** - Server-sent events (SSE) for fast responses - **Session Persistence** - Conversations survive page reloads - **Two Display Modes** - Floating launcher or inline embed +- **Source Citations** - Optional citation badges linking to source documents ## Quick Start @@ -28,7 +29,7 @@ Add these few lines to your website: ```html - + + **Citations and private documents:** When `include-citations` is enabled, + the widget will cite any documents accessible to the configured agent or API key. + If the agent has access to private or internal documents, + citation links may point to resources that end users cannot view. Scope the agent's document access appropriately, + or disable citations for public-facing deployments with sensitive sources. + ### Configuration Examples @@ -122,6 +132,7 @@ The widget embeds directly in your page layout. Perfect for dedicated support pa background-color="#FFFFFF" text-color="#1A1A1A" mode="launcher" + include-citations="true" > ```