[docs] Explain default permission groups (Admnistrator and Operator)

[nemesifier]

Document what will be discussed and decided on this mailing list discussion:

Default permisions: administrators and operators

Related to:

• [multi-tenancy] Hide content from operators #32 #38
• [groups] Added default "operator" and "user manager" groups. #40

[PabloCastellano]

During my onboarding to OpenWISP I wrote down a few User definitions that might be added to the documentation too. I found them specially useful when trying to reproduce bugs following instructions. Please review

Django admin/superuser

User.objects.create_user(is_staff=True, is_superuser=True)
# or User.objects.create_superuser()

Django staff user

User.objects.create_user(is_staff=True)

OpenWISP user

User.objects.create_user() # Belongs to 'default' organization

OpenWISP operator

User.objects.create_user(is_staff=True)
OrganizationUser(is_admin=False))  # Belongs to 'default' organization

OpenWISP operator for ABC organization

User.objects.create_user(is_staff=True)
OrganizationUser(is_admin=False, organization=abc_org))

OpenWISP admin for ABC organization

User.objects.create_user(is_staff=True)
OrganizationUser(is_admin=True, organization=abc_org))

[nemesifier]

Thank you Pablo, a few clarifications below.

OpenWISP user

User.objects.create_user() # Belongs to 'default' organization

I don't think a user created this way will belong to the default org, it will not belong to any org.

OpenWISP operator

User.objects.create_user(is_staff=True)
OrganizationUser(is_admin=False))  # Belongs to 'default' organization

Should be something like:

operator_group = Group.objects.get ... # query to get the operator group
user.groups.add(operator_group)
OrganizationUser.objects.create(is_admin=True, user=user, organization=organization)

Needs is_admin=True.

is_admin=False is used for end users, for example, a public wifi user which signs up via openwisp-radius. Or any other use case in which there are end-users which are just consumers and not managers of the network.

OpenWISP operator for ABC organization

User.objects.create_user(is_staff=True)
OrganizationUser(is_admin=False, organization=abc_org))

Same here.

OpenWISP admin for ABC organization

User.objects.create_user(is_staff=True)
OrganizationUser(is_admin=True, organization=abc_org))

the Administrator group needs to be assigned, the user must be passed to OrganizationUser.

[nemesifier]

We have some basic information about this in the openwisp-users module README.
While working on openwisp/openwisp-docs#107 we will look to include that here.

[nemesifier]

Now that we're finally moving forward with openwisp/openwisp-docs#107 I am moving this issue to the openwisp-users module, I will add the explanation there.

[nemesifier]

2d79d17 in #381 will close this issue. To anyone interested, feel free to review!