How To Use a Redis Module

Generally, modules have their own documentation that explains how to use them. To start using most open source modules with open source Redis, follow these steps:

  1. Clone or download the source code from the module's repository
  2. Follow the instructions in the repository for building the module (usually just running the make command)
  3. Load the module to the Redis server with the loadmodule configuration directive or the MODULE LOAD
  4. Use any Redis client to connect to the server and call the module's commands

Modules that are included with Redis Enterpise only need to be activated for a database to be used. Refer to the Redis Enterprise documentation for more details.