Skip to content

fix(sample-config): Fix sample config so parsing works again #55777

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
nickvergessen merged 4 commits into from
Oct 16, 2025
Merged

fix(sample-config): Fix sample config so parsing works again #55777

Changes from 3 commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
126944b
fix(sample-config): Fix sample config so parsing works again
nickvergessen Oct 15, 2025
5ef933f
fix(sample-config): Fix more list, note and warning blocks
nickvergessen Oct 15, 2025
0938c5f
fix(config-sample): Deduplicate warning
nickvergessen Oct 15, 2025
074d698
fix(sample-config): Fix more typos that break RST parsing
nickvergessen Oct 15, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
79 changes: 41 additions & 38 deletions config/config.sample.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -757,7 +757,7 @@
/**
* The URL of your proxy server, for example, ``proxy.example.com:8081``.
*
* Note: Guzzle (the HTTP library used by Nextcloud) reads the environment
* 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 a proxy with Nextcloud, any default configuration by Guzzle
Expand Down Expand Up @@ -1064,10 +1064,16 @@
'logfilemode' => 0640,

/**
* Loglevel to start logging at. Valid values are: 0 = Debug, 1 = Info, 2 =
* Warning, 3 = Error, and 4 = Fatal. The default value is Warning.
* Loglevel to start logging at. Valid values are:
*
* Defaults to ``2``
* - ``0`` = Debug
* - ``1`` = Info
* - ``2`` = Warning
* - ``3`` = Error
* - ``4`` = Fatal.
*
*
* Defaults to ``2`` (Warning)
*/
'loglevel' => 2,

Expand Down Expand Up @@ -1155,14 +1161,13 @@
/**
* This uses PHP.date formatting; see https://www.php.net/manual/en/function.date.php
*
* Defaults to ISO 8601 ``2005-08-15T15:52:01+00:00`` - see \DateTime::ATOM
* (https://www.php.net/manual/en/class.datetime.php#datetime.constants.atom)
* Defaults to ISO 8601 ``2005-08-15T15:52:01+00:00``, see ``\DateTime::ATOM``
* https://www.php.net/manual/en/class.datetimeinterface.php#datetimeinterface.constants.atom
*/
'logdateformat' => 'F d, Y H:i:s',

/**
* The timezone for logfiles. You may change this; see
* https://www.php.net/manual/en/timezones.php
* The timezone for logfiles. See https://www.php.net/manual/en/timezones.php
*
* Defaults to ``UTC``
*/
Expand Down Expand Up @@ -1296,7 +1301,6 @@
*
* Defaults to ``365``
*/

'activity_expire_days' => 365,

/**
Expand All @@ -1305,8 +1309,9 @@
* By default, activities in team folders or external storages are only generated
* for the current user. This is due to a limitations in current implementations.
* This config flag makes activities in group folders and external storages work
* like in normal shares (when set to ``true``). WARNING: Enabling this comes with
* some CRITICAL trade-offs:
* like in normal shares (when set to ``true``).
*
* WARNING: Enabling this comes with some CRITICAL trade-offs:
*
* - If team folder "Advanced Permissions" (ACLs) are used, activities do not
* respect the permissions and therefore all users see all activities, even
Expand All @@ -1318,11 +1323,8 @@
* cannot see activities in their stream or emails that happen after they
* are added until they log in again.
*
* WARNING: Before enabling this, read the warning Activity app chapter.
*
* Defaults to ``false``
**/

*/
'activity_use_cached_mountpoints' => false,

/**
Expand Down Expand Up @@ -1552,7 +1554,8 @@
/**
* Maximum file size for metadata generation.
* If a file exceeds this size, metadata generation will be skipped.
* Note: memory equivalent to this size will be used for metadata generation.
*
* NOTE: memory equivalent to this size will be used for metadata generation.
*
* Default: 256 megabytes.
*/
Expand Down Expand Up @@ -1740,11 +1743,11 @@
* higher.
*
* Available failover modes:
* - \RedisCluster::FAILOVER_NONE - only send commands to master nodes (default)
* - \RedisCluster::FAILOVER_ERROR - failover to slaves for read commands if master is unavailable (recommended)
* - \RedisCluster::FAILOVER_DISTRIBUTE - randomly distribute read commands across master and slaves
* - ``\RedisCluster::FAILOVER_NONE`` - only send commands to master nodes (default)
* - ``\RedisCluster::FAILOVER_ERROR`` - failover to slaves for read commands if master is unavailable (recommended)
* - ``\RedisCluster::FAILOVER_DISTRIBUTE`` - randomly distribute read commands across master and slaves
*
* WARNING: FAILOVER_DISTRIBUTE is a not recommended setting, and we strongly
* WARNING: ``\RedisCluster::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
* scheduled to a slave that is not fully synchronized with the connected master
Expand Down Expand Up @@ -2116,30 +2119,30 @@
*
* 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
* ``./occ db:convert-mysql-charset``
* This config setting will be automatically updated after a successful migration.
*
* Refer to the documentation for more details.
*
* MySQL requires specific settings for longer indexes (> 767 bytes), which are
* necessary for 4-byte character support:
* necessary for 4-byte character support::
*
* [mysqld]
* innodb_large_prefix=ON
* innodb_file_format=Barracuda
* innodb_file_per_table=ON
* [mysqld]
* innodb_large_prefix=ON
* innodb_file_format=Barracuda
* innodb_file_per_table=ON
*
* Tables will be created with:
* * character set: utf8mb4
* * collation: utf8mb4_bin
* * row_format: dynamic
* * character set: ``utf8mb4``
* * collation: ``utf8mb4_bin``
* * row_format: ``dynamic``
*
* See:
* https://dev.mysql.com/doc/refman/5.7/en/charset-unicode-utf8mb4.html
* https://dev.mysql.com/doc/refman/5.7/en/innodb-parameters.html#sysvar_innodb_large_prefix
* https://mariadb.com/kb/en/mariadb/xtradbinnodb-server-system-variables/#innodb_large_prefix
* http://www.tocker.ca/2013/10/31/benchmarking-innodb-page-compression-performance.html
* http://mechanics.flite.com/blog/2014/07/29/using-innodb-large-prefix-to-avoid-error-1071/
* * https://dev.mysql.com/doc/refman/5.7/en/charset-unicode-utf8mb4.html
* * https://dev.mysql.com/doc/refman/5.7/en/innodb-parameters.html#sysvar_innodb_large_prefix
* * https://mariadb.com/kb/en/mariadb/xtradbinnodb-server-system-variables/#innodb_large_prefix
* * http://www.tocker.ca/2013/10/31/benchmarking-innodb-page-compression-performance.html
* * http://mechanics.flite.com/blog/2014/07/29/using-innodb-large-prefix-to-avoid-error-1071/
*/
'mysql.utf8mb4' => false,

Expand All @@ -2151,9 +2154,9 @@
* MariaDB and MySQL share some collations, but also have incompatible ones,
* depending on the database server version.
*
* This option allows overriding the automatic collation choice. Example:
* This option allows overriding the automatic collation choice. Example::
*
* 'mysql.collation' => 'utf8mb4_0900_as_ci',
* 'mysql.collation' => 'utf8mb4_0900_as_ci',
*
* 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.
Expand Down Expand Up @@ -2220,7 +2223,7 @@
*
* WARNING: Use this only if you understand the implications.
*
* Note: This list is case-insensitive.
* NOTE: This list is case-insensitive.
*
* Defaults to ``['.htaccess']``
*/
Expand All @@ -2233,7 +2236,7 @@
* The basename is the filename without the extension, e.g., for "archive.tar.gz",
* the basename is "archive".
*
* Note: This list is case-insensitive.
* NOTE: This list is case-insensitive.
*
* Defaults to ``[]`` (empty array)
*/
Expand Down
Loading