Config Options by File

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 of the config files have full lists of settings with descriptions and other configuration files have yet to be added.

0-9

00_version.pl

version_long - The long version name of EPrints (e.g. EPrints 3.4.5).
version_alias - The alias/codename for the core EPrints release version (e.g. Smoothie Squall).
vendor_long - The long name of the vendor responsible for the EPrints software release (e.g. EPrints Services).
vendor_short - The short name / abbreviation of the vendor responsible for the EPrints software release (e.g. eps).
version_description - A fully description of the EPrints software version using above version/vendor settings.

10_core.pl

aliases - Other hostnames for the repository archive and whether they should redirect to the primary hostname.
host - The primary hostname of the repository archive on HTTP.
port - The TCP port number to connect to the repository archiver over HTTP. (Typically 80).
securehost - The primary hostname of the repository archive on HTTPS. Normally the same as host, so typically can be a reference.
secureport - The TCP port number to connect to the repository archiver over HTTPS. (Typically 443).
http_root - Where the repository archive will be hosted. (Typically undefined).

20_baseurls.pl

base_url - URL including protocol and hostname, used as a basis whenever a full URL for a specific location needs to be generated.
perl_url - URL including protocol and hostname, used as a basis whenever a full URL for a specific CGI script needs to be generated.
use_long_url_format - Use long URLs for abstract pages / documents (e.g. /id/eprint/1234 or /id/eprint/1234/1/paper.pdf rather than /1234 or /1234/1/paper.pdf. Will redirect from short to long URL rather than the long to short. (Default is 0 to not use long URLs).

A

adminemail.pl

adminemail - The email address for the administrator of the repository archive. Will be displayed in contact page and default address email will be sent to and from.
sendermail - Alternative email address to send email for the repository archive from. Useful if restrictions on where email can be sent from for the domain of the adminemail address. Will still set adminemail in reply-to.

B

branding.pl

site_logo - Default logo to use for the site. Probably only useful if using default template for EPrints.

build_attributes.pl

build_node_attributes - Defines function for manipulating attributes that can be called by EPrints::XML::create_element.

C

citation_default.pl

citation_default
- document
  - for_summary_page - The default document citation to use when rendering a document of an abstract/summary page.
- eprint
  - export - The default eprint citation to use with export plugins.
  - for_issue - The default eprint citation to use when rendering an issue.
  - for_result - The default eprint citation to use when rendering a set of eprint search results.
  - for_summary_page - The default eprint citation to use when rendering a eprint of an abstract/summary page.

citationcaches.pl

datasets
- citationcache - Defines dataset configuration for EPrints::DataObj::CitationCache.
citation_caching
- enabled - Whether citation caching is enabled. (Default is 0, i.e. not enabled).
- excluded_dataobjs - Data objects that should not cache citations because they are dynamic/context dependent. (Default [ 'epm', 'loginticket', 'subject']).
- excluded_style - Citation styles that should not be cache because they are dynamic/context dependent. (Default [ 'result' ]).

csrf_protection.pl

csrf_token_salt - A salt to ensure generated CSRF tokens are not guessable.

D

database.pl

dbhost - The hostname or IP address where the database for the repository archive is hosted. (Typically localhost).
dbname - The name of the database where the repository archive is hosted. (Typically the same as the archive's ID).
dbpass - The password to connect to the database where the repository archive is hosted. (Typically automatically generated 16 character string).
dbuser - The username to connect to the database where the repository archive is hosted. (Often the same as the archive's ID).
dbengine - The database table engine to use when creating new tables in the database where the repository archive is hosted. (Default is InnoDB, previously has been MyISAM).

datasets.pl

datasets - Initialises hash reference (if not already) so other configuration files can add bespoke datasets.

doc_rewrite.pl

Adds an EP_TRIGGER_DOC_URL_REWRITE trigger to handle relation-based document redirects.

document_fields_automatic.pl

set_document_automatic_fields - A function that updates specified fields for a document when its data object is committed. By default no fields are updated.

document_fields_default.pl

set_document_defaults -

document_fields.pl

TO BE ADDED

document_upload.pl

diskspace_error_threshold -
diskspace_warn_threshold -
guess_doc_type -
on_files_modified -
required_formats -

document_validate.pl

validate_document -

dynamic_template.pl

Dynamic Pins

E

element_classes.pl

TO BE ADDED

email.pl

send_email -

eprint_fields_automatic.pl

set_eprint_automatic_fields -

eprint_fields_common.pl

TO BE ADDED

eprint_fields_default.pl

set_eprint_defaults -

eprint_fields.pl

fields -

eprint_fields_pub.pl

TO BE ADDED

eprint_locking.pl

TO BE ADDED

eprint_render.pl

eprint_render -

eprint_search_advanced.pl

TO BE ADDED

eprint_search_simple.pl

TO BE ADDED

eprint_search_staff.pl

TO BE ADDED

eprint_validate.pl

validate_eprint -

eprint_warnings.pl

eprint_warnings -

exports.pl

TO BE ADDED

F

field_property_defaults.pl

field_defaults -

field_validate.pl

validate_field -

flavour_info.pl

TO BE ADDED

G

H

I

indexing.pl

extract_words -
index -
indexing -

issues_search.pl

TO BE ADDED

J

K

L

languages.pl

defaultlanguage -
languages -

latest_tool.pl

TO BE ADDED

limit_names_shown.pl

TO BE ADDED

log.pl

log -
loghandler -

M

make_orderkey.pl

TO BE ADDED

media_info.pl

TO BE ADDED

mime_types.pl

TO BE ADDED

misc.pl

allow_user_removal_request -
cache_maxlife -
cache_timeout -
cookie_auth -
cookie_domain -
disable_userinfo -
pin_timeout -
skip_buffer -
use_mimetex -

N

O

oai.pl

oai -

optional_filename_sanitise.pl

TO BE ADDED

P

paths.pl

config_path -
documents_path -
htdocs_path -

plugins.pl

TO BE ADDED

private_ips.pl

TO BE ADDED

Q

R

rdf_license.pl

TO BE ADDED

rdf_triples_bibo.pl

TO BE ADDED

rdf_triples_eprints.pl

TO BE ADDED

rdf_triples_formats.pl

TO BE ADDED

rdf_triples_general.pl

TO BE ADDED

rdf_triples_repository.pl

TO BE ADDED

rdf_triples_skos.pl

TO BE ADDED

rdf_triples_bibo.pl

TO BE ADDED

rdf_uris.pl

TO BE ADDED

registration.pl

allow_reset_password -
allow_web_signup -
default_user_type -
signup_style -
user_registration_fields -

render_paras.pl

TO BE ADDED

request_copy.pl

email_for_doc_request -

restrict_paths.pl

TO BE ADDED

rewrite_url_demo.pl

TO BE ADDED

S

search.pl

editor_limit_fields -
issues_search -
latest_citation -
latest_tool_modes -
match_start_of_name -
search -

search_xapian.pl

TO BE ADDED

security.pl

can_request_view_document -
can_user_view_document -

session.pl

session_close -
session_init -

sword.pl

sword -

signposting.pl

TO BE ADDED

template_core.pl

TO BE ADDED

template_edit_phrases.pl

TO BE ADDED

template_legacy.pl

TO BE ADDED

template_leinks.pl

TO BE ADDED

U

upload.pl

TO BE ADDED

urls.pl

frontpage -
rewrite_exceptions
userhome -

user_auth_limits.pl

TO BE ADDED

user_fields_automatic.pl

set_user_automatic_fields -

user_fields_default.pl

set_user_defaults -

user_fields.pl

fields -

user_render.pl

user_render -

user_review_scope.pl

TO BE ADDED

user_roles.pl

user_roles -

user_search.pl

TO BE ADDED

user_validate.pl

validate_user -

V

views.pl

browse_views -

views_render_items_example.pl

TO BE ADDED

views_render_menu_example.pl

TO BE ADDED

vlit.pl

vlit -

W

X

Y

y_export_privacy.pl

TO BE ADDED

Z

zz_version.pl

version_description -