Skip to content

Commit 87c4d20

Browse files
committed
chore(administration): Generate system config documentation from config.sample.php
1 parent 408d582 commit 87c4d20

File tree

1 file changed

+71
-27
lines changed

1 file changed

+71
-27
lines changed

admin_manual/configuration_server/config_sample_php_parameters.rst

Lines changed: 71 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -917,9 +917,13 @@ characters).
917917

918918
By default, the passwords are stored encrypted in the database.
919919

920-
WARNING: If disabled, password changes on the user backend (e.g., on LDAP) no
921-
longer log connected clients out automatically. Users can still disconnect
922-
the clients by deleting the app token from the security settings.
920+
921+
922+
.. warning::
923+
924+
If disabled, password changes on the user backend (e.g., on LDAP) no
925+
longer log connected clients out automatically. Users can still disconnect
926+
the clients by deleting the app token from the security settings.
923927

924928
hide_login_form
925929
^^^^^^^^^^^^^^^
@@ -1004,8 +1008,12 @@ mail_smtpdebug
10041008

10051009
Enable SMTP class debugging.
10061010

1007-
NOTE: ``loglevel`` will likely need to be adjusted too. See docs:
1008-
https://docs.nextcloud.com/server/latest/admin_manual/configuration_server/email_configuration.html#enabling-debug-mode
1011+
1012+
1013+
.. note::
1014+
1015+
``loglevel`` will likely need to be adjusted too. See docs:
1016+
https://docs.nextcloud.com/server/latest/admin_manual/configuration_server/email_configuration.html#enabling-debug-mode
10091017

10101018
Defaults to ``false``
10111019

@@ -2658,11 +2666,15 @@ Available failover modes:
26582666
- \\RedisCluster::FAILOVER_ERROR - failover to slaves for read commands if master is unavailable (recommended)
26592667
- \\RedisCluster::FAILOVER_DISTRIBUTE - randomly distribute read commands across master and slaves
26602668

2661-
WARNING: FAILOVER_DISTRIBUTE is a not recommended setting, and we strongly
2662-
suggest to not use it if you use Redis for file locking. Due to the way Redis
2663-
is synchronized, it could happen that the read for an existing lock is
2664-
scheduled to a slave that is not fully synchronized with the connected master
2665-
which then causes a FileLocked exception.
2669+
2670+
2671+
.. warning::
2672+
2673+
FAILOVER_DISTRIBUTE is a not recommended setting, and we strongly
2674+
suggest to not use it if you use Redis for file locking. Due to the way Redis
2675+
is synchronized, it could happen that the read for an existing lock is
2676+
scheduled to a slave that is not fully synchronized with the connected master
2677+
which then causes a FileLocked exception.
26662678

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

@@ -2808,11 +2820,15 @@ exclusive access to the object store container because it only stores the
28082820
binary data for each file. The metadata is currently kept in the local
28092821
database for performance reasons.
28102822

2811-
WARNING: The current implementation is incompatible with any app that uses
2812-
direct file I/O and circumvents our virtual filesystem. That includes
2813-
Encryption and Gallery. Gallery will store thumbnails directly in the
2814-
filesystem, and encryption will cause severe overhead because key files need
2815-
to be fetched in addition to any requested file.
2823+
2824+
2825+
.. warning::
2826+
2827+
The current implementation is incompatible with any app that uses
2828+
direct file I/O and circumvents our virtual filesystem. That includes
2829+
Encryption and Gallery. Gallery will store thumbnails directly in the
2830+
filesystem, and encryption will cause severe overhead because key files need
2831+
to be fetched in addition to any requested file.
28162832

28172833
objectstore
28182834
^^^^^^^^^^^
@@ -3295,7 +3311,11 @@ Block specific files or filenames, disallowing uploads or access (read and write
32953311

32963312
``.htaccess`` is blocked by default.
32973313

3298-
WARNING: Use this only if you understand the implications.
3314+
3315+
3316+
.. warning::
3317+
3318+
Use this only if you understand the implications.
32993319

33003320
Note: This list is case-insensitive.
33013321

@@ -3463,8 +3483,12 @@ localstorage.allowsymlinks
34633483

34643484
Allow local storage to contain symlinks.
34653485

3466-
WARNING: Not recommended, as this allows Nextcloud to access files outside the
3467-
data directory, posing a potential security risk.
3486+
3487+
3488+
.. warning::
3489+
3490+
Not recommended, as this allows Nextcloud to access files outside the
3491+
data directory, posing a potential security risk.
34683492

34693493
Defaults to ``false``
34703494

@@ -3854,7 +3878,11 @@ csrf.optout
38543878
List of user agents exempt from SameSite cookie protection due to non-standard
38553879
HTTP behavior.
38563880

3857-
WARNING: Use only if you understand the implications.
3881+
3882+
3883+
.. warning::
3884+
3885+
Use only if you understand the implications.
38583886

38593887
Defaults to:
38603888
- /^WebDAVFS/ (OS X Finder)
@@ -3872,7 +3900,11 @@ Specify allowed user agents for Login Flow V2 using regular expressions.
38723900

38733901
User agents not matching this list are denied access to Login Flow V2.
38743902

3875-
WARNING: Use only if you understand the implications.
3903+
3904+
3905+
.. warning::
3906+
3907+
Use only if you understand the implications.
38763908

38773909
Example: Allow only the Nextcloud Android app:
38783910
'core.login_flow_v2.allowed_user_agents' => ['/Nextcloud-android/i'],
@@ -3962,9 +3994,13 @@ query_log_file
39623994

39633995
Log all database queries to a file.
39643996

3965-
WARNING: This significantly reduces server performance and is intended only
3966-
for debugging or profiling query interactions. Sensitive data may be logged in
3967-
plain text.
3997+
3998+
3999+
.. warning::
4000+
4001+
This significantly reduces server performance and is intended only
4002+
for debugging or profiling query interactions. Sensitive data may be logged in
4003+
plain text.
39684004

39694005
query_log_file_requestid
39704006
^^^^^^^^^^^^^^^^^^^^^^^^
@@ -3989,7 +4025,11 @@ query_log_file_parameters
39894025
Include all query parameters in the query log when set to `yes`.
39904026

39914027
Requires `query_log_file` to be set.
3992-
WARNING: This may log sensitive data in plain text.
4028+
4029+
4030+
.. warning::
4031+
4032+
This may log sensitive data in plain text.
39934033

39944034
query_log_file_backtrace
39954035
^^^^^^^^^^^^^^^^^^^^^^^^
@@ -4013,9 +4053,13 @@ redis_log_file
40134053

40144054
Log all Redis requests to a file.
40154055

4016-
WARNING: This significantly reduces server performance and is intended only
4017-
for debugging or profiling Redis interactions. Sensitive data may be logged in
4018-
plain text.
4056+
4057+
4058+
.. warning::
4059+
4060+
This significantly reduces server performance and is intended only
4061+
for debugging or profiling Redis interactions. Sensitive data may be logged in
4062+
plain text.
40194063

40204064
diagnostics.logging
40214065
^^^^^^^^^^^^^^^^^^^

0 commit comments

Comments
 (0)