Skip to content

Commit 36d1ff3

Browse files
c121914yuxqvvunewfish-cmykFinleyGe
authored
feat: custom domain (#6067)
* perf: faq * index * delete dataset * delete dataset * perf: delete dataset * init * fix: faq * doc * fix: share link auth (#6063) * standard plan add custom domain config (#6061) * standard plan add custom domain config * bill detail modal * perf: vector count api * feat: custom domain & wecom bot SaaS integration (#6047) * feat: custom Domain type define * feat: custom domain * feat: wecom custom domain * chore: i18n * chore: i18n; team auth * feat: wecom multi-model message support * chore: wecom edit modal * chore(doc): custom domain && wecom bot * fix: type * fix: type * fix: file detect * feat: fe * fix: img name * fix: test * compress img * rename * editor initial status * fix: chat url * perf: s3 upload by buffer * img * refresh * fix: custom domain selector (#6069) * empty tip * perf: s3 init * sort provider * fix: extend * perf: extract filename --------- Co-authored-by: Roy <[email protected]> Co-authored-by: heheer <[email protected]> Co-authored-by: Finley Ge <[email protected]>
1 parent d354fd4 commit 36d1ff3

File tree

132 files changed

+2108
-622
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

132 files changed

+2108
-622
lines changed

document/content/docs/introduction/development/openapi/share.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ description: FastGPT 分享链接身份鉴权
2828

2929
`FastGPT` 将会判断`success`是否为`true`决定是允许用户继续操作。`message``msg`是等同的,你可以选择返回其中一个,当`success`不为`true`时,将会提示这个错误。
3030

31-
`uid` 是用户的唯一凭证,必须返回该 ID 且 ID 的格式为不包含 "|"、"/“、"\" 字符的、长度小于等于 255 的字符串,否则会返回 `Invalid UID` 的错误。`uid` 将会用于拉取对话记录以及保存对话记录,可参考下方实践案例。
31+
`uid` 是用户的唯一凭证,必须返回该 ID 且 ID 的格式为不包含 "|"、"/“、"\\" 字符的、小于等于 255 **字节长度**的字符串,否则会返回 `Invalid UID` 的错误。`uid` 将会用于拉取对话记录以及保存对话记录,可参考下方实践案例。
3232

3333
### 触发流程
3434

Lines changed: 42 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,42 @@
1+
---
2+
title: 配置自定义域名
3+
description: 如何在 FastGPT 中配置自定义域名
4+
---
5+
6+
FastGPT 云服务版自 v4.14.4 后支持配置自定义域名。
7+
8+
## 如何配置自定义域名
9+
10+
### 1. 打开“自定义域名”页面
11+
12+
在侧边栏选择“账号” -> “自定义域名”,打开自定义域名配置页。
13+
14+
如果您的套餐等级不支持配置,请根据页面的指引升级套餐。
15+
16+
![打开配置页面](/imgs/guide/team_permissions/customDomain/1.png)
17+
18+
### 2. 添加自定义域名
19+
20+
1. 准备好您的域名。您的域名必须先经过备案,目前支持“阿里云”、“腾讯云”、“火山引擎”三家服务商的备案域名。
21+
2. 点击“编辑”按钮,进入编辑状态。
22+
3. 填入您的域名,例如 www.example.com
23+
4. 在域名服务商的域名解析处,添加界面中提示的 DNS 纪录,注意纪录类型为 CNAME。
24+
5. 添加解析纪录后,点击“保存”按钮。系统将自动检查 DNS 解析情况,一般情况下,在一分钟内就可以获取到解析纪录。如果长时间没有获取到纪录,可以重试一次。
25+
6. 待状态提示显示为“已生效”后,点击“确认”按钮即可。
26+
27+
![配置自定义域名](/imgs/guide/team_permissions/customDomain/2.png)
28+
29+
现在您可以通过您自己的域名访问 fastgpt 服务、调用 fastgpt 的 API 了。
30+
31+
## 域名解析失效
32+
33+
系统会每天对 DNS 解析进行检查,如果发现 DNS 解析纪录失效,则会停用该自定义域名,可以在“自定义域名”管理界面中点击“编辑”进行重新解析。
34+
35+
![编辑](/imgs/guide/team_permissions/customDomain/3.png)
36+
37+
如果您需要修改自定义域名、或修改服务商,则需要删除自定义域名配置后进行重新配置。
38+
39+
40+
## 使用案例
41+
42+
- [接入企业微信智能机器人](/docs/use-cases/external-integration/wecom)
Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
{
22
"title": "团队与权限",
33
"description": "团队管理、成员组与权限设置,确保团队协作中的数据安全和权限分配合理。",
4-
"pages": ["team_roles_permissions","invitation_link"]
5-
}
4+
"pages": ["team_roles_permissions","invitation_link", "customDomain"]
5+
}

document/content/docs/toc.mdx

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -92,6 +92,7 @@ description: FastGPT 文档目录
9292
- [/docs/introduction/guide/plugins/google_search_plugin_guide](/docs/introduction/guide/plugins/google_search_plugin_guide)
9393
- [/docs/introduction/guide/plugins/searxng_plugin_guide](/docs/introduction/guide/plugins/searxng_plugin_guide)
9494
- [/docs/introduction/guide/plugins/upload_system_tool](/docs/introduction/guide/plugins/upload_system_tool)
95+
- [/docs/introduction/guide/team_permissions/customDomain](/docs/introduction/guide/team_permissions/customDomain)
9596
- [/docs/introduction/guide/team_permissions/invitation_link](/docs/introduction/guide/team_permissions/invitation_link)
9697
- [/docs/introduction/guide/team_permissions/team_roles_permissions](/docs/introduction/guide/team_permissions/team_roles_permissions)
9798
- [/docs/introduction/index](/docs/introduction/index)

document/content/docs/upgrading/4-14/4144.mdx

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -31,6 +31,7 @@ curl --location --request POST 'https://{{host}}/api/admin/initv4144' \
3131
5. 新版订阅套餐逻辑。
3232
6. 支持配置对话文件白名单。
3333
7. S3 支持 pathStyle 配置。
34+
8. 支持通过 Sealos 来进行多租户自定义域名配置。
3435

3536
## ⚙️ 优化
3637

@@ -56,3 +57,4 @@ curl --location --request POST 'https://{{host}}/api/admin/initv4144' \
5657

5758
## 插件
5859

60+
1. 新增 GLM4.6 与 DS3.2 系列模型预设。

document/content/docs/use-cases/external-integration/wecom.mdx

Lines changed: 32 additions & 81 deletions
Original file line numberDiff line numberDiff line change
@@ -3,119 +3,70 @@ title: 接入企微机器人教程
33
description: FastGPT 接入企微机器人教程
44
---
55

6-
从 4.12.4 版本起,FastGPT 商业版支持直接接入企微机器人,无需额外的 API。
6+
- 从 4.12.4 版本起,FastGPT 商业版支持直接接入企微机器人,无需额外的 API。
7+
- 从 4.14.4 版本起,FastGPT 云服务版支持通过配置自定义域名的方式接入企微智能机器人。
78

8-
## 1. 配置可信域名和可信IP
9+
## 1. (云服务版必须)配置自定义域名
910

10-
点击企微头像,打开管理企业
11+
企微要求智能机器人消息推送地址必须使用企业主体域名,因此云服务版本用户必须先配置自定义域名才能使用企微机器人。
1112

12-
![图片](/imgs/wecom-bot-1.png)
13+
- [配置自定义域名](/docs/introduction/guide/team_permissions/customDomain)
1314

14-
在应用管理中找到"自建"-"创建应用"
15+
若您是商业版用户,请继续使用您企业的域名。
1516

16-
![图片](/imgs/wecom-bot-2.png)
17+
## 2. 创建智能机器人
1718

18-
创建好应用后, 下拉, 依次配置"网页授权及JS-SDK"和"企业可信IP"
19+
### 2.1 超级管理员登录
1920

20-
![图片](/imgs/wecom-bot-3.png)
21+
[点击打开企业微信管理后台](https://work.weixin.qq.com/)
2122

22-
其中, 网页授权及JS-SDK要求按照企微指引,完成域名归属认证
23+
### 2.2 找到智能机器人入口
2324

24-
![图片](/imgs/wecom-bot-4.png)
25+
在"安全与管理" - "管理工具"页面点击"智能机器人" ( 注意: 只有企业创建者或超级管理员才有权限看到这个入口 )
2526

26-
企业可信IP要求为企业服务器IP, 后续企微的回调URL将请求到此IP
27+
![图片](/imgs/use-cases/external-integration/wecom/1.png)
2728

28-
![图片](/imgs/wecom-bot-5.png)
29+
### 2.3 选择 “API模式创建” 智能机器人
2930

30-
## 2. 创建企业自建应用
31+
在创建机器人页面, 下拉, 点击 "API模式创建"
3132

32-
前往 FastGPT ,选择想要接入的应用,在 发布渠道 页面,新建一个接入企微智能机器人的发布渠道,填写好基础信息。
33+
![图片](/imgs/use-cases/external-integration/wecom/2.png)
3334

34-
![图片](/imgs/wecom-bot-6.png)
35+
### 2.4 获取关键密钥
3536

36-
现在回到企业微信平台,找到 Corp ID, Secret, Agent ID, Token, AES Key 信息并填写回 FastGPT 平台
37+
随机生成或者手动输入 Token 和 Encoding-AESKey,并且纪录下来
3738

38-
![图片](/imgs/wecom-bot-7.png)
39+
![图片](/imgs/use-cases/external-integration/wecom/3.png)
3940

40-
在"我的企业"里找到企业 ID, 填写到 FastGPT 的 Corp ID 中
41+
### 2.5 创建企微机器人发布渠道
4142

42-
![图片](/imgs/wecom-bot-8.png)
43+
在 FastGPT 中,选择要使用 Agent,在发布渠道页面,选择“企业微信机器人”,点击“创建”
4344

44-
在应用中找到 Agent Id 和 Secret, 并填写回 FastGPT
45+
![图片](/imgs/use-cases/external-integration/wecom/4.png)
4546

46-
![图片](/imgs/wecom-bot-9.png)
47+
### 2.6 配置发布渠道信息
4748

48-
点击"消息接收"-"设置API接收"
49+
配置该发布渠道的信息,需要填入 Token 和 AESKey,也就是第四步中纪录下来的 Token 和 Encoding-AESKey
4950

50-
![图片](/imgs/wecom-bot-10.png)
51+
![图片](/imgs/use-cases/external-integration/wecom/5.png)
5152

52-
随机生成或者手动输入 Token 和 Encoding-Key, 分别填写到 FastGPT 的 Token 和 AES Key 中
53+
### 2.7 复制回调地址
5354

54-
![图片](/imgs/wecom-bot-11.png)
55+
点击“确认”后,选择您配置的自定义域名,复制回调地址,填回企微智能机器人配置页中。
5556

56-
填写完成后确认创建
57+
![图片](/imgs/use-cases/external-integration/wecom/6.png)
5758

58-
然后点击请求地址, 复制页面中的链接
59-
60-
![图片](/imgs/wecom-bot-12.png)
61-
62-
回到刚才的配置详情, 将刚才复制的链接填入 URL 框中, 并点击下方的保存 ,即可完成自建应用的创建
63-
64-
注意: 若复制的链接是以 "http://localhost" 开头, 需要将本地地址改为企业主体域名
65-
66-
因为企微会给填写的 URL 发送验证密文, 若 URL 为本地地址, 则本地接收不到企微的密文
67-
68-
若 URL 不是企业主体域名, 则验证会失败
69-
70-
## 3. 创建智能机器人
71-
72-
第二步创建企业自建应用是为了验证域名和IP的合规性, 并获取 secret 参数, 下面创建智能机器人才是正式的配置流程
73-
74-
在"安全与管理" - "管理工具"页面找到"智能机器人" ( 注意: 只有企业创建者或超级管理员才有权限看到这个入口 )
75-
76-
![图片](/imgs/wecom-bot-13.png)
77-
78-
创建机器人页面,下拉,找到,点击"API模式创建"
79-
80-
![图片](/imgs/wecom-bot-14.png)
81-
82-
与刚才配置自建应用同理, 在 FastGPT 平台再新增一个发布渠道, 并回到企业微信配置参数
83-
84-
![图片](/imgs/wecom-bot-19.png)
85-
86-
随机生成或者手动输入 Token 和 Encoding-AESKey, 分别填写到 FastGPT 的 Token 和 AES Key 中
87-
88-
![图片](/imgs/wecom-bot-15.png)
89-
90-
Corp ID 和 Secret 这两个参数和刚才的自建应用保持一致
91-
92-
Agent ID 和自建应用的不同, 需要先填写一个自定义值, 后续会根据企业微信提供的数据重新更改
93-
94-
在 FastGPT 将Corp ID, Secret, Agent ID, Token, AES Key 等参数都填写完毕后, 点击确认
95-
96-
然后点击请求地址, 复制页面中的链接
97-
98-
回到企业微信, 将链接粘贴到智能机器人的 URL 配置栏, 点击创建
99-
100-
创建完成后, 找到智能机器人的配置详情
101-
102-
![图片](/imgs/wecom-bot-16.png)
103-
104-
复制 Bot ID, 填写到 FastGPT 的 Agent ID 中, 即可完成智能机器人配置
105-
106-
![图片](/imgs/wecom-bot-17.png)
107-
108-
## 4. 使用智能机器人
59+
## 3. 使用智能机器人
10960

11061
在企业微信平台的"通讯录",即可找到创建的机器人,就可以发送消息了
11162

112-
![图片](/imgs/wecom-bot-18.png)
63+
![图片](/imgs/use-cases/external-integration/wecom/7.png)
11364

11465
## FAQ
11566

11667
### 发送了消息,没响应
11768

118-
1. 检查可信域名和可信IP是否配置正确
119-
2. 检查自建应用的 Secret 参数是否与智能机器人一致
120-
3. 查看 FastGPT 对话日志,是否有对应的提问记录
69+
1. 检查可信域名是否配置正确
70+
2. 检查 Token 和 Encoding-AESKey 是否正确
71+
3. 查看 FastGPT 对话日志,是否有对应的提问记录
12172
4. 如果没记录,则可能是应用运行报错了,可以先试试最简单的机器人.

document/data/doc-last-modified.json

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@
3434
"document/content/docs/introduction/development/openapi/chat.mdx": "2025-11-14T13:21:17+08:00",
3535
"document/content/docs/introduction/development/openapi/dataset.mdx": "2025-09-29T11:34:11+08:00",
3636
"document/content/docs/introduction/development/openapi/intro.mdx": "2025-09-29T11:34:11+08:00",
37-
"document/content/docs/introduction/development/openapi/share.mdx": "2025-12-08T16:10:51+08:00",
37+
"document/content/docs/introduction/development/openapi/share.mdx": "2025-12-09T12:18:15+08:00",
3838
"document/content/docs/introduction/development/proxy/cloudflare.mdx": "2025-07-23T21:35:03+08:00",
3939
"document/content/docs/introduction/development/proxy/http_proxy.mdx": "2025-07-23T21:35:03+08:00",
4040
"document/content/docs/introduction/development/proxy/nginx.mdx": "2025-07-23T21:35:03+08:00",
@@ -89,6 +89,7 @@
8989
"document/content/docs/introduction/guide/plugins/google_search_plugin_guide.mdx": "2025-07-23T21:35:03+08:00",
9090
"document/content/docs/introduction/guide/plugins/searxng_plugin_guide.mdx": "2025-07-23T21:35:03+08:00",
9191
"document/content/docs/introduction/guide/plugins/upload_system_tool.mdx": "2025-11-04T16:58:12+08:00",
92+
"document/content/docs/introduction/guide/team_permissions/customDomain.mdx": "2025-12-09T18:14:22+08:00",
9293
"document/content/docs/introduction/guide/team_permissions/invitation_link.mdx": "2025-07-23T21:35:03+08:00",
9394
"document/content/docs/introduction/guide/team_permissions/team_roles_permissions.mdx": "2025-07-23T21:35:03+08:00",
9495
"document/content/docs/introduction/index.en.mdx": "2025-07-23T21:35:03+08:00",
@@ -101,7 +102,7 @@
101102
"document/content/docs/protocol/terms.en.mdx": "2025-08-03T22:37:45+08:00",
102103
"document/content/docs/protocol/terms.mdx": "2025-08-03T22:37:45+08:00",
103104
"document/content/docs/toc.en.mdx": "2025-08-04T13:42:36+08:00",
104-
"document/content/docs/toc.mdx": "2025-11-29T09:24:47+08:00",
105+
"document/content/docs/toc.mdx": "2025-12-09T18:14:22+08:00",
105106
"document/content/docs/upgrading/4-10/4100.mdx": "2025-08-02T19:38:37+08:00",
106107
"document/content/docs/upgrading/4-10/4101.mdx": "2025-09-08T20:07:20+08:00",
107108
"document/content/docs/upgrading/4-11/4110.mdx": "2025-08-05T23:20:39+08:00",
@@ -118,7 +119,7 @@
118119
"document/content/docs/upgrading/4-14/4141.mdx": "2025-11-19T10:15:27+08:00",
119120
"document/content/docs/upgrading/4-14/4142.mdx": "2025-11-18T19:27:14+08:00",
120121
"document/content/docs/upgrading/4-14/4143.mdx": "2025-11-26T20:52:05+08:00",
121-
"document/content/docs/upgrading/4-14/4144.mdx": "2025-12-08T17:57:59+08:00",
122+
"document/content/docs/upgrading/4-14/4144.mdx": "2025-12-08T21:45:21+08:00",
122123
"document/content/docs/upgrading/4-8/40.mdx": "2025-08-02T19:38:37+08:00",
123124
"document/content/docs/upgrading/4-8/41.mdx": "2025-08-02T19:38:37+08:00",
124125
"document/content/docs/upgrading/4-8/42.mdx": "2025-08-02T19:38:37+08:00",
@@ -198,6 +199,6 @@
198199
"document/content/docs/use-cases/external-integration/feishu.mdx": "2025-07-24T14:23:04+08:00",
199200
"document/content/docs/use-cases/external-integration/official_account.mdx": "2025-08-05T23:20:39+08:00",
200201
"document/content/docs/use-cases/external-integration/openapi.mdx": "2025-09-29T11:34:11+08:00",
201-
"document/content/docs/use-cases/external-integration/wecom.mdx": "2025-09-16T14:22:28+08:00",
202+
"document/content/docs/use-cases/external-integration/wecom.mdx": "2025-12-09T20:03:29+08:00",
202203
"document/content/docs/use-cases/index.mdx": "2025-07-24T14:23:04+08:00"
203204
}

document/package-lock.json

Lines changed: 1 addition & 11 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.
91.9 KB
Loading
176 KB
Loading

0 commit comments

Comments
 (0)