Miscellaneous Config Options

0-9 | A | B | C | D | E | F | G | H | I | J | K | L | M | N | O | P | Q | R | S | T | U | V | W | X | Y | Z

Work in Progress
The page is a work in progress.

Only some config options that are not in files have been added. This list is not yet exhaustive

This page describes configuration options that do not appear in any specific configuration files present in the main codebase (inc. pub_lib flavour).

A

• access_logger_func - Defines a function that is called every time a documents is downloaded or abstract/summary page is viewed (i.e. an access record is created). This is used by recent versions of IRStats2, so it can process stats from a file-based access records rather than the database, which becomes a lot more efficient if the access database table is large.
• access_table_logger_disabled - Whether access records should still be saved to the database. (Without a setting database will continue to store access records).
• allow_duplicate_usernames - Whether the validation of user metadata should check for duplicate usernames. (Without a setting user metadata validation will fail if duplicate usernames. This should only bet set to 1 temporarily if username changes are required that may temporarily lead to duplicates).
• allow_uploaded_doc_js - A malevolent user could deliberately upload malicious JavaScript to perform a clickjacking or similar attack against logged in users. Should uploaded JavaScript only be returned with a Content Security Solicy (CSP) to prevent it from being run on the client web browser. (Without a setting CSP to prevent JavaScript running on the client is enabled).
• auth_basic - Deprecated configuration for configuring basic rather than cookie-based user authentication.

B

• browse_views_max_items - Global setting for the maximum number of results that can be displayed on a browse view listing page. Superseded if a particular view has a max_items attribute set. (Without a setting this defaults to 2000 items).

C

• custom_handlers - If you have a third-party application that needs to integrate with its own connector (e.g. Pure), then this allow you to define configuration for this.

D

• dbdriver - Which database driver (type of database, i.e. mysql, Pg or Oracle) to use. (Without a setting this defaults to mysql).
• dbschema - Which database schema to use. This is only applicable for Pg (PostGreSQL) databases.
• default_export_plugin - Which export plugin to pre-select on browse view and search results pages. (Without a setting, whichever export plugin appears first is pre-selected).
• deps - Defines dependencies of ingredients on other ingredients. By default this is not defined as no ingredients package in an EPrints release have any dependencies.
• disable_basic_auth - Ensure authentication cannot accidentally fallback to basic (rather than cookie-based) authentication. (Without a setting it could fallback but it is very unlikely to do this unless your EPrints repository has been significantly modified).
• disable_make_open_access - Remove the option on the Request Copy approval form to immediately make the document open access. (Without a setting the checkbox for this is present).
• does_user_own_eprint - Allows a function to augment what eprint records a user appears to own. This may be useful if a particular user is acting as a surrogate for another user.

E

• email_blacklist - Array reference containing a list of email addresses that are not allowed to make requests for copies. Can be useful if some individual is making excessive requests, although ReCaptcha is probably more useful (Without being defined no restriction on email addresses that can requests copies).
• enable_file_imports - Whether local files (for the importer) can be uploaded to the repository an part of an XML (e.g. EP3XML, Atom, etc.) import. (Without a setting they cannot be uploaded).
• enable_import_fields - Specify fields for a data object that can be imported even through their field definition says they can not.
• enable_web_imports - Whether web-based files can be uploaded to the repository an part of an XML (e.g. EP3XML, Atom, etc.) import. (Without a setting they cannot be uploaded).
• eprints_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 eprint record. Useful if you want to give access to certain eprint records without changing a user's type.
• expiry_for_doc_request - How many days an approved request copy link will last before access will be revoked. (Without a setting this is 7 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 90 days, approx. 3 months).
• export_fieldlists - What fields can exported for a data object. Further restricts field definition settings for export_as_xml. (Without a setting, what fields can be exported are only defined by their field definitions).

F

• file_local_path_function - Allows function to be defined to modify the location where the file represented by the file data object can be found on the local filesystem. Could be used if a bespoke new type of data object that has associated files need to be added.

G

• generic_filenames - New (non-history) files will be added to the documents directory as <fileid>.bin rather than there actual filename. This can be useful if users are uploading files with names that use special characters that are not compatible with the filesystem or database encoding. EPrints will already allow existing files to be mannually changed to the <fileid>.bin to provide a simple fix for existing issues using special characters, which subsequently cannot be downloaded.
• get_users_owned_eprints -

H

• history_enable -

I

• ignore_login_ip -
• items_filters -
• items_filters_order -
• import_xml_permitted_tags -

L

• login_monitoring
  • enabled -
  • fields -
  • function -
• login_required_for_cgi -
• login_required_for_eprints -
• login_required_for_views -
• login_required_url -

M

• max_history_width -

O

• oai
  • v2
    • output_plugins -
    • sample_identifier -
• order_auto_submit -

R

• recaptcha
  • ignore_countries -
  • private_key -
  • public_key -
  • 'timeout -
• recaptcha3
  • ignore_countries -
  • min_score -
  • private_key -
  • public_key -
  • 'timeout -
• request_copy_cc -
• required_formats -
• retain_embargo_dates -
• rewrite_exceptions -
• robotstxt
  • crawl_delay
    • default_seconds -
    • seconds -
    • user_agents -

S

• saved_search_additional_recipients -
• saved_search_citation -
• signup_style -
• STAFF_ONLY_LOCAL_callback -

T

• theme -

U

• user_access_restrictions_callback -
• user_area_template -
• user_cookie_timeout -
• user_inactivity_timeout -
• user_session_timeout -

V

• version_extra -
• view_sort_function -
• virtualhost -

W

• workflow_datepicker -