Skip to content

Commit 936c913

Browse files
committed
chore(administration): Generate system config documentation from config.sample.php
1 parent 0e4b414 commit 936c913

File tree

1 file changed

+53
-21
lines changed

1 file changed

+53
-21
lines changed

admin_manual/configuration_server/config_sample_php_parameters.rst

Lines changed: 53 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -903,9 +903,13 @@ characters).
903903

904904
By default, the passwords are stored encrypted in the database.
905905

906-
WARNING: If disabled, password changes on the user back-end (e.g. on LDAP) no
907-
longer log connected clients out automatically. Users can still disconnect
908-
the clients by deleting the app token from the security settings.
906+
907+
908+
.. warning::
909+
910+
If disabled, password changes on the user back-end (e.g. on LDAP) no
911+
longer log connected clients out automatically. Users can still disconnect
912+
the clients by deleting the app token from the security settings.
909913

910914
hide_login_form
911915
^^^^^^^^^^^^^^^
@@ -990,8 +994,12 @@ mail_smtpdebug
990994

991995
Enable SMTP class debugging.
992996

993-
NOTE: ``loglevel`` will likely need to be adjusted too. See docs:
994-
https://docs.nextcloud.com/server/latest/admin_manual/configuration_server/email_configuration.html#enabling-debug-mode
997+
998+
999+
.. note::
1000+
1001+
``loglevel`` will likely need to be adjusted too. See docs:
1002+
https://docs.nextcloud.com/server/latest/admin_manual/configuration_server/email_configuration.html#enabling-debug-mode
9951003

9961004
Defaults to ``false``
9971005

@@ -2532,11 +2540,15 @@ Available failover modes:
25322540
- \\RedisCluster::FAILOVER_ERROR - failover to slaves for read commands if master is unavailable (recommended)
25332541
- \\RedisCluster::FAILOVER_DISTRIBUTE - randomly distribute read commands across master and slaves
25342542

2535-
WARNING: FAILOVER_DISTRIBUTE is a not recommended setting, and we strongly
2536-
suggest to not use it if you use Redis for file locking. Due to the way Redis
2537-
is synchronized it could happen, that the read for an existing lock is
2538-
scheduled to a slave that is not fully synchronized with the connected master
2539-
which then causes a FileLocked exception.
2543+
2544+
2545+
.. warning::
2546+
2547+
FAILOVER_DISTRIBUTE is a not recommended setting, and we strongly
2548+
suggest to not use it if you use Redis for file locking. Due to the way Redis
2549+
is synchronized it could happen, that the read for an existing lock is
2550+
scheduled to a slave that is not fully synchronized with the connected master
2551+
which then causes a FileLocked exception.
25402552

25412553
See https://redis.io/topics/cluster-spec for details about the Redis cluster
25422554

@@ -2667,11 +2679,15 @@ exclusive access to the object store container because it only stores the
26672679
binary data for each file. The metadata is currently kept in the local
26682680
database for performance reasons.
26692681

2670-
WARNING: The current implementation is incompatible with any app that uses
2671-
direct file IO and circumvents our virtual filesystem. That includes
2672-
Encryption and Gallery. Gallery will store thumbnails directly in the
2673-
filesystem and encryption will cause severe overhead because key files need
2674-
to be fetched in addition to any requested file.
2682+
2683+
2684+
.. warning::
2685+
2686+
The current implementation is incompatible with any app that uses
2687+
direct file IO and circumvents our virtual filesystem. That includes
2688+
Encryption and Gallery. Gallery will store thumbnails directly in the
2689+
filesystem and encryption will cause severe overhead because key files need
2690+
to be fetched in addition to any requested file.
26752691

26762692
objectstore
26772693
^^^^^^^^^^^
@@ -3156,7 +3172,11 @@ Block a specific file or files and disallow the upload of files with this name.
31563172
This blocks any access to those files (read and write).
31573173
``.htaccess`` is blocked by default.
31583174

3159-
WARNING: USE THIS ONLY IF YOU KNOW WHAT YOU ARE DOING.
3175+
3176+
3177+
.. warning::
3178+
3179+
USE THIS ONLY IF YOU KNOW WHAT YOU ARE DOING.
31603180

31613181
Note that this list is case-insensitive.
31623182

@@ -3329,8 +3349,12 @@ localstorage.allowsymlinks
33293349

33303350
Option to allow local storage to contain symlinks.
33313351

3332-
WARNING: Not recommended. This would make it possible for Nextcloud to access
3333-
files outside the data directory and could be considered a security risk.
3352+
3353+
3354+
.. warning::
3355+
3356+
Not recommended. This would make it possible for Nextcloud to access
3357+
files outside the data directory and could be considered a security risk.
33343358

33353359
Defaults to ``false``
33363360

@@ -3345,8 +3369,12 @@ localstorage.umask
33453369
Nextcloud overrides umask to ensure suitable access permissions
33463370
regardless of webserver/php-fpm configuration and worker state.
33473371

3348-
WARNING: Modifying this value has security implications and
3349-
may soft-break the installation.
3372+
3373+
3374+
.. warning::
3375+
3376+
Modifying this value has security implications and
3377+
may soft-break the installation.
33503378

33513379
Most installs shall not modify this value.
33523380

@@ -3721,7 +3749,11 @@ List of incompatible user agents opted out from Same Site Cookie Protection.
37213749
Some user agents are notorious and don't really properly follow HTTP
37223750
specifications. For those, have an opt-out.
37233751

3724-
WARNING: only use this if you know what you are doing
3752+
3753+
3754+
.. warning::
3755+
3756+
only use this if you know what you are doing
37253757

37263758
simpleSignUpLink.shown
37273759
^^^^^^^^^^^^^^^^^^^^^^

0 commit comments

Comments
 (0)