Преглед на файлове

modules: readme files regenerated - db_redis ... [skip ci]

Kamailio Dev преди 1 година
родител
ревизия
3c16c13acd
променени са 2 файла, в които са добавени 24 реда и са изтрити 10 реда
  1. 12 5
      src/modules/db_redis/README
  2. 12 5
      src/modules/ndb_redis/README

+ 12 - 5
src/modules/db_redis/README

@@ -39,7 +39,7 @@ Joel Centelles Martin
               4.3. verbosity (int)
               4.3. verbosity (int)
               4.4. opt_tls (int)
               4.4. opt_tls (int)
               4.5. db_pass (string)
               4.5. db_pass (string)
-              4.6. ac_path (string)
+              4.6. ca_path (string)
 
 
         5. Usage
         5. Usage
         6. Module Specific Considerations
         6. Module Specific Considerations
@@ -75,7 +75,7 @@ Chapter 1. Admin Guide
         4.3. verbosity (int)
         4.3. verbosity (int)
         4.4. opt_tls (int)
         4.4. opt_tls (int)
         4.5. db_pass (string)
         4.5. db_pass (string)
-        4.6. ac_path (string)
+        4.6. ca_path (string)
 
 
    5. Usage
    5. Usage
    6. Module Specific Considerations
    6. Module Specific Considerations
@@ -203,7 +203,7 @@ allid,time_hires&cid:callid
    4.3. verbosity (int)
    4.3. verbosity (int)
    4.4. opt_tls (int)
    4.4. opt_tls (int)
    4.5. db_pass (string)
    4.5. db_pass (string)
-   4.6. ac_path (string)
+   4.6. ca_path (string)
 
 
 4.1. schema_path (string)
 4.1. schema_path (string)
 
 
@@ -247,6 +247,12 @@ modparam("db_redis", "verbosity", 0)
    Controls TLS usage while connecting to a remote DB. If set to 1, TLS is
    Controls TLS usage while connecting to a remote DB. If set to 1, TLS is
    used to connect to the DB.
    used to connect to the DB.
 
 
+   If TLS is enabled, the module will validate the Redis server
+   certificate against the ca_path. There is currently no way to connect
+   with a specified client certificate, the corresponding configuration to
+   check client certificates in the Redis server must therefore be turned
+   off.
+
    Default value: 0.
    Default value: 0.
 
 
    Example 1.4. Enabling TLS connection
    Example 1.4. Enabling TLS connection
@@ -265,9 +271,10 @@ modparam("db_redis", "opt_tls", 1)
 modparam("db_redis", "db_pass", "r3d1sPass")
 modparam("db_redis", "db_pass", "r3d1sPass")
 ...
 ...
 
 
-4.6. ac_path (string)
+4.6. ca_path (string)
 
 
-   Sets the path where Certificates Authorities certs are stored.
+   Sets the path where Certificates Authorities certs for the Redis server
+   certificate are stored.
 
 
    Default value: "" (empty).
    Default value: "" (empty).
 
 

+ 12 - 5
src/modules/ndb_redis/README

@@ -55,7 +55,7 @@ Joel Centelles Martin
               3.8. flush_on_reconnect (integer)
               3.8. flush_on_reconnect (integer)
               3.9. allow_dynamic_nodes (integer)
               3.9. allow_dynamic_nodes (integer)
               3.10. debug (integer)
               3.10. debug (integer)
-              3.11. ac_path (string)
+              3.11. ca_path (string)
 
 
         4. Functions
         4. Functions
 
 
@@ -103,7 +103,7 @@ Chapter 1. Admin Guide
         3.8. flush_on_reconnect (integer)
         3.8. flush_on_reconnect (integer)
         3.9. allow_dynamic_nodes (integer)
         3.9. allow_dynamic_nodes (integer)
         3.10. debug (integer)
         3.10. debug (integer)
-        3.11. ac_path (string)
+        3.11. ca_path (string)
 
 
    4. Functions
    4. Functions
 
 
@@ -149,7 +149,7 @@ Chapter 1. Admin Guide
    3.8. flush_on_reconnect (integer)
    3.8. flush_on_reconnect (integer)
    3.9. allow_dynamic_nodes (integer)
    3.9. allow_dynamic_nodes (integer)
    3.10. debug (integer)
    3.10. debug (integer)
-   3.11. ac_path (string)
+   3.11. ca_path (string)
 
 
 3.1. server (str)
 3.1. server (str)
 
 
@@ -168,6 +168,12 @@ Chapter 1. Admin Guide
    many REDIS servers, just give different attributes and use the specific
    many REDIS servers, just give different attributes and use the specific
    server name when querying the REDIS instance.
    server name when querying the REDIS instance.
 
 
+   If tls is enabled, the module will validate the REDIS server
+   certificate against the ca_path. There is currently no way to connect
+   with a specified client certificate, the corresponding configuration to
+   check client certificates in the REDIS server must therefore be turned
+   off.
+
    Default value is NULL.
    Default value is NULL.
 
 
    Example 1.1. Set server parameter
    Example 1.1. Set server parameter
@@ -346,9 +352,10 @@ modparam("ndb_redis", "allow_dynamic_nodes", 1)
 modparam("ndb_redis", "debug", 1)
 modparam("ndb_redis", "debug", 1)
 ...
 ...
 
 
-3.11. ac_path (string)
+3.11. ca_path (string)
 
 
-   Sets the path where Certificates Authorities certs are stored.
+   Sets the path where Certificates Authorities certs for the REDIS server
+   certificate are stored.
 
 
    Default value: "" (empty).
    Default value: "" (empty).