Changeset 5198


Ignore:
Timestamp:
15/04/09 16:32:39 (10 years ago)
Author:
cbyrom
Message:

Write README.txt for MILK with basic install and config info +
tidy up config files, removing obsolete data + remove unused help
page + fix proper use of global discovery url to simplify use.

Files:
1 deleted
8 edited

Legend:

Unmodified
Added
Removed
  • MILK/trunk/milk_server/README.txt

    r4466 r5198  
    1 Installing and running milk_server: 
     1Prerequisites 
     2================== 
     3The following should be installed to run the ojims editor: 
     41. Python2.5 - see http://www.python.org/download/ 
     52. Pylons - see http://docs.pythonweb.org/display/pylonsdocs/Installing+Pylons 
     63. Genshi - see http://genshi.edgewall.org/wiki/Download 
     74. FormEncode - see http://www.formencode.org/download.html 
     85. ndgCommon - see http://proj.badc.rl.ac.uk/ndg/browser/ndgCommon 
    29 
    3 Full instructions are available on the ndg wiki - see: 
     10NB, it is easier to setup the prereqs by using easy_install - http://peak.telecommunity.com/DevCenter/EasyInstall 
     11- then you can just run, easy_install pylons, easy_install genshi, etc. 
    412 
    5 http://proj.badc.rl.ac.uk/ndg/wiki/InstallDiscoveryBrowse 
     13Installation and Setup 
     14====================== 
     15Once the prereqs are installed and the codebase is extracted to a local: 
    616 
    7 NB, this refers to the ows_server setting up instructions 
     17i) Copy the development.ini, helpText.config and milk.config files in the top level MILK 
     18directory to the milk_server directory below 
     19ii) Adjust the content of these files as follows: 
    820 
    9 TODO: Add new instructions (if required) for MILK 
     21development.ini 
     22- adjust the host and port settings appropriately 
     23- turn debug on/off 
     24- adjust logging level of server output (adjust the logger_root settings) 
     25 
     26milk.config 
     27adjust: 
     28[DEFAULT] 
     29- server - NB, this should match the host and port settings in the development.ini file 
     30- mailserver - SMTP server to sending mails 
     31- metadataMaintainer - email address to which correction comments will be mailed 
     32- tbrecipient mail address to which trackback comments are sent 
     33- proxyServer - proxy server to use, if required 
     34- debug - for more verbose logging 
     35[SEARCH] 
     36- discoveryURL - url to discovery service; defaults to discovery service on the current stack 
     37 
     38[WMC_CLIENT] 
     39- url - if a WMC client is to be used to retrieve data for visualisation purposes, specify 
     40the url to it here  
     41 
     42[NDG_B_SERVICE] 
     43 - add details of providers and their associated browse services, to be exposed by this  
     44 browse service - format: 'provider ID: hostname' 
     45  
     46[NDG_EXIST] 
     47- add appropriate eXist DB servers and the providers which they serve 
     48- passwordFile - specify password file with content format: 
     49 
     50'db host name' 'user ID' 'password' 
     51 
     52[DISCOVERY] 
     53- discoveryServiceURL - if a different discovery service is to be used from the default  
     54one (defined in ndg.common.src.clients.ws.discovery.discoveryserviceclient) 
     55 
     56[MILK_SERVER] 
     57- configure the MILK stack to provide editor, browse, discovery, or any combination of the 
     58three, services 
     59 
     60helpText.config 
     61Adjust any of the help text contain in the file to suit purpose.  NB, any help text 
     62here is set on the globals object as a new field - e.g. having a line,  
     63' 
     64blah: some help text 
     65' 
     66in this file will set up data on the globals variable so that: 
     67 
     68g.blah will output, 'some help text' when used. 
     69 
     70 
     71iii) From the milk_server directory, run: 
     72 
     73paster serve --reload development.ini 
     74 
     75Further Notes 
     76----------------- 
     77i) The editor uses the browse service under the covers, so if this is enabled, browse 
     78functionality will also be available 
     79ii) Browse links exposed by searches in the discovery service are generated using the 
     80results from the discovery service; if these are invalid, it is likely that the moles 
     81data has not been properly passed along the pipeline from document publication to  
     82ingestion in the discovery service 
     83(NB, for info on how the discovery ingest works, see: 
     84 
     85http://proj.badc.rl.ac.uk/badc/wiki/opman/FeedHarvester and 
     86http://proj.badc.rl.ac.uk/badc/wiki/opman/OAIIngester 
     87 
     88TODO 
     89-------------- 
     90i) The retrieve controller which represents the browse service is very ropey and could do 
     91with a lot of tidying up 
     92ii) The discovery controller which represents the discovery service is very ropey and  
     93could do with a lot of tidying up 
     94iii) Implementation of new security layer; this is being developed by Phil Kershaw and 
     95should sit on top of the MILK stack without any extra modification.  When it is available, 
     96the existing security code should be entirely removed, as it currently is not doing anything. 
     97 
  • MILK/trunk/milk_server/development.ini

    r4599 r5198  
    11# 
    22# milk_server - Pylons development environment configuration 
     3# - see toplevel README.txt file for config instructions 
    34# 
    45# The %(here)s variable will be replaced with the parent directory of this file 
    56# 
    67[DEFAULT] 
    7 debug = true 
    8 email_to = you@yourdomain.com 
    9 smtp_server = localhost 
    10 error_email_from = paste@localhost 
    118 
    129[server:main] 
     
    2825csml_dir = /research/home/spascoe/host/saturn/data/ddc_data/obs 
    2926tmp_dir = %(here)s/data/tmp 
    30 #used for wcs "store": 
    31 publish_dir=%(here)s/milk_server/private/filestore   
     27 
    3228configfile = %(here)s/milk.config 
    3329helpConfigfile = %(here)s/helpText.config 
    34  
    35 # If you'd like to fine-tune the individual locations of the cache data dirs 
    36 # for Myghty, the Cache data, or the Session saves, un-comment the desired 
    37 # settings here: 
    38 #myghty_data_dir = %(here)s/data/templates 
    39 #cache_data_dir = %(here)s/data/cache 
    40 #session_data_dir = %(here)s/data/sessions 
    4130 
    4231# WARNING: *THE LINE BELOW MUST BE UNCOMMENTED ON A PRODUCTION ENVIRONMENT* 
     
    9584qualname = authkit 
    9685 
    97  
    9886[handler_console] 
    9987class = StreamHandler 
  • MILK/trunk/milk_server/helpText.config

    r5175 r5198  
    22# Help text Configuration File 
    33# - help text available in the MILK stack can be specified here 
     4# - see toplevel README.txt file for config instructions 
    45# 
    56 
  • MILK/trunk/milk_server/milk.config

    r5128 r5198  
    11# 
    22# MILK Configuration File 
    3 # At deployment time the only pieces that a user ought to need to customise 
    4 # will be  
    5 #    - the server address 
    6 #    - it might be necessary to customise the location of the layout directory  
    7 #    - the localLink, localImage and localAlt in the [layout] section 
     3# - see toplevel README.txt file for config instructions 
    84# 
    95[DEFAULT] 
     
    117# the following is the server on which this browse/discovery instance runs! 
    128server:         http://localhost:5000 
    13 #server:       http://superglue.badc.rl.ac.uk:8083 
    14 ## This is the proxied server root 
    15 #server: http://superglue.badc.rl.ac.uk/ndg-test 
    169 
    1710# 
     
    4033 
    4134[SEARCH] 
    42 advancedURL:        %(ndgServer)s/discovery 
    4335discoveryURL:       %(ndgServer)s/discovery 
    44 helpURL:            %(ndgServer)s/discovery?help=1 
    45  
    46 [logging] 
    47 debuglog:        discovery.log 
    4836 
    4937[layout] 
    50 ###### user customisable: 
    5138localLink:      %(ndgServer)s/layout/ 
    5239localImage:     %(icondir)sndg_logo_circle.gif 
    5340localAlt:       visit badc 
    54 ###### ought to be the end of the customisations 
    5541ndgLink:        http://ndg.nerc.ac.uk/ 
    5642ndgImage:       %(icondir)sndg_logo_circle.gif 
     
    6955loadingIcon:    %(icondir)sloading.gif 
    7056 
    71 pageLogo:       %(layout)s20050502_albert-park_silhouetted-trees-and-clouds_02_cropped.jpg 
    72  
    73 [HELP] 
    74 helpFile:       %(layout)shelp.html 
    75  
    7657[WMC_CLIENT] 
    7758# specify url for the client; if not specified it will not be possible to view WMS data for  
     
    8061 
    8162[NDG_A_SERVICE] 
    82 badc.nerc.ac.uk: http://glue.badc.rl.ac.uk/cgi-bin/dxui 
    8363icon: %(icondir)splot.png 
    84 #%(icondir)sdata_aservice.png 
    8564icon_alt: A Service 
    86 service_name: A 
    8765icon_title: LINKS to a DATA BROWSE view of this dataset 
    88 instance: datasetURI_%s 
    8966 
    9067[NDG_B_SERVICE] 
     
    10279icon_alt: B Service 
    10380icon_title: Links to a METADATA BROWSE view of this dataset 
    104 service_name: B 
    10581instance: SERVICEHOST/view/URI 
    10682 
     
    124100# 
    125101# NDG Security 
     102# TODO: this security stuff is obsolete and when Phil's new security layer is added 
     103# it should be completely stripped out of the MILK codebase 
    126104# 
    127105 
     
    297275icon: %(icondir)srelated_link.png 
    298276icon_alt: Related 
    299 service_name: Related 
    300277icon_title: Links to a RELATED URL 
    301 instance: uri 
    302278 
    303279[DISCOVERY] 
    304280icon: %(icondir)scatalogue_dservice.png 
    305281icon_alt: Catalogue 
    306 service_name: Catalogue 
    307282default: %(server)s 
    308283formatDefault=DIF 
    309284icon_title: Links to the DISCOVERY RECORD for this dataset 
    310 #standalone: True 
    311285standalone: False 
    312286#NB, if unset, this will default to the discovery service at ndg.badc.rl.ac.uk 
     
    317291# Configure the MILK_SERVER framework here 
    318292# 
    319 editorOn=False 
    320 browseOn=True 
    321 discoveryOn=False 
    322  
    323 # exception_type: whether OGC servers should send a valid ExceptionReport on errors 
    324 #     or use pylon's debugger.  Very useful for debugging OWS controllers.  Default is ogc 
    325 #exception_type: ogc 
    326 #exception_type: pylons 
    327  
     293editorOn=True 
     294browseOn=False 
     295discoveryOn=True 
     296 
  • MILK/trunk/milk_server/milk_server/config/milkMiddleware.py

    r5116 r5198  
    2424        self.globals.htdocs=cf.get('DEFAULT','htdocs',None) 
    2525        self.globals.localLink=cf.get('layout','localLink',None) 
    26         self.globals.localAlt=cf.get('layout','localAlt','Visit Local Site') 
    2726        self.globals.ndgLink=cf.get('layout','ndgLink','http://ndg.nerc.ac.uk') 
    2827        self.globals.ndgImage=cf.get('layout','ndgImage',None) 
     
    3635        self.globals.LeftAlt=cf.get('layout','HdrLeftAlt') 
    3736        self.globals.LeftLogo=cf.get('layout','HdrLeftLogo') 
    38         self.globals.pageLogo="bodcHdr" 
    3937        self.globals.icons_xml=cf.get('layout','Xicon') 
    4038        self.globals.icons_plot=cf.get('layout','plot') 
  • MILK/trunk/milk_server/milk_server/controllers/browse/discovery.py

    r5172 r5198  
    288288    def __advancedPrompt(self,searchConstraints=None): 
    289289        ''' This provides the advanced search input page ''' 
    290         try: 
    291             discoveryURL=self.cf.get('SEARCH','discoveryURL') 
    292             advancedURL=self.cf.get('SEARCH','advancedURL') 
    293         except: 
    294             return 'Error, invalid configuration for search interface' 
    295290        #defaults 
    296291        c.bbox='90.0','-180.0','180.0','-90.0' 
  • MILK/trunk/milk_server/milk_server/templates/browse/advanced.kid

    r5116 r5198  
    4040        <div class="outer"> 
    4141            <div class="inner"> 
    42                 <form action="$c.discoveryURL" name="discoForm" id="discoForm"> 
     42                <form action="$g.discoveryURL" name="discoForm" id="discoForm"> 
    4343                <div class="float-wrap"> 
    4444                    <div id="AdvContent">  
  • ndgCommon/trunk/ndg/common/src/models/ndgObject.py

    r5058 r5198  
    134134        if self.schema!=fmt:  
    135135            qs=('outputSchema',fmt) 
     136 
    136137        self.discoveryURL=self.__buildURL(discoveryBASE,[qs]) 
    137138 
Note: See TracChangeset for help on using the changeset viewer.