Difference between revisions of "Archives/ARCHIVEID/cfg/cfg.d/"

From EPrints Documentation
Jump to: navigation, search
(Added some descriptions for config files.)
Line 6: Line 6:
  
 
*'''[[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'''
−
** '''[[10_core.pl]]''' -
+
** '''[[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]]''' -
+
** '''[[20_baseurls.pl]]''' - Configuration for how base URLs used by the repository archive.
−
** '''[[adminemail.pl]]''' -
+
** '''[[adminemail.pl]]''' - The admin email address for the repository archive.
−
** '''[[branding.pl]]''' -
+
** '''[[branding.pl]]''' - Branding for the repository archive
−
** '''[[database.pl]]''' -
+
** '''[[database.pl]]''' - Configuration for connecting to the database.
−
** '''[[document_fields_automatic.pl]]''' -
+
** '''[[document_fields]]''' - Non-core field definitions for the document data object.
−
** '''[[document_fields_default.pl]]''' -
+
** '''[[document_fields_automatic.pl]]''' - Configuation for automatically setting document fields based on the values of other fields.
−
** '''[[document_upload.pl]]''' -
+
** '''[[document_fields_default.pl]]''' - Default initial values for document fields.
−
** '''[[document_validate.pl]]''' -
+
** '''[[document_upload.pl]]''' - Configuration relating to managing document uploads.
−
** '''[[dynamic_template.pl]]''' -
+
** '''[[document_validate.pl]]''' - Validation of the eprint data object as a whole.
−
** '''[[email.pl]]''' -
+
** '''[[dynamic_template.pl]]''' - Configuration for dynamic template of repository archive.
−
** '''[[eprint_fields.pl]]''' -
+
** '''[[email.pl]]''' - Configuration for sending email from the repository archive.
−
** '''[[eprint_fields_automatic.pl]]''' -
+
** '''[[eprint_fields.pl]]''' - Non-core field definitions for the eprint data object.
−
** '''[[eprint_fields_default.pl]]''' -
+
** '''[[eprint_fields_automatic.pl]]''' - Configuation for automatically setting eprint fields based on the values of other fields.
−
** '''[[eprint_render.pl]]''' -
+
** '''[[eprint_fields_default.pl]]''' - Default initial values for eprint fields.
−
** '''[[eprint_validate.pl]]''' -
+
** '''[[eprint_render.pl]]''' - Configuration for rendering eprint abstract/summary pages.
−
** '''[[eprint_warnings.pl]]''' -
+
** '''[[eprint_validate.pl]]''' - Validation of the eprint data object as a whole.
−
** '''[[field_property_defaults.pl]]''' -
+
** '''[[eprint_warnings.pl]]''' - Warnings to advise the depositor on potential issues with the eprint (e.g. no uploaded documents).
 +
** '''[[field_property_defaults.pl]]''' -  
 
** '''[[field_validate.pl]]''' -
 
** '''[[field_validate.pl]]''' -
−
** '''[[indexing.pl]]''' -
+
** '''[[indexing.pl]]''' - Configuration for indexing of metadata and document content.
−
** '''[[languages.pl]]''' -
+
** '''[[languages.pl]]''' - Configuration for languages used by the repository archive.
 
** '''[[log.pl]]''' -
 
** '''[[log.pl]]''' -
 
** '''[[misc.pl]]''' -
 
** '''[[misc.pl]]''' -
 
** '''[[oai.pl]]''' -
 
** '''[[oai.pl]]''' -
−
** '''[[paths.pl]]''' -
+
** '''[[paths.pl]]''' -  
−
** '''[[plugins.pl]]''' -
+
** '''[[plugins.pl]]''' - Enabling and configuration of plugins for the repository archive.
−
** '''[[registration.pl]]''' -
+
** '''[[registration.pl]]''' - Configuation for enabling/managing user reegistration for the repository archive.
−
** '''[[request_copy.pl]]''' -
+
** '''[[request_copy.pl]]''' - Configuration for "request a copy" of a restricted document.
 
** '''[[search.pl]]''' -
 
** '''[[search.pl]]''' -
−
** '''[[security.pl]]''' -
+
** '''[[security.pl]]''' - Functions for securing appropriate access to uploaded documents.
 
** '''[[session.pl]]''' -
 
** '''[[session.pl]]''' -
 
** '''[[urls.pl]]''' -
 
** '''[[urls.pl]]''' -
−
** '''[[user_fields.pl]]''' -
+
** '''[[user_fields.pl]]''' - Non-core field definitions for the user data object.
−
** '''[[user_fields_automatic.pl]]''' -
+
** '''[[user_fields_automatic.pl]]''' - Configuation for automatically setting user fields based on the values of other fields.
−
** '''[[user_fields_default.pl]]''' -
+
** '''[[user_fields_default.pl]]''' - Default initial values for user fields.
−
** '''[[user_login.pl]]''' -
+
** '''[[user_login.pl]]''' - Configuration for managing user login to the repository archive.
−
** '''[[user_render.pl]]''' -
+
** '''[[user_render.pl]]''' - Configuration for rendering user pages.
−
** '''[[user_roles.pl]]''' -
+
** '''[[user_roles.pl]]''' - The roles assigned to different types of user.
−
** '''[[user_validate.pl]]''' -
+
** '''[[user_validate.pl]]''' - Validation of the user data object as a whole.
−
** '''[[views.pl]]''' -
+
** '''[[views.pl]]''' - Configuration for generating browse views.
 
** '''[[vlit.pl]]''' -
 
** '''[[vlit.pl]]''' -

Revision as of 17:41, 23 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;
Retrieved from ‘https://wiki.eprints.org/w/index.php?title=Archives/ARCHIVEID/cfg/cfg.d/&oldid=14284’