Skip to content

Commit a342d6c

Browse files
github-actions[bot]linawolfAlagts
authored
[Backport 13.4] [TASK] Update System modules section (#574)
* [TASK] Update System modules section Releases: main, 13.4, 12.4 * Apply suggestions from code review Co-authored-by: Sandra Erbel <[email protected]> --------- Co-authored-by: lina.wolf <[email protected]> Co-authored-by: Lina Wolf <[email protected]> Co-authored-by: Sandra Erbel <[email protected]>
1 parent 00a7248 commit a342d6c

File tree

12 files changed

+109
-83
lines changed

12 files changed

+109
-83
lines changed
Lines changed: 102 additions & 49 deletions
Original file line numberDiff line numberDiff line change
@@ -1,77 +1,118 @@
1+
:navigation-title: System modules
12
.. include:: /Includes.rst.txt
2-
.. index:: Modules; System
33
.. _system-modules:
44

55
==============
66
System modules
77
==============
88

9-
.. important::
9+
System modules are backend modules in the group "System"
10+
and they are only available to backend users with
11+
admin permissions.
1012

11-
This chapters cover modules that will only be available for backend users
12-
with admin access privileges.
13+
Some modules are only available when you have an optional system extension
14+
installed. If you want to see all available modules you can also make a
15+
full TYPO3 install, see `https://get.typo3.org/misc/composer/helper`__.
1316

14-
In the :ref:`User Management <t3coreapi:user-management>` chapter we covered the
15-
*Access* and *Backend Users* module. In this section we take a look
16-
at the remaining modules.
17+
.. contents:: Backend modules in group "System"
1718

19+
.. _system-modules-permissions:
1820

19-
.. index:: Modules; Log
20-
.. _system-modules-log:
21+
Permissions
22+
===========
2123

22-
Log
23-
===
24+
In TYPO3, you can grant permissions to backend users.
25+
At first, a newly created backend user without any administrative
26+
privileges has no access to neither the page module nor the
27+
pages in the backend.
28+
The module :guilabel:`System > Permissions` can be used to view or edit
29+
these backend user permissions for pages in the backend.
2430

25-
The TYPO3 CMS backend logs a number of actions performed by backend users:
26-
login, cache clearing, database entries (creation, update, deletion),
27-
settings changes, file actions and errors. A number of filters are
28-
available to help filter this data.
31+
See also TYPO3 Explained,
32+
:ref:`Permissions management <t3coreapi:permissions-management>`.
2933

30-
.. include:: /Images/AutomaticScreenshots/Modules/LogModule.rst.txt
34+
.. _system-modules-backend-users:
3135

32-
.. index:: Modules; DB check
33-
.. _system-modules-dbcheck:
36+
Backend Users
37+
=============
3438

35-
DB check
36-
========
39+
The module :guilabel:`System > Backend Users` is used to create, edit and delete
40+
backend users.
3741

38-
.. important::
42+
See also TYPO3 Explained,
43+
:ref:`Backend user management <t3coreapi:user-management>`.
3944

40-
"DB check and :ref:`system-modules-configuration` are only available
41-
if the system extension "lowlevel" was installed and activated.
45+
.. _system-modules-reactions:
4246

43-
For Composer based systems (see also :ref:`installing-extensions`):
47+
Reactions (optional)
48+
====================
4449

45-
.. code-block:: bash
50+
This module is only available if the system extension
51+
:composer:`typo3/cms-reactions` is installed. This extension handles **incoming**
52+
webhooks to TYPO3. It also provides a corresponding backend module to manage
53+
reaction records.
4654

47-
composer req typo3/cms-lowlevel
55+
It has its own manual:
56+
:ref:`TYPO3 Reactions <typo3/cms-reactions:start>`.
4857

58+
.. _system-modules-webhooks :
4959

50-
The *Database (DB) check* module offers four functions related
51-
to the database and its content.
60+
Webhooks (optional)
61+
===================
62+
63+
This module is only available if the system extension
64+
:composer:`typo3/cms-webhooks` is installed. This extension handles **outgoing**
65+
webhooks to TYPO3. It also provides a corresponding backend module to manage
66+
webhook records in TYPO3.
67+
68+
Unfortunately this extension is not documented at the time of writing.
69+
70+
.. _system-modules-scheduler:
71+
72+
Scheduler (optional)
73+
====================
74+
75+
This module is only available if the system extension
76+
:composer:`typo3/cms-scheduler` is installed.
77+
78+
The Scheduler supports one-time or periodic execution of tasks that can be
79+
delivered by any extension. It has its own manual:
80+
:ref:`TYPO3 Scheduler <typo3/cms-scheduler:start>`.
81+
82+
.. _system-modules-dbcheck:
83+
84+
DB check (optional)
85+
===================
5286

53-
.. include:: /Images/AutomaticScreenshots/Modules/DbCheckModule.rst.txt
87+
This module is only available if the system extension
88+
:composer:`typo3/cms-lowlevel` is installed.
89+
90+
The *Database (DB) check* module offers functions related
91+
to the database and its content.
5492

5593
Record Statistics
56-
Shows a count of the various records in the database,
57-
broken down by type for pages and content elements.
94+
Shows a count of the various records in the database,
95+
broken down by type for pages and content elements.
5896

5997
Relations
60-
Checks if certain relations are empty or broken, typically
61-
used to check if files are being referenced.
98+
Checks if certain relations are empty or broken, typically
99+
used to check if files are being referenced.
62100

63101
Search
64-
A tool to search through the whole database. It offers an
65-
advanced mode which is similar to a visual query builder.
102+
A tool to search through the whole database. It offers an
103+
advanced mode which is similar to a visual query builder.
66104

67105
Check and update global reference index
68-
TYPO3 CMS keeps a record of relations between all records.
69-
This may get out of sync when certain operations are performed
70-
without the strict context of the backend. It is therefore
71-
useful to update this index regularly.
106+
TYPO3 CMS keeps a record of relations between all records.
107+
This may get out of sync when certain operations are performed
108+
without the strict context of the backend. It is therefore
109+
useful to update this index regularly.
72110

111+
Some third party extensions offer similar but extended functionality around
112+
the database, for example :composer:`fixpunkt/backendtools` can be used during
113+
development to find all pages that contain a certain plugin or that use
114+
a certain backend layout etc.
73115

74-
.. index:: Modules; Configuration
75116
.. _system-modules-configuration:
76117

77118
Configuration
@@ -84,18 +125,30 @@ you can discover their function as you dig deeper into
84125
TYPO3 CMS. Let's just mention that the `$GLOBALS['TYPO3_CONF_VARS']`
85126
contains global configuration values.
86127

87-
.. include:: /Images/AutomaticScreenshots/Modules/ConfigurationModule.rst.txt
88-
89-
90-
.. index:: Modules; Reports
91128
.. _system-modules-reports:
92129

93-
Reports
94-
=======
130+
Reports (optional)
131+
==================
132+
133+
This module is only available if the system extension
134+
:composer:`typo3/cms-reports` is installed.
95135

96-
The *Reports* module contains information and diagnostic data
97-
about your TYPO3 CMS installation. It is recommended that you
136+
The :guilabel:`System > Reports` module contains information and diagnostic data
137+
about your TYPO3 installation. It is recommended that you
98138
regularly check the "Status Report" as it will inform you
99139
about configuration errors, security issues, etc.
100140

101-
.. include:: /Images/AutomaticScreenshots/Modules/ReportsModule.rst.txt
141+
This module has its own dedicated manual:
142+
:ref:`TYPO3 Reports <typo3/cms-reports:start>`. It can be extended by third-party
143+
extensions. For example :composer:`apache-solr-for-typo3/solr` offers its own
144+
section in the report module.
145+
146+
.. _system-modules-log:
147+
148+
Log
149+
===
150+
151+
The TYPO3 CMS backend logs a number of actions performed by backend users:
152+
login, cache clearing, database entries (creation, update, deletion),
153+
settings changes, file actions and errors. A number of filters are
154+
available to help filter this data.
Binary file not shown.

Documentation/Images/AutomaticScreenshots/Modules/DbCheckModule.rst.txt

Lines changed: 0 additions & 7 deletions
This file was deleted.
-102 KB
Binary file not shown.

Documentation/Images/AutomaticScreenshots/Modules/LogModule.rst.txt

Lines changed: 0 additions & 7 deletions
This file was deleted.
Binary file not shown.

Documentation/Images/AutomaticScreenshots/Modules/ReportsModule.rst.txt

Lines changed: 0 additions & 7 deletions
This file was deleted.
-50.1 KB
Binary file not shown.

Documentation/Images/AutomaticScreenshots/Modules/System.rst.txt

Lines changed: 0 additions & 7 deletions
This file was deleted.
Binary file not shown.

0 commit comments

Comments
 (0)