Skip to content

Commit 0472da8

Browse files
committed
fix(trash bin): Improve clarity of files retention config
Signed-off-by: Louis Chemineau <louis@chmn.me> Signed-off-by: Louis Chmn <louis@chmn.me>
1 parent 036f93e commit 0472da8

1 file changed

Lines changed: 57 additions & 54 deletions

File tree

admin_manual/configuration_server/config_sample_php_parameters.rst

Lines changed: 57 additions & 54 deletions
Original file line numberDiff line numberDiff line change
@@ -5,15 +5,15 @@ Configuration Parameters
55
Introduction
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
1010
deployment, 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
1313
administrators 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
1717
parameters 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.
2323
Loading
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
2929
sixty 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
3232
placed 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

4343
Format
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
4747
requirements 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 administrators to view with any text viewer
48+
Nextcloud to interact with. It also makes it easy for administrators to view with any text viewer
4949
and 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
5353
arrays themselves). Each pair has the form ``key => value`` and is comma-separated.
5454

5555
Types 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

9898
Modifying
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
102102
then re-uploaded). They may also, in most cases, be modified using the commands in
103103
the ``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

111111
Defaults
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
115115
essential parameters for operations. These values are a mixture of auto-generated and drawn from
116116
information 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
121121
and 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

129129
Multiple/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.
136136
These 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
139139
whatever 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

152152
Examples
@@ -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

181181
This example is from a new Nextcloud installation using MariaDB::
@@ -1441,20 +1441,23 @@ Nextcloud.
14411441
Available values (D1 and D2 are configurable numbers):
14421442

14431443
* ``auto``
1444-
default setting. Keeps files and folders in the trash bin for 30 days
1445-
and automatically deletes anytime after that if space is needed (note:
1446-
files may not be deleted if space is not needed).
1444+
Default setting. Keeps files and folders in the trash bin for at least **30** days.
1445+
1446+
Then, **if space is needed**, deletes trashed files anytime after that.
14471447
* ``D1, auto``
1448-
keeps files and folders in the trash bin for D1+ days, delete anytime if
1449-
space needed (note: files may not be deleted if space is not needed)
1448+
Keeps files and folders in the trash bin for at least **D1** days.
1449+
1450+
Then, **if space is needed**, deletes trashed files anytime after that.
14501451
* ``auto, D2``
1451-
delete all files in the trash bin that are older than D2 days
1452-
automatically, delete other files anytime if space needed
1452+
**If space is needed**, deletes trashed files anytime.
1453+
1454+
After **D2** days, delete all trashed files automatically
14531455
* ``D1, D2``
1454-
keep files and folders in the trash bin for at least D1 days and
1455-
delete when exceeds D2 days (note: files will not be deleted automatically if space is needed)
1456+
Keeps files and folders in the trash bin for at least **D1** days.
1457+
1458+
Then, after **D2** days, delete all trashed files automatically.
14561459
* ``disabled``
1457-
trash bin auto clean disabled, files and folders will be kept forever
1460+
Trash bin auto clean is disabled, files and folders will be kept forever.
14581461

14591462
Defaults to ``auto``
14601463

@@ -2116,7 +2119,7 @@ like in normal shares (when set to ``true``).
21162119
.. warning::
21172120

21182121
Enabling this comes with some CRITICAL trade-offs:
2119-
2122+
21202123
- If team folder "Advanced Permissions" (ACLs) are used, activities do not
21212124
respect the permissions and therefore all users see all activities, even
21222125
for files and directories they do not have access to.
@@ -2784,16 +2787,16 @@ memcached_options
27842787
\Memcached::OPT_SEND_TIMEOUT => 50,
27852788
\Memcached::OPT_RECV_TIMEOUT => 50,
27862789
\Memcached::OPT_POLL_TIMEOUT => 50,
2787-
2790+
27882791
// Enable compression
27892792
\Memcached::OPT_COMPRESSION => true,
2790-
2793+
27912794
// Turn on consistent hashing
27922795
\Memcached::OPT_LIBKETAMA_COMPATIBLE => true,
2793-
2796+
27942797
// Enable Binary Protocol
27952798
\Memcached::OPT_BINARY_PROTOCOL => true,
2796-
2799+
27972800
// Binary serializer will be enabled if the igbinary PECL module is available
27982801
//\Memcached::OPT_SERIALIZER => \Memcached::SERIALIZER_IGBINARY,
27992802
],

0 commit comments

Comments
 (0)