Config Options by File - Revision history

Drn@ecs.soton.ac.uk: No longer a work in progress

2024-07-26T16:28:27Z

No longer a work in progress

← Older revision		Revision as of 16:28, 26 July 2024
Line 4:		Line 4:
	[[#0-9\|0-9]] \| [[#A\|A]] \| [[#B\|B]] \| [[#C\|C]] \| [[#D\|D]] \| [[#E\|E]] \| [[#F\|F]] \| [[#G\|G]] \| [[#H\|H]] \| [[#I\|I]] \| [[#J\|J]] \| [[#K\|K]] \| [[#L\|L]] \| [[#M\|M]] \| [[#N\|N]] \| [[#O\|O]] \| [[#P\|P]] \| [[#Q\|Q]] \| [[#R\|R]] \| [[#S\|S]] \| [[#T\|T]] \| [[#U\|U]] \| [[#V\|V]] \| [[#W\|W]] \| [[#X\|X]] \| [[#Y\|Y]] \| [[#Z\|Z]]		[[#0-9\|0-9]] \| [[#A\|A]] \| [[#B\|B]] \| [[#C\|C]] \| [[#D\|D]] \| [[#E\|E]] \| [[#F\|F]] \| [[#G\|G]] \| [[#H\|H]] \| [[#I\|I]] \| [[#J\|J]] \| [[#K\|K]] \| [[#L\|L]] \| [[#M\|M]] \| [[#N\|N]] \| [[#O\|O]] \| [[#P\|P]] \| [[#Q\|Q]] \| [[#R\|R]] \| [[#S\|S]] \| [[#T\|T]] \| [[#U\|U]] \| [[#V\|V]] \| [[#W\|W]] \| [[#X\|X]] \| [[#Y\|Y]] \| [[#Z\|Z]]
	</div>		</div>
	~~{{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.}}~~

	As well as options that exist in configuration files there are further [[Miscellaneous Config Options]].		As well as options that exist in configuration files there are further [[Miscellaneous Config Options]].

Drn@ecs.soton.ac.uk: /* vlit.pl */

2024-07-26T16:27:41Z

vlit.pl

← Older revision		Revision as of 16:27, 26 July 2024
Line 654:		Line 654:
	=== [[vlit.pl]] ===		=== [[vlit.pl]] ===
	* '''vlit'''		* '''vlit'''
	** '''enable''' - Whether vlit is enabled>. (By default <code>1</code>, vlit is enabled).		** '''enable''' - Whether vlit is enabled. (By default <code>1</code>, vlit is enabled).
	** '''copyright_url''' - The URL that points to a page that describes the copyright for vlit. (By default <code>/vlit.html</code>).		** '''copyright_url''' - The URL that points to a page that describes the copyright for vlit. (By default <code>/vlit.html</code>).

Drn@ecs.soton.ac.uk: /* user_validate.pl */

2024-07-26T16:26:49Z

user_validate.pl

← Older revision		Revision as of 16:26, 26 July 2024
Line 636:		Line 636:

	=== [[user_validate.pl]] ===		=== [[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 user dataset</font>).		* '''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>).

	== V ==		== V ==

Drn@ecs.soton.ac.uk: /* user_roles.pl */

2024-07-26T16:26:22Z

user_roles.pl

← Older revision		Revision as of 16:26, 26 July 2024
Line 618:		Line 618:
	=== [[user_roles.pl]] ===		=== [[user_roles.pl]] ===
	* '''user_roles'''		* '''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>.		** '''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>.		** '''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>.		** '''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>.		** '''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>).		* '''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>).		* '''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>).

Drn@ecs.soton.ac.uk: /* user_review_scope.pl */

2024-07-26T16:25:30Z

user_review_scope.pl

← Older revision		Revision as of 16:25, 26 July 2024
Line 614:		Line 614:

	=== [[user_review_scope.pl]] ===		=== [[user_review_scope.pl]] ===
	* '''editor_limit_fields''' - Specifies an array reference of eprint 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).		* '''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.pl]] ===

Drn@ecs.soton.ac.uk: /* user_render.pl */

2024-07-26T16:24:40Z

user_render.pl

← Older revision		Revision as of 16:24, 26 July 2024
Line 611:		Line 611:

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

	=== [[user_review_scope.pl]] ===		=== [[user_review_scope.pl]] ===

Drn@ecs.soton.ac.uk: /* user_auth_limits.pl */

2024-07-26T16:23:38Z

user_auth_limits.pl

Drn@ecs.soton.ac.uk: /* template_links.pl */

2024-07-26T16:19:43Z

template_links.pl

← Older revision		Revision as of 16:19, 26 July 2024
Line 580:		Line 580:

	=== [[template_links.pl]] ===		=== [[template_links.pl]] ===
	Just adds a [[Triggers#EP_TRIGGER_DYNAMIC_TEMPLATE\|<code>EP_TRIGGER_DYNAMIC_TEMPLATE</code> trigger function]] to add various <code><~~links~~></code>s to the <code><head></code> section of the dynamic template.		Just adds a [[Triggers#EP_TRIGGER_DYNAMIC_TEMPLATE\|<code>EP_TRIGGER_DYNAMIC_TEMPLATE</code> trigger function]] to add various <code><link></code>s to the <code><head></code> section of the dynamic template.

	== U ==		== U ==

Drn@ecs.soton.ac.uk: /* SystemSettings.pm */

2024-07-26T16:19:24Z

SystemSettings.pm

Drn@ecs.soton.ac.uk: /* invocations.pl */

2024-07-26T16:17:19Z

invocations.pl

← Older revision		Revision as of 16:17, 26 July 2024
Line 310:		Line 310:

	=== [[invocations.pl]] ===		=== [[invocations.pl]] ===
	* '''invocation''' - Invocations (i.e. command lines) of external applications on internal ~~script~~ used by EPrints (as defined in [[executables.pl]]). Includes the following invocations: <code>convert_crop_white, dvips, sendmail, html2text, latex, targz, antiwordpdf, pdftotext, zip, unzzip, cpall, wget, antiword, doc2txt, rmall, ffmpeg_i, ffmpeg_video_mp4, ffmpeg_video_ogg, ffmpeg_video_webm, ffmpeg_audio_mp4, ffmpeg_audio_off, ffmpeg_cell, unoconv, txt2refs, ffprobe, cal, ncal</code>.		* '''invocation''' - Invocations (i.e. command lines) of external applications on internal scripts used by EPrints (as defined in [[executables.pl]]). Includes the following invocations: <code>convert_crop_white, dvips, sendmail, html2text, latex, targz, antiwordpdf, pdftotext, zip, unzzip, cpall, wget, antiword, doc2txt, rmall, ffmpeg_i, ffmpeg_video_mp4, ffmpeg_video_ogg, ffmpeg_video_webm, ffmpeg_audio_mp4, ffmpeg_audio_off, ffmpeg_cell, unoconv, txt2refs, ffprobe, cal, ncal</code>.

	=== [[issues_search.pl]] ===		=== [[issues_search.pl]] ===

← Older revision		Revision as of 16:23, 26 July 2024
Line 589:		Line 589:
	=== [[user_auth_limits.pl]] ===		=== [[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).		* '''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 ~~and~~ account is locked out if there have been too many failed login attempts. (Default is <code>10</code> minutes the account is locked out).		* '''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 ~~when~~ a user ~~can~~ request password reset links. (Default is <code>24</code> hours between reset password emails to avoid users being spammed incessantly, if reset password misused).		* '''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 is a mass email is sent round to an organisation asking everyone to sign up).		* '''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).		* '''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 ~~password~~ 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).		* '''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.		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'''		* '''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).		** '''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).		** '''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 bespoke log message (CSV line) for a login attempt. (Commented out by default but function is the same as ~~that~~ is 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]] ===		=== [[user_fields_automatic.pl]] ===

← Older revision		Revision as of 16:19, 26 July 2024
Line 550:		Line 550:
	* '''show_ids_in_log''' - Whether to show repoistory archive ID is log messages. (By default <code>0</code> do not show archive ID in log messages).		* '''show_ids_in_log''' - Whether to show repoistory archive ID is log messages. (By default <code>0</code> do not show archive ID in log messages).
	* '''group''' - The Unix group to set when EPrints creates new files (By default <code>eprints</code>).		* '''group''' - The Unix group to set when EPrints creates new files (By default <code>eprints</code>).
	* '''version_history'''' - An array reference of version IDs that proceeded the current version.		* '''version_history''' - An array reference of version IDs that proceeded the current version.
	* '''smtp_server''' - The SMTP server to connect to for sending emails (By default <code>127.0.0.1</code>, i.e. localhost).		* '''smtp_server''' - The SMTP server to connect to for sending emails (By default <code>127.0.0.1</code>, i.e. localhost).
	* '''user''' - The Unix user to set when EPrints creates new files (By default <code>eprints</code>).		* '''user''' - The Unix user to set when EPrints creates new files (By default <code>eprints</code>).
	* '''file_perms''' The Unix permissions mask to use when EPrints creates new files. (By default <code>0664</code>).		* '''file_perms''' The Unix permissions mask to use when EPrints creates new files. (By default <code>0664</code>).
	* '''invocation''' - Invocation commands for external executables. (By default an empty hash reference, as populated by invocations.pl).		* '''invocation''' - Invocation commands for external executables and internal scripts. (By default an empty hash reference, as populated by [[invocations.pl]]).
	* '''executables''' - External executable paths. (By default a hash reference with one entry for <code>perl</code>. Further populated by executables.pl).		* '''executables''' - External executable and internal script paths. (By default a hash reference with one entry for <code>perl</code>. Further populated by [[executables.pl]]).
	* '''dir_perms''' - The Unix permissions mask to use when EPrints creates new ~~directores~~. (By default <code>02775</code>).		* '''dir_perms''' - The Unix permissions mask to use when EPrints creates new directories. (By default <code>02775</code>).
	* '''flavours''' - Flavours available for this EPrints installation. (By default <code>zero</code> plus any flavours found under the <code>flavours/</code> sub-directory).		* '''flavours''' - Flavours available for this EPrints installation. (By default <code>zero</code> plus any flavours found under the <code>flavours/</code> sub-directory).
	* '''perl_module_isolation''' - If running multiple archives should Perl modules be isolated between each archive. (By default <code>0</code> they should not be isolated, as this can severely affect performance).		* '''perl_module_isolation''' - If running multiple archives should Perl modules be isolated between each archive. (By default <code>0</code> they should not be isolated, as this can severely affect performance).
Line 565:		Line 565:
	** '''interval''' - How many seconds to wait between checking if there are any indexer tasks ready to be run. (By default <code>30</code> seconds to wait for any indexer tasks ready to be run).		** '''interval''' - How many seconds to wait between checking if there are any indexer tasks ready to be run. (By default <code>30</code> seconds to wait for any indexer tasks ready to be run).
	** '''respawn''' - How many seconds before the child process of the indexer should respawn, prompting the indexer log to be rotated. (By default <code>86400</code> seconds, i.e. 1 day).		** '''respawn''' - How many seconds before the child process of the indexer should respawn, prompting the indexer log to be rotated. (By default <code>86400</code> seconds, i.e. 1 day).
	** '''timeout''' - How many seconds ~~and~~ indexer should allow to complete a task before killing it. (By default <code>600</code> seconds, i.e. 10 minutes).		** '''timeout''' - How many seconds the indexer should allow to complete a task before killing it. (By default <code>600</code> seconds, i.e. 10 minutes).
	** '''interrupt''' - Should the indexer immediately break out of loop checking for indexer tasks (By default <code>0</code>, no it should not break out of loops. This is a ~~non-sensical~~ setting, as <code>1</code> would affectively disable the indexer whilst it kept running).		** '''interrupt''' - Should the indexer immediately break out of loop checking for indexer tasks (By default <code>0</code>, no it should not break out of loops. This is a nonsensical setting, as <code>1</code> would affectively disable the indexer whilst it kept running).

	== T ==		== T ==