Skip to content

Commit 65e2eae

Browse files
mentalkoilya ilchenko
authored andcommitted
📖 update docs
1 parent 59fdebd commit 65e2eae

File tree

4 files changed

+60
-20
lines changed

4 files changed

+60
-20
lines changed

access_restricted/README.rst

Lines changed: 18 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -2,18 +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 (and see) more access rights (groups) than he already has.
9-
The only partial exception of this rule is made if you are already a member of the 'Allow add implied groups from settings' security group.
10-
Then you are allowed to escalate your privileges but just from ``Settings`` menus (by means of ``group_XXX`` boolean fields of ``res.config.settings`` models views).
9+
The module makes impossible for **Internal User** to set (or see) more access **groups/rights** than he already has.
10+
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.
1116

12-
This doesn't affect superuser, of course.
1317

1418
Typical usage of the module.
1519
----------------------------
1620

17-
The superuser creates an administrator user without access group "Show Apps Menu" (see **access_apps** module). Then the administrator has access to settings, but not able to install new apps (without this module he can add himself to "Show Apps Menu" and get access to apps).
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+
25+
26+
- Without this module, it can change the option to ``Apps access: Allow installing apps`` and get access to apps management.
27+
28+
29+
------------
30+
1831

1932
Tested on `Odoo 14.0 <https://github.com/odoo/odoo/commit/c16d4b5e7b9181c2c792f595a117de10510d45be>`_
171 KB
Loading

access_restricted/doc/index.rst

Lines changed: 42 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -5,30 +5,57 @@
55
Installation
66
============
77

8-
* `Install <https://odoo-development.readthedocs.io/en/latest/odoo/usage/install-module.html>`__ this module in a usual way
8+
* `Install <https://odoo-development.readthedocs.io/en/latest/odoo/usage/install-module.html>`__ this module in a usual way.
99

1010
Configuration
1111
=============
1212

13-
* By default all users except a superuser restricted to escalate the privileges
14-
* There is only one configuration option this module provides. Under superuser open menu ``[[ Settings ]] >> Users & Companies >> Users``
15-
* In ``Access Rights`` tab you can select 'Allow add implied groups from settings' -
16-
to allow some users to configure modules by means of ``group_XXX`` fields from ``Settings`` menus
13+
**IMPORTANT NOTE:** By default, all users except the superuser are restricted from changing their access gropus for escalate privileges.
1714

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.
21+
22+
There is only one configuration option this module provides:
23+
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'
26+
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+
1830
Usage
1931
=====
32+
Let's take an example of using this module and **Sales** module (sale_management).
33+
34+
**Without this module installed:**
35+
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``.
39+
40+
Also he can open menu ``[[ Sales ]] >> Configuration >> Settings`` and
41+
select Customer Addresses (**group_** sale_delivery_address) there and then click ``[Apply]`` button
42+
43+
44+
**With this module installed:**
45+
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.
50+
51+
============
2052

21-
Let's take ``Sales (sale_management)`` module as an example.
53+
To activate the ``Customer Addresses`` option, the user must be:
2254

23-
Without this module installed:
55+
- with administration rights ``Administration: Settings`` and also with ``Sales: Administrator`` rights
2456

25-
* Say you have a user with administration rights ``Administration: Access Rights``. This user thus may increase his own rights in ``Application Accesses`` from ``Sales: User: Own Documents Only``
26-
to ``Sales: Administrator``. Also he can open menu ``[[ Sales ]] >> Configuration >> Settings`` and select ``Customer Addresses`` there
27-
and then click ``[Apply]`` button (adding ``group_sale_delivery_address``)
57+
- is included in the **'Allow add implied groups from settings'** group.
2858

29-
With this module installed:
59+
The screenshot shows a user who is not included in the 'Allow add implied groups from settings' group and cannot activate the ``Customer Addresses`` option.
3060

31-
* The user from previous example cannot increase his privileges. There is no ``Sales: Manager`` option for him, and also no ``Customer Addresses``
32-
option in module configuration
33-
* The only exception is done for users who are in special group 'Allow add implied groups from settings' - if your user is included in this group by the superuser then you may select
34-
``Customer Addresses`` from ``Sale`` module ``Configuration >> Settings`` menu
61+
.. image:: access_restricted_screenshot.png
171 KB
Loading

0 commit comments

Comments
 (0)