Commit 85373145 authored by Lina Wolf's avatar Lina Wolf Committed by Stefan Bürk
Browse files

[DOCS] Document reports extension

Document the status quo and the recent changes.

resolves https://github.com/TYPO3-Documentation/Changelog-To-Doc/issues/84
resolves https://github.com/TYPO3-Documentation/Changelog-To-Doc/issues/77

Resolves: #97758
Releases: main
Change-Id: I35596dad6f9f840f21fac42ca7f2d58009ba5463
Reviewed-on: https://review.typo3.org/c/Packages/TYPO3.CMS/+/74873

Tested-by: core-ci's avatarcore-ci <typo3@b13.com>
Tested-by: Chris Müller's avatarChris Müller <typo3@krue.ml>
Tested-by: Sybille Peters's avatarSybille Peters <sypets@gmx.de>
Tested-by: Stefan Bürk's avatarStefan Bürk <stefan@buerk.tech>
Reviewed-by: Chris Müller's avatarChris Müller <typo3@krue.ml>
Reviewed-by: Sybille Peters's avatarSybille Peters <sypets@gmx.de>
Reviewed-by: Christian Kuhn's avatarChristian Kuhn <lolli@schwarzbu.ch>
Reviewed-by: Stefan Bürk's avatarStefan Bürk <stefan@buerk.tech>
parent c1ae656d
.. More information about this file:
https://docs.typo3.org/m/typo3/docs-how-to-document/main/en-us/GeneralConventions/FileStructure.html#includes-rst-txt
.. ----------
.. text roles
.. ----------
.. role:: aspect(emphasis)
.. role:: bash(code)
.. role:: html(code)
.. role:: js(code)
.. role:: php(code)
.. role:: rst(code)
.. role:: sep(strong)
.. role:: sql(code)
.. role:: tsconfig(code)
:class: typoscript
.. role:: typoscript(code)
.. role:: xml(code)
:class: html
.. role:: yaml(code)
.. default-role:: code
.. ---------
.. highlight
.. ---------
.. By default, code blocks use PHP syntax highlighting
.. highlight:: php
.. include:: /Includes.rst.txt
===============
TYPO3 Reports
===============
:Extension key:
reports
:Package name:
typo3/cms-reports
:Version:
|release|
:Language:
en
:Author:
TYPO3 contributors
:License:
This document is published under the
`Creative Commons BY 4.0 <https://creativecommons.org/licenses/by/4.0/>`__
license.
:Rendered:
|today|
----
This extension shows status reports and installed services in the
:guilabel:`System > Reports` backend module.
----
.. container:: row m-0 p-0
.. container:: col-md-6 pl-0 pr-3 py-3 m-0
.. container:: card px-0 h-100
.. rst-class:: card-header h3
.. rubric:: :ref:`Introduction <introduction>`
.. container:: card-body
Written for new users, this chapter introduces the module
:guilabel:`Reports` and what it does.
.. container:: col-md-6 pl-0 pr-3 py-3 m-0
.. container:: card px-0 h-100
.. rst-class:: card-header h3
.. rubric:: :ref:`Installation <installation>`
.. container:: card-body
Explains how to install the extension if it is not installed yet.
.. container:: col-md-6 pl-0 pr-3 py-3 m-0
.. container:: card px-0 h-100
.. rst-class:: card-header h3
.. rubric:: :ref:`API Reference <api>`
.. container:: card-body
Explains the underlying API and its interfaces.
.. container:: col-md-6 pl-0 pr-3 py-3 m-0
.. container:: card px-0 h-100
.. rst-class:: card-header h3
.. rubric:: :ref:`Custom reports <custom-reports>`
.. container:: card-body
Introduction into developing your own custom reports or status
messages.
.. container:: col-md-6 pl-0 pr-3 py-3 m-0
.. container:: card px-0 h-100
.. rst-class:: card-header h3
.. rubric:: :ref:`Scheduler task <scheduler-task>`
.. container:: card-body
Use the system extension scheduler to configure automatic
status reports sent via email.
.. Table of Contents
.. toctree::
:hidden:
Introduction/Index
Installation/Index
Api/Index
CustomReports/Index
Scheduler/Index
.. Meta Menu
.. toctree::
:hidden:
Sitemap
genindex
.. include:: /Includes.rst.txt
.. _installation:
============
Installation
============
The system extension is not part of common Composer distributions such as
`typo3/cms-base-distribution <https://packagist.org/packages/typo3/cms-base-distribution>`_.
Therefore, if you installed TYPO3 following :ref:`t3start:install`, EXT:reports
is not automatically installed.
You can install it via:
.. code-block:: bash
composer require typo3/cms-reports
Legacy installations
====================
For legacy installations that do not use Composer, EXT:reports is already
part of the distributed package.
Activate the :guilabel:`Reports`
extension in :guilabel:`Admin Tools > Extension Manager`.
.. include:: /Includes.rst.txt
.. _introduction:
============
Introduction
============
What does it do?
================
.. figure:: /Images/ModuleReports.png
:class: with-shadow
The backend module :guilabel:`System > Reports`
The TYPO3 system extension EXT:reports displays the extendable backend module
:guilabel:`System > Reports` for users with administrator role.
The Reports module groups several system reports and gives you a quick
overview about important system statuses and site parameters.
Section "Security"
==================
.. figure:: /Images/Security.png
:class: with-shadow
Regularily check the section :guilabel:`Security`
From a security perspective, the section :guilabel:`Security` should be checked
regularly: it provides information about the administrator user
account, encryption key, file deny pattern, :guilabel:`Admin Tools` checks
and more.
.. warning::
In case of a compromised system, the information displayed here may
have been manipulated by the attacker.
Thus, if no problems are pointed out - it does not necessarily mean
that there are no security issues. But, on the other hand, if security
problems are pointed out, you most certainly should fix them.
.. include:: /Includes.rst.txt
.. _scheduler-task:
==============
Scheduler task
==============
If the system extension :ref:`scheduler is installed <ext_scheduler:installation>`,
you can create automatic reports with the help of a scheduler task.
To create a task for the reports functionality go to
:guilabel:`System > Scheduler`, click on :guilabel:`+ (add Task)` and chose
:guilabel:`System Status Update (reports)` as :guilabel:`Class`.
Enter :guilabel:`Notification Email Addresses` where the reports should be sent
and chose whether you want to be informed with each run.
The remaining settings are standard task settings provided by the scheduler
extension.
.. figure:: /Images/SchedulerTask.png
:class: with-shadow
Create a :guilabel:`System Status Update` task in :guilabel:`System > Scheduler`
System status notification mail
===============================
You will receive mails looking like this:
.. code-block:: text
:caption: Example mail from the System status notification
This report contains all System Status Notifications from your TYPO3
installation. Please check the status report for more information.
Site: [DDEV] TYPO3
Issues:
[WARN] System environment check - 1 Test(s)
### Trusted hosts pattern is insecure: 1
# More information about this file:
# https://docs.typo3.org/m/typo3/docs-how-to-document/main/en-us/GeneralConventions/FileStructure.html#settings-cfg
[general]
project = Reports
version = main (development)
release = main (development)
copyright = since 2018 by the TYPO3 contributors
[html_theme_options]
# "Edit on GitHub" button
github_repository = typo3/typo3
github_branch = main
path_to_documentation_dir = typo3/sysext/reports/Documentation
# Footer links
project_home = https://extensions.typo3.org/extension/reports/
project_contact = https://typo3.slack.com/archives/C025BQLFA
project_repository = https://github.com/typo3/typo3
project_issues = https://forge.typo3.org/projects/typo3cms-core/issues
project_discussions =
use_opensearch =
[intersphinx_mapping]
# Official TYPO3 manuals
# h2document = https://docs.typo3.org/m/typo3/docs-how-to-document/main/en-us/
# t3cheatsheets = https://docs.typo3.org/m/typo3/docs-cheatsheets/main/en-us/
# t3contribute = https://docs.typo3.org/m/typo3/guide-contributionworkflow/main/en-us/
t3coreapi = https://docs.typo3.org/m/typo3/reference-coreapi/main/en-us/
# t3docteam = https://docs.typo3.org/m/typo3/team-t3docteam/main/en-us/
# t3editors = https://docs.typo3.org/m/typo3/tutorial-editors/main/en-us/
# t3extbasebook = https://docs.typo3.org/m/typo3/book-extbasefluid/main/en-us/
# t3extexample = https://docs.typo3.org/m/typo3/guide-example-extension-manual/main/en-us/
# t3home = https://docs.typo3.org/
# t3install = https://docs.typo3.org/m/typo3/guide-installation/main/en-us/
# t3l10n = https://docs.typo3.org/m/typo3/guide-frontendlocalization/main/en-us/
# t3sitepackage = https://docs.typo3.org/m/typo3/tutorial-sitepackage/main/en-us/
t3start = https://docs.typo3.org/m/typo3/tutorial-getting-started/main/en-us/
# t3tca = https://docs.typo3.org/m/typo3/reference-tca/main/en-us/
# t3templating = https://docs.typo3.org/m/typo3/tutorial-templating/main/en-us/
# t3translate = https://docs.typo3.org/m/typo3/guide-frontendlocalization/main/en-us/
# t3tsconfig = https://docs.typo3.org/m/typo3/reference-tsconfig/main/en-us/
# t3tsref = https://docs.typo3.org/m/typo3/reference-typoscript/main/en-us/
# t3ts45 = https://docs.typo3.org/m/typo3/tutorial-typoscript-in-45-minutes/main/en-us/
# t3viewhelper = https://docs.typo3.org/other/typo3/view-helper-reference/main/en-us/
# t3upgrade = https://docs.typo3.org/m/typo3/guide-installation/main/en-us/
# TYPO3 system extensions
# ext_adminpanel = https://docs.typo3.org/c/typo3/cms-adminpanel/main/en-us/
# ext_core = https://docs.typo3.org/c/typo3/cms-core/main/en-us/
# ext_dashboard = https://docs.typo3.org/c/typo3/cms-dashboard/main/en-us/
# ext_felogin = https://docs.typo3.org/c/typo3/cms-felogin/main/en-us/
# ext_form = https://docs.typo3.org/c/typo3/cms-form/main/en-us/
# ext_fsc = https://docs.typo3.org/c/typo3/cms-fluid-styled-content/main/en-us/
# ext_indexed_search = https://docs.typo3.org/c/typo3/cms-indexed-search/main/en-us/
# ext_rte_ckeditor = https://docs.typo3.org/c/typo3/cms-rte-ckeditor/main/en-us/
ext_scheduler = https://docs.typo3.org/c/typo3/cms-scheduler/main/en-us/
# ext_seo = https://docs.typo3.org/c/typo3/cms-seo/main/en-us/
# ext_workspaces = https://docs.typo3.org/c/typo3/cms-workspaces/main/en-us/
:template: sitemap.html
.. include:: /Includes.rst.txt
=======
Sitemap
=======
.. The sitemap.html template will insert here the page tree automatically.
.. include:: /Includes.rst.txt
=====
Index
=====
.. Sphinx will insert here the general index automatically.
......@@ -7,5 +7,5 @@ This extension shows status reports and installed services in the
:Repository: https://github.com/typo3/typo3
:Issues: https://forge.typo3.org/
:Read online: https://docs.typo3.org/
:Read online: https://docs.typo3.org/c/typo3/cms-reports/main/en-us/
:TER: https://extensions.typo3.org/extension/reports/
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment