Skip to content

Commit

Permalink
[Backport 13.4] [TASK] Update System modules section (#574)
Browse files Browse the repository at this point in the history
* [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]>
  • Loading branch information
4 people authored Nov 17, 2024
1 parent 00a7248 commit a342d6c
Show file tree
Hide file tree
Showing 12 changed files with 109 additions and 83 deletions.
151 changes: 102 additions & 49 deletions Documentation/Concepts/Backend/SystemModules/Index.rst
Original file line number Diff line number Diff line change
@@ -1,77 +1,118 @@
:navigation-title: System modules
.. include:: /Includes.rst.txt
.. index:: Modules; System
.. _system-modules:

==============
System modules
==============

.. important::
System modules are backend modules in the group "System"
and they are only available to backend users with
admin permissions.

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

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

.. _system-modules-permissions:

.. index:: Modules; Log
.. _system-modules-log:
Permissions
===========

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

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

.. include:: /Images/AutomaticScreenshots/Modules/LogModule.rst.txt
.. _system-modules-backend-users:

.. index:: Modules; DB check
.. _system-modules-dbcheck:
Backend Users
=============

DB check
========
The module :guilabel:`System > Backend Users` is used to create, edit and delete
backend users.

.. important::
See also TYPO3 Explained,
:ref:`Backend user management <t3coreapi:user-management>`.

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

For Composer based systems (see also :ref:`installing-extensions`):
Reactions (optional)
====================

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

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

.. _system-modules-webhooks :

The *Database (DB) check* module offers four functions related
to the database and its content.
Webhooks (optional)
===================

This module is only available if the system extension
:composer:`typo3/cms-webhooks` is installed. This extension handles **outgoing**
webhooks to TYPO3. It also provides a corresponding backend module to manage
webhook records in TYPO3.

Unfortunately this extension is not documented at the time of writing.

.. _system-modules-scheduler:

Scheduler (optional)
====================

This module is only available if the system extension
:composer:`typo3/cms-scheduler` is installed.

The Scheduler supports one-time or periodic execution of tasks that can be
delivered by any extension. It has its own manual:
:ref:`TYPO3 Scheduler <typo3/cms-scheduler:start>`.

.. _system-modules-dbcheck:

DB check (optional)
===================

.. include:: /Images/AutomaticScreenshots/Modules/DbCheckModule.rst.txt
This module is only available if the system extension
:composer:`typo3/cms-lowlevel` is installed.

The *Database (DB) check* module offers functions related
to the database and its content.

Record Statistics
Shows a count of the various records in the database,
broken down by type for pages and content elements.
Shows a count of the various records in the database,
broken down by type for pages and content elements.

Relations
Checks if certain relations are empty or broken, typically
used to check if files are being referenced.
Checks if certain relations are empty or broken, typically
used to check if files are being referenced.

Search
A tool to search through the whole database. It offers an
advanced mode which is similar to a visual query builder.
A tool to search through the whole database. It offers an
advanced mode which is similar to a visual query builder.

Check and update global reference index
TYPO3 CMS keeps a record of relations between all records.
This may get out of sync when certain operations are performed
without the strict context of the backend. It is therefore
useful to update this index regularly.
TYPO3 CMS keeps a record of relations between all records.
This may get out of sync when certain operations are performed
without the strict context of the backend. It is therefore
useful to update this index regularly.

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

.. index:: Modules; Configuration
.. _system-modules-configuration:

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

.. include:: /Images/AutomaticScreenshots/Modules/ConfigurationModule.rst.txt


.. index:: Modules; Reports
.. _system-modules-reports:

Reports
=======
Reports (optional)
==================

This module is only available if the system extension
:composer:`typo3/cms-reports` is installed.

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

.. include:: /Images/AutomaticScreenshots/Modules/ReportsModule.rst.txt
This module has its own dedicated manual:
:ref:`TYPO3 Reports <typo3/cms-reports:start>`. It can be extended by third-party
extensions. For example :composer:`apache-solr-for-typo3/solr` offers its own
section in the report module.

.. _system-modules-log:

Log
===

The TYPO3 CMS backend logs a number of actions performed by backend users:
login, cache clearing, database entries (creation, update, deletion),
settings changes, file actions and errors. A number of filters are
available to help filter this data.
Binary file not shown.

This file was deleted.

Binary file not shown.

This file was deleted.

Binary file not shown.

This file was deleted.

Binary file not shown.

This file was deleted.

Binary file not shown.

This file was deleted.

7 changes: 7 additions & 0 deletions Documentation/Installation/Install.rst
Original file line number Diff line number Diff line change
Expand Up @@ -92,6 +92,13 @@ Install TYPO3
You now have a **Composer-based TYPO3 installation**.

.. note::
The command above installs a typical set of functionality.

The official `Composer Helper <https://get.typo3.org/misc/composer/helper>`__
at Get TYPO3 supports you to generate commands for a full TYPO3 installation
with all optional system extensions included.

Run the Installation Setup Tool
-------------------------------

Expand Down

0 comments on commit a342d6c

Please sign in to comment.