Chapter 1. Admin Guide

1.1. Overview

This module is an implementation of a cache system designed to work with a
Redis server. It uses hiredis client library to connect to either a single Redis
server instance, or to a Redis Server inside a Redis Cluster.
It uses the Key-Value interface exported from the core.

1.2. Advantages

memory costs are no longer on the server

many servers can be used inside a cluster, so the memory
is virtually unlimited

the cache is 100% persistent. A restart
of OpenSIPS server will not affect the DB. The Redis DB is also
persistent so it can also be restarted without loss of information.

redis is an open-source project so
it can be used to exchange data
with various other applicationsr

1.3. Limitations

keys (in key:value pairs) may not contain spaces or control characters

1.4. Dependencies

1.4.1. OpenSIPS Modules

None.

1.4.2. External Libraries or Applications

The following libraries or applications must be installed before running
OpenSIPS with this module loaded:

hiredis:

On the latest Debian based distributions, hiredis can be installed
by running 'apt-get install libhiredis-dev'
Alternatively, if hiredis is not available on your OS repos,
hiredis can be downloaded from: https://github.com/antirez/hiredis .
Download the archive, extract sources, run make,sudo make install.

1.5. Exported Parameters

1.5.1. cachedb_url (string)

The urls of the server groups that OpenSIPS will connect to in order
to use the from script cache_store,cache_fetch, etc operations.
It can be set more than one time.
The prefix part of the URL will be the identifier that will be used
from the script.