diff --git a/README.md b/README.md index 3e3b54b88..f2b3969ce 100644 --- a/README.md +++ b/README.md @@ -5,48 +5,41 @@ [![Discord](https://img.shields.io/badge/Discord-Letta-blue?logo=discord&logoColor=white)](https://discord.gg/letta) [![Documentation](https://img.shields.io/badge/docs-letta.com-blue)](https://docs.letta.com) -**A feature-rich, self-hosted chat interface specifically designed for Letta agents.** This fork includes native Letta OAuth integration, multi-project agent management, and optimized support for Letta's stateful memory features. +**A feature-rich chat interface specifically designed for Letta agents on [Letta Developer Platform](https://app.letta.com).** This fork includes native Letta OAuth integration, multi-project agent management, and optimized support for Letta's stateful memory features. + +> **⚠️ Important:** This chat interface only works with [Letta Developer Platform](https://app.letta.com). It does **not** support self-hosted Letta instances. ## What Makes This Different from Open WebUI? -This fork is specifically tailored for Letta: +This fork is specifically tailored for **Letta Developer Platform**: -- **🔐 Native Letta OAuth Integration**: Seamless login with your Letta account, automatic token management +- **🔐 Native Letta OAuth Integration**: Seamless login with your [Letta Developer Platform](https://app.letta.com) account - **🗂️ Multi-Project Support**: Browse and switch between all your Letta projects and agents - **🔄 Stateful Agent Sessions**: Proper support for Letta's memory and conversation state - **⚡ Function/Pipe Model Support**: Dynamically loaded agents without database configuration -- **🎯 Optimized for Letta**: Custom configurations and improvements for Letta-specific features - -## Quick Start with Letta 🚀 +- **🎯 Optimized for Letta Platform**: Custom configurations for Letta Developer Platform features -### Prerequisites -- A [Letta account](https://app.letta.com) (free to create) -- Docker installed on your machine +## Using Letta Chat 🚀 -### Run with Docker +This application is deployed and managed by the Letta team at **[chat.letta.com](https://chat.letta.com)** (or your organization's deployment). -```bash -docker run -d -p 3000:8080 \ - -e LETTA_CLIENT_ID=your-client-id \ - -e ENABLE_OAUTH_SIGNUP=true \ - -e DEFAULT_USER_ROLE=user \ - -v open-webui:/app/backend/data \ - --name letta-chat \ - --restart always \ - ghcr.io/letta-ai/chat.letta.com:main -``` +### Getting Started +1. Visit your Letta Chat deployment URL +2. Click **"Continue with Letta"** +3. Login with your [Letta Developer Platform](https://app.letta.com) account +4. Select a project and start chatting with your agents! -Then open http://localhost:3000 and click **"Continue with Letta"** to login! +### For Letta Team / Deployment -### Configuration +The application requires official Letta OAuth credentials: -Key environment variables for Letta integration: - -- `LETTA_CLIENT_ID`: Your Letta OAuth client ID -- `LETTA_BASE_URL`: Letta API URL (default: `https://api.letta.com`) +- `LETTA_CLIENT_ID`: Official Letta OAuth client ID (managed by Letta team) +- `LETTA_BASE_URL`: Fixed to `https://api.letta.com` (Letta Developer Platform) - `DEFAULT_USER_ROLE`: Set to `user` to auto-approve OAuth signups - `ENABLE_OAUTH_SIGNUP`: Enable OAuth-based user registration +**Important:** OAuth integration requires official Letta Developer Platform authentication. Self-hosted Letta deployments are not supported. + ## Features Specific to This Fork - **Project Selector**: Switch between your Letta projects in the model dropdown @@ -124,21 +117,26 @@ Want to learn more about Open WebUI's features? Check out our [Open WebUI docume ## About This Fork -This repository is maintained by the [Letta](https://letta.com) team as a customized chat interface for Letta agents. We regularly sync with upstream [Open WebUI](https://github.com/open-webui/open-webui) to incorporate new features and improvements. +This repository is maintained by the [Letta](https://letta.com) team as a customized chat interface for **Letta Developer Platform** agents. We regularly sync with upstream [Open WebUI](https://github.com/open-webui/open-webui) to incorporate new features and improvements. **Key differences from upstream:** -- Native Letta OAuth integration -- Multi-project agent management +- Native Letta Developer Platform OAuth integration +- Multi-project agent management for Letta Platform - Function/pipe model filtering optimizations - Letta-specific UI customizations +**Important limitations:** +- ⚠️ Only works with [Letta Developer Platform](https://app.letta.com) +- ❌ Does **not** support self-hosted Letta instances +- 🔐 Requires official Letta OAuth credentials (managed by Letta team) + For general Open WebUI questions, please refer to the [upstream documentation](https://docs.openwebui.com). For Letta-specific issues, visit our [Discord](https://discord.gg/letta) or [documentation](https://docs.letta.com). -## Installation Options 🚀 +## General Installation Reference 🚀 -> **Note:** For Letta-specific setup, see the [Quick Start with Letta](#quick-start-with-letta-) section above. +> **Note:** This application is deployed and managed by the Letta team. The following Open WebUI installation methods are provided for reference but require official Letta OAuth credentials to function with Letta Developer Platform. -The following are general Open WebUI installation methods that also work with this fork: +The following are general Open WebUI installation methods: ### Installation via Python pip 🐍