[commits] [Wiki] changed: Doc/Dev/Configuration

[Jan Schneider]

jan  Wed, 04 Sep 2013 14:18:00 +0000

Modified page: http://wiki.horde.org/Doc/Dev/Configuration
New Revision:  3
Change log:  Update to reality

@@ -10,15 +10,15 @@
  There is a set of default configuration files that are mandatory for  
an application, or optional but consistently used across all  
applications:
  * {{conf.php}}: This is the main configuration file that contains  
global options for every application.
  * {{prefs.php}}: This file controls the available user preferences  
for the application, their default values, and also controls which  
preferences users can alter.
  * {{mime_drivers.php}}: This file controls local MIME drivers for  
the application, specifically what kinds of files are viewable and/or  
downloadable.
-* {{servers.php}}, {{backends.php}}, {{sources.php}}: If an  
application can connect to different servers, backends, or  
directories, these will be defined and configured here.
+* {{backends.php}}: If an application can connect to different  
servers, backends, or directories, these will be defined and  
configured here.

-Normally, the configuration files have distributed examples with a  
{{.dist}} suffix appended to the file names. The {{prefs.php}} file  
for example comes distributed as {{prefs.php.dist}}. Applications are  
configured by copying e.g. {{prefs.php.dist}} to {{prefs.php}} and  
editing the configuration files with any text editor.
+Applications are configured by creating {{*.local.php}} files e.g.  
{{prefs.local.php}} to customize {{prefs.php}} and changing individual  
settings by adding them to those {{.local.php}} configuration files  
with any text editor.

-The only exception is currently the {{conf.php}} file, which no  
longer comes as a {{conf.php.dist}} file, but as a {{conf.xml}} file  
containing the available options and their default values as XML  
markup (see ((ConfXML))). A graphical setup interface is created from  
this XML data that administrators can open and edit in their browsers.  
If they submit the configuration form, the PHP configuration files are  
created automatically, they no longer need to edited manually. This  
approach solves most of the drawbacks with PHP configuration files  
while keeping the good things:
+The only exception is currently the {{conf.php}} file, which comes as  
a {{conf.xml}} file containing the available options and their default  
values as XML markup (see ((ConfXML))). A graphical setup interface is  
created from this XML data that administrators can open and edit in  
their browsers. If they submit the configuration form, the PHP  
configuration files are created automatically, they no longer need to  
edited manually. This approach solves most of the drawbacks with PHP  
configuration files while keeping the good things:
  * The chances are much lower that administrators accidentally break  
the configuration files by creating invalid PHP code.
  * Configuration is much easier using a graphical interface.
  * The configuration files are still PHP code.
  * Administrators can still customize the configuration with their  
own PHP code.

-This approach will be extended over other configuration files in the future.
+This approach may be extended over other configuration files in the future.