Author: |
Camptocamp SA, Odoo Community Association (OCA) |
License: |
AGPL-3 |
Branch: |
11.0 |
Repository: |
acsone/server-env |
Dependencies: |
auth_oauth,
and
server_environment |
Languages: |
Python (104, 56.8%),
XML (16, 8.7%),
and
reStructuredText (63, 34.4%) |
Other repositories: |
Change2improve/server-env,
ERPLibre/server-env,
Gabinete-Digital/server-env,
KonosCL/server-env,
NeatNerdPrime/server-env,
OCA-MUK/server-env,
OCA/server-env,
SanteLibre/server-env,
SequarSrl/server-env,
anhvu-sg/server-env,
brain-tec/server-env,
brainbeanapps/server-env,
camptocamp/server-env,
grindtildeath/server-env,
gurneyalex/server-env,
it-projects-llc/server-env,
sanube/server-env,
sendalpegat/server-env,
simahawk/server-env,
ursais/server-env,
and
yvaucher/server-env |
<a class="reference external image-reference" href="https://www.gnu.org/licenses/agpl"><img alt="License: AGPL-3" src="https://img.shields.io/badge/license-AGPL--3-blue.png" /></a>
<a name="auth-oauth-environment"></a>
<h2>Auth Oauth Environment</h2>
<p>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)</p>
<a name="installation"></a>
<h3>Installation</h3>
<p>To install this module, you need to have the server_environment module
installed and properly configured.</p>
<a name="configuration"></a>
<h3>Configuration</h3>
<p>To configure this module, you need to add a section
<code>[auth_oauth.provider_simple_name]</code> to you server_environment_files
configurations, where 'provider_simple_name' match the simplified name field on
auth.oauth.provider.</p>
<p>'provider_simple_name' is the first part (until first space character) in
lower case of provider name. Using existing providers, it could be either
<code>google</code>, <code>odoo.com</code>, or <code>facebook</code>.</p>
<p>For example, if you want to activate Google and Odoo.com, your
server_environment_files should look like this</p>
<pre>
<code>[auth_oauth.google]
enabled=True
client_id=123456789101-abcdefghijklmnopqrstuvwxyz000000
[auth_oauth.odoo.com]
enabled=True</code>
</pre>
<p>Any provider not being enabled through server_environment_files will be set as
disabled automatically.</p>
<p>If you want to define a new custom provider, you should pay attention to the
name to use in the server_environment_files. If you create a provider with
'Dummy auth provider' as its name, then the section should be named
<code>[auth_oauth.dummy]</code>.</p>
<a name="usage"></a>
<h3>Usage</h3>
<p>Once configured, Odoo will read from server_environment_files the following
fields of auth.oauth.provider :</p>
<ul class="simple">
<li>Allowed (<code>enabled</code>)</li>
<li>Client ID (<code>client_id</code>)</li>
</ul>
<a name="known-issues-roadmap"></a>
<h3>Known issues / Roadmap</h3>
<ul class="simple">
<li>Due to the specific nature of this module, it cannot be tested on OCA runbot.</li>
</ul>
<a name="bug-tracker"></a>
<h3>Bug Tracker</h3>
<p>Bugs are tracked on <a class="reference external" href="https://github.com/OCA/server-env/issues">GitHub Issues</a>. 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.</p>
<a name="credits"></a>
<h3>Credits</h3>
<a name="images"></a>
<h4>Images</h4>
<ul class="simple">
<li>Odoo Community Association: <a class="reference external" href="https://odoo-community.org/logo.png">Icon</a>.</li>
</ul>
<a name="contributors"></a>
<h4>Contributors</h4>
<ul class="simple">
<li>Akim Juillerat <<a class="reference external" href="mailto:akim.juillerat@camptocamp.com">akim.juillerat@camptocamp.com</a>></li>
</ul>
<p>Do not contact contributors directly about support or help with technical issues.</p>
<a name="maintainer"></a>
<h4>Maintainer</h4>
<a class="reference external image-reference" href="https://odoo-community.org"><img alt="Odoo Community Association" src="https://odoo-community.org/logo.png" /></a>
<p>This module is maintained by the OCA.</p>
<p>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.</p>
<p>To contribute to this module, please visit <a class="reference external" href="https://odoo-community.org">https://odoo-community.org</a>.</p>