mirror of
https://github.com/nextcloud/server.git
synced 2026-04-15 22:11:17 -04:00
fix(sample-config): Fix more typos that break RST parsing
Signed-off-by: Joas Schilling <coding@schilljs.com>
This commit is contained in:
parent
0938c5f1ce
commit
074d69820f
1 changed files with 106 additions and 114 deletions
|
|
@ -42,8 +42,6 @@ $CONFIG = [
|
|||
* automatically by the installer. This example is for documentation only,
|
||||
* and you should never use it because it will not work. A valid ``instanceid``
|
||||
* is created when you install Nextcloud.
|
||||
*
|
||||
* 'instanceid' => 'd3c944a9a',
|
||||
*/
|
||||
'instanceid' => '',
|
||||
|
||||
|
|
@ -55,8 +53,6 @@ $CONFIG = [
|
|||
*
|
||||
* @deprecated This salt is deprecated and only used for legacy-compatibility,
|
||||
* developers should *NOT* use this value for anything nowadays.
|
||||
*
|
||||
* 'passwordsalt' => 'd3c944a9af095aa08f',
|
||||
*/
|
||||
'passwordsalt' => '',
|
||||
|
||||
|
|
@ -70,15 +66,13 @@ $CONFIG = [
|
|||
* Your list of trusted domains that users can log into. Specifying trusted
|
||||
* domains prevents host header poisoning. Do not remove this, as it performs
|
||||
* 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.
|
||||
* This disallows all other ports on this host
|
||||
* - 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
|
||||
* Using TLS certificates where commonName=<IP address> is deprecated
|
||||
* - 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 ``ubos-raspberry-pi.local`` and ``ubos-raspberry-pi-2.local``
|
||||
* - 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',
|
||||
|
|
@ -88,11 +82,11 @@ $CONFIG = [
|
|||
],
|
||||
|
||||
/**
|
||||
* The validity domain for cookies, for example '' (cookies will be sent only
|
||||
* the domain that defined it, e.g. 'demo.example.org'), 'demo.example.org'
|
||||
* The validity domain for cookies, for example ``''`` (cookies will be sent only
|
||||
* the domain that defined it, e.g. ``'demo.example.org'``), ``'demo.example.org'``
|
||||
* (cookies will be valid for the domain and all subdomains), ...
|
||||
*
|
||||
* Defaults to '' (safe option)
|
||||
* Defaults to ``''`` (safe option)
|
||||
*/
|
||||
'cookie_domain' => '',
|
||||
|
||||
|
|
@ -160,7 +154,7 @@ $CONFIG = [
|
|||
|
||||
/**
|
||||
* Enable persistent connections to the database.
|
||||
* This setting uses the "persistent" option from Doctrine DBAL, which in turn
|
||||
* This setting uses the ``persistent`` option from Doctrine DBAL, which in turn
|
||||
* uses the PDO::ATTR_PERSISTENT option from the PDO driver.
|
||||
*/
|
||||
'dbpersistent' => '',
|
||||
|
|
@ -204,9 +198,9 @@ $CONFIG = [
|
|||
* 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
|
||||
* 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
|
||||
* the user has chosen something different explicitly.
|
||||
*
|
||||
* Defaults to ``en``
|
||||
|
|
@ -241,7 +235,7 @@ $CONFIG = [
|
|||
* 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.
|
||||
*
|
||||
* For example: Set to ['de', 'fr'] to only allow German and French languages.
|
||||
* For example: Set to ``['de', 'fr']`` to only allow German and French languages.
|
||||
*/
|
||||
'reduce_to_languages' => [],
|
||||
|
||||
|
|
@ -278,7 +272,8 @@ $CONFIG = [
|
|||
|
||||
/**
|
||||
* ``true`` enables the Help menu item in the user menu (top right of the
|
||||
* Nextcloud Web interface). ``false`` removes the Help item.
|
||||
* Nextcloud Web interface).
|
||||
* ``false`` removes the Help item.
|
||||
*/
|
||||
'knowledgebaseenabled' => true,
|
||||
|
||||
|
|
@ -335,8 +330,8 @@ $CONFIG = [
|
|||
/**
|
||||
* The lifetime of a session after inactivity.
|
||||
*
|
||||
* The maximum possible time is limited by the session.gc_maxlifetime php.ini setting
|
||||
* which would overwrite this option if it is less than the value in the config.php
|
||||
* The maximum possible time is limited by the ``session.gc_maxlifetime`` php.ini setting
|
||||
* which would overwrite this option if it is less than the value in the ``config.php``
|
||||
*
|
||||
* Defaults to ``60*60*24`` seconds (24 hours)
|
||||
*/
|
||||
|
|
@ -348,23 +343,23 @@ $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,
|
||||
|
||||
/**
|
||||
* The limit applied to the synchronization report request, e.g. federated system address books (as run by `occ federation:sync-addressbooks`).
|
||||
* The limit applied to the synchronization report request, e.g. federated system address books (as run by ``occ federation:sync-addressbooks``).
|
||||
*/
|
||||
'carddav_sync_request_truncation' => 2500,
|
||||
|
||||
/**
|
||||
* `true` enables 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.
|
||||
*
|
||||
* This may lead to sessions being available for longer than what session_lifetime uses but
|
||||
* 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
|
||||
* requests.
|
||||
*/
|
||||
|
|
@ -381,9 +376,10 @@ $CONFIG = [
|
|||
/**
|
||||
* Enable or disable the automatic logout after session_lifetime, even if session
|
||||
* keepalive is enabled. This will make sure that an inactive browser will log itself out
|
||||
* even if requests to the server might extend the session lifetime. Note: the logout is
|
||||
* handled on the client side. This is not a way to limit the duration of potentially
|
||||
* compromised sessions.
|
||||
* even if requests to the server might extend the session lifetime.
|
||||
*
|
||||
* NOTE: The logout is handled on the client side. This is not a way to
|
||||
* limit the duration of potentially compromised sessions.
|
||||
*
|
||||
* Defaults to ``false``
|
||||
*/
|
||||
|
|
@ -413,7 +409,7 @@ $CONFIG = [
|
|||
/**
|
||||
* Whether the brute force protection shipped with Nextcloud should be enabled or not.
|
||||
*
|
||||
* Disabling this is discouraged for security reasons.
|
||||
* WARNING: Disabling this is discouraged for security reasons.
|
||||
*
|
||||
* Defaults to ``true``
|
||||
*/
|
||||
|
|
@ -457,7 +453,7 @@ $CONFIG = [
|
|||
/**
|
||||
* Whether the rate limit protection shipped with Nextcloud should be enabled or not.
|
||||
*
|
||||
* Disabling this is discouraged for security reasons.
|
||||
* WARNING: Disabling this is discouraged for security reasons.
|
||||
*
|
||||
* Defaults to ``true``
|
||||
*/
|
||||
|
|
@ -502,16 +498,16 @@ $CONFIG = [
|
|||
* admin wants to avoid users entering their credentials to the system if the SSO
|
||||
* app is unavailable.
|
||||
*
|
||||
* This will show an error. But the direct login still works with adding ?direct=1
|
||||
* This will show an error. But the direct login still works with adding ``?direct=1``
|
||||
*/
|
||||
'hide_login_form' => false,
|
||||
|
||||
/**
|
||||
* 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
|
||||
* 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'
|
||||
* 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',
|
||||
|
||||
|
|
@ -717,40 +713,40 @@ $CONFIG = [
|
|||
'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
|
||||
* 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
|
||||
* 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",
|
||||
* the correct value would most likely be "/nextcloud". If Nextcloud is running
|
||||
* under "https://mycloud.org/", then it would be "/".
|
||||
* 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 ``/``.
|
||||
*
|
||||
* 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
|
||||
* 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
|
||||
* - ``mod_rewrite`` is installed
|
||||
* - ``mod_env`` is installed
|
||||
*
|
||||
* Defaults to ``''`` (empty string)
|
||||
*/
|
||||
'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
|
||||
* parameter, and you updated your .htaccess with `occ maintenance:update:htaccess`.
|
||||
* Otherwise, your Nextcloud installation might not be reachable anymore.
|
||||
* For example, try accessing resources by leaving out `index.php` in the URL.
|
||||
* 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 any more.
|
||||
* For example, try accessing resources by leaving out ``index.php`` in the URL.
|
||||
*/
|
||||
'htaccess.IgnoreFrontController' => false,
|
||||
|
||||
|
|
@ -758,7 +754,7 @@ $CONFIG = [
|
|||
* The URL of your proxy server, for example, ``proxy.example.com:8081``.
|
||||
*
|
||||
* 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.
|
||||
* variables ``HTTP_PROXY`` (only for CLI requests), ``HTTPS_PROXY``, and ``NO_PROXY`` by default.
|
||||
*
|
||||
* If you configure a proxy with Nextcloud, any default configuration by Guzzle
|
||||
* is overwritten. Make sure to set ``proxyexclude`` accordingly if necessary.
|
||||
|
|
@ -780,7 +776,7 @@ $CONFIG = [
|
|||
* For example: ``['.mit.edu', 'foo.com']``.
|
||||
*
|
||||
* Hint: Use something like ``explode(',', getenv('NO_PROXY'))`` to sync this
|
||||
* value with the global NO_PROXY option.
|
||||
* value with the global ``NO_PROXY`` option.
|
||||
*
|
||||
* Defaults to empty array.
|
||||
*/
|
||||
|
|
@ -789,7 +785,7 @@ $CONFIG = [
|
|||
/**
|
||||
* Allow remote servers with local addresses, e.g., in federated shares, webcal services, and more
|
||||
*
|
||||
* Defaults to false
|
||||
* Defaults to ``false``
|
||||
*/
|
||||
'allow_local_remote_servers' => true,
|
||||
|
||||
|
|
@ -951,8 +947,8 @@ $CONFIG = [
|
|||
* will show a warning. Set to an empty list to not do any such checks (warning
|
||||
* will still be shown).
|
||||
* If no protocol is provided, both http and https will be tested.
|
||||
* For example, 'http://www.nextcloud.com' and 'https://www.nextcloud.com'
|
||||
* will be tested for 'www.nextcloud.com'
|
||||
* For example, ``http://www.nextcloud.com`` and ``https://www.nextcloud.com``
|
||||
* will be tested for ``www.nextcloud.com``
|
||||
* If a protocol is provided, only this one will be tested.
|
||||
*
|
||||
* Defaults to the following domains:
|
||||
|
|
@ -972,7 +968,7 @@ $CONFIG = [
|
|||
/**
|
||||
* Allows Nextcloud to verify a working .well-known URL redirects. This is done
|
||||
* by attempting to make a request from JS to
|
||||
* https://your-domain.com/.well-known/caldav/
|
||||
* ``https://example.tld/.well-known/caldav/``
|
||||
*
|
||||
* Defaults to ``true``
|
||||
*/
|
||||
|
|
@ -1019,15 +1015,11 @@ $CONFIG = [
|
|||
|
||||
/**
|
||||
* This parameter determines where the Nextcloud logs are sent.
|
||||
* ``file``: the logs are written to file ``nextcloud.log`` in the default
|
||||
* Nextcloud data directory. The log file can be changed with parameter
|
||||
* ``logfile``.
|
||||
* ``syslog``: the logs are sent to the system log. This requires a syslog daemon
|
||||
* to be active.
|
||||
* ``errorlog``: the logs are sent to the PHP ``error_log`` function.
|
||||
* ``systemd``: the logs are sent to the Systemd journal. This requires a system
|
||||
* that runs Systemd and the Systemd journal. The PHP extension ``systemd``
|
||||
* must be installed and active.
|
||||
*
|
||||
* - ``file``: the logs are written to file ``nextcloud.log`` in the default Nextcloud data directory. The log file can be changed with parameter ``logfile``.
|
||||
* - ``syslog``: the logs are sent to the system log. This requires a syslog daemon to be active.
|
||||
* - ``errorlog``: the logs are sent to the PHP ``error_log`` function.
|
||||
* - ``systemd``: the logs are sent to the Systemd journal. This requires a system that runs Systemd and the Systemd journal. The PHP extension ``systemd`` must be installed and active.
|
||||
*
|
||||
* Defaults to ``file``
|
||||
*/
|
||||
|
|
@ -1059,7 +1051,7 @@ $CONFIG = [
|
|||
/**
|
||||
* Log file mode for the Nextcloud logging type in octal notation.
|
||||
*
|
||||
* Defaults to 0640 (writable by user, readable by group).
|
||||
* Defaults to ``0640`` (writable by user, readable by group).
|
||||
*/
|
||||
'logfilemode' => 0640,
|
||||
|
||||
|
|
@ -1410,15 +1402,15 @@ $CONFIG = [
|
|||
* including previews that need to be newly generated, and those that have
|
||||
* been generated.
|
||||
*
|
||||
* This should be greater than 'preview_concurrency_new'.
|
||||
* If unspecified, defaults to twice the value of 'preview_concurrency_new'.
|
||||
* This should be greater than ``preview_concurrency_new``.
|
||||
* If unspecified, defaults to twice the value of ``preview_concurrency_new``.
|
||||
*/
|
||||
'preview_concurrency_all' => 8,
|
||||
|
||||
/**
|
||||
* Number of new previews that are being concurrently generated.
|
||||
*
|
||||
* Depending on the max preview size set by 'preview_max_x' and 'preview_max_y',
|
||||
* Depending on the max preview size set by ``preview_max_x`` and ``preview_max_y``,
|
||||
* the generation process can consume considerable CPU and memory resources.
|
||||
* It's recommended to limit this to be no greater than the number of CPU cores.
|
||||
* If unspecified, defaults to the number of CPU cores, or 4 if that cannot
|
||||
|
|
@ -1455,7 +1447,7 @@ $CONFIG = [
|
|||
* 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.
|
||||
* be disabled and the default mimetype icon is shown. Set to ``-1`` for no limit.
|
||||
*
|
||||
* Defaults to ``256`` megabytes
|
||||
*/
|
||||
|
|
@ -1589,7 +1581,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.
|
||||
* @deprecated since Nextcloud 29 - Use the frontend instead or set the app config value `group.sortBy` for `core` to `2`
|
||||
* @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,
|
||||
|
||||
|
|
@ -1997,7 +1989,7 @@ $CONFIG = [
|
|||
'sharing.enable_share_accept' => false,
|
||||
|
||||
/**
|
||||
* Set to true to enforce that internal shares need to be accepted
|
||||
* Set to ``true`` to enforce that internal shares need to be accepted
|
||||
*/
|
||||
'sharing.force_share_accept' => false,
|
||||
|
||||
|
|
@ -2026,8 +2018,8 @@ $CONFIG = [
|
|||
|
||||
/**
|
||||
* Set to true to always transfer incoming shares by default
|
||||
* when running "occ files:transfer-ownership".
|
||||
* Defaults to false, so incoming shares are not transferred if not specifically requested
|
||||
* when running ``occ files:transfer-ownership``.
|
||||
* Defaults to ``false``, so incoming shares are not transferred if not specifically requested
|
||||
* by a command line argument.
|
||||
*/
|
||||
'transferIncomingShares' => false,
|
||||
|
|
@ -2058,7 +2050,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.
|
||||
*/
|
||||
|
|
@ -2073,7 +2065,7 @@ $CONFIG = [
|
|||
|
||||
/**
|
||||
* The number of iterations that are used by the algorithm for computing a hash.
|
||||
* The value must be an integer, and the minimum value is 1. Values that
|
||||
* The value must be an integer, and the minimum value is ``1``. Values that
|
||||
* undershoot the minimum will be ignored in favor of the minimum.
|
||||
*/
|
||||
'hashingTimeCost' => PASSWORD_ARGON2_DEFAULT_TIME_COST,
|
||||
|
|
@ -2094,10 +2086,10 @@ $CONFIG = [
|
|||
*
|
||||
* 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
|
||||
* ``PDO::MYSQL_ATTR_SSL_VERIFY_SERVER_CERT`` might need to be set to false, if the
|
||||
* 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.
|
||||
* does not verify the server cert except ``--ssl-verify-server-cert`` is passed manually.
|
||||
*/
|
||||
'dbdriveroptions' => [
|
||||
PDO::MYSQL_ATTR_SSL_CA => '/file/path/to/ca_cert.pem',
|
||||
|
|
@ -2109,7 +2101,7 @@ $CONFIG = [
|
|||
|
||||
/**
|
||||
* 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.
|
||||
* can be ``'WAL'`` or ``'DELETE'``. See https://www.sqlite.org/wal.html for more details.
|
||||
*/
|
||||
'sqlite.journal_mode' => 'DELETE',
|
||||
|
||||
|
|
@ -2209,8 +2201,8 @@ $CONFIG = [
|
|||
|
||||
/**
|
||||
* 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.
|
||||
* 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.
|
||||
|
|
@ -2248,7 +2240,7 @@ $CONFIG = [
|
|||
* existing files cannot be updated, and no new files can be created in matching
|
||||
* folders.
|
||||
*
|
||||
* The '/' and '\' characters, as well as ASCII characters [0-31], are always
|
||||
* The ``/`` and ``\`` characters, as well as ASCII characters [0-31], are always
|
||||
* forbidden.
|
||||
*
|
||||
* Example for Windows: ``['?', '<', '>', ':', '*', '|', '"']``
|
||||
|
|
@ -2262,7 +2254,7 @@ $CONFIG = [
|
|||
* 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 it is used internally by Nextcloud.
|
||||
* The ``'.part'`` extension is always forbidden, as it is used internally by Nextcloud.
|
||||
*
|
||||
* Defaults to ``['.filepart', '.part']``
|
||||
*/
|
||||
|
|
@ -2278,8 +2270,8 @@ $CONFIG = [
|
|||
|
||||
/**
|
||||
* 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.
|
||||
* valid ITheme ID, e.g., ``dark``, ``dark-highcontrast``, ``default``, ``light``,
|
||||
* ``light-highcontrast``, ``opendyslexic``.
|
||||
*/
|
||||
'enforce_theme' => '',
|
||||
|
||||
|
|
@ -2378,9 +2370,8 @@ $CONFIG = [
|
|||
|
||||
/**
|
||||
* 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
|
||||
* 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``
|
||||
*/
|
||||
|
|
@ -2391,10 +2382,8 @@ $CONFIG = [
|
|||
* 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 are possible.
|
||||
* - ``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 are possible.
|
||||
*
|
||||
* Defaults to ``0``
|
||||
*/
|
||||
|
|
@ -2427,16 +2416,17 @@ $CONFIG = [
|
|||
|
||||
/**
|
||||
* 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`
|
||||
*
|
||||
* If a request's `REMOTE_ADDR` matches an address here, it is treated as a proxy,
|
||||
* - 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``
|
||||
*
|
||||
* 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`.
|
||||
* ``forwarded_for_headers`` instead of ``REMOTE_ADDR``.
|
||||
*
|
||||
* Ensure `forwarded_for_headers` is configured if `trusted_proxies` is set.
|
||||
* Ensure ``forwarded_for_headers`` is configured if ``trusted_proxies`` is set.
|
||||
*
|
||||
* Defaults to ``[]`` (empty array)
|
||||
*/
|
||||
|
|
@ -2444,8 +2434,8 @@ $CONFIG = [
|
|||
|
||||
/**
|
||||
* 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.
|
||||
* ``trusted_proxies``. For example, use ``HTTP_X_FORWARDED_FOR`` for the
|
||||
* ``X-Forwarded-For`` header.
|
||||
*
|
||||
* Incorrect configuration allows clients to spoof their IP address, bypassing
|
||||
* access controls and rendering logs unreliable.
|
||||
|
|
@ -2459,8 +2449,8 @@ $CONFIG = [
|
|||
* must originate from IPs within these 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`
|
||||
* - 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 ``[]`` (empty array)
|
||||
*/
|
||||
|
|
@ -2480,7 +2470,7 @@ $CONFIG = [
|
|||
* Set the lock's time-to-live (TTL) in seconds. Locks older than this are
|
||||
* automatically cleaned up.
|
||||
*
|
||||
* Defaults to ``3600`` seconds (1 hour) or the PHP `max_execution_time`,
|
||||
* Defaults to ``3600`` seconds (1 hour) or the PHP ``max_execution_time``,
|
||||
* whichever is higher.
|
||||
*/
|
||||
'filelocking.ttl' => 60 * 60,
|
||||
|
|
@ -2498,7 +2488,7 @@ $CONFIG = [
|
|||
* entries, potentially causing performance degradation and large log files on
|
||||
* busy instances.
|
||||
*
|
||||
* Use with `log.condition` to limit logging in production environments.
|
||||
* Use with ``log.condition`` to limit logging in production environments.
|
||||
*
|
||||
* Defaults to ``false``
|
||||
*/
|
||||
|
|
@ -2540,8 +2530,8 @@ $CONFIG = [
|
|||
|
||||
/**
|
||||
* 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
|
||||
* detect if a backup has been restored. Update this by running::
|
||||
* occ maintenance:data-fingerprint
|
||||
*
|
||||
* Changing or deleting this value may cause connected clients to stall until
|
||||
* conflicts are resolved.
|
||||
|
|
@ -2573,7 +2563,7 @@ $CONFIG = [
|
|||
'gs.enabled' => false,
|
||||
|
||||
/**
|
||||
* Configure federation for Global Scale setups. Set to 'global' to allow
|
||||
* Configure federation for Global Scale setups. Set to ``global`` to allow
|
||||
* federation outside the environment.
|
||||
*
|
||||
* Defaults to ``internal``
|
||||
|
|
@ -2587,8 +2577,9 @@ $CONFIG = [
|
|||
* WARNING: Use only if you understand the implications.
|
||||
*
|
||||
* Defaults to:
|
||||
* - /^WebDAVFS/ (OS X Finder)
|
||||
* - /^Microsoft-WebDAV-MiniRedir/ (Windows WebDAV drive)
|
||||
*
|
||||
* - ``/^WebDAVFS/`` (OS X Finder)
|
||||
* - ``/^Microsoft-WebDAV-MiniRedir/`` (Windows WebDAV drive)
|
||||
*/
|
||||
'csrf.optout' => [
|
||||
'/^WebDAVFS/', // OS X Finder
|
||||
|
|
@ -2601,8 +2592,9 @@ $CONFIG = [
|
|||
*
|
||||
* WARNING: Use only if you understand the implications.
|
||||
*
|
||||
* Example: Allow only the Nextcloud Android app:
|
||||
* 'core.login_flow_v2.allowed_user_agents' => ['/Nextcloud-android/i'],
|
||||
* Example: Allow only the Nextcloud Android app::
|
||||
*
|
||||
* 'core.login_flow_v2.allowed_user_agents' => ['/Nextcloud-android/i'],
|
||||
*
|
||||
* Defaults to ``[]`` (empty array)
|
||||
*/
|
||||
|
|
@ -2667,14 +2659,14 @@ $CONFIG = [
|
|||
/**
|
||||
* Prefix all queries with the request ID when set to `yes`.
|
||||
*
|
||||
* Requires `query_log_file` to be set.
|
||||
* Requires ``query_log_file`` to be set.
|
||||
*/
|
||||
'query_log_file_requestid' => '',
|
||||
|
||||
/**
|
||||
* Include all query parameters in the query log when set to `yes`.
|
||||
*
|
||||
* Requires `query_log_file` to be set.
|
||||
* Requires ``query_log_file`` to be set.
|
||||
* WARNING: This may log sensitive data in plain text.
|
||||
*/
|
||||
'query_log_file_parameters' => '',
|
||||
|
|
@ -2682,7 +2674,7 @@ $CONFIG = [
|
|||
/**
|
||||
* Include a backtrace in the query log when set to `yes`.
|
||||
*
|
||||
* Requires `query_log_file` to be set.
|
||||
* Requires ``query_log_file`` to be set.
|
||||
*/
|
||||
'query_log_file_backtrace' => '',
|
||||
|
||||
|
|
@ -2697,7 +2689,7 @@ $CONFIG = [
|
|||
|
||||
/**
|
||||
* Enable diagnostics event logging. Logs timings of common execution steps at
|
||||
* debug level. Use with `log.condition` to enable conditionally in production.
|
||||
* debug level. Use with ``log.condition`` to enable conditionally in production.
|
||||
*
|
||||
* Defaults to ``true``
|
||||
*/
|
||||
|
|
|
|||
Loading…
Reference in a new issue