Skip to content

[Docs] Clarify that the Docker Redis service is not used by the cache by default - #615

Open
berfinyuksel wants to merge 1 commit into
2026.xfrom
docs/redis-cache-docs
Open

berfinyuksel wants to merge 1 commit into
2026.xfrom
docs/redis-cache-docs

Conversation

@berfinyuksel

Copy link
Copy Markdown
Contributor

What

The Installation page says "configure a caching backend … Redis is the recommended cache adapter", and both Docker packages start a Redis-compatible service — but neither package actually wires Pimcore's object cache to it. The pimcore.cache.pool block in config/config.yaml is commented out (and uses redis://localhost, which doesn't resolve inside Compose), so a fresh install silently runs on the database adapter (cache_items).

Changes

  • Installation README – state that the service is started but the cache pool must be enabled; link to the Docker-specific steps.
  • Skeleton Installation – new "Enabling the Redis cache" section: REDIS_URL=redis://redis:6379 in .env.local, config/packages/cache.yaml (same pool config as the Performance Guide), cache:clear + pimcore:cache:warming, and a note that the host inside Docker is redis, not localhost.
  • Demo Enterprise Installation – note that the valkey service / existing REDIS_URL are not used by the cache until enabled.

Verification

  • Checked pimcore/skeleton@2026.x and pimcore/demo-enterprise@2026.x: Redis is only referenced in the commented block of config/config.yaml (and REDIS_URL in the demo .env); no config/packages/* file configures the pool.
  • Docs-only change; not rendered locally — relying on the docs build in CI. Anchors used: #enabling-the-redis-cache, #pimcore-caching-redis.

🤖 Generated with Claude Code

… by default

The Installation page tells readers to configure Redis as the cache backend,
and both Docker packages start a Redis-compatible service, but neither
package wires Pimcore's object cache to it: the cache pool config in
config/config.yaml is commented out and defaults to the database adapter.

- Installation README: say explicitly that the service is started but the
  cache pool must be enabled, and link to the Docker-specific steps.
- Skeleton Installation: add an "Enabling the Redis cache" section with
  REDIS_URL, config/packages/cache.yaml, and cache:clear / cache:warming,
  and point out that inside Docker the host is `redis`, not `localhost`.
- Demo Enterprise Installation: note that the `valkey` service and the
  existing REDIS_URL are not used by the cache until enabled.

Co-Authored-By: Claude <noreply@anthropic.com>
@berfinyuksel berfinyuksel added the Skip Milestone Check Exempts this PR from the mandatory milestone requirement label Oct 13, 2026
@berfinyuksel
berfinyuksel requested a review from fashxp October 13, 2026 11:02

@fashxp fashxp left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

I'd rather change demo and skeleton repos so that we don't need that doc adaptions...

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

Labels

Skip Milestone Check Exempts this PR from the mandatory milestone requirement

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants