@lobehub/chat 0.128.2 → 0.128.4

package/docs/Deployment/Deploy-with-Azure-OpenAI.md

@@ -1,54 +0,0 @@
-# Deploying with Azure OpenAI
-
-LobeChat supports using [Azure OpenAI][azure-openai-url] as the model service provider for OpenAI. This document will guide you through the configuration of Azure OpenAI.
-
-#### TOC
-
-- [Usage Limitations](#usage-limitations)
-- [Configuration in the Interface](#configuration-in-the-interface)
-- [Configuration at Deployment](#configuration-at-deployment)
-
-## Usage Limitations
-
-Considering development costs ([#178][rfc]), the current version of LobeChat does not fully conform to Azure OpenAI's implementation model. Instead, it adopts a solution based on `openai` that is compatible with Azure OpenAI. This brings about the following limitations:
-
-- You can only choose one between OpenAI and Azure OpenAI. Once you enable Azure OpenAI, you will not be able to use OpenAI as the model service provider.
-- LobeChat requires deployment names to be the same as the model names in order to function properly. For example, the deployment name for the `gpt-35-turbo` model must be `gpt-35-turbo`, otherwise LobeChat will not be able to match the model correctly.
-  ![](https://github-production-user-asset-6210df.s3.amazonaws.com/28616219/267082091-d89d53d3-1c8c-40ca-ba15-0a9af2a79264.png)
-- Due to the complexity of integrating the Azure OpenAI SDK, it is currently impossible to query the model list of configured resources.
-
-## Configuration in the Interface
-
-Click on "Operation" - "Settings" in the bottom left corner, switch to the "Language Model" tab and enable the "Azure OpenAI" switch to start using Azure OpenAI.
-
-![](https://github-production-user-asset-6210df.s3.amazonaws.com/28616219/267083420-422a3714-627e-4bef-9fbc-141a2a8ca916.png)
-
-You can fill in the corresponding configuration items as needed:
-
-- **APIKey**: The API key you applied for on the Azure OpenAI account page, which can be found in the "Keys and Endpoints" section.
-- **API Address**: Azure API address, which can be found in the "Keys and Endpoints" section when checking resources from the Azure portal.
-- **Azure Api Version**: The API version of Azure, which follows the YYYY-MM-DD format, refer to the [latest version][azure-api-version-url].
-
-After completing the above field configuration, click on "Check". If the prompt says "Check Passed", it means the configuration was successful.
-
-<br/>
-
-## Configuration at Deployment
-
-If you want the deployed version to be directly configured with Azure OpenAI for end users to use immediately, you need to configure the following environment variables at deployment:
-
-| Environment Variable | Required | Description                                                                                                                                  | Default Value      | Example                                                        |
-| -------------------- | -------- | -------------------------------------------------------------------------------------------------------------------------------------------- | ------------------ | -------------------------------------------------------------- |
-| `USE_AZURE_OPENAI`   | Yes      | Set this value to `1` to enable Azure OpenAI configuration                                                                                   | -                  | `1`                                                            |
-| `AZURE_API_KEY`      | Yes      | This is the API key you applied for on the Azure OpenAI account page                                                                         | -                  | `c55168be3874490ef0565d9779ecd5a6`                             |
-| `OPENAI_PROXY_URL`   | Yes      | Azure API address, can be found in the "Keys and Endpoints" section                                                                          | -                  | `https://docs-test-001.openai.azure.com`                       |
-| `AZURE_API_VERSION`  | No       | Azure's API version, follows the YYYY-MM-DD format                                                                                           | 2023-08-01-preview | `2023-05-15`, refer to [latest version][azure-api-version-url] |
-| `ACCESS_CODE`        | No       | Add a password to access this service; you can set a long password to avoid leaking. If this value contains a comma, it is a password array. | -                  | `awCT74` or `e3@09!` or `code1,code2,code3`                    |
-
-> \[!NOTE]
->
-> When you enable `USE_AZURE_OPENAI` on the server side, users will not be able to modify and use the OpenAI key in the front-end configuration.
-
-[azure-api-version-url]: https://learn.microsoft.com/zh-cn/azure/ai-services/openai/reference#chat-completions
-[azure-openai-url]: https://learn.microsoft.com/zh-cn/azure/ai-services/openai/concepts/models
-[rfc]: https://github.com/lobehub/lobe-chat/discussions/178

package/docs/Deployment/Docker-Deployment.md

@@ -1,219 +0,0 @@
-# Docker Deployment Guide
-
-[![][docker-release-shield]][docker-release-link]
-[![][docker-size-shield]][docker-size-link]
-[![][docker-pulls-shield]][docker-pulls-link]
-
-We provide [Docker Images][docker-release-link] for you to deploy LobeChat service on your private device.
-
-#### TOC
-
-- [Install Docker container environment](#install-docker-container-environment)
-- [Deploy container image](#deploy-container-image)
-  - [`A` Command deployment (recommended)](#a-command-deployment-recommended)
-  - [`B` Docker Compose](#b-docker-compose)
-
-## Install Docker container environment
-
-If already installed, skip this step.
-
-**Ubuntu:**
-
-```fish
-$ apt install docker.io
-```
-
-**CentOS:**
-
-```fish
-$ yum install docker
-```
-
-## Deploy container image
-
-### `A` Command deployment (recommended)
-
-Use the following command to start LobeChat service with one click:
-
-```fish
-$ docker run -d -p 3210:3210 \
-  -e OPENAI_API_KEY=sk-xxxx \
-  -e ACCESS_CODE=lobe66 \
-  --name lobe-chat \
-  lobehub/lobe-chat
-```
-
-> \[!NOTE]
->
-> - The default mapped port is `3210`. Make sure it is not occupied or manually change the port mapping.
-> - Replace `sk-xxxx` in the above command with your own OpenAI API Key.
-> - The official Docker doesn't set password by default. Please add your own password to improve security.
-> - For a complete list of environment variables supported by LobeChat, please refer to the [Environment Variables](https://github.com/lobehub/lobe-chat/wiki/Environment-Variable.zh-CN) section.
-
-> \[!WARNING]
->
-> If the architecture of your **deployed server differs from the container architecture**, you may need to perform cross-compilation for **Sharp**. For further details, please refer to the documentation on [Sharp Cross-platform](https://sharp.pixelplumbing.com/install#cross-platform).
-
-#### Use a proxy address
-
-If you need to use OpenAI service through a proxy, you can use the `OPENAI_PROXY_URL` environment variable to configure the proxy address:
-
-```fish
-$ 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 \
-  --name lobe-chat \
-  lobehub/lobe-chat
-```
-
-> \[!NOTE]
->
-> As the official Docker image build takes about half an hour, if there is a "update available" prompt after updating deployment, wait for the image to finish building before deploying again.
-
-#### Crontab Auto-Update Script
-
-If you want to automatically get the latest images, you can do the following.
-
-First, create a `lobe.env` configuration file with various environment variables, for example:
-
-```env
-OPENAI_API_KEY=sk-xxxx
-OPENAI_PROXY_URL=https://api-proxy.com/v1
-ACCESS_CODE=arthals2333
-CUSTOM_MODELS=-gpt-4,-gpt-4-32k,-gpt-3.5-turbo-16k,gpt-3.5-turbo-1106=gpt-3.5-turbo-16k,gpt-4-0125-preview=gpt-4-turbo,gpt-4-vision-preview=gpt-4-vision
-```
-
-Then, you can use the following script to automatically update:
-
-```bash
-#!/bin/bash
-# auto-update-lobe-chat.sh
-
-# Set proxy (optional)
-export https_proxy=http://127.0.0.1:7890 http_proxy=http://127.0.0.1:7890 all_proxy=socks5://127.0.0.1:7890
-
-# Pull the latest image and store the output in a variable
-output=$(docker pull lobehub/lobe-chat:latest 2>&1)
-
-# Check if the pull command executed successfully
-if [ $? -ne 0 ]; then
-  exit 1
-fi
-
-# Check if the output contains a specific string
-echo "$output" | grep -q "Image is up to date for lobehub/lobe-chat:latest"
-
-# If the image is already up to date, then do nothing
-if [ $? -eq 0 ]; then
-  exit 0
-fi
-
-echo "Detected Lobe-Chat update"
-
-# Remove old container
-echo "Removed: $(docker rm -f Lobe-Chat)"
-
-# Run new container
-echo "Started: $(docker run -d --network=host --env-file /path/to/lobe.env --name=Lobe-Chat --restart=always lobehub/lobe-chat)"
-
-# Print the update time and version
-echo "Update time: $(date)"
-echo "Version: $(docker inspect lobehub/lobe-chat:latest | grep 'org.opencontainers.image.version' | awk -F'"' '{print $4}')"
-
-# Clean up unused images
-docker images | grep 'lobehub/lobe-chat' | grep -v 'latest' | awk '{print $3}' | xargs -r docker rmi > /dev/null 2>&1
-echo "Removed old images."
-```
-
-This script can be used in Crontab, but make sure your Crontab can find the correct Docker command. It's recommended to use absolute paths.
-
-Configure Crontab to execute the script every 5 minutes:
-
-```bash
-*/5 * * * * /path/to/auto-update-lobe-chat.sh >> /path/to/auto-update-lobe-chat.log 2>&1
-```
-
-### `B` Docker Compose
-
-The configuration file for using `docker-compose` is as follows:
-
-```yml
-version: '3.8'
-
-services:
-  lobe-chat:
-    image: lobehub/lobe-chat
-    container_name: lobe-chat
-    restart: always
-    ports:
-      - '3210:3210'
-    environment:
-      OPENAI_API_KEY: sk-xxxx
-      OPENAI_PROXY_URL: https://api-proxy.com/v1
-      ACCESS_CODE: lobe66
-```
-
-#### Crontab Auto-Update Script
-
-Similarly, you can use the following script to update Lobe Chat automatically. When using `Docker Compose`, environment variables do not need additional configuration.
-
-```bash
-#!/bin/bash
-# auto-update-lobe-chat.sh
-
-# Set proxy (optional)
-export https_proxy=http://127.0.0.1:7890 http_proxy=http://127.0.0.1:7890 all_proxy=socks5://127.0.0.1:7890
-
-# Pull the latest image and store the output in a variable
-output=$(docker pull lobehub/lobe-chat:latest 2>&1)
-
-# Check if the pull command executed successfully
-if [ $? -ne 0 ]; then
-  exit 1
-fi
-
-# Check if the output contains a specific string
-echo "$output" | grep -q "Image is up to date for lobehub/lobe-chat:latest"
-
-# If the image is already up to date, then do nothing
-if [ $? -eq 0 ]; then
-  exit 0
-fi
-
-echo "Detected Lobe-Chat update"
-
-# Remove old container
-echo "Removed: $(docker rm -f Lobe-Chat)"
-
-# Maybe you need to enter the directory where `docker-compose.yml` is located first
-# cd /path/to/docker-compose-folder
-
-# Run new container
-echo "Started: $(docker-compose up)"
-
-# Print the update time and version
-echo "Update time: $(date)"
-echo "Version: $(docker inspect lobehub/lobe-chat:latest | grep 'org.opencontainers.image.version' | awk -F'"' '{print $4}')"
-
-# Clean up unused images
-docker images | grep 'lobehub/lobe-chat' | grep -v 'latest' | awk '{print $3}' | xargs -r docker rmi > /dev/null 2>&1
-echo "Removed old images."
-```
-
-This script can also be used in Crontab, but make sure your Crontab can find the correct Docker command. It's recommended to use absolute paths.
-
-Configure Crontab to execute the script every 5 minutes:
-
-```bash
-*/5 * * * * /path/to/auto-update-lobe-chat.sh >> /path/to/auto-update-lobe-chat.log 2>&1
-```
-
-<!-- LINK GROUP -->
-
-[docker-pulls-link]: https://hub.docker.com/r/lobehub/lobe-chat
-[docker-pulls-shield]: https://img.shields.io/docker/pulls/lobehub/lobe-chat?color=45cc11&labelColor=black&style=flat-square
-[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
-[docker-size-link]: https://hub.docker.com/r/lobehub/lobe-chat
-[docker-size-shield]: https://img.shields.io/docker/image-size/lobehub/lobe-chat?color=369eff&labelColor=black&style=flat-square

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

@@ -1,217 +0,0 @@
-# Docker 部署指引
-
-[![][docker-release-shield]][docker-release-link]
-[![][docker-size-shield]][docker-size-link]
-[![][docker-pulls-shield]][docker-pulls-link]
-
-我们提供了 [Docker 镜像][docker-release-link]，供你在自己的私有设备上部署 LobeChat 服务
-
-#### TOC
-
-- [安装 Docker 容器环境](#安装-docker-容器环境)
-- [部署容器镜像](#部署容器镜像)
-  - [`A` 指令部署（推荐）](#a-指令部署推荐)
-  - [`B` Docker Compose](#b-docker-compose)
-
-## 安装 Docker 容器环境
-
-如果已安装，请跳过此步
-
-**Ubuntu**
-
-```fish
-$ apt install docker.io
-```
-
-**CentOS**
-
-```fish
-$ yum install docker
-```
-
-## 部署容器镜像
-
-### `A` 指令部署（推荐）
-
-使用以下命令即可使用一键启动 LobeChat 服务：
-
-```fish
-$ docker run -d -p 3210:3210 \
-  -e OPENAI_API_KEY=sk-xxxx \
-  -e ACCESS_CODE=lobe66 \
-  --name lobe-chat \
-  lobehub/lobe-chat
-```
-
-> \[!NOTE]
->
-> - 默认映射端口为 `3210`, 请确保未被占用或手动更改端口映射
-> - 使用你的 OpenAI API Key 替换上述命令中的 `sk-xxxx`
-> - 官方 Docker 镜像中未设定密码，强烈建议添加密码以提升安全性，否则你可能会遇到 [My API Key was stolen!!!](https://github.com/lobehub/lobe-chat/issues/1123) 这样的情况
-> - LobeChat 支持的完整环境变量列表请参考 [环境变量](https://github.com/lobehub/lobe-chat/wiki/Environment-Variable.zh-CN) 部分
-
-> \[!WARNING]
->
-> 注意，当**部署架构与镜像的不一致时**，需要对 **Sharp** 进行交叉编译，详见 [Sharp 交叉编译](https://sharp.pixelplumbing.com/install#cross-platform)
-
-#### 使用代理地址
-
-如果你需要通过代理使用 OpenAI 服务，你可以使用 `OPENAI_PROXY_URL` 环境变量来配置代理地址：
-
-```fish
-$ 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 \
-  --name lobe-chat \
-  lobehub/lobe-chat
-```
-
-> \[!NOTE]
->
-> 由于官方的 Docker 镜像构建大约需要半小时左右，如果在更新部署后会出现「存在更新」的提示，可以等待镜像构建完成后再次部署。
-
-#### Crontab 自动更新脚本
-
-如果你想自动获得最新的镜像，你可以如下操作。
-
-首先，新建一个 `lobe.env` 配置文件，内容为各种环境变量，例如：
-
-```env
-OPENAI_API_KEY=sk-xxxx
-OPENAI_PROXY_URL=https://api-proxy.com/v1
-ACCESS_CODE=arthals2333
-CUSTOM_MODELS=-gpt-4,-gpt-4-32k,-gpt-3.5-turbo-16k,gpt-3.5-turbo-1106=gpt-3.5-turbo-16k,gpt-4-0125-preview=gpt-4-turbo,gpt-4-vision-preview=gpt-4-vision
-```
-
-然后，你可以使用以下脚本来自动更新：
-
-```bash
-#!/bin/bash
-# auto-update-lobe-chat.sh
-
-# 设置代理（可选）
-export https_proxy=http://127.0.0.1:7890 http_proxy=http://127.0.0.1:7890 all_proxy=socks5://127.0.0.1:7890
-
-# 拉取最新的镜像并将输出存储在变量中
-output=$(docker pull lobehub/lobe-chat:latest 2>&1)
-
-# 检查拉取命令是否成功执行
-if [ $? -ne 0 ]; then
-  exit 1
-fi
-
-# 检查输出中是否包含特定的字符串
-echo "$output" | grep -q "Image is up to date for lobehub/lobe-chat:latest"
-
-# 如果镜像已经是最新的，则不执行任何操作
-if [ $? -eq 0 ]; then
-  exit 0
-fi
-
-echo "Detected Lobe-Chat update"
-
-# 删除旧的容器
-echo "Removed: $(docker rm -f Lobe-Chat)"
-
-# 运行新的容器
-echo "Started: $(docker run -d --network=host --env-file /path/to/lobe.env --name=Lobe-Chat --restart=always lobehub/lobe-chat)"
-
-# 打印更新的时间和版本
-echo "Update time: $(date)"
-echo "Version: $(docker inspect lobehub/lobe-chat:latest | grep 'org.opencontainers.image.version' | awk -F'"' '{print $4}')"
-
-# 清理不再使用的镜像
-docker images | grep 'lobehub/lobe-chat' | grep -v 'latest' | awk '{print $3}' | xargs -r docker rmi > /dev/null 2>&1
-echo "Removed old images."
-```
-
-此脚本可以在 Crontab 中使用，但请确认你的 Crontab 可以找到正确的 Docker 命令。建议使用绝对路径。
-
-配置 Crontab，每 5 分钟执行一次脚本：
-
-```bash
-*/5 * * * * /path/to/auto-update-lobe-chat.sh >> /path/to/auto-update-lobe-chat.log 2>&1
-```
-
-### `B` Docker Compose
-
-使用 `docker-compose` 时配置文件如下:
-
-```yml
-version: '3.8'
-
-services:
-  lobe-chat:
-    image: lobehub/lobe-chat
-    container_name: lobe-chat
-    restart: always
-    ports:
-      - '3210:3210'
-    environment:
-      OPENAI_API_KEY: sk-xxxx
-      OPENAI_PROXY_URL: https://api-proxy.com/v1
-      ACCESS_CODE: lobe66
-```
-
-#### Crontab 自动更新脚本
-
-类似地，你可以使用以下脚本来自动更新 Lobe Chat，使用 `Docker Compose` 时，环境变量无需额外配置。
-
-```bash
-#!/bin/bash
-# auto-update-lobe-chat.sh
-
-# 设置代理（可选）
-export https_proxy=http://127.0.0.1:7890 http_proxy=http://127.0.0.1:7890 all_proxy=socks5://127.0.0.1:7890
-
-# 拉取最新的镜像并将输出存储在变量中
-output=$(docker pull lobehub/lobe-chat:latest 2>&1)
-
-# 检查拉取命令是否成功执行
-if [ $? -ne 0 ]; then
-  exit 1
-fi
-
-# 检查输出中是否包含特定的字符串
-echo "$output" | grep -q "Image is up to date for lobehub/lobe-chat:latest"
-
-# 如果镜像已经是最新的，则不执行任何操作
-if [ $? -eq 0 ]; then
-  exit 0
-fi
-
-echo "Detected Lobe-Chat update"
-
-# 删除旧的容器
-echo "Removed: $(docker rm -f Lobe-Chat)"
-
-# 也许需要先进入 `docker-compose.yml` 所在的目录
-# cd /path/to/docker-compose-folder
-
-# 运行新的容器
-echo "Started: $(docker-compose up)"
-
-# 打印更新的时间和版本
-echo "Update time: $(date)"
-echo "Version: $(docker inspect lobehub/lobe-chat:latest | grep 'org.opencontainers.image.version' | awk -F'"' '{print $4}')"
-
-# 清理不再使用的镜像
-docker images | grep 'lobehub/lobe-chat' | grep -v 'latest' | awk '{print $3}' | xargs -r docker rmi > /dev/null 2>&1
-echo "Removed old images."
-```
-
-此脚本亦可以在 Crontab 中使用，但请确认你的 Crontab 可以找到正确的 Docker 命令。建议使用绝对路径。
-
-配置 Crontab，每 5 分钟执行一次脚本：
-
-```bash
-*/5 * * * * /path/to/auto-update-lobe-chat.sh >> /path/to/auto-update-lobe-chat.log 2>&1
-```
-
-[docker-pulls-link]: https://hub.docker.com/r/lobehub/lobe-chat
-[docker-pulls-shield]: https://img.shields.io/docker/pulls/lobehub/lobe-chat?color=45cc11&labelColor=black&style=flat-square
-[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
-[docker-size-link]: https://hub.docker.com/r/lobehub/lobe-chat
-[docker-size-shield]: https://img.shields.io/docker/image-size/lobehub/lobe-chat?color=369eff&labelColor=black&style=flat-square