mirror of
https://github.com/OCA/server-backend.git
synced 2025-02-18 09:52:42 +02:00
[UPD] README.rst
This commit is contained in:
OCA-git-bot
@@ -1,36 +1,161 @@
|
||||
.. image:: https://img.shields.io/badge/license-AGPL--3-blue.png
|
||||
:target: https://www.gnu.org/licenses/agpl
|
||||
:alt: License: AGPL-3
|
||||
|
||||
==========
|
||||
User roles
|
||||
==========
|
||||
|
||||
.. !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
|
||||
!! This file is generated by oca-gen-addon-readme !!
|
||||
!! changes will be overwritten. !!
|
||||
!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
|
||||
|
||||
.. |badge1| image:: https://img.shields.io/badge/maturity-Beta-yellow.png
|
||||
:target: https://odoo-community.org/page/development-status
|
||||
:alt: Beta
|
||||
.. |badge2| image:: https://img.shields.io/badge/licence-AGPL--3-blue.png
|
||||
:target: http://www.gnu.org/licenses/agpl-3.0-standalone.html
|
||||
:alt: License: AGPL-3
|
||||
.. |badge3| image:: https://img.shields.io/badge/github-OCA%2Fserver--backend-lightgray.png?logo=github
|
||||
:target: https://github.com/OCA/server-backend/tree/12.0/base_user_role
|
||||
:alt: OCA/server-backend
|
||||
.. |badge4| image:: https://img.shields.io/badge/weblate-Translate%20me-F47D42.png
|
||||
:target: https://translation.odoo-community.org/projects/server-backend-12-0/server-backend-12-0-base_user_role
|
||||
:alt: Translate me on Weblate
|
||||
.. |badge5| image:: https://img.shields.io/badge/runbot-Try%20me-875A7B.png
|
||||
:target: https://runbot.odoo-community.org/runbot/253/12.0
|
||||
:alt: Try me on Runbot
|
||||
|
||||
|badge1| |badge2| |badge3| |badge4| |badge5|
|
||||
|
||||
This module was written to extend the standard functionality regarding users
|
||||
and groups management.
|
||||
It helps creating well-defined user roles and associating them to users.
|
||||
|
||||
It can become very hard to maintain a large number of user profiles over time,
|
||||
juggling with many technical groups. For this purpose, this module will help
|
||||
you to:
|
||||
|
||||
* define functional roles by aggregating low-level groups,
|
||||
* set user accounts with the predefined roles (roles are cumulative),
|
||||
* update groups of all relevant user accounts (all at once),
|
||||
* ensure that user accounts will have the groups defined in their roles
|
||||
(nothing more, nothing less). In other words, you can not set groups
|
||||
manually on a user as long as there is roles configured on it,
|
||||
* activate/deactivate roles depending on the date (useful to plan holidays, etc)
|
||||
* get a quick overview of roles and the related user accounts.
|
||||
|
||||
That way you make clear the different responsabilities within a company, and
|
||||
are able to add and update user accounts in a scalable and reliable way.
|
||||
|
||||
**Table of contents**
|
||||
|
||||
.. contents::
|
||||
:local:
|
||||
|
||||
Configuration
|
||||
=============
|
||||
|
||||
To configure this module, you need to go to *Configuration / Users / Roles*,
|
||||
and create a new role. From there, you can add groups to compose your role,
|
||||
and then associate users to it.
|
||||
|
||||
You can also define default roles for a new user by editing the user called
|
||||
"Default User".
|
||||
|
||||
Roles:
|
||||
|
||||
.. image:: /base_user_role/static/description/roles.png
|
||||
|
||||
Add groups:
|
||||
|
||||
.. image:: /base_user_role/static/description/role_groups.png
|
||||
|
||||
Add users (with dates or not):
|
||||
|
||||
.. image:: /base_user_role/static/description/role_users.png
|
||||
|
||||
Usage
|
||||
=====
|
||||
|
||||
[ This file must be present and contains the usage instructions
|
||||
for end-users. As all other rst files included in the README,
|
||||
it MUST NOT contain reStructuredText sections
|
||||
only body text (paragraphs, lists, tables, etc). Should you need
|
||||
a more elaborate structure to explain the addon, please create a
|
||||
Sphinx documentation (which may include this file as a "quick start"
|
||||
section). ]
|
||||
|
||||
To use this module, you need to:
|
||||
|
||||
#. Go to Configuration / Users / Users choose user and set Roles:
|
||||
|
||||
.. image:: /base_user_role/static/description/user_form.png
|
||||
|
||||
Known issues / Roadmap
|
||||
======================
|
||||
|
||||
Bugs are tracked on `GitHub Issues
|
||||
<https://github.com/OCA/server-backend/issues>`_. In case of trouble, please
|
||||
check there if your issue has already been reported. If you spotted it first,
|
||||
help us smash it by providing detailed and welcomed feedback.
|
||||
|
||||
Bug Tracker
|
||||
===========
|
||||
|
||||
Bugs are tracked on `GitHub Issues <https://github.com/OCA/server-backend/issues>`_.
|
||||
In case of trouble, please check there if your issue has already been reported.
|
||||
If you spotted it first, help us smashing it by providing a detailed and welcomed
|
||||
`feedback <https://github.com/OCA/server-backend/issues/new?body=module:%20base_user_role%0Aversion:%2012.0%0A%0A**Steps%20to%20reproduce**%0A-%20...%0A%0A**Current%20behavior**%0A%0A**Expected%20behavior**>`_.
|
||||
|
||||
Do not contact contributors directly about support or help with technical issues.
|
||||
|
||||
Credits
|
||||
=======
|
||||
|
||||
Authors
|
||||
~~~~~~~
|
||||
|
||||
* ABF OSIELL
|
||||
|
||||
Contributors
|
||||
------------
|
||||
~~~~~~~~~~~~
|
||||
|
||||
* Sébastien Alix <sebastien.alix@osiell.com>
|
||||
* Duc, Dao Dong <duc.dd@komit-consulting.com> (https://komit-consulting.com)
|
||||
* Jean-Charles Drubay <jc@komit-consulting.com> (https://komit-consulting.com)
|
||||
|
||||
Maintainer
|
||||
----------
|
||||
Do not contact contributors directly about support or help with technical issues.
|
||||
|
||||
Other credits
|
||||
~~~~~~~~~~~~~
|
||||
|
||||
Images
|
||||
------
|
||||
|
||||
* Oxygen Team: `Icon <http://www.iconarchive.com/show/oxygen-icons-by-oxygen-icons.org/Actions-user-group-new-icon.html>`_ (LGPL)
|
||||
|
||||
Maintainers
|
||||
~~~~~~~~~~~
|
||||
|
||||
This module is maintained by the OCA.
|
||||
|
||||
.. image:: https://odoo-community.org/logo.png
|
||||
:alt: Odoo Community Association
|
||||
:target: https://odoo-community.org
|
||||
|
||||
This module is maintained by the OCA.
|
||||
|
||||
OCA, or the Odoo Community Association, is a nonprofit organization whose
|
||||
mission is to support the collaborative development of Odoo features and
|
||||
promote its widespread use.
|
||||
|
||||
To contribute to this module, please visit https://odoo-community.org.
|
||||
.. |maintainer-ABF OSIELL| image:: https://github.com/ABF OSIELL.png?size=40px
|
||||
:target: https://github.com/ABF OSIELL
|
||||
:alt: ABF OSIELL
|
||||
.. |maintainer-jcdrubay| image:: https://github.com/jcdrubay.png?size=40px
|
||||
:target: https://github.com/jcdrubay
|
||||
:alt: jcdrubay
|
||||
|
||||
Current `maintainers <https://odoo-community.org/page/maintainer-role>`__:
|
||||
|
||||
|maintainer-ABF OSIELL| |maintainer-jcdrubay|
|
||||
|
||||
This module is part of the `OCA/server-backend <https://github.com/OCA/server-backend/tree/12.0/base_user_role>`_ project on GitHub.
|
||||
|
||||
You are welcome to contribute. To learn how please visit https://odoo-community.org/page/Contribute.
|
||||
|
||||
Reference in New Issue
Block a user