Green_GoodERP18_FSJ_Standard/gooderp18/myaddons/auth_admin_passkey/README.rst

===============================================
Authentification - System Administrator Passkey
===============================================

.. 
   !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
   !! This file is generated by oca-gen-addon-readme !!
   !! changes will be overwritten.                   !!
   !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
   !! source digest: sha256:1f6c1842b29ec5688e1621fae3e50ba24b946451b6df3e3263127947aee1d832
   !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!

.. |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--auth-lightgray.png?logo=github
    :target: https://github.com/OCA/server-auth/tree/18.0/auth_admin_passkey
    :alt: OCA/server-auth
.. |badge4| image:: https://img.shields.io/badge/weblate-Translate%20me-F47D42.png
    :target: https://translation.odoo-community.org/projects/server-auth-18-0/server-auth-18-0-auth_admin_passkey
    :alt: Translate me on Weblate
.. |badge5| image:: https://img.shields.io/badge/runboat-Try%20me-875A7B.png
    :target: https://runboat.odoo-community.org/builds?repo=OCA/server-auth&target_branch=18.0
    :alt: Try me on Runboat

|badge1| |badge2| |badge3| |badge4| |badge5|

This module extends the functionality of users module to support loging
in with an extra system administrator password in other user accounts.

- System Administrator has now the possibility to login in with any
  login
- According to the configuration, Odoo will send a mail to user and
  admin to indicate them
- According to the configuration, password can be stored encrypted in
  configuration file

**Table of contents**

.. contents::
   :local:

Configuration
=============

To enable this feature, once the module installed, you have to add the
following keys in your ``odoo.cfg`` configuration file.

- ``auth_admin_passkey_password``. The password that allows user to
  logging in with any login. If not set, the feature is disabled.
- ``auth_admin_passkey_password_sha512_encrypted`` (default False), if
  enabled, auth_admin_passkey_password should be the password encrypted
  with sha512. On linux, this can be done using this command:
  ``echo -n YOUR_PASSWORD_AUTH_ADMIN_PASSKEY | sha512sum``
- ``auth_admin_passkey_send_to_user`` (default True), if enabled, an
  email will be send to the user, if his account has been used by the
  System Administrator.
- ``auth_admin_passkey_sysadmin_email``. If set, an email will be sent
  to this mail.
- ``auth_admin_passkey_sysadmin_lang``. the language (exemple en_US),
  used for the mail sent to the System Administrator. If not set, the
  language of the SUPERUSER_ID user will be used.
- ``auth_admin_passkey_ignore_totp`` (default False), if enabled, then
  2FA will be ignored.

**typical Dev / Test configuration section**

No keys to add.

**typical Production configuration section**

.. code:: ini

   auth_admin_passkey_password = PASSKEY_PASSWORD
   auth_admin_passkey_password_sha512_encrypted = True
   auth_admin_passkey_send_to_user = True
   auth_admin_passkey_sysadmin_email = SYSADMIN_EMAIL
   auth_admin_passkey_sysadmin_lang = SYSADMIN_LANG

Bug Tracker
===========

Bugs are tracked on `GitHub Issues <https://github.com/OCA/server-auth/issues>`_.
In case of trouble, please check there if your issue has already been reported.
If you spotted it first, help us to smash it by providing a detailed and welcomed
`feedback <https://github.com/OCA/server-auth/issues/new?body=module:%20auth_admin_passkey%0Aversion:%2018.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
-------

* GRAP

Contributors
------------

- Eugen Don <eugen.don@don-systems.de>
- Alexandre Papin (https://twitter.com/Fenkiou)
- Sylvain LE GAL (https://twitter.com/legalsylvain)
- Dhara Solanki <dhara.solanki@initos.com> (http://www.initos.com)
- Zina Rasoamanana <zina.rasoamanana@acsone.eu>

Maintainers
-----------

This module is maintained by the OCA.

.. image:: https://odoo-community.org/logo.png
   :alt: Odoo Community Association
   :target: https://odoo-community.org

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.

This module is part of the `OCA/server-auth <https://github.com/OCA/server-auth/tree/18.0/auth_admin_passkey>`_ project on GitHub.

You are welcome to contribute. To learn how please visit https://odoo-community.org/page/Contribute.