agent/agent-framework
1
0
Fork 0
mirror of https://github.com/microsoft/agent-framework.git synced 2026-06-16 21:04:09 +08:00
Code Issues Packages Projects Releases Wiki Activity

Python: Document ChatKit frontend requirements and air-gapped limitations (#2587)

Browse Source 
- Add "Requirements and Limitations" section to chatkit package README
- Add "Network Requirements" and "Limitations" sections to chatkit-integration sample README
- Add explanatory comments in frontend code for CDN dependency and domain key configuration

Fixes #2347
This commit is contained in:
Victor Dibia
2025-12-03 17:19:14 -08:00
committed by GitHub
Unverified
parent a683c0e865
commit 42ffe59592
4 changed files with 92 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files
python/packages/chatkit/README.md
+31
View File
@@ -20,6 +20,37 @@ pip install agent-framework-chatkit --pre
This will install `agent-framework-core` and `openai-chatkit` as dependencies.
## Requirements and Limitations
### Frontend Requirements
The ChatKit integration requires the OpenAI ChatKit frontend library, which has the following requirements:
1. **Internet Connectivity Required**: The ChatKit UI is loaded from OpenAI's CDN (`cdn.platform.openai.com`). This library cannot be self-hosted or bundled locally.
2. **External Network Requests**: The ChatKit frontend makes requests to:
- `cdn.platform.openai.com` - UI library (required)
- `chatgpt.com/ces/v1/projects/oai/settings` - Configuration
- `api-js.mixpanel.com` - Telemetry (metadata only, not user messages)
3. **Domain Registration for Production**: Production deployments require registering your domain at [platform.openai.com](https://platform.openai.com/settings/organization/security/domain-allowlist) and configuring a domain key.
### Air-Gapped / Regulated Environments
**The ChatKit frontend is not suitable for air-gapped or highly-regulated environments** where outbound connections to OpenAI domains are restricted.
**What IS self-hostable:**
- The backend components (`chatkit-python`, `agent-framework-chatkit`) are fully open source and have no external dependencies
**What is NOT self-hostable:**
- The frontend UI (`chatkit.js`) requires connectivity to OpenAI's CDN
For environments with network restrictions, consider building a custom frontend that consumes the ChatKit server protocol, or using alternative UI libraries like `ai-sdk`.
See [openai/chatkit-js#57](https://github.com/openai/chatkit-js/issues/57) for tracking self-hosting feature requests.
## Example Usage
Here's a minimal example showing how to integrate Agent Framework with ChatKit: