PR #35139: feat: support configurable redis key prefix

• Repository: langgenius/dify
• Author: Blackoutta
• State: closed | merged: True
• Link: https://github.com/langgenius/dify/pull/35139

Description (problem / solution / changelog)

[!IMPORTANT]

1. Make sure you have read our contribution guidelines
2. Ensure there is an associated issue and you have been assigned to it
3. Use the correct syntax to link this PR: Fixes #<issue number>.

Summary

Fixes #35138 Fixes #13652 Fixes #13604

This PR adds support for configurable Redis key prefixing via REDIS_KEY_PREFIX to improve namespace isolation when multiple Dify deployments share the same Redis instance.

Main changes:

• Added centralized Redis name helpers for prefix normalization and serialization.
• Applied key prefixing to RedisClientWrapper operations (including lock/hash/sorted-set calls).
• Applied prefixing to Redis-based broadcast channel names (standard, sharded, and streams).
• Added Celery Redis transport global_keyprefix wiring to align task/broker/backend keys with the configured namespace.
• Added REDIS_KEY_PREFIX examples in API/docker env templates and updated docker docs.
• Added/updated unit tests for config loading, Redis naming behavior, wrapper prefixing, pub/sub channels, streams channels, and Celery transport behavior.

Compatibility notes:

• If REDIS_KEY_PREFIX is unset or whitespace-only, behavior is unchanged from today.
• Existing deployments can opt into namespace isolation by setting a non-empty prefix.

From Codex.

Screenshots

Before

keys without a global prefix: <img width="2490" height="1672" alt="image" src="https://github.com/user-attachments/assets/c8128f42-542a-4dad-aa49-5ec93c71bbca" />

After

keys with a global prefix, all grouped together nicely:

<img width="2580" height="1574" alt="image" src="https://github.com/user-attachments/assets/1401981f-2a22-4ad1-a02e-4f8add5ed378" />

Checklist

• This change requires a documentation update, included: Dify Document
• I understand that this PR may be closed in case there was no previous discussion or issues. (This doesn't apply to typos!)
• I've added a test for each change that was introduced, and I tried as much as possible to make a single atomic change.
• I've updated the documentation accordingly.
• I ran make lint && make type-check (backend) and cd web && pnpm exec vp staged (frontend) to appease the lint gods

Changed files

• api/.env.example (modified, +3/-0)
• api/configs/middleware/cache/redis_config.py (modified, +5/-0)
• api/extensions/ext_celery.py (modified, +21/-3)
• api/extensions/ext_redis.py (modified, +153/-64)
• api/extensions/redis_names.py (added, +32/-0)
• api/libs/broadcast_channel/redis/channel.py (modified, +4/-2)
• api/libs/broadcast_channel/redis/sharded_channel.py (modified, +4/-2)
• api/libs/broadcast_channel/redis/streams_channel.py (modified, +2/-1)
• api/libs/db_migration_lock.py (modified, +4/-1)
• api/tests/integration_tests/.env.example (modified, +1/-0)
• api/tests/unit_tests/configs/test_dify_config.py (modified, +35/-0)
• api/tests/unit_tests/extensions/test_celery_ssl.py (modified, +87/-0)
• api/tests/unit_tests/extensions/test_pubsub_channel.py (modified, +2/-0)
• api/tests/unit_tests/extensions/test_redis.py (modified, +100/-1)
• api/tests/unit_tests/libs/broadcast_channel/redis/test_channel_unit_tests.py (modified, +44/-0)
• api/tests/unit_tests/libs/broadcast_channel/redis/test_streams_channel_unit_tests.py (modified, +20/-0)
• docker/.env.example (modified, +3/-0)
• docker/README.md (modified, +1/-0)
• docker/docker-compose.yaml (modified, +1/-0)