From 15ff80185c727ff3ddf6a8203edf2b0c25af5c8e Mon Sep 17 00:00:00 2001 From: Martin Date: Tue, 28 Aug 2018 09:09:45 +0200 Subject: [PATCH] Improve the top section of config description --- .../server/config_sample_php_parameters.rst | 35 ++++++++++++++----- 1 file changed, 26 insertions(+), 9 deletions(-) diff --git a/admin_manual/configuration/server/config_sample_php_parameters.rst b/admin_manual/configuration/server/config_sample_php_parameters.rst index c7f203250..3ac977c56 100644 --- a/admin_manual/configuration/server/config_sample_php_parameters.rst +++ b/admin_manual/configuration/server/config_sample_php_parameters.rst @@ -10,20 +10,37 @@ is usually not necessary to edit ``config/config.php``. .. note:: The installer creates a configuration containing the essential parameters. Only manually add configuration parameters to ``config/config.php`` if you need to - use a special value for a parameter. **Do not copy everything from** - ``config/config.sample.php`` **. Only enter the parameters you wish to modify!** + use a special value for a parameter. + **Do not copy everything from** ``config/config.sample.php`` + **. Only enter the parameters you wish to modify!** + +Multiple configuration files +---------------------------- ownCloud supports loading configuration parameters from multiple files. -You can add arbitrary files ending with :file:`.config.php` in the :file:`config/` -directory, for example you could place your email server configuration -in :file:`email.config.php`. This allows you to easily create and manage -custom configurations, or to divide a large complex configuration file -into a set of smaller files. These custom files are not overwritten by -ownCloud, and the values in these files take precedence over :file:`config.php`. +You can add arbitrary files ending with `.config.php` in the `config/` directory. + +Example: + +You could place your email server configuration in `email.config.php`. + +This allows you to easily create and manage custom configurations, or to divide a +large complex configuration file into a set of smaller files. + +.. note:: These custom files are not overwritten by ownCloud, + and the values in these files take precedence over `config.php` + +.. note:: ownCloud may write configurations into the ``config.php`` file. + These configurations may confict with identical keys already set in additional config files. + Be careful when using this capability! .. The following section is auto-generated from .. https://github.com/owncloud/core/blob/master/config/config.sample.php -.. Do not edit this file; edit the source file in core +.. Do not edit the content of this file between _section_start and _sections_end +.. The content there will be loaded and replaced via script from the source file from the link above +.. Any configuration changes done in this file will be overwritten on the next update +.. You can of course change the common desription above this text which will then be part of the next update + .. DEFAULT_SECTION_START