From e8eec9a32fabef951d49cf5ff58ff4534704711c Mon Sep 17 00:00:00 2001 From: Eric Lippmann Date: Wed, 19 Nov 2014 16:09:15 +0100 Subject: [PATCH] Remove doc/CONFIG.md --- doc/CONFIG.md | 35 ----------------------------------- 1 file changed, 35 deletions(-) delete mode 100644 doc/CONFIG.md diff --git a/doc/CONFIG.md b/doc/CONFIG.md deleted file mode 100644 index e19f90bd5..000000000 --- a/doc/CONFIG.md +++ /dev/null @@ -1,35 +0,0 @@ -# Application and Module Configuration - -## Basic usage - -The \Icinga\Application\Config class is a general purpose service to help you find, load and save -configuration data. It is used both by the Icinga Web 2 modules and the framework itself. With -INI files as source it enables you to store configuration in a familiar format. Icinga Web 2 -defines some configuration files for its own purposes. Please note that both modules and framework -keep their main configuration in the INI file called config.ini. Here's some example code: - -```php -global->get('defaultTimezone', 'Europe/Berlin'); - -// If you don't pass a configuration name to IcingaConfig::app it tries to load values from the -// application's config.ini. For using other files you have to pass this parameter though. -// The following example loads a section from the application's authentication.ini: -IcingaConfig::app('authentication')->get('ldap-authentication'); - -// If you don't pass a configuration name to IcingaConfig::module it tries to load values from -// the module's config.ini. For using other files you have to pass this parameter though. -// The following example loads values from the example module's extra.ini: -IcingaConfig::module('example', 'extra')->logging->get('enabled', true); -``` - -## Reload from disk - -If you want to force reading a configuration from disk (i.e. after you modified it), you can use the $fromDisk flag in -the IcingaConfig::app/IcingaConfig::module call: - - IcingaConfig::app('authentication', true)-> ... // read authentication from disk - IcingaConfig::module('example', 'extra', true)->... // read module configuration from disk