Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 2 Next »

When you have a large instance with many spaces or a lot of simultaneously active users, or you just want to speed things up, we recommend turning on the caching feature.

An enabled cache will make the server requests related to Refined fewer by storing the UI settings locally in the browser using the Web Storage API. This will decrease the amount of server requests and greatly improve page load times for all users.

In short, enabling caching provides these benefits:

  • Fewer server requests

  • Faster resource load times

  • Great potential performance gain for large instances

  • Smoother end user experience

  • Always up to date 

How it works

A small cache object is made available in the beginning of each page load, checking if the cached resources are up to date or if the administrator has made any changes to the cache management settings. This way the resources are still kept updated at all times. 

If a resource is cached, the user will read it locally without having to make any server requests. The resources are stored using the standardised Web Storage API, allowing for fast and efficient use across all major browsers.  

Browser support

The cache system works with all supported browsers and versions. The cache management system is built with Web Storage, read more about browser support.

Enable and set up caching

  1. Go to the Refined Administration.

  2. Go to the Caching tab.

  3. Select Enable caching.

  4. Set up Cachable resources:

Resource API

Description

Used by

Category REST API

Requests made for categories, the category menu and all their content. Recommended to cache if your instance has categories containing a large amount of spaces and/or subcategories.

Categories, Spaces in categories macro

Footer REST API

The footer and all of its content. If it is not cached, this resource will be fetched on all your site’s pages.

Footer

Global Menu REST API

The global menu, as well as the sidebar from Original Theme 4.0. If it is not cached, this resource will be fetched on all your site’s pages.

Global menu

User Category REST API

All requests associated with the functionality of linking users to categories, including the roles defined for them. Introduced in 4.2.

Connecting Users to Categories and Spaces

Users REST API

User-related requests made by Refined’s user macros.

User Details macro, Users Macro

  • No labels