Archives/ARCHIVEID/cfg/cfg.d/

EPrints 3 Reference: Directory Structure - Metadata Fields - Repository Configuration - XML Config Files - XML Export Format - EPrints data structure - Core API - Data Objects

This is the main repository configuration directory. Each of these files is a valid perl script and are loaded in alphabetic order. The configuration is stored in a hash reference named $c. For example a simple file might look like this:

# the foo option modifies the number of badgers in the boojum
$c->{foo} = 23;

Although this listing is shown as for the archive's cfg.d directory, it is actually the combined listing of all configuration files under the following cfg.d directories:

1. EPRINTS_PATH/lib/cfg.d/
2. EPRINTS_PATH/flavours/pub_lib/cfg.d/
3. EPRINTS_PATH/lib/defaultcfg_zero/cfg.d/ (which are copied to the repository archive's cfg.d directory on its creation, unless using a specific flavour).
4. EPRINTS_PATH/flavours/pub_lib/defaultcfg/cfg.d/ (which are copied to the repository archive's cfg.d directory on its creation).
5. Generated through epadmin create

• eprints3/archives/ARCHIVEID/cfg/cfg.d
  • 10_core.pl ⁵ - Core configuration for repository archive, such as hostname and port (both for HTTP and HTTPS), host aliases and path it sits on.
  • 20_baseurls.pl ^1,2 - Configuration for how base URLs used by the repository archive.
  • adminemail.pl ⁵ - The admin email address for the repository archive.
  • branding.pl ¹ - Branding for the repository archive.
  • database.pl ⁵ - Configuration for connecting to the database.
  • datasets.pl ¹ - Configuration for bespoke datasets and data objects for the repository archive.
  • document_fields_automatic.pl ¹ - Configuration for automatically setting document fields based on the values of other fields.
  • document_fields_default.pl ¹ - Default initial values for document fields.
  • document_fields.pl ¹ - Non-core field definitions for the document data object.
  • document_upload.pl ¹ - Configuration relating to managing document uploads.
  • document_validate.pl ¹ - Validation of the eprint data object as a whole.
  • dynamic_template.pl ¹ - Legacy configuration for dynamic template of repository archive.
  • email.pl ¹ - Configuration for sending email from the repository archive.
  • eprint_fields_automatic.pl ^2,3 - Configuration for automatically setting eprint fields based on the values of other fields.
  • eprint_fields_common.pl ² - Common (across flavours) non-core fields for the eprint data object.
  • eprint_fields_default.pl ^2,3 - Default initial values for eprint fields.
  • eprint_fields.pl ^2,3 - Non-core field definitions for the eprint data object.
  • eprint_fields_pub.pl ² - Publication flavour fields for the eprint data object.
  • [[eprint_locking.pl] ¹ - Configuration for locking eprint data objects so they can only be edited by one user at once.
  • eprint_render.pl ^2,3 - Configuration for rendering eprint abstract/summary pages.
  • eprint_search_advanced.pl ^2,3 - Configuration for advanced search of eprint data objects.
  • eprint_search_simple.pl ^2,3 - Configuration for simple search of eprint data objects.
  • eprint_search_staff.pl ^2,3 - Configuration for staff search of eprint data objects.
  • eprint_validate.pl ^2,3 - Validation of the eprint data object as a whole.
  • eprint_warnings.pl ^2,3 - Warnings to advise the depositor on potential issues with the eprint (e.g. no uploaded documents).
  • exports.pl ² - Configuration relating to generic aspects of export plugins.
  • field_property_defaults.pl ¹ - Defaults for various attributes for a field specification.
  • field_validate.pl ¹ - General validation of a metadata field.
  • flavour_info.pl ^2,3 - Information about the flavour of the repository archive.
  • indexing.pl ¹ - Configuration for indexing of metadata and document content.
  • issues_search.pl ^2,3 - Configuration for search of eprint issues.
  • languages.pl ¹ - Configuration for languages used by the repository archive.
  • latest_tool.pl ¹ - Configuration for generating listings and feeds of latest eprints in the repository archive.
  • log.pl ¹ - Configuration for logging error/warnung messages for the repository archive.
  • misc.pl ¹ - Miscellaneous configuration settings.
  • oai.pl ^2,3 - Configuration for OAI.
  • paths.pl ¹ - Configuration for filesystem paths for particular parts of the repository archive.
  • plugins.pl ^2,3 - Enabling and configuration of plugins for the repository archive.
  • rdf_license.pl ¹ - Configuration for adding licences to RDF data files.
  • rdf.pl ¹ - Configuration for setting XML namespaces for RDF data files.
  • rdf_triples_bibo.pl ¹ - Configuration for generating Bibo RDF triples for an eprint data object.
  • rdf_triples_eprints.pl ¹ - Configuration for generating EPrints RDF triples for an eprint data object.
  • rdf_triples_formats.pl ¹ - Configuration for generating format RDF triples for an eprint data object.
  • rdf_triples_general.pl ¹ - Configuration for generating general RDF triples.
  • rdf_triples_repository.pl ¹ - Configuration for generating repository RDF triples.
  • rdf_triples_skos.pl ¹ - Configuration for generating SKOS RDF triples for an eprint and subject data objects.
  • rdf_uris.pl ¹ - Configuration for generating RDF URIs.
  • registration.pl ¹ - Configuration for enabling/managing user reegistration for the repository archive.
  • render_paras.pl ² - Function for rendering paragraphs for free-text fields.
  • request_copy.pl ^2,3 - Configuration for "request a copy" of a restricted document.
  • search.pl ¹ - Miscelleanous search configuration not tied to a specific data object or type of search.
  • security.pl ¹ - Functions for securing appropriate access to uploaded documents.
  • session.pl ¹ - Functions for bespoke operations when initiating or closing a session.
  • template_core.pl ¹ - Core trigger for generating dynamic template.
  • template_edit_phrases.pl ¹ - Edit phrases trigger for generating dynamic template.
  • template_legacy.pl ¹ - Legacy trigger for generating dynamic template, as defined in dynamic_template.pl.
  • template_links.pl ¹ - Links trogger for generating dynamic template.
  • user_auth_limits.pl ¹ - Configuration for limiting aspects of user authentication to prevent brute force password cracking, denial-of-service, user spamming, etc.
  • user_fields_automatic.pl ¹ - Configuration for automatically setting user fields based on the values of other fields.
  • user_fields_default.pl ¹ - Default initial values for user fields.
  • user_fields.pl ¹ - Non-core field definitions for the user data object.
  • user_login.pl ¹ - Configuration for managing user login to the repository archive.
  • user_render.pl ¹ - Configuration for rendering user pages.
  • user_review_scope.pl ^2,3 - Configuration defining the options for the scope of eprint items an editor user can review.
  • user_roles.pl ¹ - The roles assigned to different types of user.
  • user_search.pl ¹ - Configuration for search of user data objects.
  • user_validate.pl ¹ - Validation of the user data object as a whole.
  • views.pl ^2,3 - Configuration for generating browse views.
  • vlit.pl ¹ - Configuration for VLit.