Metadata-Version: 2.1
Name: odoo-addon-auth_oauth_environment
Version: 17.0.1.0.0.2
Requires-Python: >=3.10
Requires-Dist: odoo-addon-server_environment>=17.0dev,<17.1dev
Requires-Dist: odoo>=17.0a,<17.1dev
Summary: Configure mail servers with server_environment_files
Home-page: https://github.com/OCA/server-env
License: AGPL-3
Author: Camptocamp SA, Odoo Community Association (OCA)
Author-email: support@odoo-community.org
Classifier: Programming Language :: Python
Classifier: Framework :: Odoo
Classifier: Framework :: Odoo :: 17.0
Classifier: License :: OSI Approved :: GNU Affero General Public License v3
Description-Content-Type: text/x-rst

.. image:: https://odoo-community.org/readme-banner-image
   :target: https://odoo-community.org/get-involved?utm_source=readme
   :alt: Odoo Community Association

================================================
Auth oauth configuration with server_environment
================================================

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

.. |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/license-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--env-lightgray.png?logo=github
    :target: https://github.com/OCA/server-env/tree/17.0/auth_oauth_environment
    :alt: OCA/server-env
.. |badge4| image:: https://img.shields.io/badge/weblate-Translate%20me-F47D42.png
    :target: https://translation.odoo-community.org/projects/server-env-17-0/server-env-17-0-auth_oauth_environment
    :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-env&target_branch=17.0
    :alt: Try me on Runboat

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

This module extends the functionality of server environment to support
OAuth providers, and allows you to enable providers and set client_id
key according to environment. (Refer to module server_environment for
more informations)

**Table of contents**

.. contents::
   :local:

Installation
============

To install this module, you need to have the server_environment module
installed and properly configured.

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

To configure this module, you need to add a section
``[auth_oauth.provider_name]`` to you server_environment_files
configurations, where 'provider_name' match the tech_name field on
auth.oauth.provider.

'provider_name' is the first part (until first space character) in lower
case of provider name. Using existing providers, it could be either
``provider_google``, ``provider_openerp``, or ``provider_facebook``.

For example, if you want to activate Google and Odoo.com, your
server_environment_files should look like this:

::

     [auth_oauth.provider_google]
     client_id=123456789101-abcdefghijklmnopqrstuvwxyz000000
     enabled=True

     [auth_oauth.provider_openerp]
     enabled=True

Any provider not being enabled through server_environment_files will be
set as disabled automatically.

If you want to define a new custom provider, you should pay attention to
the tech name to use in the server_environment_files. If you create a
provider with 'provider_dummy' as its tech_name, then the section should
be named ``[auth_oauth.provider_dummy]``.

Usage
=====

Once configured, Odoo will read from server_environment_files the
following fields of auth.oauth.provider :

- Allowed (``enabled``)
- Client ID (``client_id``)

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

Bugs are tracked on `GitHub Issues <https://github.com/OCA/server-env/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-env/issues/new?body=module:%20auth_oauth_environment%0Aversion:%2017.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
-------

* Camptocamp SA

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

- `Camptocamp <https://www.camptocamp.com>`__

  - Akim Juillerat akim.juillerat@camptocamp.com
  - Vincent Van Rossem vincent.vanrossem@camptocamp.com>

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-env <https://github.com/OCA/server-env/tree/17.0/auth_oauth_environment>`_ project on GitHub.

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