Skip to content

Commit 95cb8cc

Browse files
linawolffroemken
linawolf
and
froemken
authored
[FEATURE] How to create administrator accounts (#661)
* [FEATURE] How to create administrator accounts Preparing the structure for additional backend user and administration topics. Releases: main, 13.4, 12.4 * Apply suggestions from code review Co-authored-by: Stefan Frömken <[email protected]> --------- Co-authored-by: Stefan Frömken <[email protected]>
1 parent 2376494 commit 95cb8cc

File tree

10 files changed

+230
-2
lines changed

10 files changed

+230
-2
lines changed

‎Documentation/Administration/BackendUsers/Administrator.rst

Lines changed: 146 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,146 @@
1+
:navigation-title: Administrator
2+
3+
.. include:: /Includes.rst.txt
4+
.. _backend-users-admin:
5+
6+
===========================
7+
TYPO3 backend administrator
8+
===========================
9+
10+
Each administrator that uses the TYPO3 backend should have their own personal
11+
backend user account. This allows you to see who made which changes later on.
12+
13+
The administrator account that was automatically created for you during
14+
`Installation <https://docs.typo3.org/permalink/t3start:installation-index>`_
15+
has the widest rights possible and is a System Maintainer. The System Maintainer
16+
is an Administrator who can also see and use the section
17+
`Admin Tools <https://docs.typo3.org/permalink/t3start:admin-tools>`_ in the
18+
backend.
19+
20+
.. tip::
21+
If your Backend User account does not seem to work for some reason, check
22+
chapter `Troubleshooting common TYPO3 backend login
23+
problems <https://docs.typo3.org/permalink/t3start:troubleshooting-backend-login>`_.
24+
25+
.. contents:: Table of Contents
26+
:local:
27+
:depth: 1
28+
29+
.. _backend-users-admin-creation:
30+
31+
Creating a TYPO3 backend administrator
32+
======================================
33+
34+
There are 3 ways to create a new TYPO3 backend administrator:
35+
36+
.. contents:: Table of Contents
37+
:local:
38+
:depth: 1
39+
40+
.. _backend-users-admin-cli:
41+
42+
Create an administrator using a console command
43+
-----------------------------------------------
44+
45+
In DDEV or on a server if you can use the console there is a console
46+
command to create a new administrator:
47+
48+
.. tabs::
49+
50+
.. group-tab:: DDEV
51+
52+
.. code-block:: bash
53+
54+
ddev typo3 backend:user:create
55+
56+
.. group-tab:: On server
57+
58+
.. code-block:: bash
59+
60+
vendor/bin/typo3 backend:user:create
61+
62+
When prompted answer that you want to create an administrator. If they should
63+
also be a system maintainer, answer yes during the prompt.
64+
65+
.. _backend-users-admin-backend-module:
66+
67+
Using the backend module "Backend Users" to create admins
68+
---------------------------------------------------------
69+
70+
The first administrator got created for you during
71+
`Installation <https://docs.typo3.org/permalink/t3start:installation-index>`_.
72+
73+
When you log into the backend (See `Backend login <https://docs.typo3.org/permalink/t3start:backend-login>`_)
74+
you can go to module `Backend Users <https://docs.typo3.org/permalink/t3start:system-modules-backend-users>`_
75+
and create a new administrator there.
76+
77+
.. figure:: /Images/ManualScreenshots/BackendUser/CreateUser.png
78+
:alt: Screenshot of the "Backend Users" module demonstrating the location of the "Create new backend user" button in the module header
79+
80+
Open the module :guilabel:`System > Backend Users` and click on "Create new backend user"
81+
82+
When creating the user check the "Admin" option:
83+
84+
.. figure:: /Images/ManualScreenshots/BackendUser/CreateAdmin.png
85+
:alt: The Admin option is the first option in the tab "General" in the backend user edit form
86+
87+
When you check the Admin option the form needs to reload once. Answer the dialogue with "OK".
88+
89+
You can :ref:`Grant System Maintainer rights <backend-users-system-maintainer>`
90+
in the Admin Tools later on.
91+
92+
.. _backend-users-admin-install-tool:
93+
94+
Using the Install Tool to create an administrator
95+
-------------------------------------------------
96+
97+
Access the Install Tool at `https://my-site.ddev.site/typo3/install.php` using
98+
the Install Tool password defined during the installation process.
99+
100+
.. figure:: /Images/ManualScreenshots/BackendUser/InstallTool.png
101+
:alt: The Install Tool: Create Administrative User, Create new administrative users and grant them system maintainer privileges (optional).
102+
103+
In the module "Maintenance" module use the button "Create Administrator".
104+
105+
If they should be a System Maintainer check the box.
106+
107+
.. _backend-users-system-maintainer:
108+
109+
Granting System Maintainer rights
110+
=================================
111+
112+
.. note::
113+
You must be logged in with a System Maintainer account or use the
114+
Install Tool to grant System Maintainer rights. In
115+
`Application context Development <https://docs.typo3.org/permalink/t3start:application-context>`_
116+
all backend administrators can use the module.
117+
118+
Using the module :guilabel:`Admin Tools > Settings` and card
119+
"Manage System Maintainers Access" you can manage which administrator accounts
120+
should be granted "System Maintainer" rights.
121+
122+
.. figure:: /Images/ManualScreenshots/BackendUser/ManageSystemMaintainers.png
123+
:alt: "Manage System Maintainers" window in the Admin Tools.
124+
125+
Disabled backend admins are marked with [DISABLED], you can choose them any way.
126+
127+
On saving the changes are written to file :file:`config/system/settings.php`
128+
therefore this file needs to be writable.
129+
130+
If your installation also has a file called :file:`config/system/additional.php`
131+
the settings can be overridden here. In this case changes you make in the
132+
Admin Tools do not take effect.
133+
134+
A setting overriding the System Maintainer list could look like this:
135+
136+
.. code-block:: php
137+
:caption: config/system/additional.php
138+
139+
$GLOBALS['TYPO3_CONF_VARS']['SYS']['systemMaintainers'] => [
140+
1,
141+
3,
142+
42
143+
];
144+
145+
This setting is also documented in
146+
:ref:`systemMaintainers <t3coreapi:confval-globals-typo3-conf-vars-sys-systemmaintainers>`.

‎Documentation/Administration/BackendUsers/Index.rst

Lines changed: 43 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,43 @@
1+
:navigation-title: Backend Users
2+
3+
.. include:: /Includes.rst.txt
4+
5+
.. _backend-users:
6+
7+
============================================
8+
Creating and configuring TYPO3 backend users
9+
============================================
10+
11+
Each person that uses the TYPO3 backend should have their own personal backend
12+
user account.
13+
14+
The user that was automatically created for you during
15+
`Installation <https://docs.typo3.org/permalink/t3start:installation-index>`_
16+
has the widest rights possible and is a System Maintainer. The System Maintainer
17+
is an Administrator who can also see and use the section
18+
`Admin Tools <https://docs.typo3.org/permalink/t3start:admin-tools>`_ in the
19+
backend.
20+
21+
.. tip::
22+
If your Backend User account does not seem to work for some reason, check
23+
chapter `Troubleshooting common TYPO3 backend login
24+
problems <https://docs.typo3.org/permalink/t3start:troubleshooting-backend-login>`_.
25+
26+
.. toctree::
27+
:hidden:
28+
:titlesonly:
29+
:glob:
30+
31+
*
32+
33+
.. card-grid::
34+
:columns: 1
35+
:columns-md: 2
36+
:gap: 4
37+
:class: pb-4
38+
:card-height: 100
39+
40+
.. card:: `Administrators <https://docs.typo3.org/permalink/t3start:backend-users-admin>`_
41+
42+
Create personal administrator accounts and mange them. Grant
43+
System Maintainer permissions to administrators.

‎Documentation/Administration/Index.rst

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
:navigation-title: Administration
2+
3+
.. include:: /Includes.rst.txt
4+
5+
.. _administration:
6+
7+
==========================================
8+
Administration of your first TYPO3 project
9+
==========================================
10+
11+
In this chapter you will:
12+
13+
* Learn how to create and mange backend user.
14+
15+
.. card-grid::
16+
:columns: 1
17+
:columns-md: 2
18+
:gap: 4
19+
:class: pb-4
20+
:card-height: 100
21+
22+
.. card:: Backend User Management
23+
24+
Each person (administrator or editor) that uses the TYPO3 backend should
25+
have their own personal backend user account.
26+
27+
.. card-footer:: :ref:`Backend Users <backend-users>` :ref:`Administrators <backend-users-admin>`
28+
:button-style: btn btn-secondary stretched-link
29+
30+
.. toctree::
31+
:hidden:
32+
:titlesonly:
33+
34+
BackendUsers/Index

‎Documentation/Images/ManualScreenshots/BackendUser/CreateAdmin.png

8.51 KB
Loading

‎Documentation/Images/ManualScreenshots/BackendUser/CreateUser.png

36.7 KB
Loading

‎Documentation/Images/ManualScreenshots/BackendUser/InstallTool.png

78.9 KB
Loading

‎Documentation/Images/ManualScreenshots/BackendUser/ManageSystemMaintainers.png

22.2 KB
Loading

‎Documentation/Index.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -94,6 +94,7 @@ system and detailed information on how to install TYPO3.
9494
Concepts/Index
9595
Installation/Index
9696
FirstProject/Index
97+
Administration/Index
9798
Troubleshooting/Index
9899
Extensions/Index
99100
NextSteps/Index

‎Documentation/Troubleshooting/BackendLogin.rst

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,10 @@ The following errors can happen during backend login:
1111

1212
.. contents::
1313

14+
.. tip::
15+
`Creating a TYPO3 backend administrator <https://docs.typo3.org/permalink/t3start:backend-users-admin-creation>`_
16+
is a solution if you lost the password or user name of your administrator account.
17+
1418
.. _troubleshooting-login-reload:
1519

1620
Login page reloads without error
@@ -31,7 +35,7 @@ Login page reloads without error
3135
===========================
3236

3337
* Check if the username and password are correct.
34-
* Try to create a :ref:`new administrative user <t3coreapi:troubleshooting-backend-admin-password>`
38+
* Try to `Create a new backend administrator <https://docs.typo3.org/permalink/t3start:backend-users-admin-creation>`_
3539
and use that one.
3640

3741
.. _troubleshooting-login-white-screen:

‎Documentation/Troubleshooting/WebServer.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ You can find detailed information on the following topics in TYPO3 Explained:
1818

1919
.. card:: :ref:`TYPO3 <t3coreapi:troubleshooting-typo3>`
2020

21-
* :ref:`Reset Backend Administrative User Passwords <t3coreapi:troubleshooting-backend-admin-password>`
21+
* `Creating a TYPO3 backend administrator <https://docs.typo3.org/permalink/t3start:backend-users-admin-creation>`_
2222
* :ref:`Reset The Install Tool Password <t3coreapi:troubleshooting-install-tool-password>`
2323
* :ref:`Enabling Debug Mode <t3coreapi:troubleshooting-debug-mode>`
2424
* :ref:`Caching <t3coreapi:troubleshooting-caching>`

0 commit comments

Comments
 (0)