-.. ==================================================
-.. FOR YOUR INFORMATION
-.. --------------------------------------------------
-.. -*- coding: utf-8 -*- with BOM.
-
-.. include:: ../Includes.txt
+.. include:: ../Includes.txt
.. _configuration:
+=============
Configuration
--------------
+=============
All configuration options are available in the FlexForm or TypoScript,
with the FlexForm settings taking precedence.
.. _plugin-tx-felogin-pi1:
plugin.tx\_felogin\_pi1
-^^^^^^^^^^^^^^^^^^^^^^^
+=======================
.. _storagepid:
storagePid
-""""""""""
+----------
.. container:: table-row
Data type
string
+ Default
+ {$styles.content.loginform.pid}
+
Description
Define the Storage Folder with the Website User Records, using a comma
separated list or single value
- Default
- {$styles.content.loginform.pid}
-
.. _recursive:
recursive
-"""""""""
+---------
.. container:: table-row
.. _templatefile:
templateFile
-""""""""""""
+------------
.. container:: table-row
Data type
string
+ Default
+ EXT:felogin/Resources/Private/Templates/FrontendLogin.html
+
Description
The Template File
template in TypoScript constants:
:code:`styles.content.loginform.templateFile = EXT:felogin/template.html`
- Default
- EXT:felogin/Resources/Private/Templates/FrontendLogin.html
-
.. _feloginbaseurl:
feloginBaseURL
-""""""""""""""
+--------------
.. container:: table-row
.. _wrapcontentinbaseclass:
wrapContentInBaseClass
-""""""""""""""""""""""
+----------------------
.. container:: table-row
Data type
bool
- Description
- If set, plugin is wrapped by Standard Base Class-Wrap
-
Default
true
+ Description
+ If set, plugin is wrapped by Standard Base Class-Wrap
+
.. _linkconfig:
linkConfig
-""""""""""
+----------
.. container:: table-row
.. _preservegetvars:
preserveGETvars
-"""""""""""""""
+---------------
.. container:: table-row
.. _showforgotpasswordlink:
showForgotPasswordLink
-""""""""""""""""""""""
+----------------------
.. container:: table-row
.. _showpermalogin:
showPermaLogin
-""""""""""""""
+--------------
.. container:: table-row
.. _forgetlinkhashvalidtime:
forgetLinkHashValidTime
-"""""""""""""""""""""""
+-----------------------
.. container:: table-row
Data type
integer
- Description
- How many hours the link for forget password is valid
-
Default
12
+ Description
+ How many hours the link for forget password is valid
+
.. _newpasswordminlength:
newPasswordMinLength
-""""""""""""""""""""
+--------------------
.. container:: table-row
Data type
integer
- Description
- Minimum length of the new password a user sets
-
Default
6
+ Description
+ Minimum length of the new password a user sets
+
.. _showlogoutformafterlogin:
showLogoutFormAfterLogin
-""""""""""""""""""""""""
+------------------------
.. container:: table-row
.. _welcomeheader-stdwrap:
welcomeHeader\_stdWrap
-""""""""""""""""""""""
+----------------------
.. container:: table-row
Data type
array
- Description
- stdWrap for Welcome Header
-
Default
wrap = <h3>\|</h3>
+ Description
+ stdWrap for Welcome Header
+
.. _welcomemessage-stdwrap:
welcomeMessage\_stdWrap
-"""""""""""""""""""""""
+-----------------------
.. container:: table-row
Data type
array
- Description
- stdWrap for Welcome Message
-
Default
wrap = <div>\|</div>
+ Description
+ stdWrap for Welcome Message
+
.. _successheader-stdwrap:
successHeader\_stdWrap
-""""""""""""""""""""""
+----------------------
.. container:: table-row
Data type
array
- Description
- stdWrap for Login SuccessHeader
-
Default
wrap = <h3>\|</h3>
+ Description
+ stdWrap for Login SuccessHeader
+
.. _successmessage-stdwrap:
successMessage\_stdWrap
-"""""""""""""""""""""""
+-----------------------
.. container:: table-row
Data type
array
- Description
- stdWrap for Login Success Message
-
Default
wrap = <div>\|</div>
+ Description
+ stdWrap for Login Success Message
+
.. _logoutheader-stdwrap:
logoutHeader\_stdWrap
-"""""""""""""""""""""
+---------------------
.. container:: table-row
Data type
array
- Description
- stdWrap for Logout Header
-
Default
wrap = <h3>\|</h3>
+ Description
+ stdWrap for Logout Header
+
.. _logoutmessage-stdwrap:
logoutMessage\_stdWrap
-""""""""""""""""""""""
+----------------------
.. container:: table-row
Data type
array
- Description
- stdWrap for Logout Message
-
Default
wrap = <div>\|</div>
+ Description
+ stdWrap for Logout Message
+
.. _errorheader-stdwrap:
errorHeader\_stdWrap
-""""""""""""""""""""
+--------------------
.. container:: table-row
Data type
array
- Description
- stdWrap for Error Header
-
Default
wrap = <h3>\|</h3>
+ Description
+ stdWrap for Error Header
+
.. _errormessage-stdwrap:
errorMessage\_stdWrap
-"""""""""""""""""""""
+---------------------
.. container:: table-row
Data type
array
- Description
- stdWrap for Error Message
-
Default
wrap = <div>\|</div>
+ Description
+ stdWrap for Error Message
+
.. _forgotheader-stdwrap:
forgotHeader\_stdWrap
-"""""""""""""""""""""
+---------------------
.. container:: table-row
Data type
array
- Description
- stdWrap for Forgot Header
-
Default
wrap = <h3>\|</h3>
+ Description
+ stdWrap for Forgot Header
+
.. _forgotmessage-stdwrap:
forgotMessage\_stdWrap
-""""""""""""""""""""""
+----------------------
.. container:: table-row
Data type
array
- Description
- stdWrap for Forgot Message
-
Default
wrap = <div>\|</div>
+ Description
+ stdWrap for Forgot Message
+
.. _forgoterrormessage-stdwrap:
forgotErrorMessage\_stdWrap
-"""""""""""""""""""""""""""
+---------------------------
.. container:: table-row
Data type
array
- Description
- stdWrap for error message in forgot password form
-
Default
wrap = <div>\|</div>
+ Description
+ stdWrap for error message in forgot password form
+
.. _forgotresetmessageemailsentmessage-stdwrap:
forgotResetMessageEmailSentMessage\_stdWrap
-"""""""""""""""""""""""""""""""""""""""""""
+-------------------------------------------
.. container:: table-row
Data type
array
- Description
- stdWrap for message that password reset mail was sent
-
Default
wrap = <div>\|</div>
+ Description
+ stdWrap for message that password reset mail was sent
+
.. _changepasswordnotvalidmessage-stdwrap:
changePasswordNotValidMessage\_stdWrap
-""""""""""""""""""""""""""""""""""""""
+--------------------------------------
.. container:: table-row
Data type
array
- Description
- stdWrap for message that changed password was not valid
-
Default
wrap = <div>\|</div>
+ Description
+ stdWrap for message that changed password was not valid
+
.. _changepasswordtooshortmessage-stdwrap:
changePasswordTooShortMessage\_stdWrap
-""""""""""""""""""""""""""""""""""""""
+--------------------------------------
.. container:: table-row
Data type
array
- Description
- stdWrap for message that new password was too short
-
Default
wrap = <div>\|</div>
+ Description
+ stdWrap for message that new password was too short
+
.. _changepasswordnotequalmessage-stdwrap:
changePasswordNotEqualMessage\_stdWrap
-""""""""""""""""""""""""""""""""""""""
+--------------------------------------
.. container:: table-row
Data type
- Description
- stdWrap for message that new passwords were not equal
-
Default
wrap = <div>\|</div>
+ Description
+ stdWrap for message that new passwords were not equal
+
.. _changepasswordheader-stdwrap:
changePasswordHeader\_stdWrap
-"""""""""""""""""""""""""""""
+-----------------------------
.. container:: table-row
Data type
array
- Description
- stdWrap for Change Password Header
-
Default
wrap = <h3>\|</h3>
+ Description
+ stdWrap for Change Password Header
+
.. _changepasswordmessage-stdwrap:
changePasswordMessage\_stdWrap
-""""""""""""""""""""""""""""""
+------------------------------
.. container:: table-row
Data type
array
- Description
- stdWrap for Change Password Message
-
Default
wrap = <div>\|</div>
+ Description
+ stdWrap for Change Password Message
+
.. _changepassworddonemessage-stdwrap:
changePasswordDoneMessage\_stdWrap
-""""""""""""""""""""""""""""""""""
+----------------------------------
.. container:: table-row
Data type
array
- Description
- stdWrap for message that password was changed
-
Default
wrap = <div>\|</div>
+ Description
+ stdWrap for message that password was changed
+
.. _userfields:
userfields
-""""""""""
+----------
.. container:: table-row
stdWrap configuration. These fields can be used as markers in the
template (e.g. ###FEUSER\_USERNAME###)
- Default
- ::
+ Example:
+
+ .. code-block:: typoscript
username {
htmlSpecialChars = 1
.. _redirectmode:
redirectMode
-""""""""""""
+------------
.. container:: table-row
.. _redirectfirstmethod:
redirectFirstMethod
-"""""""""""""""""""
+-------------------
.. container:: table-row
.. _redirectpagelogin:
redirectPageLogin
-"""""""""""""""""
+-----------------
.. container:: table-row
.. _redirectpageloginerror:
redirectPageLoginError
-""""""""""""""""""""""
+----------------------
.. container:: table-row
.. _redirectpagelogout:
redirectPageLogout
-""""""""""""""""""
+------------------
.. container:: table-row
.. _redirectdisable:
redirectDisable
-"""""""""""""""
+---------------
.. container:: table-row
.. _email-from:
email\_from
-"""""""""""
+-----------
.. container:: table-row
.. _email-fromname:
email\_fromName
-"""""""""""""""
+---------------
.. container:: table-row
.. _replyto:
replyTo
-"""""""
+-------
.. container:: table-row
.. _domains:
domains
-"""""""
+-------
.. container:: table-row
.. _dateformat:
dateFormat
-""""""""""
+----------
.. container:: table-row
Data type
date-conf
- Description
- Format for the link is valid until message (forget password email)
-
Default
Y-m-d H:i
+ Description
+ Format for the link is valid until message (forget password email)
+
.. _linkprefix:
linkPrefix
-""""""""""
+----------
.. container:: table-row
.. _exposenonexistentuserinforgotpassworddialog:
exposeNonexistentUserInForgotPasswordDialog
-"""""""""""""""""""""""""""""""""""""""""""
+-------------------------------------------
.. container:: table-row
Data type
bool
+ Default
+ 0
+
Description
If set and the user account cannot be found in the forgot password
dialogue, an error message will be shown that the account could not be
email address is actually used for a frontend user account! Visitors
can find out if a user is known as frontend user.
- Default
- 0
-
.. _css-default-style:
\_CSS\_DEFAULT\_STYLE
-"""""""""""""""""""""
+---------------------
.. container:: table-row
Description
CSS included in the page containing the login form
- Default
- ::
+ Example:
+
+ .. code-block:: typoscript
.tx-felogin-pi1 label {
display: block;
.. _default-pi-vars:
\_DEFAULT\_PI\_VARS
-"""""""""""""""""""
+-------------------
.. container:: table-row
.. _local-lang:
\_LOCAL\_LANG
-"""""""""""""
+-------------
.. container:: table-row
ll\_enter\_your\_data Form field label
oLabel\_header\_welcome Legend
=========================================== =================================
-