Add Valkey support to Winter CMS documentation #244
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
- Update cache service documentation to include Valkey configuration options - Update queues service documentation with Valkey support details - Update session service documentation with Valkey configuration - Document Valkey as a Redis-compatible alternative for caching, queues, and sessions
bennothommo
requested changes
Jul 31, 2025
There was a problem hiding this comment.
@rlunar thanks for your submission. While we'd be happy to mention Valkey in our docs, we don't want to advocate for Valkey over Redis (or vice-versa). Could you please make the following changes.
Comment on lines
+117
to
+124
| ### Valkey | ||
|
|
||
| [Valkey](https://valkey.io) is an open-source, high-performance key-value datastore that serves as a drop-in replacement for Redis. It offers the same functionality and performance as Redis while being community-driven with improved governance. | ||
|
|
||
| Since Valkey is protocol-compatible with Redis, it uses the same configuration as Redis. You can use the existing Redis configuration section in `config/database.php` for Valkey connections. Both the `predis` and `phpredis` clients work seamlessly with Valkey, requiring no additional configuration changes. | ||
|
|
||
| To use Valkey instead of Redis, simply point your Redis configuration to your Valkey server instance. All Redis configuration examples in this documentation apply equally to Valkey. | ||
|
|
There was a problem hiding this comment.
This section reads too much like a promotion of Valkey. I'd prefer if we do not include a section for Valkey and just change the Redis section above to "Redis / Valkey" instead as necessary, with maybe a small mention that Valkey is a drop-in replacement for Redis.
Suggested change
| ### Valkey | |
| [Valkey](https://valkey.io) is an open-source, high-performance key-value datastore that serves as a drop-in replacement for Redis. It offers the same functionality and performance as Redis while being community-driven with improved governance. | |
| Since Valkey is protocol-compatible with Redis, it uses the same configuration as Redis. You can use the existing Redis configuration section in `config/database.php` for Valkey connections. Both the `predis` and `phpredis` clients work seamlessly with Valkey, requiring no additional configuration changes. | |
| To use Valkey instead of Redis, simply point your Redis configuration to your Valkey server instance. All Redis configuration examples in this documentation apply equally to Valkey. |
| @@ -11,7 +11,7 @@ The session configuration is stored in `config/session.php`. Be sure to review t | |||
| - `file` - sessions are stored in `storage/framework/sessions`. | |||
| - `cookie` - sessions are stored in secure, encrypted cookies. | |||
| - `database` - sessions are stored in a database used by your application. | |||
| - `memcached` / `redis` - sessions are stored in one of these fast, cache based stores. | |||
| - `memcached` / `redis` / `valkey` - sessions are stored in one of these fast, cache based stores. | |||
There was a problem hiding this comment.
valkey is not an applicable session driver as far as I know. Valkey still uses the redis driver.
Suggested change
| - `memcached` / `redis` / `valkey` - sessions are stored in one of these fast, cache based stores. | |
| - `memcached` / `redis` - sessions are stored in one of these fast, cache based stores. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Summary
Files to Modify/Add
New Documentation Files:
services/cache.md- Update cache service documentation to include Valkey configuration optionsservices/queues.md- Update queues service documentation with Valkey support detailsservices/session.md- Update session service documentation with Valkey configurationsetup/configuration.md- Add Valkey environment variables