From 37c6c987e08eaf7baeb8b70fa85726f3168a631a Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Michal=20=C4=8Ciha=C5=99?= Date: Wed, 27 Apr 2016 13:41:48 +0200 Subject: [PATCH] Better documentation for config file MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: Michal Čihař --- doc/config.rst | 24 ++++++++++++++++++++---- 1 file changed, 20 insertions(+), 4 deletions(-) diff --git a/doc/config.rst b/doc/config.rst index 005c3ca42e..ef518fa357 100644 --- a/doc/config.rst +++ b/doc/config.rst @@ -5,10 +5,15 @@ Configuration ============= -Almost all configurable data is placed in :file:`config.inc.php`. If this file -does not exist, please refer to the :ref:`setup` section to create one. This -file only needs to contain the parameters you want to change from their -corresponding default value in :file:`libraries/config.default.php`. +All configurable data is placed in :file:`config.inc.php` in phpMyAdmin's +toplevel directory. If this file does not exist, please refer to the +:ref:`setup` section to create one. This file only needs to contain the +parameters you want to change from their corresponding default value in +:file:`libraries/config.default.php` (this file is not inteded for changes). + +.. seealso:: + + :ref:`config-examples` for examples of configurations If a directive is missing from your file, you can just add another line with the file. This file is for over-writing the defaults; if you wish to use the @@ -2967,11 +2972,22 @@ Developer This is used for `phpMyAdmin demo server `_. +.. _config-examples: + Examples -------- See following configuration snippets for usual setups of phpMyAdmin. +Basic example ++++++++++++++ + +This example is distributed with phpMyAdmin as :file:`config.sample.inc.php`: + +.. literalinclude:: ../config.sample.inc.php + :language: php + + .. _example-google-ssl: Google Cloud SQL with SSL