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

From EPrints Documentation
Jump to: navigation, search
(Added signposting.pl)
 
(2 intermediate revisions by the same user not shown)
Line 16: Line 16:
 
  lib/cfg.d/ <- flavours/FLAVOURLIB/cfg.d/ <- ingredients/INGREDIENTID/cfg.d/ <- site_lib/cfg.d/ <- '''archives/ARCHIVEID/cfg/cfg.d/'''
 
  lib/cfg.d/ <- flavours/FLAVOURLIB/cfg.d/ <- ingredients/INGREDIENTID/cfg.d/ <- site_lib/cfg.d/ <- '''archives/ARCHIVEID/cfg/cfg.d/'''
  
 +
Below is a listing of all the configuration files in EPrints core codebase.  A typically archive would only have a small percentage of these files.  It also may have its own bespoke configuration files or those installed by [https://bazaar.eprints.org EPrints Bazaar] plugins.  Configuration files under lib/cfg.d/ or flavours/pub_lib/cfg.d/ need not be copied to an archive's cfg.d/ directory unless they need to be modified.  If a modification is needed to only one or two variables in one of these configuration files, it is advised to create a new configuration under the archive's cfg.d/ directory with a similar filename but prefixed with a 'z_', (e.g. branding.pl -> z_branding.pl) and then just add configuration variables that need modifying.
 
*'''[[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'''
 +
** '''[[00_flavour.pl]] <sup>5</sup>''' - The flavour of the repository archive.
 
** '''[[00_version.pl]] <sup>1</sup>''' -  The version information for EPrints core. as opposed to a particular [[flavour_info.pl|flavour]].
 
** '''[[00_version.pl]] <sup>1</sup>''' -  The version information for EPrints core. as opposed to a particular [[flavour_info.pl|flavour]].
 
** '''[[10_core.pl]] <sup>5</sup>''' - Core configuration for repository archive, such as hostname and port (both for HTTP and HTTPS), host aliases and path it sits on.
 
** '''[[10_core.pl]] <sup>5</sup>''' - Core configuration for repository archive, such as hostname and port (both for HTTP and HTTPS), host aliases and path it sits on.
Line 104: Line 106:
 
** '''[[views_render_items_example.pl]] <sup>3</sup>''' - Example configuation for alternative rendering of browse view listing pages.
 
** '''[[views_render_items_example.pl]] <sup>3</sup>''' - Example configuation for alternative rendering of browse view listing pages.
 
** '''[[views_render_menu_example.pl]] <sup>3</sup>''' - Example configuation for alternative rendering of browse view menu pages.
 
** '''[[views_render_menu_example.pl]] <sup>3</sup>''' - Example configuation for alternative rendering of browse view menu pages.
 +
** '''[[y_export_privacy.pl]] <sup>2</sup>''' - Logic that can restrict export plugins that may include information with privacy concerns from being publicly accessible.
 +
** '''[[zz_version.pl]] <sup>1</sup>''' - Builds the final EPrints version description for the repository archive.

Latest revision as of 16:10, 4 March 2025

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/

Below is a listing of all the configuration files in EPrints core codebase. A typically archive would only have a small percentage of these files. It also may have its own bespoke configuration files or those installed by EPrints Bazaar plugins. Configuration files under lib/cfg.d/ or flavours/pub_lib/cfg.d/ need not be copied to an archive's cfg.d/ directory unless they need to be modified. If a modification is needed to only one or two variables in one of these configuration files, it is advised to create a new configuration under the archive's cfg.d/ directory with a similar filename but prefixed with a 'z_', (e.g. branding.pl -> z_branding.pl) and then just add configuration variables that need modifying.

Retrieved from ‘https://wiki.eprints.org/w/index.php?title=Archives/ARCHIVEID/cfg/cfg.d/&oldid=16736’