Editing Config Options by File (section)

== D ==

=== [[database.pl]] ===
* '''dbname''' - The name of the database where the repository archive is hosted. (Configuration generated on repository archive creation. Typically the same as the archive's ID).
* '''dbhost''' - The hostname or IP address where the database for the repository archive is hosted.  (Configuration generated on repository archive creation. Typically <code>localhost</code>). 
* '''dbport''' - The TCP port over which the database for the repository archive can be accessed. (Configuration generated on repository archive creation. Typically <code>undef</code> as database client assume default port).
* '''dbsock''' - The socket over which the database for the repository archive can be accessed. (Configuration generated on repository archive creation. Typically <code>undef</code>, as sockets are not used).
* '''dbuser''' - The username to connect to the database where the repository archive is hosted. (Configuration generated on repository archive creation. Often the same as the archive's ID).
* '''dbpass''' - The password to connect to the database where the repository archive is hosted. (Configuration generated on repository archive creation. Typically automatically generated 16 character string).
* '''dbengine''' - The database table engine to use when creating new tables in the database where the repository archive is hosted. (Configuration generated on repository archive creation. Default is <code>InnoDB</code>, previously has been <code>MyISAM</code>).

=== [[datasets.pl]] ===
* '''datasets''' - Initialises hash reference (if not already) so other configuration files can add bespoke datasets.

=== [[doc_rewrite.pl]] ===
Adds an [[Triggers#EP_TRIGGER_DOC_URL_REWRITE|<code>EP_TRIGGER_DOC_URL_REWRITE</code> trigger function]] to handle relation-based document redirects.

=== [[document_fields_automatic.pl]] ===
* '''set_document_automatic_fields''' - Defines a function that updates specified fields for a document when its data object is committed.  (By default no fields are updated).

=== [[document_fields_default.pl]] ===
* '''set_document_defaults''' - A function that sets the initial values specified fields for a document when its data object is created.  (By default the <code>language</code> field is set to the default language for the repository and the <code>security</code> field is set to <code>public</code>).
* '''eprint_details_document_fields''' - The document fields that should be displayed in the Upload section of Details tab of the eprint view page.  (Default: <code>[ "content", "format", "format_desc", "language", "security", "license", "date_embargo", "embargo_reason" ]</code>

=== [[document_fields.pl]] ===
* '''fields'''
** '''document''' - Extra fields to add to the document data object beyond those defined by <code>EPrints::DataObj::Document</code>.  (By default this configuration is commented out.  I.e. no new fields will be added).

=== [[document_upload.pl]] ===
* '''diskspace_error_threshold''' - The minimum amount of space left on a disk before using the next disk available if present. (Default is <code>64 * 1024</code> kilobytes, i.e. 64 MiB).
* '''diskspace_warn_threshold''' - The minimum amount of space left on a disk before the administrator receives a warning email about disk space running low. (Default is <code>512 * 1024</code> kilobytes, i.e. 512 MiB).
* '''mimemap''' - Additional entries can be added to the <code>mimemap</code>.  (By default no additional entries are added).
* '''archive_max_files''' - Maximum number of files in an archive (e.g. zip file) that can be expanded in individual documents for an eprint record.  (Commented out by default but core default is <code>100</code> files).

=== [[document_validate.pl]] ===
* '''validate_document''' - A function that validates the metadata for a document data object.  (<font style="color: red;">This option is partially deprecated.  Rather than adding extra validations, use a  [[Triggers#EP_TRIGGER_VALIDATE|<code>EP_TRIGGER_VALIDATE</code> dataset trigger function]] for the document dataset</font>).

The following validation tests are performed on a document data object:
# <code>formatdesc</code> is set if the <code>format</code> is <code>other</code>.  
# Unless <code>retain_embargo_dates</code> config option is set true, if <code>security</code> is set to <code>public</code> then the <code>date_embargo</code> field must be unset.
# If the year part of <code>date_embargo</code> is set then the month and day most also be set to ensure clarity on when an embargo expires.
# Unless <code>retain_embargo_dates</code> config option is set true, <code>date_embargo</code> must be in the past.
# If <code>security</code> is set to <code>public</code> then <code>date_embargo</code> cannot be in the future (and can only be in the past if <code>retain_embargo_dates</code> config option is set true).

=== [[dynamic_template.pl]] ===
For more information see '''[[API:EPrints/Apache/Template#Dynamic_Pins|Dynamic Pins]]'''.  (<font style="color: red;">This option is partially deprecated.  Consider using a [[Triggers#EP_TRIGGER_DYNAMIC_TEMPLATE|<code>EP_TRIGGER_DYNAMIC_TEMPLATE</code>  trigger function]] instead</font>).
* '''dynamic_template''' 
** '''enable''' - Enables dynamic template. (Default is <code>1</code>).
* '''plugins''' 
** '''Screen::Login'''
*** '''appears'''
**** '''key_tools''' - Where login page link should appear in the key tools menu bar, if the user is not already logged in.
** '''Screen::Register'''
*** '''actions'''
**** '''register'''
***** '''appears'''
****** '''key_tools''' - Where the user registration page link should appear in the key tools menu bar.
** '''Screen::Logout'''
*** '''appears'''
**** '''key_tools''' - Where logout page link should appear in the key tools menu bar, if the user is already logged in.
** '''Screen::Admin::Config::Edit::XPage'''
*** '''actions'''
**** '''edit'''
***** '''appears'''
****** '''key_tools''' - Where the edit static page (if current page is a static page) link should appear in the key tools menu bar.
** '''Screen::Admin::Phrases'''
*** '''actions'''
**** '''edit'''
***** '''appears'''
****** '''key_tools''' - Where the edit page phrases link should appear in the key tools menu bar.
** '''Screen::OtherTools'''
*** '''appears'''
**** '''key_tools''' - Where Other Tools page link should appear in the key tools menu bar.  (<code>Screen::OtherTools</code> plugin does not exist by default so will not appear in the key tools meny bar).