root/main/trunk/greenstone2/etc/oai.cfg @ 24517

Revision 24517, 7.1 KB (checked in by ak19, 8 years ago)

John Rose's improvement to the comment explaining when to set the base URL.

  • Property svn:keywords set to Author Date Id Revision
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 base URL of the web server. Will be automatically generated by the
29# oaiserver program if not specified here, but may use 'xxx.xxx.xxx.xxx'
30# IP address, but NOT a human-readable domain name like 'www.mylibrary.com'.
31# If you edit this, it must include the port number if not using port 80.
32#baseServerURL "http://your-domain-name:port"
33
34# the relative base path of the oaiserver.cgi
35oaiserverPath "/greenstone/cgi-bin/oaiserver.cgi"
36
37# the relative base path of the Greenstone library.cgi
38libraryPath "/greenstone/cgi-bin/library.cgi"
39
40# the relative base document root
41docRootPath "/greenstone"
42
43# The OAI repository name - human readable
44repositoryName ""
45
46# The OAI repository domain name or unique identifier - used for generating
47# the document identifiers, which will be like:
48# oai:reposId:coll:oid
49repositoryId ""
50
51# version is which oai id scheme is used for ids. Can be 1.1 or 2.0.
52# 1.1 uses a unique id, while 2.0 uses a domain name
53repositoryIdVersion "1.1"
54
55# The central administrative email address for the repository.
56maintainer  ""
57
58# Which version of OAI the repository supports, 1.1 or 2.0
59# (The server supports both)
60oaiversion "2.0"
61
62# How many records to output before needing a resumption token
63# A value of -1 will return all records for a request
64resumeafter  250
65
66# Other free text items describing the repository. There is no restriction
67# on the number of items, or item names
68# The format is like the following:
69# oaiinfo "item name" "item value"
70# Examples may include sponsor, purpose, size...
71
72# A list of collections that should be made available to OAI clients. By
73# default, collections are not available.
74# There can be more than one line: each line must start with oaicollection,
75# and this is followed by one or more collection names. The collection name
76# is the name of the collection's folder in the collect directory.
77oaicollection demo documented-examples/oai-e
78
79# Optional, set name and description for each collection
80# collname is the same collection name as in the above oaicollection line
81# The format is like the following:
82# oaisetname collname "Name of Collection"
83# oaisetdescription collname "Collection description"
84
85# Set name and description can also be added for classifiers. Specify this like
86# oaisetname demo:CL1 "Titles set for Demo collection"
87
88# These can also be specified in a collection's collect.cfg. The collection
89# name is not needed, so lines will look like
90# oaisetname "demo collection"
91# oaisetname CL1 "Titles set for demo collection"
92
93# Metadata mapping information. At present, Greenstone's OAI server
94# supports the following metadata formats.
95# oai_dc (OAI standard for Dublin Core)
96# gsdl_qdc (Greenstone format for Qualified Dublin Core)
97# rfc1807 (OAI standard for RFC 1807 format)
98
99# the list of metadata formats this server should support (Choose from the
100# above list)
101oaimetadata oai_dc gsdl_qdc
102
103#### Metadata Mapping Rules ####
104################################
105
106# Metadata in other formats must be mapped to the formats specified above.
107# This can be done in this file, or, for a particular collection, in its
108# collect.cfg file.
109
110# The format is like
111# oaimapping <greenstone fieldname> <metadataPrefix.fieldname>
112
113# The Greenstone field names can be unqualified (Title, Subject) or
114# qualified by a namespace (dc.Title, dls.Subject). Capitalization must match
115# that used by Greenstone.
116# OAI field names must start with the metadataPrefix name (e.g. oai_dc.) and
117# capitalization must match that used by the appropriate schema. Valid elements
118# for each schema are listed below. Only valid elements will be included in
119# the output
120
121# OAI Dublin Core metadata schema:
122# http://www.openarchives.org/OAI/2.0/oai_dc.xsd
123# metadataPrefix: oai_dc
124# Valid elements:
125# contributor coverage creator date description format identifier language
126# publisher relation rights source subject title type
127
128# Greenstone's OAI Qualified Dublin Core metadata schema:
129# http://www.greenstone.org/namespace/gsdl_qdc/1.0/gsdl_qdc.xsd
130# metadataPrefix: gsdl_qdc
131# Valid elements:
132# title creator subject description publisher contributor date type format
133# identifier source language relation coverage rights alternative
134# tableOfContents abstract created valid available issued modified
135# dateAccepted dateCopyrighted dateSubmitted extent medium isVersionOf
136# hasVersion isReplacedBy replaces isRequiredBy requires isPartOf hasPart
137# isReferencedBy references isFormatOf hasFormat conformsTo spatial
138# temporal audience accrualMethod accrualPeriodicity accrualPolicy
139# instructionalMethod provenance rightsHolder mediator educationLevel
140# accessRights license bibliographicCitation
141
142# OAI RFC 1807 metadata schema
143# http://www.openarchives.org/OAI/1.1/rfc1807.xsd
144# metadataPrefix: rfc1807
145# Valid elements:
146# bib-version id entry organization title type revision withdraw author
147# corp-author contact date pages copyright handle other_access retrieval
148# keyword cr-category period series monitoring funding contract grant
149# language notes abstract
150
151# mappings for the dls metadata set
152# for dublin core (oai_dc metadata prefix)
153oaimapping dls.Title oai_dc.title
154oaimapping dls.Subject oai_dc.subject
155oaimapping dls.Language oai_dc.language
156oaimapping dls.Organization oai_dc.publisher
157# for qualified dublin core (gsdl_qdc metadata prefix)
158oaimapping dls.Title gsdl_qdc.title
159oaimapping dls.Subject gsdl_qdc.subject
160oaimapping dls.Language gsdl_qdc.language
161oaimapping dls.Organization gsdl_qdc.publisher
162
163
164# These mapping rules will apply to the entire repository.
165
166# Collection specific rules can also be specified in this file using a
167# collection name qualifier with the greenstone field name. This is the
168# collection name followed by a colon (demo:Title, demo:dls.Title).
169# oaimapping demo:dls.Title oai_dc.title
170# Mappings specified in a collect.cfg file do not need the collection
171# qualifier.
172
Note: See TracBrowser for help on using the browser.