Editing Config Options by File (section)

== U ==

=== [[upload.pl]] ===
* '''max_upload_filesize''' - Maximum size of a file that can be uploaded to EPrints.  This gets set in both Apache (HTTP and HTTPS) configuration and <code>99_uploadmethod_file_max_size.js</code> under the archive's <code>cfg/static/javascript/auto/</code> directory, when the <code>generate_apacheconf</code> is run.  (By default <code>1 * 1024 * 1024 * 1024</code>, i.e. 1 GiB).

=== [[user_auth_limits.pl]] ===
* '''max_login_attempts''' - The maximum number of failed login attempts before an account is temporarily locked.  (Default is <code>10</code> failed login attempts).
* '''lockout_minutes''' - The number of minutes an account is locked out if there have been too many failed login attempts.  (Default is <code>10</code> minutes the account is locked out).
* '''reset_request_recent_hours''' - How many hours between a user being able to request password reset links. (Default is <code>24</code> hours between reset password emails to avoid users being spammed incessantly, if reset password misused).
* '''max_account_requests''' - The maximum number of new user accounts can be requested (through <code>/cgi/register</code> in <code>max_account_requests_minutes</code>.  (Default is <code>100</code> user accounts.  This is quite high, as you may get a lot of people all trying to sign up at once if a mass email is sent round to an organisation asking everyone to sign up).
* '''max_account_requests_minutes''' - The size of the window in minutes to check if <code>max_account_requests has been exceeded</code>.  (By default <code>60</code> minutes, 1 hour).
* '''password_maxlength''' - Sounds counter-intuitive but really long passwords can take a long time and a lot of resources to hash.  So a limit prevents such a DoS attack. (By default <code>200</code> characters).
Also adds a [[Triggers#EP_TRIGGER_VALIDATE_FIELD|<code>EP_TRIGGER_VALIDATE_FIELD</code> trigger function]] to validate that the length of the password submitted is not too long.
* '''login_monitoring'''
** '''enabled''' - Whether monitoring of logins (both failed and successful) are logged to archive's <code>var/login_attempts/</code> directory in CSV format.  (By default <code>1</code>, i.e. enabled).
** '''fields''' - Array reference of field names to include at start of file as column headers.  (Commented out by default and only needed if <code>function</code> is also defined.  The commented out fields: <code>timestamp, username, password_length,ip_address, user_agent, target, login_status, userid, securecode</code> are the same as those hard-coded).
** '''function''' - Defines a function for generating a bespoke log message (CSV line) for a login attempt. (Commented out by default but function is the same as what is hard-coded).

=== [[user_fields_automatic.pl]] ===
* '''set_user_automatic_fields''' -  What fields to automatically update when an <code>user</code> data object record is committed.  (By default <code>frequency</code> (to receive emails for editor alerts/saved searches) is set to <code>never</code> if not already set).

=== [[user_fields_default.pl]] ===
* '''set_user_defaults''' - Sets default values for fields when <code>user</code> data object is created.  (By default <code>hideemail</code> is set to the string <code>TRUE</code>, <code>item_fields</code> is set to <code>[ "lastmod", "title", "type", "eprint_status" ]</code> and <code>review_fields</code> is set to <code>[ "status_changed", "title", "type", "userid" ]</code>.

=== [[user_fields.pl]] ===
* '''fields'''
** '''user''' - Adds the following extra fields to <code>user</code> data object: <code>name, dept, org, address, country, hideemail, url</code>.

=== [[user_render.pl]] ===
* '''user_render''' - Defines a function that specifies how to display a user's metadata on their profile page.

=== [[user_review_scope.pl]] ===
* '''editor_limit_fields''' - Specifies an array reference of <code>eprint</code> metadata fields that are presented when an <code>admin</code> user is configuring what items an <code>editor</code> user can see to review.  (By default for zero this is <code>subjects</code> and <code>type</code>.  For pub_lib, <code>divisions</code> is also included).

=== [[user_roles.pl]] ===
* '''user_roles''' 
** '''user''' - Permitted actions for a regular user, i.e <code>usertype</code> of <code>user</code>.  (By default: <code>general, edit-own-record, saved-searches, set-password, deposit, change-email</code>).
** '''editor''' - Permitted actions for a editor user, i.e <code>usertype</code> of <code>editor</code>.  (By default: <code>general, edit-own-record, saved-searches, set-password, deposit, change-email, editor, view-status, staff-view</code>).
** '''admin''' - Permitted actions for a admin user, i.e <code>usertype</code> of <code>editor</code>.  (By default: <code>general, edit-own-record, saved-searches, set-password, deposit, change-email, editor, view-status, staff-view, admin edit-config</code>).
** '''min_user''' - Permitted actions for a minimal user, i.e <code>usertype</code> of <code>minuser</code>.  (By default: <code>general, edit-own-record, saved-searches, set-password, lock-username-to-email</code>).
* '''public_roles''' - Permitted actions for all users including those not logged in. (By default: <code>+eprint/archive/rest/get, +subject/rest/get</code>).
* '''roles''' - Allows extra roles to be added together that collate a set of permissions.  Sometimes referred to as "hats".  (By default this is not defined but there is a commented out example for <code>approve-hat</code>).

=== [[user_search.pl]] ===
* '''search'''
** '''user''' - The configuration for the search for <code>user</code> data objects.
*** '''search_fields''' - Array reference of <code>meta_fields</code> to include in the user search form. (Defaults are: <code>name, username, userid, dept, org, address, country, usertype, email</code>).
*** '''citation''' - The <code>user</code> citation style to use for search results. (Default: <code>result</code>).
*** '''page_size''' - How many results to display per page. (Default: <code>20</code>).
*** '''order_methods''' - Different ways or ordering search results (Defaults are: <code>byname, byjoin, byrevjoin, bytype</code>).
*** '''default_order''' - Default order for search results (Default: <code>byname</code>).
*** '''show_zero_results''' - Whether to go to results page with no results or say on search form page. (Default: <code>1</code>, i.e. go to search results page).

=== [[user_validate.pl]] ===
* '''validate_user''' - Defines a function to perform complex validations the metadata for a user data object. (<font style="color: red;">This option is deprecated.  Rather than adding validations to this configuration option, use a  [[Triggers#EP_TRIGGER_VALIDATE|<code>EP_TRIGGER_VALIDATE</code> dataset trigger function]] for the <code>user</code> dataset</font>).