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

From EPrints Documentation
Jump to: navigation, search
m
(Added missing descriptions.)
Line 22: Line 22:
 
** '''[[adminemail.pl]] <sup>5</sup>''' - The admin email address for the repository archive.
 
** '''[[adminemail.pl]] <sup>5</sup>''' - The admin email address for the repository archive.
 
** '''[[branding.pl]] <sup>1</sup>''' - Branding for the repository archive.
 
** '''[[branding.pl]] <sup>1</sup>''' - Branding for the repository archive.
−
** '''[[citationcaches.pl]] <sup>3,4</sup>''' -
+
** '''[[citationcaches.pl]] <sup>3,4</sup>''' - Configurtion for protection against [https://owasp.org/www-community/attacks/csrf Cross Site Request Forgery (CSRF)] attacks.
−
** '''[[csrf_protection.pl]] <sup>3,4</sup>''' -
+
** '''[[csrf_protection.pl]] <sup>3,4</sup>''' - Configuration for enabling and restricting citation caching.
 
** '''[[database.pl]] <sup>5</sup>''' - Configuration for connecting to the database.
 
** '''[[database.pl]] <sup>5</sup>''' - Configuration for connecting to the database.
 
** '''[[datasets.pl]] <sup>1</sup>''' - Configuration for bespoke datasets and data objects for the repository archive.
 
** '''[[datasets.pl]] <sup>1</sup>''' - Configuration for bespoke datasets and data objects for the repository archive.
Line 62: Line 62:
 
** '''[[misc.pl]] <sup>1</sup>''' - Miscellaneous configuration settings.
 
** '''[[misc.pl]] <sup>1</sup>''' - Miscellaneous configuration settings.
 
** '''[[oai.pl]] <sup>2,3</sup>''' - Configuration for [[OAI]].
 
** '''[[oai.pl]] <sup>2,3</sup>''' - Configuration for [[OAI]].
−
** '''[[optional_filename_sanitise.pl]] <sup>1</sup>''' -
+
** '''[[optional_filename_sanitise.pl]] <sup>1</sup>''' - Configuration to santise uploaded file names.
 
** '''[[paths.pl]] <sup>1</sup>''' - Configuration for filesystem paths for particular parts of the repository archive.
 
** '''[[paths.pl]] <sup>1</sup>''' - Configuration for filesystem paths for particular parts of the repository archive.
 
** '''[[plugins.pl]] <sup>2,3</sup>''' - Enabling and configuration of plugins for the repository archive.
 
** '''[[plugins.pl]] <sup>2,3</sup>''' - Enabling and configuration of plugins for the repository archive.
Line 77: Line 77:
 
** '''[[render_paras.pl]] <sup>2</sup>''' - Function for rendering paragraphs for free-text fields.
 
** '''[[render_paras.pl]] <sup>2</sup>''' - Function for rendering paragraphs for free-text fields.
 
** '''[[request_copy.pl]] <sup>2,3</sup>''' - Configuration for "request a copy" of a restricted document.
 
** '''[[request_copy.pl]] <sup>2,3</sup>''' - Configuration for "request a copy" of a restricted document.
−
** '''[[rewrite_url_demo.pl]] <sup>3</sup>''' -
+
** '''[[rewrite_url_demo.pl]] <sup>3</sup>''' - Example configuration for redirecting certain requests.
 
** '''[[search.pl]] <sup>1</sup>''' - Miscelleanous search configuration not tied to a specific data object or type of search.
 
** '''[[search.pl]] <sup>1</sup>''' - Miscelleanous search configuration not tied to a specific data object or type of search.
 
** '''[[search_xapian.pl]] <sup>1</sup>''' - Xapian-specific search configuration.
 
** '''[[search_xapian.pl]] <sup>1</sup>''' - Xapian-specific search configuration.
Line 98: Line 98:
 
** '''[[views.pl]] <sup>2,3</sup>''' - Configuration for generating browse views.
 
** '''[[views.pl]] <sup>2,3</sup>''' - Configuration for generating browse views.
 
** '''[[vlit.pl]] <sup>1</sup>''' - Configuration for [[VLit]].
 
** '''[[vlit.pl]] <sup>1</sup>''' - Configuration for [[VLit]].
−
** '''[[views_render_items_example.pl]] <sup>3</cup>''' -
+
** '''[[views_render_items_example.pl]] <sup>3</cup>''' - Example configuation for alternative rendering of browse view listing pages.
−
** '''[[views_render_menu_example.pl]] <sup>3</sup>''' -
+
** '''[[views_render_menu_example.pl]] <sup>3</sup>''' - Example configuation for alternative rendering of browse view menu pages.

Revision as of 11:19, 4 February 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:

  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

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/
Retrieved from ‘https://wiki.eprints.org/w/index.php?title=Archives/ARCHIVEID/cfg/cfg.d/&oldid=14487’