Catalyst::Plugin::ConfigLoader::Manual - Guide to using the ConfigLoader plugin
package MyApp;
use Catalyst qw( ConfigLoader ... );
MYAPP_CONFIG - specific config file to load for "MyApp"CATALYST_CONFIG_LOCAL_SUFFIX - global suffix for extra config filesMYAPP_CONFIG_LOCAL_SUFFIX - suffix specifically for "MyApp" name = TestApp
<Component Controller::Foo>
foo bar
</Component>
<Model Baz>
qux xyzzy
</Model>
name=TestApp
[Controller::Foo]
foo=bar
[Model::Baz]
qux=xyzzy
{
"name": "TestApp",
"Controller::Foo": {
"foo": "bar"
},
"Model::Baz": {
"qux": "xyzzy"
}
}
{
name => 'TestApp',
'Controller::Foo' => {
foo => 'bar'
},
'Model::Baz' => {
qux => 'xyzzy'
}
}
<config>
<name>TestApp</name>
<component name="Controller::Foo">
<foo>bar</foo>
</component>
<model name="Baz">
<qux>xyzzy</qux>
</model>
</config>
---
name: TestApp
Controller::Foo:
foo: bar
Model::Baz:
qux: xyzzy
Model::MyModel:
schema_class: MyApp::MySchema
connect_info:
- dbi:SQLite:myapp.db
- ''
- ''
- AutoCommit: 1
As of Catalyst::Devel 1.07, a newly created application will use Config::General for configuration. If you wish to convert your existing config, run the following one-liner (replacing MyApp with your app's name):
perl -Ilib -MMyApp -MConfig::General -e 'Config::General->new->save_file("myapp.conf", MyApp->config);'
If you have UTF-8 strings in your Config::General-based config file, you should add the following config information to MyApp.pm:
__PACKAGE__->config( 'Plugin::ConfigLoader' => {
driver => {
'General' => { -UTF8 => 1 },
}
} );
When ConfigLoader reads configurations, it starts by reading the configuration file for myapp with one of the supported extensions as listed above.
For example, A Config::General config file is myapp.conf.
If a configuration file called myapp_local exists with one of the supported file extensions, it will also be read, and values from that file will override values from the main config file.
A Config::General local configuration file would be called myapp_local.conf.
The local suffix can be changed. See "get_config_local_suffix" in Catalyst::Plugin::ConfigLoader for the details of how.
This is useful because it allows different people or environments to have different configuration files. A project with three developers, Tom, Dick, and Harry as well as a production environment can have a myapp_tom.conf, a myapp_dick.conf, a myapp_harry.conf, and a myapp_production.conf.
Each developer, and the web server, would set the environment variable to load their proper configuration file. All of the configurations can be stored properly in source control.
If there is no myapp.local, and the individual configuration files contain something required to start the application, such as the Model's data source definition, the applicaton won't start unless the environment variable is set properly.
