View source for Perl lib/EPrints/SystemSettings.pm

EPrints' system settings page can be found under ''[[perl_lib/EPrints/]]'' and contains global settings for the EPrints repository.  This field contains a data structure called <code>$EPrints::SystemSettings::conf</code> that stores various global configuration.  Including:
; <code>version</code> : The human-readable version of EPrints, (e.g. <tt>EPrints 3.4.4</tt>).
; <code>version_id</code> : The machine-readable version of EPrints, (e.g. <tt>eprints-3.4.4</tt>
; <code>base_path</code> : The base path on the filesystem where EPrints is installed (e.g. <tt>/opt/eprints3</tt>).
; <code>show_ids_in_log</code> : Whether <code>EPrints::Repository->log</code> calls should include the archive ID.  This is useful if your repository is running muliple archives.
; <code>group</code> : New files/directories created by EPrints should have their (Unix) group set to this. (e.g. <tt>eprints</tt>).
; <code>version_history</code> : An array of machine-readable versions of EPrints that preceded this version. (Not used in core codebase).
; <code>smtp_server</code> : SMTP server to use to send out emails from EPrints. Typically it is best to leave this as <tt>127.0.0.1</tt> and configure Postfix or Sendmail applications on your server to relay email to a real SMTP server.
; <code>user</code> : New files/directories created by EPrints should have their (Unix) user set to this. (e.g. <tt>eprints</tt>).
; <code>file_perms</code> : New files created by EPrints should have their (Unix) file permissions set to this. (E.g. <tt>0664</tt> Read/write for user and group, read-only to others).
; <code>invocation</code>: A Perl hash of external applications and how they should be invoked.  This is typically empty as invocations should be defined in lib/syscfg.d/[[invocations.pl]].
; <code>invocation</code>: A Perl hash of external applications and oaths to their executables.  This typically only contains the Perl executable as execitable paths should be defined in lib/syscfg.d/[[executables.pl]].
; <code>dir_perms</code> : New directories created by EPrints should have their (Unix) file permissions set to this. (E.g. <tt>02775</tt> Read, write and execute for user and group, read and execute to others. The SetGID bit is set so files/directories created in this directory will be set with the same group as the directory.  EPrints will do this any but useful if external processes are liable to create new files).
; <code>flavours</code> : A data structure that specifies [[EPrints Glossary#Flavour|flavours]] and the [[EPrints Glossary#Ingredient|ingredients]] or other paths (e.g. <tt>[EPrints Glossary#Site_lib|site_lib]]</tt>) that shoud be included within this flavour.  Typically, this defines just the <code>[[EPrints Glossary#Zero_flavour|zero]]</code> flavour as this configuration can be defined in the [[EPrints_Glossary#Inc_file|inc]] within the flavour's directory.
; <code>perl_module_isolation</code> : Should Perl modules be isolated between different archives within the repository?
; <code>indexer_daemon</code> : Configuration settings for EPrints' [[EPrints Glossary#Indexer|indexer]].  This includes 
* <code>loglevel</code> - What level of log messages should be captured. By default this is <tt>1</tt>, which prints all messages to STDERR.
* <code>rollcount</code> - How many old <tt>indexer.log.N</tt> files to keep before deleting them.  By default this (N) is <tt>5</tt>.
* <code>maxwait</code> - How many seconds to wait before concluding indexer is not running.  By default this is <tt>8</tt> seconds.
* <code>interval</code> - How many seconds the indexer should wait whilst idle before checking if there are any new [[EPrints Glossary#Indexer_task|tasks]] it can run from the [[EPrints Glossary#Event_queue|event queue]].  By default this is <tt>30</tt> seconds.
* <code>respawn</code> - How many seconds before the indexer should be respawned (in case it has got stuck) and rotate its log file.  By default this is <tt>86400</tt> seconds or one day.
* <code>timeout</code> - How many seconds before an individual [[EPrints Glossary#Indexer task]] is allowed to run before it times out and gets marked as <tt>failed</tt>.  By default this is <tt>600</tt> seconds or ten minutes.
* <code>interrupt</code> - Whether the indexer should be interrupted.  This effectively stops the indexer from being run.  Bu default this is <tt>0</tt>, as you probably want the indexer to be able to run.


This file also contains some code to managed the loading of [[EPrints Glossary#Inc file|inc files]] saving the need to reconfigure the <code>flavours</code> section of  <code>$EPrints::SystemSettings::conf</code>.