Archives/ARCHIVEID/cfg/cfg.d/
Revision as of 11:59, 4 February 2022 by Drn@ecs.soton.ac.uk (talk | contribs)
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:
- EPRINTS_PATH/lib/cfg.d/
- EPRINTS_PATH/flavours/pub_lib/cfg.d/
- 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).
- EPRINTS_PATH/flavours/pub_lib/defaultcfg/cfg.d/ (which are copied to the repository archive's cfg.d directory on its creation).
- Generated through epadmin create
This directory is at the top of the levels of precedence for configuration files:
lib/cfg.d/ <- flavours/FLAVOURLIB/cfg.d/ <- ingredients/INGREDIENTID/cfg.d/ <- site_lib/cfg.d/ <- archives/ARCHIVEID/cfg/cfg.d/
- eprints3/archives/ARCHIVEID/cfg/cfg.d
- 00_version.pl 1 - The version information for EPrints core. as opposed to a particular flavour.
- 10_core.pl 5 - 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 5 - The admin email address for the repository archive.
- branding.pl 1 - Branding for the repository archive.
- citationcaches.pl 3,4 - Configuration for enabling and restricting citation caching.
- csrf_protection.pl 3,4 - Configuration for protection against Cross Site Request Forgery (CSRF) attacks.
- database.pl 5 - Configuration for connecting to the database.
- datasets.pl 1 - Configuration for bespoke datasets and data objects for the repository archive.
- doc_rewrite.pl 1 - Configuration to handle relation-based document redirects.
- document_fields_automatic.pl 1 - Configuration for automatically setting document fields based on the values of other fields.
- document_fields_default.pl 1 - Default initial values for document fields.
- document_fields.pl 1 - Non-core field definitions for the document data object.
- document_upload.pl 1 - Configuration relating to managing document uploads.
- document_validate.pl 1 - Validation of the eprint data object as a whole.
- dynamic_template.pl 1 - Legacy configuration for dynamic template of repository archive.
- element_classes.pl 1 - Configuration for assigning classes EPrints generated HTML elements.
- email.pl 1 - 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 2 - 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 2 - Publication flavour fields for the eprint data object.
- eprint_locking.pl 1 - 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 1,2 - 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 2 - Configuration relating to generic aspects of export plugins.
- field_property_defaults.pl 1 - Defaults for various attributes for a field specification.
- field_validate.pl 1 - General validation of a metadata field.
- flavour_info.pl 2,3 - Information about the flavour of the repository archive.
- indexing.pl 1 - Configuration for indexing of metadata and document content.
- issues_search.pl 2,3 - Configuration for search of eprint issues.
- languages.pl 1 - Configuration for languages used by the repository archive.
- latest_tool.pl 1 - Configuration for generating listings and feeds of latest eprints in the repository archive.
- limit_names_shown.pl 1 - Configuration to restrict number of names shown in a citation.
- log.pl 1 - Configuration for logging error/warning messages for the repository archive.
- make_orderkey.pl 1 - Configuration to better manage diacritics in ordering items.
- media_info.pl 1 - Configuration to file in media information about documents/files.
- mime_types.pl 1 - Configuration to load mime.types file.
- misc.pl 1 - Miscellaneous configuration settings.
- oai.pl 2,3 - Configuration for OAI.
- optional_filename_sanitise.pl 1 - Configuration to santise uploaded file names.
- paths.pl 1 - 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.pl 1 - Configuration for setting XML namespaces for RDF data files.
- rdf_license.pl 1 - Configuration for adding licences to RDF data files.
- rdf_triples_bibo.pl 1 - Configuration for generating Bibo RDF triples for an eprint data object.
- rdf_triples_eprints.pl 1 - Configuration for generating EPrints RDF triples for an eprint data object.
- rdf_triples_formats.pl 1 - Configuration for generating format RDF triples for an eprint data object.
- rdf_triples_general.pl 1 - Configuration for generating general RDF triples.
- rdf_triples_repository.pl 1 - Configuration for generating repository RDF triples.
- rdf_triples_skos.pl 1 - Configuration for generating SKOS RDF triples for an eprint and subject data objects.
- rdf_uris.pl 1 - Configuration for generating RDF URIs.
- registration.pl 1 - Configuration for enabling/managing user reegistration for the repository archive.
- render_paras.pl 2 - Function for rendering paragraphs for free-text fields.
- request_copy.pl 2,3 - Configuration for "request a copy" of a restricted document.
- rewrite_url_demo.pl 3 - Example configuration for redirecting certain requests.
- search.pl 1 - Miscelleanous search configuration not tied to a specific data object or type of search.
- search_xapian.pl 1 - Xapian-specific search configuration.
- security.pl 1 - Functions for securing appropriate access to uploaded documents.
- session.pl 1 - Functions for bespoke operations when initiating or closing a session.
- template_core.pl 1 - Core trigger for generating dynamic template.
- template_edit_phrases.pl 1 - Edit phrases trigger for generating dynamic template.
- template_legacy.pl 1 - Legacy trigger for generating dynamic template, as defined in dynamic_template.pl.
- template_links.pl 1 - Links trogger for generating dynamic template.
- user_auth_limits.pl 1 - Configuration for limiting aspects of user authentication to prevent brute force password cracking, denial-of-service, user spamming, etc.
- user_fields_automatic.pl 1 - Configuration for automatically setting user fields based on the values of other fields.
- user_fields_default.pl 1 - Default initial values for user fields.
- user_fields.pl 1 - Non-core field definitions for the user data object.
- user_login.pl 1 - Configuration for managing user login to the repository archive.
- user_render.pl 1 - 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 1 - The roles assigned to different types of user.
- user_search.pl 1 - Configuration for search of user data objects.
- user_validate.pl 1 - Validation of the user data object as a whole.
- views.pl 2,3 - Configuration for generating browse views.
- vlit.pl 1 - Configuration for VLit.
- views_render_items_example.pl 3</cup> - Example configuation for alternative rendering of browse view listing pages.
- views_render_menu_example.pl 3 - Example configuation for alternative rendering of browse view menu pages.