Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
:navigation-title: Content Security Policy
.. include:: /Includes.rst.txt
.. _admin-tools-csp:

=====================================
Content Security Policy (Admin Tools)
=====================================

:ref:`Content Security Policy <t3coreapi:content-security-policy>` declarations
can be applied to a TYPO3 website in frontend and backend scope with a dedicated
API.

This module handles
:ref:`Reporting of violations of the Content Security
Policy <t3coreapi:content-security-policy-reporting>`. It is always available
but can only be:ref:`accessed via the backend <t3start:admin-tools-access>`,
not the Install Tool.
15 changes: 15 additions & 0 deletions Documentation/Concepts/Backend/AdminTools/Environment.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
:navigation-title: Environment
.. include:: /Includes.rst.txt
.. _admin-tools-environment:

=========================
Environment (Admin Tools)
=========================

Only available if :composer:`typo3/cms-install` is installed.

The backend module :guilabel:`Admin Tools > Maintenance` offers tools
to system maintainers regarding the server environment like PHP and database
versions, directory status, mail setup and image processing.

.. todo: Describe the tools available here
15 changes: 15 additions & 0 deletions Documentation/Concepts/Backend/AdminTools/Extensions.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
:navigation-title: Extensions
.. include:: /Includes.rst.txt
.. _admin-tools-extensions:

========================
Extensions (Admin Tools)
========================

Only available if :composer:`typo3/cms-extensionmanager` is installed.

The backend module :guilabel:`Admin Tools > Extensions`, also called
"Extension Manager", can be used in Composer-based extensions to view which
TYPO3 extensions are installed. In non-Composer installation (not in the scope
of this guide) they can also be used to install and activate extensions:
:ref:`Installing an Extension using the Extension Manager <t3coreapi:extension-install>`.
89 changes: 89 additions & 0 deletions Documentation/Concepts/Backend/AdminTools/Index.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,89 @@
.. include:: /Includes.rst.txt
.. _admin-tools:

===========
Admin Tools
===========

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.

The following modules are available in a full TYPO3 installation:

.. toctree::
:glob:
:titlesonly:

Maintenance
Settings
Upgrade
Environment
ContentSecurityPolicy
Extensions

.. contents::

.. _admin-tools-access:

Accessing the Admin Tools
=========================

The Admin Tools can only be accessed from the backend if:

* :composer:`typo3/cms-install` is installed. This system extension became
optional with TYPO3 13.
* The currently logged in backend user has admin privileges and is a system
maintainer.
* On systems in the :ref:`application context "Production" <production-settings>`
the user has to reconfirm their login.

If the TYPO3 backend is not accessible you can access the "Install Tool", which
features the Admin Tool modules provided by :composer:`typo3/cms-install`:

.. _install-tools-access:

Accessing the Install Tools without TYPO3 Backend access
========================================================

On any TYPO3 installation with :composer:`typo3/cms-install` you can access the
Install Tools by calling the following URL: `https://example.org/typo3/index.php`.

To prove that you have writing access to the file system where TYPO3 is installed
you **have to** create a file in path :file:`var/transient/ENABLE_INSTALL_TOOL`
or :file:`config/ENABLE_INSTALL_TOOL`. The file can be empty, TYPO3 has to have
write access to the file. You can create it like this on:

.. code-block:: bash

touch config/ENABLE_INSTALL_TOOL

See also :confval:`TYPO3 Explained, ENABLE_INSTALL_TOOL <t3coreapi:flag-file-enable-install-tool>`.

You **must** now enter the Install Tool password. If you do not know the install
tool password you can generate a new one by entering the desired password.

Copy the calculated hash:

.. figure:: /Images/ManualScreenshots/AdminTools/InstallToolHash.png
:alt: Screenshot demonstrating copying the calculated hash in the install tool

Copy the calculated hash

Open file :file:`config/system/settings.php` and adjust the Install tool
password like so:

.. code-block:: diff
:caption: config/system/settings.php (Diference)

<?php
return [
'BE' => [
- 'installToolPassword' => '$argon2i$v=19$m=65536,t=16,p=1$Z1BRbnZDdGx4T3pJVmpLVw$Bjhz+rSW1Bps5hIdXUBXrtlZ52E4Qx4lw4NU0MiEUyg',
+ 'installToolPassword' => '$argon2i$v=19$m=65536,t=16,p=1$Z0tiZjVVdzN5VUEuLzhmYw$xTalKXJVMCALCO+0OklDt24Y/7NkffNc1bOeg2jo00I',
'passwordHashing' => [
'className' => 'TYPO3\\CMS\\Core\\Crypto\\PasswordHashing\\Argon2iPasswordHash',
'options' => [],
],
],
];
69 changes: 69 additions & 0 deletions Documentation/Concepts/Backend/AdminTools/Maintenance.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,69 @@
:navigation-title: Maintenance
.. include:: /Includes.rst.txt
.. _admin-tools-maintenance:

=========================
Maintenance (Admin Tools)
=========================

Only available if :composer:`typo3/cms-install` is installed.

The backend module :guilabel:`Admin Tools > Maintenance` offers tools
to system maintainers that are necessary during development or updates.

Some of the tools available here include:

.. todo: describe the other tools

.. contents::

.. _admin-tools-maintenance-flush-cache:

Flush TYPO3 and PHP Cache
=========================

By clicking the button :guilabel:`Flush cache` you can flush all caches. This is
necessary during development if you changed files like
:ref:`Fluid templates <fluid-templates>`, :ref:`TypoScript files <typoscript>`,
or PHP files.

It is also necessary to flush caches after installing or updating extensions.

You can achieve the same effect by calling

.. code-block:: bash

ddev typo3 cache: flush

.. note::
Flushing the cache via the "Clear cache" buttons in the
:ref:`Top Bar <top-bar>` does not have the same effect. It does not flush
PHP related caches.

.. _admin-tools-maintenance-database-analyzer:

Analyze Database Structure
==========================

Aside its name this tool does not only analyze the database structure but also
offers to fix it for you.

Database changes can be necessary when :ref:`TCA files <tca>` where changed or
extensions installed / updated.

.. _admin-tools-maintenance-create-admin:

Create Administrative User
==========================

This tool can be used to create a new administrative backend user with or
without maintainer privileges.

You can also create a new backend user from the console:

.. code-block:: bash

ddev typo3 backend:user:create

and from the module :guilabel:`System > Backend Users`. The latter cannot
grant system maintainer rights but is available to all admins.
15 changes: 15 additions & 0 deletions Documentation/Concepts/Backend/AdminTools/Settings.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
:navigation-title: Settings
.. include:: /Includes.rst.txt
.. _admin-tools-settings:

======================
Settings (Admin Tools)
======================

Only available if :composer:`typo3/cms-install` is installed.

The backend module :guilabel:`Admin Tools > Settings` offers tools
to system maintainers regarding **global** settings that influence the complete
TYPO3 installation.

.. todo: Describe the tools available here
15 changes: 15 additions & 0 deletions Documentation/Concepts/Backend/AdminTools/Upgrade.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
:navigation-title: Upgrade
.. include:: /Includes.rst.txt
.. _admin-tools-upgrade:

=====================
Upgrade (Admin Tools)
=====================

Only available if :composer:`typo3/cms-install` is installed.

The backend module :guilabel:`Admin Tools > Upgrade` offers tools
to system maintainers that are useful during
:ref:`Major upgrades (TYPO3 explained) <t3coreapi:major>`.

.. todo: Describe the tools available here
1 change: 1 addition & 0 deletions Documentation/Concepts/Backend/Index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,7 @@ see when browsing the site.
ListModule/Index
FileModule/Index
InfoModule/Index
AdminTools/Index
SystemModules/Index

.. _backend modules:
Expand Down
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading