@@ -5,15 +5,15 @@ Configuration Parameters
55Introduction
66------------
77
8- Nextcloud uses ``config/config.php `` as its main configuration file. This file controls
9- various fundamental aspects of server operations. It is typically modified as part of initial
8+ Nextcloud uses ``config/config.php `` as its main configuration file. This file controls
9+ various fundamental aspects of server operations. It is typically modified as part of initial
1010deployment, when troubleshooting, and when making adjustments to surrounding infrastructure.
1111
12- This is a required file for all Nextcloud deployments and thus it is critical for Nextcloud
12+ This is a required file for all Nextcloud deployments and thus it is critical for Nextcloud
1313administrators to be familiar with managing it.
1414
15- This section of the *Administration Manual * documents how to adjust this essential file,
16- certain special characteristics of the ``config/ `` directory, and all of the supported
15+ This section of the *Administration Manual * documents how to adjust this essential file,
16+ certain special characteristics of the ``config/ `` directory, and all of the supported
1717parameters that can be specified in a ``config/config.php `` file.
1818
1919.. note :: While ``config/config.php`` is a required file, many Nextcloud or Nextcloud app
@@ -23,39 +23,39 @@ parameters that can be specified in a ``config/config.php`` file.
2323Loading
2424-------
2525
26- Configuration files located in ``config/ `` are parsed automatically when Nextcloud
27- starts up. They are also checked for changes periodically (approximately every two seconds
28- in a standard PHP environment running with default *OPcache * settings; approximately every
26+ Configuration files located in ``config/ `` are parsed automatically when Nextcloud
27+ starts up. They are also checked for changes periodically (approximately every two seconds
28+ in a standard PHP environment running with default *OPcache * settings; approximately every
2929sixty seconds in many pre-packaged Nextcloud installation methods).
3030
31- The ``config/config.php `` file may be supplemented by additional ``*.config.php `` files
31+ The ``config/config.php `` file may be supplemented by additional ``*.config.php `` files
3232placed in the ``config/ `` directory (if appropriately named and formatted).
3333
34- .. danger :: Be cautious when naming or creating backup copies of your active
34+ .. danger :: Be cautious when naming or creating backup copies of your active
3535 ``config/config.php ``. If a backup is located within ``config/ `` and is named
3636 ``(ANYTHING).config.php ``, it will be loaded as part of your live configuration
3737 and override your ``config/config.php `` values!
3838
39- .. tip :: If your configuration changes don't seem to be taking effect, check: (a) your PHP opcache
39+ .. tip :: If your configuration changes don't seem to be taking effect, check: (a) your PHP opcache
4040 configuration; (b) for additional ``*.config.php `` files located in ``config/ ``; (c) the documentation
4141 for your Nextcloud installation method/package; (d) the output of ``occ config:list system ``.
4242
4343Format
4444------
4545
46- The short answer is that ``config/ `` files are plain text files with some special formatting
46+ The short answer is that ``config/ `` files are plain text files with some special formatting
4747requirements for different types of parameters and values. This makes it extensible and easy for
48- Nextcloud to interact with. It also makes it easy for administartors to view with any text viewer
48+ Nextcloud to interact with. It also makes it easy for administartors to view with any text viewer
4949and from the command-line.
5050
51- Technically these configuration files are PHP files containing a special (to Nextcloud) PHP array
52- called ``$CONFIG ``. This array consists of various Nextcloud specific "key-value" pairs (in some cases
51+ Technically these configuration files are PHP files containing a special (to Nextcloud) PHP array
52+ called ``$CONFIG ``. This array consists of various Nextcloud specific "key-value" pairs (in some cases
5353arrays themselves). Each pair has the form ``key => value `` and is comma-separated.
5454
5555Types of Values
5656^^^^^^^^^^^^^^^
5757
58- Strings:
58+ Strings:
5959
6060* ``"thisIsAnImportantValue" ``
6161* Note: These must be either single or double quoted - i.e. ``"string" `` or ``'string' ``.
@@ -65,7 +65,7 @@ Strings:
6565 - ``'versions_retention_obligation' => 'auto, D', ``
6666 - ``'logtimezone' => 'Europe/Berlin', ``
6767
68- Boolean:
68+ Boolean:
6969
7070* ``true `` or ``false ``
7171* Note: These should **not ** be surrounded by quote marks within the configuration file itself.
@@ -91,62 +91,62 @@ Arrays of any of the above types:
9191 - ``'connectivity_check_domains' => [ 'www.nextcloud.com', 'www.eff.org', ], ``
9292 - ``'enabledPreviewProviders' => [ 'OC\Preview\BMP', 'OC\Preview\GIF', 'OC\Preview\JPEG', ], ``
9393
94- .. tip :: Nextcloud attempts to remedy some value type/formatting mistakes, but this is not foolproof.
95- Use the correct formatting (for the type of value in question) to avoid unexpected results arising
94+ .. tip :: Nextcloud attempts to remedy some value type/formatting mistakes, but this is not foolproof.
95+ Use the correct formatting (for the type of value in question) to avoid unexpected results arising
9696 from values being cast in unexpected ways.
9797
9898Modifying
9999---------
100100
101- Parameters may be modified in a standard text editor (i.e. via the command-line or externally
101+ Parameters may be modified in a standard text editor (i.e. via the command-line or externally
102102then re-uploaded). They may also, in most cases, be modified using the commands in
103103the ``occ config:system:* `` namespace.
104104
105105.. tip :: Incorrectly formatted ``key => value`` entries (or incorrectly specified values) may
106- not generate immediate errors or problems (such as parsing / syntax errors), but may still
106+ not generate immediate errors or problems (such as parsing / syntax errors), but may still
107107 lead to unexpected and undesirable results. Review your fully parsed (by PHP) configuration
108108 by using the command ``occ config:list system `` and/or ``occ config:list system --private ``
109109 to identify anything unexpected.
110110
111111Defaults
112112--------
113113
114- Nextcloud creates a base ``config/config.php `` file at installation time containing the most
114+ Nextcloud creates a base ``config/config.php `` file at installation time containing the most
115115essential parameters for operations. These values are a mixture of auto-generated and drawn from
116116information provided by the administrator at installation time.
117117
118- The file ``config/config.sample.php `` lists all the parameters within Nextcloud that can be
119- specified in ``config/ `` files, along with example and default values for each. The content of
120- that sample configuration file is included :ref: `below<config-php-sample> ` for ease of reference
118+ The file ``config/config.sample.php `` lists all the parameters within Nextcloud that can be
119+ specified in ``config/ `` files, along with example and default values for each. The content of
120+ that sample configuration file is included :ref: `below<config-php-sample> ` for ease of reference
121121and alongside additional context.
122122
123- .. tip :: Only add parameters to ``config/config.php`` that you wish to modify.
123+ .. tip :: Only add parameters to ``config/config.php`` that you wish to modify.
124124
125- .. danger :: Do not copy everything from ``config/config.sample.php`` into your own
125+ .. danger :: Do not copy everything from ``config/config.sample.php`` into your own
126126 ``config/config.php ``! Besides being unnecessary, it will break things and possibly even
127127 require re-installation.
128128
129129Multiple/Merged Configuration Files
130130-----------------------------------
131131
132- Nextcloud supports loading configuration parameters from multiple files. You can add arbitrary
133- files ending with ``.config.php* `` (i.e. ``*.config.php ``) in the ``config/ `` directory. The values
134- in these files take precedence over ``config/config.php ``. This allows you to easily create and
135- manage custom configurations, or to divide a large complex configuration file into a set of smaller files.
132+ Nextcloud supports loading configuration parameters from multiple files. You can add arbitrary
133+ files ending with ``.config.php* `` (i.e. ``*.config.php ``) in the ``config/ `` directory. The values
134+ in these files take precedence over ``config/config.php ``. This allows you to easily create and
135+ manage custom configurations, or to divide a large complex configuration file into a set of smaller files.
136136These custom files are not overwritten by Nextcloud.
137137
138- For example, you could place your email server configuration in ``config/email.config.php `` and
138+ For example, you could place your email server configuration in ``config/email.config.php `` and
139139whatever parameters you specify in it will be merged with your ``config/config.php ``.
140140
141- .. note :: The values in these additional configuration files **always** take precedence over
141+ .. note :: The values in these additional configuration files **always** take precedence over
142142 ``config/config.php ``.
143143
144- .. tip :: To view your fully merged configuration (i.e. incorporating all config files), use
144+ .. tip :: To view your fully merged configuration (i.e. incorporating all config files), use
145145 ``occ config:list system `` and/or ``occ config:list system --private ``.
146146
147- .. danger :: Be cautious when naming or creating backup copies of your active
148- ``config/config.php ``. If a backup config file is located within ``config/ `` and happens to be
149- named ``(ANYTHING).config.php ``, it will be loaded as part of your live configuration and override
147+ .. danger :: Be cautious when naming or creating backup copies of your active
148+ ``config/config.php ``. If a backup config file is located within ``config/ `` and happens to be
149+ named ``(ANYTHING).config.php ``, it will be loaded as part of your live configuration and override
150150 your ``config/config.php `` values!
151151
152152Examples
@@ -174,8 +174,8 @@ this after installation. The SQLite database is stored in your Nextcloud
174174 'installed' => true,
175175 );
176176
177- .. note :: SQLite is a simple, lightweight embedded database that is fine for testing
178- and simple installations, but production environments you should use MySQL/MariaDB,
177+ .. note :: SQLite is a simple, lightweight embedded database that is fine for testing
178+ and simple installations, but production environments you should use MySQL/MariaDB,
179179 Oracle, or PosgreSQL.
180180
181181This example is from a new Nextcloud installation using MariaDB::
@@ -1380,20 +1380,23 @@ Nextcloud.
13801380Available values (D1 and D2 are configurable numbers):
13811381
13821382* ``auto ``
1383- default setting. keeps files and folders in the trash bin for 30 days
1384- and automatically deletes anytime after that if space is needed (note:
1385- files may not be deleted if space is not needed) .
1383+ Default setting. Keeps files and folders in the trash bin for at least ** 30 ** days.
1384+
1385+ Then, ** if space is needed **, deletes trashed files anytime after that .
13861386* ``D1, auto ``
1387- keeps files and folders in the trash bin for D1+ days, delete anytime if
1388- space needed (note: files may not be deleted if space is not needed)
1387+ Keeps files and folders in the trash bin for at least **D1 ** days.
1388+
1389+ Then, **if space is needed **, deletes trashed files anytime after that.
13891390* ``auto, D2 ``
1390- delete all files in the trash bin that are older than D2 days
1391- automatically, delete other files anytime if space needed
1391+ **If space is needed **, deletes trashed files anytime.
1392+
1393+ After **D2 ** days, delete all trashed files automatically
13921394* ``D1, D2 ``
1393- keep files and folders in the trash bin for at least D1 days and
1394- delete when exceeds D2 days (note: files will not be deleted automatically if space is needed)
1395+ Keeps files and folders in the trash bin for at least **D1 ** days.
1396+
1397+ Then, after **D2 ** days, delete all trashed files automatically.
13951398* ``disabled ``
1396- trash bin auto clean disabled, files and folders will be kept forever
1399+ Trash bin auto clean is disabled, files and folders will be kept forever.
13971400
13981401Defaults to ``auto ``
13991402
@@ -2552,16 +2555,16 @@ memcached_options
25522555 \Memcached::OPT_SEND_TIMEOUT => 50,
25532556 \Memcached::OPT_RECV_TIMEOUT => 50,
25542557 \Memcached::OPT_POLL_TIMEOUT => 50,
2555-
2558+
25562559 // Enable compression
25572560 \Memcached::OPT_COMPRESSION => true,
2558-
2561+
25592562 // Turn on consistent hashing
25602563 \Memcached::OPT_LIBKETAMA_COMPATIBLE => true,
2561-
2564+
25622565 // Enable Binary Protocol
25632566 \Memcached::OPT_BINARY_PROTOCOL => true,
2564-
2567+
25652568 // Binary serializer vill be enabled if the igbinary PECL module is available
25662569 //\Memcached::OPT_SERIALIZER => \Memcached::SERIALIZER_IGBINARY,
25672570 ],
0 commit comments