source: main/trunk/greenstone2/etc/oai.cfg@ 21718

Last change on this file since 21718 was 21718, checked in by kjdon, 12 years ago

changed resumeafter to 250 by default. Apparently some harvesters can be overwhelmed if all records come at once

  • Property svn:keywords set to Author Date Id Revision
File size: 4.6 KB
Line 
1# OAI Server Configuration
2
3# This is the main configuration file for configuring your Greenstone oai server.
4# The server is a cgi program called oaiserver (oaiserver.exe on Windows).
5# Some basic commands that you can send it are:
6# ....cgi-bin/oaiserver.cgi?verb=Identify
7# ....cgi-bin/oaiserver.cgi?verb=ListSets
8# ....cgi-bin/oaiserver.cgi?verb=ListMetadataFormats
9# ....cgi-bin/oaiserver.cgi?verb=ListIdentifiers&set=xxx (1.1 only)
10# ....cgi-bin/oaiserver.cgi?verb=ListIdentifiers&set=xxx&metadataPrefix=oai_dc (2.0 only)
11# ....cgi-bin/oaiserver.cgi?verb=ListRecords&set=xxx&metadataPrefix=oai_dc
12# ....cgi-bin/oaiserver.cgi?verb=GetRecord&identifier=xxx&metadataPrefix=oai_dc
13
14#The List verbs (ListSets, ListIdentifiers, ListRecords) all return a
15#sequence of items. The 'resumeafter' paramter below indicates how many
16#records to return - if this number is less than the number matching the
17#request, then a resumption token is returned. To use this to get the
18#next set of documents, you need to issue the same request again, with
19#an additional parameter: resumptionToken=xxx
20#For example,
21# ....cgi-bin/oaiserver.cgi?verb=ListRecords&set=demo&metadataPrefix=oai_dc&resumptionToken=gsdloai:demo,,11-
22
23# For more information about the OAI-PMH protocol, see
24# http://www.openarchives.org/
25
26# Strings containing spaces should be enclosed in double quotes ""
27
28#the baseURL used by the oaiserver
29#Example: baseURL "http://your-domain-name/cgi-bin/oaiserver.cgi"
30baseURL "your-own-baseURL-goes-here"
31
32# the base address of gsdl directory
33#Example: baseDocRoot "http://your-domain-name/gsdl"
34baseDocRoot "your-own-base-document-root-goes-here"
35
36# The OAI repository name - human readable
37repositoryName ""
38
39# The central administrative email address for the repository.
40maintainer ""
41
42# Which version of OAI the repository supports, 1.1 or 2.0
43# (The server supports both)
44oaiversion "2.0"
45
46# How many records to output before needing a resumption token
47# A value of -1 will return all records for a request
48resumeafter 250
49
50# Other free text items describing the repository. There is no restriction
51# on the number of items, or item names
52# The format is like the following:
53# oaiinfo "item name" "item value"
54# Examples may include sponsor, purpose, size...
55
56# A list of collections that should be made available to OAI clients. By
57# default, collections are not available.
58# There can be more than one line: each line must start with oaicollection,
59# and this is followed by one or more collection names. The collection name
60# is the name of the collection's folder in the collect directory.
61oaicollection demo oai-e
62
63# Optional, set name and description for each collection
64# collname is the same collection name as in the above oaicollection line
65# The format is like the following:
66# oaisetname collname "Name of Collection"
67# oaisetdescription collname "Collection description"
68
69# Metadata mapping information. At present, Greenstone's OAI server
70# supports the following metadata formats.
71# oai_dc (OAI standard for Dublin Core)
72# gsdl_qdc (Greenstone format for Qualified Dublin Core)
73# rfc1807 (OAI standard for RFC 1807 format)
74
75# the list of metadata formats this server should support (Choose from the
76# above list)
77oaimetadata oai_dc gsdl_qdc
78
79# Metadata in other formats must be mapped to these formats. This can be done
80# in this file, or for a particular collection, in its collect.cfg file.
81
82# The format is like
83# oaimapping <greenstone fieldname> <metadataPrefix.fieldname>
84
85# The Greenstone field names can be unqualified (Title, Subject) or
86# qualified by a namespace (dc.Title, dls.Subject). These mapping rules
87# will apply to the entire repository. Collection specific rules can also
88# be specified in this file using a collection name qualifier. This is
89# the collection name followed by a colon (demo:Title, demo:dls.Title).
90# Mappings specified in a collect.cfg file do not need the collection
91# qualifier.
92
93# Details about the Dublin Core metadata format can be found at
94# http://dublincore.org/
95# Elements include Title, Creator, Subject, Description, Publisher,
96# Contributor, Date, Type, Format, Identifier, Source, Language,
97# Relation, Coverage, Rights
98
99# mappings for the dls metadata set
100# for dublin core (oai_dc metadata prefix)
101oaimapping dls.Title oai_dc.title
102oaimapping dls.Subject oai_dc.subject
103oaimapping dls.Language oai_dc.language
104oaimapping dls.Organization oai_dc.publisher
105# for qualified dublin core (gsdl_qdc metadata prefix)
106oaimapping dls.Title gsdl_qdc.title
107oaimapping dls.Subject gsdl_qdc.subject
108oaimapping dls.Language gsdl_qdc.language
109oaimapping dls.Organization gsdl_qdc.publisher
110
111
Note: See TracBrowser for help on using the repository browser.