Difference between revisions of "Archives/ARCHIVEID/cfg/cfg.d/"
(removed user_password_maxlength.pl. imporved description for user_auth_limits.pl) |
(Added info about where cfg.d files come from.) |
||
| Line 4: | Line 4: | ||
# the foo option modifies the number of badgers in the boojum | # the foo option modifies the number of badgers in the boojum | ||
$c->{foo} = 23; | $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/cfg.d/ (which are copied to the repository archive's cfg.d directory on its creation). | ||
| + | * EPRINTS_PATH/flavours/pub_lib/defaultcfg/cfg.d/ (which are copied to the repository archive's cfg.d directory on its creation). | ||
*'''[[EPrints_Directory_Structure/eprints3|eprints3]]/[[EPrints_Directory_Structure/eprints3/archives|archives]]/[[EPrints_Directory_Structure/eprints3/archives/ARCHIVEID|ARCHIVEID]]/[[EPrints_Directory_Structure/eprints3/archives/ARCHIVEID/cfg|cfg]]/cfg.d''' | *'''[[EPrints_Directory_Structure/eprints3|eprints3]]/[[EPrints_Directory_Structure/eprints3/archives|archives]]/[[EPrints_Directory_Structure/eprints3/archives/ARCHIVEID|ARCHIVEID]]/[[EPrints_Directory_Structure/eprints3/archives/ARCHIVEID/cfg|cfg]]/cfg.d''' | ||
Revision as of 13:24, 31 January 2022
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/cfg.d/ (which are copied to the repository archive's cfg.d directory on its creation).
- EPRINTS_PATH/flavours/pub_lib/defaultcfg/cfg.d/ (which are copied to the repository archive's cfg.d directory on its creation).
- 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 - 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 - 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 - Default initial values for eprint fields.
- eprint_fields.pl - 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 - Configuration for rendering eprint abstract/summary pages.
- eprint_search_advanced.pl - Configuration for advanced search of eprint data objects.
- eprint_search_simple.pl - Configuration for simple search of eprint data objects.
- eprint_search_staff.pl - Configuration for staff search of eprint data objects.
- eprint_validate.pl - Validation of the eprint data object as a whole.
- eprint_warnings.pl - 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 - Information about the flavour of the repository archive.
- indexing.pl - Configuration for indexing of metadata and document content.
- issues_search.pl - 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 - Configuration for OAI.
- paths.pl - Configuration for filesystem paths for particular parts of the repository archive.
- plugins.pl - 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 - 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 - 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 - Configuration for generating browse views.
- vlit.pl - Configuration for VLit.
