Skip to content

Configuration file

This is the default configuration file for plugin template: listener

###################################
#####                         #####
#####     GENERAL SECTION     #####
#####                         #####
###################################
# (plugin metadatas)
[general]

# Notes about the name of the plugin:
# - the name of the plugin is given by the content of .layerapi2_label
#   in this directory (format: plugin_{name of the plugin}@mfdata)
# - the old "name" key in this file is not used anymore

# Version of the plugin (X.Y.Z)
# If the value is {{MFMODULE_VERSION}},
# the current module version is used
_version={{MFMODULE_VERSION}}

# Release of the plugin
_release=1

# Summary (one line) of the goal of the plugin
_summary=one line summary about your plugin

# License of the plugin
_license=Proprietary

# URL of the plugin homepage
_url=http://yourpluginhomepage

# Name of the maintainer of the plugin on the form "Firstname FAMILYNAME <email>"
_maintainer=Firstname FAMILYNAME <email>

# Vendor of the plugin
_vendor=MetWork

[extra_daemon_listener]
_cmd_and_args = listener.py
numprocesses = 1

####################################################################
#####                                                          #####
#####         SWITCH RULES FRAGMENT (FOR THIS PLUGIN)          #####
#####   (only if you use the default system switch plugin)     #####
#####                                                          #####
####################################################################
#
# You can have several "rules blocks":
#   [switch_rules:{rule_type}:{rule_param1,rule_param2}]
#
# Each "rules block" define a rule type and some rule parameters.
# Under a "rules block" you can have one or several "switch rules".
#
# A "switch rule" is a line like:
#   pattern = plugin_name1/step_name1, plugin_name2/step_name2*
#
# So, for a given pattern, you can have one or several copy actions (separated
# by coma). Each action means copy (or hardlink) the incoming file to the
# given plugin/step.
#
# (if a step name ends with a "*", it means that we can use hardlinking instead
#  of copying => it's better for performances but target step must not alter
#  the incoming file in any way so please DO NOT ADD THE STAR SIGN IF YOU ARE
#  NOT SURE)
#
# All "switch rules" are evaluated in the context of their "rule block". If
# the pattern match (in this context), collected actions are APPENDED.
#
# See FIXME for plenty details and examples.

# Example: copy all incoming files with original_basename starting with A to
#          the current plugin in "main" step
# [switch_rules:fnmatch:first.core.original_basename]
# A* = main

# Example: copy all incoming files to the current plugin in "main" step
# [switch_rules:alwaystrue]
# * = main

# Example: copy all incoming files from the foo dirname to the current plugin
# in "main" step
# [switch_rules:equal:first.core.original_dirname]
# foo = main

# Example: for complex routing rules, you can use a python function
#          (here: my_function() in foo.py under the plugin root)
# [switch_rules:python]
# foo.my_function = main
#

[custom]
# Here is a space for your public configuration keys
#   (ie. overridable by administrator after deployment)
# Your keys shouldn't start with an underscore (as they are public)
#   and you have to read their value through the corresponding env variable
#   and NOT by parsing this file
# A key named "foo_bar" here will generate (in plugin_env) an env var called
# MFDATA_CURRENT_PLUGIN_CUSTOM_FOO_BAR
# (MFDATA_CURRENT_PLUGIN_CUSTOM_{YOUR KEY IN UPPERCASE})
# with the corresponding value inside