NAME

Mojolicious::Plugin::JsonConfig - JSON Configuration Plugin

SYNOPSIS

  # myapp.json
  {
    "foo"       : "bar",
    "music_dir" : "<%= app->home->rel_dir('music') %>"
  }

  # Mojolicious
  my $config = $self->plugin('json_config');

  # Mojolicious::Lite
  my $config = plugin 'json_config';

  # Reads myapp.json by default and puts the parsed version into the stash
  my $config = $self->stash('config');

  # Everything can be customized with options
  my $config = plugin json_config => {
    file      => '/etc/myapp.conf',
    stash_key => 'conf'
  };

DESCRIPTION

Mojolicous::Plugin::JsonConfig is a JSON configuration plugin that preprocesses it's input with Mojo::Template.

The application object can be accessed via $app or the app helper. You can extend the normal config file myapp.json with mode specific ones like myapp.$mode.json.

OPTIONS

default

  # Mojolicious::Lite
  plugin json_config => {default => {foo => 'bar'}};

Default configuration.

ext

  # Mojolicious::Lite
  plugin json_config => {ext => 'conf'};

File extension of config file, defaults to json.

file

  # Mojolicious::Lite
  plugin json_config => {file => 'myapp.conf'};
  plugin json_config => {file => '/etc/foo.json'};

Configuration file, defaults to the value of MOJO_JSON_CONFIG or myapp.json in the application home directory.

stash_key

  # Mojolicious::Lite
  plugin json_config => {stash_key => 'conf'};

Configuration stash key.

template

  # Mojolicious::Lite
  plugin json_config => {template => {line_start => '.'}};

Template options.

METHODS

Mojolicious::Plugin::JsonConfig inherits all methods from Mojolicious::Plugin and implements the following new ones.

register

  $plugin->register;

Register plugin in Mojolicious application.

SEE ALSO

Mojolicious, Mojolicious::Guides, http://mojolicio.us.