Changes between Version 6 and Version 7 of FeddSkelPlugin

Timestamp:

Jun 27, 2010 11:02:38 AM (14 years ago)

Author:

faber

Comment:

--

FeddSkelPlugin

@@ -42 +42 @@
 The [attachment:skel.conf] file contains three sections, each set off by a section name in braces, e.g., {{{[access]}}}.  We will explain this file section by section.
 
-=== DEFAULT ===
+=== [DEFAULT] ===
 
 The first section, {{{[DEFAULT]}}} contains parameters that will be expanded in later sections.  The {{{base}}} parameter will be used in other pathnames, to avoid having to hard code each full pathname.  In later sections,the {{{%(base)s}}} construction will expand to the contents of the {{{base}}}} parameter.  This is a standard construction in a configuration file parsed by python's [http://docs.python.org/library/configparser.html ConfigParser] module.  The value inside the {{{%()}}} is the variable to expand, which is followed by a single character for formatting.  More information about these conventions is [http://docs.python.org/library/configparser.html available].
 
-=== access ===
+=== [access] ===
 
-The {{{[access]}}} section contains most of the plug-in configuration information.
+The {{{[access]}}} section contains most of the plug-in configuration information.  Field by field:
+
+ '''project_priority: false'''::
+  This means that if two [FeddAbout#GlobalIdentifiers:Three-levelNames three level names] match for the current request, give priority to the user match rather than the project match.  Practically this has little effect on the skeleton.
+ '''log_level: debug'''::
+  Log messages at or above log.DEBUG level will be printed to stderr or a log file.
+ '''access_state: %(base)s/skel_access.state'''::
+  The persistent state of the plug-in will be stored in this file (skel_access.state in the base directory).  The plug-in will create this file if it is not there and state needs to be stored.
+ '''accessdb: %(base)s/skel_access'''::
+  The access database is in skel_access in the base directory.  We will discuss the contents of that file below.
+ '''certdir: %(base)s/certs'''::
+  This directory is used to store transient certificates.  It should be readable only by the federation user.
+ '''userconfdir: %(base)s/userconf'''::
+  Used to store information about exported user configurations.  Again, it should be readable only by the federation user.
+ '''maxint: 3'''::
+  The maximum integer that the skeleton will allocate is 3.  This is not inclusive, so the skeleton will actually allocate from {0,1,2,}.
+
+A line of the form '''create_debug: true''' is commented out.  When true, that parameter generally means that the plug-in will not make allocations when requests come in.  Because the skeleton only manipulates its internal state, the parameter is not used.
+
+There are other common attributes in this section that are left as defaults in the example file, and [FeddConfig#AccessOptions defined elsewhere].
+
+=== [globals] ===
+
+The two or three parameters in this section control overall operation of the plug-in, specifically what prinicpal ID (that is which [FeddAbout#GlobalIdentifiers:Fedids fedid]) it uses and what TCP port it provides services on.  '''cert_file''' and '''cert_pwd''' select the X.509 certificate and encyrption password, if any, used to identify the plug-in.  The '''services''' parameter controls which ports and transports are used.  The sample file serves SOAP traffic on port 13230. [FeddConfig#GlobalOptions Other choices] are possible.
+
+
+
+
+