@lobehub/chat 0.89.2 → 0.89.3

package/CHANGELOG.md

@@ -2,6 +2,31 @@
 
 # Changelog
 
+### [Version 0.89.3](https://github.com/lobehub/lobe-chat/compare/v0.89.2...v0.89.3)
+
+<sup>Released on **2023-10-12**</sup>
+
+#### 🐛 Bug Fixes
+
+- **misc**: Fix plugin error with nginx reverse proxy.
+
+<br/>
+
+<details>
+<summary><kbd>Improvements and Fixes</kbd></summary>
+
+#### What's fixed
+
+- **misc**: Fix plugin error with nginx reverse proxy, closes [#315](https://github.com/lobehub/lobe-chat/issues/315) ([3ba3a3b](https://github.com/lobehub/lobe-chat/commit/3ba3a3b))
+
+</details>
+
+<div align="right">
+
+[![](https://img.shields.io/badge/-BACK_TO_TOP-151515?style=flat-square)](#readme-top)
+
+</div>
+
 ### [Version 0.89.2](https://github.com/lobehub/lobe-chat/compare/v0.89.1...v0.89.2)
 
 <sup>Released on **2023-10-12**</sup>

package/README.md

@@ -49,7 +49,8 @@ LobeChat is a open-source, extensible ([Function Calling][fc-link]), high-perfor
 - [📸 Snapshot](#-snapshot)
 - [⚡️ Performance](#️-performance)
 - [🛳 Self Hosting](#-self-hosting)
-  - [Keep Updated](#keep-updated)
+  - [Deploying with Vercel](#deploying-with-vercel)
+  - [Deploying with Docker](#deploying-with-docker)
 - [📦 Ecosystem](#-ecosystem)
 - [🧩 Plugins](#-plugins)
 - [⌨️ Local Development](#️-local-development)
@@ -174,6 +175,8 @@ We have carried out a series of optimization designs for mobile devices to enhan
 
 ## 🛳 Self Hosting
 
+### Deploying with Vercel
+
 LobeChat provides a [self-hosted version][deploy-link] with Vercel. This allows you to build your own chatbot within a few minutes, without any prior knowledge. If you want to deploy this service yourself, you can follow these steps:
 
 - Prepare your [OpenAI API Key](https://platform.openai.com/account/api-keys).
@@ -196,10 +199,33 @@ LobeChat provides a [self-hosted version][deploy-link] with Vercel. This allows
 | `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`<br/>The default value is<br/>`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!`                                                                      |
 
-### Keep Updated
+#### 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 accurately detect updates. We suggest you redeploy using the following steps, [📘 Maintaining Updates with LobeChat Self-Deployment](https://github.com/lobehub/lobe-chat/wiki/Upstream-Sync).
 
+### 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 with one-click:
+
+```shell
+docker run -d -p 3210:3210 \
+  -e OPENAI_API_KEY=sk-xxxx \
+  -e ACCESS_CODE=lobe66 \
+  lobehub/lobe-chat
+```
+
+If you need to use the OpenAI service through a proxy, you can configure the proxy address using the `OPENAI_PROXY_URL` environment variable:
+
+```shell
+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
+```
+
+For detailed instructions on deploying with Docker, please refer to the [📘 Docker Deployment Guide](docs/Docker-Deployment.md)
+
 <div align="right">
 
 [![][back-to-top]](#readme-top)

package/README.zh-CN.md

@@ -49,7 +49,8 @@ LobeChat 是一个开源的、可扩展的（[Function Calling][fc-link]）高
 - [📸 快照预览](#-快照预览)
 - [⚡️ 性能测试](#️-性能测试)
 - [🛳 开箱即用](#-开箱即用)
-  - [保持更新](#保持更新)
+  - [一键部署到 Vercel](#一键部署到-vercel)
+  - [使用 Docker 部署](#使用-docker-部署)
 - [📦 生态系统](#-生态系统)
 - [🧩 插件体系](#-插件体系)
 - [⌨️ 本地开发](#️-本地开发)
@@ -176,6 +177,8 @@ LobeChat 提供了两种独特的主题模式 - 明亮模式和暗黑模式，
 
 ## 🛳 开箱即用
 
+### 一键部署到 Vercel
+
 LobeChat 提供了 Vercel 的 [自托管版本][deploy-link]。这使你可以在几分钟内构建自己的聊天机器人，无需任何基础知识。如果想自己部署该服务，可以按照以下步骤进行操作：
 
 - 准备好你的 [OpenAI API Key](https://platform.openai.com/account/api-keys) 。
@@ -198,10 +201,33 @@ LobeChat 提供了 Vercel 的 [自托管版本][deploy-link]。这使你可以
 | `OPENAI_PROXY_URL` | 可选 | 如果你手动配置了 OpenAI 接口代理，可以使用此配置项来覆盖默认的 OpenAI API 请求基础 URL | `https://api.chatanywhere.cn/v1`<br/>默认值:<br/>`https://api.openai.com/v1` |
 | `ACCESS_CODE`      | 可选 | 添加访问此服务的密码，密码应为 6 位数字或字母                                          | `awCT74` 或 `e3@09!`                                                         |
 
-### 保持更新
+#### 保持更新
 
 如果你根据 README 中的一键部署步骤部署了自己的项目，你可能会发现总是被提示 “有可用更新”。这是因为 Vercel 默认为你创建新项目而非 fork 本项目，这将导致无法准确检测更新。我们建议按照 [📘 LobeChat 自部署保持更新](https://github.com/lobehub/lobe-chat/wiki/Upstream-Sync.zh-CN) 步骤重新部署。
 
+### 使用 Docker 部署
+
+我们提供了 Docker 镜像，供你在自己的私有设备上部署 LobeChat 服务。使用以下命令即可使用一键启动 LobeChat 服务：
+
+```shell
+docker run -d -p 3210:3210 \
+  -e OPENAI_API_KEY=sk-xxxx \
+  -e ACCESS_CODE=lobe66 \
+  lobehub/lobe-chat
+```
+
+如果你需要通过代理使用 OpenAI 服务，你可以使用 `OPENAI_PROXY_URL` 环境变量来配置代理地址：
+
+```shell
+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
+```
+
+有关 Docker 部署的详细说明，详见 [📘 使用 Docker 部署](docs/Docker-Deployment.zh-CN.md)
+
 <div align="right">
 
 [![][back-to-top]](#readme-top)

package/docs/Analytics.zh-CN.md

@@ -6,14 +6,10 @@
 
 [Vercel Analytics](https://vercel.com/analytics) 是 Vercel 推出的一款数据分析服务，它可以帮助你收集网站的访问情况，包括访问量、访问来源、访问设备等等。
 
-由于我们推荐使用 Vercel 一键部署 LobeChat，因此我们在代码中默认集成了 Vercel Analytics，你可以通过自行打开部署项目中 \[Insights] tab，查看你的应用访问情况。
+我们在代码中集成了 Vercel Analytics，你可以通过设置环境变量 `NEXT_PUBLIC_ANALYTICS_VERCEL=1` 来开启它，并打开 Vercel 部署项目中 Analytics tab 查看你的应用访问情况。
 
 Vercel Analytics 提供了 2500 次 / 月的免费 Web Analytics Events (可以理解为 PV)，对于个人部署自用的产品来说基本够用。
 
 如果你需要了解 Vercel Analytics 的详细使用教程，请查阅[Vercel Web Analytics 快速开始](https://vercel.com/docs/analytics/quickstart)
 
-如果你不需要 Vercel Analytics，你可以通过设置环境变量 `NEXT_PUBLIC_ANALYTICS_VERCEL=0` 来关闭它。
-
 ## 🚧 Posthog
-
-## 🚧 Mixpanel

package/docs/Development-Guide/Folder-Structure.zh-CN.md

@@ -0,0 +1,38 @@
+LobeChat 的文件夹目录架构如下：
+
+```bash
+src
+├── app        # 应用主要逻辑和状态管理相关的代码
+├── components # 可复用的 UI 组件
+├── config     # 应用的配置文件，包含客户端环境变量与服务端环境变量
+├── const      # 用于定义常量，如 action 类型、路由名等
+├── features   # 与业务功能相关的功能模块，如 Agent 设置、插件开发弹窗等
+├── hooks      # 全应用复用自定义的工具 Hooks
+├── layout     # 应用的布局组件，如导航栏、侧边栏等
+├── locales    # 国际化的语言文件
+├── services   # 封装的后端服务接口，如 HTTP 请求
+├── store      # 用于状态管理的 zustand store
+├── types      # TypeScript 的类型定义文件
+└── utils      # 通用的工具函数
+```
+
+## app
+
+在 `app` 文件夹中，我们将每个路由页面按照 app router 的 [Route Groups](https://nextjs.org/docs/app/building-your-application/routing/route-groups) 进行组织，以此来分别处理桌面端和移动端的代码实现。以下是 `welcome` 页面的文件结构为例：
+
+```bash
+.
+├── (desktop)               # 桌面端实现
+│   ├── features            # 桌面端特有的功能
+│   ├── index.tsx           # 桌面端的主入口文件
+│   └── layout.desktop.tsx  # 桌面端的布局组件
+├── (mobile)                # 移动端实现
+│   ├── features            # 移动端特有的功能
+│   ├── index.tsx           # 移动端的主入口文件
+│   └── layout.mobile.tsx   # 移动端的布局组件
+├── features                # 此文件夹包含双端共享的特性代码，如 Banner 组件
+│   └── Banner
+└── page.tsx                # 此为页面的主入口文件，用于根据设备类型选择加载桌面端或移动端的代码
+```
+
+通过这种方式，我们可以清晰地区分和管理桌面端和移动端的代码，同时也能方便地复用在两种设备上都需要的代码，从而提高开发效率并保持代码的整洁和可维护性。

package/docs/Development-Guide/index.zh-CN.md

@@ -0,0 +1,38 @@
+# LobeChat 技术开发上手指南
+
+欢迎来到 LobeChat 技术开发上手指南。LobeChat 是一款基于 Next.js 框架构建的 AI 会话应用，它汇集了一系列的技术栈，以实现多样化的功能和特性。本指南将详细介绍 LobeChat 的主要技术组成，以及如何在你的开发环境中配置和使用这些技术。
+
+## 基础技术栈
+
+LobeChat 的核心技术栈如下：
+
+- **框架**：我们选择了 [Next.js](https://nextjs.org/)，这是一款强大的 React 框架，为我们的项目提供了服务端渲染、路由框架、Router Handler 等关键功能。
+- **组件库**：我们使用了 [Ant Design (antd)](https://ant.design/) 作为基础组件库，同时引入了 [lobe-ui](https://github.com/lobehub/lobe-ui) 作为我们的业务组件库。
+- **状态管理**：我们选用了 [zustand](https://github.com/pmndrs/zustand)，一款轻量级且易于使用的状态管理库。
+- **网络请求**：我们采用 [swr](https://swr.vercel.app/)，这是一款用于数据获取的 React Hooks 库。
+- **路由**：路由管理我们直接使用 [Next.js](https://nextjs.org/) 自身提供的解决方案。
+- **国际化**：我们使用 [i18next](https://www.i18next.com/) 来实现应用的多语言支持。
+- **样式**：我们使用 [antd-style](https://github.com/ant-design/antd-style)，这是一款与 Ant Design 配套的 CSS-in-JS 库。
+- **单元测试**：我们使用 [vitest](https://github.com/vitejs/vitest) 进行单元测试。
+
+## 文件夹目录架构
+
+LobeChat 的文件夹目录架构如下：
+
+```bash
+src
+├── app        # 应用主要逻辑和状态管理相关的代码
+├── components # 可复用的 UI 组件
+├── config     # 应用的配置文件，包含客户端环境变量与服务端环境变量
+├── const      # 用于定义常量，如 action 类型、路由名等
+├── features   # 与业务功能相关的功能模块，如 Agent 设置、插件开发弹窗等
+├── hooks      # 全应用复用自定义的工具 Hooks
+├── layout     # 应用的布局组件，如导航栏、侧边栏等
+├── locales    # 国际化的语言文件
+├── services   # 封装的后端服务接口，如 HTTP 请求
+├── store      # 用于状态管理的 zustand store
+├── types      # TypeScript 的类型定义文件
+└── utils      # 通用的工具函数
+```
+
+有关目录架构的详细介绍，详见： [文件夹目录架构](Folder-Structure.zh-CN.md)

package/docs/Docker-Deployment.md

@@ -0,0 +1,42 @@
+# Deployment using Docker
+
+[![][docker-release-shield]][docker-release-link]
+
+We provide Docker images for deploying the LobeChat service on your own private devices.
+
+## Container Image
+
+### Command Deployment (Recommended)
+
+Use the following command to start the LobeChat service with one-click:
+
+```shell
+docker run -d -p 3210:3210 \
+  -e OPENAI_API_KEY=sk-xxxx \
+  -e ACCESS_CODE=lobe66 \
+  lobehub/lobe-chat
+```
+
+### Using Proxy Address
+
+If you need to use OpenAI services through a proxy, you can configure the proxy address using the `OPENAI_PROXY_URL` environment variable:
+
+```shell
+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
+```
+
+For a complete list of environment variables for LobeChat, please refer to the [Environment Variables](./Environment-Variable.md) section.
+
+> **Note**\
+> Since the official Docker image construction takes about half an hour, if you see the "update available" message after updating the deployment, you can wait for the image construction to complete before redeploying.
+
+### 🚧 Docker Compose
+
+Under construction, please be patient\~
+
+[docker-release-link]: https://hub.docker.com/r/lobehub/lobe-chat
+[docker-release-shield]: https://img.shields.io/docker/v/lobehub/lobe-chat?color=369eff&label=docker&labelColor=black&logo=docker&logoColor=white&style=flat-square

package/docs/Docker-Deployment.zh-CN.md

@@ -0,0 +1,44 @@
+# 使用 Docker 部署
+
+[![][docker-release-shield]][docker-release-link]
+
+我们提供了 Docker 镜像，供你在自己的私有设备上部署 LobeChat 服务。
+
+## 容器镜像
+
+### 指令部署 （推荐）
+
+使用以下命令即可使用一键启动 LobeChat 服务：
+
+```shell
+docker run -d -p 3210:3210 \
+  -e OPENAI_API_KEY=sk-xxxx \
+  -e ACCESS_CODE=lobe66 \
+  lobehub/lobe-chat
+```
+
+使用你的 OpenAI API Key 替换上述命令中的 `sk-xxxx` ， 官方 Docker 镜像中设定的密码默认为 `lobe66`，请将其替换为自己的密码以提升安全性。
+
+### 使用代理地址
+
+如果你需要通过代理使用 OpenAI 服务，你可以使用 `OPENAI_PROXY_URL` 环境变量来配置代理地址：
+
+```shell
+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
+```
+
+LobeChat 支持的完整环境变量列表请参考 [环境变量](./Environment-Variable.zh-CN.md) 部分。
+
+> **Note**\
+> 由于官方的 Docker 镜像构建大约需要半小时左右，如果在更新部署后会出现「存在更新」的提示，可以等待镜像构建完成后再次部署。
+
+### 🚧 Docker Compose
+
+施工中，请耐心等待～
+
+[docker-release-link]: https://hub.docker.com/r/lobehub/lobe-chat
+[docker-release-shield]: https://img.shields.io/docker/v/lobehub/lobe-chat?color=369eff&label=docker&labelColor=black&logo=docker&logoColor=white&style=flat-square

package/docs/Environment-Variable.zh-CN.md

@@ -19,7 +19,6 @@ LobeChat 在部署时提供了一些额外的配置项，使用环境变量进
   - [`AGENTS_INDEX_URL`](#agents_index_url)
 - [数据统计](#数据统计)
   - [Vercel Analytics](#vercel-analytics)
-  - [Mixpanel Analytics](#mixpanel-analytics)
   - [Posthog Analytics](#posthog-analytics)
 
 ## 通用变量
@@ -114,29 +113,6 @@ LobeChat 在部署时提供了一些额外的配置项，使用环境变量进
 - 默认值： -
 - 示例：`1`
 
-### Mixpanel Analytics
-
-#### `NEXT_PUBLIC_ANALYTICS_MIXPANEL`
-
-- 类型：可选
-- 描述：用于开启 [Mixpanel Analytics][mixpanel-analytics-url] 的环境变量，设为 `1` 时开启 Mixpanel Analytics
-- 默认值： -
-- 示例：`1`
-
-#### `NEXT_PUBLIC_MIXPANEL_PROJECT_TOKEN`
-
-- 类型：可选
-- 描述：设置 Mixpanel 项目的识别 Token，可以在[这里][mixpanel-project-url]找到
-- 默认值： -
-- 示例：`60db2abae7fdd29961f4e8f91b074b3a`
-
-#### `NEXT_PUBLIC_MIXPANEL_DEBUG`
-
-- 类型：可选
-- 描述：开启 Mixpanel 的调试模式
-- 默认值： -
-- 示例：`1`
-
 ### Posthog Analytics
 
 #### `NEXT_PUBLIC_ANALYTICS_POSTHOG`
@@ -168,7 +144,5 @@ LobeChat 在部署时提供了一些额外的配置项，使用环境变量进
 - 示例：`1`
 
 [azure-api-verion-url]: https://docs.microsoft.com/zh-cn/azure/developer/javascript/api-reference/es-modules/azure-sdk/ai-translation/translationconfiguration?view=azure-node-latest#api-version
-[mixpanel-analytics-url]: https://mixpanel.com
-[mixpanel-project-url]: https://mixpanel.com/settings/project
 [openai-api-page]: https://platform.openai.com/account/api-keys
 [posthog-analytics-url]: https://posthog.com

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@lobehub/chat",
-  "version": "0.89.2",
+  "version": "0.89.3",
   "description": "An open-source, extensible (Function Calling), high-performance chatbot framework. It supports one-click free deployment of your private ChatGPT/LLM web application",
   "keywords": [
     "chatbot",
@@ -69,7 +69,7 @@
     "@emoji-mart/data": "^1",
     "@emoji-mart/react": "^1",
     "@icons-pack/react-simple-icons": "^9",
-    "@lobehub/chat-plugin-sdk": "latest",
+    "@lobehub/chat-plugin-sdk": "^1.17.8",
     "@lobehub/chat-plugins-gateway": "latest",
     "@lobehub/ui": "latest",
     "@vercel/analytics": "^1",
@@ -91,7 +91,6 @@
     "immer": "^10",
     "lodash-es": "^4",
     "lucide-react": "latest",
-    "mixpanel-browser": "^2",
     "modern-screenshot": "^4",
     "nanoid": "^5",
     "next": "^13.5.3",
@@ -130,7 +129,6 @@
     "@types/chroma-js": "^2",
     "@types/lodash": "^4",
     "@types/lodash-es": "^4",
-    "@types/mixpanel-browser": "^2",
     "@types/node": "^20",
     "@types/react": "^18",
     "@types/react-dom": "^18",

package/src/components/Analytics/index.tsx

@@ -3,19 +3,16 @@ import dynamic from 'next/dynamic';
 import { getClientConfig } from '@/config/client';
 
 const Vercel = dynamic(() => import('./Vercel'), { ssr: false });
-const Mixpanel = dynamic(() => import('./Mixpanel'), { ssr: false });
 const Plausible = dynamic(() => import('./Plausible'), { ssr: false });
 const Posthog = dynamic(() => import('./Posthog'), { ssr: false });
 
-const { ANALYTICS_VERCEL, ANALYTICS_POSTHOG, ANALYTICS_MIXPANEL, ANALYTICS_PLAUSIBLE } =
-  getClientConfig();
+const { ANALYTICS_VERCEL, ANALYTICS_POSTHOG, ANALYTICS_PLAUSIBLE } = getClientConfig();
 
 const Analytics = () => {
   return (
     <>
       {ANALYTICS_VERCEL && <Vercel />}
       {ANALYTICS_PLAUSIBLE && <Plausible />}
-      {ANALYTICS_MIXPANEL && <Mixpanel />}
       {ANALYTICS_POSTHOG && <Posthog />}
     </>
   );

package/src/config/client.ts

@@ -34,18 +34,13 @@ export const getClientConfig = () => ({
   PLUGINS_INDEX_URL: process.env.PLUGINS_INDEX_URL,
 
   // Vercel Analytics
-  ANALYTICS_VERCEL: process.env.NEXT_PUBLIC_ANALYTICS_VERCEL !== '0',
+  ANALYTICS_VERCEL: process.env.NEXT_PUBLIC_ANALYTICS_VERCEL === '1',
   VERCEL_DEBUG: process.env.NEXT_PUBLIC_VERCEL_DEBUG === '1',
 
   // Plausible Analytics
   ANALYTICS_PLAUSIBLE: process.env.NEXT_PUBLIC_ANALYTICS_PLAUSIBLE === '1',
   PLAUSIBLE_DOMAIN: process.env.NEXT_PUBLIC_PLAUSIBLE_DOMAIN,
 
-  // Mixpanel Analytics
-  ANALYTICS_MIXPANEL: process.env.NEXT_PUBLIC_ANALYTICS_MIXPANEL === '1',
-  MIXPANEL_PROJECT_TOKEN: process.env.NEXT_PUBLIC_MIXPANEL_PROJECT_TOKEN,
-  MIXPANEL_DEBUG: process.env.NEXT_PUBLIC_MIXPANEL_DEBUG === '1',
-
   // Posthog Analytics
   ANALYTICS_POSTHOG: process.env.NEXT_PUBLIC_ANALYTICS_POSTHOG === '1',
   POSTHOG_KEY: process.env.NEXT_PUBLIC_POSTHOG_KEY,

package/src/components/Analytics/Mixpanel.tsx

@@ -1,23 +0,0 @@
-'use client';
-
-import mixpanel from 'mixpanel-browser';
-import { memo, useEffect } from 'react';
-
-import { getClientConfig } from '@/config/client';
-
-const { MIXPANEL_PROJECT_TOKEN, MIXPANEL_DEBUG } = getClientConfig();
-
-const MixpanelAnalytics = memo(() => {
-  useEffect(() => {
-    if (!MIXPANEL_PROJECT_TOKEN) return;
-
-    mixpanel.init(MIXPANEL_PROJECT_TOKEN, {
-      debug: MIXPANEL_DEBUG,
-      persistence: 'localStorage',
-      track_pageview: true,
-    });
-  }, []);
-  return null;
-});
-
-export default MixpanelAnalytics;