source: TI01-discovery/trunk/OAIInfoEditor/README.txt @ 5466

Subversion URL: http://proj.badc.rl.ac.uk/svn/ndg/TI01-discovery/trunk/OAIInfoEditor/README.txt@5466
Revision 5466, 3.2 KB checked in by cbyrom, 10 years ago (diff)

Add to code to allow the OAI editor to be used with the new openid
based security system. Add the policy file and secured ini file +
adjust handling of users - enforcing page access via URL content

  • basically either by provider ID or via 'admin=1' parameter for

admin users. For the latter, provider security_redirector module to
allow admin users to use same point of entry as normal users.

Line 
1Prerequisites
2==================
3The following should be installed to run the OAI Info 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. OAIBatch - see http://proj.badc.rl.ac.uk/ndg/browser/TI01-discovery/branches/ingestAutomation-upgrade [or main trunk when things have been properly merged]
85. ndgCommon - see http://proj.badc.rl.ac.uk/ndg/browser/ndgCommon
9
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.
12
13Installation and Setup
14======================
15Once the prereqs are installed and the codebase is extracted to a local:
16
17i) Adjust the content of the config files in oai_info_editor directory as follows:
18
19development.ini
20- adjust the host and port settings appropriately
21- turn debug on/off
22- adjust logging level of server output (adjust the logger_root settings)
23
24editor.config
25adjust:
26
27[SERVERS]
28- server - NB, this should match the host and port settings in the development.ini file
29- mailserver - SMTP server for sending mails
30- proxyServer - proxy server to use, if required
31
32[DATA_STORE]
33- appDataFileName - name of the data file used to store the provider info in - NB, this
34is suffixed with '_provider_info_data.xml'
35- appDataFileDir - the directory, relative to the run directory, to store the
36change history data and any parser data files
37- backupFileDir - the directory, relative to the run directory, to store backups of
38the data files in the appDataFileDir
39- harvestDir - the directory to harvest OAI documents to
40
41 
42ii) Add a config file for the postgres DB used by the discovery service; this is required
43when documents are harvested via the editor - since once the harvest is complete, the
44data is automatically ingested into the discovery service.  The file should be in
45the oai_info_editor directory and be called, 'ingest.config'.  The contents should
46be of the format:
47
48databaseName hostName userName password portNumber
49
50(NB, portNumber is optional)
51
52iii) From the oai_info_editor directory, run:
53
54paster serve --reload development.ini
55
56
57Using the Editor
58------------------
59A help guide is available from the web app - click on the link, 'help' for detailed
60instructions on how to use.
61
62
63Tests
64------------
65A suite of unit tests is available under oai_info_editor/tests - the file, nostTests.py,
66in this directory, can be used to discover and run all the tests via the python nose module -
67just run it as a python app.
68
69
70 Further Notes
71-----------------
72i) The editor uses the OAIBatch codebase to do the ingest - using the same
73script, oai_document_ingester, that is used by the discovery service
74ii) NB, this work replaces the use of the jOAI harvester web app.  Although the jOAI codebase has
75an exposed java API to complete harvesting (which is used by this editor), in a consistent manner
76to the web app, it doesn't have any public API to curate the data contained by the web app.  Since
77the only additional functionality offered by the jOAI system was increased logging, and since this
78wasn't being used anyway, it was considered simpler just to write a new system to allow
79curation of provider info.
Note: See TracBrowser for help on using the repository browser.