Skip to content

docs(wordpress): document redis-cache plugin requirement#479

Merged
slydlake merged 1 commit into
mainfrom
docs/wordpress-redis-plugin-requirement
Jul 9, 2026
Merged

docs(wordpress): document redis-cache plugin requirement#479
slydlake merged 1 commit into
mainfrom
docs/wordpress-redis-plugin-requirement

Conversation

@slydlake

@slydlake slydlake commented Jul 9, 2026

Copy link
Copy Markdown
Collaborator

Summary

  • Clarify that redis.enabled/redis.createConfig (and Valkey) only inject WP_REDIS_* config into wp-config.php — the redis-cache plugin still needs to be installed and activated via wordpress.plugins, otherwise the object cache silently stays inactive
  • Add the required wordpress.plugins entry to the "Minimal example (Redis)" snippet
  • Fix the Redis/Valkey troubleshooting commands, which called redis-cli — not installed in the running wordpress container — with a PHP fsockopen reachability check instead, and point to the plugin's own status page for hit/miss stats

Fixes the confusion reported in #478, where a user followed the README's minimal example exactly but Redis never became usable because the redis-cache plugin was never listed.

Test plan

  • Docs-only change, no template/values changes
  • Reviewer sanity-check of rendered README section

Enabling redis.enabled/createConfig only injects WP_REDIS_* config into
wp-config.php; the redis-cache plugin still has to be installed and
activated via wordpress.plugins for the object cache to actually turn
on, and nothing warns when it's missing (see #478). Also swap the
redis-cli-based troubleshooting commands for a PHP fsockopen check,
since redis-cli/wp-cli aren't present in the running wordpress
container.
@slydlake slydlake merged commit 8b38a49 into main Jul 9, 2026
6 checks passed
@slydlake slydlake deleted the docs/wordpress-redis-plugin-requirement branch July 9, 2026 18:40
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant