gian/phpmyadmin
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Merge #19465 - documentation(setup.rst): Add all new ENV for the Docker image (mTLS) and added all missing ones

Browse Source 
Pull-request: #19465

Co-Authored-by: William Desportes <williamdes@wdes.fr>
Signed-off-by: William Desportes <williamdes@wdes.fr>
This commit is contained in:
William Desportes 2025-01-16 01:08:50 +01:00
commit 7274abc34e
No known key found for this signature in database
GPG Key ID: 90A0EF1B8251A889
1 changed files with 92 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

92
doc/setup.rst
View File

@ -329,6 +329,98 @@ You can configure several phpMyAdmin features using environment variables:
If set, this option will change the default Apache port from `80` in case you want it to run on a different port like an unprivileged port. Set to any port value (such as `APACHE_PORT=8090`).
.. envvar:: PMA_SSL_DIR
Define the path used for SSL files generated from environment variables, default value is `/etc/phpmyadmin/ssl`.
.. envvar:: PMA_SSL
When set to `1`, defines SSL usage for the MySQL connection.
.. seealso:: :config:option:`$cfg['Servers'][$i]['ssl']`
.. envvar:: PMA_SSLS
Comma-separated list of `0` and `1` defining SSL usage for the corresponding MySQL connections.
.. envvar:: PMA_SSL_VERIFY
When set to `1`, enables SSL certificate verification for the MySQL connection.
.. seealso:: :config:option:`$cfg['Servers'][$i]['ssl_verify']`
.. envvar:: PMA_SSL_VERIFIES
Comma-separated list of `0` and `1` to enable or disable SSL certificate verification for multiple MySQL connections.
.. seealso:: :config:option:`$cfg['Servers'][$i]['ssl_verify']`
.. envvar:: PMA_SSL_CA
In the context of mutual TLS security, allows setting your CA file as a string inside the default `config.inc.php`.
.. seealso:: :config:option:`$cfg['Servers'][$i]['ssl_ca']`
.. envvar:: PMA_SSL_CAS
In the context of mutual TLS security, allows setting multiple CA files as a comma-separated list of strings inside the default `config.inc.php`.
.. envvar:: PMA_SSL_CA_BASE64
In the context of mutual TLS security, allows setting your CA file as a base64 string inside the default `config.inc.php`.
.. seealso:: :config:option:`$cfg['Servers'][$i]['ssl_ca']`
.. envvar:: PMA_SSL_CAS_BASE64
In the context of mutual TLS security, allows setting multiple CA files as a comma-separated list of base64 strings inside the default `config.inc.php`.
.. envvar:: PMA_SSL_CERT
In the context of mutual TLS security, allows setting your CERT file as a string inside the default `config.inc.php`.
.. seealso:: :config:option:`$cfg['Servers'][$i]['ssl_cert']`
.. envvar:: PMA_SSL_CERTS
In the context of mutual TLS security, allows setting multiple CERT files as a comma-separated list of strings inside the default `config.inc.php`.
.. envvar:: PMA_SSL_CERT_BASE64
In the context of mutual TLS security, allows setting your CERT file as a base64 string inside the default `config.inc.php`.
.. seealso:: :config:option:`$cfg['Servers'][$i]['ssl_cert']`
.. envvar:: PMA_SSL_CERTS_BASE64
In the context of mutual TLS security, allows setting multiple CERT files as a comma-separated list of base64 strings inside the default `config.inc.php`.
.. envvar:: PMA_SSL_KEY
In the context of mutual TLS security, allows setting your KEY file as a string inside the default `config.inc.php`.
.. envvar:: PMA_SSL_KEYS
In the context of mutual TLS security, allows setting multiple KEY files as a comma-separated list of strings inside the default `config.inc.php`.
.. seealso:: :config:option:`$cfg['Servers'][$i]['ssl_key']`
.. envvar:: PMA_SSL_KEY_BASE64
In the context of mutual TLS security, allows setting your KEY file as a base64 string inside the default `config.inc.php`.
.. seealso:: :config:option:`$cfg['Servers'][$i]['ssl_key']`
.. envvar:: PMA_SSL_KEYS_BASE64
In the context of mutual TLS security, allows setting multiple KEY files as a comma-separated list of base64 strings inside the default `config.inc.php`.
.. envvar:: TZ
If defined, this option will change the default PHP `date.timezone` from `UTC`.
.. seealso:: :config:option:`$cfg['Servers'][$i]['SessionTimeZone']`
By default, :ref:`cookie` is used, but if :envvar:`PMA_USER` and
:envvar:`PMA_PASSWORD` are set, it is switched to :ref:`auth_config`.