Skip to content

Commit 05d80b9

Browse files
chenymechenyme
authored
Merge pull request #488 from DEEIX-AI/brand
fix: enhance branding configuration and public API endpoints for branding details
2 parents 5a500c5 + 59008b8 commit 05d80b9

39 files changed

Lines changed: 1042 additions & 324 deletions

‎Dockerfile‎

Lines changed: 0 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -10,26 +10,6 @@ ENV PATH=$PNPM_HOME:$PATH
1010
ARG NEXT_PUBLIC_API_BASE_URL=""
1111
ENV NEXT_PUBLIC_API_BASE_URL=${NEXT_PUBLIC_API_BASE_URL}
1212

13-
ARG NEXT_PUBLIC_LOGO_URL=""
14-
ARG NEXT_PUBLIC_FAVICON_URL=""
15-
ARG NEXT_PUBLIC_PWA_ICON_192_URL=""
16-
ARG NEXT_PUBLIC_PWA_ICON_512_URL=""
17-
ARG NEXT_PUBLIC_PWA_MASKABLE_ICON_512_URL=""
18-
ARG NEXT_PUBLIC_APPLE_TOUCH_ICON_180_URL=""
19-
ARG NEXT_PUBLIC_BRAND_TITLE=""
20-
ARG NEXT_PUBLIC_BRAND_SHORT_NAME=""
21-
ARG NEXT_PUBLIC_BRAND_DESCRIPTION=""
22-
23-
ENV NEXT_PUBLIC_LOGO_URL=${NEXT_PUBLIC_LOGO_URL}
24-
ENV NEXT_PUBLIC_FAVICON_URL=${NEXT_PUBLIC_FAVICON_URL}
25-
ENV NEXT_PUBLIC_PWA_ICON_192_URL=${NEXT_PUBLIC_PWA_ICON_192_URL}
26-
ENV NEXT_PUBLIC_PWA_ICON_512_URL=${NEXT_PUBLIC_PWA_ICON_512_URL}
27-
ENV NEXT_PUBLIC_PWA_MASKABLE_ICON_512_URL=${NEXT_PUBLIC_PWA_MASKABLE_ICON_512_URL}
28-
ENV NEXT_PUBLIC_APPLE_TOUCH_ICON_180_URL=${NEXT_PUBLIC_APPLE_TOUCH_ICON_180_URL}
29-
ENV NEXT_PUBLIC_BRAND_TITLE=${NEXT_PUBLIC_BRAND_TITLE}
30-
ENV NEXT_PUBLIC_BRAND_SHORT_NAME=${NEXT_PUBLIC_BRAND_SHORT_NAME}
31-
ENV NEXT_PUBLIC_BRAND_DESCRIPTION=${NEXT_PUBLIC_BRAND_DESCRIPTION}
32-
3313
COPY VERSION /src/VERSION
3414
COPY scripts /src/scripts
3515
COPY frontend/package.json frontend/pnpm-lock.yaml ./

‎README.md‎

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -311,10 +311,12 @@ If a superadmin already exists, the service does not regenerate or print the ini
311311

312312
> Full configuration guide: [Configuration](https://deeix.com/docs/deeix-chat/configuration).
313313
314-
Backend configuration is split into static runtime configuration and runtime business settings. Static runtime configuration describes the infrastructure, security, and storage parameters required to start the service, and is provided through `config.yaml` and environment variables. Runtime business settings cover product capabilities such as authentication, conversations, models, files, and billing; they are stored in `system_settings` and maintained from the admin console. Environment variables override matching config-file values, which is useful for containerized deployments, separated deployments, and secret injection.
314+
Backend configuration is split into static runtime configuration and runtime business settings. Static runtime configuration describes branding and the infrastructure, security, and storage parameters required to start the service, and is provided through `config.yaml` and environment variables. Runtime business settings cover product capabilities such as authentication, conversations, models, files, and billing; they are stored in `system_settings` and maintained from the admin console. Environment variables override matching config-file values, which is useful for containerized deployments, separated deployments, and secret injection.
315315

316316
At startup, the backend resolves the default config file from the working directory: starting from the repository root reads `config.yaml`, while starting from `backend/` reads `../config.yaml`. Docker deployments usually mount host `./config.yaml` as read-only `/app/config.yaml` inside the container. If the config file is stored elsewhere, set `CONFIG_FILE` to a path accessible from the running process or container.
317317

318+
Frontend branding is also runtime configuration. Set the `branding` section in `config.yaml`, then restart the application; rebuilding the frontend or Docker image is not required. See [Custom branding](docs/BRANDING.md).
319+
318320
Static configuration environment variables:
319321

320322
| Area | Environment variable | Purpose |

‎README.zh-CN.md‎

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -208,7 +208,7 @@ docker compose -f docker-compose.full.yml up -d
208208

209209
#### 配置、持久化和镜像
210210

211-
配置优先级是：`环境变量 > config.yaml > 代码内置默认值`。`config.yaml` 只负责静态基础设施和安全配置，例如服务地址、数据库、缓存、存储、GeoIP、Trace、JWT 和加密密钥。运行时业务配置存储在数据库中，并通过后台管理修改。
211+
配置优先级是：`环境变量 > config.yaml > 代码内置默认值`。`config.yaml` 负责品牌和静态基础设施、安全配置，例如品牌资源、服务地址、数据库、缓存、存储、GeoIP、Trace、JWT 和加密密钥。运行时业务配置存储在数据库中，并通过后台管理修改。
212212

213213
默认 compose 会持久化应用数据：
214214

@@ -311,10 +311,12 @@ docker compose logs app
311311

312312
> 完整配置说明：[配置说明](https://deeix.com/zh/docs/deeix-chat/configuration)。
313313
314-
后端配置分为静态运行配置和运行时业务配置。静态运行配置用于描述服务启动所需的基础设施、安全和存储参数，由 `config.yaml` 与环境变量提供；运行时业务配置用于认证、会话、模型、文件、计费等产品能力，写入 `system_settings` 并通过后台管理维护。环境变量会覆盖配置文件中的同名项，适合容器化、分离部署和密钥注入场景。
314+
后端配置分为静态运行配置和运行时业务配置。静态运行配置用于描述品牌以及服务启动所需的基础设施、安全和存储参数，由 `config.yaml` 与环境变量提供；运行时业务配置用于认证、会话、模型、文件、计费等产品能力，写入 `system_settings` 并通过后台管理维护。环境变量会覆盖配置文件中的同名项，适合容器化、分离部署和密钥注入场景。
315315

316316
后端启动时会按运行目录解析默认配置文件：从仓库根目录启动读取 `config.yaml`，从 `backend/` 目录启动读取 `../config.yaml`。Docker 部署通常将宿主机 `./config.yaml` 只读挂载到容器内 `/app/config.yaml`；如果配置文件放在其他位置，请使用 `CONFIG_FILE` 指向实际运行环境可访问的路径。
317317

318+
前端品牌同样属于运行时配置。在 `config.yaml` 中设置 `branding` 后重启应用即可生效，无需重新构建前端或 Docker 镜像。详见[自定义品牌资源](docs/BRANDING.md)。
319+
318320
静态配置环境变量：
319321

320322
| 所属域 | 环境变量 | 说明 |

‎backend/docs/docs.go‎

Lines changed: 148 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6625,6 +6625,44 @@ const docTemplate = `{
66256625
}
66266626
}
66276627
},
6628+
"/branding": {
6629+
"get": {
6630+
"produces": [
6631+
"application/json"
6632+
],
6633+
"tags": [
6634+
"settings"
6635+
],
6636+
"summary": "查询公开品牌配置",
6637+
"responses": {
6638+
"200": {
6639+
"description": "OK",
6640+
"schema": {
6641+
"$ref": "#/definitions/internal_transport_http_settings.BrandingResponseDoc"
6642+
}
6643+
}
6644+
}
6645+
}
6646+
},
6647+
"/branding/manifest.webmanifest": {
6648+
"get": {
6649+
"produces": [
6650+
"application/manifest+json"
6651+
],
6652+
"tags": [
6653+
"settings"
6654+
],
6655+
"summary": "查询品牌 Web App Manifest",
6656+
"responses": {
6657+
"200": {
6658+
"description": "OK",
6659+
"schema": {
6660+
"$ref": "#/definitions/internal_transport_http_settings.BrandingManifestResponse"
6661+
}
6662+
}
6663+
}
6664+
}
6665+
},
66286666
"/context-artifacts/{id}": {
66296667
"get": {
66306668
"security": [
@@ -17681,6 +17719,116 @@ const docTemplate = `{
1768117719
}
1768217720
}
1768317721
},
17722+
"internal_transport_http_settings.BrandingManifestIcon": {
17723+
"type": "object",
17724+
"properties": {
17725+
"purpose": {
17726+
"type": "string"
17727+
},
17728+
"sizes": {
17729+
"type": "string"
17730+
},
17731+
"src": {
17732+
"type": "string"
17733+
},
17734+
"type": {
17735+
"type": "string"
17736+
}
17737+
}
17738+
},
17739+
"internal_transport_http_settings.BrandingManifestResponse": {
17740+
"type": "object",
17741+
"properties": {
17742+
"background_color": {
17743+
"type": "string"
17744+
},
17745+
"categories": {
17746+
"type": "array",
17747+
"items": {
17748+
"type": "string"
17749+
}
17750+
},
17751+
"description": {
17752+
"type": "string"
17753+
},
17754+
"display": {
17755+
"type": "string"
17756+
},
17757+
"icons": {
17758+
"type": "array",
17759+
"items": {
17760+
"$ref": "#/definitions/internal_transport_http_settings.BrandingManifestIcon"
17761+
}
17762+
},
17763+
"id": {
17764+
"type": "string"
17765+
},
17766+
"lang": {
17767+
"type": "string"
17768+
},
17769+
"name": {
17770+
"type": "string"
17771+
},
17772+
"orientation": {
17773+
"type": "string"
17774+
},
17775+
"scope": {
17776+
"type": "string"
17777+
},
17778+
"short_name": {
17779+
"type": "string"
17780+
},
17781+
"start_url": {
17782+
"type": "string"
17783+
},
17784+
"theme_color": {
17785+
"type": "string"
17786+
}
17787+
}
17788+
},
17789+
"internal_transport_http_settings.BrandingResponse": {
17790+
"type": "object",
17791+
"properties": {
17792+
"appleTouchIcon180URL": {
17793+
"type": "string"
17794+
},
17795+
"description": {
17796+
"type": "string"
17797+
},
17798+
"faviconURL": {
17799+
"type": "string"
17800+
},
17801+
"logoURL": {
17802+
"type": "string"
17803+
},
17804+
"pwaIcon192URL": {
17805+
"type": "string"
17806+
},
17807+
"pwaIcon512URL": {
17808+
"type": "string"
17809+
},
17810+
"pwaMaskableIcon512URL": {
17811+
"type": "string"
17812+
},
17813+
"shortName": {
17814+
"type": "string"
17815+
},
17816+
"title": {
17817+
"type": "string"
17818+
}
17819+
}
17820+
},
17821+
"internal_transport_http_settings.BrandingResponseDoc": {
17822+
"type": "object",
17823+
"properties": {
17824+
"data": {
17825+
"$ref": "#/definitions/internal_transport_http_settings.BrandingResponse"
17826+
},
17827+
"errorMsg": {
17828+
"type": "string"
17829+
}
17830+
}
17831+
},
1768417832
"internal_transport_http_settings.PatchItem": {
1768517833
"type": "object",
1768617834
"required": [

‎backend/docs/swagger.json‎

Lines changed: 148 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6618,6 +6618,44 @@
66186618
}
66196619
}
66206620
},
6621+
"/branding": {
6622+
"get": {
6623+
"produces": [
6624+
"application/json"
6625+
],
6626+
"tags": [
6627+
"settings"
6628+
],
6629+
"summary": "查询公开品牌配置",
6630+
"responses": {
6631+
"200": {
6632+
"description": "OK",
6633+
"schema": {
6634+
"$ref": "#/definitions/internal_transport_http_settings.BrandingResponseDoc"
6635+
}
6636+
}
6637+
}
6638+
}
6639+
},
6640+
"/branding/manifest.webmanifest": {
6641+
"get": {
6642+
"produces": [
6643+
"application/manifest+json"
6644+
],
6645+
"tags": [
6646+
"settings"
6647+
],
6648+
"summary": "查询品牌 Web App Manifest",
6649+
"responses": {
6650+
"200": {
6651+
"description": "OK",
6652+
"schema": {
6653+
"$ref": "#/definitions/internal_transport_http_settings.BrandingManifestResponse"
6654+
}
6655+
}
6656+
}
6657+
}
6658+
},
66216659
"/context-artifacts/{id}": {
66226660
"get": {
66236661
"security": [
@@ -17674,6 +17712,116 @@
1767417712
}
1767517713
}
1767617714
},
17715+
"internal_transport_http_settings.BrandingManifestIcon": {
17716+
"type": "object",
17717+
"properties": {
17718+
"purpose": {
17719+
"type": "string"
17720+
},
17721+
"sizes": {
17722+
"type": "string"
17723+
},
17724+
"src": {
17725+
"type": "string"
17726+
},
17727+
"type": {
17728+
"type": "string"
17729+
}
17730+
}
17731+
},
17732+
"internal_transport_http_settings.BrandingManifestResponse": {
17733+
"type": "object",
17734+
"properties": {
17735+
"background_color": {
17736+
"type": "string"
17737+
},
17738+
"categories": {
17739+
"type": "array",
17740+
"items": {
17741+
"type": "string"
17742+
}
17743+
},
17744+
"description": {
17745+
"type": "string"
17746+
},
17747+
"display": {
17748+
"type": "string"
17749+
},
17750+
"icons": {
17751+
"type": "array",
17752+
"items": {
17753+
"$ref": "#/definitions/internal_transport_http_settings.BrandingManifestIcon"
17754+
}
17755+
},
17756+
"id": {
17757+
"type": "string"
17758+
},
17759+
"lang": {
17760+
"type": "string"
17761+
},
17762+
"name": {
17763+
"type": "string"
17764+
},
17765+
"orientation": {
17766+
"type": "string"
17767+
},
17768+
"scope": {
17769+
"type": "string"
17770+
},
17771+
"short_name": {
17772+
"type": "string"
17773+
},
17774+
"start_url": {
17775+
"type": "string"
17776+
},
17777+
"theme_color": {
17778+
"type": "string"
17779+
}
17780+
}
17781+
},
17782+
"internal_transport_http_settings.BrandingResponse": {
17783+
"type": "object",
17784+
"properties": {
17785+
"appleTouchIcon180URL": {
17786+
"type": "string"
17787+
},
17788+
"description": {
17789+
"type": "string"
17790+
},
17791+
"faviconURL": {
17792+
"type": "string"
17793+
},
17794+
"logoURL": {
17795+
"type": "string"
17796+
},
17797+
"pwaIcon192URL": {
17798+
"type": "string"
17799+
},
17800+
"pwaIcon512URL": {
17801+
"type": "string"
17802+
},
17803+
"pwaMaskableIcon512URL": {
17804+
"type": "string"
17805+
},
17806+
"shortName": {
17807+
"type": "string"
17808+
},
17809+
"title": {
17810+
"type": "string"
17811+
}
17812+
}
17813+
},
17814+
"internal_transport_http_settings.BrandingResponseDoc": {
17815+
"type": "object",
17816+
"properties": {
17817+
"data": {
17818+
"$ref": "#/definitions/internal_transport_http_settings.BrandingResponse"
17819+
},
17820+
"errorMsg": {
17821+
"type": "string"
17822+
}
17823+
}
17824+
},
1767717825
"internal_transport_http_settings.PatchItem": {
1767817826
"type": "object",
1767917827
"required": [

0 commit comments

Comments
 (0)