From 6dfc67956fe2a6597668a2c19d803fdfb1706efa Mon Sep 17 00:00:00 2001 From: Andreas Perhab Date: Thu, 3 Nov 2022 10:09:23 +0100 Subject: [PATCH] [IMP] auth_oidc: update documentation for 17.0.1.0.0 --- auth_oidc/README.rst | 49 ++++++++++--- auth_oidc/readme/CONTRIBUTORS.md | 1 + auth_oidc/readme/HISTORY.md | 24 +++++++ auth_oidc/static/description/index.html | 93 ++++++++++++++++++------- 4 files changed, 133 insertions(+), 34 deletions(-) diff --git a/auth_oidc/README.rst b/auth_oidc/README.rst index 5d551ee657..0106a937bd 100644 --- a/auth_oidc/README.rst +++ b/auth_oidc/README.rst @@ -7,7 +7,7 @@ Authentication OpenID Connect !! This file is generated by oca-gen-addon-readme !! !! changes will be overwritten. !! !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! - !! source digest: sha256:a54c4126f9873d2af17b9228f9afa844806a2541b42dc7945ec41be08379a915 + !! source digest: sha256:376f14d31d98045b37afd5cfd3b74af9327544e62dba698ce26a53f58ffb75a4 !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! .. |badge1| image:: https://img.shields.io/badge/maturity-Beta-yellow.png @@ -17,13 +17,13 @@ Authentication OpenID Connect :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/16.0/auth_oidc + :target: https://github.com/OCA/server-auth/tree/17.0/auth_oidc :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-16-0/server-auth-16-0-auth_oidc + :target: https://translation.odoo-community.org/projects/server-auth-17-0/server-auth-17-0-auth_oidc :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=16.0 + :target: https://runboat.odoo-community.org/builds?repo=OCA/server-auth&target_branch=17.0 :alt: Try me on Runboat |badge1| |badge2| |badge3| |badge4| |badge5| @@ -123,9 +123,9 @@ In Odoo, create a new Oauth Provider with the following parameters: - JWKS URL: The "jwks_uri" URL found in the OpenID Endpoint Configuration of your Keycloak realm -.. |image| image:: https://raw.githubusercontent.com/OCA/server-auth/16.0/auth_oidc/static/description/oauth-microsoft_azure-api_permissions.png -.. |image1| image:: https://raw.githubusercontent.com/OCA/server-auth/16.0/auth_oidc/static/description/oauth-microsoft_azure-optional_claims.png -.. |image2| image:: https://raw.githubusercontent.com/OCA/server-auth/16.0/auth_oidc/static/description/odoo-azure_ad_multitenant.png +.. |image| image:: https://raw.githubusercontent.com/OCA/server-auth/17.0/auth_oidc/static/description/oauth-microsoft_azure-api_permissions.png +.. |image1| image:: https://raw.githubusercontent.com/OCA/server-auth/17.0/auth_oidc/static/description/oauth-microsoft_azure-optional_claims.png +.. |image2| image:: https://raw.githubusercontent.com/OCA/server-auth/17.0/auth_oidc/static/description/odoo-azure_ad_multitenant.png Usage ===== @@ -143,6 +143,36 @@ Known issues / Roadmap Changelog ========= +17.0.1.0.0 2024-02-28 +--------------------- + +- Odoo 17 migration + +16.0.1.1.0 2024-02-28 +--------------------- + +- Forward port OpenID Connect fixes from 15.0 to 16.0 + +16.0.1.0.2 2023-11-16 +--------------------- + +- Readme link updates + +16.0.1.0.1 2023-10-09 +--------------------- + +- Add AzureAD code flow provider + +16.0.1.0.0 2023-01-27 +--------------------- + +- Odoo 16 migration + +15.0.1.0.0 2023-01-06 +--------------------- + +- Odoo 15 migration + 14.0.1.0.0 2021-12-10 --------------------- @@ -164,7 +194,7 @@ Bug Tracker Bugs are tracked on `GitHub 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 `_. +`feedback `_. Do not contact contributors directly about support or help with technical issues. @@ -184,6 +214,7 @@ Contributors - Alexandre Fayolle - Stéphane Bidoul - David Jaen +- Andreas Perhab Maintainers ----------- @@ -206,6 +237,6 @@ Current `maintainer `__: |maintainer-sbidoul| -This module is part of the `OCA/server-auth `_ project on GitHub. +This module is part of the `OCA/server-auth `_ project on GitHub. You are welcome to contribute. To learn how please visit https://odoo-community.org/page/Contribute. diff --git a/auth_oidc/readme/CONTRIBUTORS.md b/auth_oidc/readme/CONTRIBUTORS.md index 5663785334..8bdbc1daa2 100644 --- a/auth_oidc/readme/CONTRIBUTORS.md +++ b/auth_oidc/readme/CONTRIBUTORS.md @@ -1,3 +1,4 @@ - Alexandre Fayolle \<\> - Stéphane Bidoul \<\> - David Jaen \<\> +- Andreas Perhab \<\> diff --git a/auth_oidc/readme/HISTORY.md b/auth_oidc/readme/HISTORY.md index 98e99203b8..b8e1356a8c 100644 --- a/auth_oidc/readme/HISTORY.md +++ b/auth_oidc/readme/HISTORY.md @@ -1,3 +1,27 @@ +## 17.0.1.0.0 2024-02-28 + +- Odoo 17 migration + +## 16.0.1.1.0 2024-02-28 + +- Forward port OpenID Connect fixes from 15.0 to 16.0 + +## 16.0.1.0.2 2023-11-16 + +- Readme link updates + +## 16.0.1.0.1 2023-10-09 + +- Add AzureAD code flow provider + +## 16.0.1.0.0 2023-01-27 + +- Odoo 16 migration + +## 15.0.1.0.0 2023-01-06 + +- Odoo 15 migration + ## 14.0.1.0.0 2021-12-10 - Odoo 14 migration diff --git a/auth_oidc/static/description/index.html b/auth_oidc/static/description/index.html index 12b4d34099..d4a7347a6e 100644 --- a/auth_oidc/static/description/index.html +++ b/auth_oidc/static/description/index.html @@ -366,9 +366,9 @@

Authentication OpenID Connect

!! This file is generated by oca-gen-addon-readme !! !! changes will be overwritten. !! !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! -!! source digest: sha256:a54c4126f9873d2af17b9228f9afa844806a2541b42dc7945ec41be08379a915 +!! source digest: sha256:376f14d31d98045b37afd5cfd3b74af9327544e62dba698ce26a53f58ffb75a4 !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! --> -

Beta License: AGPL-3 OCA/server-auth Translate me on Weblate Try me on Runboat

+

Beta License: AGPL-3 OCA/server-auth Translate me on Weblate Try me on Runboat

This module allows users to login through an OpenID Connect provider using the authorization code flow or implicit flow.

Note the implicit flow is not recommended because it exposes access @@ -385,16 +385,22 @@

Authentication OpenID Connect

  • Usage
  • Known issues / Roadmap
  • Changelog
    • -
  • Bug Tracker
    • -
  • Credits @@ -422,8 +428,8 @@

    Setup for Microsoft Azure

    for more information):
    • -

    image

    -

    image1

    +

    image

    +

    image1

    Single tenant provider limits the access to user of your tenant, while Multitenants allow access for all AzureAD users, so user of foreign companies can use their AzureAD login without an guest account.

    @@ -441,7 +447,7 @@

    Setup for Microsoft Azure

    Allowed: yes
  • replace {tenant_id} in urls with your Azure tenant id
    • -

    image2

    +

    image2

    Setup for Keycloak

    @@ -492,36 +498,72 @@

    Known issues / Roadmap

    Changelog

    -

    14.0.1.0.0 2021-12-10

    +

    17.0.1.0.0 2024-02-28

      -
    • Odoo 14 migration
      • +
    • Odoo 17 migration
    -

    13.0.1.0.0 2020-04-10

    +

    16.0.1.1.0 2024-02-28

      -
    • Odoo 13 migration, add authorization code flow.
      • +
    • Forward port OpenID Connect fixes from 15.0 to 16.0
    -

    10.0.1.0.0 2018-10-05

    +

    16.0.1.0.2 2023-11-16

    +
      +
    • Readme link updates
      • +
    +
    +
    +

    16.0.1.0.1 2023-10-09

    +
      +
    • Add AzureAD code flow provider
      • +
    +
    +
    +

    16.0.1.0.0 2023-01-27

    +
      +
    • Odoo 16 migration
      • +
    +
    +
    +

    15.0.1.0.0 2023-01-06

    +
      +
    • Odoo 15 migration
      • +
    +
    +
    +

    14.0.1.0.0 2021-12-10

    +
      +
    • Odoo 14 migration
      • +
    +
    +
    +

    13.0.1.0.0 2020-04-10

    +
      +
    • Odoo 13 migration, add authorization code flow.
      • +
    +
    +
    +

    10.0.1.0.0 2018-10-05

    • Initial implementation
    -

    Bug Tracker

    +

    Bug Tracker

    Bugs are tracked on GitHub 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.

    +feedback.

    Do not contact contributors directly about support or help with technical issues.

    -

    Credits

    +

    Credits

    -

    Authors

    +

    Authors

    • ICTSTUDIO
    • André Schenkels
      • @@ -529,15 +571,16 @@

      Authors

    -

    Maintainers

    +

    Maintainers

    This module is maintained by the OCA.

    Odoo Community Association

    OCA, or the Odoo Community Association, is a nonprofit organization whose @@ -545,7 +588,7 @@

    Maintainers

    promote its widespread use.

    Current maintainer:

    sbidoul

    -

    This module is part of the OCA/server-auth project on GitHub.

    +

    This module is part of the OCA/server-auth project on GitHub.

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