oai-pmh2/config/config.dist.yml

#
# The default configuration
#
# Copy this file as 'config.yml' and change the settings to your preferences.
# See https://www.openarchives.org/OAI/2.0/openarchivesprotocol.htm for further
# explanation.
#

#
# A human readable name for the repository
#
repositoryName: 'OAI-PMH 2.0 Data Provider'

#
# Email address for contacting the repository owner
#
# This has to be a valid email according to RFC 822 Address Specification.
#
adminEmail: 'admin@example.org'

#
# Database connection details
#
# This has to be a valid data source name (DSN) URL. The scheme is used to
# specify a driver, the user and password in the URL encode user and password
# for the connection, followed by the host and port parts. The path after the
# authority part represents the name of the database (the leading slash is
# removed so add an extra slash to specify an absolute file path for SQLite).
# The placeholder "%BASEDIR%" may be used to represent the application's base
# directory.
# Any optional query parameters are used as additional connection parameters.
# Since the scheme determines the database driver, it also specifies if the PDO
# abstraction ("mariadb", "mssql", "mysql", "oracle", "postgresql", "sqlite")
# or native drivers ("ibm-db2", "mysqli", "oci8", "pgsql", "sqlite3", "sqlsrv")
# should be used to handle the connection. Make sure the corresponding PHP
# extensions are installed.
#
# %DRIVER%://[[%USER%[:%PASSWORD%]@]%HOST%[:%PORT%]]/%DBNAME%[?%OPTIONS%]
#
# Examples:
# database: 'mssql://oaipmh:secret@127.0.0.1/oaipmh'
# database: 'mysql://root@localhost/oai?charset=utf8mb4'
# database: 'pgsql://oaipmh:secret@localhost:5432/oai_data_provider'
# database: 'sqlite3:////opt/oaipmh/database.db'
#
# Run "composer doctrine:initialize-database" after switching to a new DB to
# test the settings and initialize the database!
#
database: 'sqlite3:///%BASEDIR%/data/sqlite3.db'

#
# Memory Limit
#
# This defines the maximum amount of memory the indexing process should use per
# run before it persists changes to the database, flushes it's internal storage
# and starts over with the next batch of records. Higher settings result in
# better performance, but depending on the size of your records even smaller
# values may be needed to prevent running out of memory.
# The value is interpreted as a percentage of the PHP "memory_limit".
#
# [0.2 - 0.8]
#
memoryLimit: 0.5

#
# Metadata formats, namespaces and schemas of your records
#
# The default is 'oai_dc' which is also required by the OAI-PMH specification,
# but technically you can provide any XML based data formats you want. Just add
# another entry with the metadata prefix as key and namespace/schema URIs as
# array values or replace the default entry (although not recommended).
# You do not have to provide every record in each metadata format, but if you
# have the same record in multiple formats, it's highly recommended to use the
# same identifier for all versions of the record.
#
# Run "bin/cli oai:formats:update" after changing metadata prefixes to update
# the database accordingly!
#
metadataPrefix: {
    oai_dc: {
        namespace: 'http://www.openarchives.org/OAI/2.0/oai_dc/',
        schema: 'https://www.openarchives.org/OAI/2.0/oai_dc.xsd'
    }
}

#
# Deleted records policy
#
# This states if and how the repository keeps track of deleted records. You can
# delete records by importing empty records with the same identifiers and
# metadata prefixes. Depending on the deleted records policy those records will
# be either marked as deleted or completely removed from the database.
# "no" - The repository does not provide any information about deletions and
# deleted records are completely removed from the database.
# "persistent" - The repository provides consistent information about deletions
# and placeholders for deleted records are kept in the database.
# "transient" - The repository may provide information about deletions. This is
# handled exactly the same as "persistent", but you are allowed to manually
# prune deleted records from the database (see below).
#
# ["no"|"persistent"|"transient"]
#
# Run "bin/cli oai:records:prune" after changing the deleted records policy to
# "no" to remove all deleted records from the database.
# If your policy is "transient" and you want to clean up deleted records from
# the database anyway, run the command with the "--force" flag.
#
deletedRecords: 'transient'

#
# Maximum number of records to return per request
#
# For larger result sets resumption tokens are provided repeatedly, which
# allow requesting more batches of records until the set is complete.
#
# [1 - 100]
#
maxRecords: 50

#
# Number of seconds a resumption token should be valid
#
# [300 - 86400]
#
tokenValid: 1800 # 30 minutes