[skip ci] add OAuth module doc

phpMv · Jun 8, 2020 · 2dcb4ba · 2dcb4ba
1 parent 8d2550b
commit 2dcb4ba
Show file tree

Hide file tree

Showing 9 changed files with 73 additions and 0 deletions.
diff --git a/docs/_static/images/oauth/create-oauth-controller-created.png b/docs/_static/images/oauth/create-oauth-controller-created.png
diff --git a/docs/_static/images/oauth/create-oauth-controller.png b/docs/_static/images/oauth/create-oauth-controller.png
diff --git a/docs/_static/images/oauth/google-check-infos.png b/docs/_static/images/oauth/google-check-infos.png
diff --git a/docs/_static/images/oauth/google-check.png b/docs/_static/images/oauth/google-check.png
diff --git a/docs/_static/images/oauth/oauth-part-0.png b/docs/_static/images/oauth/oauth-part-0.png
diff --git a/docs/_static/images/oauth/oauth-part-callback.png b/docs/_static/images/oauth/oauth-part-callback.png
diff --git a/docs/_static/images/oauth/provider-config.png b/docs/_static/images/oauth/provider-config.png
diff --git a/docs/extra/oauth.rst b/docs/extra/oauth.rst
@@ -0,0 +1,71 @@
+.. _oauth:
+OAuth2 client module
+====================
+.. |br| raw:: html
+
+   <br />
+
+.. note:: This part is accessible from the **webtools**, so if you created your project with the **-a** option or with the **create-project** command.
+          The OAuth module is not installed by default. It uses HybridAuth library.
+
+
+Installation
+------------
+
+In the root of your project:
+
+.. code-block:: bash
+   
+	composer require phpmv/ubiquity-oauth
+
+.. note:: It is also possible to add the **ubiquity-oauth** dependency using the Compose part of the administration module.
+
+.. image:: /_static/images/composer/composer-add-1.png
+   :class: bordered
+
+OAuth configuration
+-------------------
+
+Global configuration
+++++++++++++++++++++
+
+.. image:: /_static/images/oauth/oauth-part-0.png
+   :class: bordered
+
+Click on the **Global configuration** button, and modify the callback URL, which corresponds to the local callback url after a successful connection.
+
+.. image:: /_static/images/oauth/oauth-part-callback.png
+   :class: bordered
+
+OAuth controller
+++++++++++++++++
+
+Click on the **Create Oauth controller** button and assign to the route the value previously given to the callback:
+
+.. image:: /_static/images/oauth/create-oauth-controller.png
+   :class: bordered
+
+Validate and reset the router cache:
+
+.. image:: /_static/images/oauth/create-oauth-controller-create.png
+   :class: bordered
+
+Providers
++++++++++
+
+.. note:: For an OAuth authentication, it is necessary to create an application at the provider beforehand, and to take note of the keys of the application (id and secret).
+
+Click on the **Add provider** button and select **Google**:
+
+.. image:: /_static/images/oauth/provider-config.png
+   :class: bordered
+
+Check the connection by clicking on the **Check** button:
+
+.. image:: /_static/images/oauth/google-check.png
+   :class: bordered
+
+Post Login Information:
+
+.. image:: /_static/images/oauth/google-check-infos.png
+   :class: bordered
diff --git a/docs/index.rst b/docs/index.rst
@@ -15,6 +15,7 @@ Ubiquity User guide
 
 .. sidebar:: New in documentation
 
+   - :ref:`OAuth client module<oauth>`
    - :ref:`Mailer module<mailer>`
    - :ref:`Servers configuration<servers>`
    - :ref:`Database connexions<db>`
@@ -127,6 +128,7 @@ Ubiquity User guide
    extra/libraries
    extra/caching
    extra/dependencies
+   extra/oauth
 
 Indices and tables
 ==================