Skip to content

Commit 709248c

Browse files
author
ilya ilchenko
committed
📖 update docs v2
1 parent ed57519 commit 709248c

File tree

3 files changed

+42
-49
lines changed

3 files changed

+42
-49
lines changed

access_restricted/README.rst

Lines changed: 14 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -2,29 +2,31 @@
22
:alt: Tested and maintained by IT Projects Labs
33
:target: https://itpp.dev
44

5+
56
Restricted administration rights
67
================================
78

8-
The module makes impossible for administrator to set (or see) more access rights (access groups) than he already has.
9-
10-
It also using for restrict changes to certain settings for specific users, who should be prevented from making important changes without the knowledge of the superuser.
9+
The module makes impossible for **Internal User** to set (or see) more access **groups/rights** than he already has.
1110

12-
The only partial exception if user is already a member of the **'Allow add implied groups from settings'** security group.
11+
Using this module, you can restrict access to changing some settings of other modules.
12+
For take effect it should be used with modules such as CRM, Sales etc.
13+
These modules have some parameters that add access groups to the user,
14+
thereby making it possible to make important changes to the functionality.
15+
With this module, only superuser-defined users can modify these fields.
1316

14-
Sure, it doesn't affect to superuser rights.
1517

1618
Typical usage of the module.
1719
----------------------------
1820

19-
This example in addition to this module installed also requires **base_setup** and **access_apps** modules.
21+
This example in addition to this module installed also requires our **access_apps** module.
22+
23+
- The superuser creates an admin user without any ``Apps Access`` option in its settings.Then the administrator has access to settings, but not able to install new apps.
24+
2025

21-
1. The superuser creates an administrator user with empty parameter **"Apps access"**.
22-
2. Then the administrator has access to settings, but not able to install new apps.
26+
- Without this module, it can change the option to ``Apps access: Allow installing apps`` and get access to apps management.
2327

24-
* Without this module this user can add himself to **"Allow installing apps"** access group and get access to apps management.
2528

26-
=============
29+
------------
2730

28-
**Read more examples in the module's documentation.**
2931

30-
It was tested on `Odoo 14.0 <https://github.com/odoo/odoo/commit/c16d4b5e7b9181c2c792f595a117de10510d45be>`_
32+
Tested on `Odoo 14.0 <https://github.com/odoo/odoo/commit/c16d4b5e7b9181c2c792f595a117de10510d45be>`_

access_restricted/doc/index.rst

Lines changed: 28 additions & 37 deletions
Original file line numberDiff line numberDiff line change
@@ -2,20 +2,6 @@
22
Restricted administration rights
33
==================================
44

5-
Description
6-
============
7-
Using this module, you can restrict access to changing some settings of third-party modules.
8-
9-
This module should be used with other modules that support access groups such as CRM, Sales and etc.
10-
11-
The module makes impossible for administrator to set (or see) more access rights (access groups) than he already has.
12-
13-
It also using for restrict changes to certain settings for specific users, who should be prevented from making important changes without the knowledge of the superuser.
14-
15-
The only partial exception if user is already a member of the **'Allow add implied groups from settings'** security group. This user is allowed to escalate his privileges but just from Settings menus.
16-
17-
Sure, it doesn't affect to superuser rights.
18-
195
Installation
206
============
217

@@ -24,42 +10,47 @@ Installation
2410
Configuration
2511
=============
2612

27-
- IMPORTANT NOTE:
28-
By default all users except a superuser restricted to escalate the privileges
13+
**IMPORTANT NOTE:** By default, all users except the superuser are restricted from changing their access gropus for escalate privileges.
2914

15+
It allows certain users to configure modules from ``[[ Settings ]]``
16+
menu using boolean fields which ``Field`` value starts with a **group_**
17+
`(This info is displayed when hovering over the option name if developer tools is enabled)`
18+
19+
The only users who are in special group **'Allow add implied groups from settings'**
20+
have access to make changes in forbidden for others fields.
3021

3122
There is only one configuration option this module provides:
3223

33-
1. Under superuser open ``[[ Settings ]] >> Users & Companies >> Users`` and select user's profile
34-
2. In ``Access Rights`` tab you can select **'Allow add implied groups from settings'**
35-
3. It allows some users to configure modules from ``[[ Settings ]]`` menus by means of boolean fields which **Field** value starts from **group_...**. (This info is displayed when hovering over the option name if developer tools is enabled)
24+
- Under superuser open ``[[ Settings ]] >> Users & Companies >> Users`` and select user's profile
25+
- In ``Access Rights`` tab activate 'Allow add implied groups from settings'
3626

27+
The user is then allowed to add additional access groups for himself
28+
by using the Boolean settings fields. `(res.config.settings models views)`
29+
3730
Usage
3831
=====
39-
40-
Let's take a few examples.
41-
42-
**In the first case:** we have installed this module and **Sales module** ``(sale_management)`` from ``[[ Apps ]]``.
32+
Let's take an example of using this module and **Sales** module (sale_management).
4333

4434
**Without this module installed:**
4535

46-
- Say you have a user with administration rights ``"Administration: Access Rights"``. This user thus may increase his own rights in ``"Access Rights > Sales"`` from ``"Sales: User: Own Documents Only"`` to ``"Sales: Administrator"``.
47-
48-
**With this module installed:**
49-
50-
- The user from previous example cannot increase his privileges. There is no ``Sales: Administrator`` option for him, and also no ``Customer Addresses`` option in module configuration
36+
Say you have a user with administration rights ``Administration: Access Rights``.
37+
This user thus may increase his own rights in ``Access Rights > Sales``
38+
from ``Sales: User: Own Documents Only`` to ``Sales: Administrator``.
5139

52-
The only exception is done for users who are in special group **'Allow add implied groups from settings'** they may select ``"Customer Addresses"`` from ``[[ Sales ]]`` module ``Configuration >> Settings`` menu
40+
Also he can open menu [[ Sales ]] >> Configuration >> Settings and
41+
select Customer Addresses (**group_** sale_delivery_address) there and then click [Apply] button
5342

5443

55-
=================
56-
57-
58-
**In another case:** we have also installed this module and also **CRM module**.
59-
60-
* In the screenshot. the user has an access right to the settings panel from his account. (``Administration: Settings``), but is not a member of the **'Allow add implied groups from settings'** access group so it is forbidden for him to set some checkboxes in the **CRM** tab.
44+
**With this module installed:**
6145

62-
.. image:: access_restricted_screenshot.png
46+
The example user cannot increase their privileges.
47+
There is no ``Sales: Administrator`` option for it and for this reason
48+
there are no module settings, including the
49+
``Client Addresses`` option.
6350

64-
* If we give him access by adding to this group, the user will have access to make changes in forbidden fields.
51+
-------------
6552

53+
To activate the ``Customer Addresses`` option, the user must be:
54+
- with administration rights `` Administration: Settings``
55+
and also with ``Sales: Administrator`` rights
56+
- is included in the **'Allow add implied groups from settings'** group.

access_restricted/doc/access_restricted_screenshot.png renamed to access_restricted/static/description/access_restricted_screenshot.png

File renamed without changes.

0 commit comments

Comments
 (0)