Skip to content

mandatory cache store #465

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
Paul-Bob wants to merge 2 commits into
base: main
Choose a base branch
from
Open

mandatory cache store #465

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
e8bfa3c
mandatory cache store
Paul-Bob Dec 18, 2025
68d997b
update docs
Paul-Bob Dec 18, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 11 additions & 5 deletions docs/4.0/cache.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,16 @@

Avo uses the application's cache system to enhance performance. The cache system is especially beneficial when dealing with resource index tables and license requests.

:::warning Operational cache store required
A working cache store is **mandatory**. Avo verifies the cache store is operational during boot by performing a write/read/delete test.

If the cache store is not operational, Avo will redirect all requests to an error page:
- **[Admins and developers](authentication#customize-the-methods-that-check-for-roles)** will see detailed error information including the specific error message and a link to this documentation.
- **Other users** will see a generic message asking them to contact their administrator.

This ensures issues are caught early and provides clear guidance for resolution.
:::

## Cache store selection

The cache system dynamically selects the appropriate cache store based on the application's environment:
Expand All @@ -10,13 +20,9 @@ The cache system dynamically selects the appropriate cache store based on the ap

In production, if the existing cache store is one of the following: `ActiveSupport::Cache::MemoryStore` or `ActiveSupport::Cache::NullStore` it will use the default `:file_store` with a cache path of `tmp/cache`. Otherwise, the existing cache store `Rails.cache` will be used.

### Test

In testing, it directly uses the `Rails.cache` store.

### Development and other environments

In all other environments the `:memory_store` is used.
In all other environments the `:file_store` is used.

### Custom selection

Expand Down