source: TI03-DataExtractor/trunk/pydxc/clientConfig.py @ 1184

Subversion URL: http://proj.badc.rl.ac.uk/svn/ndg/TI03-DataExtractor/trunk/pydxc/clientConfig.py@1184
Revision 1184, 6.5 KB checked in by astephen, 14 years ago (diff)

Safe version pre-security installation and zsi versioning.

Line 
1#   Copyright (C) 2004 CCLRC & NERC( Natural Environment Research Council ).
2#   This software may be distributed under the terms of the
3#   Q Public License, version 1.0 or later. http://ndg.nerc.ac.uk/public_docs/QPublic_license.txt
4
5"""
6clientConfig.py
7=============
8
9Holds the main configuration details that must be set up in order
10for a version of the package to run on a new machine.
11
12Each option below is documented to guide the user through setting
13up the interface.
14
15All these global variables are used in various parts of the
16package. For consistency they are all CAPITALISED.
17
18"""
19
20# Import python modules
21import os   # used to combine paths in variables below
22
23# DEBUG:
24# Set to 1 if you want to be in DEBUG mode. This reports CGI errors
25# directly to the browser.
26DEBUG=0
27
28# CALL_METHOD
29# Method used for client to communicate with the server.
30# Either "WS" for Web Service or "Local" for local machine.
31CALL_METHOD="WS"
32
33# SECURITY_MODEL:
34# The name of the security model being used. The standard
35# ***and insecure (until you have implemented your local hooks)***
36# version is "basic". NERC DataGrid is "ndg".
37SECURITY_MODEL="basic"
38
39# RESTRICTED_DATA:
40# Do you want security on (1) or off (0)?
41# Note that there is no in-built security implementation in
42# dx, just a set of hooks under which your security system
43# can be called.
44RESTRICTED_DATA=1
45
46# PACKAGE_NAME:
47# This will appear as the main title displayed
48# on the web interface.
49PACKAGE_NAME="Data Extractor"
50
51# LOCAL_RULES:
52# Do you want local rules switched on or off (1 or 0)?
53# This will apply to any parts of the code where local
54# modifications have been made and wrapped in an if clause.
55LOCAL_RULES=0
56
57# REGISTRATION_PAGE:
58# For restricted datasets, this is the web page from which users
59# can find registration details.
60REGISTRATION_PAGE="http://yourhost/your_link.html"
61
62# ADMIN_MAIL_ADDRESS:
63# The e-mail address of the adminstrator for this version. 
64ADMIN_MAIL_ADDRESS="yourmail@yourhost"
65
66# LOCAL_MAIL_HOST:
67# The outgoing mail box address for the host machine.
68# On many systems you can just use "localhost".
69LOCAL_MAIL_HOST="youroutbox.yourdomain"
70
71# ADMIN_NOTIFICATION:
72# Set this to 1 if you want to be notified by e-mail when an error has
73# occurred.
74ADMIN_NOTIFICATION=0
75
76# SOAP_SERVER_URL:
77# URL to Web Service of the form: "http://<host>:<port>/<script>
78SOAP_SERVER_URL="http://localhost:8406/DXController.py"
79
80# LOCAL_SERVER_PACKAGE
81# Local path to Server Package if callable locally
82LOCAL_SERVER_PACKAGE="/home/as56/abstractWebService/dxs"
83
84# MAX_NUM_DATASETS:
85# A kind of fake maximum number of datasets
86# to make the CGI client behave sensibly.
87MAX_NUM_DATASETS=2
88
89# REQUEST_XML_DIR_LOCAL_PATH:
90# Directory for request document uploads and downloads on the local machine.
91# Probably a temporary store. This directory needs to be visible from the
92# webserver (e.g. /srv/www/htdocs/dx/request_xmls).
93REQUEST_XML_DIR_LOCAL_PATH="/home/as56/apache/htdocs/request_xmls"
94
95# REQUEST_XML_DIR_URL_PATH:
96# The URL address of the REQUEST_XML_DIR_LOCAL_PATH
97REQUEST_XML_DIR_URL_PATH="http://localhost/request_xmls"
98
99# STATIC_WEBSERVER_URL_PATH
100# HTTP location of the webserver
101STATIC_WEBSERVER_URL_PATH="http://localhost"
102
103# STATIC_WEBSERVER_LOCAL_PATH
104# Location on the local machine of the webserver top level directory,
105# i.e. the htdocs directory.
106STATIC_WEBSERVER_LOCAL_PATH="/home/as56/apache/htdocs"
107
108# WEB_EXTRAS_URL_PATH:
109# HTTP location of the web extras directory.
110WEB_EXTRAS_URL_PATH=os.path.join(STATIC_WEBSERVER_URL_PATH, "dx_extras")
111
112# WEB_EXTRAS_LOCAL_PATH:
113# Local location of the web extras directory.
114WEB_EXTRAS_LOCAL_PATH=os.path.join(STATIC_WEBSERVER_LOCAL_PATH, "dx_extras")
115
116# CGI_SCRIPT_URL_PATH:
117# The full path of the main CGI script on your system.
118# "http://yourdomain/cgi-bin/dxui" is the most likely but
119# you are free to rename the files if you wish.
120CGI_SCRIPT_URL_PATH=os.path.join(STATIC_WEBSERVER_URL_PATH, "cgi-bin/dxui")
121
122# CGI_SCRIPT_LOCAL_PATH:
123# The local path of the CGI script on your system.
124# "/srv/www/cgi-bin/apwsui.py" is likely on a SUSE system but
125# you are free to rename this as you wish.
126CGI_SCRIPT_LOCAL_PATH="/home/as56/apache/cgi-bin/dxui"
127
128# TOKEN_VALID_LIFETIME:
129# Period before security token (cookie) should expire (in seconds)
130TOKEN_VALID_LIFETIME=60*60*8   # 8 hours
131
132# COOKIE_NAME:
133# Name of cookie to hold security information and user roles.
134COOKIE_NAME="dx_cookie"
135
136# TOKEN_DOMAIN:
137# The domain that should be written in the secure token (cookie).
138TOKEN_DOMAIN="localhost"
139
140# BASEDIR:
141# Full path to the main client package location.
142# "/usr/local/dxc" is recommended but you can change it as
143# you wish.
144BASEDIR="/home/as56/abstractWebService/dxc"
145
146# OUTPUT_DIR_LOCAL_PATH
147# The full path on the local machine of the output directory.
148OUTPUT_DIR_LOCAL_PATH=os.path.join(STATIC_WEBSERVER_LOCAL_PATH, "output")
149
150# OUTPUT_DIR_URL_PATH:
151# The URL address of the OUTPUT_DIR_LOCAL_PATH
152OUTPUT_DIR_URL_PATH=os.path.join(STATIC_WEBSERVER_URL_PATH, "output")
153
154# HTML_DIR_LOCAL_PATH:
155# Location of the HTML header and footer files in the package
156HTML_DIR_LOCAL_PATH=os.path.join(BASEDIR, "html")
157
158# LOGO_DIR:
159# Location of logos for the header section, this should be a
160# full or relative URL and NOT a directory path on your machine.
161LOGO_DIR=os.path.join(STATIC_WEBSERVER_URL_PATH, "dx_extras/logos")
162
163# LEFT_LOGO:
164# Name of logo file for left hand side of header.
165LEFT_LOGO="dx_logo.jpg"
166
167# RIGHT_LOGO:
168# Name of logo file for right hand side of header.
169RIGHT_LOGO="dx_logo.jpg"
170
171# MESSAGE_TO_USERS:
172# A message that will be written at the top of all web pages underneath
173# the main header.
174MESSAGE_TO_USERS="""This is a test version of the %s so it may contain bugs.
175Please contact <A HREF="mailto:%s">%s</A> if an
176error occurs so that we can improve this
177service.""" % (PACKAGE_NAME, ADMIN_MAIL_ADDRESS, ADMIN_MAIL_ADDRESS)
178
179# GEOSPLAT_URL_PATH:
180# The URL of the Visualisor package that the dx connects to
181# once files have been produced.
182GEOSPLAT_URL_PATH="/cgi-bin/splatui"
183
184# CONFIRMATION_PAGE:
185# Should the CGI interface include a confirmation page?
186# 1 for yes and 0 for no.
187CONFIRMATION_PAGE=1
188
189# MAP_APPLET_TEMPLATE_URL_PATH:
190# URL of map applet HTML template page
191MAP_APPLET_TEMPLATE_URL_PATH=os.path.join(WEB_EXTRAS_URL_PATH, "maps/map_template.html")
192
193# MAP_APPLET_TEMPLATE_LOCAL_PATH:
194# Local path to map applet HTML template page
195MAP_APPLET_TEMPLATE_LOCAL_PATH=os.path.join(WEB_EXTRAS_LOCAL_PATH, "maps/map_template.html")
Note: See TracBrowser for help on using the repository browser.