From 37abcc3d6e5f3774a07bbd9219484d72844b684a Mon Sep 17 00:00:00 2001 From: Liviu Chircu Date: Tue, 7 Jul 2020 17:03:49 +0300 Subject: [PATCH] permissions docs: Update partition, db_url and address_table (cherry picked from commit 180674b833ef9e82cb3f97105add2ada6843ddc1) (cherry picked from commit 67c06628eae20cca4fc3e5509435b775a425d17e) (cherry picked from commit 8ad9847f0b010b5344c1d9fdf4b4f65f347efae8) --- modules/dialplan/doc/dialplan_admin.xml | 2 +- modules/permissions/doc/permissions_admin.xml | 34 +++++++++---------- 2 files changed, 18 insertions(+), 18 deletions(-) diff --git a/modules/dialplan/doc/dialplan_admin.xml b/modules/dialplan/doc/dialplan_admin.xml index aaa3fd125e0..556c1bd5c8a 100644 --- a/modules/dialplan/doc/dialplan_admin.xml +++ b/modules/dialplan/doc/dialplan_admin.xml @@ -321,7 +321,7 @@ <varname>partition</varname> (string) Specify a new dialplan partition (data source). This parameter may - be set multiple times. Each partition may have a specific "db_url" or + be set multiple times. Each partition may have a specific "db_url" and "table_name". If not specified, these values will be inherited from , db_default_url or , respectively. The name of diff --git a/modules/permissions/doc/permissions_admin.xml b/modules/permissions/doc/permissions_admin.xml index f64d76f70e7..97781695c2b 100644 --- a/modules/permissions/doc/permissions_admin.xml +++ b/modules/permissions/doc/permissions_admin.xml @@ -342,17 +342,17 @@ modparam("permissions", "deny_suffix", ".deny")
<varname>db_url</varname> (string) - This is URL of the database to be used for loading the date related to + The URL of the database to be used for loading the data related to IP-based checking (address table). This parameter is optional and it is needed only if you use functions related to IP-based checking. If you do so, you need to - explicitly set this parameter (it is not covered by + explicitly set this parameter (it will not inherit from db_default_url) - Since version 2.2, this URL represents the db_url for the + Since version 2.2, this URL represents the db_url for the default partition. @@ -374,8 +374,8 @@ modparam("permissions", "db_url", "&exampledb;") Name of database table containing matching rules used by allow_register function. - Since version 2.2, this table name represents the table name - for the default partition. + Since version 2.2, this table name also represents the default table + name for partitions without a 'table_name' setting. @@ -394,23 +394,23 @@ modparam("permissions", "address_table", "pbx")
<varname>partition</varname> (string) - Create a partition containg an url and a table name. Partitions - allow you to use different databases or different tables from - the same database. It is IMPORTANT that you split the paramteres by - ";". Also, it is very IMPORTANT to put ";" after the last parameter, - elseway it will not be taken into consideration. + Specify a new IP-based checking partition (data source). This + parameter may be set multiple times. Each partition may have a + specific "db_url" and "table_name". If not specified, these values + will be inherited from , db_default_url + or , respectively. The name of + the default partition is 'default'. - - The db_url for a partition is mandatory. The table name, instead, - has a default value 'address'. - Set <varname>partition</varname> parameter ... -modparam("permissions", "partition", "my_part: db_url=some_url; table_name=some_table;") +modparam("permissions", "partition", " + inbound: + db_url = postgres://opensips:opensipsrw@127.0.0.1/opensips; + table_name = address") ... @@ -460,7 +460,7 @@ modparam("permissions", "ip_col", "ipess") <varname>mask_col</varname> (string) Name of address table column containing network mask of - the address. Possible values are 0-128. It should be up to 32 if + the address. Possible values are 0-128. It should be up to 32 if the IP is v4 and up to 128 if the IP is v6. @@ -529,7 +529,7 @@ modparam("permissions", "proto_col", "transport") <varname>pattern_col</varname> (string) Name of address table column containinga a pattern (a shell wildcard - pattern, like the ones used for file name matching) that is matched + pattern, like the ones used for file name matching) that is matched against the arguments received by check_address or check_source_address.