Described clearing caches in more detail by mnocon · Pull Request #3289 · ibexa/documentation-developer

mnocon · 2026-07-13T13:04:51Z

Target: 4.6, 5.0, 6.0

As reported on Slack:

Hello,

https://doc.ibexa.co/en/5.0/infrastructure_and_maintenance/support_and_maintenance_faq/#how-to-clear-the-cache-properly
should cover the changes mentioned in https://doc.ibexa.co/en/5.0/update_and_migration/from_5.0/update_from_5.0/#update-symfony-from-73-to-74  imho.
(so basically saying that persistence cache needs always to be cleared separately - even when using filesystem)

This PR clarifies the types of caches and how to clear them.

I've used the terminology from Symfony for system and application caches:

Added a section for clearing HTTP cache as well

In addition, I've cleaned up outdated content in the Persistence Cache article - mentioned in comments.

The goal is to have a single "how to clear caches from CLI" article we can use.

github-actions · 2026-07-13T13:52:37Z

Preview of modified files

Preview of modified Markdown:

github-actions · 2026-07-13T14:04:28Z

Summary

Status	Count
🔍 Total	760091
🔗 Unique	15034
✅ Successful	7276
⏳ Timeouts	0
🔀 Redirected	0
👻 Excluded	752815
❓ Unknown	0
🚫 Errors	0
⛔ Unsupported	0

Full Github Actions output

mnocon · 2026-07-13T13:46:24Z

 ### Using the cache service

 Example usage of the cache service:

 ``` php
-use Symfony\Component\Cache\Adapter\TagAwareAdapterInterface;
-use Symfony\Component\DependencyInjection\ContainerInterface;
-


Rewrote this to avoid getting a service from the container directly - that's not recommended anymore

mnocon · 2026-07-13T13:47:11Z

-    If you have customized the persistence cache configuration, the name of your cache pool might be different.
-
-Persistence cache prefixes it's cache using "ibx-". Clearing persistence cache can thus be done in the following ways:
+Persistence cache uses the `ibx-` prefix, declared as a container parameter called `ibexa.core.persistence.cache.tag_prefix`.


https://github.com/ibexa/core/blob/6.0/src/lib/Resources/settings/storage_engines/cache.yml#L13

The part about clearing the cache with the command was out of place here, it's about API usage.

Added a link for people searching how to clear the cache manually.

mnocon · 2026-07-13T13:47:37Z

-    Manual cache clearing should be executed with caution, as it doesn't warm up the cache.
-    It results in a significant performance drop on first request, so it shouldn't be called on a production environment.
-    Besides, it could lead to issues with file ownership after running `cache:clear` as a root.
+See [Cache clearing](devops.md#cache-clearing) for information how to clear system, application, and HTTP caches.


No need to have this info duplicated in two places.

mnocon · 2026-07-13T13:47:49Z


 ## Web Debug Toolbar

 As of [[= product_name =]] v4.5, the [Symfony Web Debug Toolbar]([[= symfony_doc =]]/profiler.html) is no longer installed by default.
 To install it, run the following command:

 ```bash
-composer require symfony/debug-pack
+composer require --dev symfony/debug-pack


--dev was missing, and it's crucial!

mnocon · 2026-07-13T13:48:06Z


-### Clearing content cache on a cluster setup
+### Clear HTTP cache


Added a dedicated HTTP cache section to cover all types of caches.

mnocon · 2026-07-13T13:48:47Z

-use Symfony\Component\Cache\Adapter\TagAwareAdapterInterface;
-use Symfony\Component\DependencyInjection\ContainerInterface;
-
-// Getting the cache service in PHP


ibexa.cache_pool is a private service (Public: no) so it's not possible to retrieve it from the container anymore

~/Desktop/Sites/v5 main +1 !174 ?19 ❯ php bin/console debug:container ibexa.cache_pool  24.4.0 13:21:18 // This service is a private alias for the service // Ibexa\Core\Persistence\Cache\Adapter\TransactionalInMemoryCacheAdapter Information for Service "Ibexa\Core\Persistence\Cache\Adapter\TransactionalInMemoryCacheAdapter" ================================================================================================ Internal proxy adapter invalidating our isolated in-memory cache, and defer shared pool changes during transactions. ---------------- --------------------------------------------------------------------------------------------------------------------------------- Option Value ---------------- --------------------------------------------------------------------------------------------------------------------------------- Service ID Ibexa\Core\Persistence\Cache\Adapter\TransactionalInMemoryCacheAdapter Class Ibexa\Core\Persistence\Cache\Adapter\TransactionalInMemoryCacheAdapter Tags container.decorator (id: ibexa.cache_pool, inner: Ibexa\Core\Persistence\Cache\Adapter\TransactionalInMemoryCacheAdapter.inner) Public no Synthetic no Lazy yes Shared yes Abstract no Autowired no Autoconfigured no

mnocon · 2026-07-13T13:49:11Z

-This can shortly be described as a cache which is invisible to the end user (admin/editors) of [[= product_name =]] where content is always returned *fresh*.
-In other words, there should be no need to manually clear the cache like it was frequently the case with eZ Publish 4.x.
-This is possible thanks to an interface that follows CRUD (Create Read Update Delete) operations per domain.
+With the persistence cache, like with the HTTP cache, [[= product_name =]] follows the principles of transparent caching.


Removed an outdated eZ Publish 4.x mention 🙈

mnocon · 2026-07-13T14:17:20Z

+```
+
+The default cache pool is named `cache.tagaware.filesystem`.
+The default cache pool when running Redis or Valkey is named `cache.redis`.


Added to the allowlist in https://github.com/ibexa/vale-styles/pull/44

alongosz · 2026-07-14T14:42:16Z

+php bin/console --env=prod cache:clear
+```
+
+If you don't specify an environment, by default `cache:clear` clears the cache for the `dev` environment.


Not entirely correct AFAIR. If you set APP_ENV=prod, by default it should clear prod env. If you ssh into an e.g., Upsun instance, that variable will be set by default.

https://youtu.be/hou0lU8WMgo 😄

Thanks, nice catch! Clarified (hopefully) in 253fa6b

julitafalcondusza

Just a small remark.

julitafalcondusza · 2026-07-15T09:12:33Z

+
+The default cache pool is named `cache.tagaware.filesystem`.
+The default cache pool when running Redis or Valkey is named `cache.redis`.
+If you have customized the persistence cache configuration, the name of your cache pool might be different.


To avoid Present Perfect:

Suggested change

If you have customized the persistence cache configuration, the name of your cache pool might be different.

If you customized the persistence cache configuration, the name of your cache pool might be different.

or

Suggested change

If you have customized the persistence cache configuration, the name of your cache pool might be different.

If your persistence cache configuration is customized, the name of your cache pool might be different.

mnocon added 2 commits July 13, 2026 15:51

Described clearing caches in more detail

9c970ac

Updated baseline

9c45324

mnocon force-pushed the cache-clearing branch from dbb090e to 9c45324 Compare July 13, 2026 13:52

Selfreview

ea8ac73

mnocon marked this pull request as ready for review July 13, 2026 14:00

mnocon added the Needs DEV review label Jul 13, 2026

mnocon requested a review from reithor July 13, 2026 14:04

mnocon commented Jul 13, 2026

View reviewed changes

mnocon requested a review from a team July 13, 2026 14:18

ibexa-workflow-automation-1 Bot requested review from Steveb-p, ViniTou, alongosz, barw4, bnowak, ciastektk, konradoboza, mikadamczyk, tbialcz and wiewiurdp and removed request for a team July 13, 2026 14:18

Run fixer

d312dde

konradoboza approved these changes Jul 14, 2026

View reviewed changes

mnocon added Needs DOC review and removed Needs DEV review labels Jul 14, 2026

PHPStan baseline

2b420d1

alongosz reviewed Jul 14, 2026

View reviewed changes

Mention environments and variables

253fa6b

julitafalcondusza approved these changes Jul 15, 2026

View reviewed changes


		### Clearing content cache on a cluster setup
		### Clear HTTP cache

	If you have customized the persistence cache configuration, the name of your cache pool might be different.
	If you customized the persistence cache configuration, the name of your cache pool might be different.

	If you have customized the persistence cache configuration, the name of your cache pool might be different.
	If your persistence cache configuration is customized, the name of your cache pool might be different.

Uh oh!

Conversation

mnocon commented Jul 13, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

github-actions Bot commented Jul 13, 2026

Preview of modified files

Uh oh!

github-actions Bot commented Jul 13, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

julitafalcondusza left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

mnocon commented Jul 13, 2026 •

edited

Loading

github-actions Bot commented Jul 13, 2026 •

edited

Loading