Difference between revisions of "Config Options by File"
(→dynamic_template.pl) |
(Reformatted. Added some descriptions. Added some extra config files (still some to add and fill out).) |
||
| Line 1: | Line 1: | ||
[[Category:Manual]] | [[Category:Manual]] | ||
| + | == 00_version.pl == | ||
| + | * '''version_long''' - The long version name of EPrints (e.g. <code>EPrints 3.4.5</code>). | ||
| + | * '''version_alias''' - The alias/codename for the core EPrints release version (e.g. <code>Smoothie Squall</code>). | ||
| + | * '''vendor_long''' - The long name of the vendor responsible for the EPrints software release (e.g. <code>EPrints Services</code>). | ||
| + | * '''vendor_short''' - The short name / abbreviation of the vendor responsible for the EPrints software release (e.g. <code>eps</code>). | ||
| + | * '''version_description''' - A fully description of the EPrints software version using above version/vendor settings. | ||
== 10_core.pl == | == 10_core.pl == | ||
| − | * aliases | + | * '''aliases''' - Other hostnames for the repository archive and whether they should redirect to the primary hostname. |
| − | * host | + | * '''host''' - The primary hostname of the repository archive on HTTP. |
| − | * port | + | * '''port''' - The TCP port number to connect to the repository archiver over HTTP. (Typically <code>80</code>). |
| − | * securehost | + | * '''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 <code>443</code>). |
| + | * '''http_root''' - Where the repository archive will be hosted. (Typically undefined). | ||
| + | |||
== 20_baseurls.pl == | == 20_baseurls.pl == | ||
| − | * base_url | + | * '''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 | + | * '''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. <code>/id/eprint/1234</code> or <code>/id/eprint/1234/1/paper.pdf</code> rather than <code>/1234</code> or <code>/1234/1/paper.pdf</code>. Will redirect from short to long URL rather than the long to short. (Default is <code>0</code> to not use long URLs). |
| + | |||
== adminemail.pl == | == adminemail.pl == | ||
| − | * adminemail | + | * '''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. | ||
| + | |||
== branding.pl == | == branding.pl == | ||
| − | * site_logo | + | * '''site_logo''' - Default logo to use for the site. Probably only useful if using default template for EPrints. |
| + | |||
| + | == build_attributes.pl == | ||
| + | ''TO BE ADDED'' | ||
| + | |||
| + | == citation_default.pl == | ||
| + | ''TO BE ADDED'' | ||
| + | |||
== database.pl == | == database.pl == | ||
| − | * dbhost | + | * '''dbhost''' - The hostname or IP address where the database for the repository archive is hosted. (Typically <code>localhost</code>). |
| − | * dbname | + | * '''dbname''' - The name of the database where the repository archive is hosted. (Typically the same as the archive's ID). |
| − | * dbpass | + | * '''dbpass''' - The password to connect to the database where the repository archive is hosted. (Typically automatically generated 16 character string). |
| − | * dbuser | + | * '''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 <code>InnoDB</code>, previously has been <code>MyISAM</code>). | ||
| + | |||
| + | == datasets.pl == | ||
| + | ''TO BE ADDED'' | ||
| + | |||
| + | == doc_rewrite.pl == | ||
| + | ''TO BE ADDED'' | ||
| + | |||
| + | |||
== document_fields_automatic.pl == | == document_fields_automatic.pl == | ||
| − | * set_document_automatic_fields | + | * '''set_document_automatic_fields''' - |
| + | |||
== document_fields_default.pl == | == document_fields_default.pl == | ||
| − | * set_document_defaults | + | * '''set_document_defaults''' - |
| + | |||
== document_upload.pl == | == document_upload.pl == | ||
| − | * diskspace_error_threshold | + | * '''diskspace_error_threshold''' - |
| − | * diskspace_warn_threshold | + | * '''diskspace_warn_threshold''' - |
| − | * guess_doc_type | + | * '''guess_doc_type''' - |
| − | * on_files_modified | + | * '''on_files_modified''' - |
| − | * required_formats | + | * '''required_formats''' - |
| + | |||
== document_validate.pl == | == document_validate.pl == | ||
| − | * validate_document | + | * '''validate_document''' - |
| + | |||
== dynamic_template.pl == | == dynamic_template.pl == | ||
*[[API:EPrints/Apache/Template#Dynamic_Pins|Dynamic Pins]] | *[[API:EPrints/Apache/Template#Dynamic_Pins|Dynamic Pins]] | ||
== email.pl == | == email.pl == | ||
| − | * send_email | + | * '''send_email''' - |
| + | |||
== eprint_fields.pl == | == eprint_fields.pl == | ||
| − | * fields | + | * '''fields''' - |
| + | |||
== eprint_fields_automatic.pl == | == eprint_fields_automatic.pl == | ||
| − | * set_eprint_automatic_fields | + | * '''set_eprint_automatic_fields''' - |
| + | |||
== eprint_fields_default.pl == | == eprint_fields_default.pl == | ||
| − | * set_eprint_defaults | + | * '''set_eprint_defaults''' - |
| + | |||
== eprint_render.pl == | == eprint_render.pl == | ||
| − | * eprint_render | + | * '''eprint_render''' - |
| + | |||
== eprint_validate.pl == | == eprint_validate.pl == | ||
| − | * validate_eprint | + | * '''validate_eprint''' - |
| + | |||
== eprint_warnings.pl == | == eprint_warnings.pl == | ||
| − | * eprint_warnings | + | * '''eprint_warnings''' - |
| + | |||
== field_property_defaults.pl == | == field_property_defaults.pl == | ||
| − | * field_defaults | + | * '''field_defaults''' - |
| + | |||
== field_validate.pl == | == field_validate.pl == | ||
| − | * validate_field | + | * '''validate_field''' - |
| + | |||
== indexing.pl == | == indexing.pl == | ||
| − | * extract_words | + | * '''extract_words''' - |
| − | * index | + | * '''index''' - |
| − | * indexing | + | * '''indexing''' - |
| + | |||
== languages.pl == | == languages.pl == | ||
| − | * defaultlanguage | + | * '''defaultlanguage''' - |
| − | * languages | + | * '''languages''' - |
| + | |||
== log.pl == | == log.pl == | ||
| − | * log | + | * '''log''' - |
| − | * loghandler | + | * '''loghandler''' - |
| + | |||
== misc.pl == | == misc.pl == | ||
| − | * allow_user_removal_request | + | * '''allow_user_removal_request''' - |
| − | * cache_maxlife | + | * '''cache_maxlife''' - |
| − | * cache_timeout | + | * '''cache_timeout''' - |
| − | * cookie_auth | + | * '''cookie_auth''' - |
| − | * cookie_domain | + | * '''cookie_domain''' - |
| − | * disable_userinfo | + | * '''disable_userinfo''' - |
| − | * pin_timeout | + | * '''pin_timeout''' - |
| − | * skip_buffer | + | * '''skip_buffer''' - |
| − | * use_mimetex | + | * '''use_mimetex''' - |
| + | |||
== oai.pl == | == oai.pl == | ||
| − | * oai | + | * '''oai''' - |
| + | |||
== paths.pl == | == paths.pl == | ||
| − | * config_path | + | * '''config_path''' - |
| − | * documents_path | + | * '''documents_path''' - |
| − | * htdocs_path | + | * '''htdocs_path''' - |
| + | |||
== registration.pl == | == registration.pl == | ||
| − | * allow_reset_password | + | * '''allow_reset_password''' - |
| − | * allow_web_signup | + | * '''allow_web_signup''' - |
| − | * default_user_type | + | * '''default_user_type''' - |
| − | * signup_style | + | * '''signup_style''' - |
| − | * user_registration_fields | + | * '''user_registration_fields''' - |
| + | |||
== request_copy.pl == | == request_copy.pl == | ||
| − | * email_for_doc_request | + | * '''email_for_doc_request''' - |
| + | |||
== search.pl == | == search.pl == | ||
| − | * editor_limit_fields | + | * '''editor_limit_fields''' - |
| − | * issues_search | + | * '''issues_search''' - |
| − | * latest_citation | + | * '''latest_citation''' - |
| − | * latest_tool_modes | + | * '''latest_tool_modes''' - |
| − | * match_start_of_name | + | * '''match_start_of_name''' - |
| − | * search | + | * '''search''' - |
| + | |||
== security.pl == | == security.pl == | ||
| − | * can_request_view_document | + | * '''can_request_view_document''' - |
| − | * can_user_view_document | + | * '''can_user_view_document''' - |
| + | |||
== session.pl == | == session.pl == | ||
| − | * session_close | + | * '''session_close''' - |
| − | * session_init | + | * '''session_init''' - |
| + | |||
== sword.pl == | == sword.pl == | ||
| − | * sword | + | * '''sword''' - |
| + | |||
== urls.pl == | == urls.pl == | ||
| − | * frontpage | + | * '''frontpage''' - |
| − | * rewrite_exceptions | + | * '''rewrite_exceptions''' |
| − | * userhome | + | * '''userhome''' - |
| + | |||
== user_fields.pl == | == user_fields.pl == | ||
| − | * fields | + | * '''fields''' - |
| + | |||
== user_fields_automatic.pl == | == user_fields_automatic.pl == | ||
| − | * set_user_automatic_fields | + | * '''set_user_automatic_fields''' - |
| + | |||
== user_fields_default.pl == | == user_fields_default.pl == | ||
| − | * set_user_defaults | + | * '''set_user_defaults''' - |
| + | |||
== user_render.pl == | == user_render.pl == | ||
| − | * user_render | + | * '''user_render''' - |
| + | |||
== user_roles.pl == | == user_roles.pl == | ||
| − | * user_roles | + | * '''user_roles''' - |
| + | |||
== user_validate.pl == | == user_validate.pl == | ||
| − | * validate_user | + | * '''validate_user''' - |
| + | |||
== views.pl == | == views.pl == | ||
| − | * browse_views | + | * '''browse_views''' - |
| + | |||
== vlit.pl == | == vlit.pl == | ||
| − | * vlit | + | * '''vlit''' - |
Revision as of 11:23, 9 July 2024
Contents
- 1 00_version.pl
- 2 10_core.pl
- 3 20_baseurls.pl
- 4 adminemail.pl
- 5 branding.pl
- 6 build_attributes.pl
- 7 citation_default.pl
- 8 database.pl
- 9 datasets.pl
- 10 doc_rewrite.pl
- 11 document_fields_automatic.pl
- 12 document_fields_default.pl
- 13 document_upload.pl
- 14 document_validate.pl
- 15 dynamic_template.pl
- 16 email.pl
- 17 eprint_fields.pl
- 18 eprint_fields_automatic.pl
- 19 eprint_fields_default.pl
- 20 eprint_render.pl
- 21 eprint_validate.pl
- 22 eprint_warnings.pl
- 23 field_property_defaults.pl
- 24 field_validate.pl
- 25 indexing.pl
- 26 languages.pl
- 27 log.pl
- 28 misc.pl
- 29 oai.pl
- 30 paths.pl
- 31 registration.pl
- 32 request_copy.pl
- 33 search.pl
- 34 security.pl
- 35 session.pl
- 36 sword.pl
- 37 urls.pl
- 38 user_fields.pl
- 39 user_fields_automatic.pl
- 40 user_fields_default.pl
- 41 user_render.pl
- 42 user_roles.pl
- 43 user_validate.pl
- 44 views.pl
- 45 vlit.pl
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/1234or/id/eprint/1234/1/paper.pdfrather than/1234or/1234/1/paper.pdf. Will redirect from short to long URL rather than the long to short. (Default is0to not use long URLs).
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.
branding.pl
- site_logo - Default logo to use for the site. Probably only useful if using default template for EPrints.
build_attributes.pl
TO BE ADDED
citation_default.pl
TO BE ADDED
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 beenMyISAM).
datasets.pl
TO BE ADDED
doc_rewrite.pl
TO BE ADDED
document_fields_automatic.pl
- set_document_automatic_fields -
document_fields_default.pl
- set_document_defaults -
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
email.pl
- send_email -
eprint_fields.pl
- fields -
eprint_fields_automatic.pl
- set_eprint_automatic_fields -
eprint_fields_default.pl
- set_eprint_defaults -
eprint_render.pl
- eprint_render -
eprint_validate.pl
- validate_eprint -
eprint_warnings.pl
- eprint_warnings -
field_property_defaults.pl
- field_defaults -
field_validate.pl
- validate_field -
indexing.pl
- extract_words -
- index -
- indexing -
languages.pl
- defaultlanguage -
- languages -
log.pl
- log -
- loghandler -
misc.pl
- allow_user_removal_request -
- cache_maxlife -
- cache_timeout -
- cookie_auth -
- cookie_domain -
- disable_userinfo -
- pin_timeout -
- skip_buffer -
- use_mimetex -
oai.pl
- oai -
paths.pl
- config_path -
- documents_path -
- htdocs_path -
registration.pl
- allow_reset_password -
- allow_web_signup -
- default_user_type -
- signup_style -
- user_registration_fields -
request_copy.pl
- email_for_doc_request -
search.pl
- editor_limit_fields -
- issues_search -
- latest_citation -
- latest_tool_modes -
- match_start_of_name -
- search -
security.pl
- can_request_view_document -
- can_user_view_document -
session.pl
- session_close -
- session_init -
sword.pl
- sword -
urls.pl
- frontpage -
- rewrite_exceptions
- userhome -
user_fields.pl
- fields -
user_fields_automatic.pl
- set_user_automatic_fields -
user_fields_default.pl
- set_user_defaults -
user_render.pl
- user_render -
user_roles.pl
- user_roles -
user_validate.pl
- validate_user -
views.pl
- browse_views -
vlit.pl
- vlit -
