From be4bba4d844ba251a7f5898fbe199d998f1ac283 Mon Sep 17 00:00:00 2001 From: Scott Baker Date: Wed, 1 Oct 2008 18:10:12 +0000 Subject: [PATCH] config docs --- docs/Makefile | 3 +-- docs/pythondoc-config.html | 36 ++++++++++++++++++++++++++++++++++++ 2 files changed, 37 insertions(+), 2 deletions(-) create mode 100644 docs/pythondoc-config.html diff --git a/docs/Makefile b/docs/Makefile index 42ddc10e..f67bcd95 100644 --- a/docs/Makefile +++ b/docs/Makefile @@ -1,3 +1,2 @@ doc: - pythondoc.py ../util/cert.py ../util/credential.py ../util/gid.py ../util/rights.py - \ No newline at end of file + pythondoc.py ../util/cert.py ../util/credential.py ../util/gid.py ../util/rights.py ../util/config.py diff --git a/docs/pythondoc-config.html b/docs/pythondoc-config.html new file mode 100644 index 00000000..a7240b24 --- /dev/null +++ b/docs/pythondoc-config.html @@ -0,0 +1,36 @@ + + + + +The config Module + + +

The config Module

Geniwrapper Configuration Info + +This module holds configuration parameters for geniwrapper. There are two +main pieces of information that are used: the database connection and +the PLCAPI connection

get_default_dbinfo() [#]: +
Geniwrapper uses a MYSQL database to store records. This database may be +co-located with the PLC database, or it may be a separate database. The +following parameters define the connection to the database. + +Note that Geniwrapper does not access any of the PLC databases directly via +a mysql connection; All PLC databases are accessed via PLCAPI.
+
get_pl_auth() [#]: +
Geniwrapper uses a PLCAPI connection to perform operations on the registry, +such as creating and deleting slices. This connection requires an account +on the PLC server with full administrator access. + +The Url parameter controls whether the connection uses PLCAPI directly (i.e. +Geniwrapper is located on the same machine as PLC), or uses a XMLRPC connection +to the PLC machine. If you wish to use the API directly, then remove the Url +field from the dictionary.
+

+ -- 2.43.0