What the data for this category looks like
Version release and Release Notes data typically comes from Git tags, merged commit logs, CI build artifacts, and Issue-linked milestones. The update cadence is once per official release. Daily produced documents include Release Notes, change logs, version tags, and release checklists. Common document fields include version identifiers, change categorization items, breaking change notes, and artifact checksum values. All content centers on merged change sets, and does not include uncommitted draft content.
What constraints these characteristics impose on the Deployment and Upgrade workflow
Data sources rely on code repository and CI artifact permissions. Deployment steps require corresponding storage and access permissions to be configured, to ensure the latest version metadata can be pulled. Update frequency is once per version. Upgrade processes must adapt to version tag validation logic, to avoid pulling unmarked temporary changes. Documents include change categorization and breaking change notes. Pre-deployment automatic validation steps must be configured to block versions with incomplete compliance annotations. Errors can cause upgrade failures, version rollbacks, or community misunderstandings. Rollback plans and version validation mechanisms must be configured to ensure release process stability.
How to configure the settings
These configurations apply to FastGPT v4.17.0.
| Configuration Item | Recommended Value | Rationale |
|---|---|---|
MONGODB_URI | mongodb://username:password@host:27017/fastgpt?authSource=admin | Adapts to storage requirements for version release metadata, links Git and CI artifact indexes, ensures persistent storage of version tags and change logs |
REDIS_URL | redis://:password@host:6379/0 | Caches query results for version tags and change logs, reduces overhead from repeated pulling of Git and CI data |
DB_MAX_LINK | 10–30 connections | Adapts to concurrent connection requirements for version release data, prevents metadata pull failures caused by exhausted connection pools |
STORAGE_S3_ENDPOINT | https://s3-cn-beijing.aliyuncs.com (adjust per actual storage region) | Stores Release Notes attachments and CI artifact check files, ensures complete storage of version release documents |
FE_DOMAIN | https://your-fastgpt-domain.com | Configures the access domain for version release pages, ensures correct access paths for internal tickets and on-call staff |
FILE_TOKEN_KEY | Random string generated per environment, minimum 32 characters in length | Validates the legitimacy of model API keys, ensures permissions for locally deployed model calls |
Three common configuration mistakes
- Scenario: Internal ticket-generated Release Notes only display fixed bottom reference prompts, with no custom linked knowledge base entries. Cause:
DB_MAX_LINKis not configured to limit the number of metadata pulls, causing linked knowledge base document indexes to fail to load normally. - Scenario: Version tags fail to sync after deployment, with an error prompt "Associated Git repository permissions not found". Cause:
STORAGE_S3_ENDPOINTis not correctly configured to link CI artifact storage paths, causing version metadata to fail to pull. - Scenario: Locally deployed model calls fail, with an error prompt "Invalid API key". Cause:
FILE_TOKEN_KEYis not configured for model API signature verification, causing locally deployed model keys to not be recognized by the system.
How to confirm configurations are correct
- Run the
mongo --uri $MONGODB_URIcommand to verify normal database connection, and confirm that collection data including version identifiers and change fields can be queried. - Access the
$FE_DOMAIN/api/release-notesinterface to confirm that the returned JSON data includes expected fields such as version numbers and change categorization items. - Upload a test Release Notes attachment to verify that
STORAGE_S3_ENDPOINTcan complete file storage and reading normally. - View the Redis cache key list to confirm that cache entries prefixed with
fastgpt:release:*exist, indicating that version data has been cached normally.
The values provided are common starting points, and should be evaluated against the reader's own samples.
Question material comes from public community discussions. Configuration values are common starting points and should be measured against your own samples. Verified on 2026-10-19.