NAME

AxKit2::Config - Configuration class

DESCRIPTION

This class is a parser for the configuration files. This document also describes the API for the classes that implement the configuration, which are AxKit2::Config::Global, AxKit2::Config::Server and AxKit2::Config::Location. It's just easier to type AxKit2::Config so we're putting the docs here to be nice :-)

DIRECTIVES

DocumentRoot

ConsolePort

ConsoleAddr

PluginDir

Plugin

<Server> / <Server name>

Port

<Location path>

...

API

$config->docroot( [ STRING ] )

Get/set the DocumentRoot.

$config->console_port( [ NUMBER ] )

Get/set the ConsolePort. See AxKit2::Console.

$config->console_addr( [ STRING ] )

Get/set the ConsoleAddr bind address.

$config->plugin_dir( [ STRING ] )

Get/set the PluginDir (directory to look in for plugins).

$config->notes( KEY [, VALUE] )

Get/set per-config key-value pairs.

CASCADING

Lookup of values cascades from the location to the server to the global config class. So if the docroot isn't set in the <Location> section, the config class will automatically cascade down to the <Server> section to look for the value, and down to the global level if it is still not found.

LOCATION MATCHING

How AxKit2 matches a request to a particular <Location> section is at best described as naive. It simply looks for the last matching location section in the config file. This has consequences that I should document better.