CACHEDB_REDIS module
Admin Guide
Section titled “Admin Guide”Overview
Section titled “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.
Advantages
Section titled “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
- By creating a Redis Cluster, multiple OpenSIPS instances can easily share key-value information
Limitations
Section titled “Limitations”- keys (in key:value pairs) may not contain spaces or control characters
Dependencies
Section titled “Dependencies”OpenSIPS Modules
Section titled “OpenSIPS Modules”None.
External Libraries or Applications
Section titled “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.
Exported Parameters
Section titled “Exported Parameters”cachedb_url (string)
Section titled “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.
...modparam("cachedb_redis", "cachedb_url","redis:group1://localhost:6379/");modparam("cachedb_redis", "cachedb_url","redis:cluster1://random_url:8888/");......cache_store("redis:group1","key","$ru value");cache_fetch("redis:cluster1","key",$avp(10));cache_remove("redis:cluster1","key");...Exported Functions
Section titled “Exported Functions”The module does not export functions to be used in configuration script.
Contributors
Section titled “Contributors”By Commit Statistics
Section titled “By Commit Statistics”Top contributors by DevScore(1), authored commits(2) and lines added/removed(3)
| # | Name | DevScore | Commits | Lines++ | Lines— |
|---|---|---|---|---|---|
| 1. | Vlad Paiu (@vladpaiu) | 28 | 17 | 1174 | 46 |
| 2. | Stefan Darius (@dariusstefan) | 7 | 4 | 128 | 22 |
| 3. | Razvan Crainea (@razvancrainea) | 4 | 2 | 8 | 8 |
(1) DevScore = author_commits + author_lines_added / (project_lines_added / project_commits) + author_lines_deleted / (project_lines_deleted / project_commits)
(2) including any documentation-related commits, excluding merge commits
(3) ignoring whitespace edits, renamed files and auto-generated files
By Commit Activity
Section titled “By Commit Activity”| # | Name | Commit Activity |
|---|---|---|
| 1. | Stefan Darius (@dariusstefan) | Jun 2026 - Jul 2026 |
| 2. | Razvan Crainea (@razvancrainea) | Feb 2012 - Jun 2026 |
| 3. | Vlad Paiu (@vladpaiu) | Oct 2011 - Jun 2013 |
(1) including any documentation-related commits, excluding merge commits
Documentation
Section titled “Documentation”Contributors
Section titled “Contributors”Last edited by: Razvan Crainea (@razvancrainea), Vlad Paiu (@vladpaiu).
License
Section titled “License”All documentation files (i.e. .md extension) are licensed under the Creative Common License 4.0