Skip to content

Commit 10abccc

Browse files
linawolflinawolf
authored
[TASK] List Admin Tools in Admin Section (#5802)
Releases: main, 13.4, 12.4
1 parent 725f9e5 commit 10abccc

File tree

9 files changed

+253
-51
lines changed

9 files changed

+253
-51
lines changed

‎Documentation/Administration/Tools/ContentSecurityPolicy/Index.rst‎

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
:navigation-title: Content Security Policy
2+
3+
.. include:: /Includes.rst.txt
4+
.. _admin-tools-csp:
5+
6+
=====================================
7+
Content Security Policy (Admin Tools)
8+
=====================================
9+
10+
:ref:`Content Security Policy <t3coreapi:content-security-policy>` declarations
11+
can be applied to a TYPO3 website in frontend and backend scope with a dedicated
12+
API.
13+
14+
This module handles
15+
:ref:`Reporting of violations of the Content Security
16+
Policy <t3coreapi:content-security-policy-reporting>`. It is always available
17+
but can only be :ref:`accessed via the backend <t3start:admin-tools-access>`,
18+
not the Install Tool.

‎Documentation/Administration/Tools/Environment/Index.rst‎

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
:navigation-title: Environment
2+
3+
.. include:: /Includes.rst.txt
4+
.. _admin-tools-environment:
5+
6+
=========================
7+
Environment (Admin Tools)
8+
=========================
9+
10+
Only available if :composer:`typo3/cms-install` is installed.
11+
12+
The backend module :guilabel:`Admin Tools > Maintenance` offers tools
13+
to system maintainers regarding the server environment like PHP and database
14+
versions, directory status, mail setup and image processing.
15+
16+
.. todo: Describe the tools available here

‎Documentation/Administration/Tools/ExtensionManger/Index.rst‎

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
:navigation-title: Extensions
2+
.. include:: /Includes.rst.txt
3+
.. _admin-tools-extensions:
4+
5+
========================
6+
Extensions (Admin Tools)
7+
========================
8+
9+
Only available if :composer:`typo3/cms-extensionmanager` is installed.
10+
11+
The backend module :guilabel:`Admin Tools > Extensions`, also called
12+
"Extension Manager", can be used in Composer-based extensions to view which
13+
TYPO3 extensions are installed. In non-Composer installation (not in the scope
14+
of this guide) they can also be used to install and activate extensions:
15+
:ref:`Installing an Extension using the Extension Manager <t3coreapi:extension-install>`.

‎Documentation/Administration/Tools/Index.rst‎

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
:navigation-title: Admin Tools
2+
3+
.. include:: /Includes.rst.txt
4+
.. _admin-tools:
5+
6+
========================================
7+
Admin tools for TYPO3 system maintainers
8+
========================================
9+
10+
The following modules are available in a full TYPO3 installation:
11+
12+
.. toctree::
13+
:glob:
14+
:titlesonly:
15+
16+
Maintenance/Index
17+
Settings/Index
18+
Upgrade/Index
19+
Environment/Index
20+
ContentSecurityPolicy/Index
21+
ExtensionManger/Index

‎Documentation/Administration/Tools/Maintenance/Index.rst‎

Lines changed: 70 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,70 @@
1+
:navigation-title: Maintenance
2+
3+
.. include:: /Includes.rst.txt
4+
.. _admin-tools-maintenance:
5+
6+
=========================
7+
Maintenance (Admin Tools)
8+
=========================
9+
10+
Only available if :composer:`typo3/cms-install` is installed.
11+
12+
The backend module :guilabel:`Admin Tools > Maintenance` offers tools
13+
to system maintainers that are necessary during development or updates.
14+
15+
Some of the tools available here include:
16+
17+
.. todo: describe the other tools
18+
19+
.. contents::
20+
21+
.. _admin-tools-maintenance-flush-cache:
22+
23+
Flush TYPO3 and PHP Cache
24+
=========================
25+
26+
By clicking the button :guilabel:`Flush cache` you can flush all caches. This is
27+
necessary during development if you changed files like
28+
:ref:`Fluid templates <fluid-templates>`, :ref:`TypoScript files <typoscript>`,
29+
or PHP files.
30+
31+
It is also necessary to flush caches after installing or updating extensions.
32+
33+
You can achieve the same effect by calling
34+
35+
.. code-block:: bash
36+
37+
ddev typo3 cache: flush
38+
39+
.. note::
40+
Flushing the cache via the "Clear cache" buttons in the
41+
Top Bar does not have the same effect. It does not flush
42+
PHP related caches.
43+
44+
.. _admin-tools-maintenance-database-analyzer:
45+
46+
Analyze Database Structure
47+
==========================
48+
49+
Aside its name this tool does not only analyze the database structure but also
50+
offers to fix it for you.
51+
52+
Database changes can be necessary when TCA files where changed or
53+
extensions installed / updated.
54+
55+
.. _admin-tools-maintenance-create-admin:
56+
57+
Create Administrative User
58+
==========================
59+
60+
This tool can be used to create a new administrative backend user with or
61+
without maintainer privileges.
62+
63+
You can also create a new backend user from the console:
64+
65+
.. code-block:: bash
66+
67+
ddev typo3 backend:user:create
68+
69+
and from the module :guilabel:`System > Backend Users`. The latter cannot
70+
grant system maintainer rights but is available to all admins.

‎Documentation/Administration/Tools/Settings/Index.rst‎

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
:navigation-title: Settings
2+
3+
.. include:: /Includes.rst.txt
4+
.. _admin-tools-settings:
5+
6+
======================
7+
Settings (Admin Tools)
8+
======================
9+
10+
Only available if :composer:`typo3/cms-install` is installed.
11+
12+
The backend module :guilabel:`Admin Tools > Settings` offers tools
13+
to system maintainers regarding **global** settings that influence the complete
14+
TYPO3 installation.
15+
16+
.. todo: Describe the tools available here

‎Documentation/Administration/Tools/Upgrade/Index.rst‎

Lines changed: 41 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,41 @@
1+
:navigation-title: Upgrade
2+
3+
.. include:: /Includes.rst.txt
4+
.. _admin-tools-upgrade:
5+
6+
=====================
7+
Upgrade (Admin Tools)
8+
=====================
9+
10+
Only available if :composer:`typo3/cms-install` is installed with system
11+
maintainer permissions.
12+
13+
The backend module :guilabel:`Admin Tools > Upgrade` offers tools
14+
to system maintainers that are useful during
15+
:ref:`Major upgrades (TYPO3 explained) <t3coreapi:major>`.
16+
17+
.. figure:: /Images/ManualScreenshots/AdminTools/UpgradeTools.png
18+
:alt: Admin Tools -> Upgrade, Overview
19+
20+
The tools listed here are mainly used during `Major Upgrades of the TYPO3 Core
21+
or a third party extension <https://docs.typo3.org/permalink/t3coreapi:upgrading>`_.
22+
23+
Some tools can also be used to access the quality of custom TYPO3 extensions.
24+
25+
.. seealso::
26+
There are also a number of `Third-party tools useful during upgrade <https://docs.typo3.org/permalink/t3coreapi:tools>`_.
27+
28+
.. contents:: Table of contents
29+
30+
.. _admin-tools-upgrade-updater:
31+
32+
Core updater
33+
============
34+
35+
In classic mode TYPO3 installations that fulfil certain criteria you can use
36+
this function to automatically do patch level TYPO3 Core updates.
37+
38+
.. seealso::
39+
40+
* :ref:`classic-mode-upgrade-minor`
41+
* :ref:`classic-mode-upgrade-disable`

‎Documentation/Administration/Upgrade/Legacy/Index.rst‎

Lines changed: 56 additions & 51 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,8 @@
77
Classic mode upgrade
88
====================
99

10+
.. _classic-mode-upgrade-minor:
11+
1012
Minor Upgrades - Using The Core Updater
1113
========================================
1214

@@ -17,26 +19,31 @@ In the section "Important Actions" scroll down to "Core update" and click the
1719
"Check for core updates" button. If the requirements are met, TYPO3 will
1820
automatically install the new source code.
1921

20-
.. note::
22+
.. note::
23+
24+
For the Core Updater to work, the following setup is required:
2125

22-
For the Core Updater to work, the following setup is required:
26+
* It only works in Unix-like systems (including macOS).
2327

24-
* It only works in Unix-like systems (including macOS).
28+
* :file:`typo3_src` must be a symlink.
2529

26-
* :file:`typo3_src` must be a symlink.
30+
* This symlink needs to be writable (and deletable) by the web-server user.
2731

28-
* This symlink needs to be writable (and deletable) by the web-server user.
32+
* The document root needs to be writable.
2933

30-
* The document root needs to be writable.
34+
* One path above document root (:file:`../`) needs to be writable (creation
35+
of new directories must be allowed).
3136

32-
* One path above document root (:file:`../`) needs to be writable (creation
33-
of new directories must be allowed).
37+
* The :program:`tar` command must be available (for extracting the Source
38+
package).
3439

35-
* The :program:`tar` command must be available (for extracting the Source
36-
package).
3740

41+
Database updates are usually *not* necessary, though you still have to
42+
:ref:`remove the temporary cache files <clear_caches>`. After
43+
that your update is finished.
3844

39-
.. _install-manually:
45+
.. _classic-mode-upgrade-major:
46+
.. _install-manually:
4047

4148
Major Upgrades - Symlink The Core
4249
=================================
@@ -47,13 +54,24 @@ the source package of the new TYPO3 version.
4754
Extract the package on your web server and, in your TYPO3 document root,
4855
adjust the :file:`typo3_src` symlink.
4956

50-
.. important::
51-
Make sure to upload the whole TYPO3 source directory including the
52-
:file:`vendor` directory, otherwise you will miss important dependency
53-
updates.
57+
Make sure to upload the whole TYPO3 source directory including the
58+
:file:`vendor` directory, otherwise you will miss important dependency
59+
updates.
60+
61+
Make sure to read the release notes of even the minor versions carefully. While
62+
great care is taken to keep the minor updates as easy as possible, (especially
63+
when releasing security updates) more steps might be necessary.
64+
65+
In case of a *major update*, e.g. from TYPO3 11.5 to 12.4, go ahead with the next
66+
step!
67+
68+
Also check out any breaking changes listed in the :doc:`changelog <ext_core:Index>`
69+
for the new version.
70+
71+
.. _classic-mode-upgrade-disable:
5472

55-
Disabling the Core Updater
56-
--------------------------
73+
Disabling the Core Updater in a classic mode installation
74+
=========================================================
5775

5876
The Core Updater functionality can be turned off, in order to avoid users using it,
5977
i.e. if you use your own update mechanism.
@@ -62,49 +80,36 @@ This feature is already disabled when TYPO3 is installed via Composer.
6280

6381
To disable the Core updater, you can set this environment variable:
6482

65-
.. code-block:: none
66-
:caption: Environment variable
83+
.. tabs::
6784

68-
TYPO3_DISABLE_CORE_UPDATER=1
85+
.. group-tab:: Environment variable
6986

70-
For example in Apache:
87+
.. code-block:: none
7188

72-
.. code-block:: apacheconf
73-
:caption: typo3_root/public/.htaccess
89+
TYPO3_DISABLE_CORE_UPDATER=1
7490

75-
SetEnv TYPO3_DISABLE_CORE_UPDATER 1
91+
.. tabs::
7692

77-
or for NGINX:
93+
.. group-tab:: Apache
7894

79-
.. code-block:: nginx
80-
:caption: /usr/local/nginx/conf/nginx.conf
95+
.. code-block:: apacheconf
96+
:caption: typo3_root/public/.htaccess
8197

82-
server {
83-
location ~ path/to/it {
84-
include fastcgi_params;
85-
fastcgi_param TYPO3_DISABLE_CORE_UPDATER "1";
86-
}
87-
}
98+
SetEnv TYPO3_DISABLE_CORE_UPDATER 1
8899

89-
This will remove the button and all related functionality in the Install
90-
Tool.
91-
92-
What's the Next Step?
93-
=====================
94-
95-
In case you performed a *minor update*, e.g. from TYPO3 12.4.0 to 12.4.1, database
96-
updates are usually *not* necessary, though you still have to
97-
:ref:`remove the temporary cache files <clear_caches>`. After
98-
that your update is finished.
100+
.. tabs::
99101

100-
.. note::
102+
.. group-tab:: NGINX
101103

102-
Make sure to read the release notes of even the minor versions carefully. While
103-
great care is taken to keep the minor updates as easy as possible, (especially
104-
when releasing security updates) more steps might be necessary.
104+
.. code-block:: nginx
105+
:caption: /usr/local/nginx/conf/nginx.conf
105106

106-
In case of a *major update*, e.g. from TYPO3 11.5 to 12.4, go ahead with the next
107-
step!
107+
server {
108+
location ~ path/to/it {
109+
include fastcgi_params;
110+
fastcgi_param TYPO3_DISABLE_CORE_UPDATER "1";
111+
}
112+
}
108113

109-
Also check out any breaking changes listed in the :doc:`changelog <ext_core:Index>`
110-
for the new version.
114+
This will remove the button and all related functionality in the Install
115+
Tool.

‎Documentation/Images/ManualScreenshots/AdminTools/UpgradeTools.png‎

63.9 KB
Loading

0 commit comments

Comments
 (0)