[sr-dev] git:master:a10d6860: modules: readme files regenerated - db_mysql ... [skip ci]

[Kamailio Dev]

Module: kamailio
Branch: master
Commit: a10d6860c69a518a1b60a17640cfb4da65839214
URL: https://github.com/kamailio/kamailio/commit/a10d6860c69a518a1b60a17640cfb4da65839214

Author: Kamailio Dev <kamailio.dev at kamailio.org>
Committer: Kamailio Dev <kamailio.dev at kamailio.org>
Date: 2020-06-14T11:46:20+02:00

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

---

Modified: src/modules/db_mysql/README

---

Diff:  https://github.com/kamailio/kamailio/commit/a10d6860c69a518a1b60a17640cfb4da65839214.diff
Patch: https://github.com/kamailio/kamailio/commit/a10d6860c69a518a1b60a17640cfb4da65839214.patch

---

diff --git a/src/modules/db_mysql/README b/src/modules/db_mysql/README
index 69bd5e979d..8d67a41097 100644
--- a/src/modules/db_mysql/README
+++ b/src/modules/db_mysql/README
@@ -32,9 +32,10 @@ Daniel-Constantin Mierla
               3.5. insert_delayed (integer)
               3.6. update_affected_found (integer)
 
-        4. Functions
-        5. Installation
-        6. Reading configuration from my.cnf
+        4. opt_ssl_mode (integer)
+        5. Functions
+        6. Installation
+        7. Reading configuration from my.cnf
 
    List of Examples
 
@@ -44,9 +45,10 @@ Daniel-Constantin Mierla
    1.4. Set auto_reconnect parameter
    1.5. Set insert_delayed parameter
    1.6. Set update_affected_found parameter
-   1.7. Set a my.cnf group in db_url parameter
-   1.8. Adding a kamailio group to my.cnf
-   1.9. Using [client] and specific group
+   1.7. Set opt_ssl_mode parameter
+   1.8. Set a my.cnf group in db_url parameter
+   1.9. Adding a kamailio group to my.cnf
+   1.10. Using [client] and specific group
 
 Chapter 1. Admin Guide
 
@@ -67,9 +69,10 @@ Chapter 1. Admin Guide
         3.5. insert_delayed (integer)
         3.6. update_affected_found (integer)
 
-   4. Functions
-   5. Installation
-   6. Reading configuration from my.cnf
+   4. opt_ssl_mode (integer)
+   5. Functions
+   6. Installation
+   7. Reading configuration from my.cnf
 
 1. Overview
 
@@ -181,11 +184,32 @@ modparam("db_mysql", "insert_delayed", 1)
 modparam("db_mysql", "update_affected_found", 1)
 ...
 
-4. Functions
+4. opt_ssl_mode (integer)
+
+   Control how the connection to MySQL server is done in regards to
+   SSL/TLS. If set to 1, SSL/TLS mode is disabled.
+
+   The 'include/mysql.h' starting with MySQL 5.7.11 defines the values for
+   this option as enum: 'mysql_ssl_mode { SSL_MODE_DISABLED=1,
+   SSL_MODE_PREFERRED, SSL_MODE_REQUIRED, SSL_MODE_VERIFY_CA,
+   SSL_MODE_VERIFY_IDENTITY}'.
+
+   Note: if the value of this parameter is 1, it enforces
+   SSL_MODE_DISABLED, any other value is passed to the mysql_options(),
+   not checking if it is defined.
+
+   Default value is 0 (0 - off).
+
+   Example 1.7. Set opt_ssl_mode parameter
+...
+modparam("db_mysql", "opt_ssl_mode", 1)
+...
+
+5. Functions
 
    No function exported to be used from configuration file.
 
-5. Installation
+6. Installation
 
    Because it depends on an external library, the mysql module is not
    compiled and installed by default. You can use one of these options.
@@ -195,7 +219,7 @@ modparam("db_mysql", "update_affected_found", 1)
      * - from command line use: 'make all include_modules="db_mysql"; make
        install include_modules="db_mysql"'.
 
-6. Reading configuration from my.cnf
+7. Reading configuration from my.cnf
 
    In order to take into account specific mysql client options, a my.cnf
    config group can be passed using the db_url module parameter. This is
@@ -207,12 +231,12 @@ modparam("db_mysql", "update_affected_found", 1)
      * mysql://user:pass@[group]/db
      * mysql://[group]/db
 
-   Example 1.7. Set a my.cnf group in db_url parameter
+   Example 1.8. Set a my.cnf group in db_url parameter
 ...
 modparam("usrloc", "db_url", "mysql://[kamailio]/kamailio)
 ...
 
-   Example 1.8. Adding a kamailio group to my.cnf
+   Example 1.9. Adding a kamailio group to my.cnf
 ...
 [kamailio]
 socket = /path/to/mysql.sock
@@ -226,7 +250,7 @@ default-character-set = utf8
    both your specific group and the client group, then the value is taken
    from the last one.
 
-   Example 1.9. Using [client] and specific group
+   Example 1.10. Using [client] and specific group
 ...
 [client]
 socket = /run/mysql/mysqld.sock