Archives/ARCHIVEID/cfg/cfg.d/: Difference between revisions
Added some more config file descriptions |
Added some more config files and descriptions. |
||
| Line 9: | Line 9: | ||
** '''[[20_baseurls.pl]]''' - Configuration for how base URLs used by the repository archive. | ** '''[[20_baseurls.pl]]''' - Configuration for how base URLs used by the repository archive. | ||
** '''[[adminemail.pl]]''' - The admin email address for the repository archive. | ** '''[[adminemail.pl]]''' - The admin email address for the repository archive. | ||
** '''[[branding.pl]]''' - Branding for the repository archive | ** '''[[branding.pl]]''' - Branding for the repository archive. | ||
** '''[[database.pl]]''' - Configuration for connecting to the database. | ** '''[[database.pl]]''' - Configuration for connecting to the database. | ||
** '''[[document_fields.pl]]''' - Non-core field definitions for the document data object. | ** '''[[document_fields.pl]]''' - Non-core field definitions for the document data object. | ||
| Line 22: | Line 22: | ||
** '''[[eprint_fields_default.pl]]''' - Default initial values for eprint fields. | ** '''[[eprint_fields_default.pl]]''' - Default initial values for eprint fields. | ||
** '''[[eprint_render.pl]]''' - Configuration for rendering eprint abstract/summary pages. | ** '''[[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_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). | ** '''[[eprint_warnings.pl]]''' - Warnings to advise the depositor on potential issues with the eprint (e.g. no uploaded documents). | ||
** '''[[field_property_defaults.pl]]''' - | ** '''[[field_property_defaults.pl]]''' - Defaults for various attributes for a field specification. | ||
** '''[[field_validate.pl]]''' - | ** '''[[field_validate.pl]]''' - General validation of a metadata field. | ||
** '''[[indexing.pl]]''' - Configuration for indexing of metadata and document content. | ** '''[[indexing.pl]]''' - Configuration for indexing of metadata and document content. | ||
** '''[[issues_search.pl]]''' - | |||
** '''[[languages.pl]]''' - Configuration for languages used by the repository archive. | ** '''[[languages.pl]]''' - Configuration for languages used by the repository archive. | ||
** '''[[latest_tool.pl]]''' - | |||
** '''[[log.pl]]''' - Configuration for logging error/warnung messages for the repository archive. | ** '''[[log.pl]]''' - Configuration for logging error/warnung messages for the repository archive. | ||
** '''[[misc.pl]]''' - Miscellaneous configuration settings. | ** '''[[misc.pl]]''' - Miscellaneous configuration settings. | ||
** '''[[oai.pl]]''' - Configuration for [[OAI]]. | ** '''[[oai.pl]]''' - Configuration for [[OAI]]. | ||
** '''[[paths.pl]]''' - | ** '''[[paths.pl]]''' - Configuration for filesystem paths for particular parts of the repository archive. | ||
** '''[[plugins.pl]]''' - Enabling and configuration of plugins for the repository archive. | ** '''[[plugins.pl]]''' - Enabling and configuration of plugins for the repository archive. | ||
** '''[[registration.pl]]''' - Configuation for enabling/managing user reegistration for the repository archive. | ** '''[[registration.pl]]''' - Configuation for enabling/managing user reegistration for the repository archive. | ||
** '''[[request_copy.pl]]''' - Configuration for "request a copy" of a restricted document. | ** '''[[request_copy.pl]]''' - Configuration for "request a copy" of a restricted document. | ||
** '''[[search.pl]]''' - | ** '''[[search.pl]]''' - Miscelleanous search configuation not tied to a specific data object or type of search. | ||
** '''[[security.pl]]''' - Functions for securing appropriate access to uploaded documents. | ** '''[[security.pl]]''' - Functions for securing appropriate access to uploaded documents. | ||
** '''[[session.pl]]''' - | ** '''[[session.pl]]''' - | ||
| Line 44: | Line 49: | ||
** '''[[user_login.pl]]''' - Configuration for managing user login to the repository archive. | ** '''[[user_login.pl]]''' - Configuration for managing user login to the repository archive. | ||
** '''[[user_render.pl]]''' - Configuration for rendering user pages. | ** '''[[user_render.pl]]''' - Configuration for rendering user pages. | ||
** '''[[user_review_scope.pl]]''' - | |||
** '''[[user_roles.pl]]''' - The roles assigned to different types of user. | ** '''[[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. | ** '''[[user_validate.pl]]''' - Validation of the user data object as a whole. | ||
** '''[[views.pl]]''' - Configuration for generating browse views. | ** '''[[views.pl]]''' - Configuration for generating browse views. | ||
** '''[[vlit.pl]]''' - | ** '''[[vlit.pl]]''' - | ||
Revision as of 21:07, 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;
- 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.
- document_fields.pl - Non-core field definitions for the document data object.
- document_fields_automatic.pl - Configuation for automatically setting document fields based on the values of other fields.
- document_fields_default.pl - Default initial values for document fields.
- document_upload.pl - Configuration relating to managing document uploads.
- document_validate.pl - Validation of the eprint data object as a whole.
- dynamic_template.pl - Configuration for dynamic template of repository archive.
- email.pl - Configuration for sending email from the repository archive.
- eprint_fields.pl - Non-core field definitions for the eprint data object.
- eprint_fields_automatic.pl - Configuation for automatically setting eprint fields based on the values of other fields.
- eprint_fields_default.pl - Default initial values for eprint fields.
- 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).
- field_property_defaults.pl - Defaults for various attributes for a field specification.
- field_validate.pl - General validation of a metadata field.
- indexing.pl - Configuration for indexing of metadata and document content.
- issues_search.pl -
- languages.pl - Configuration for languages used by the repository archive.
- latest_tool.pl -
- 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.
- registration.pl - Configuation for enabling/managing user reegistration for the repository archive.
- request_copy.pl - Configuration for "request a copy" of a restricted document.
- search.pl - Miscelleanous search configuation not tied to a specific data object or type of search.
- security.pl - Functions for securing appropriate access to uploaded documents.
- session.pl -
- urls.pl -
- user_fields.pl - Non-core field definitions for the user data object.
- user_fields_automatic.pl - Configuation for automatically setting user fields based on the values of other fields.
- user_fields_default.pl - Default initial values for user fields.
- user_login.pl - Configuration for managing user login to the repository archive.
- user_render.pl - Configuration for rendering user pages.
- user_review_scope.pl -
- 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 -