Skip to content

Commit c471bbe

Browse files
linawolflinawolf
committed
[TASK] Create section describing all Admin Tools
Releases: main, 13.4, 12.4
1 parent bcf5228 commit c471bbe

File tree

9 files changed

+236
-0
lines changed

9 files changed

+236
-0
lines changed

‎Documentation/Concepts/Backend/AdminTools/ContentSecurityPolicy.rst‎

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

‎Documentation/Concepts/Backend/AdminTools/Environment.rst‎

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

‎Documentation/Concepts/Backend/AdminTools/Extensions.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/Concepts/Backend/AdminTools/Index.rst‎

Lines changed: 89 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,89 @@
1+
.. include:: /Includes.rst.txt
2+
.. _admin-tools:
3+
4+
===========
5+
Admin Tools
6+
===========
7+
8+
In the :ref:`User Management <t3coreapi:user-management>` chapter we covered the
9+
*Access* and *Backend Users* module. In this section we take a look
10+
at the remaining modules.
11+
12+
The following modules are available in a full TYPO3 installation:
13+
14+
.. toctree::
15+
:glob:
16+
:titlesonly:
17+
18+
Maintenance
19+
Settings
20+
Upgrade
21+
Environment
22+
ContentSecurityPolicy
23+
Extensions
24+
25+
.. contents::
26+
27+
.. _admin-tools-access:
28+
29+
Accessing the Admin Tools
30+
=========================
31+
32+
The Admin Tools can only be accessed from the backend if:
33+
34+
* :composer:`typo3/cms-install` is installed. This system extension became
35+
optional with TYPO3 13.
36+
* The currently logged in backend user has admin privileges and is a system
37+
maintainer.
38+
* On systems in the :ref:`application context "Production" <production-settings>`
39+
the user has to reconfirm their login.
40+
41+
If the TYPO3 backend is not accessible you can access the "Install Tool", which
42+
features the Admin Tool modules provided by :composer:`typo3/cms-install`:
43+
44+
.. _install-tools-access:
45+
46+
Accessing the Install Tools without TYPO3 Backend access
47+
========================================================
48+
49+
On any TYPO3 installation with :composer:`typo3/cms-install` you can access the
50+
Install Tools by calling the following URL: `https://example.org/typo3/index.php`.
51+
52+
To prove that you have writing access to the file system where TYPO3 is installed
53+
you **have to** create a file in path :file:`var/transient/ENABLE_INSTALL_TOOL`
54+
or :file:`config/ENABLE_INSTALL_TOOL`. The file can be empty, TYPO3 has to have
55+
write access to the file. You can create it like this on:
56+
57+
.. code-block:: bash
58+
59+
touch config/ENABLE_INSTALL_TOOL
60+
61+
See also :confval:`TYPO3 Explained, ENABLE_INSTALL_TOOL <t3coreapi:flag-file-enable-install-tool>`.
62+
63+
You **must** now enter the Install Tool password. If you do not know the install
64+
tool password you can generate a new one by entering the desired password.
65+
66+
Copy the calculated hash:
67+
68+
.. figure:: /Images/ManualScreenshots/AdminTools/InstallToolHash.png
69+
:alt: Screenshot demonstrating copying the calculated hash in the install tool
70+
71+
Copy the calculated hash
72+
73+
Open file :file:`config/system/settings.php` and adjust the Install tool
74+
password like so:
75+
76+
.. code-block:: diff
77+
:caption: config/system/settings.php (Diference)
78+
79+
<?php
80+
return [
81+
'BE' => [
82+
- 'installToolPassword' => '$argon2i$v=19$m=65536,t=16,p=1$Z1BRbnZDdGx4T3pJVmpLVw$Bjhz+rSW1Bps5hIdXUBXrtlZ52E4Qx4lw4NU0MiEUyg',
83+
+ 'installToolPassword' => '$argon2i$v=19$m=65536,t=16,p=1$Z0tiZjVVdzN5VUEuLzhmYw$xTalKXJVMCALCO+0OklDt24Y/7NkffNc1bOeg2jo00I',
84+
'passwordHashing' => [
85+
'className' => 'TYPO3\\CMS\\Core\\Crypto\\PasswordHashing\\Argon2iPasswordHash',
86+
'options' => [],
87+
],
88+
],
89+
];

‎Documentation/Concepts/Backend/AdminTools/Maintenance.rst‎

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

‎Documentation/Concepts/Backend/AdminTools/Settings.rst‎

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

‎Documentation/Concepts/Backend/AdminTools/Upgrade.rst‎

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
:navigation-title: Upgrade
2+
.. include:: /Includes.rst.txt
3+
.. _admin-tools-upgrade:
4+
5+
=====================
6+
Upgrade (Admin Tools)
7+
=====================
8+
9+
Only available if :composer:`typo3/cms-install` is installed.
10+
11+
The backend module :guilabel:`Admin Tools > Upgrade` offers tools
12+
to system maintainers that are useful during
13+
:ref:`Major upgrades (TYPO3 explained) <t3coreapi:major>`.
14+
15+
.. todo: Describe the tools available here

‎Documentation/Concepts/Backend/Index.rst‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -28,6 +28,7 @@ see when browsing the site.
2828
ListModule/Index
2929
FileModule/Index
3030
InfoModule/Index
31+
AdminTools/Index
3132
SystemModules/Index
3233

3334
.. _backend modules:

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

22.8 KB
Loading

0 commit comments

Comments
 (0)