permissions: updated docs with parameters for new columns of trusted table
authorEmmanuel Schmidbauer <eschmidbauer@voipxswitch.com>
Wed, 17 Jun 2015 14:17:07 +0000 (16:17 +0200)
committerDaniel-Constantin Mierla <miconda@gmail.com>
Wed, 17 Jun 2015 14:17:07 +0000 (16:17 +0200)
- used for setting priority and regexp matching over r-uri

modules/permissions/doc/permissions.xml
modules/permissions/doc/permissions_admin.xml

index 9da70ee..482b5cf 100644 (file)
                        <email>jh@tutpro.com</email>
                </address>
                </editor>
+               <editor>
+               <firstname>Emmanuel</firstname>
+               <surname>Schmidbauer</surname>
+               <address>
+                       <email>eschmidbauer@voipxswitch.com</email>
+               </address>
+               </editor>
        </authorgroup>
        <copyright>
                <year>2003</year>
index 82785d5..ce93321 100644 (file)
@@ -661,6 +661,26 @@ modparam("permissions", "proto_col", "transport")
 ...
 modparam("permissions", "from_col", "regexp")
 ...
+</programlisting>
+               </example>
+       </section>
+       <section id ="permissions.p.ruri_col">
+               <title><varname>ruri_col</varname> (string)</title>
+               <para>
+               Name of the column trusted table containing a regular
+               expression that is matched against the Request URI.
+               </para>
+               <para>
+               <emphasis>
+               Default value is <quote>ruri_pattern</quote>.
+               </emphasis>
+               </para>
+               <example>
+               <title>Set <varname>ruri_col</varname> parameter</title>
+               <programlisting format="linespecific">
+...
+modparam("permissions", "ruri_col", "regexp")
+...
 </programlisting>
                </example>
        </section>
@@ -683,6 +703,26 @@ modparam("permissions", "from_col", "regexp")
 ...
 modparam("permissions", "tag_col", "peer_tag")
 ...
+</programlisting>
+               </example>
+       </section>
+       <section id ="permissions.p.priority_col">
+               <title><varname>priority_col</varname> (integer)</title>
+               <para>
+               The column name used to store the priority of the corresponding rule from the database
+               row.
+               </para>
+               <para>
+               <emphasis>
+               Default value is <quote>priority</quote>.
+               </emphasis>
+               </para>
+               <example>
+               <title>Set <varname>priority_col</varname> parameter</title>
+               <programlisting format="linespecific">
+...
+modparam("permissions", "priority_col", "column_name")
+...
 </programlisting>
                </example>
        </section>