Browse Source

Merge pull request #35881 from nextcloud/dev/fix-config-template

improve sample.config.php parameter descriptions
pull/35907/head
Simon L 3 years ago
committed by GitHub
parent
commit
65995ea95a
No known key found for this signature in database GPG Key ID: 4AEE18F83AFDEB23
  1. 173
      config/config.sample.php

173
config/config.sample.php

@ -675,7 +675,7 @@ $CONFIG = [
* and a maximum time for trash bin retention.
*
* 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
* *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
* not needed.
*
@ -687,8 +687,8 @@ $CONFIG = [
* * If a user quota is defined, 50% of the user's remaining quota space sets
* the limit for the trashbin.
*
* Maximum time is the number of days at which it is _guaranteed
* to be_ deleted. There is no further dependency on the available space.
* Maximum time is the number of days at which it is *guaranteed
* to be* deleted. There is no further dependency on the available space.
*
* Both minimum and maximum times can be set together to explicitly define
* file and folder deletion. For migration purposes, this setting is installed
@ -1193,7 +1193,7 @@ $CONFIG = [
/**
* Set the URL of the Imaginary service to send image previews to.
* Also requires the OC\Preview\Imaginary provider to be enabled.
* Also requires the ``OC\Preview\Imaginary`` provider to be enabled.
*
* See https://github.com/h2non/imaginary
*/
@ -1205,33 +1205,33 @@ $CONFIG = [
* The following providers are disabled by default due to performance or privacy
* concerns:
*
* - OC\Preview\Illustrator
* - OC\Preview\HEIC
* - OC\Preview\Movie
* - OC\Preview\MSOffice2003
* - OC\Preview\MSOffice2007
* - OC\Preview\MSOfficeDoc
* - OC\Preview\PDF
* - OC\Preview\Photoshop
* - OC\Preview\Postscript
* - OC\Preview\StarOffice
* - OC\Preview\SVG
* - OC\Preview\TIFF
* - OC\Preview\Font
* - ``OC\Preview\Illustrator``
* - ``OC\Preview\HEIC``
* - ``OC\Preview\Movie``
* - ``OC\Preview\MSOffice2003``
* - ``OC\Preview\MSOffice2007``
* - ``OC\Preview\MSOfficeDoc``
* - ``OC\Preview\PDF``
* - ``OC\Preview\Photoshop``
* - ``OC\Preview\Postscript``
* - ``OC\Preview\StarOffice``
* - ``OC\Preview\SVG``
* - ``OC\Preview\TIFF``
* - ``OC\Preview\Font``
*
*
* Defaults to the following providers:
*
* - OC\Preview\BMP
* - OC\Preview\GIF
* - OC\Preview\JPEG
* - OC\Preview\MarkDown
* - OC\Preview\MP3
* - OC\Preview\PNG
* - OC\Preview\TXT
* - OC\Preview\XBitmap
* - OC\Preview\OpenDocument
* - OC\Preview\Krita
* - ``OC\Preview\BMP``
* - ``OC\Preview\GIF``
* - ``OC\Preview\JPEG``
* - ``OC\Preview\MarkDown``
* - ``OC\Preview\MP3``
* - ``OC\Preview\PNG``
* - ``OC\Preview\TXT``
* - ``OC\Preview\XBitmap``
* - ``OC\Preview\OpenDocument``
* - ``OC\Preview\Krita``
*/
'enabledPreviewProviders' => [
'OC\Preview\PNG',
@ -1664,6 +1664,14 @@ $CONFIG = [
*/
'sharing.allow_custom_share_folder' => true,
/**
* Define a default folder for shared files and folders other than root.
* Changes to this value will only have effect on new shares.
*
* Defaults to ``/``
*/
'share_folder' => '/',
/**
* Set to ``false``, to stop sending a mail when users receive a share
*/
@ -1682,6 +1690,49 @@ $CONFIG = [
*/
'transferIncomingShares' => false,
/**
* Hashing
*/
/**
* 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.
*
* 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
* be found at: https://www.php.net/manual/en/function.password-hash.php
*/
'hashing_default_password' => false,
/**
* 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
* 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.
*/
'hashingThreads' => PASSWORD_ARGON2_DEFAULT_THREADS,
/**
* The memory in KiB to be used by the algorithm for computing a hash. The value
* must be an integer, and the minimum value is 8 times the number of CPU threads.
* Values that undershoot the minimum will be ignored in favor of the minimum.
*/
'hashingMemoryCost' => PASSWORD_ARGON2_DEFAULT_MEMORY_COST,
/**
* 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
* undershoot the minimum will be ignored in favor of the minimum.
*/
'hashingTimeCost' => PASSWORD_ARGON2_DEFAULT_TIME_COST,
/**
* The hashing cost used by hashes generated by Nextcloud
* Using a higher value requires more time and CPU power to calculate the hashes
*/
'hashingCost' => 10,
/**
* All other configuration options
*/
@ -1802,52 +1853,6 @@ $CONFIG = [
*/
'updatedirectory' => '',
/**
* Hashing
*/
/**
* 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.
*/
'hashing_default_password' => false,
/**
*
* 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
* be found at: https://www.php.net/manual/en/function.password-hash.php
*/
/**
* 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
* 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.
*/
'hashingThreads' => PASSWORD_ARGON2_DEFAULT_THREADS,
/**
* The memory in KiB to be used by the algorithm for computing a hash. The value
* must be an integer, and the minimum value is 8 times the number of CPU threads.
* Values that undershoot the minimum will be ignored in favor of the minimum.
*/
'hashingMemoryCost' => PASSWORD_ARGON2_DEFAULT_MEMORY_COST,
/**
* 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
* undershoot the minimum will be ignored in favor of the minimum.
*/
'hashingTimeCost' => PASSWORD_ARGON2_DEFAULT_TIME_COST,
/**
* The hashing cost used by hashes generated by Nextcloud
* Using a higher value requires more time and CPU power to calculate the hashes
*/
'hashingCost' => 10,
/**
* Blacklist a specific file or files and disallow the upload of files
* with this name. ``.htaccess`` is blocked by default.
@ -1857,14 +1862,6 @@ $CONFIG = [
*/
'blacklisted_files' => ['.htaccess'],
/**
* Define a default folder for shared files and folders other than root.
* Changes to this value will only have effect on new shares.
*
* Defaults to ``/``
*/
'share_folder' => '/',
/**
* If you are applying a theme to Nextcloud, enter the name of the theme here.
* The default location for themes is ``nextcloud/themes/``.
@ -2286,14 +2283,18 @@ $CONFIG = [
/**
* 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
* ``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
* ]
*
* ::
*
* [
* \OCP\Accounts\IAccountManager::PROPERTY_PHONE => \OCP\Accounts\IAccountManager::SCOPE_PRIVATE
* ]
*
*/
'account_manager.default_property_scope' => [],

Loading…
Cancel
Save