Browse code

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

Kamailio Dev authored on 14/06/2020 09:46:20
Showing 1 changed files
... ...
@@ -32,9 +32,10 @@ Daniel-Constantin Mierla
32 32
               3.5. insert_delayed (integer)
33 33
               3.6. update_affected_found (integer)
34 34
 
35
-        4. Functions
36
-        5. Installation
37
-        6. Reading configuration from my.cnf
35
+        4. opt_ssl_mode (integer)
36
+        5. Functions
37
+        6. Installation
38
+        7. Reading configuration from my.cnf
38 39
 
39 40
    List of Examples
40 41
 
... ...
@@ -44,9 +45,10 @@ Daniel-Constantin Mierla
44 45
    1.4. Set auto_reconnect parameter
45 46
    1.5. Set insert_delayed parameter
46 47
    1.6. Set update_affected_found parameter
47
-   1.7. Set a my.cnf group in db_url parameter
48
-   1.8. Adding a kamailio group to my.cnf
49
-   1.9. Using [client] and specific group
48
+   1.7. Set opt_ssl_mode parameter
49
+   1.8. Set a my.cnf group in db_url parameter
50
+   1.9. Adding a kamailio group to my.cnf
51
+   1.10. Using [client] and specific group
50 52
 
51 53
 Chapter 1. Admin Guide
52 54
 
... ...
@@ -67,9 +69,10 @@ Chapter 1. Admin Guide
67 69
         3.5. insert_delayed (integer)
68 70
         3.6. update_affected_found (integer)
69 71
 
70
-   4. Functions
71
-   5. Installation
72
-   6. Reading configuration from my.cnf
72
+   4. opt_ssl_mode (integer)
73
+   5. Functions
74
+   6. Installation
75
+   7. Reading configuration from my.cnf
73 76
 
74 77
 1. Overview
75 78
 
... ...
@@ -181,11 +184,32 @@ modparam("db_mysql", "insert_delayed", 1)
181 184
 modparam("db_mysql", "update_affected_found", 1)
182 185
 ...
183 186
 
184
-4. Functions
187
+4. opt_ssl_mode (integer)
188
+
189
+   Control how the connection to MySQL server is done in regards to
190
+   SSL/TLS. If set to 1, SSL/TLS mode is disabled.
191
+
192
+   The 'include/mysql.h' starting with MySQL 5.7.11 defines the values for
193
+   this option as enum: 'mysql_ssl_mode { SSL_MODE_DISABLED=1,
194
+   SSL_MODE_PREFERRED, SSL_MODE_REQUIRED, SSL_MODE_VERIFY_CA,
195
+   SSL_MODE_VERIFY_IDENTITY}'.
196
+
197
+   Note: if the value of this parameter is 1, it enforces
198
+   SSL_MODE_DISABLED, any other value is passed to the mysql_options(),
199
+   not checking if it is defined.
200
+
201
+   Default value is 0 (0 - off).
202
+
203
+   Example 1.7. Set opt_ssl_mode parameter
204
+...
205
+modparam("db_mysql", "opt_ssl_mode", 1)
206
+...
207
+
208
+5. Functions
185 209
 
186 210
    No function exported to be used from configuration file.
187 211
 
188
-5. Installation
212
+6. Installation
189 213
 
190 214
    Because it depends on an external library, the mysql module is not
191 215
    compiled and installed by default. You can use one of these options.
... ...
@@ -195,7 +219,7 @@ modparam("db_mysql", "update_affected_found", 1)
195 219
      * - from command line use: 'make all include_modules="db_mysql"; make
196 220
        install include_modules="db_mysql"'.
197 221
 
198
-6. Reading configuration from my.cnf
222
+7. Reading configuration from my.cnf
199 223
 
200 224
    In order to take into account specific mysql client options, a my.cnf
201 225
    config group can be passed using the db_url module parameter. This is
... ...
@@ -207,12 +231,12 @@ modparam("db_mysql", "update_affected_found", 1)
207 231
      * mysql://user:pass@[group]/db
208 232
      * mysql://[group]/db
209 233
 
210
-   Example 1.7. Set a my.cnf group in db_url parameter
234
+   Example 1.8. Set a my.cnf group in db_url parameter
211 235
 ...
212 236
 modparam("usrloc", "db_url", "mysql://[kamailio]/kamailio)
213 237
 ...
214 238
 
215
-   Example 1.8. Adding a kamailio group to my.cnf
239
+   Example 1.9. Adding a kamailio group to my.cnf
216 240
 ...
217 241
 [kamailio]
218 242
 socket = /path/to/mysql.sock
... ...
@@ -226,7 +250,7 @@ default-character-set = utf8
226 250
    both your specific group and the client group, then the value is taken
227 251
    from the last one.
228 252
 
229
-   Example 1.9. Using [client] and specific group
253
+   Example 1.10. Using [client] and specific group
230 254
 ...
231 255
 [client]
232 256
 socket = /run/mysql/mysqld.sock