Skip to content

Commit c91e88a

Browse files
committed
[IMP] auth_saml_environment: pre-commit execution
1 parent 35f9e7c commit c91e88a

15 files changed

Lines changed: 70 additions & 72 deletions

File tree

auth_saml_environment/README.rst

Lines changed: 23 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -17,13 +17,13 @@ Auth SAML environement
1717
:target: http://www.gnu.org/licenses/agpl-3.0-standalone.html
1818
:alt: License: AGPL-3
1919
.. |badge3| image:: https://img.shields.io/badge/github-OCA%2Fserver--env-lightgray.png?logo=github
20-
:target: https://github.com/OCA/server-env/tree/14.0/auth_saml_environment
20+
:target: https://github.com/OCA/server-env/tree/18.0/auth_saml_environment
2121
:alt: OCA/server-env
2222
.. |badge4| image:: https://img.shields.io/badge/weblate-Translate%20me-F47D42.png
23-
:target: https://translation.odoo-community.org/projects/server-env-14-0/server-env-14-0-auth_saml_environment
23+
:target: https://translation.odoo-community.org/projects/server-env-18-0/server-env-18-0-auth_saml_environment
2424
:alt: Translate me on Weblate
2525
.. |badge5| image:: https://img.shields.io/badge/runboat-Try%20me-875A7B.png
26-
:target: https://runboat.odoo-community.org/builds?repo=OCA/server-env&target_branch=14.0
26+
:target: https://runboat.odoo-community.org/builds?repo=OCA/server-env&target_branch=18.0
2727
:alt: Try me on Runboat
2828

2929
|badge1| |badge2| |badge3| |badge4| |badge5|
@@ -38,45 +38,44 @@ This module allows to use server env for SAML configuration
3838
Installation
3939
============
4040

41-
To install this module, you need to have the following modules installed and
42-
properly configured: `server_environment module` `auth_saml`
41+
To install this module, you need to have the following modules installed
42+
and properly configured: server_environment module auth_saml
4343

4444
Configuration
4545
=============
4646

4747
To configure this module, you need to:
4848

49-
Create a module server_environment_file with a cfg file or set the environment variable
50-
SERVER_ENV_CONFIG with the following section:
49+
Create a module server_environment_file with a cfg file or set the
50+
environment variable SERVER_ENV_CONFIG with the following section:
5151

5252
[auth_saml_provider.<name>]
5353

54-
Where <name> is optional and must be equal to the name field you defined in Odoo for the IDP.
55-
54+
Where <name> is optional and must be equal to the name field you defined
55+
in Odoo for the IDP.
5656

5757
Example of configuration
5858

5959
[auth_saml_provider.my_idp]
6060

61-
idp_metadata=<...>
62-
sp_baseurl=https://odoo-community.org
63-
sp_pem_public_path=/data/cert.pem
64-
sp_pem_private_path=/data/key.pem
61+
idp_metadata=<...> sp_baseurl=\ https://odoo-community.org
62+
sp_pem_public_path=/data/cert.pem sp_pem_private_path=/data/key.pem
6563

6664
Usage
6765
=====
6866

6967
Once configured, Odoo will read the Auth SAML Providers values from the
7068
configuration.
7169

72-
Note that visibility of login button for SAML is changed and differs from `auth_saml` module,
73-
instead of relying on which fields are filled or not, all providers will be displayed as long
74-
as their configuration in Odoo are set to active.
70+
Note that visibility of login button for SAML is changed and differs
71+
from auth_saml module, instead of relying on which fields are filled or
72+
not, all providers will be displayed as long as their configuration in
73+
Odoo are set to active.
7574

7675
Known issues / Roadmap
7776
======================
7877

79-
* Due to the special nature of this addon, you cannot test it on the OCA
78+
- Due to the special nature of this addon, you cannot test it on the OCA
8079
runbot.
8180

8281
Bug Tracker
@@ -85,26 +84,26 @@ Bug Tracker
8584
Bugs are tracked on `GitHub Issues <https://github.com/OCA/server-env/issues>`_.
8685
In case of trouble, please check there if your issue has already been reported.
8786
If you spotted it first, help us to smash it by providing a detailed and welcomed
88-
`feedback <https://github.com/OCA/server-env/issues/new?body=module:%20auth_saml_environment%0Aversion:%2014.0%0A%0A**Steps%20to%20reproduce**%0A-%20...%0A%0A**Current%20behavior**%0A%0A**Expected%20behavior**>`_.
87+
`feedback <https://github.com/OCA/server-env/issues/new?body=module:%20auth_saml_environment%0Aversion:%2018.0%0A%0A**Steps%20to%20reproduce**%0A-%20...%0A%0A**Current%20behavior**%0A%0A**Expected%20behavior**>`_.
8988

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

9291
Credits
9392
=======
9493

9594
Authors
96-
~~~~~~~
95+
-------
9796

9897
* Camptocamp
9998

10099
Contributors
101-
~~~~~~~~~~~~
100+
------------
102101

103-
* Denis Leemann <denis.leemann@camptocamp.com>
104-
* Yannick Vaucher <yannick.vaucher@camptocamp.com>
102+
- Denis Leemann <denis.leemann@camptocamp.com>
103+
- Yannick Vaucher <yannick.vaucher@camptocamp.com>
105104

106105
Maintainers
107-
~~~~~~~~~~~
106+
-----------
108107

109108
This module is maintained by the OCA.
110109

@@ -116,6 +115,6 @@ OCA, or the Odoo Community Association, is a nonprofit organization whose
116115
mission is to support the collaborative development of Odoo features and
117116
promote its widespread use.
118117

119-
This module is part of the `OCA/server-env <https://github.com/OCA/server-env/tree/14.0/auth_saml_environment>`_ project on GitHub.
118+
This module is part of the `OCA/server-env <https://github.com/OCA/server-env/tree/18.0/auth_saml_environment>`_ project on GitHub.
120119

121120
You are welcome to contribute. To learn how please visit https://odoo-community.org/page/Contribute.
Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
[build-system]
2+
requires = ["whool"]
3+
build-backend = "whool.buildapi"
Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
To configure this module, you need to:
2+
3+
Create a module server_environment_file with a cfg file or set the
4+
environment variable SERVER_ENV_CONFIG with the following section:
5+
6+
\[auth_saml_provider.\<name\>\]
7+
8+
Where \<name\> is optional and must be equal to the name field you
9+
defined in Odoo for the IDP.
10+
11+
Example of configuration
12+
13+
\[auth_saml_provider.my_idp\]
14+
15+
idp_metadata=\<...\> sp_baseurl=https://odoo-community.org
16+
sp_pem_public_path=/data/cert.pem sp_pem_private_path=/data/key.pem

auth_saml_environment/readme/CONFIGURE.rst

Lines changed: 0 additions & 18 deletions
This file was deleted.
Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
- Denis Leemann \<denis.leemann@camptocamp.com\>
2+
- Yannick Vaucher \<yannick.vaucher@camptocamp.com\>

auth_saml_environment/readme/CONTRIBUTORS.rst

Lines changed: 0 additions & 2 deletions
This file was deleted.
File renamed without changes.
Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
To install this module, you need to have the following modules installed
2+
and properly configured: server_environment module auth_saml

auth_saml_environment/readme/INSTALL.rst

Lines changed: 0 additions & 2 deletions
This file was deleted.
Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
- Due to the special nature of this addon, you cannot test it on the OCA
2+
runbot.

0 commit comments

Comments
 (0)