Difference between revisions of "Miscellaneous Config Options"

From EPrints Documentation
Jump to: navigation, search
(Added placeholders for misc config options (not in config files))
(A)
Line 9: Line 9:
  
 
== A ==
 
== A ==
* '''access_logger_func''' -
+
* '''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''' -
+
* '''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''' -
+
* '''allow_duplicate_usernames''' - Whether the validation of <code>user</code> metadata should check for duplicate usernames.  (Without a setting user metadata validation will fail if duplicate usernames.  This should only bet set to <code>1</code> temporarily if username changes are required that may temporarily lead to duplicates).
* '''allow_uploaded_doc_js''' -
+
* '''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''' -  
+
* '''auth_basic''' - Deprecated configuration for configuring basic rather than cookie-based user authentication.
  
 
== B ==
 
== B ==

Revision as of 14:28, 19 July 2024

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

Warning.png

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 -

C

  • custom_handlers -

D

  • datacite_import
    • datemap -
    • date_priority -
    • typemap -
  • dbdriver -
  • dbschema -
  • default_export_plugin -
  • deps -
  • disable_basic_auth -
  • disable_make_open_access -
  • does_user_own_eprint -

E

  • email_blacklist -
  • enable_file_imports -
  • enable_import_fields -
  • enable_web_imports -
  • eprints_access_restrictions_callback -
  • expiry_for_doc_request -
  • expiry_for_unresponded_doc_request -
  • export_fieldlists -

F

  • file_local_path_function -

G

  • generic_filenames -
  • get_users_owned_eprints -

H

  • history_enable -

I

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

J

K

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 -

N

O

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

P

Q

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 -

X

Y

Z