Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[16.0][MIG] users_ldap_mail: Migration to version 16.0 #512

Merged
merged 13 commits into from
Aug 14, 2023
Merged
Prev Previous commit
Next Next commit
[MIG] users_ldap_mail: Migration to 13.0
  • Loading branch information
joao-p-marques authored and pedrobaeza committed Aug 14, 2023
commit 658bc475cc07222ba18b82d45656d17851886a07
39 changes: 28 additions & 11 deletions users_ldap_mail/README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -14,13 +14,13 @@ LDAP mapping for user name and e-mail
: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/12.0/users_ldap_mail
:target: https://github.com/OCA/server-auth/tree/13.0/users_ldap_mail
: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-12-0/server-auth-12-0-users_ldap_mail
:target: https://translation.odoo-community.org/projects/server-auth-13-0/server-auth-13-0-users_ldap_mail
:alt: Translate me on Weblate
.. |badge5| image:: https://img.shields.io/badge/runbot-Try%20me-875A7B.png
:target: https://runbot.odoo-community.org/runbot/251/12.0
:target: https://runbot.odoo-community.org/runbot/251/13.0
:alt: Try me on Runbot

|badge1| |badge2| |badge3| |badge4| |badge5|
Expand All @@ -40,20 +40,28 @@ Usage
To use this module, you need to:

#. Open Odoo in your browser
#. Go to Settings
#. Go to General Settings
#. In The General Settings form go to LDAP Parameters
#. In a LDAP Parameters item there are two new fields: mail and name, the name
These items will correspond with a new user that is created, when a user
logs in via LDAP in Odoo.
#. Go to **Settings > General Settings**
#. In the **Integrations** section click on **LDAP Server** under
**LDAP Authentication**. This will allow you to create your LDAP integration
settings.
#. When creating or editing a record, under the **Process Parameter** section
there are two new fields: mail and name, the name of these items will
correspond with a new user that is created, when a user logs in via LDAP in
Odoo.

Known issues / Roadmap
======================


* Add tests (use LDAP Mocking through something like https://mockldap.readthedocs.io/en/latest/overview.html)

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 smashing it by providing a detailed and welcomed
`feedback <https://github.com/OCA/server-auth/issues/new?body=module:%20users_ldap_mail%0Aversion:%2012.0%0A%0A**Steps%20to%20reproduce**%0A-%20...%0A%0A**Current%20behavior**%0A%0A**Expected%20behavior**>`_.
`feedback <https://github.com/OCA/server-auth/issues/new?body=module:%20users_ldap_mail%0Aversion:%2013.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.

Expand All @@ -72,6 +80,7 @@ Contributors
* `Tecnativa <https://www.tecnativa.com>`_:

* Alexandre Díaz
* João Marques

Maintainers
~~~~~~~~~~~
Expand All @@ -86,6 +95,14 @@ 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/12.0/users_ldap_mail>`_ project on GitHub.
.. |maintainer-joao-p-marques| image:: https://github.com/joao-p-marques.png?size=40px
:target: https://github.com/joao-p-marques
:alt: joao-p-marques

Current `maintainer <https://odoo-community.org/page/maintainer-role>`__:

|maintainer-joao-p-marques|

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

You are welcome to contribute. To learn how please visit https://odoo-community.org/page/Contribute.
7 changes: 5 additions & 2 deletions users_ldap_mail/__manifest__.py
Original file line number Diff line number Diff line change
@@ -1,13 +1,16 @@
# Copyright Daniel Reis (https://launchpad.com/~dreis-pt)
# Copyright 2021 Tecnativa - João Marques
# License AGPL-3.0 or later (http://www.gnu.org/licenses/gpl.html).

{
"name": "LDAP mapping for user name and e-mail",
"version": "12.0.1.0.0",
"version": "13.0.1.0.0",
"depends": ["auth_ldap"],
"author": "Daniel Reis," "Odoo Community Association (OCA)",
"maintainers": ["joao-p-marques"],
"website": "https://github.com/OCA/server-auth",
"license": "AGPL-3",
"category": "Tools",
"data": ["views/res_company_ldap.xml",],
"data": ["views/res_company_ldap.xml"],
"installable": True,
}
1 change: 1 addition & 0 deletions users_ldap_mail/readme/CONTRIBUTORS.rst
Original file line number Diff line number Diff line change
Expand Up @@ -2,3 +2,4 @@
* `Tecnativa <https://www.tecnativa.com>`_:

* Alexandre Díaz
* João Marques
2 changes: 2 additions & 0 deletions users_ldap_mail/readme/ROADMAP.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@

* Add tests (use LDAP Mocking through something like https://mockldap.readthedocs.io/en/latest/overview.html)
14 changes: 8 additions & 6 deletions users_ldap_mail/readme/USAGE.rst
Original file line number Diff line number Diff line change
@@ -1,9 +1,11 @@
To use this module, you need to:

#. Open Odoo in your browser
#. Go to Settings
#. Go to General Settings
#. In The General Settings form go to LDAP Parameters
#. In a LDAP Parameters item there are two new fields: mail and name, the name
These items will correspond with a new user that is created, when a user
logs in via LDAP in Odoo.
#. Go to **Settings > General Settings**
#. In the **Integrations** section click on **LDAP Server** under
**LDAP Authentication**. This will allow you to create your LDAP integration
settings.
#. When creating or editing a record, under the **Process Parameter** section
there are two new fields: mail and name, the name of these items will
correspond with a new user that is created, when a user logs in via LDAP in
Odoo.
52 changes: 32 additions & 20 deletions users_ldap_mail/static/description/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<meta name="generator" content="Docutils 0.15.1: http://docutils.sourceforge.net/" />
<meta name="generator" content="Docutils: http://docutils.sourceforge.net/" />
<title>LDAP mapping for user name and e-mail</title>
<style type="text/css">

Expand Down Expand Up @@ -367,19 +367,20 @@ <h1 class="title">LDAP mapping for user name and e-mail</h1>
!! This file is generated by oca-gen-addon-readme !!
!! changes will be overwritten. !!
!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! -->
<p><a class="reference external" href="https://odoo-community.org/page/development-status"><img alt="Beta" src="https://img.shields.io/badge/maturity-Beta-yellow.png" /></a> <a class="reference external" href="http://www.gnu.org/licenses/agpl-3.0-standalone.html"><img alt="License: AGPL-3" src="https://img.shields.io/badge/licence-AGPL--3-blue.png" /></a> <a class="reference external" href="https://github.com/OCA/server-auth/tree/12.0/users_ldap_mail"><img alt="OCA/server-auth" src="https://img.shields.io/badge/github-OCA%2Fserver--auth-lightgray.png?logo=github" /></a> <a class="reference external" href="https://translation.odoo-community.org/projects/server-auth-12-0/server-auth-12-0-users_ldap_mail"><img alt="Translate me on Weblate" src="https://img.shields.io/badge/weblate-Translate%20me-F47D42.png" /></a> <a class="reference external" href="https://runbot.odoo-community.org/runbot/251/12.0"><img alt="Try me on Runbot" src="https://img.shields.io/badge/runbot-Try%20me-875A7B.png" /></a></p>
<p><a class="reference external" href="https://odoo-community.org/page/development-status"><img alt="Beta" src="https://img.shields.io/badge/maturity-Beta-yellow.png" /></a> <a class="reference external" href="http://www.gnu.org/licenses/agpl-3.0-standalone.html"><img alt="License: AGPL-3" src="https://img.shields.io/badge/licence-AGPL--3-blue.png" /></a> <a class="reference external" href="https://github.com/OCA/server-auth/tree/13.0/users_ldap_mail"><img alt="OCA/server-auth" src="https://img.shields.io/badge/github-OCA%2Fserver--auth-lightgray.png?logo=github" /></a> <a class="reference external" href="https://translation.odoo-community.org/projects/server-auth-13-0/server-auth-13-0-users_ldap_mail"><img alt="Translate me on Weblate" src="https://img.shields.io/badge/weblate-Translate%20me-F47D42.png" /></a> <a class="reference external" href="https://runbot.odoo-community.org/runbot/251/13.0"><img alt="Try me on Runbot" src="https://img.shields.io/badge/runbot-Try%20me-875A7B.png" /></a></p>
<p>This module extends the functionality of the auth_ldap module to support mail
from LDAP and to allow you to get an e-mail address from LDAP accounts to Odoo
users.</p>
<p><strong>Table of contents</strong></p>
<div class="contents local topic" id="contents">
<ul class="simple">
<li><a class="reference internal" href="#usage" id="id1">Usage</a></li>
<li><a class="reference internal" href="#bug-tracker" id="id2">Bug Tracker</a></li>
<li><a class="reference internal" href="#credits" id="id3">Credits</a><ul>
<li><a class="reference internal" href="#authors" id="id4">Authors</a></li>
<li><a class="reference internal" href="#contributors" id="id5">Contributors</a></li>
<li><a class="reference internal" href="#maintainers" id="id6">Maintainers</a></li>
<li><a class="reference internal" href="#known-issues-roadmap" id="id2">Known issues / Roadmap</a></li>
<li><a class="reference internal" href="#bug-tracker" id="id3">Bug Tracker</a></li>
<li><a class="reference internal" href="#credits" id="id4">Credits</a><ul>
<li><a class="reference internal" href="#authors" id="id5">Authors</a></li>
<li><a class="reference internal" href="#contributors" id="id6">Contributors</a></li>
<li><a class="reference internal" href="#maintainers" id="id7">Maintainers</a></li>
</ul>
</li>
</ul>
Expand All @@ -389,48 +390,59 @@ <h1><a class="toc-backref" href="#id1">Usage</a></h1>
<p>To use this module, you need to:</p>
<ol class="arabic simple">
<li>Open Odoo in your browser</li>
<li>Go to Settings</li>
<li>Go to General Settings</li>
<li>In The General Settings form go to LDAP Parameters</li>
<li>In a LDAP Parameters item there are two new fields: mail and name, the name
These items will correspond with a new user that is created, when a user
logs in via LDAP in Odoo.</li>
<li>Go to <strong>Settings &gt; General Settings</strong></li>
<li>In the <strong>Integrations</strong> section click on <strong>LDAP Server</strong> under
<strong>LDAP Authentication</strong>. This will allow you to create your LDAP integration
settings.</li>
<li>When creating or editing a record, under the <strong>Process Parameter</strong> section
there are two new fields: mail and name, the name of these items will
correspond with a new user that is created, when a user logs in via LDAP in
Odoo.</li>
</ol>
</div>
<div class="section" id="known-issues-roadmap">
<h1><a class="toc-backref" href="#id2">Known issues / Roadmap</a></h1>
<ul class="simple">
<li>Add tests (use LDAP Mocking through something like <a class="reference external" href="https://mockldap.readthedocs.io/en/latest/overview.html">https://mockldap.readthedocs.io/en/latest/overview.html</a>)</li>
</ul>
</div>
<div class="section" id="bug-tracker">
<h1><a class="toc-backref" href="#id2">Bug Tracker</a></h1>
<h1><a class="toc-backref" href="#id3">Bug Tracker</a></h1>
<p>Bugs are tracked on <a class="reference external" href="https://github.com/OCA/server-auth/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 smashing it by providing a detailed and welcomed
<a class="reference external" href="https://github.com/OCA/server-auth/issues/new?body=module:%20users_ldap_mail%0Aversion:%2012.0%0A%0A**Steps%20to%20reproduce**%0A-%20...%0A%0A**Current%20behavior**%0A%0A**Expected%20behavior**">feedback</a>.</p>
<a class="reference external" href="https://github.com/OCA/server-auth/issues/new?body=module:%20users_ldap_mail%0Aversion:%2013.0%0A%0A**Steps%20to%20reproduce**%0A-%20...%0A%0A**Current%20behavior**%0A%0A**Expected%20behavior**">feedback</a>.</p>
<p>Do not contact contributors directly about support or help with technical issues.</p>
</div>
<div class="section" id="credits">
<h1><a class="toc-backref" href="#id3">Credits</a></h1>
<h1><a class="toc-backref" href="#id4">Credits</a></h1>
<div class="section" id="authors">
<h2><a class="toc-backref" href="#id4">Authors</a></h2>
<h2><a class="toc-backref" href="#id5">Authors</a></h2>
<ul class="simple">
<li>Daniel Reis</li>
</ul>
</div>
<div class="section" id="contributors">
<h2><a class="toc-backref" href="#id5">Contributors</a></h2>
<h2><a class="toc-backref" href="#id6">Contributors</a></h2>
<ul class="simple">
<li>Daniel Reis (<a class="reference external" href="https://launchpad.com/~dreis-pt">https://launchpad.com/~dreis-pt</a>),</li>
<li><a class="reference external" href="https://www.tecnativa.com">Tecnativa</a>:<ul>
<li>Alexandre Díaz</li>
<li>João Marques</li>
</ul>
</li>
</ul>
</div>
<div class="section" id="maintainers">
<h2><a class="toc-backref" href="#id6">Maintainers</a></h2>
<h2><a class="toc-backref" href="#id7">Maintainers</a></h2>
<p>This module is maintained by the OCA.</p>
<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>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>This module is part of the <a class="reference external" href="https://github.com/OCA/server-auth/tree/12.0/users_ldap_mail">OCA/server-auth</a> project on GitHub.</p>
<p>Current <a class="reference external" href="https://odoo-community.org/page/maintainer-role">maintainer</a>:</p>
<p><a class="reference external" href="https://github.com/joao-p-marques"><img alt="joao-p-marques" src="https://github.com/joao-p-marques.png?size=40px" /></a></p>
<p>This module is part of the <a class="reference external" href="https://github.com/OCA/server-auth/tree/13.0/users_ldap_mail">OCA/server-auth</a> project on GitHub.</p>
<p>You are welcome to contribute. To learn how please visit <a class="reference external" href="https://odoo-community.org/page/Contribute">https://odoo-community.org/page/Contribute</a>.</p>
</div>
</div>
Expand Down