Editing Config Options by File (section)

== S ==

=== [[search.pl]] ===
* '''match_start_of_name''' - Whether searches should match start of family names rather than just the complete family name (e.g. <code>smi</code> rather than <code>smith</code>.  (Default is <code>0</code>, do not match on start of name).
* '''latest_citation''' - The <code>eprint</code> citation style file to use on <code>/cgi/latest</code> page for items published in the last 7 days.

=== [[search_xapian.pl]] ===
* '''xapian_index_restricted_fulltext''' - Whether to index the full text of documents not publicly accessible. As clever searches may allow users to discover certain contents of these documents.  (Default is <code>0</code>, do not restrict the full texts from being indexed).

Also adds [[Triggers#EP_TRIGGER_INDEX_FIELDS|<code>EP_TRIGGER_INDEX_FIELDS</code>]] and [[Triggers#EP_TRIGGER_REMOVED|<code>EP_TRIGGER_REMOVED</code> trigger functions]] to index fields in the Xapian database index or remove the Xapian database index if the <code>eprint</code> data iobject is removed.

=== [[security.pl]] ===
* '''can_request_view_document''' - Defines a function to determine if a particular document can be viewed.  (By default allows documents with <code>security</code> set to <code>public</code> to be viewed as well as restricted documents that include an authorised "request copy" code).
* '''can_user_view_document''' - Defines a function to determine if a particular document can be viewed by a specific user. (By default allows documents with <code>security</code> set to <code>public</code> to be viewed as well as <code>validuser</code> for <code>security</code> documents to be viewed by logged in user unless their <code>usertype</code> is <code>minuser</code>.  Also allows access to  <code>staffonly</code> for <code>security</code> documents for users of type <code>editor</code> or <code>admin</code> or the owner of the eprint item).

=== [[session.pl]] ===
* '''session_init''' - Defines a function to carry out any actions when a session is initialised.  (No actions by default).
* '''session_close''' - Defines a function to carry out any actions when a session is closed.  (No actions by default).

=== [[signposting.pl]] ===
* '''plugins'''
** '''Export::BibTeX''' 
*** '''params'''
**** '''signposting''' - Specifies <code>Export::BibTeX</code> plugin can be used in [https://signposting.org/ Signposting].
** '''Export::DC''' 
*** '''params'''
**** '''signposting''' - Specifies <code>Export::DC</code> plugin can be used in Signposting.
** '''Export::JSON''' 
*** '''params'''
**** '''signposting''' - Specifies <code>Export::JSON</code> plugin can be used in Signposting.
** '''Export::XML''' 
*** '''params'''
**** '''signposting''' - Specifies <code>Export::XML</code> plugin can be used in Signposting.

=== [[Perl_lib/EPrints/SystemSettings.pm|SystemSettings.pm]] ===
* '''version''' - The core version of EPrints (By default <code>EPrints 3.x.y</code>.  <code>x.y</code> varies dependent on version).
* '''version_id''' - The core version ID of EPrints (By default <code>eprints-3.x.y</code>.  <code>x.y</code> varies dependent on version).
* '''base_path''' - The base path for EPrints on the filesystem. (By default <code>/opt/eprints3</code>).
* '''show_ids_in_log''' - Whether to show repoistory archive ID is log messages. (By default <code>0</code> do not show archive ID in log messages).
* '''group''' - The Unix group to set when EPrints creates new files (By default <code>eprints</code>).
* '''version_history''' - An array reference of version IDs that proceeded the current version.
* '''smtp_server''' - The SMTP server to connect to for sending emails (By default <code>127.0.0.1</code>, i.e. localhost).
* '''user''' - The Unix user to set when EPrints creates new files (By default <code>eprints</code>).
* '''file_perms''' The Unix permissions mask to use when EPrints creates new files. (By default <code>0664</code>).
* '''invocation''' - Invocation commands for external executables and internal scripts. (By default an empty hash reference, as populated by [[invocations.pl]]).
* '''executables''' - External executable and internal script paths. (By default a hash reference with one entry for <code>perl</code>.  Further populated by [[executables.pl]]).
* '''dir_perms''' - The Unix permissions mask to use when EPrints creates new directories. (By default <code>02775</code>).
* '''flavours''' - Flavours available for this EPrints installation.  (By default <code>zero</code> plus any flavours found under the <code>flavours/</code> sub-directory).
* '''perl_module_isolation''' - If running multiple archives should Perl modules be isolated between each archive. (By default <code>0</code> they should not be isolated, as this can severely affect performance).
* '''indexer_daemon''' 
** '''loglevel''' - What level of log messages to write to the indexer log file. (By default messages of at up to level <code>1</code>).
** '''rollcount''' - How many old log files to retain after the log file has been rolled/rotated (By default <code>5</code> old log files should be retained).
** '''maxwait''' - How many seconds to wait after gracefully trying to kill the child indexer process before forcefully killing the child indexer process.  (By default <code>8</code> seconds before the child indexer process should forcefully be killed).
** '''interval''' - How many seconds to wait between checking if there are any indexer tasks ready to be run.  (By default <code>30</code> seconds to wait for any indexer tasks ready to be run).
** '''respawn''' - How many seconds before the child process of the indexer should respawn, prompting the indexer log to be rotated. (By default <code>86400</code> seconds, i.e. 1 day).
** '''timeout''' - How many seconds the indexer should allow to complete a task before killing it.  (By default <code>600</code> seconds, i.e. 10 minutes).
** '''interrupt''' - Should the indexer immediately break out of loop checking for indexer tasks (By default <code>0</code>, no it should not break out of loops. This is a nonsensical setting, as <code>1</code> would affectively disable the indexer whilst it kept running).