Miscellaneous Config Options - Revision history

Libjlrs: /* E */

2025-06-25T08:55:43Z

‎E

Drn@ecs.soton.ac.uk: /* L */ Added resources exceptions needed if homepage is excepted.

2025-04-25T09:02:16Z

‎L: Added resources exceptions needed if homepage is excepted.

Drn@ecs.soton.ac.uk: /* L */ Added login_required_for_static

2025-04-24T17:42:51Z

‎L: Added login_required_for_static

Drn@ecs.soton.ac.uk: /* L */ Added better explanation for login_required_url and login_required_for_cgi -> exceptions

2025-04-18T17:57:05Z

‎L: Added better explanation for login_required_url and login_required_for_cgi -> exceptions

Drn@ecs.soton.ac.uk: No longer a work in progress

2024-07-30T15:41:50Z

No longer a work in progress

Drn@ecs.soton.ac.uk: /* U */

2024-07-30T15:40:55Z

‎U

Drn@ecs.soton.ac.uk: /* T */

2024-07-30T15:37:02Z

‎T

Drn@ecs.soton.ac.uk: /* S */

2024-07-30T15:36:04Z

‎S

Drn@ecs.soton.ac.uk: /* O */

2024-07-30T15:29:39Z

‎O

Drn@ecs.soton.ac.uk: /* O */ on_generate_thumbnails is deprecated

2024-07-30T15:27:59Z

‎O: on_generate_thumbnails is deprecated

@@ Line 40: / Line 40: @@
 * '''expiry_for_doc_request''' - How many days an approved request copy link will last before access will be revoked. (Without a setting this is <code>7</code> days).
 * '''expiry_for_unresponded_doc_request''' - How many days an unapproved request can exists before the request can no longer be approved. Saves really old requests being approved without proper consideration or confusing / annoying the requester months/years after their request.  (Without a setting this is <code>90</code> days, approx. 3 months).
-* '''export_fieldlists''' - What fields can exported for a data object.  Further restricts field definition settings for <code>export_as_xml</code>.  This may be useful to block fields with data privacy concerns but it will mean that not even repository admins will bot be able to explort these fields.  Consider using [[y_export_privacy.pl|export_privacy]] instead.  (Without a setting, what fields can be exported are only defined by their field definitions).
+* '''export_fieldlists''' - What fields can exported for a data object.  Further restricts field definition settings for <code>export_as_xml</code>.  This may be useful to block fields with data privacy concerns but it will mean that not even repository admins will not be able to export these fields.  Consider using [[y_export_privacy.pl|export_privacy]] instead.  (Without a setting, what fields can be exported are only defined by their field definitions).
 == F ==

@@ Line 75: / Line 75: @@
 * '''login_required_for_static''' (EPrints 3.4.7+)
 ** '''enable''' -  Whether users need to be logged in to access static pages (e.g. the homepage, information and help pages. etc.).  (Without a setting login is not required, set to <code>1</code> to enable).
-** '''exceptions''' - Array reference of paths that are excluded from needing login.  (Without a setting all static require login, if <code>enabled</code> is set to <code>1</code>. All paths requires leading <code>/</code>.  So information page would be <code>/information.html</code> and hompage would be just <code>/</code>).
+** '''exceptions''' - Array reference of paths that are excluded from needing login.  (Without a setting all static require login, if <code>enabled</code> is set to <code>1</code>. All paths requires leading <code>/</code>.  So information page would be <code>/information.html</code> and hompage would be just <code>/</code>.  If some static pages are excepted, some of their resources will also need to be, e.g. <code>/favicon.ico</code>, <code>/images/.*</code> and <code>/style/images/.*</code>).
 * '''login_required_for_views'''
 ** '''enable''' - Whether users need to be logged in to access browse view pages. (Without a setting login is not required, set to <code>1</code> to enable).

@@ Line 69: / Line 69: @@
 == L ==
 * '''login_required_for_cgi'''
-** '''enable''' -  Whether users need to be logged in to access   <code>/cgi/...</code> pages (<code>/cgi/users/...</code> pages always required being logged in).  (Without a setting login is not required, set to <code>1</code> to enable).
+** '''enable''' -  Whether users need to be logged in to access <code>/cgi/...</code> pages (<code>/cgi/users/...</code> pages always required being logged in).  (Without a setting login is not required, set to <code>1</code> to enable).
 ** '''exceptions''' - Array reference of paths that are excluded from needing login.  (Without a setting all CGI scripts require login, if <code>enabled</code> is set to <code>1</code>.  This would cause a problem if your <code>login_required_url</code> is <code>/cgi/users/login</code> and therefore at least <code>users/login</code> should be added).
 * '''login_required_for_eprints'''
 ** '''enable''' -  Whether users need to be logged in to access eprint abstract/summary pages. (Without a setting login is not required, set to <code>1</code> to enable).
 * '''login_required_for_views'''
 ** '''enable''' - Whether users need to be logged in to access browse view pages. (Without a setting login is not required, set to <code>1</code> to enable).

@@ Line 70: / Line 70: @@
 * '''login_required_for_cgi'''
 ** '''enable''' -  Whether users need to be logged in to access   <code>/cgi/...</code> pages (<code>/cgi/users/...</code> pages always required being logged in).  (Without a setting login is not required, set to <code>1</code> to enable).
-** '''exceptions''' - Array reference of paths that are excluded from needing login.  (Without a setting all CGI scripts require login, if <code>enabled</code> is set to <code>1</code>).
+** '''exceptions''' - Array reference of paths that are excluded from needing login.  (Without a setting all CGI scripts require login, if <code>enabled</code> is set to <code>1</code>.  This would cause a problem if your <code>login_required_url</code> is <code>/cgi/users/login</code> and therefore at least <code>users/login</code> should be added).
 * '''login_required_for_eprints'''
 ** '''enable''' -  Whether users need to be logged in to access eprint abstract/summary pages. (Without a setting login is not required, set to <code>1</code> to enable).
 * '''login_required_for_views'''
 ** '''enable''' - Whether users need to be logged in to access browse view pages. (Without a setting login is not required, set to <code>1</code> to enable).
-* '''login_required_url''' - URL for page to be redirected to if login is required. This is different to <code>get_login_url</code> as it is only applicable to pages that are affected by <code>login_required_for_cgi</code>, <code>login_required_for_eprints</code> and <code>login_required_for_views</code>/ (Without a setting <code>/cgi/users/login</code> is used).
+* '''login_required_url''' - URL for page to be redirected to if login is required. This is different to <code>get_login_url</code> as it is only applicable to pages that are affected by <code>login_required_for_cgi</code>, <code>login_required_for_eprints</code> and <code>login_required_for_views</code>.  (Typically, this should be set to ths default login URL <code>/cgi/users/login</code>.  If this is not set the pages will try redirecting to themselves and get stuck in a loop).
 == M ==

@@ Line 4: / Line 4: @@
 [[#A|A]] | [[#B|B]] | [[#C|C]] | [[#D|D]] | [[#E|E]] | [[#F|F]] | [[#G|G]] | [[#H|H]] | [[#I|I]] | [[#J|J]] | [[#K|K]] | [[#L|L]] | [[#M|M]] | [[#N|N]] | [[#O|O]] | [[#P|P]] | [[#Q|Q]] | [[#R|R]] | [[#S|S]] | [[#T|T]] | [[#U|U]] | [[#V|V]] | [[#W|W]] | [[#X|X]] | [[#Y|Y]] | [[#Z|Z]]
 </div>
 This page describes configuration options that do not appear in any [[Config Options by File|specific configuration files present]] in the main codebase (inc. pub_lib flavour).  <font style="color: red;">The reason a configuration option does not appear in a default configuration file may be because it is a legacy option that may become deprecated and removed.</font> Some descriptions below state that a configuration option is legacy but some descriptions may still need updating to explain they are legacy options.

@@ Line 136: / Line 136: @@
 * '''<font style="color: red;">update_submitted_eprint</font>''' - Allows a bespoke function to be defined to perform actions once an eprint has been  moved to the review buffer.  <font style="color: red;">This is a legacy option.  The more generic <code>EP_TRIGGER_STATUS_CHANGE</code> [[Triggers#Dataset Triggers|dataset trigger function]] should be used instead.</font>
 * '''user_access_restrictions_callback''' - Allows a function to be defined to test if the current user has access to read/write (access View/Edit page) the specified user record.
-* '''user_area_template''' - Page template to use when accessing user area pages.  Superseded in EPrints 3.4.x by automatically using <code>default_internal</code> template all screen plugins.  (Without a setting either <code>default</code> (EPrints 3.3.x) or <code>default_internal</code> (EPrints 3.4.x) template is used.
+* '''<font style="color: red;">user_area_template</font>''' - Page template to use when accessing user area pages.  Superseded in EPrints 3.4.x by automatically using <code>default_internal</code> template all screen plugins.  (Without a setting either <code>default</code> (EPrints 3.3.x) or <code>default_internal</code> (EPrints 3.4.x) template is used.
 * '''user_cookie_timeout''' - The amount time (using: h, d, w, m, and y) before the user session cookie should expire (e.g. <code>+1h</code>, <code>+7d</code>).  (Without a setting no cookie timeout is set).
-* '''user_inactivity_timeout''' - How long to wait in seconds before logging the user out after their last activity.  (Without a setting 86400 * 7 seconds, i.e. 7 days is used).
+* '''user_inactivity_timeout''' - How long to wait in seconds before logging the user out after their last activity.  (Without a setting <code>86400 * 7</code> seconds, i.e. 7 days is used).
-* '''user_session_timeout''' - How long in seconds the user can stay logged in before they must re-log in. (Without a setting user session nevr times out.  With a setting <code>user_inactivity_timeout</code> probably will to be reduced to a considerably shorter period of time to this).
+* '''user_session_timeout''' - How long in seconds the user can stay logged in before they must re-log in. (Without a setting user session never times out.  With a setting <code>user_inactivity_timeout</code> probably will to be reduced to a considerably shorter period of time to this).
 == V ==

@@ Line 129: / Line 129: @@
 == T ==
-* '''theme''' - Rather than having to define templates, CSS and JavaScript branding just for the archive, use the files under the defined theme subdirectory (e.g. <code>lib/theme/</code>, <code>archives/ARCHIVE_ID/cfg/theme/</code> or a theme sub-directory for paths lists in flavour's inc file).  (Without a setting no theme will be used).
+* '''theme''' - Rather than having to define templates, CSS and JavaScript branding just for the archive, use the files under the defined theme subdirectory (e.g. <code>lib/theme/</code>, <code>archives/ARCHIVE_ID/cfg/theme/</code> or a theme sub-directory for paths listed in flavour's inc file).  (Without a setting no theme will be used).
 * '''<font style="color: red;">thumbnail_types</font>''' - Allows a function to be define to add extra thumbnail types that should be generated for a document.  <font style="color: red;">This is a legacy option.  <code>EP_TRIGGER_THUMBNAIL_TYPES</code> [[Triggers|trigger function]] should be used instead.</font>

@@ Line 123: / Line 123: @@
 == S ==
 * '''saved_search_additional_recipients''' - Comma separated list of emails addresses that should additionally be included in saved search emails.  (Without a setting no additional recipients will be added to saved search emails).
-* '''saved_search_citation''' - <code>eprint</code> citation to use for items listed in saved search emails.
+* '''saved_search_citation''' - <code>eprint</code> citation format to use for items listed in saved search emails.  (Without a set the default eprint citation format will be used).
-* '''signup_style''' - The introductory message to show on the signup page.  (Without a setting the default introductory message is used.  If set to <code>minimal</code> then the minimal introductory message is used.  Typically this setting is only useful if <code>default_user_type</code> is also set to <code>minuser</code>).
+* '''signup_style''' - The introductory message to show on the sign up page.  (Without a setting the default introductory message is used.  If set to <code>minimal</code> then the minimal introductory message is used.  Typically using this setting is only useful if <code>default_user_type</code> is also set to <code>minuser</code>).
-* '''skip_validation''' - Allows a bespoke function to be defined to determine if an eprint is allowed to skip validation. This may be useful for imported records that had different validation rules (Without a setting no eprints are allowed to skip validation).
+* '''skip_validation''' - Allows a bespoke function to be defined to determine if an eprint is allowed to skip validation. This may be useful for imported records that had different validation rules (Without a setting, no eprints are allowed to skip validation).
-* '''STAFF_ONLY_LOCAL_callback''' - Allows a function to be defined to test of current user is a local staff (editor/admin) user to set <code>STAFF_ONLY_LOCAL</code> for use in workflows.  (Without setting <code>STAFF_ONLY_LOCAL</code> will be set to <code>0</code>).
+* '''STAFF_ONLY_LOCAL_callback''' - Allows a function to be defined to test of current user is a local staff (editor/admin) user to set <code>STAFF_ONLY_LOCAL</code> for use in workflows.  (Without setting <code>STAFF_ONLY_LOCAL</code> will be set to <code>0</code>, i.e. current user is not local staff).
 == T ==

@@ Line 90: / Line 90: @@
 *** '''sample_identifier''' - An example of an identifier used by OAI-PMH for individual records.  (Without a setting no sample identifier is shown on OAI-PMH pages).
 * '''<font style="color: red;">on_files_modified</font>''' - Allows a function to be defined that is called when a <code>FilesModified</code> indexer task runs.  <font style="color: red;">This is a legacy function.  <code>EP_TRIGGER_FILES_MODIFIED</code> [[Triggers|trigger function]] should be used instead.</font>
-* '''<font style="color: red;">on_generate_thumbnails</font>''' - Allows a function to be defined that is called when a <code>FilesModified</code> indexer task runs which includes generating thumbnails.  This may be useful if a special type of thumbnail file is required but cannot be defined with existing configuration for thumbnail types. (Now use a <code>EP_TRIGGER_THUMBNAIL_TYPES</code> [[Triggers|trigger function]] instead).
+* '''<font style="color: red;">on_generate_thumbnails</font>''' - Allows a function to be defined that is called when a <code>FilesModified</code> indexer task runs which includes generating thumbnails.  This may be useful if a special type of thumbnail file is required but cannot be defined with existing configuration for thumbnail types.  <font style="color: red;">This is a legacy function.  <code>EP_TRIGGER_THUMBNAIL_TYPES</code> [[Triggers|trigger function]] instead</font>.
 * '''on_logout''' - Allows a bespoke function to be defined to carry out certain actions before a user is logged out.  (Without a setting no additional actions are performed).
 * '''order_auto_submit''' - Whether changing the ordering for search results will automatically reload the page.  (Without a setting search results pages will not automatically be reloaded on ordering change).

@@ Line 87: / Line 87: @@
 * '''oai'''
 ** '''v2'''
-*** '''output_plugins''' - Hash referernce of Additional export plugins that can be used with OAI-PMH.  (Without a setting just those that have an <code>xmlns</code> set, provide export for the appropriate dataset (typically eprint) and are at least visible to <code>staff</code>).
+*** '''output_plugins''' - Hash reference of additional export plugins that can be used with OAI-PMH.  (Without a setting just those that have an <code>xmlns</code> set, provide export for the appropriate dataset (typically <code>eprint</code>) and are at least visible to <code>staff</code>).
 *** '''sample_identifier''' - An example of an identifier used by OAI-PMH for individual records.  (Without a setting no sample identifier is shown on OAI-PMH pages).
-* '''<font style="color: red;">on_files_modified</font>''' - Allows a function to be defined that is called when a files modified indexer task runs.  <font style="color: red;">This is a legacy function.  <code>EP_TRIGGER_FILES_MODIFIED</code> [[Triggers|trigger function]] should be used instead.</font>
+* '''<font style="color: red;">on_files_modified</font>''' - Allows a function to be defined that is called when a <code>FilesModified</code> indexer task runs.  <font style="color: red;">This is a legacy function.  <code>EP_TRIGGER_FILES_MODIFIED</code> [[Triggers|trigger function]] should be used instead.</font>
-* '''on_generate_thumbnails''' - Allows a function to be defined that is called when a generate thumbnails indexer task runs.  This may be useful if a special type of thumbnail file is required but cannot be defined with existing configuration for thumbnail types (now using an <code>EP_TRIGGER_THUMBNAIL_TYPES</code> [[Triggers|trigger function]]).
+* '''<font style="color: red;">on_generate_thumbnails</font>''' - Allows a function to be defined that is called when a <code>FilesModified</code> indexer task runs which includes generating thumbnails.  This may be useful if a special type of thumbnail file is required but cannot be defined with existing configuration for thumbnail types. (Now use a <code>EP_TRIGGER_THUMBNAIL_TYPES</code> [[Triggers|trigger function]] instead).
 * '''on_logout''' - Allows a bespoke function to be defined to carry out certain actions before a user is logged out.  (Without a setting no additional actions are performed).
 * '''order_auto_submit''' - Whether changing the ordering for search results will automatically reload the page.  (Without a setting search results pages will not automatically be reloaded on ordering change).