Leuchtfeuer/auth0-for-typo3

View on GitHub
Documentation/Editor/Plugin/Index.rst

Summary

Maintainability
Test Coverage
.. include:: ../../Includes.txt

.. _editor-plugin:

======
Plugin
======

This extensions comes with a login / logoff plugin for frontend users. It is located underneath the forms tab when creating a
new content element.

.. image:: ../../Images/new-plugin.png
   :alt: Create a New Plugin
   :class: with-shadow

.. _editor-plugin-configuration:

Configuration
=============

In general there is only one configuration you have to care about: the Auth0 application you want to communicate with. Besides of
that, you can configure whether the user should be logged off from your TYPO3 instance only (soft log out), or if be logged off
from Auth0, too (single log out). Furthermore you can configure some additional URL query parameters for the authentication
(e.g: :code:`mode=signUp` or :code:`access_type=offline&connection=google-oauth2`. This setting will overwrite your TypoScript
setting :typoscript:`plugin.tx_auth0.settings.frontend.login.additionalAuthorizeParameters`.

.. figure:: ../../Images/plugin-configuration-general.png
   :alt: General Plugin Configuration
   :class: with-shadow

   The general configuration can be done in the "General" tab of the plugin configuration.

.. _editor-plugin-redirects:

Redirects
=========

You can configure where the user should be redirected to. The configuration of that is similar to the
standard TYPO3 frontend login form plugin. Please take a look into the official
`TYPO3 documentation <https://docs.typo3.org/typo3cms/extensions/felogin/LoginMechanism/RedirectModes/Index.html>`__ for further
details.