# Redis cache

# Introduction

This package provides integration with Redis (opens new window). For more information about this topic, please refer to SSR Cache page.

# Installation

Install required packages:

yarn add @vue-storefront/cache
yarn add @vue-storefront/redis-cache

Register @vue-storefront/cache module with following configuration:

// nuxt.config.js

export default {
  modules: [
    ['@vue-storefront/cache/nuxt', {
      enabled: true,
      invalidation: {
        // Invalidation options
      },
      driver: [
        '@vue-storefront/redis-cache',
        {
          defaultTimeout: 86400,
          redis: {
            host: 'localhost',
            port: 6379,
            password: 'password'
          }
        }
      ]
    }]
  ]
};

We can break down package configuration into three pieces:

  • enabled (required boolean) - contains boolean value, that is responsible for the package's running status.
  • invalidation - please refer to SSR Cache configuration page.
  • driver - object containing:
    • defaultTimeout - number of seconds until records expire, even if not invalidated;
    • redis - object directly passed to ioredis (opens new window);

WARNING

If you use the Vue Storefront Cloud, set the driver.redis.host property to redis in the production environment. It will be automatically mapped to the address of the Redis instance.

Introduction →