[sr-dev] git:master: group: Minor changes to documentation
Olle E. Johansson
oej at edvina.net
Wed Nov 28 12:03:22 CET 2012
Module: sip-router
Branch: master
Commit: eddd6b80432a3feda925ccb629bf55892d4b175f
URL: http://git.sip-router.org/cgi-bin/gitweb.cgi/sip-router/?a=commit;h=eddd6b80432a3feda925ccb629bf55892d4b175f
Author: Olle E. Johansson <oej at edvina.net>
Committer: Olle E. Johansson <oej at edvina.net>
Date: Wed Nov 28 12:02:53 2012 +0100
group: Minor changes to documentation
---
modules_k/group/README | 34 +++++++++++++++++-----------------
modules_k/group/doc/group_admin.xml | 18 +++++++++---------
2 files changed, 26 insertions(+), 26 deletions(-)
diff --git a/modules_k/group/README b/modules_k/group/README
index 4091482..c2ce2a7 100644
--- a/modules_k/group/README
+++ b/modules_k/group/README
@@ -99,14 +99,14 @@ Chapter 1. Admin Guide
1.1. Strict membership checking
1.2. Regular Expression based checking
- This module provides functionalities for different methods of group
+ This module provides functionality for two different methods of group
membership checking.
1.1. Strict membership checking
- There is a database table that contains list of users and groups they
- belong to. The module provides the possibility to check if a specific
- user belongs to a specific group.
+ The module uses a database table that contains a list of users and
+ groups they belong to. The module provides the possibility to check if
+ a specific user belongs to a specific group.
There is no DB caching support, each check involving a DB query.
@@ -117,7 +117,7 @@ Chapter 1. Admin Guide
This type of matching may be used to fetch the group ID(s) the user
belongs to (via RE matching) .
- Due performance reasons (regular expression evaluation), DB cache
+ Due to performance reasons (regular expression evaluation), DB cache
support is available: the table content is loaded into memory at
startup and all regular expressions are compiled.
@@ -154,11 +154,11 @@ Chapter 1. Admin Guide
URL of the database table to be used.
- Default value is "mysql://openserro:openserro@localhost/openser".
+ Default value is "mysql://kamailioro:kamailioro@localhost/kamailio".
Example 1.1. Set db_url parameter
...
-modparam("group", "db_url", "mysql://username:password@dbhost/openser")
+modparam("group", "db_url", "dbdriver://username:password@dbhost/dbname")
...
3.2. table (string)
@@ -197,7 +197,7 @@ modparam("group", "domain_column", "realm")
3.5. group_column (string)
- Name of the "table" column holding groups.
+ Name of the "table" column holding group names.
Default value is "grp".
@@ -208,11 +208,11 @@ modparam("group", "group_column", "grp")
3.6. use_domain (integer)
- If enabled (set to non zero value) then domain will be used also used
- for strict group matching; otherwise only the username part will be
- used.
+ If enabled (set to a non zero value) then the domain will be used also
+ used for strict group matching; otherwise only the username part will
+ be used.
- Default value is 0 (no).
+ Default value is 0 (disabled).
Example 1.6. Set use_domain parameter
...
@@ -261,7 +261,7 @@ modparam("group", "re_gid_column", "grp_id")
all group IDs that match the user; otherwise only the first will be
returned.
- Default value is "1".
+ Default value is "1" (enabled).
Example 1.10. Set multiple_gid parameter
...
@@ -273,11 +273,11 @@ modparam("group", "multiple_gid", 0)
4.1. is_user_in(URI, group)
4.2. get_user_group(URI, AVP)
-4.1. is_user_in(URI, group)
+4.1. is_user_in(URI, group)
This function is to be used for script group membership. The function
- returns true if username in the given URI is member of the given group
- and false if not.
+ returns true if username in the given URI is a member of the given
+ group and false if not.
Meaning of the parameters is as follows:
* URI - URI whose username and optionally domain to be used, this can
@@ -300,7 +300,7 @@ if (is_user_in("Request-URI", "ld")) {
};
...
-4.2. get_user_group(URI, AVP)
+4.2. get_user_group(URI, AVP)
This function is to be used for regular expression based group
membership. The function returns true if username in the given URI
diff --git a/modules_k/group/doc/group_admin.xml b/modules_k/group/doc/group_admin.xml
index 6bce8f3..7fd83fd 100644
--- a/modules_k/group/doc/group_admin.xml
+++ b/modules_k/group/doc/group_admin.xml
@@ -16,13 +16,13 @@
<section>
<title>Overview</title>
<para>
- This module provides functionalities for different methods of group
+ This module provides functionality for two different methods of group
membership checking.
</para>
<section>
<title>Strict membership checking</title>
<para>
- There is a database table that contains list of users and groups
+ The module uses a database table that contains a list of users and groups
they belong to. The module provides the possibility to check if a
specific user belongs to a specific group.
</para>
@@ -39,7 +39,7 @@
group ID(s) the user belongs to (via RE matching) .
</para>
<para>
- Due performance reasons (regular expression evaluation), DB cache
+ Due to performance reasons (regular expression evaluation), DB cache
support is available: the table content is loaded into memory at
startup and all regular expressions are compiled.
</para>
@@ -94,7 +94,7 @@
<title>Set <varname>db_url</varname> parameter</title>
<programlisting format="linespecific">
...
-modparam("group", "db_url", "mysql://username:password@dbhost/openser")
+modparam("group", "db_url", "&exampledb;")
...
</programlisting>
</example>
@@ -164,7 +164,7 @@ modparam("group", "domain_column", "realm")
<section>
<title><varname>group_column</varname> (string)</title>
<para>
- Name of the <quote>table</quote> column holding groups.
+ Name of the <quote>table</quote> column holding group names.
</para>
<para>
<emphasis>
@@ -184,13 +184,13 @@ modparam("group", "group_column", "grp")
<section>
<title><varname>use_domain</varname> (integer)</title>
<para>
- If enabled (set to non zero value) then domain will be used also used
+ If enabled (set to a non zero value) then the domain will be used also used
for strict group matching; otherwise only the username part will be
used.
</para>
<para>
<emphasis>
- Default value is 0 (no).
+ Default value is 0 (disabled).
</emphasis>
</para>
<example>
@@ -275,7 +275,7 @@ modparam("group", "re_gid_column", "grp_id")
</para>
<para>
<emphasis>
- Default value is <quote>1</quote>.
+ Default value is <quote>1</quote> (enabled).
</emphasis>
</para>
<example>
@@ -297,7 +297,7 @@ modparam("group", "multiple_gid", 0)
</title>
<para>
This function is to be used for script group membership. The function
- returns true if username in the given &uri; is member of the given
+ returns true if username in the given &uri; is a member of the given
group and false if not.
</para>
<para>Meaning of the parameters is as follows:</para>
More information about the sr-dev
mailing list