diff --git a/config.TEMPLATE.inc.php b/config.TEMPLATE.inc.php index 63541738eb..0dfc2e8083 100644 --- a/config.TEMPLATE.inc.php +++ b/config.TEMPLATE.inc.php @@ -7,8 +7,8 @@ ; ; config.TEMPLATE.inc.php ; -; Copyright (c) 2014-2021 Simon Fraser University -; Copyright (c) 2003-2021 John Willinsky +; Copyright (c) 2014-2024 Simon Fraser University +; Copyright (c) 2003-2024 John Willinsky ; Distributed under the GNU GPL v3. For full terms see the file docs/COPYING. ; ; OPS Configuration settings. @@ -24,9 +24,9 @@ [general] -; An application specific key that is required for the app to run +; An application-specific key that is required for the app to run ; Internally this is used for any encryption (specifically cookie encryption if enabled) -app_key = +app_key = ; Set this to On once the system has been installed ; (This is generally done automatically by the installer) @@ -86,7 +86,7 @@ ; Example3: URLs that map to a subdomain. ; Example3: base_url[myOtherServer] = http://myOtherServer.example.com -; Generate RESTful URLs using mod_rewrite. This requires the +; Generate RESTful URLs using mod_rewrite. This requires the ; rewrite directive to be enabled in your .htaccess or httpd.conf. ; See FAQ for more details. restful_urls = Off @@ -95,21 +95,15 @@ ; See docs/README.md for more details. The list should be JSON-formatted. ; An empty string indicates that all hosts should be trusted (not recommended!) ; Example: -; allowed_hosts = '["myjournal.tld", "anotherjournal.tld", "mylibrary.tld"]' +; allowed_hosts = '["myserver.tld", "anotherserver.tld", "mylibrary.tld"]' allowed_hosts = '' ; Allow the X_FORWARDED_FOR header to override the REMOTE_ADDR as the source IP -; Set this to "On" if you are behind a reverse proxy and you control the X_FORWARDED_FOR +; Set this to "On" if you are behind a reverse proxy and you control the +; X_FORWARDED_FOR header. ; Warning: This defaults to "On" if unset for backwards compatibility. trust_x_forwarded_for = Off -; Set the maximum number of citation checking processes that may run in parallel. -; Too high a value can increase server load and lead to too many parallel outgoing -; requests to citation checking web services. Too low a value can lead to significantly -; slower citation checking performance. A reasonable value is probably between 3 -; and 10. The more your connection bandwidth allows the better. -citation_checking_max_processes = 3 - ; Display a message on the site admin and server manager user home pages if there is an upgrade available show_upgrade_warning = On @@ -127,10 +121,10 @@ ; as separate Privacy Statements for each server. sitewide_privacy_statement = Off -; The number of days a new user has to validate their account -; A new user account will be expired and removed if this many days have passed since the user registered -; their account, and they have not validated their account or logged in. If the user_validation_period is set to -; 0, unvalidated accounts will never be removed. Use this setting to automatically remove bot registrations. +; The number of days a new user has to validate their account. +; A new user account will be removed if this many days have passed since the user registered +; their account, and they have not validated their account or logged in. If set to 0, +; unvalidated accounts will never be removed. Use this setting to automatically remove bot registrations. user_validation_period = 28 ; Turn sandbox mode to On in order to prevent the software from interacting with outside systems. @@ -160,6 +154,7 @@ ; Enable database debug output (very verbose!) debug = Off + ;;;;;;;;;;;;;;;;;; ; Cache Settings ; ;;;;;;;;;;;;;;;;;; @@ -235,10 +230,6 @@ ; Permissions mask for created files and directories umask = 0022 -; The minimum percentage similarity between filenames that should be considered -; a possible revision -filename_revision_match = 70 - ;;;;;;;;;;;;;;;;;;;;;;;;;;;; ; Fileinfo (MIME) Settings ; @@ -254,12 +245,12 @@ [security] -; Specific cipher algorithm used to generate app key and encryption purpose -; Valid and available algorithms are `aes-128-cbc`, `aes-256-cbc`, `aes-128-gcm` and `aes-256-gcm` -; cipher = 'aes-256-cbc' +; Cipher algorithm used to generate the app key and encryption purpose +; Available options: aes-128-cbc, aes-128-gcm, aes-256-cbc, aes-256-gcm +; cipher = aes-256-cbc -; Define should the cookie at user's end need to be encrypted -; Enabling/Disabling will force all user to re-login +; Whether cookies will be encrypted. +; Changing this setting will log out all users. ; cookie_encryption = On ; Force SSL connections site-wide and also sets the "Secure" flag for session cookies @@ -270,8 +261,9 @@ force_login_ssl = Off ; This check will invalidate a session if the user's IP address changes. -; Enabling this option provides some amount of additional security, but may -; cause problems for users behind a proxy farm (e.g., AOL). +; Enabling this option provides some additional security, but may cause +; login problems for some users (e.g. if a user IP is changed frequently +; by a server or network configuration). session_check_ip = On ; The encryption (hashing) algorithm to use for encrypting user passwords @@ -301,6 +293,7 @@ ;N.b.: The implicit_auth parameter has been removed in favor of plugin implementations such as shibboleth + ;;;;;;;;;;;;;;;;;; ; Email Settings ; ;;;;;;;;;;;;;;;;;; @@ -363,7 +356,7 @@ ; If enabled, email addresses must be validated before login is possible. require_validation = Off -; Maximum number of days before an unvalidated account expires and is deleted +; The number of days a user has to validate their account before their access key expires. validation_timeout = 14 @@ -380,9 +373,6 @@ ; are fetched and merged to provide results for searches with several keywords. results_per_keyword = 500 -; The number of hours for which keyword search results are cached. -result_cache_hours = 1 - ; Paths to helper programs for indexing non-text files. ; Programs are assumed to output the converted text to stdout, and "%s" is ; replaced by the file argument. @@ -420,6 +410,7 @@ ; Maximum number of records per request to serve via OAI oai_max_records = 100 + ;;;;;;;;;;;;;;;;;;;;;; ; Interface Settings ; ;;;;;;;;;;;;;;;;;;;;;; @@ -457,6 +448,7 @@ ; Validate the hostname in the ReCaptcha response recaptcha_enforce_hostname = Off + ;;;;;;;;;;;;;;;;;;;;; ; External Commands ; ;;;;;;;;;;;;;;;;;;;;; @@ -465,12 +457,8 @@ ; These are paths to (optional) external binaries used in ; certain plug-ins or advanced program features. - ; Using full paths to the binaries is recommended. -; perl (used in paracite citation parser) -perl = /usr/bin/perl - ; tar (used in backup plugin, translation packaging) tar = /bin/tar @@ -482,6 +470,7 @@ ; /usr/bin/java -jar ~/java/xalan.jar -HTML -IN %xml -XSL %xsl xslt_command = "" + ;;;;;;;;;;;;;;;;;; ; Proxy Settings ; ;;;;;;;;;;;;;;;;;; @@ -513,11 +502,6 @@ ; Log web service request information for debugging log_web_service_info = Off -; declare a cainfo path if a certificate other than PHP's default should be used for curl calls. -; This setting overrides the 'curl.cainfo' parameter of the php.ini configuration file. -[curl] -; cainfo = "" - ;;;;;;;;;;;;;;;;;;;;;;; ; Job Queues Settings ; @@ -531,17 +515,13 @@ ; Default queue to use when a job is added to the queue default_queue = "queue" -; Whether or not to turn on the built-in job runner -; +; Whether or not to turn on the built-in job runner. ; When enabled, jobs will be processed at the end of each web ; request to the application. -; ; Use of the built-in job runner is highly discouraged for high-volume ; sites. Instead, a worker daemon or cron job should be configured ; to process jobs off the application's main thread. -; -; See: https://docs.pkp.sfu.ca/admin-guide/en/advanced-jobs -; +; See: https://docs.pkp.sfu.ca/admin-guide/en/deploy-jobs job_runner = On ; The maximum number of jobs to run in a single request when using @@ -550,22 +530,18 @@ ; The maximum number of seconds the built-in job runner should spend ; running jobs in a single request. -; ; This should be less than the max_execution_time the server has ; configured for PHP. -; ; Lower this setting if jobs are failing due to timeouts. job_runner_max_execution_time = 30 -; The maximum consumerable memory that should be spent by the built-in +; The maximum consumable memory that should be spent by the built-in ; job runner when running jobs. ; ; Set as a percentage, such as 80%: -; ; job_runner_max_memory = 80 ; ; Or set as a fixed value in megabytes: -; ; job_runner_max_memory = 128M ; ; When setting a fixed value in megabytes, this should be less than the @@ -582,48 +558,52 @@ delete_failed_jobs_after = 180 -;;;;;;;;;;;;;;;;;;;;;;;;;; -; Schedule Task Settings ; -;;;;;;;;;;;;;;;;;;;;;;;;;; +;;;;;;;;;;;;;;;;;;;;;;;;;;; +; Scheduled Task Settings ; +;;;;;;;;;;;;;;;;;;;;;;;;;;; [schedule] -; Whether or not to turn on the built-in schedule task runner -; -; When enabled, schedule tasks will be processed at the end of each web +; Whether or not to turn on the built-in scheduled task runner. +; When enabled, scheduled tasks will be processed at the end of each web ; request to the application. -; -; Use of the built-in schedule task runner is highly discouraged for high-volume -; sites. Use your operational system's task scheduler instead, and configure +; Use of the built-in scheduled task runner is strongly discouraged for high-volume +; sites. Use your operating system's task scheduler instead, and configure ; it to run the task scheduler every minute. -; Sample for the *nix crontab +; +; Sample for the *nix crontab: ; * * * * * php lib/pkp/tools/scheduler.php run >> /dev/null 2>&1 ; ; See: task_runner = On -; How often should the built-in schedule task runner run scheduled tasks at the +; How often the built-in scheduled task runner should run at the ; end of web request life cycle (value defined in seconds). -; -; This configuration will only have effect for the build-it task runner, it doesn't apply -; to the system crontab configuration. -; -; The default value is set to 60 seconds, a value smaller than that might affect the -; application performance negatively. +; This configuration will only affect the built-in task runner, it doesn't apply +; to the system crontab configuration. +; The default value is 60 seconds (a value smaller than that might affect the +; application performance negatively). task_runner_interval = 60 -; When enabled, an email with the scheduled task result will be sent only when an error +; When enabled, an email with the scheduled task result will only be sent when an error ; has occurred. Otherwise, all tasks will generate a notification. scheduled_tasks_report_error_only = On +;;;;;;;;;;;;;;;;;;;;;;;;; +; Invitations Settings ; +;;;;;;;;;;;;;;;;;;;;;;;;; + [invitations] + +; The number of days a user has to accept an invitation before it expires. expiration_days = 3 + ;;;;;;;;;;;;;;;;;;;;;;;;; ; New Features Settings ; ;;;;;;;;;;;;;;;;;;;;;;;;; [features] -enable_new_submission_listing = On \ No newline at end of file +enable_new_submission_listing = On