mirror of https://github.com/sipwise/kamailio.git
You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
119 lines
2.6 KiB
119 lines
2.6 KiB
<?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 "../../../docbook/entities.xml">
|
|
%docentities;
|
|
|
|
]>
|
|
|
|
<!-- Module User's Guide -->
|
|
|
|
<chapter>
|
|
<title>&adminguide;</title>
|
|
|
|
<section>
|
|
<title>Overview</title>
|
|
<para>The module is an implementation of the internal DB API v1 connector
|
|
for SQlite 3 file.</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>No dependencies on other &kamailio; modules</emphasis>.
|
|
</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>SQlite 3 library</emphasis> - e.g., libsqlite3-0
|
|
</para>
|
|
</listitem>
|
|
<listitem>
|
|
<para>
|
|
<emphasis>SQlite 3 devel library</emphasis> - to compile
|
|
the module e.g. libsqlite3-dev
|
|
</para>
|
|
</listitem>
|
|
<listitem>
|
|
<para>
|
|
<emphasis>SQlite 3 utilities</emphasis> - for kamdbctl
|
|
e.g. sqlite3
|
|
</para>
|
|
</listitem>
|
|
</itemizedlist>
|
|
</para>
|
|
</section>
|
|
</section>
|
|
|
|
<section>
|
|
<title>Parameters</title>
|
|
<para>
|
|
NONE
|
|
</para>
|
|
</section>
|
|
|
|
<section>
|
|
<title>Functions</title>
|
|
<para>
|
|
NONE
|
|
</para>
|
|
</section>
|
|
|
|
<section>
|
|
<title>Usage</title>
|
|
<para>
|
|
To use the module, first you have to load it in the &kamailio;
|
|
configuration file.
|
|
</para>
|
|
<example>
|
|
<title><function>loading the module</function> usage</title>
|
|
<programlisting format="linespecific">
|
|
...
|
|
loadmodule "db_sqlite.so"
|
|
...
|
|
</programlisting>
|
|
</example>
|
|
<para>
|
|
Then set the db_url (or similar) parameter of modules that have to
|
|
use the SQLite database to driver part 'sqlite://', followed by the
|
|
path to database file. For example:
|
|
</para>
|
|
<example>
|
|
<title><function>db_url module parameter</function> usage</title>
|
|
<programlisting format="linespecific">
|
|
...
|
|
modparam("auth_db", "db_url", "sqlite:///etc/kamailio/kamailio.db")
|
|
...
|
|
</programlisting>
|
|
</example>
|
|
<para>
|
|
In the default config file, defined token DBURL can be updated like:
|
|
</para>
|
|
<example>
|
|
<title><function>DBURL define</function> usage</title>
|
|
<programlisting format="linespecific">
|
|
...
|
|
#!define DBURL "sqlite:///etc/kamailio/kamailio.db"
|
|
...
|
|
</programlisting>
|
|
</example>
|
|
</section>
|
|
</chapter>
|
|
|