About Features Downloads Getting Started Documentation Events Support GitHub

Site Tools

Warning: This page has not been updated in over over a year and may be outdated or deprecated.

DSpace: Enabling OAI-PMH

These instructions were shared by the Naval Postgraduate School in Monterey, California.

:!: Newer releases of DSpace have OAI-PMH enabled by default, so these steps should not be needed. They are retained only for historical reasons (and in case there is still an instance of DSpace 3.x or earlier than needs to be harvested).

OAI must be enabled on the DSpace repository before you can index DSpace records into VuFind:

  1. Modify the DSpace server config in nginx.conf on the DSpace server:
    Location /oai/ {
        Proxy_set_header X-Forwarded-Host $host;
        Proxy_set_header X-Forwarded-Server $host;
        Proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
        Proxy_pass http://yourdspacehostname:8080/oai/;
        Proxy_redirect http://yourdspacehostname:8080/oai/  http://yourdspacehostname/oai;
        Proxy_buffering off;
        Proxy_store off;
        Proxy_connect_timeout 120;
        Proxy_send_timeout 120;
        Proxy_read_timeout 120;

    Comparable configuration in Apache makes use of mod_proxy. Note that the proxy configuration is only necessary if you are unable to open port 8080 to your VuFind instance. If you are not limited by such restrictions, feel free to use your full DSpace hostname appended with “:8080” and skip the above proxy configuration.

  2. Modify the server.xml for the appropriate DSpace Tomcat instance in the HOST block:
    <Context path="/oai" docBase="/path_to_dspace/webapps/oai" debug="0"
        Reloadable="true" cachingAllowed="false"
        allowLinking="true" />
  3. Modify the dspace.conf config file for the appropriate DSpace instance:
    harvest.includerestricted.oai = true
    harvester.autoStart = true
indexing/dspace/enable_oai.txt · Last modified: 2020/09/21 13:55 by demiankatz