diff options
| author | Git'Fellow <12234510+solracsf@users.noreply.github.com> | 2025-06-13 13:53:48 +0200 |
|---|---|---|
| committer | Git'Fellow <12234510+solracsf@users.noreply.github.com> | 2025-06-16 09:15:03 +0200 |
| commit | 2c950d4e05ef176999b94427766df50e8347b8fd (patch) | |
| tree | 65440757e6580cb8c8df3d53fe918fee2c542c1f | |
| parent | 9b29df2dd59dffa85a29098d5684900f732ce584 (diff) | |
| download | nextcloud-server-confWordingReview.tar.gz nextcloud-server-confWordingReview.zip | |
refactor(config.php): Global wording reviewconfWordingReview
Signed-off-by: Git'Fellow <12234510+solracsf@users.noreply.github.com>
| -rw-r--r-- | config/config.sample.php | 894 |
1 files changed, 438 insertions, 456 deletions
diff --git a/config/config.sample.php b/config/config.sample.php index 947666e0895..d34a5f0b9b1 100644 --- a/config/config.sample.php +++ b/config/config.sample.php @@ -17,13 +17,13 @@ * * This file is used to generate the configuration documentation. * Please consider following requirements of the current parser: - * * all comments need to start with `/**` and end with ` *\/` - each on their + * * All comments need to start with `/**` and end with ` *\/` - each on their * own line - * * add a `@see CONFIG_INDEX` to copy a previously described config option + * * Add a `@see CONFIG_INDEX` to copy a previously described config option * also to this line - * * everything between the ` *\/` and the next `/**` will be treated as the + * * Everything between the ` *\/` and the next `/**` will be treated as the * config option - * * use RST syntax + * * Use RST syntax */ $CONFIG = [ @@ -47,22 +47,22 @@ $CONFIG = [ */ 'instanceid' => '', - /** - * The salt used to hash all passwords, auto-generated by the Nextcloud - * installer. (There are also per-user salts.) If you lose this salt you lose - * all your passwords. This example is for documentation only, and you should - * never use it. - * - * @deprecated This salt is deprecated and only used for legacy-compatibility, - * developers should *NOT* use this value for anything nowadays. - * - * 'passwordsalt' => 'd3c944a9af095aa08f', +/** + * The salt used to hash all passwords, auto-generated by the Nextcloud + * installer. (There are also per-user salts.) If you lose this salt, you lose + * all your passwords. This example is for documentation only, and you should + * never use it. + * + * @deprecated This salt is deprecated and only used for legacy-compatibility, + * developers should *NOT* use this value for anything nowadays. + * + * 'passwordsalt' => 'd3c944a9af095aa08f', */ 'passwordsalt' => '', /** - * Secret used by Nextcloud for various purposes, e.g. to encrypt data. If you - * lose this string there will be data corruption. + * Secret used by Nextcloud for various purposes, e.g., to encrypt data. If you + * lose this string, there will be data corruption. */ 'secret' => '', @@ -72,21 +72,20 @@ $CONFIG = [ * necessary security checks. * You can specify: * - * - the exact hostname of your host or virtual host, e.g. demo.example.org. - * - the exact hostname with permitted port, e.g. demo.example.org:443. + * - The exact hostname of your host or virtual host, e.g., demo.example.org. + * - The exact hostname with permitted port, e.g., demo.example.org:443. * This disallows all other ports on this host - * - use * as a wildcard, e.g. ubos-raspberry-pi*.local will allow + * - Use * as a wildcard, e.g., ubos-raspberry-pi*.local will allow * ubos-raspberry-pi.local and ubos-raspberry-pi-2.local - * - the IP address with or without permitted port, e.g. [2001:db8::1]:8080 + * - The IP address with or without permitted port, e.g., [2001:db8::1]:8080 * Using TLS certificates where commonName=<IP address> is deprecated */ -'trusted_domains' => - [ - 'demo.example.org', - 'otherdomain.example.org', - '10.111.112.113', - '[2001:db8::1]' - ], +'trusted_domains' => [ + 'demo.example.org', + 'otherdomain.example.org', + '10.111.112.113', + '[2001:db8::1]' +], /** @@ -108,9 +107,9 @@ $CONFIG = [ * ``supportedDatabases`` * * Available: - * - sqlite3 (SQLite3) - * - mysql (MySQL/MariaDB) - * - pgsql (PostgreSQL) + * - sqlite3 (SQLite3) + * - mysql (MySQL/MariaDB) + * - pgsql (PostgreSQL) * * Defaults to ``sqlite3`` */ @@ -119,9 +118,9 @@ $CONFIG = [ /** * Your host server name, for example ``localhost``, ``hostname``, * ``hostname.example.com``, or the IP address. - * To specify a port use ``hostname:####``, for IPv6 addresses use the URI notation ``[ip]:port``. - * To specify a Unix socket use ``localhost:/path/to/directory/containing/socket`` or - * ``:/path/to/directory/containing/socket``, e.g. ``localhost:/run/postgresql/``. + * To specify a port, use ``hostname:####``; for IPv6 addresses, use the URI notation ``[ip]:port``. + * To specify a Unix socket, use ``localhost:/path/to/directory/containing/socket`` or + * ``:/path/to/directory/containing/socket``, e.g., ``localhost:/run/postgresql/``. */ 'dbhost' => '', @@ -152,14 +151,14 @@ $CONFIG = [ 'dbtableprefix' => 'oc_', /** - * Enable persistent connexions to the database. - * This setting uses the "persistent" option from doctrine dbal, which in turn - * uses the PDO::ATTR_PERSISTENT option from the pdo driver. + * Enable persistent connections to the database. + * This setting uses the "persistent" option from Doctrine DBAL, which in turn + * uses the PDO::ATTR_PERSISTENT option from the PDO driver. */ 'dbpersistent' => '', /** - * Specify read only replicas to be used by Nextcloud when querying the database + * Specify read-only replicas to be used by Nextcloud when querying the database */ 'dbreplica' => [ ['user' => 'nextcloud', 'password' => 'password1', 'host' => 'replica1', 'dbname' => ''], @@ -167,7 +166,7 @@ $CONFIG = [ ], /** - * Add request id to the database query in a comment. + * Add request ID to the database query in a comment. * * This can be enabled to assist in mapping database logs to Nextcloud logs. */ @@ -193,13 +192,13 @@ $CONFIG = [ /** * This sets the default language on your Nextcloud server, using ISO_639-1 * language codes such as ``en`` for English, ``de`` for German, and ``fr`` for - * French. The default_language parameter is only used, when the browser does - * not send any language, and the user hasn’t configured own language + * French. The default_language parameter is only used when the browser does + * not send any language, and the user hasn’t configured their own language * preferences. * * Nextcloud has two distinguished language codes for German, 'de' and 'de_DE'. * 'de' is used for informal German and 'de_DE' for formal German. By setting - * this value to 'de_DE' you can enforce the formal version of German unless + * this value to 'de_DE', you can enforce the formal version of German unless * the user has chosen something different explicitly. * * Defaults to ``en`` @@ -207,7 +206,7 @@ $CONFIG = [ 'default_language' => 'en', /** - * With this setting a language can be forced for all users. If a language is + * With this setting, a language can be forced for all users. If a language is * forced, the users are also unable to change their language in the personal * settings. If users shall be unable to change their language, but users have * different languages, this value can be set to ``true`` instead of a language @@ -230,9 +229,9 @@ $CONFIG = [ 'default_locale' => 'en_US', /** - * With this setting is possible to reduce the languages available in the + * With this setting, it is possible to reduce the languages available in the * language chooser. The languages have to be set as array values using ISO_639-1 - * language codes such as ``en`` for English, ``de`` for German etc. + * language codes such as ``en`` for English, ``de`` for German, etc. * * For example: Set to ['de', 'fr'] to only allow German and French languages. */ @@ -242,14 +241,14 @@ $CONFIG = [ * This sets the default region for phone numbers on your Nextcloud server, * using ISO 3166-1 country codes such as ``DE`` for Germany, ``FR`` for France, … * It is required to allow inserting phone numbers in the user profiles starting - * without the country code (e.g. +49 for Germany). + * without the country code (e.g., +49 for Germany). * * No default value! */ 'default_phone_region' => 'GB', /** - * With this setting a locale can be forced for all users. If a locale is + * With this setting, a locale can be forced for all users. If a locale is * forced, the users are also unable to change their locale in the personal * settings. If users shall be unable to change their locale, but users have * different languages, this value can be set to ``true`` instead of a locale @@ -262,7 +261,7 @@ $CONFIG = [ /** * This sets the default timezone on your Nextcloud server, using IANA * identifiers like ``Europe/Berlin`` or ``Pacific/Auckland``. The default - * timezone parameter is only used when the timezone of the user can't be + * timezone parameter is only used when the timezone of the user cannot be * determined. * * Defaults to ``UTC`` @@ -290,10 +289,10 @@ $CONFIG = [ /** * The directory where the skeleton files are located. These files will be * copied to the data directory of new users. Set empty string to not copy any - * skeleton files. If unset and templatedirectory is empty string, shipped + * skeleton files. If unset and templatedirectory is an empty string, shipped * templates will be used to create a template directory for the user. * ``{lang}`` can be used as a placeholder for the language of the user. - * If the directory does not exist, it falls back to non dialect (from ``de_DE`` + * If the directory does not exist, it falls back to non-dialect (from ``de_DE`` * to ``de``). If that does not exist either, it falls back to ``default`` * * Defaults to ``core/skeleton`` in the Nextcloud directory. @@ -305,7 +304,7 @@ $CONFIG = [ * copied to the template directory of new users. Set empty string to not copy any * template files. * ``{lang}`` can be used as a placeholder for the language of the user. - * If the directory does not exist, it falls back to non dialect (from ``de_DE`` + * If the directory does not exist, it falls back to non-dialect (from ``de_DE`` * to ``de``). If that does not exist either, it falls back to ``default`` * * To disable creating a template directory, set both skeletondirectory and @@ -319,7 +318,7 @@ $CONFIG = [ /** * Lifetime of the remember login cookie. This should be larger than the - * session_lifetime. If it is set to 0 remember me is disabled. + * session_lifetime. If it is set to 0, remember me is disabled. * * Defaults to ``60*60*24*15`` seconds (15 days) */ @@ -341,16 +340,16 @@ $CONFIG = [ 'davstorage.request_timeout' => 30, /** - * The timeout in seconds for synchronizing address books, e.g. federated system address books (as run by `occ federation:sync-addressbooks`). + * The timeout in seconds for synchronizing address books, e.g., federated system address books (as run by `occ federation:sync-addressbooks`). * * Defaults to ``30`` seconds */ 'carddav_sync_request_timeout' => 30, /** - * `true` enabled a relaxed session timeout, where the session timeout would no longer be + * `true` enables a relaxed session timeout, where the session timeout would no longer be * handled by Nextcloud but by either the PHP garbage collection or the expiration of - * potential other session backends like redis. + * potential other session backends like Redis. * * This may lead to sessions being available for longer than what session_lifetime uses but * comes with performance benefits as sessions are no longer a locking operation for concurrent @@ -421,7 +420,7 @@ $CONFIG = [ /** * Whether the brute force protection shipped with Nextcloud should be set to testing mode. * - * In testing mode brute force attempts are still recorded, but the requests do + * In testing mode, brute force attempts are still recorded, but the requests do * not sleep/wait for the specified time. They will still abort with * "429 Too Many Requests" when the maximum delay is reached. * Enabling this is discouraged for security reasons @@ -454,8 +453,8 @@ $CONFIG = [ /** * Size of subnet used to normalize IPv6 * - * For Brute Force Protection and Rate Limiting, IPv6 are truncated using subnet size. - * It defaults to /56 but you can set it between /32 and /64 + * For Brute Force Protection and Rate Limiting, IPv6 addresses are truncated using subnet size. + * It defaults to /56, but you can set it between /32 and /64 * * Defaults to ``56`` */ @@ -467,19 +466,19 @@ $CONFIG = [ 'auth.webauthn.enabled' => true, /** - * Whether encrypted password should be stored in the database + * Whether encrypted passwords should be stored in the database * * The passwords are only decrypted using the login token stored uniquely in the - * clients and allow to connect to external storages, autoconfigure mail account in - * the mail app and periodically check if the password it still valid. + * clients and allow connecting to external storages, autoconfiguring mail accounts in + * the mail app, and periodically checking if the password is still valid. * - * This might be desirable to disable this functionality when using one time + * This might be desirable to disable this functionality when using one-time * passwords or when having a password policy enforcing long passwords (> 300 * characters). * * By default, the passwords are stored encrypted in the database. * - * WARNING: If disabled, password changes on the user back-end (e.g. on LDAP) no + * WARNING: If disabled, password changes on the user backend (e.g., on LDAP) no * longer log connected clients out automatically. Users can still disconnect * the clients by deleting the app token from the security settings. */ @@ -495,11 +494,11 @@ $CONFIG = [ 'hide_login_form' => false, /** - * If your user backend does not allow password resets (e.g. when it's a + * If your user backend does not allow password resets (e.g., when it's a * read-only user backend like LDAP), you can specify a custom link, where the * user is redirected to, when clicking the "reset password" link after a failed - * login-attempt. - * In case you do not want to provide any link, replace the url with 'disabled' + * login attempt. + * In case you do not want to provide any link, replace the URL with 'disabled' */ 'lost_password_link' => 'https://example.org/link/to/password/reset', @@ -528,7 +527,7 @@ $CONFIG = [ * FROM address that overrides the built-in ``sharing-noreply`` and * ``lostpassword-noreply`` FROM addresses. * - * Defaults to different from addresses depending on the feature. + * Defaults to different FROM addresses depending on the feature. */ 'mail_from_address' => 'nextcloud', @@ -542,14 +541,14 @@ $CONFIG = [ 'mail_smtpdebug' => false, /** - * Which mode to use for sending mail: ``sendmail``, ``smtp``, ``qmail`` or ``null``. + * Which mode to use for sending mail: ``sendmail``, ``smtp``, ``qmail``, or ``null``. * * If you are using local or remote SMTP, set this to ``smtp``. * - * For the ``sendmail`` option you need an installed and working email system on + * For the ``sendmail`` option, you need an installed and working email system on * the server, with ``/usr/sbin/sendmail`` installed on your Unix system. * - * For ``qmail`` the binary is /var/qmail/bin/sendmail, and it must be installed + * For ``qmail``, the binary is /var/qmail/bin/sendmail, and it must be installed * on your Unix system. * * Use the string ``null`` to send no mails (disable mail delivery). This can be @@ -562,7 +561,7 @@ $CONFIG = [ /** * This depends on ``mail_smtpmode``. Specify the IP address of your mail * server host. This may contain multiple hosts separated by a semicolon. If - * you need to specify the port number append it to the IP address separated by + * you need to specify the port number, append it to the IP address separated by * a colon, like this: ``127.0.0.1:24``. * * Defaults to ``127.0.0.1`` @@ -596,7 +595,6 @@ $CONFIG = [ 'mail_smtpsecure' => '', /** - * * This depends on ``mail_smtpmode``. Change this to ``true`` if your mail * server requires authentication. * @@ -622,14 +620,14 @@ $CONFIG = [ /** * Replaces the default mail template layout. This can be utilized if the - * options to modify the mail texts with the theming app is not enough. - * The class must extend ``\OC\Mail\EMailTemplate`` + * options to modify the mail texts with the theming app are not enough. + * The class must extend ``\OC\Mail\EMailTemplate`` */ 'mail_template_class' => '\OC\Mail\EMailTemplate', /** * Email will be sent by default with an HTML and a plain text body. This option - * allows to only send plain text emails. + * allows sending only plain text emails. */ 'mail_send_plaintext_only' => false, @@ -643,10 +641,10 @@ $CONFIG = [ /** * Which mode is used for sendmail/qmail: ``smtp`` or ``pipe``. * - * For ``smtp`` the sendmail binary is started with the parameter ``-bs``: + * For ``smtp``, the sendmail binary is started with the parameter ``-bs``: * - Use the SMTP protocol on standard input and output. * - * For ``pipe`` the binary is started with the parameters ``-t``: + * For ``pipe``, the binary is started with the parameters ``-t``: * - Read message from STDIN and extract recipients. * * Defaults to ``smtp`` @@ -660,7 +658,7 @@ $CONFIG = [ /** * The automatic hostname detection of Nextcloud can fail in certain reverse * proxy and CLI/cron situations. This option allows you to manually override - * the automatic detection; for example ``www.example.com``, or specify the port + * the automatic detection; for example, ``www.example.com``, or specify the port * ``www.example.com:8080``. */ 'overwritehost' => '', @@ -699,31 +697,31 @@ $CONFIG = [ * occ). The value should contain the full base URL: * ``https://www.example.com/nextcloud`` * Please make sure to set the value to the URL that your users mainly use to access this Nextcloud. - * Otherwise there might be problems with the URL generation via cron. + * Otherwise, there might be problems with the URL generation via cron. * * Defaults to ``''`` (empty string) */ 'overwrite.cli.url' => '', /** - * To have clean URLs without `/index.php` this parameter needs to be configured. + * To have clean URLs without `/index.php`, this parameter needs to be configured. * * This parameter will be written as "RewriteBase" on update and installation of * Nextcloud to your `.htaccess` file. While this value is often simply the URL - * path of the Nextcloud installation it cannot be set automatically properly in + * path of the Nextcloud installation, it cannot be set automatically properly in * every scenario and needs thus some manual configuration. * - * In a standard Apache setup this usually equals the folder that Nextcloud is - * accessible at. So if Nextcloud is accessible via "https://mycloud.org/nextcloud" + * In a standard Apache setup, this usually equals the folder that Nextcloud is + * accessible at. So if Nextcloud is accessible via "https://mycloud.org/nextcloud", * the correct value would most likely be "/nextcloud". If Nextcloud is running - * under "https://mycloud.org/" then it would be "/". + * under "https://mycloud.org/", then it would be "/". * * Note that the above rule is not valid in every case, as there are some rare setup - * cases where this may not apply. However, to avoid any update problems this + * cases where this may not apply. However, to avoid any update problems, this * configuration value is explicitly opt-in. * - * After setting this value run `occ maintenance:update:htaccess`. Now, when the - * following conditions are met Nextcloud URLs won't contain `index.php`: + * After setting this value, run `occ maintenance:update:htaccess`. Now, when the + * following conditions are met, Nextcloud URLs won't contain `index.php`: * * - `mod_rewrite` is installed * - `mod_env` is installed @@ -733,23 +731,23 @@ $CONFIG = [ 'htaccess.RewriteBase' => '/', /** - * For server setups, that don't have `mod_env` enabled or restricted (e.g. suEXEC) + * For server setups that don't have `mod_env` enabled or restricted (e.g., suEXEC), * this parameter has to be set to true and will assume mod_rewrite. * - * Please check, if `mod_rewrite` is active and functional before setting this + * Please check if `mod_rewrite` is active and functional before setting this * parameter, and you updated your .htaccess with `occ maintenance:update:htaccess`. - * Otherwise, your nextcloud installation might not be reachable anymore. + * Otherwise, your Nextcloud installation might not be reachable anymore. * For example, try accessing resources by leaving out `index.php` in the URL. */ 'htaccess.IgnoreFrontController' => false, /** - * The URL of your proxy server, for example ``proxy.example.com:8081``. + * The URL of your proxy server, for example, ``proxy.example.com:8081``. * - * Note: Guzzle (the http library used by Nextcloud) is reading the environment - * variables HTTP_PROXY (only for cli request), HTTPS_PROXY, and NO_PROXY by default. + * Note: Guzzle (the HTTP library used by Nextcloud) reads the environment + * variables HTTP_PROXY (only for CLI requests), HTTPS_PROXY, and NO_PROXY by default. * - * If you configure proxy with Nextcloud any default configuration by Guzzle + * If you configure a proxy with Nextcloud, any default configuration by Guzzle * is overwritten. Make sure to set ``proxyexclude`` accordingly if necessary. * * Defaults to ``''`` (empty string) @@ -765,7 +763,7 @@ $CONFIG = [ 'proxyuserpwd' => '', /** - * List of host names that should not be proxied to. + * List of hostnames that should not be proxied to. * For example: ``['.mit.edu', 'foo.com']``. * * Hint: Use something like ``explode(',', getenv('NO_PROXY'))`` to sync this @@ -776,7 +774,7 @@ $CONFIG = [ 'proxyexclude' => [], /** - * Allow remote servers with local addresses e.g. in federated shares, webcal services and more + * Allow remote servers with local addresses, e.g., in federated shares, webcal services, and more * * Defaults to false */ @@ -801,7 +799,7 @@ $CONFIG = [ * * Minimum time is the number of days a file will be kept, after which it * *may be* deleted. A file may be deleted after the minimum number of days - * is expired if space is needed. The file will not be deleted if space is + * has expired if space is needed. The file will not be deleted if space is * not needed. * * Whether "space is needed" depends on whether a user quota is defined or not: @@ -823,7 +821,7 @@ $CONFIG = [ * Available values (D1 and D2 are configurable numbers): * * * ``auto`` - * default setting. keeps files and folders in the trash bin for 30 days + * default setting. Keeps files and folders in the trash bin for 30 days * and automatically deletes anytime after that if space is needed (note: * files may not be deleted if space is not needed). * * ``D1, auto`` @@ -892,8 +890,8 @@ $CONFIG = [ /** * Checks an app before install whether it uses private APIs instead of the - * proper public APIs. If this is set to true it will only allow to install or - * enable apps that pass this check. + * proper public APIs. If this is set to true, it will only allow installing or + * enabling apps that pass this check. * * Defaults to ``false`` */ @@ -901,8 +899,8 @@ $CONFIG = [ /** * Check if Nextcloud is up-to-date and shows a notification if a new version is - * available. It sends current version, php version, installation and last update - * time and release channel to the updater server which responds with the latest + * available. It sends current version, PHP version, installation and last update + * time, and release channel to the updater server which responds with the latest * available version based on those metrics. * * Defaults to ``true`` @@ -979,11 +977,11 @@ $CONFIG = [ 'check_for_working_htaccess' => true, /** - * In rare setups (e.g. on Openshift or Docker on Windows) the permissions check + * In rare setups (e.g., on OpenShift or Docker on Windows), the permissions check * might block the installation while the underlying system offers no means to * "correct" the permissions. In this case, set the value to false. * - * In regular cases, if issues with permissions are encountered they should be + * In regular cases, if issues with permissions are encountered, they should be * adjusted accordingly. Changing the flag is discouraged. * * Defaults to ``true`` @@ -991,10 +989,10 @@ $CONFIG = [ 'check_data_directory_permissions' => true, /** - * In certain environments it is desired to have a read-only configuration file. + * In certain environments, it is desired to have a read-only configuration file. * When this switch is set to ``true``, writing to the config file will be * forbidden. Therefore, it will not be possible to configure all options via - * the Web interface. Furthermore, when updating Nextcloud it is required to + * the Web interface. Furthermore, when updating Nextcloud, it is required to * make the configuration file writable again and to set this switch to ``false`` * for the update process. * @@ -1048,7 +1046,7 @@ $CONFIG = [ /** * Log file mode for the Nextcloud logging type in octal notation. * - * Defaults to 0640 (writeable by user, readable by group). + * Defaults to 0640 (writable by user, readable by group). */ 'logfilemode' => 0640, @@ -1062,7 +1060,7 @@ $CONFIG = [ /** * Loglevel used by the frontend to start logging at. The same values as - * for ``loglevel`` can be used. If not set it defaults to the value + * for ``loglevel`` can be used. If not set, it defaults to the value * configured for ``loglevel`` or Warning if that is not set either. * * Defaults to ``2`` @@ -1081,7 +1079,7 @@ $CONFIG = [ /** * If you maintain different instances and aggregate the logs, you may want * to distinguish between them. ``syslog_tag`` can be set per instance - * with a unique id. Only available if ``log_type`` is set to ``syslog`` or + * with a unique ID. Only available if ``log_type`` is set to ``syslog`` or * ``systemd``. * * The default value is ``Nextcloud``. @@ -1091,7 +1089,7 @@ $CONFIG = [ /** * If you maintain different instances and aggregate the logs, you may want * to distinguish between them. ``syslog_tag_audit`` can be set per instance - * with a unique id. Only available if ``log_type`` is set to ``syslog`` or + * with a unique ID. Only available if ``log_type`` is set to ``syslog`` or * ``systemd``. * * The default value is the value of ``syslog_tag``. @@ -1100,18 +1098,18 @@ $CONFIG = [ /** * Log condition for log level increase based on conditions. Once one of these - * conditions is met, the required log level is set to debug. This allows to - * debug specific requests, users or apps + * conditions is met, the required log level is set to debug. This allows + * debugging specific requests, users, or apps * * Supported conditions: * - ``shared_secret``: if a request parameter with the name `log_secret` is set to - * this value the condition is met + * this value, the condition is met * - ``users``: if the current request is done by one of the specified users, * this condition is met * - ``apps``: if the log message is invoked by one of the specified apps, * this condition is met * - ``matches``: if all the conditions inside a group match, - * this condition is met. This allows to log only entries to an app + * this condition is met. This allows logging only entries to an app * by a few users. * * Defaults to an empty array. @@ -1133,7 +1131,7 @@ $CONFIG = [ /** * Enables logging a backtrace with each log line. Normally, only Exceptions - * are carrying backtrace information which are logged automatically. This + * carry backtrace information, which are logged automatically. This * switch turns them on for any log message. Enabling this option will lead * to increased log data size. * @@ -1165,7 +1163,7 @@ $CONFIG = [ /** * Enables log rotation and limits the total size of logfiles. Set it to 0 for - * no rotation. Specify a size in bytes, for example 104857600 (100 megabytes + * no rotation. Specify a size in bytes, for example, 104857600 (100 megabytes * = 100 * 1024 * 1024 bytes). A new logfile is created with a new name when the * old logfile reaches your limit. If a rotated log file is already present, it * will be overwritten. @@ -1187,7 +1185,7 @@ $CONFIG = [ * Enable profiling for individual requests if profiling single requests is enabled or the secret is passed. * This requires the excimer extension to be installed. Be careful with this, as it can generate a lot of data. * - * The profile data will be stored as a json file in the profiling.path directory that can be analysed with speedscope. + * The profile data will be stored as a JSON file in the profiling.path directory that can be analyzed with speedscope. * * Defaults to ``false`` */ @@ -1213,7 +1211,7 @@ $CONFIG = [ * Enable sampling-based profiling. This collects profiling data periodically rather than per-request. * This requires the excimer extension to be installed. Be careful with this, as it can generate a lot of data. * - * The profile data will be stored as a plain text file in the profiling.path directory that can be analysed with speedscope. + * The profile data will be stored as a plain text file in the profiling.path directory that can be analyzed with speedscope. * * Defaults to ``false`` */ @@ -1257,19 +1255,20 @@ $CONFIG = [ * - Desktop client: ``https://nextcloud.com/install/#install-clients`` * - Android client: ``https://play.google.com/store/apps/details?id=com.nextcloud.client`` * - iOS client: ``https://itunes.apple.com/us/app/nextcloud/id1125420102?mt=8`` - * - iOS client app id: ``1125420102`` + * - iOS client app ID: ``1125420102`` * - F-Droid client: ``https://f-droid.org/packages/com.nextcloud.client/`` */ 'customclient_desktop' => - 'https://nextcloud.com/install/#install-clients', + 'https://nextcloud.com/install/#install-clients', 'customclient_android' => - 'https://play.google.com/store/apps/details?id=com.nextcloud.client', + 'https://play.google.com/store/apps/details?id=com.nextcloud.client', 'customclient_ios' => - 'https://itunes.apple.com/us/app/nextcloud/id1125420102?mt=8', + 'https://itunes.apple.com/us/app/nextcloud/id1125420102?mt=8', 'customclient_ios_appid' => - '1125420102', + '1125420102', 'customclient_fdroid' => - 'https://f-droid.org/packages/com.nextcloud.client/', + 'https://f-droid.org/packages/com.nextcloud.client/', + /** * Apps * @@ -1278,10 +1277,10 @@ $CONFIG = [ /** * Set the default app to open on login. The entry IDs can be retrieved from - * the Navigations OCS API endpoint: https://docs.nextcloud.com/server/latest/develper_manual/_static/openapi.html#/operations/core-navigation-get-apps-navigation. + * the Navigations OCS API endpoint: https://docs.nextcloud.com/server/latest/developer_manual/_static/openapi.html#/operations/core-navigation-get-apps-navigation. * You can use a comma-separated list of app names, so if the first - * app is not enabled for a user then Nextcloud will try the second one, and so - * on. If no enabled apps are found it defaults to the dashboard app. + * app is not enabled for a user, then Nextcloud will try the second one, and so + * on. If no enabled apps are found, it defaults to the dashboard app. * * Defaults to ``dashboard,files`` */ @@ -1296,7 +1295,7 @@ $CONFIG = [ /** * Enables the installation of apps from a self-hosted apps store. - * Requires that at least one of the configured apps directories is writeable. + * Requires that at least one of the configured apps directories is writable. * * Defaults to ``https://apps.nextcloud.com/api/v1`` */ @@ -1397,7 +1396,7 @@ $CONFIG = [ 'preview_max_filesize_image' => 50, /** - * max memory for generating image previews with imagegd (default behavior) + * Max memory for generating image previews with imagegd (default behavior) * Reads the image dimensions from the header and assumes 32 bits per pixel. * If creating the image would allocate more memory, preview generation will * be disabled and the default mimetype icon is shown. Set to -1 for no limit. @@ -1407,7 +1406,7 @@ $CONFIG = [ 'preview_max_memory' => 256, /** - * custom path for LibreOffice/OpenOffice binary + * Custom path for LibreOffice/OpenOffice binary * * * Defaults to ``''`` (empty string) @@ -1415,7 +1414,7 @@ $CONFIG = [ 'preview_libreoffice_path' => '/usr/bin/libreoffice', /** - * custom path for ffmpeg binary + * Custom path for ffmpeg binary * * Defaults to ``null`` and falls back to searching ``avconv`` and ``ffmpeg`` * in the configured ``PATH`` environment @@ -1423,7 +1422,7 @@ $CONFIG = [ 'preview_ffmpeg_path' => '/usr/bin/ffmpeg', /** - * custom path for ffprobe binary + * Custom path for ffprobe binary * * Defaults to ``null`` and falls back to using the same path as ffmpeg. * ffprobe is typically packaged with ffmpeg and is required for @@ -1435,9 +1434,9 @@ $CONFIG = [ * Set the URL of the Imaginary service to send image previews to. * Also requires the ``OC\Preview\Imaginary`` provider to be enabled in the * ``enabledPreviewProviders`` array, to create previews for these mimetypes: bmp, - * x-bitmap, png, jpeg, gif, heic, heif, svg+xml, tiff, webp and illustrator. + * x-bitmap, png, jpeg, gif, heic, heif, svg+xml, tiff, webp, and illustrator. * - * If you want Imaginary to also create preview images from PDF Documents, you + * If you want Imaginary to also create preview images from PDF documents, you * have to add the ``OC\Preview\ImaginaryPDF`` provider as well. * * See https://github.com/h2non/imaginary @@ -1445,7 +1444,7 @@ $CONFIG = [ 'preview_imaginary_url' => 'http://previews_hpb:8088/', /** - * If you want set a api key for imaginary. + * If you want to set an API key for Imaginary. */ 'preview_imaginary_key' => 'secret', @@ -1521,7 +1520,7 @@ $CONFIG = [ */ /** - * defines the interval in minutes for the background job that checks user + * Defines the interval in minutes for the background job that checks user * existence and marks them as ready to be cleaned up. The number is always * minutes. Setting it to 0 disables the feature. * See command line (occ) methods ``ldap:show-remnants`` and ``user:delete`` @@ -1533,7 +1532,7 @@ $CONFIG = [ /** * Sort groups in the user settings by name instead of the user count * - * By enabling this the user count beside the group name is disabled as well. + * By enabling this, the user count beside the group name is disabled as well. * @deprecated since Nextcloud 29 - Use the frontend instead or set the app config value `group.sortBy` for `core` to `2` */ 'sort_groups_by_name' => false, @@ -1546,7 +1545,7 @@ $CONFIG = [ /** * Replaces the default Comments Manager Factory. This can be utilized if an - * own or 3rdParty CommentsManager should be used that – for instance – uses the + * own or 3rd-party CommentsManager should be used that – for instance – uses the * filesystem instead of the database to keep the comments. * * Defaults to ``\OC\Comments\ManagerFactory`` @@ -1555,7 +1554,7 @@ $CONFIG = [ /** * Replaces the default System Tags Manager Factory. This can be utilized if an - * own or 3rdParty SystemTagsManager should be used that – for instance – uses the + * own or 3rd-party SystemTagsManager should be used that – for instance – uses the * filesystem instead of the database to keep the tags. * * Defaults to ``\OC\SystemTag\ManagerFactory`` @@ -1574,7 +1573,7 @@ $CONFIG = [ * * If you want to prevent users from logging in to Nextcloud before you start * doing some maintenance work, you need to set the value of the maintenance - * parameter to true. Please keep in mind that users who are already logged-in + * parameter to true. Please keep in mind that users who are already logged in * are kicked out of Nextcloud instantly. * * Defaults to ``false`` @@ -1587,9 +1586,9 @@ $CONFIG = [ * Some background jobs only run once a day. When an hour is defined for this config, * the background jobs which advertise themselves as not time sensitive will be * delayed during the "working" hours and only run in the 4 hours after the given time. - * This is e.g. used for activity expiration, suspicious login training and update checks. + * This is, e.g., used for activity expiration, suspicious login training, and update checks. * - * A value of 1 e.g. will only run these background jobs between 01:00am UTC and 05:00am UTC. + * A value of 1, e.g., will only run these background jobs between 01:00am UTC and 05:00am UTC. * * Defaults to ``100`` which disables the feature */ @@ -1610,7 +1609,7 @@ $CONFIG = [ /** * Extra SSL options to be used for configuration. - * + * * Defaults to an empty array. */ 'openssl' => [ @@ -1638,7 +1637,7 @@ $CONFIG = [ /** * Memory caching backend for locally stored data * - * * Used for host-specific data, e.g. file paths + * * Used for host-specific data, e.g., file paths * * Defaults to ``none`` */ @@ -1647,7 +1646,7 @@ $CONFIG = [ /** * Memory caching backend for distributed data * - * * Used for installation-specific data, e.g. database caching + * * Used for installation-specific data, e.g., database caching * * If unset, defaults to the value of memcache.local * * Defaults to ``none`` @@ -1655,24 +1654,24 @@ $CONFIG = [ 'memcache.distributed' => '\OC\Memcache\Memcached', /** - * Connection details for redis to use for memory caching in a single server configuration. + * Connection details for Redis to use for memory caching in a single server configuration. * - * For enhanced security it is recommended to configure Redis + * For enhanced security, it is recommended to configure Redis * to require a password. See http://redis.io/topics/security * for more information. * - * We also support redis SSL/TLS encryption as of version 6. + * We also support Redis SSL/TLS encryption as of version 6. * See https://redis.io/topics/encryption for more information. */ 'redis' => [ - 'host' => 'localhost', // can also be a unix domain socket: '/tmp/redis.sock' + 'host' => 'localhost', // can also be a Unix domain socket: '/tmp/redis.sock' 'port' => 6379, 'timeout' => 0.0, 'read_timeout' => 0.0, 'user' => '', // Optional: if not defined, no password will be used. 'password' => '', // Optional: if not defined, no password will be used. - 'dbindex' => 0, // Optional: if undefined SELECT will not run and will use Redis Server's default DB Index. - // If redis in-transit encryption is enabled, provide certificates + 'dbindex' => 0, // Optional: if undefined, SELECT will not run and will use Redis Server's default DB Index. + // If Redis in-transit encryption is enabled, provide certificates // SSL context https://www.php.net/manual/en/context.ssl.php 'ssl_context' => [ 'local_cert' => '/certs/redis.crt', @@ -1684,7 +1683,7 @@ $CONFIG = [ /** * Connection details for a Redis Cluster. * - * Redis Cluster support requires the php module phpredis in version 3.0.0 or + * Redis Cluster support requires the PHP module phpredis in version 3.0.0 or * higher. * * Available failover modes: @@ -1694,7 +1693,7 @@ $CONFIG = [ * * WARNING: FAILOVER_DISTRIBUTE is a not recommended setting, and we strongly * suggest to not use it if you use Redis for file locking. Due to the way Redis - * is synchronized it could happen, that the read for an existing lock is + * is synchronized, it could happen that the read for an existing lock is * scheduled to a slave that is not fully synchronized with the connected master * which then causes a FileLocked exception. * @@ -1713,7 +1712,7 @@ $CONFIG = [ 'failover_mode' => \RedisCluster::FAILOVER_ERROR, 'user' => '', // Optional: if not defined, no password will be used. 'password' => '', // Optional: if not defined, no password will be used. - // If redis in-transit encryption is enabled, provide certificates + // If Redis in-transit encryption is enabled, provide certificates // SSL context https://www.php.net/manual/en/context.ssl.php 'ssl_context' => [ 'local_cert' => '/certs/redis.crt', @@ -1724,11 +1723,11 @@ $CONFIG = [ /** - * Server details for one or more memcached servers to use for memory caching. + * Server details for one or more Memcached servers to use for memory caching. */ 'memcached_servers' => [ // hostname, port and optional weight - // or path and port 0 for unix socket. Also see: + // or path and port 0 for Unix socket. Also see: // https://www.php.net/manual/en/memcached.addservers.php // https://www.php.net/manual/en/memcached.addserver.php ['localhost', 11211], @@ -1736,7 +1735,7 @@ $CONFIG = [ ], /** - * Connection options for memcached + * Connection options for Memcached */ 'memcached_options' => [ // Set timeouts to 50ms @@ -1755,7 +1754,7 @@ $CONFIG = [ // Enable Binary Protocol \Memcached::OPT_BINARY_PROTOCOL => true, - // Binary serializer vill be enabled if the igbinary PECL module is available + // Binary serializer will be enabled if the igbinary PECL module is available //\Memcached::OPT_SERIALIZER => \Memcached::SERIALIZER_IGBINARY, ], @@ -1786,7 +1785,7 @@ $CONFIG = [ /** * This example shows how to configure Nextcloud to store all files in a - * swift object storage. + * Swift object storage. * * It is important to note that Nextcloud in object store mode will expect * exclusive access to the object store container because it only stores the @@ -1794,18 +1793,18 @@ $CONFIG = [ * database for performance reasons. * * WARNING: The current implementation is incompatible with any app that uses - * direct file IO and circumvents our virtual filesystem. That includes + * direct file I/O and circumvents our virtual filesystem. That includes * Encryption and Gallery. Gallery will store thumbnails directly in the - * filesystem and encryption will cause severe overhead because key files need + * filesystem, and encryption will cause severe overhead because key files need * to be fetched in addition to any requested file. * */ 'objectstore' => [ 'class' => 'OC\\Files\\ObjectStore\\Swift', 'arguments' => [ - // trystack will use your facebook id as the username + // trystack will use your Facebook ID as the username 'username' => 'facebook100000123456789', - // in the trystack dashboard go to user -> settings -> API Password to + // in the trystack dashboard, go to user -> settings -> API Password to // generate a password 'password' => 'Secr3tPaSSWoRdt7', // must already exist in the objectstore, name can be different @@ -1825,13 +1824,13 @@ $CONFIG = [ // dev-/trystack uses swift by default, the lib defaults to 'cloudFiles' // if omitted 'serviceName' => 'swift', - // The Interface / url Type, optional + // The Interface / URL Type, optional 'urlType' => 'internal' ], ], /** - * To use swift V3 + * To use Swift V3 */ 'objectstore' => [ 'class' => 'OC\\Files\\ObjectStore\\Swift', @@ -1861,17 +1860,17 @@ $CONFIG = [ ], /** - * If this is set to true and a multibucket object store is configured then + * If this is set to true and a multibucket object store is configured, then * newly created previews are put into 256 dedicated buckets. * - * Those buckets are named like the mulibucket version but with the postfix + * Those buckets are named like the multibucket version but with the postfix * ``-preview-NUMBER`` where NUMBER is between 0 and 255. * * Keep in mind that only previews of files are put in there that don't have * some already. Otherwise, the old bucket will be used. * - * To migrate existing previews to this new multibucket distribution of previews - * use the occ command ``preview:repair``. For now this will only migrate + * To migrate existing previews to this new multibucket distribution of previews, + * use the occ command ``preview:repair``. For now, this will only migrate * previews that were generated before Nextcloud 19 in the flat * ``appdata_INSTANCEID/previews/FILEID`` folder structure. */ @@ -1886,7 +1885,7 @@ $CONFIG = [ /** * Replaces the default Share Provider Factory. This can be utilized if - * own or 3rdParty Share Providers are used that – for instance – use the + * own or 3rd-party Share Providers are used that – for instance – use the * filesystem instead of the database to keep the share information. * * Defaults to ``\OC\Share20\ProviderFactory`` @@ -1895,8 +1894,8 @@ $CONFIG = [ /** * Enables expiration for link share passwords sent by email (sharebymail). - * The passwords will expire after the configured interval, the users can - * still request a new one in the public link page. + * The passwords will expire after the configured interval; the users can + * still request a new one on the public link page. */ 'sharing.enable_mail_link_password_expiration' => false, @@ -1909,9 +1908,9 @@ $CONFIG = [ * Define max number of results returned by the search for auto-completion of * users, groups, etc. The value must not be lower than 0 (for unlimited). * - * If more, different sources are requested (e.g. different user backends; or + * If more, different sources are requested (e.g., different user backends; or * both users and groups), the value is applied per source and might not be - * truncated after collecting the results. I.e. more results can appear than + * truncated after collecting the results. I.e., more results can appear than * configured here. * * Default is 25. @@ -1936,7 +1935,7 @@ $CONFIG = [ 'sharing.force_share_accept' => false, /** - * Set to ``false``, to prevent users from setting a custom share_folder + * Set to ``false`` to prevent users from setting a custom share_folder */ 'sharing.allow_custom_share_folder' => true, @@ -1949,7 +1948,7 @@ $CONFIG = [ 'share_folder' => '/', /** - * Set to ``false``, to stop sending a mail when users receive a share + * Set to ``false`` to stop sending a mail when users receive a share */ 'sharing.enable_share_mail' => true, @@ -1970,9 +1969,9 @@ $CONFIG = [ * Federated Cloud Sharing */ - /** - * Allow self-signed certificates for federated shares - */ +/** + * Allow self-signed certificates for federated shares + */ 'sharing.federation.allowSelfSignedCertificates' => false, /** @@ -1982,7 +1981,7 @@ $CONFIG = [ /** * By default, Nextcloud will use the Argon2 password hashing if available. * However, if for whatever reason you want to stick with the PASSWORD_DEFAULT - * of your php version. Then set the setting to true. + * of your PHP version, then set the setting to true. * * Nextcloud uses the Argon2 algorithm (with PHP >= 7.2) to create hashes by its * own and exposes its configuration options as following. More information can @@ -1992,7 +1991,7 @@ $CONFIG = [ /** * The number of CPU threads to be used by the algorithm for computing a hash. - * The value must be an integer, and the minimum value is 1. Rationally it does + * The value must be an integer, and the minimum value is 1. Rationally, it does * not help to provide a number higher than the available threads on the machine. * Values that undershoot the minimum will be ignored in favor of the minimum. */ @@ -2023,13 +2022,13 @@ $CONFIG = [ */ /** - * Additional driver options for the database connection, e.g. to enable SSL + * Additional driver options for the database connection, e.g., to enable SSL * encryption in MySQL or specify a custom wait timeout on a cheap hoster. * * When setting up TLS/SSL for encrypting the connections, you need to ensure that * the passed keys and certificates are readable by the PHP process. In addition, * PDO::MYSQL_ATTR_SSL_VERIFY_SERVER_CERT might need to be set to false, if the - * database servers certificates CN does not match with the hostname used to connect. + * database server's certificate CN does not match with the hostname used to connect. * The standard behavior here is different from the MySQL/MariaDB CLI client, which * does not verify the server cert except --ssl-verify-server-cert is passed manually. */ @@ -2042,31 +2041,31 @@ $CONFIG = [ ], /** - * sqlite3 journal mode can be specified using this configuration parameter - - * can be 'WAL' or 'DELETE' see for more details https://www.sqlite.org/wal.html + * SQLite3 journal mode can be specified using this configuration parameter - + * can be 'WAL' or 'DELETE'. See https://www.sqlite.org/wal.html for more details. */ 'sqlite.journal_mode' => 'DELETE', /** * During setup, if requirements are met (see below), this setting is set to true - * and MySQL can handle 4 byte characters instead of 3 byte characters. + * to enable MySQL to handle 4-byte characters instead of 3-byte characters. * - * If you want to convert an existing 3-byte setup into a 4-byte setup please - * set the parameters in MySQL as mentioned below and run the migration command: + * To convert an existing 3-byte setup to a 4-byte setup, configure the MySQL + * parameters as described below and run the migration command: * ./occ db:convert-mysql-charset - * The config setting will be set automatically after a successful run. + * This config setting will be automatically updated after a successful migration. * - * Consult the documentation for more details. + * Refer to the documentation for more details. * - * MySQL requires a special setup for longer indexes (> 767 bytes) which are - * needed: + * MySQL requires specific settings for longer indexes (> 767 bytes), which are + * necessary for 4-byte character support: * * [mysqld] * innodb_large_prefix=ON * innodb_file_format=Barracuda * innodb_file_per_table=ON * - * Tables will be created with + * Tables will be created with: * * character set: utf8mb4 * * collation: utf8mb4_bin * * row_format: dynamic @@ -2081,33 +2080,32 @@ $CONFIG = [ 'mysql.utf8mb4' => false, /** - * For search queries in the database, a default collation – depending on the - * character set – is chosen. In some cases a different behaviour is desired, - * for instances when an accent sensitive search is desired. + * For search queries in the database, a default collation is chosen based on the + * character set. In some cases, a different collation is desired, such as for + * accent-sensitive searches. * - * MariaDB and MySQL have an overlap in available collations, but also - * incompatible ones, also depending on the version of the database server. + * MariaDB and MySQL share some collations, but also have incompatible ones, + * depending on the database server version. * - * This option allows to override the automatic choice. Example: + * This option allows overriding the automatic collation choice. Example: * * 'mysql.collation' => 'utf8mb4_0900_as_ci', * - * This setting has no effect on setup or creating tables. In those cases - * always utf8[mb4]_bin is being used. This setting is only taken into - * consideration in SQL queries that utilize LIKE comparison operators. + * This setting does not affect table creation or setup, where utf8[mb4]_bin is + * always used. It applies only to SQL queries using LIKE comparison operators. */ 'mysql.collation' => null, /** - * Database types that are supported for installation. + * Database types supported for installation. * * Available: - * - sqlite (SQLite3) - * - mysql (MySQL) - * - pgsql (PostgreSQL) - * - oci (Oracle) + * - sqlite (SQLite3) + * - mysql (MySQL) + * - pgsql (PostgreSQL) + * - oci (Oracle) * - * Defaults to the following databases: + * Defaults to: * - sqlite (SQLite3) * - mysql (MySQL) * - pgsql (PostgreSQL) @@ -2120,104 +2118,103 @@ $CONFIG = [ ], /** - * Override where Nextcloud stores temporary files. Useful in situations where - * the system temporary directory is on a limited space ramdisk or is otherwise - * restricted, or if external storage which do not support streaming are in - * use. + * Override the location where Nextcloud stores temporary files. Useful in setups + * where the system temporary directory is on a limited-space ramdisk, restricted, + * or when using external storage that does not support streaming. * - * The Web server user/PHP must have write access to this directory. - * Additionally you have to make sure that your PHP configuration considers this a valid - * tmp directory, by setting the TMP, TMPDIR, and TEMP variables to the required directories. - * On top of that you might be required to grant additional permissions in AppArmor or SELinux. + * The web server user/PHP must have write access to this directory. Ensure that + * PHP configuration recognizes this as a valid temporary directory by setting + * the TMP, TMPDIR, and TEMP environment variables accordingly. Additional + * permissions may be required for AppArmor or SELinux. */ 'tempdirectory' => '/tmp/nextcloudtemp', /** - * Override where Nextcloud stores update files while updating. Useful in situations - * where the default `datadirectory` is on network disk like NFS, or is otherwise - * restricted. Defaults to the value of `datadirectory` if unset. - * - * If set, the value MUST be located _outside_ of the installation directory of Nextcloud and - * writable by the Web server user. + * Override the location where Nextcloud stores update files during updates. + * Useful when the default `datadirectory` is on a network disk like NFS or is + * otherwise restricted. Defaults to the value of `datadirectory` if unset. * + * If set, the directory must be located outside the Nextcloud installation + * directory and writable by the web server user. */ 'updatedirectory' => '', /** - * Block a specific file or files and disallow the upload of files with this name. - * This blocks any access to those files (read and write). + * Block specific files or filenames, disallowing uploads or access (read and write). * ``.htaccess`` is blocked by default. * - * WARNING: USE THIS ONLY IF YOU KNOW WHAT YOU ARE DOING. + * WARNING: Use this only if you understand the implications. * - * Note that this list is case-insensitive. + * Note: This list is case-insensitive. * - * Defaults to ``array('.htaccess')`` + * Defaults to ``['.htaccess']`` */ 'forbidden_filenames' => ['.htaccess'], /** - * Disallow the upload of files with specific basenames. - * Matching existing files can no longer be updated and in matching folders no files can be created anymore. + * Disallow uploads of files with specific basenames. Matching existing files + * cannot be updated, and no new files can be created in matching folders. * - * The basename is the name of the file without the extension, - * e.g. for "archive.tar.gz" the basename would be "archive". + * The basename is the filename without the extension, e.g., for "archive.tar.gz", + * the basename is "archive". * - * Note that this list is case-insensitive. + * Note: This list is case-insensitive. * - * Defaults to ``array()`` + * Defaults to ``[]`` (empty array) */ 'forbidden_filename_basenames' => [], /** - * Block characters from being used in filenames. This is useful if you - * have a filesystem or OS which does not support certain characters like windows. - * Matching existing files can no longer be updated and in matching folders no files can be created anymore. + * Block specific characters in filenames. Useful for filesystems or operating + * systems (e.g., Windows) that do not support certain characters. Matching + * existing files cannot be updated, and no new files can be created in matching + * folders. * - * The '/' and '\' characters are always forbidden, as well as all characters in the ASCII range [0-31]. + * The '/' and '\' characters, as well as ASCII characters [0-31], are always + * forbidden. * - * Example for windows systems: ``array('?', '<', '>', ':', '*', '|', '"')`` - * see https://en.wikipedia.org/wiki/Comparison_of_file_systems#Limits + * Example for Windows: ``['?', '<', '>', ':', '*', '|', '"']`` + * See: https://en.wikipedia.org/wiki/Comparison_of_file_systems#Limits * - * Defaults to ``array()`` + * Defaults to ``[]`` (empty array) */ 'forbidden_filename_characters' => [], /** - * Deny extensions from being used for filenames. - * Matching existing files can no longer be updated and in matching folders no files can be created anymore. + * Deny specific file extensions. Matching existing files cannot be updated, and + * no new files can be created in matching folders. * - * The '.part' extension is always forbidden, as this is used internally by Nextcloud. + * The '.part' extension is always forbidden, as it is used internally by Nextcloud. * - * Defaults to ``array('.filepart', '.part')`` + * Defaults to ``['.filepart', '.part']`` */ 'forbidden_filename_extensions' => ['.part', '.filepart'], /** - * If you are applying a theme to Nextcloud, enter the name of the theme here. - * The default location for themes is ``nextcloud/themes/``. + * Specify the name of a theme to apply to Nextcloud. Themes are located in + * ``nextcloud/themes/`` by default. * - * Defaults to the theming app which is shipped since Nextcloud 9 + * Defaults to the theming app, included since Nextcloud 9. */ 'theme' => '', /** - * Enforce the user theme. This will disable the user theming settings - * This must be a valid ITheme ID. - * E.g. dark, dark-highcontrast, default, light, light-highcontrast, opendyslexic + * Enforce a specific user theme, disabling user theming settings. Must be a + * valid ITheme ID, e.g., dark, dark-highcontrast, default, light, + * light-highcontrast, opendyslexic. */ 'enforce_theme' => '', - /** - * This setting allows to disable the PWA functionality that allows browsers to open web applications in dedicated windows. + * Enable or disable Progressive Web App (PWA) functionality, which allows + * browsers to open web applications in dedicated windows. * * Defaults to ``true`` */ 'theming.standalone_window.enabled' => true, /** - * The default cipher for encrypting files. Currently supported are: + * Specify the default cipher for encrypting files. Supported ciphers: * - AES-256-CTR * - AES-128-CTR * - AES-256-CFB @@ -2228,448 +2225,426 @@ $CONFIG = [ 'cipher' => 'AES-256-CTR', /** - * Use the legacy base64 format for encrypted files instead of the more space-efficient - * binary format. The option affects only newly written files, existing encrypted files - * will not be touched and will remain readable whether they use the new format or not. + * Use the legacy base64 format for encrypted files instead of the more + * space-efficient binary format. This affects only newly written files; existing + * encrypted files remain readable regardless of the format. * * Defaults to ``false`` */ 'encryption.use_legacy_base64_encoding' => false, /** - * The minimum Nextcloud desktop client version that will be allowed to sync with - * this server instance. All connections made from earlier clients will be denied - * by the server. Defaults to the minimum officially supported Nextcloud desktop - * client version at the time of release of this server version. + * Specify the minimum Nextcloud desktop client version allowed to sync with this + * server. Connections from earlier clients will be denied. Defaults to the + * minimum officially supported version at the time of this server release. * - * When changing this, note that older unsupported versions of the Nextcloud desktop - * client may not function as expected, and could lead to permanent data loss for - * clients or other unexpected results. + * Changing this may cause older, unsupported clients to malfunction, potentially + * leading to data loss or unexpected behavior. * * Defaults to ``2.7.0`` */ 'minimum.supported.desktop.version' => '2.7.0', /** - * The maximum Nextcloud desktop client version that will be allowed to sync with - * this server instance. All connections made from later clients will be denied - * by the server. + * Specify the maximum Nextcloud desktop client version allowed to sync with this + * server. Connections from later clients will be denied. * * Defaults to ``99.99.99`` */ 'maximum.supported.desktop.version' => '99.99.99', /** - * Option to allow local storage to contain symlinks. - * WARNING: Not recommended. This would make it possible for Nextcloud to access - * files outside the data directory and could be considered a security risk. + * Allow local storage to contain symlinks. + * WARNING: Not recommended, as this allows Nextcloud to access files outside the + * data directory, posing a potential security risk. * * Defaults to ``false`` */ 'localstorage.allowsymlinks' => false, /** - * Nextcloud overrides umask to ensure suitable access permissions - * regardless of webserver/php-fpm configuration and worker state. - * WARNING: Modifying this value has security implications and - * may soft-break the installation. + * Nextcloud overrides umask to ensure suitable access permissions regardless of + * web server or PHP-FPM configuration. Modifying this value has security + * implications and may cause issues with the installation. * - * Most installs shall not modify this value. + * Most installations should not modify this value. * * Defaults to ``0022`` */ 'localstorage.umask' => 0022, /** - * This options allows storage systems that don't allow to modify existing files - * to overcome this limitation by removing the files before overwriting. + * Allow storage systems that do not support modifying existing files to overcome + * this limitation by removing files before overwriting. * * Defaults to ``false`` */ 'localstorage.unlink_on_truncate' => false, /** - * EXPERIMENTAL: option whether to include external storage in quota - * calculation, defaults to false. + * EXPERIMENTAL: Include external storage in quota calculations. * * Defaults to ``false`` */ 'quota_include_external_storage' => false, /** - * When an external storage is unavailable for some reasons, it will be flagged - * as such for 10 minutes. When the trigger is a failed authentication attempt - * the delay is higher and can be controlled with this option. The motivation - * is to make account lock outs at Active Directories (and compatible) more - * unlikely. + * When an external storage is unavailable (e.g., due to failed authentication), + * it is flagged as such for a specified duration. For authentication failures, + * this delay can be customized to reduce the likelihood of account lockouts in + * systems like Active Directory. * - * Defaults to ``1800`` (seconds) + * Defaults to ``1800`` seconds (30 minutes) */ 'external_storage.auth_availability_delay' => 1800, /** - * Allows to create external storages of type "Local" in the web interface and APIs. - * - * When disabled, it is still possible to create local storages with occ using - * the following command: + * Allow creation of external storages of type "Local" via the web interface and + * APIs. When disabled, local storages can still be created using the occ command: * * occ files_external:create /mountpoint local null::null -c datadir=/path/to/data * * Defaults to ``true`` - * */ 'files_external_allow_create_new_local' => true, /** - * Specifies how often the local filesystem (the Nextcloud data/ directory, and - * NFS mounts in data/) is checked for changes made outside Nextcloud. This - * does not apply to external storage. - * - * 0 -> Never check the filesystem for outside changes, provides a performance - * increase when it's certain that no changes are made directly to the - * filesystem + * Specify how often the local filesystem (Nextcloud data/ directory and NFS + * mounts in data/) is checked for changes made outside Nextcloud. This does not + * apply to external storage. * + * 0 -> Never check the filesystem for outside changes, improving performance + * when no external changes are expected. * 1 -> Check each file or folder at most once per request, recommended for - * general use if outside changes might happen. + * general use if outside changes are possible. * * Defaults to ``0`` */ 'filesystem_check_changes' => 0, /** - * By default, Nextcloud will store the part files created during upload in the - * same storage as the upload target. Setting this to false will store the part - * files in the root of the users folder which might be required to work with certain - * external storage setups that have limited rename capabilities. + * Store part files created during upload in the same storage as the upload + * target. Setting this to false stores part files in the root of the user's + * folder, which may be necessary for external storage with limited rename + * capabilities. * * Defaults to ``true`` */ 'part_file_in_storage' => true, /** - * Where ``mount.json`` file should be stored, defaults to ``data/mount.json`` - * in the Nextcloud directory. + * Specify the location of the ``mount.json`` file. * * Defaults to ``data/mount.json`` in the Nextcloud directory. */ 'mount_file' => '/var/www/nextcloud/data/mount.json', /** - * When ``true``, prevent Nextcloud from changing the cache due to changes in - * the filesystem for all storage. + * Prevent Nextcloud from updating the cache due to filesystem changes for all + * storage. * * Defaults to ``false`` */ 'filesystem_cache_readonly' => false, /** - * List of trusted proxy servers - * - * You may set this to an array containing a combination of - * - IPv4 addresses, e.g. `192.168.2.123` - * - IPv4 ranges in CIDR notation, e.g. `192.168.2.0/24` - * - IPv6 addresses, e.g. `fd9e:21a7:a92c:2323::1` - * - IPv6 ranges in CIDR notation, e.g. `2001:db8:85a3:8d3:1319:8a20::/95` + * List of trusted proxy servers. Supported formats: + * - IPv4 addresses, e.g., `192.168.2.123` + * - IPv4 ranges in CIDR notation, e.g., `192.168.2.0/24` + * - IPv6 addresses, e.g., `fd9e:21a7:a92c:2323::1` + * - IPv6 ranges in CIDR notation, e.g., `2001:db8:85a3:8d3:1319:8a20::/95` * - * When an incoming request's `REMOTE_ADDR` matches any of the IP addresses - * specified here, it is assumed to be a proxy instead of a client. Thus, the - * client IP will be read from the HTTP header specified in - * `forwarded_for_headers` instead of from `REMOTE_ADDR`. + * If a request's `REMOTE_ADDR` matches an address here, it is treated as a proxy, + * and the client IP is read from the HTTP header specified in + * `forwarded_for_headers` instead of `REMOTE_ADDR`. * - * So if you configure `trusted_proxies`, also consider setting - * `forwarded_for_headers` which otherwise defaults to `HTTP_X_FORWARDED_FOR` - * (the `X-Forwarded-For` header). + * Ensure `forwarded_for_headers` is configured if `trusted_proxies` is set. * - * Defaults to an empty array. + * Defaults to ``[]`` (empty array) */ 'trusted_proxies' => ['203.0.113.45', '198.51.100.128', '192.168.2.0/24'], /** - * Headers that should be trusted as client IP address in combination with - * `trusted_proxies`. If the HTTP header looks like 'X-Forwarded-For', then use - * 'HTTP_X_FORWARDED_FOR' here. + * Headers trusted as containing the client IP address when used with + * `trusted_proxies`. For example, use `HTTP_X_FORWARDED_FOR` for the + * `X-Forwarded-For` header. * - * If set incorrectly, a client can spoof their IP address as visible to - * Nextcloud, bypassing access controls and making logs useless! + * Incorrect configuration allows clients to spoof their IP address, bypassing + * access controls and rendering logs unreliable. * - * Defaults to ``'HTTP_X_FORWARDED_FOR'`` + * Defaults to ``['HTTP_X_FORWARDED_FOR']`` */ 'forwarded_for_headers' => ['HTTP_X_FORWARDED', 'HTTP_FORWARDED_FOR'], /** - * List of trusted IP ranges for admin actions + * List of trusted IP ranges for admin actions. If non-empty, all admin actions + * must originate from IPs within these ranges. * - * If this list is non-empty, all admin actions must be triggered from - * IP addresses inside theses ranges. + * Supported formats: + * - IPv4 addresses or ranges, e.g., `192.0.2.42/32`, `233.252.0.0/24` + * - IPv6 addresses or ranges, e.g., `2001:db8::13:37/64` * - * Defaults to an empty array. + * Defaults to ``[]`` (empty array) */ 'allowed_admin_ranges' => ['192.0.2.42/32', '233.252.0.0/24', '2001:db8::13:37/64'], /** - * max file size for animating gifs on public-sharing-site. - * If the gif is bigger, it'll show a static preview + * Maximum file size (in megabytes) for animating GIFs on public sharing pages. + * If a GIF exceeds this size, a static preview is shown. * - * Value represents the maximum filesize in megabytes. Set to ``-1`` for - * no limit. + * Set to ``-1`` for no limit. * * Defaults to ``10`` megabytes */ 'max_filesize_animated_gifs_public_sharing' => 10, /** - * Set the lock's time-to-live in seconds. - * - * Any lock older than this will be automatically cleaned up. + * Set the lock's time-to-live (TTL) in seconds. Locks older than this are + * automatically cleaned up. * - * Defaults to ``60*60`` seconds (1 hour) or the php - * max_execution_time, whichever is higher. + * Defaults to ``3600`` seconds (1 hour) or the PHP `max_execution_time`, + * whichever is higher. */ 'filelocking.ttl' => 60*60, /** - * Memory caching backend for file locking - * - * Because most memcache backends can clean values without warning using redis - * is highly recommended to *avoid data loss*. + * Memory caching backend for file locking. Redis is highly recommended to avoid + * data loss, as many memcache backends may evict values unexpectedly. * * Defaults to ``none`` */ 'memcache.locking' => '\\OC\\Memcache\\Redis', /** - * Enable locking debug logging + * Enable debug logging for file locking. This can generate a large volume of log + * entries, potentially causing performance degradation and large log files on + * busy instances. * - * Note that this can lead to a very large volume of log items being written which can lead - * to performance degradation and large log files on busy instance. + * Use with `log.condition` to limit logging in production environments. * - * Thus enabling this in production for longer periods of time is not recommended - * or should be used together with the ``log.condition`` setting. + * Defaults to ``false`` */ 'filelocking.debug' => false, /** - * Disable the web based updater + * Disable the web-based updater. + * + * Defaults to ``false`` */ 'upgrade.disable-web' => false, /** - * Allows to modify the cli-upgrade link in order to link to a different documentation + * Customize the CLI upgrade documentation link. */ 'upgrade.cli-upgrade-link' => '', /** - * Allows to modify the exception server logs documentation link in order to link to a different documentation + * Customize the server logs documentation link for exception handling. */ 'documentation_url.server_logs' => '', /** - * Set this Nextcloud instance to debugging mode - * - * Only enable this for local development and not in production environments - * This will disable the minifier and outputs some additional debug information + * Enable debugging mode for Nextcloud. Only use for local development, not in + * production, as it disables minification and outputs additional debug + * information. * * Defaults to ``false`` */ 'debug' => false, /** - * Sets the data-fingerprint of the current data served - * - * This is a property used by the clients to find out if a backup has been - * restored on the server. Once a backup is restored run + * Set the data fingerprint for the current data served. Used by clients to + * detect if a backup has been restored. Update this by running: * ./occ maintenance:data-fingerprint - * To set this to a new value. * - * Updating/Deleting this value can make connected clients stall until - * the user has resolved conflicts. + * Changing or deleting this value may cause connected clients to stall until + * conflicts are resolved. * * Defaults to ``''`` (empty string) */ 'data-fingerprint' => '', /** - * This entry is just here to show a warning in case somebody copied the sample - * configuration. DO NOT ADD THIS SWITCH TO YOUR CONFIGURATION! + * This entry serves as a warning if the sample configuration was copied. + * DO NOT ADD THIS TO YOUR CONFIGURATION! * - * If you, brave person, have read until here be aware that you should not - * modify *ANY* settings in this file without reading the documentation. + * Ensure all settings are modified only after consulting the documentation. */ 'copied_sample_config' => true, /** - * use a custom lookup server to publish user data + * Use a custom lookup server to publish user data. + * + * Defaults to ``https://lookup.nextcloud.com`` */ 'lookup_server' => 'https://lookup.nextcloud.com', /** - * set to true if the server is used in a setup based on Nextcloud's Global Scale architecture + * Enable Nextcloud's Global Scale architecture. + * + * Defaults to ``false`` */ 'gs.enabled' => false, /** - * by default federation is only used internally in a Global Scale setup - * If you want to allow federation outside your environment set it to 'global' + * Configure federation for Global Scale setups. Set to 'global' to allow + * federation outside the environment. + * + * Defaults to ``internal`` */ 'gs.federation' => 'internal', /** - * List of incompatible user agents opted out from Same Site Cookie Protection. - * Some user agents are notorious and don't really properly follow HTTP - * specifications. For those, have an opt-out. + * List of user agents exempt from SameSite cookie protection due to non-standard + * HTTP behavior. + * + * WARNING: Use only if you understand the implications. * - * WARNING: only use this if you know what you are doing + * Defaults to: + * - /^WebDAVFS/ (OS X Finder) + * - /^Microsoft-WebDAV-MiniRedir/ (Windows WebDAV drive) */ 'csrf.optout' => [ '/^WebDAVFS/', // OS X Finder - '/^Microsoft-WebDAV-MiniRedir/', // Windows webdav drive + '/^Microsoft-WebDAV-MiniRedir/', // Windows WebDAV drive ], /** - * This option allows you to specify a list of allowed user agents for the Login Flow V2. - * If a user agent is not in this list, it will not be allowed to use the Login Flow V2. - * The user agents are defined using regular expressions. + * Specify allowed user agents for Login Flow V2 using regular expressions. + * User agents not matching this list are denied access to Login Flow V2. * - * WARNING: only use this if you know what you are doing + * WARNING: Use only if you understand the implications. * - * Example: Allow only the Nextcloud Android app to use the Login Flow V2 + * Example: Allow only the Nextcloud Android app: * 'core.login_flow_v2.allowed_user_agents' => ['/Nextcloud-android/i'], * - * Defaults to an empty array. + * Defaults to ``[]`` (empty array) */ 'core.login_flow_v2.allowed_user_agents' => [], /** - * By default, there is on public pages a link shown that allows users to - * learn about the "simple sign up" - see https://nextcloud.com/signup/ + * Show or hide the "simple sign up" link on public pages. + * See: https://nextcloud.com/signup/ * - * If this is set to "false" it will not show the link. + * Defaults to ``true`` */ 'simpleSignUpLink.shown' => true, /** - * By default, autocompletion is enabled for the login form on Nextcloud's login page. - * While this is enabled, browsers are allowed to "remember" login names and such. - * Some companies require it to be disabled to comply with their security policy. + * Enable or disable autocompletion for the login form. Disabling this prevents + * browsers from remembering login credentials, which may be required for + * compliance with certain security policies. * - * Simply set this property to "false", if you want to turn this feature off. + * Defaults to ``true`` */ - 'login_form_autocomplete' => true, /** - * Timeout for the login form, after this time the login form is reset. - * This prevents password leaks on public devices if the user forgots to clear the form. + * Set a timeout (in seconds) for the login form. After this period, the form is + * reset to prevent password leaks on public devices if the user forgets to clear + * it. * - * Default is 5 minutes (300 seconds), a value of 0 means no timeout. + * A value of 0 disables the timeout. + * + * Defaults to ``300`` seconds (5 minutes) */ 'login_form_timeout' => 300, /** - * If your user is using an outdated or unsupported browser, a warning will be shown - * to offer some guidance to upgrade or switch and ensure a proper Nextcloud experience. - * They can still bypass it after they have read the warning. + * Suppress warnings for outdated or unsupported browsers. When enabled, users + * can bypass the warning after reading it. + * + * Set to ``true`` to disable the warning. * - * Simply set this property to "true", if you want to turn this feature off. + * Defaults to ``false`` */ - 'no_unsupported_browser_warning' => false, /** - * Disable background scanning of files - * - * By default, a background job runs every 10 minutes and execute a background - * scan to sync filesystem and database. Only users with unscanned files - * (size < 0 in filecache) are included. Maximum 500 users per job. + * Disable background scanning of files. When enabled, a background job runs + * every 10 minutes to sync the filesystem and database for up to 500 users with + * unscanned files (size < 0 in filecache). * * Defaults to ``false`` */ 'files_no_background_scan' => false, /** - * Log all queries into a file + * Log all database queries to a file. * - * Warning: This heavily decreases the performance of the server and is only - * meant to debug/profile the query interaction manually. - * Also, it might log sensitive data into a plain text file. + * WARNING: This significantly reduces server performance and is intended only + * for debugging or profiling query interactions. Sensitive data may be logged in + * plain text. */ 'query_log_file' => '', /** - * Prefix all queries with the requestid when set to `yes` + * Prefix all queries with the request ID when set to `yes`. * * Requires `query_log_file` to be set. */ 'query_log_file_requestid' => '', /** - * Add all query parameters to the query log entry when set to `yes` + * Include all query parameters in the query log when set to `yes`. * * Requires `query_log_file` to be set. - * Warning: This will log sensitive data into a plain text file. + * WARNING: This may log sensitive data in plain text. */ 'query_log_file_parameters' => '', /** - * Add a backtrace to the query log entry when set to `yes` + * Include a backtrace in the query log when set to `yes`. * * Requires `query_log_file` to be set. */ 'query_log_file_backtrace' => '', /** - * Log all redis requests into a file + * Log all Redis requests to a file. * - * Warning: This heavily decreases the performance of the server and is only - * meant to debug/profile the redis interaction manually. - * Also, it might log sensitive data into a plain text file. + * WARNING: This significantly reduces server performance and is intended only + * for debugging or profiling Redis interactions. Sensitive data may be logged in + * plain text. */ 'redis_log_file' => '', /** - * Enable diagnostics event logging + * Enable diagnostics event logging. Logs timings of common execution steps at + * debug level. Use with `log.condition` to enable conditionally in production. * - * If enabled the timings of common execution steps will be logged to the - * Nextcloud log at debug level. log.condition is useful to enable this on - * production systems to only log under some conditions + * Defaults to ``true`` */ 'diagnostics.logging' => true, /** - * Limit diagnostics event logging to events longer than the configured threshold in ms - * - * when set to 0 no diagnostics events will be logged + * Limit diagnostics event logging to events longer than the specified threshold + * (in milliseconds). A value of 0 disables diagnostics event logging. */ 'diagnostics.logging.threshold' => 0, /** - * Enable profile globally + * Enable profiling globally. * * Defaults to ``true`` */ 'profile.enabled' => true, /** - * Allows to override the default scopes for Account data. - * The list of overridable properties and valid values for scopes are in - * ``OCP\Accounts\IAccountManager``. Values added here are merged with - * default values, which are in ``OC\Accounts\AccountManager``. - * - * For instance, if the phone property should default to the private scope - * instead of the local one: - * - * :: - * - * [ - * \OCP\Accounts\IAccountManager::PROPERTY_PHONE => \OCP\Accounts\IAccountManager::SCOPE_PRIVATE - * ] + * Override default scopes for account data. Valid properties and scopes are + * defined in ``OCP\Accounts\IAccountManager``. Values are merged with defaults + * from ``OC\Accounts\AccountManager``. * + * Example: Set phone property to private scope: + * [ + * \OCP\Accounts\IAccountManager::PROPERTY_PHONE => \OCP\Accounts\IAccountManager::SCOPE_PRIVATE + * ] */ 'account_manager.default_property_scope' => [], /** - * Enable the deprecated Projects feature, - * superseded by Related resources as of Nextcloud 25 + * Enable the deprecated Projects feature, superseded by Related Resources since + * Nextcloud 25. * * Defaults to ``false`` */ @@ -2683,31 +2658,38 @@ $CONFIG = [ 'bulkupload.enabled' => true, /** - * Enables fetching open graph metadata from remote urls + * Enable fetching Open Graph metadata from remote URLs. * * Defaults to ``true`` */ 'reference_opengraph' => true, /** - * Enable use of old unified search + * Enable the legacy unified search. * * Defaults to ``false`` */ 'unified_search.enabled' => false, /** - * Enable features that don't respect accessibility standards yet. + * Enable features that do not yet comply with accessibility standards. * * Defaults to ``true`` */ 'enable_non-accessible_features' => true, /** - * Directories where nextcloud looks for binaries. - * This is used to find external binaries like libreoffice, sendmail, ffmpeg and more. + * Directories where Nextcloud searches for external binaries (e.g., LibreOffice, + * sendmail, ffmpeg). * - * Defaults to ``['/usr/local/sbin','/usr/local/bin','/usr/sbin','/usr/bin','/sbin','/bin','/opt/bin']`` + * Defaults to: + * - /usr/local/sbin + * - /usr/local/bin + * - /usr/sbin + * - /usr/bin + * - /sbin + * - /bin + * - /opt/bin */ 'binary_search_paths' => [ '/usr/local/sbin', @@ -2720,36 +2702,36 @@ $CONFIG = [ ], /** - * The maximum chunk size to use for chunked uploads. - * A bigger chunk size results in higher throughput, but above 100 MiB there are only diminishing returns, - * while services like Cloudflare already limit to 100 MiB. + * Maximum chunk size for chunked uploads (in bytes). Larger chunks increase + * throughput but yield diminishing returns above 100 MiB. Services like + * Cloudflare may limit to 100 MiB. * - * Defaults to 100 MiB. + * Defaults to ``100 * 1024 * 1024`` (100 MiB) */ 'files.chunked_upload.max_size' => 100 * 1024 * 1024, /** - * The maximum number of chunks uploaded in parallel during chunked uploads. - * A bigger count results in higher throughput, but will also consume more server workers, - * while the improvements diminish. + * Maximum number of chunks uploaded in parallel during chunked uploads. Higher + * counts increase throughput but consume more server resources, with diminishing + * returns. * - * Defaults to 5. + * Defaults to ``5`` */ 'files.chunked_upload.max_parallel_count' => 5, /** - * Allow users to manually delete files from their trashbin. - * Automated deletions are not affected and will continue to work in cases like low remaining quota for example. + * Allow users to manually delete files from their trashbin. Automated deletions + * (e.g., due to low quota) are unaffected. * - * Defaults to true. + * Defaults to ``true`` */ 'files.trash.delete' => true, /** - * Enable lazy objects feature from PHP 8.4 to be used in the Dependency Injection. - * Should improve performances by avoiding buiding unused objects. + * Enable PHP 8.4 lazy objects for Dependency Injection to improve performance by + * avoiding instantiation of unused objects. * - * Defaults to true. + * Defaults to ``true`` */ 'enable_lazy_objects' => true, ]; |