<?xml version="1.0" encoding='ISO-8859-1'?>
<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.4//EN"
"http://www.oasis-open.org/docbook/xml/4.4/docbookx.dtd" [

<!-- Include general documentation entities -->
<!ENTITY % docentities SYSTEM "../../../../doc/docbook/entities.xml">
%docentities;

]>
<!-- Module User's Guide -->

<chapter>

	<title>&adminguide;</title>

	<section>
	<title>Overview</title>
	<para>
		This module offers REDIS storage support for TOPOS module.
	</para>
	</section>
	<section>
	<title>Dependencies</title>
	<section>
		<title>&kamailio; Modules</title>
		<para>
		The following modules must be loaded before this module:
			<itemizedlist>
			<listitem>
			<para>
				<emphasis>ndb_redis module</emphasis> - for interaction with
				a REDIS server.
			</para>
			</listitem>
			<listitem>
			<para>
				<emphasis>topos module</emphasis> - to bind to as a storage
				engine.
			</para>
			</listitem>
			</itemizedlist>
		</para>
	</section>
	<section>
		<title>External Libraries or Applications</title>
		<para>
		The following libraries or applications must be installed before running
		&kamailio; with this module loaded:
			<itemizedlist>
			<listitem>
			<para>
				<emphasis>hiredis</emphasis> - available at
				https://github.com/antirez/hiredis .
			</para>
			</listitem>
			</itemizedlist>
		</para>
	</section>
	</section>
	<section>
	<title>Parameters</title>
	<section id="topos_redis.p.serverid">
		<title><varname>serverid</varname> (str)</title>
		<para>
			The name of the REDIS server to be used as provided to the 'name'
			attribute of 'server' parameter for NDB_REDIS module.
		</para>
		<para>
			The 'storage' parameter for TOPOS module must be set to 'redis'.
		</para>
		<para>
		<emphasis>
			Default value is <quote>NULL</quote>.
		</emphasis>
		</para>
		<example>
		<title>Set <varname>serverid</varname> parameter</title>
		<programlisting format="linespecific">
...
# ----- ndb_redis params -----
modparam("ndb_redis", "server", "name=srv8;addr=127.0.0.1;port=6379;db=8")

# ----- topos params -----
modparam("topos", "storage", "redis")

# ----- topos_redis params -----
modparam("topos_redis", "serverid", "srv8")
...
</programlisting>
		</example>
	</section>
	</section>
</chapter>

