@lobehub/chat

Lobe Chat

LobeChat is an open-source, extensible (Function Calling) high-performance chatbot framework.
It supports one-click free deployment of your private ChatGPT/LLM web application.

English · 简体中文 · Changelog · Wiki · Report Bug · Request Feature

Share LobeChat Repository

Table of contents

TOC

• 👋🏻 Getting Started & Join Our Community
• ✨ Features
• 📸 Snapshot
• ⚡️ Performance
• 🛳 Self Hosting
  • A Deploying with Vercel
  • B Deploying with Docker
  • Environment Variable
• 📦 Ecosystem
• 🧩 Plugins
• ⌨️ Local Development
• 🤝 Contributing
• 🔗 More Products

👋🏻 Getting Started & Join Our Community

Please be aware that LobeChat is currently under active development, and feedback is welcome for any issues encountered.

	No installation or registration necessary! Visit our website to experience it firsthand.
	Join our Discord community! This is where you can connect with developers and other enthusiastic users of LobeHub.

Important
Star Us, You will receive all release notifications from GitHub without any delay ~ ⭐️

Star History

✨ Features

• 💨 Quick Deployment: Using the Vercel platform, you can deploy with just one click and complete the process within 1 minute without any complex configuration;
• 💎 Exquisite UI Design: With a carefully designed interface, it offers an elegant appearance and smooth interaction. It supports light and dark themes and is mobile-friendly. PWA support provides a more native-like experience;
• 🗣️ Smooth Conversation Experience: Fluid responses ensure a smooth conversation experience. It fully supports Markdown rendering, including code highlighting, LaTex formulas, Mermaid flowcharts, and more;
• 🧩 Plugin Support & Custom Plugin Development: Conversations are extendable with plugins. Users can install and use various plugins, such as search engines, web extraction, etc. It also supports the development of custom plugins to meet custom needs;
• 🔒 Privacy Protection: All data is stored locally in the user's browser, ensuring user privacy;
• 🤖 Customizable Agent Roles: Users can create, share, and debug personalized dialogue agent roles according to their needs, providing more flexible and customized dialogue functions;
• 🌐 Custom Domain: If users have their own domain, they can bind it to the platform for quick access to the dialogue agent from anywhere.
• 🏬 Role Market: A Role Market is provided where users can select their preferred dialogue agent roles, enriching the content and style of the dialogue;

Note
You can find our upcoming Roadmap plans in the Projects section.

📸 Snapshot

1 Function Calling Plugin System

By building a robust plugin ecosystem, ChatGPT cannot only provide real-time news updates but can also assist you in efficiently querying documents and accessing various e-commerce data. This allows ChatGPT to play a vital role in a wider range of fields. If you are interested in writing plugins, we provide detailed component development documentation, SDKs, and template files in the 🧩 Plugin System section below. Let's work together to make ChatGPT more powerful and easier to use.

2 Prompt Agent Market

In our agent market, we have accumulated a large number of practical, prompt agents that have been used in daily work and study. You can also share your agents here and iterate and optimize your prompt agents with more people. You can submit your agents through 🤖/🏪 Submit Agents, and our automated i18n workflow will automatically translate your agents into multiple languages, allowing users worldwide to enjoy your wisdom.

3 Progress Web App

Utilize the Progressive Web Application (PWA) technology to achieve a seamless LobeChat experience on your computer or mobile device.

Note
If you are unfamiliar with the installation process of PWA, you can add LobeChat as your desktop application (also applicable to mobile devices) by following these steps:

• Launch the Chrome or Edge browser on your computer
• Visit the LobeChat webpage
• In the upper right corner of the address bar, click on the Install icon
• Follow the instructions on the screen to complete the PWA installation

4 Theme Mode Selection

LobeChat offers two unique theme modes - Light Mode and Dark Mode, as well as rich color customization options to meet your personalized needs. By default, our themes will intelligently switch based on your system settings, but if you prefer manual control, you can easily switch in the settings.

5 Mobile Device Adaptation

We have carried out a series of optimization designs for mobile devices to enhance the user's mobile experience. Currently, we are iterating on the mobile user experience to achieve smoother and more intuitive interactions. If you have any suggestions or ideas, we welcome you to provide feedback through GitHub Issues or Pull Requests.

🚧 Additional snapshots and demonstrations are being progressively added...

⚡️ Performance

Note
The complete list of reports can be found in the 📘 Lighthouse Reports

Desktop	Mobile
📑 Lighthouse Report	📑 Lighthouse Report

🛳 Self Hosting

LobeChat provides Self-Hosted Version with Vercel and Docker Image. This allows you to deploy your own chatbot within a few minutes without any prior knowledge.

A Deploying with Vercel

If you want to deploy this service yourself on Vercel, you can follow these steps:

• Prepare your OpenAI API Key.
• Click the button below to start deployment: Deploy with Vercel. Log in directly with your GitHub account, and remember to fill in the API Key and access code CODE on the environment variable page;
• After deployment, you can start using it;
• Bind a custom domain (optional): The DNS of the domain assigned by Vercel is polluted in some areas; binding a custom domain can connect directly.

Keep Updated

If you have deployed your own project following the one-click deployment steps in the README, you might encounter constant prompts indicating "updates available." This is because Vercel defaults to creating a new project instead of forking this one, resulting in an inability to detect updates accurately.

Important
We suggest you redeploy using the following steps, 📘 Maintaining Updates with LobeChat Self-Deployment.

B Deploying with Docker

We provide a Docker image for deploying the LobeChat service on your own private device. Use the following command to start the LobeChat service:

$ docker run -d -p 3210:3210 \
  -e OPENAI_API_KEY=sk-xxxx \
  -e ACCESS_CODE=lobe66 \
  lobehub/lobe-chat

Note
If you need to use the OpenAI service through a proxy, you can configure the proxy address using the OPENAI_PROXY_URL environment variable:

$ docker run -d -p 3210:3210 \
  -e OPENAI_API_KEY=sk-xxxx \
  -e OPENAI_PROXY_URL=https://api-proxy.com/v1 \
  -e ACCESS_CODE=lobe66 \
  lobehub/lobe-chat

Note
For detailed instructions on deploying with Docker, please refer to the 📘 Docker Deployment Guide

Environment Variable

This project provides some additional configuration items set with environment variables:

Environment Variable	Required	Description	Example
OPENAI_API_KEY	Yes	This is the API key you apply on the OpenAI account page	sk-xxxxxx...xxxxxx
OPENAI_PROXY_URL	No	If you manually configure the OpenAI interface proxy, you can use this configuration item to override the default OpenAI API request base URL	https://api.chatanywhere.cn/v1 The default value is https://api.openai.com/v1
ACCESS_CODE	No	Add a password to access this service; the password should be a 6-digit number or letter	awCT74 or e3@09!

Note
The complete list of environment variables can be found in the 📘 Environment Variables

📦 Ecosystem

NPM	Repository	Description	Version
@lobehub/ui	lobehub/lobe-ui	Lobe UI is an open-source UI component library dedicated to building AIGC web applications.
@lobehub/lint	lobehub/lobe-lint	LobeLint provides configurations for ESlint, Stylelint, Commitlint, Prettier, Remark, and Semantic Release for LobeHub.
@lobehub/assets	lobehub/assets	Logo assets, favicons, webfonts for LobeHub.

🧩 Plugins

Plugins provide a means to extend the Function Calling capabilities of LobeChat. They can be used to introduce new function calls and even new ways to render message results. If you are interested in plugin development, please refer to our 📘 Plugin Development Guide in the Wiki.

• lobe-chat-plugins: This is the plugin index for LobeChat. It accesses index.json from this repository to display a list of available plugins for LobeChat to the user.
• chat-plugin-template: This is the plugin template for LobeChat plugin development.
• @lobehub/chat-plugin-sdk: The LobeChat Plugin SDK assists you in creating exceptional chat plugins for Lobe Chat.
• @lobehub/chat-plugins-gateway: The LobeChat Plugins Gateway is a backend service that provides a gateway for LobeChat plugins. We deploy this service using Vercel. The primary API POST /api/v1/runner is deployed as an Edge Function.

Note
The plugin system is currently undergoing major development. You can learn more in the following issues:

• Plugin Phase 1: Implement separation of the plugin from the main body, split the plugin into an independent repository for maintenance, and realize dynamic loading of the plugin.
• Plugin Phase 2: The security and stability of the plugin's use, more accurately presenting abnormal states, the maintainability of the plugin architecture and developer-friendly.
• Plugin Phase 3: Higher-level and more comprehensive customization capabilities, support for plugin authentication and examples.

Official Plugin	Description
SearchEngine	This plugin allows for the use of the SerpApi search engine.
RealtimeWeather	This plugin provides practical weather information by obtaining real-time weather data and can automatically update based on the user's location.
WebsiteCrawler	This plugin automatically crawls the main content of a specified URL webpage and uses it as context input.

⌨️ Local Development

You can use GitHub Codespaces for online development:

Or clone it for local development:

$ git clone https://github.com/lobehub/lobe-chat.git
$ cd lobe-chat
$ bun install
$ bun dev

🤝 Contributing

Contributions of all types are more than welcome; if you are interested in contributing code, feel free to check out our GitHub Issues and Projects to get stuck in to show us what you’re made of.

🔗 More Products

• 🤯 Lobe Theme: The modern theme for stable diffusion webui, exquisite interface design, highly customizable UI, and efficiency-boosting features.
• 🌏 Lobe i18n : Lobe i18n is an automation tool for the i18n (internationalization) translation process, powered by ChatGPT. It supports features such as automatic splitting of large files, incremental updates, and customization options for the OpenAI model, API proxy, and temperature.
• 💌 Lobe Commit: Lobe Commit is a CLI tool that leverages Langchain/ChatGPT to generate Gitmoji-based commit messages.

---

📝 License

Copyright © 2023 LobeHub.
This project is MIT licensed.

Changelog

Version 0.89.5

^{Released on 2023-10-15}

🐛 Bug Fixes

• misc: Fix fallback to en when the locale is zh, fix reset button not clear plugin settings.

<br /> <details> <summary><kbd>Improvements and Fixes</kbd></summary>

What's fixed

• misc: Fix fallback to en when the locale is zh (ff2c00e)
• misc: Fix reset button not clear plugin settings (aa1e657)

</details> <div align="right"> [](#readme-top) </div>