db_sqlite: added notes about usage in readme
authorDaniel-Constantin Mierla <miconda@gmail.com>
Mon, 30 Jul 2012 09:18:28 +0000 (11:18 +0200)
committerDaniel-Constantin Mierla <miconda@gmail.com>
Mon, 30 Jul 2012 09:18:28 +0000 (11:18 +0200)
- based on content by Meftah Tayeb

modules_k/db_sqlite/README
modules_k/db_sqlite/doc/db_sqlite_admin.xml

index a1ef4fa..34d1302 100644 (file)
@@ -1,12 +1,12 @@
 SQlite Module
 
-Timo Teräs
+Timo Teräs
 
 Edited by
 
-Timo Teräs
+Timo Teräs
 
-   Copyright © 2011 Timo Teräs
+   Copyright © 2011 Timo Teräs
      __________________________________________________________________
 
    Table of Contents
@@ -21,6 +21,13 @@ Timo Teräs
 
         3. Parameters
         4. Functions
+        5. Usage
+
+   List of Examples
+
+   1.1. loading the module usage
+   1.2. db_url module parameter usage
+   1.3. DBURL define usage
 
 Chapter 1. Admin Guide
 
@@ -34,6 +41,7 @@ Chapter 1. Admin Guide
 
    3. Parameters
    4. Functions
+   5. Usage
 
 1. Overview
 
@@ -65,3 +73,29 @@ Chapter 1. Admin Guide
 4. Functions
 
    NONE
+
+5. Usage
+
+   To use the module, first you have to load it in the Kamailio
+   configuration file.
+
+   Example 1.1. loading the module usage
+...
+loadmodule "db_sqlite.so"
+...
+
+   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:
+
+   Example 1.2. db_url module parameter usage
+...
+modparam("auth_db", "db_url", "sqlite:///etc/kamailio/kamailio.db")
+...
+
+   In the default config file, defined token DBURL can be updated like:
+
+   Example 1.3. DBURL define usage
+...
+#!define DBURL "sqlite:///etc/kamailio/kamailio.db"
+...
index 43c2d5d..8c11032 100644 (file)
                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>