Driver name mysql.
Driver for MySQL / MariaDB server.
To compile support for this driver, you need to have MySQL client library and headers installed.
For MariaDB, you need to have compatibility headers installed.
See MySQL authentication.
mysql| Default | [None] |
|---|---|
| Value | Named List Filter |
| See Also |
Creates a new MySQL connection. If more than one is specified, the connections
are automatically used for load balancing and for failover. The filter name
refers to the mysql_host setting.
mysql_client_flags| Default | [None] |
|---|---|
| Value | unsigned integer |
Flags to use when connecting to the database, provided as base-10 number. See https://dev.mysql.com/doc/c-api/8.0/en/mysql-real-connect.html
mysql_connect_timeout| Default | 5s |
|---|---|
| Value | time |
How long to wait for connection.
mysql_connection_limit| Default | 5 |
|---|---|
| Value | unsigned integer |
Maximum number of parallel connections. Currently MySQL queries are blocking, so only a single connection can be used in parallel.
mysql_dbname| Default | [None] |
|---|---|
| Value | string |
Database name to connect to.
mysql_host| Default | localhost |
|---|---|
| Value | string |
Host or UNIX socket path to connect to. The mysql setting defaults
to this.
INFO
MySQL drivers can default to using UNIX socket connection when host is
localhost and port is 0 (default). To force it to use TCP connection,
set mysql_host = 127.0.0.1 or set mysql_port explicitly.
mysql_option_file| Default | [None] |
|---|---|
| Value | string |
File to read for client library specific configuration.
mysql_option_group| Default | [None] |
|---|---|
| Value | string |
Section name to read from mysql_option_file.
mysql_password| Default | [None] |
|---|---|
| Value | string |
Password for authentication.
mysql_port| Default | 0 (defaults to 3306 for TCP connections) |
|---|---|
| Value | Port Number |
Port to connect to.
mysql_read_timeout| Default | 30s |
|---|---|
| Value | time |
Timeout when reading data from server.
mysql_ssl| Default | no |
|---|---|
| Value | boolean |
| See Also |
Whether to use SSL when connecting to MySQL. Configure it using the
ssl_client_* settings. See SSL.
mysql_user| Default | [None] |
|---|---|
| Value | string |
Username for authentication.
mysql_write_timeout| Default | 30s |
|---|---|
| Value | time |
Timeout in seconds when writing data to server.
ssl_cipher_list| Default | ALL:!kRSA:!SRP:!kDHd:!DSS:!aNULL:!eNULL:!EXPORT:!DES:!3DES:!MD5:!PSK:!RC4:!ADH:!LOW@STRENGTH (for ssl_server, empty for ssl_client) |
|---|---|
| Value | string |
| See Also |
The list of SSL ciphers to use for TLSv1.2 and below connections, in order
of preference. Use ssl_cipher_suites for TLSv1.3 connections.
You do not need to edit this setting in order to disable specific SSL
protocols; that is best done with ssl_min_protocol instead.
This setting is used for both incoming and outgoing SSL connections.
ssl_client_ca_dir| Default | [None] |
|---|---|
| Value | string |
| See Also |
The directory where trusted SSL CA certificates can be found. For example
/etc/ssl/certs. These certificates are used only for outgoing SSL
connections (e.g. with the imapc driver).
For extra security you might want to point to a directory containing certificates only for the CAs that are actually needed for the server operation instead of all the root CAs.
ssl_client_ca_file| Default | [None] |
|---|---|
| Value | File |
| See Also |
File containing the trusted SSL CA certificates. For example
/etc/ssl/certs/ca-bundle.crt.
These certificates are used only for outgoing SSL connections (e.g. with the imapc driver).
Note that this setting isn't recommended to be used with large CA bundles,
because all the certificates are read into memory. This leads to excessive
memory usage, because it gets multiplied by the number of imap processes.
It's better to either use ssl_client_ca_dir setting or
use a CA bundle that only contains the CAs that are actually necessary for
the server operation.
ssl_client_cert_file| Default | [None] |
|---|---|
| Value | File |
| See Also |
Public SSL certificate used for outgoing SSL connections. This is generally needed only when the server authenticates the client using the certificate.
ssl_client_key_file is also needed for the private certificate.
Example:
ssl_client_cert_file = /etc/dovecot/dovecot-client.crt
ssl_client_key_file = /etc/dovecot/dovecot-client.keyssl_client_key_file| Default | [None] |
|---|---|
| Value | File |
| See Also |
Private key for ssl_client_cert_file. If it is password protected,
set the password with ssl_client_key_password.
Example:
ssl_client_cert_file = /etc/dovecot/dovecot-client.crt
ssl_client_key_file = /etc/dovecot/dovecot-client.keyssl_client_require_valid_cert| Default | yes |
|---|---|
| Value | boolean |
| See Also |
Require a valid certificate when connecting to external SSL services?
Not all of Dovecot SSL settings are supported by the MySQL library. Below is the list of supported settings: