TYPO3 v15 dev-main snapshot ()

Documentation/LoginMechanism/Display/Index.rst

@@ -0,0 +1,19 @@
+.. include:: /Includes.rst.txt
+
+.. _display:
+
+==================
+What is displayed?
+==================
+
+If there is no frontend user logged in, the login form will be
+shown.
+
+If there is a logged in frontend user, the logout form is shown.
+
+If the forgot password link was used, the form to reset a password
+based on username or email address will be shown.
+
+If the password reset link was followed from an email, the form to
+change the password will be shown.
+

Documentation/LoginMechanism/Index.rst

@@ -0,0 +1,22 @@
+.. include:: /Includes.rst.txt
+
+.. _login-mechanism:
+
+===============
+Login mechanism
+===============
+
+In order to properly use the felogin plugin and its advanced
+capabilities (such as redirect options) it is important to understand
+the mechanism of frontend user login in TYPO3 CMS.
+
+
+.. toctree::
+   :maxdepth: 5
+   :titlesonly:
+   :glob:
+
+   Display/Index
+   LoginProcess/Index
+   RedirectModes/Index
+

Documentation/LoginMechanism/LoginProcess/Index.rst

@@ -0,0 +1,22 @@
+.. include:: /Includes.rst.txt
+
+.. _login-process:
+
+=================
+The login process
+=================
+
+After the form is submitted the TYPO3 CMS authentication services will
+validate the login credentials. After this process felogin will handle
+the rest. This means that the felogin plugin must be visible for the
+user who has logged in.
+
+Felogin will then check any redirect options and generate the
+appropriate content.
+
+.. caution::
+
+   - Do not use the login status of a frontend user as authorization,
+     but **always** rely on user groups.
+   - Only use different storage folders for frontend users if this is really
+     necessary due to organizational reasons.

Documentation/LoginMechanism/RedirectModes/Index.rst

@@ -0,0 +1,103 @@
+.. include:: /Includes.rst.txt
+
+.. _redirect-modes:
+
+==============
+Redirect Modes
+==============
+
+The following redirect options are supported.
+
+
+.. _defined-by-usergroup-record:
+
+Defined by Usergroup Record
+===========================
+
+Within a Website usergroup record, you can specify a page where
+usergroup members will be redirected after login.
+
+
+.. _defined-by-user-record:
+
+Defined by User Record
+======================
+
+This is identical to the redirection option for "defined by Usergroup
+Record" but applies to a single website user instead of an entire user
+group.
+
+
+.. _after-login-ts-or-flexform:
+
+After Login (TS or Flexform)
+============================
+
+This redirect page is set either in TypoScript
+(:typoscript:`plugin.tx_felogin_login.settings.redirectPageLogin`) or in the
+FlexForm of the felogin plugin.
+
+
+.. _after-logout-ts-or-flexform:
+
+After Logout (TS or Flexform)
+=============================
+
+Defines the redirect page after a user has logged out. Again, it can
+be set in TypoScript or in the felogin plugin's FlexForm.
+
+
+.. _after-login-error-ts-of-flexform:
+
+After Login Error (TS of Flexform)
+==================================
+
+Defines the redirect page after a login error occurs. Can be set in
+TypoScript or in the felogin plugin's FlexForm.
+
+
+.. _defined-by-get-post-vars:
+
+Defined by GET/POST Parameters
+==============================
+
+Redirect the visitor based on the GET/POST parameters :code:`redirect_url`.
+If the TypoScript configuration
+:typoscript:`config.typolinkLinkAccessRestrictedPages` is set, the GET/POST
+parameter :code:`redirect_url` is used.
+
+Example URL:
+
+.. code-block:: text
+
+   https://example.org/index.php?id=12&redirect_url=https%3A%2F%2Fexample%2Eorg%2Fdestiny%2F
+
+
+.. _defined-by-referrer:
+
+Defined by Referrer
+===================
+
+The referrer page is used for the redirect. This basically means that
+the user is sent back to the page he originally came from.
+
+
+.. _defined-by-domain-entries:
+
+Defined by Domain entries
+=========================
+
+Same as :guilabel:`Defined by Referrer`, except that only the domains listed in
+:typoscript:`plugin.tx_felogin_login.domains` are allowed. If someone is sent to the
+login page coming from a domain which is not listed, the redirect will
+not happen.
+
+By using the option :guilabel:`Use First Supported Mode from Selection` you can
+define several fallback methods.
+
+
+.. note::
+
+   It is only possible to use domains, which are known to TYPO3. This means,
+   that domains must be configured as :code:`base` in site settings for websites
+   in the current TYPO3 instance.