model¶

Top class required to configure this application. Optional. Type reference.

synopsis¶

one line description of the application. Optional. Type uniline.

link_to_doc¶

Documentation URL. Optional. Type uniline.

category¶

Can be "system", "user" or "application" Mandatory. Type enum. choice: 'system', 'user', 'application'.

Here are some explanations on the possible values:

'application'

Configuration file is located anywhere and is usually explicitly specified to application. E.g. "multistrap -f CONFIG_FILE"

'system'

Configuration file is owned by root and usually located in "/etc"

'user'

Configuration files is owned by user and usually located in "~/.*"

allow_config_file_override¶

Set if user can override the configuration file loaded by default by cme. Optional. Type boolean.

upstream_default value :

0

require_config_file¶

set when there's no default path for the configuration file.user will have to specify a configuration file with "--file" option. Optional. Type boolean.

upstream_default value :

0

require_backend_argument¶

set when the application backend requires an argument passed as 3rd argument to cme, e.g. cme <cmd> <app> <backend_arg>. Optional. Type boolean.

upstream_default value :

0

use_backend_argument_as_config_file¶

When backend argument is also used as the name of the config file. Optional. Type boolean.

upstream_default value :

0

backend_argument_info¶

Short description of the backend argument. Used to generate error message when user forgets to set the 3rd cme argument. Optional. Type uniline.

config_dir¶

set configuration directory where config file is read from or written to. This value does not override a directory specified in the model. Optional. Type uniline.

support_info¶

Instructions to let user report a bug for this application. This URL is shown in the message of unknown element exception in the string "please submit a bug report $support_info". Defaults to an url to Config::Model bug tracker. Optional. Type uniline.

upstream_default value :

to https://github.com/dod38fr/config-model/issues