wiki:Help/MyConfiguration

Configuration: myconfig.py

This page will describe the variables available to be set in the global configuration file .site-packages/myconfig.py used by Python CGI scripts in ESTEST.

These variables are separated in to sections based on the Python dictionary data structure.

It is NOT recommended that you use the configuration variables labeled advanced unless you really know what you're doing! Intermediate labels indicate a bit of know-how is needed.

google (intermediate)

google={}
google["api_key"] = "xxxxxxxxxxxxxxxxxxxxxxxxxxx"
  • google["api_key"] - Google API Key

See https://code.google.com/apis/console

ldap (advanced)

ldap={}
ldap["url"]="ldap://localhost:1389"
ldap["admin_name"]="Directory Manager"
ldap["admin_pass"]="SECRET"
ldap["base_dn"]="dc=cantabile,dc=ucdavis,dc=edu"
ldap["users_dn"]="ou=Users,o=cantabile,dc=cantabile,dc=ucdavis,dc=edu"
  • ldap["url"]="ldap://localhost:1389" - The LDAP server address
  • ldap["admin_name"] - The LDAP directory manager user name
  • ldap["admin_pass"] - The LDAP directory manager password
  • ldap["base_dn"] - The base DN for the LDAP directory
  • ldap["users_dn"] - The DN associated with users of the directory

Mendeley (intermediate)

mendeley={}
mendeley["consumer_key"] = "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"
mendeley["consumer_secret"] = "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"
  • mendeley["consumer_key"] - The Mendeley consumer key
  • mendeley["consumer_secret"] - The Mendeley consumer secret

See http://apidocs.mendeley.com/

registration

registration={}
registration["sysadmin_email"]="estest.dev@gmail.com"
registration["subprocess_env"]={"exist_bin_dir":"/home/opt/eXist-1.4.0/bin/"}
registration["signature"]="Team ESTEST"
  • registration["sysadmin_email"] - The email address used to send messages to the users
  • registration["signature"] - A string that is appended to the end of outbound email messages
  • registration["subprocess_env"] - Used to set the environment for Python subprocesses

registration (advanced)

registration["use_gpg_pass"]=True
registration["gpg_recipiant"]="estest.dev@gmail.com"
registration["gpg_tmp_store_dir"]="/home/tmp/43/cache"
  • registration["use_gpg_pass"] - Boolean to use or not GPG encryption to store temporary use registration files
  • registration["gpg_recipiant"] - The GPG user id
  • registration["gpg_tmp_store_dir"] - A directory needed to store temporary registration files, this is needed whether or not GPG encryption is used

server

server = {}
server["url"] = "http://estest.ucdavis.edu
server["exist_prefix"]="/home/opt/eXist-1.4.0"
server["estest_prefix"]="/home/estest"
server["default_mask"]="754"
  • server["url"] - The domain address of the ESTEST server
  • server["exist_prefix"] - The prefix installation directory for eXist-db
  • server["estest_prefix"] - The prefix installation directory for ESTEST
  • server["default_mask"] - The default permissions mask for documents on this server given in octal.

upload

upload={}
upload["max_size"]="10.0"
  • upload["max_size"] - Controls the maximum individual file size accepted for upload to ESTEST based on file sizes after tar decompression. The parameter is given in Megabytes.

xmlrpc

xmlrpc={}
xmlrpc["localhost"]="localhost:8080/exist/xmlrpc"
  • xmlrpc["localhost"] - The URL for the XMLRPC ServerProxy parameter
Last modified 5 years ago Last modified on 06/05/12 12:10:59