Skip to content

refactor: batch update environment variable documentation based on latest code#721

Merged
RiskeyL merged 3 commits intomainfrom
refactor/environment-var-docs
Mar 30, 2026
Merged

refactor: batch update environment variable documentation based on latest code#721
RiskeyL merged 3 commits intomainfrom
refactor/environment-var-docs

Conversation

@RiskeyL
Copy link
Copy Markdown
Contributor

@RiskeyL RiskeyL commented Mar 30, 2026

No description provided.

Copilot AI review requested due to automatic review settings March 30, 2026 07:18
@dosubot dosubot bot added the size:XS This PR changes 0-9 lines, ignoring generated files. label Mar 30, 2026
Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Copilot wasn't able to review any files in this pull request.


💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

@dosubot dosubot bot added the documentation Improvements or additions to documentation label Mar 30, 2026
Copilot AI review requested due to automatic review settings March 30, 2026 13:48
@dosubot dosubot bot added size:XXL This PR changes 1000+ lines, ignoring generated files. and removed size:XS This PR changes 0-9 lines, ignoring generated files. labels Mar 30, 2026
Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Copilot reviewed 1 out of 3 changed files in this pull request and generated no new comments.


💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

@RiskeyL RiskeyL merged commit 752bf16 into main Mar 30, 2026
6 checks passed
@RiskeyL RiskeyL deleted the refactor/environment-var-docs branch March 30, 2026 14:03
@dosubot
Copy link
Copy Markdown

dosubot bot commented Mar 30, 2026

Documentation Updates

1 document(s) were updated by changes in this PR:

REDIS_MAX_CONNECTIONS Validation Error in Dify v1.13.1
View Changes
@@ -1,4 +1,6 @@
 ### REDIS_MAX_CONNECTIONS validation error in v1.13.1
+
+> **Resolved in v1.13.2.** If you are running Dify v1.13.2 or later, this issue is already fixed and no workaround is needed. The information below applies only to users still running v1.13.1 or earlier.
 
 When [upgrading from Dify 1.13.0 to 1.13.1](https://github.com/langgenius/dify/issues/33592), containers may fail to start with this error:
 
@@ -10,7 +12,7 @@
 
 [This affects both upgrades and fresh installations using the default `.env.example` file](https://github.com/langgenius/dify/issues/33614).
 
-**Solution**: Add this line to your `.env` file:
+**Workaround (v1.13.1 only)**: Add this line to your `.env` file:
 
 ```
 REDIS_MAX_CONNECTIONS=10
@@ -25,6 +27,6 @@
 
 **Root cause**: Version 1.13.1 [introduced the REDIS_MAX_CONNECTIONS configuration](https://github.com/langgenius/dify/pull/32935) to [address Redis connection exhaustion issues](https://github.com/langgenius/dify/issues/31603). The [docker-compose.yaml file passes an empty string when this variable is unset](https://github.com/langgenius/dify/blob/bbe975c6bca3e3afb20de217deb67c0920b2bd6d/docker/docker-compose.yaml#L93), which Pydantic cannot parse as an integer. [Commenting out or removing the variable doesn't work](https://github.com/langgenius/dify/issues/33592) due to the docker-compose configuration.
 
-**Permanent fix**: [A fix was merged on March 18, 2026](https://github.com/langgenius/dify/pull/33619) that [allows empty strings to be treated as None](https://github.com/langgenius/dify/blob/bbe975c6bca3e3afb20de217deb67c0920b2bd6d/api/configs/middleware/cache/redis_config.py#L120-L128). Version 1.13.2 (released on March 18, 2026) includes the fix. Users on v1.13.1 should upgrade to v1.13.2 or later.
+**Permanent fix**: [A fix was merged on March 18, 2026](https://github.com/langgenius/dify/pull/33619) that [allows empty strings to be treated as None](https://github.com/langgenius/dify/blob/bbe975c6bca3e3afb20de217deb67c0920b2bd6d/api/configs/middleware/cache/redis_config.py#L120-L128). Version 1.13.2 (released on March 18, 2026) includes the fix. Users on v1.13.1 should upgrade to v1.13.2 or later. **Status: Resolved.**
 
-**About REDIS_MAX_CONNECTIONS**: This optional setting [limits the total connections in Redis connection pools](https://github.com/langgenius/dify/blob/bbe975c6bca3e3afb20de217deb67c0920b2bd6d/api/configs/middleware/cache/redis_config.py#L115-L118) across [all deployment modes](https://github.com/langgenius/dify/blob/bbe975c6bca3e3afb20de217deb67c0920b2bd6d/api/extensions/ext_redis.py) (standalone, Sentinel, Cluster, PubSub). [The default of 10 connections per pool](https://github.com/langgenius/dify/issues/33592) is reasonable for most deployments.
+**About REDIS_MAX_CONNECTIONS**: This fully optional setting [limits the total connections in Redis connection pools](https://github.com/langgenius/dify/blob/bbe975c6bca3e3afb20de217deb67c0920b2bd6d/api/configs/middleware/cache/redis_config.py#L115-L118) across [all deployment modes](https://github.com/langgenius/dify/blob/bbe975c6bca3e3afb20de217deb67c0920b2bd6d/api/extensions/ext_redis.py) (standalone, Sentinel, Cluster, PubSub). In v1.13.2 and later, leaving this variable unset (or empty) is valid — the system correctly treats an empty value as "use the Redis client library default connection pool size". Set it to a specific integer only if you need to cap the pool size to match your Redis server's `maxclients` setting.

How did I do? Any feedback?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation size:XXL This PR changes 1000+ lines, ignoring generated files.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants