Skip to content

folio-org/edge-oai-pmh

Repository files navigation

edge-oai-pmh

Copyright (C) 2018-2023 The Open Library Foundation

This software is distributed under the terms of the Apache License, Version 2.0. See the file "LICENSE" for more information.

Introduction

Edge API for Metadata Harvesting (OAI-PMH Version 2.0)

Additional information

Schemas

The following schemas used:

Required Permissions

Institutional users should be granted the following permissions in order to use this edge API:

  • oai-pmh.all

Multi-tenant (consortia) harvesting setup

In order to perform harvesting across consortium tenants, central tenant's institutional user should be granted additional permission user-tenants.collection.get. Also, additional system users should be created for each consortia member tenant, with same as central tenant's username and granted oai-pmh.all permission.

Configuration

Please refer to the Configuration section in the edge-common documentation to see all available system properties and their default values. For stable operation, the application requires the following memory configuration. Java: -XX:MetaspaceSize=384m -XX:MaxMetaspaceSize=512m -Xmx1440m. Amazon Container: cpu - 1024, memory - 1512, memoryReservation - 1360.

For example, to enable HTTP compression based on Accept-Encoding header the -Dresponse_compression=true should be specified as VM option.

Issue tracker

See project EDGOAIPMH at the FOLIO issue tracker.

Other documentation

Other modules are described, with further FOLIO Developer documentation at dev.folio.org