ChatGPT/FastGPT
1
0
Fork 0
mirror of https://github.com/labring/FastGPT.git synced 2025-07-23 05:12:39 +00:00
Code Issues Packages Projects Releases Wiki Activity

docs (#165)

Browse Source 
* perf: log

* README

* docs
This commit is contained in:
Archer
2023-08-10 14:26:10 +08:00
committed by GitHub
parent 4dc0fd3c3f
commit a0c397cfd2
9 changed files with 209 additions and 34 deletions
Download Patch File Download Diff File Expand all files Collapse all files

34
docSite/docs/develop/data_config/intro.md
View File

@@ -4,34 +4,36 @@ sidebar_position: 1
# Quick Introduction
Due to the limitations of environment variables in configuring complex content, the new version of FastGPT uses ConfigMap to mount configuration files. You can find the default configuration file at client/data/config.json.
In the development environment, you need to make a copy of config.json as config.local.json for it to take effect.
This configuration file includes customization of the frontend page, system-level parameters, and AI dialogue models, etc.
Due to the limitations of environment variables in configuring complex content, the new version of FastGPT uses ConfigMap to mount the configuration file. You can see the default configuration file in `client/data/config.json`. You can refer to [docker-compose deployment](/docs/develop/deploy/docker) to mount the configuration file.
In the development environment, you need to make a copy of `config.json` as `config.local.json` for it to take effect.
This configuration file contains customization of the frontend page, system-level parameters, and AI dialogue models, etc.
## Brief Explanation of Basic Fields
Here, we will introduce some basic configuration fields.
Here are some basic configuration fields.
```json
// This configuration controls some styles of the frontend
"FeConfig": {
"show_emptyChat": true, // Whether to display the introduction page when the conversation page is empty
"show_register": false, // Whether to display the registration button (including forget password, register account, and third-party login)
"show_appStore": false, // Whether to display the app store (currently the permissions are not properly set, so it is useless to open it)
"show_userDetail": false, // Whether to display user details (account balance, OpenAI binding)
"show_git": true, // Whether to display Git
"systemTitle": "FastAI", // The title of the system
"authorText": "Made by FastAI Team.", // Signature
"gitLoginKey": "" // Git login credentials
"show_emptyChat": true, // Whether to display the introduction page when the conversation page is empty
"show_register": false, // Whether to display the registration button (including forget password, register account, and third-party login)
"show_appStore": false, // Whether to display the app store (currently the permission is not properly set, so it is useless to open it)
"show_userDetail": false, // Whether to display user details (account balance, OpenAI binding)
"show_git": true, // Whether to display Git
"systemTitle": "FastGPT", // The title of the system
"authorText": "Made by FastGPT Team.", // Signature
"gitLoginKey": "" // Git login credentials
}
```
```json
// This configuration file contains system-level parameters
"SystemParams": {
"gitLoginSecret": "", // Git login credentials
"vectorMaxProcess": 15, // Maximum number of processes for vector generation, set in combination with database performance and key
"qaMaxProcess": 15, // Maximum number of processes for QA generation, set in combination with database performance and key
"pgIvfflatProbe": 20 // pg vector search probe. Can be ignored before setting up the index, usually only needed for more than 500,000 groups.
"gitLoginSecret": "", // Git login credentials
"vectorMaxProcess": 15, // Maximum number of processes for vector generation, set in combination with database performance and key
"qaMaxProcess": 15, // Maximum number of processes for QA generation, set in combination with database performance and key
"pgIvfflatProbe": 20 // pg vector search probe. Can be ignored before setting the index, usually only needed for more than 500,000 groups.
},
```

6
docSite/i18n/zh-Hans/docusaurus-plugin-content-docs/current/develop/data_config/intro.md
View File

@@ -4,7 +4,7 @@ sidebar_position: 1
# 快速介绍
由于环境变量不利于配置复杂的内容，新版 FastGPT 采用了 ConfigMap 的形式挂载配置文件，你可以在 client/data/config.json 看到默认的配置文件。
由于环境变量不利于配置复杂的内容，新版 FastGPT 采用了 ConfigMap 的形式挂载配置文件，你可以在 client/data/config.json 看到默认的配置文件。可以参考 [docker-compose 部署](/docs/develop/deploy/docker) 来挂载配置文件。
开发环境下，你需要复制一份 config.json 成 config.local.json 文件才会生效。
@@ -22,8 +22,8 @@ sidebar_position: 1
"show_appStore": false, // 是否展示应用市场（不过目前权限还没做好，放开也没用）
"show_userDetail": false, // 是否展示用户详情（账号余额、OpenAI 绑定）
"show_git": true, // 是否展示 Git
"systemTitle": "FastAI", // 系统的 title
"authorText": "Made by FastAI Team.", // 签名
"systemTitle": "FastGPT", // 系统的 title
"authorText": "Made by FastGPT Team.", // 签名
"gitLoginKey": "" // Git 登录凭证
}
```