Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[TASK] Add Groups Inheritance chapter for Permissions Management docs #335

Merged
merged 1 commit into from
Mar 5, 2024
Merged

[TASK] Add Groups Inheritance chapter for Permissions Management docs #335

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
23 changes: 23 additions & 0 deletions Documentation/PermissionsManagement/GroupsInheritance/Index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
.. include:: /Includes.rst.txt

.. index:: backend, acl, permissions, user groups, user management

.. _groups-inheritance:

==================
Groups inheritance
==================

Even though TYPO3 does not limit the depth of backend user group inheritance,
it's advisable to avoid complex setups. Typically, 1 or 2 levels of inheritance
should suffice. Such flat structures offer significant advantages over more complex,
deeper inheritances, including easier maintenance, updates, and verification
of the sources of specific permissions.

.. uml:: _simple-groups-inheritance.plantuml
:align: center
:caption: Backend groups hierarchy with 2 levels of inheritance
:width: 700

.. note::
Avoid complex inheritance within backend user groups. One or two levels of inheritance should suffice and make permissions easier to maintain.
46 changes: 46 additions & 0 deletions Documentation/PermissionsManagement/GroupsInheritance/_simple-groups-inheritance.plantuml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,46 @@
@startuml
skinparam defaultTextAlignment center
skinparam nodesep 10
skinparam ranksep 20

rectangle "User" AS User #Motivation {
}

rectangle "First level" AS First_Level #line.dotted {
rectangle "R_role_group" AS R_role_group #Implementation {
}
}

User <-down- First_Level

rectangle "Second level" AS Second_Level #line.dotted {
rectangle "System Groups" AS System_Groups #line.dotted {
rectangle "PG_website_a" as PG_website_a #Application
rectangle "DBM_website_a" as DBM_website_a #Application
rectangle "FM_website_a" as FM_website_a #Application
rectangle "CM_website_a" as CM_website_a #Application
rectangle "FO_all" as FO_all #Application
rectangle "L_all" as L_all #Application
PG_website_a -[hidden]-> DBM_website_a
DBM_website_a -[hidden]-> FM_website_a
FM_website_a -[hidden]-> CM_website_a
CM_website_a -[hidden]-> FO_all
FO_all -[hidden]-> L_all
}

rectangle "ACL Groups" AS ACL_Groups #line.dotted {
rectangle "ACL_content_elements" as ACL_content_elements #Technology
rectangle "ACL_news" as ACL_news #Technology
rectangle "ACL_gallery" as ACL_gallery #Technology
rectangle "ACL_survey" as ACL_survey #Technology
ACL_content_elements -[hidden]-> ACL_news
ACL_news -[hidden]-> ACL_gallery
ACL_gallery -[hidden]-> ACL_survey
}

System_Groups -[hidden]right-> ACL_Groups
}

First_Level <-down- Second_Level

@enduml
1 change: 1 addition & 0 deletions Documentation/PermissionsManagement/Index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -108,3 +108,4 @@ the naming convention for backend groups later on.
GeneralRecommendations/Index
SettingUpBackendGroups/Index
ExampleConfiguration/Index
GroupsInheritance/Index
Loading