🐛 fix: fix CUSTOM_MODEL don't work with docker deployment

.env.example

@@ -2,7 +2,7 @@
 ACCESS_CODE=lobe66
 
 # add your custom model name, multi model separate by comma. for example gpt-3.5-1106,gpt-4-1106
-# NEXT_PUBLIC_CUSTOM_MODELS=model1,model2,model3
+# CUSTOM_MODELS=model1,model2,model3
 
 # ---- only choose one from OpenAI Service and Azure OpenAI Service ---- #
 

Dockerfile

@@ -58,7 +58,7 @@ ENV PORT=3210
 
 # General Variables
 ENV ACCESS_CODE "lobe66"
-ENV NEXT_PUBLIC_CUSTOM_MODELS ""
+ENV CUSTOM_MODELS ""
 
 # OpenAI
 ENV OPENAI_API_KEY ""

docs/Deployment/Environment-Variable.md

@@ -6,7 +6,7 @@ LobeChat provides additional configuration options during deployment, which can
 
 - [General Variables](#general-variables)
   - [`ACCESS_CODE`](#access_code)
-  - [`NEXT_PUBLIC_CUSTOM_MODELS`](#next_public_custom_models)
+  - [`CUSTOM_MODELS`](#custom_models)
 - [OpenAI](#openai)
   - [`OPENAI_API_KEY`](#openai_api_key)
   - [`OPENAI_PROXY_URL`](#openai_proxy_url)
@@ -31,7 +31,7 @@ LobeChat provides additional configuration options during deployment, which can
 - Default: `-`
 - Example: `awCTe)re_r74` or `rtrt_ewee3@09!` or `code1,code2,code3`
 
-### `NEXT_PUBLIC_CUSTOM_MODELS`
+### `CUSTOM_MODELS`
 
 - Type: Optional
 - Description: Used to control the model list. Use `+` to add a model, `-` to hide a model, and `model_name=display_name` to customize the display name of a model, separated by commas.

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

@@ -6,7 +6,7 @@ LobeChat 在部署时提供了一些额外的配置项，使用环境变量进
 
 - [通用变量](#通用变量)
   - [`ACCESS_CODE`](#access_code)
-  - [`NEXT_PUBLIC_CUSTOM_MODELS`](#next_public_custom_models)
+  - [`CUSTOM_MODELS`](#custom_models)
 - [OpenAI](#openai)
   - [`OPENAI_API_KEY`](#openai_api_key)
   - [`OPENAI_PROXY_URL`](#openai_proxy_url)
@@ -31,7 +31,7 @@ LobeChat 在部署时提供了一些额外的配置项，使用环境变量进
 - 默认值：-
 - 示例：`awCTe)re_r74` or `rtrt_ewee3@09!`
 
-### `NEXT_PUBLIC_CUSTOM_MODELS`
+### `CUSTOM_MODELS`
 
 - 类型：可选
 - 描述：用来控制模型列表，使用 `+` 增加一个模型，使用 `-` 来隐藏一个模型，使用 `模型名=展示名` 来自定义模型的展示名，用英文逗号隔开。

src/app/api/config/route.ts

@@ -0,0 +1,15 @@
+import { getServerConfig } from '@/config/server';
+import { GlobalServerConfig } from '@/types/settings';
+
+export const runtime = 'edge';
+
+/**
+ * get Server config to client
+ */
+export const GET = async () => {
+  const { CUSTOM_MODELS } = getServerConfig();
+
+  const config: GlobalServerConfig = { customModelName: CUSTOM_MODELS };
+
+  return new Response(JSON.stringify(config));
+};

src/layout/GlobalLayout/StoreHydration.tsx

@@ -8,12 +8,16 @@ import { useEffectAfterSessionHydrated, useSessionStore } from '@/store/session'
 const StoreHydration = memo(() => {
   const router = useRouter();
 
+  const useFetchGlobalConfig = useGlobalStore((s) => s.useFetchGlobalConfig);
+
   useEffect(() => {
     // refs: https://github.com/pmndrs/zustand/blob/main/docs/integrations/persisting-store-data.md#hashydrated
     useSessionStore.persist.rehydrate();
     useGlobalStore.persist.rehydrate();
   }, []);
 
+  useFetchGlobalConfig();
+
   const { mobile } = useResponsive();
 
   useEffectAfterSessionHydrated(
@@ -29,6 +33,7 @@ const StoreHydration = memo(() => {
     },
     [router],
   );
+
   useEffect(() => {
     router.prefetch('/chat');
     router.prefetch('/market');

src/services/__tests__/chat.test.ts

@@ -1,6 +1,6 @@
 import { LobeChatPluginManifest } from '@lobehub/chat-plugin-sdk';
 import { act } from '@testing-library/react';
-import { afterEach, beforeEach, describe, expect, it, vi } from 'vitest';
+import { describe, expect, it, vi } from 'vitest';
 
 import { VISION_MODEL_WHITE_LIST } from '@/const/llm';
 import { DEFAULT_AGENT_CONFIG } from '@/const/settings';

src/services/_url.ts

@@ -1,4 +1,5 @@
 export const URLS = {
+  config: '/api/config',
   market: '/api/market',
   plugins: '/api/plugins',
 };

src/services/global.ts

@@ -1,3 +1,6 @@
+import { URLS } from '@/services/_url';
+import { GlobalServerConfig } from '@/types/settings';
+
 const VERSION_URL = 'https://registry.npmmirror.com/@lobehub/chat';
 
 class GlobalService {
@@ -10,6 +13,12 @@ class GlobalService {
 
     return data['dist-tags']?.latest;
   };
+
+  getGlobalConfig = async (): Promise<GlobalServerConfig> => {
+    const res = await fetch(URLS.config);
+
+    return res.json();
+  };
 }
 
 export const globalService = new GlobalService();

src/store/global/initialState.ts

@@ -1,5 +1,5 @@
 import { DEFAULT_SETTINGS } from '@/const/settings';
-import type { GlobalSettings } from '@/types/settings';
+import type { GlobalServerConfig, GlobalSettings } from '@/types/settings';
 
 export enum SidebarTabKey {
   Chat = 'chat',
@@ -38,6 +38,7 @@ export interface GlobalState {
    *  @localStorage
    */
   preference: GlobalPreference;
+  serverConfig: GlobalServerConfig;
   /**
    * @localStorage
    * 用户设置
@@ -58,6 +59,7 @@ export const initialState: GlobalState = {
     showSessionPanel: true,
     showSystemRole: false,
   },
+  serverConfig: {},
   settings: DEFAULT_SETTINGS,
   settingsTab: SettingsTabs.Common,
   sidebarKey: SidebarTabKey.Chat,

src/store/global/selectors/settings.test.ts

@@ -61,12 +61,13 @@ describe('settingsSelectors', () => {
   describe('CUSTOM_MODELS', () => {
     it('custom deletion, addition, and renaming of models', () => {
       const s = {
+        serverConfig: {
+          customModelName:
+            '-all,+llama,+claude-2，-gpt-3.5-turbo,gpt-4-1106-preview=gpt-4-turbo,gpt-4-1106-preview=gpt-4-32k',
+        },
         settings: {
           languageModel: {
-            openAI: {
-              customModelName:
-                '-all,+llama,+claude-2，-gpt-3.5-turbo,gpt-4-1106-preview=gpt-4-turbo,gpt-4-1106-preview=gpt-4-32k',
-            },
+            openAI: {},
           },
         },
       } as unknown as GlobalStore;
@@ -78,6 +79,7 @@ describe('settingsSelectors', () => {
 
     it('duplicate naming model', () => {
       const s = {
+        serverConfig: {},
         settings: {
           languageModel: {
             openAI: {
@@ -94,6 +96,7 @@ describe('settingsSelectors', () => {
 
     it('only add the model', () => {
       const s = {
+        serverConfig: {},
         settings: {
           languageModel: {
             openAI: {

src/store/global/selectors/settings.ts

@@ -34,6 +34,7 @@ const modelListSelectors = (s: GlobalStore) => {
 
   const modelNames = [
     ...DEFAULT_OPENAI_MODEL_LIST,
+    ...(s.serverConfig.customModelName || '').split(/[,，]/).filter(Boolean),
     ...(s.settings.languageModel.openAI.customModelName || '').split(/[,，]/).filter(Boolean),
   ];
 

src/store/global/slices/common.ts

@@ -5,6 +5,7 @@ import type { StateCreator } from 'zustand/vanilla';
 
 import { CURRENT_VERSION } from '@/const/version';
 import { globalService } from '@/services/global';
+import type { GlobalServerConfig } from '@/types/settings';
 import { merge } from '@/utils/merge';
 import { setNamespace } from '@/utils/storeDebug';
 
@@ -28,6 +29,7 @@ export interface CommonAction {
   updateGuideState: (guide: Partial<Guide>) => void;
   updatePreference: (preference: Partial<GlobalPreference>, action?: string) => void;
   useCheckLatestVersion: () => SWRResponse<string>;
+  useFetchGlobalConfig: () => SWRResponse;
 }
 
 export const createCommonSlice: StateCreator<
@@ -78,4 +80,11 @@ export const createCommonSlice: StateCreator<
           set({ hasNewVersion: true, latestVersion: data }, false, n('checkLatestVersion'));
       },
     }),
+  useFetchGlobalConfig: () =>
+    useSWR<GlobalServerConfig>('fetchGlobalConfig', globalService.getGlobalConfig, {
+      onSuccess: (data) => {
+        set({ serverConfig: data });
+      },
+      revalidateOnFocus: false,
+    }),
 });

src/types/settings.ts

@@ -91,3 +91,7 @@ export interface GlobalSettings extends GlobalBaseSettings {
 }
 
 export type ConfigKeys = keyof GlobalSettings;
+
+export interface GlobalServerConfig {
+  customModelName?: string;
+}