Skip to content

Commit f693715

Browse files
[TASK] Explain details on Settings module (#5852)
* [TASK] Explain details on Settings module Releases: main, 13.4, 12.4 * [TASK] Language checks --------- Co-authored-by: Sarah McCarthy <sarahmccarthy123@yahoo.com>
1 parent 9859d0a commit f693715

File tree

5 files changed

+117
-10
lines changed

5 files changed

+117
-10
lines changed

Documentation/Administration/Tools/Settings/Index.rst

Lines changed: 115 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,120 @@ Settings (Admin Tools)
1010
Only available if :composer:`typo3/cms-install` is installed.
1111

1212
The backend module :guilabel:`Admin Tools > Settings` offers tools
13-
to system maintainers regarding **global** settings that influence the complete
13+
to system maintainers regarding **global** settings that affect the complete
1414
TYPO3 installation.
1515

16-
.. todo: Describe the tools available here
16+
.. _admin-tools-settings-extension:
17+
18+
Extension configuration (global)
19+
================================
20+
21+
Here you can set global extensions settings. Changes are stored in file
22+
:file:`config/system/settings.php` under the `EXTENSIONS` key. You can
23+
override extension settings in file :file:`config/system/additional.php`,
24+
using the :php:`$GLOBALS['TYPO3_CONF_VARS']['EXTENSION']` variable.
25+
26+
Extensions can define global settings in
27+
`ext_conf_template.txt <https://docs.typo3.org/permalink/t3coreapi:extension-options>`_.
28+
29+
.. _admin-tools-settings-password:
30+
31+
Change install tool password
32+
============================
33+
34+
You can use this tool to easily change the install tool password from
35+
within Admin Tools.
36+
37+
.. _admin-tools-settings-maintainer:
38+
39+
Manage system maintainers
40+
=========================
41+
42+
This tool can be used to grant or revoke
43+
`system maintainer <https://docs.typo3.org/permalink/t3coreapi:system-maintainer>`_
44+
permissions from backend administrators.
45+
46+
.. _admin-tools-settings-presets:
47+
48+
Configuration presets
49+
=====================
50+
51+
Some `system configuration settings <https://docs.typo3.org/permalink/t3coreapi:typo3ConfVars>`_
52+
(:php:`$GLOBALS['TYPO3_CONF_VARS']`) are commonly used in combination or with
53+
predefined values for certain use cases. Configuration presets can be used to
54+
configure these settings.
55+
56+
.. _admin-tools-settings-cache:
57+
58+
Cache settings
59+
--------------
60+
61+
TYPO3 features a flexible `caching <https://docs.typo3.org/permalink/t3coreapi:caching>`_
62+
system with a default configuration that is ideal for most use cases.
63+
64+
Depending on your individual hosting setup, the performance of your
65+
TYPO3 instance can be optimized even further by adjusting the storage type.
66+
67+
.. _admin-tools-settings-debug:
68+
69+
Debug settings
70+
--------------
71+
72+
Depending on the `Application Context <https://docs.typo3.org/permalink/t3coreapi:application-context>`_
73+
debug settings are set to live (in Production context, no debugging) or debug (in
74+
Development context, debugging enabled). The debug setting presets turn
75+
debugging on and off with just two clicks.
76+
77+
.. _admin-tools-settings-image:
78+
79+
Image handling settings
80+
-----------------------
81+
82+
These presets can be used to configure paths to Graphics Magick or Image Magick.
83+
84+
More detailed settings are available in
85+
`TYPO3_CONF_VALS GFX - graphics configuration <https://docs.typo3.org/permalink/t3coreapi:typo3confvars-gfx>`_.
86+
87+
.. _admin-tools-settings-mail:
88+
89+
Mail handling settings
90+
----------------------
91+
92+
This preset can be used to configure commands used to send mails.
93+
94+
More detailed settings are available in
95+
`TYPO3_CONF_VALS MAIL settings <https://docs.typo3.org/permalink/t3coreapi:typo3confvars-mail>`_.
96+
97+
.. _admin-tools-settings-password-hashing:
98+
99+
Password hashing settings
100+
-------------------------
101+
102+
Allows you to switch the `password hashing algorithm <https://docs.typo3.org/permalink/t3coreapi:password-hashing>`_.
103+
104+
.. _admin-tools-settings-feature-toggles:
105+
106+
Feature toggles
107+
===============
108+
109+
.. figure:: /Images/ManualScreenshots/AdminTools/FeatureToggles.png
110+
:alt: Feature toggles in the Admin Tools
111+
112+
This tool enables and disables Core features. See
113+
`Feature toggle API <https://docs.typo3.org/permalink/t3coreapi:feature-toggles>`_
114+
for details.
115+
116+
.. _admin-tools-settings-typo3confval:
117+
118+
Configure installation-wide options
119+
===================================
120+
121+
In this tool most values in the
122+
`TYPO3_CONF_VARS array in the settings.php <https://docs.typo3.org/permalink/t3coreapi:typo3confvars>`_
123+
can be changed.
124+
125+
Values that have been overridden in file :file:`config/system/additional.php`
126+
are not displayed here.
127+
128+
Some settings, for example `DB - Database connections <https://docs.typo3.org/permalink/t3coreapi:typo3confvars-db>`_,
129+
cannot be viewed or changed here for security reasons.

Documentation/ApiOverview/FeatureToggleApi/Index.rst

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -132,7 +132,8 @@ Enable / disable feature toggle
132132
Features can be toggled in the :guilabel:`Admin Tools > Settings` module via
133133
:guilabel:`Feature Toggles`:
134134

135-
.. include:: /Images/AutomaticScreenshots/AdminTools/FeatureToggles.rst.txt
135+
.. figure:: /Images/ManualScreenshots/AdminTools/FeatureToggles.png
136+
:alt: Feature toggles in the Admin Tools
136137

137138
Internally, the changes are written to :file:`config/system/settings.php`:
138139

Binary file not shown.

Documentation/Images/AutomaticScreenshots/AdminTools/FeatureToggles.rst.txt

Lines changed: 0 additions & 7 deletions
This file was deleted.
48.8 KB
Loading

0 commit comments

Comments
 (0)