FE - frontend configuration¶

The following configuration variables can be used to configure settings for the TYPO3 frontend:

addAllowedPaths
debug
compressionLevel
pageNotFoundOnCHashError
pageUnavailable_force
addRootLineFields
checkFeUserPid
loginRateLimit
loginRateLimitInterval
loginRateLimitIpExcludeList
lockIP
lockIPv6
lifetime
sessionTimeout
sessionDataLifetime
permalogin
cookieDomain
cookieName
cookieSameSite
defaultTypoScript_constants
defaultTypoScript_setup
additionalAbsRefPrefixDirectories
enable_mount_pids
hidePagesIfNotTranslatedByDefault
eID_include
disableNoCacheParameter
additionalCanonicalizedUrlParameters
cacheHash
- cachedParametersWhiteList
- requireCacheHashPresenceParameters
- excludedParameters
- excludedParametersIfEmpty
- excludeAllEmptyParameters
- enforceValidation
workspacePreviewLogoutTemplate
versionNumberInFilename
contentRenderingTemplates
ContentObjects
typolinkBuilder
passwordHashing
- className
- options
passwordPolicy
exposeRedirectInformation
contentSecurityPolicyReportingUrl

Note

The configuration values listed here are keys in the global PHP array $GLOBALS['TYPO3_CONF_VARS']['FE'].

This variable can be set in one of the following files:

addAllowedPaths ¶

$GLOBALS['TYPO3_CONF_VARS']['FE']['addAllowedPaths']¶

Type: list
Default: ''

Additional relative paths where resources may be placed. Used in some frontend-related places for images and TypoScript. It should be prefixed with /. If not, then any path whose the first part is like this path will match. That is, myfolder/ , myarchive will match, for example, myfolder/, myarchive/, myarchive_one/, myarchive_2/, etc.

No check is done whether this directory actually exists in the root folder of the site.

debug ¶

$GLOBALS['TYPO3_CONF_VARS']['FE']['debug']¶

Type: bool
Default: false

If enabled, the total parse time of the page is added as HTTP response header X-TYPO3-Parsetime. This can also be enabled/disabled via the TypoScript option config.debug = 0.

compressionLevel ¶

$GLOBALS['TYPO3_CONF_VARS']['FE']['compressionLevel']¶

Type: int
Default: 0

Determines output compression of FE output. Makes output smaller but slows down the page generation depending on the compression level. Requires

zlib in your PHP installation and
special rewrite rules for .css.gz and .js.gz (before version 12.0 the extension was .css.gzip and .js.gzip)

Please see EXT:install/Resources/Private/FolderStructureTemplateFiles/root-htaccess for an example. Range 1-9, where 1 is least compression and 9 is greatest compression. true as value will set the compression based on the PHP default settings (usually 5 ). Suggested and most optimal value is 5.

pageNotFoundOnCHashError ¶

$GLOBALS['TYPO3_CONF_VARS']['FE']['pageNotFoundOnCHashError']¶

Type: bool
Default: true

If TRUE, a page not found call is made when cHash evaluation error occurs, otherwise caching is disabled and page output is displayed.

pageUnavailable_force ¶

$GLOBALS['TYPO3_CONF_VARS']['FE']['pageUnavailable_force']¶

Type: bool
Default: false

If TRUE, every frontend page is shown as "unavailable". If the client matches [SYS][devIPmask], the page is shown as normal. This is useful during temporary site maintenance.

addRootLineFields ¶

$GLOBALS['TYPO3_CONF_VARS']['FE']['addRootLineFields']¶

Type: list
Default: ''

Comma-list of fields from the pages-table. These fields are added to the select query for fields in the rootline.

checkFeUserPid ¶

$GLOBALS['TYPO3_CONF_VARS']['FE']['checkFeUserPid']¶

Type: bool
Default: true

If set, the pid of fe_user logins must be sent in the form as the field pid and then the user must be located in the pid. If you unset this, you should change the fe_users username eval-flag uniqueInPid to unique in $TCA.

This will do $TCA[fe_users][columns][username][config][eval]= nospace,lower,required,unique;

loginRateLimit ¶

$GLOBALS['TYPO3_CONF_VARS']['FE']['loginRateLimit']¶

Type: int
Default: 5

Maximum amount of login attempts for the time interval in [FE][loginRateLimitInterval], before further login requests will be denied. Setting this value to "0" will disable login rate limiting.

loginRateLimitInterval ¶

$GLOBALS['TYPO3_CONF_VARS']['FE']['loginRateLimitInterval']¶

Type: string, PHP relative format
Default: '15 minutes'
AllowedValues: '1 minute', '5 minutes', '15 minutes', '30 minutes'

Allowed time interval for the configured rate limit. Individual values using PHP relative formats can be set in config/system/additional.php.

loginRateLimitIpExcludeList ¶

$GLOBALS['TYPO3_CONF_VARS']['FE']['loginRateLimitIpExcludeList']¶

Type: string
Default: ''

IP-numbers (with *-wildcards) that are excluded from rate limiting. Syntax similar to [BE][IPmaskList]. An empty value disables the exclude list check.

lockIP ¶

$GLOBALS['TYPO3_CONF_VARS']['FE']['lockIP']¶

Type

int

Default

0

AllowedValues

0: Default Do not lock Frontend User sessions to their IP address at all
1: Use the first part of the visitors IPv4 address (for example "192.") as part of the session locking of Frontend Users
2: Use the first two parts of the visitors IPv4 address (for example "192.168") as part of the session locking of Frontend Users
3: Use the first three parts of the visitors IPv4 address (for example "192.168.13") as part of the session locking of Frontend Users
4: Use the visitors full IPv4 address (for example "192.168.13.84") as part of the session locking of Frontend Users (highest security)

If activated, Frontend Users are locked to (a part of) their public IP ($_SERVER[REMOTE_ADDR]) for their session, if REMOTE_ADDR is an IPv4-address. Enhances security but may throw off users that may change IP during their session (in which case you can lower it). The integer indicates how many parts of the IP address to include in the check for the session.

Have also a look into the security guidelines.

lockIPv6 ¶

$GLOBALS['TYPO3_CONF_VARS']['FE']['lockIPv6']¶

Type

int

Default

0

AllowedValues

0: Default: Do not lock Backend User sessions to their IP address at all
1: Use the first block (16 bits) of the editors IPv6 address (for example "2001") as part of the session locking of Backend Users
2: Use the first two blocks (32 bits) of the editors IPv6 address (for example "20010db8") as part of the session locking of Backend Users
3: Use the first three blocks (48 bits) of the editors IPv6 address (for example "20010db885a3") as part of the session locking of Backend Users
4: Use the first four blocks (64 bits) of the editors IPv6 address (for example "20010db885a308d3") as part of the session locking of Backend Users
5: Use the first five blocks (80 bits) of the editors IPv6 address (for example "20010db885a308d31319") as part of the session locking of Backend Users
6: Use the first six blocks (96 bits) of the editors IPv6 address (for example "20010db885a308d313198a2e") as part of the session locking of Backend Users
7: Use the first seven blocks (112 bits) of the editors IPv6 address (for example "20010db885a308d313198a2e0370") as part of the session locking of Backend Users
8: Use the visitors full IPv6 address (for example "20010db885a308d313198a2e03707344") as part of the session locking of Backend Users (highest security)

If activated, Frontend Users are locked to (a part of) their public IP ( $_SERVER[REMOTE_ADDR]) for their session, if REMOTE_ADDR is an IPv6-address. Enhances security but may throw off users that may change IP during their session (in which case you can lower it). The integer indicates how many parts of the IP address to include in the check for the session.

lifetime ¶

$GLOBALS['TYPO3_CONF_VARS']['FE']['lifetime']¶

Type: int
Default: 0

If greater then 0 and the option permalogin is greater or equal 0, the cookie of FE users will have a lifetime of the number of seconds this value indicates. Otherwise it will be a session cookie (deleted when browser is shut down). Setting this value to 604800 will result in automatic login of FE users during a whole week, 86400 will keep the FE users logged in for a day.

sessionTimeout ¶

$GLOBALS['TYPO3_CONF_VARS']['FE']['sessionTimeout']¶

Type: int
Default: 6000

Server side session timeout for frontend users in seconds. Will be overwritten by the lifetime property if the lifetime is longer.

sessionDataLifetime ¶

$GLOBALS['TYPO3_CONF_VARS']['FE']['sessionDataLifetime']¶

Type: int
Default: 86400

If greater then 0, the session data of an anonymous session will timeout and be removed after the number of seconds given (86400 seconds represents 24 hours).

permalogin ¶

$GLOBALS['TYPO3_CONF_VARS']['FE']['permalogin']¶

Type: text
Default: 0

-1: Permanent login for FE users is disabled

0: By default permalogin is disabled for FE users but can be enabled by a form control in the login form.
1: Permanent login is by default enabled but can be disabled by a form control in the login form.
2: Permanent login is forced to be enabled.

In any case, permanent login is only possible if [FE][lifetime] lifetime is greater then 0.

cookieDomain ¶

$GLOBALS['TYPO3_CONF_VARS']['FE']['cookieDomain']¶

Type: text
Default: ''

Same as $TYPO3_CONF_VARS[SYS][cookieDomain]<_typo3ConfVars_sys_cookieDomain> but only for FE cookies. If empty, $TYPO3_CONF_VARS[SYS][cookieDomain] value will be used.

cookieName ¶

$GLOBALS['TYPO3_CONF_VARS']['FE']['cookieName']¶

Type

text

Default

'fe_typo_user'

Sets the name for the cookie used for the front-end user session

cookieSameSite ¶

$GLOBALS['TYPO3_CONF_VARS']['FE']['cookieSameSite']¶

Type

text

Default

'lax'

AllowedValues

lax: Cookies set by TYPO3 are only available for the current site, third-party integrations are not allowed to read cookies, except for links and simple HTML forms
strict: Cookies sent by TYPO3 are only available for the current site, never shared to other third-party packages
none: Allow cookies set by TYPO3 to be sent to other sites as well, please note - this only works with HTTPS connections

Indicates that the cookie should send proper information where the cookie can be shared (first-party cookies vs. third-party cookies) in TYPO3 Frontend.

defaultTypoScript_constants ¶

$GLOBALS['TYPO3_CONF_VARS']['FE']['defaultTypoScript_constants']¶

Type

multiline

Default

''

Enter lines of default TypoScript, constants-field.

defaultTypoScript_setup ¶

$GLOBALS['TYPO3_CONF_VARS']['FE']['defaultTypoScript_setup']¶

Type

multiline

Default

''

Enter lines of default TypoScript, setup-field.

additionalAbsRefPrefixDirectories ¶

$GLOBALS['TYPO3_CONF_VARS']['FE']['additionalAbsRefPrefixDirectories']¶

Type: text
Default: ''

Enter additional directories to be prepended with absRefPrefix. Directories must be comma-separated. TYPO3 already prepends the following directories public/_assets/, public/typo3temp/ and all local storages including public/fileadmin/.

In legacy installations without Composer typo3conf/ext and typo3/ are also prefixed.

enable_mount_pids ¶

$GLOBALS['TYPO3_CONF_VARS']['FE']['enable_mount_pids']¶

Type: bool
Default: true

If enabled, the mount_pid feature allowing symlinks in the page tree (for frontend operation) is allowed.

hidePagesIfNotTranslatedByDefault ¶

$GLOBALS['TYPO3_CONF_VARS']['FE']['hidePagesIfNotTranslatedByDefault']¶

Type: bool
Default: false

If enabled, pages that have no translation will be hidden by default. Basically this will inverse the effect of the page localization setting "Hide page if no translation for current language exists" to "Show page even if no translation exists"

eID_include ¶

$GLOBALS['TYPO3_CONF_VARS']['FE']['eID_include']¶

Type: array
Default: []

Array of key/value pairs where the key is tx_[ext]_[optional suffix] and value is relative filename of class to include. Key is used as "?eID=" for \TYPO3\CMS\Frontend\Http\RequestHandlerRequestHandler to include the code file which renders the page from that point.

(Useful for functionality that requires a low initialization footprint, for example frontend Ajax applications)

disableNoCacheParameter ¶

$GLOBALS['TYPO3_CONF_VARS']['FE']['disableNoCacheParameter']¶

Type: bool
Default: false

If set, the no_cache request parameter will become ineffective. This is currently still an experimental feature and will require a website only with plugins that dont use this parameter. However, using "&no_cache=1" should be avoided anyway because there are better ways to disable caching for a certain part of the website (see COA_INT/USER_INT<t3tsref:cobj-coa-int>).

additionalCanonicalizedUrlParameters ¶

$GLOBALS['TYPO3_CONF_VARS']['FE']['additionalCanonicalizedUrlParameters']¶

Type: array
Default: []

The given parameters will be included when calculating canonicalized URL

cacheHash ¶

cachedParametersWhiteList ¶

$GLOBALS['TYPO3_CONF_VARS']['FE']['cacheHash']['cachedParametersWhiteList']['cacheHash']¶

Type: array
Default: []

Only the given parameters will be evaluated in the cHash calculation. Example:

config/system/additional.php | typo3conf/system/additional.php¶

$GLOBALS['TYPO3_CONF_VARS']['FE']['cacheHash']['cachedParametersWhiteList'][] = 'tx_news_pi1[uid]';

requireCacheHashPresenceParameters ¶

$GLOBALS['TYPO3_CONF_VARS']['FE']['cacheHash']['requireCacheHashPresenceParameters']¶

Type: array
Default: []

Configure Parameters that require a cHash. If no cHash is given but one of the parameters are set, then TYPO3 triggers the configured cHash Error behaviour

excludedParameters ¶

$GLOBALS['TYPO3_CONF_VARS']['FE']['cacheHash']['excludedParameters']¶

Type: array
Default: ['L', 'pk_campaign', 'pk_kwd', 'utm_source', 'utm_medium', 'utm_campaign', 'utm_term', 'utm_content', 'gclid', 'fbclid']

The given parameters will be ignored in the cHash calculation. Example:

config/system/additional.php | typo3conf/system/additional.php¶

$GLOBALS['TYPO3_CONF_VARS']['FE']['cacheHash']['excludedParameters'] = ['L','tx_search_pi1[query]'];

excludedParametersIfEmpty ¶

$GLOBALS['TYPO3_CONF_VARS']['FE']['cacheHash']['excludedParametersIfEmpty']¶

Type: array
Default: []

Configure Parameters that are only relevant for the cHash if there's an associated value available. Set excludeAllEmptyParameters to true to skip all empty parameters.

excludeAllEmptyParameters ¶

$GLOBALS['TYPO3_CONF_VARS']['FE']['cacheHash']['excludeAllEmptyParameters']¶

Type: bool
Default: false

If true, all parameters which are relevant for cHash are only considered if they are non-empty.

enforceValidation ¶

New in version 10.4.35/11.5.23/12.2.

$GLOBALS['TYPO3_CONF_VARS']['FE']['cacheHash']['enforceValidation']¶

Type: bool
Default: false (for existing installations), true (for new installations)

If this option is enabled, the same validation is used to calculate a "cHash" value as when a valid or invalid "cHash" parameter is given to a request, even when no "cHash" is given.

Note

The option is disabled for existing installations, but enabled for new installations. It is also highly recommended to enable this option in your existing installations as well.

Details:

Since TYPO3 v9 and the PSR-15 middleware concept, cHash validation has been moved outside of plugins and rendering code inside a validation middleware to check if a given "cHash" acts as a signature of other query parameters in order to use a cached version of a frontend page.

However, the check only provided information about an invalid "cHash" in the query parameters. If no "cHash" was given, the only option was to add a "required list" (global TYPO3 configuration option requireCacheHashPresenceParameters), but not based on the final excludedParameters for the cache hash calculation of the given query parameters.

workspacePreviewLogoutTemplate ¶

$GLOBALS['TYPO3_CONF_VARS']['FE']['workspacePreviewLogoutTemplate']¶

Type: text
Default: ''

If set, points to an HTML file relative to the TYPO3_site root which will be read and outputted as template for this message. Example fileadmin/templates/template_workspace_preview_logout.html.

Inside you can put the marker %1$s to insert the URL to go back to. Use this in <a href="%1$s">Go back...</a> links.

versionNumberInFilename ¶

$GLOBALS['TYPO3_CONF_VARS']['FE']['versionNumberInFilename']¶

Type: bool
Default: false

If enabled, included CSS and JS files loaded in the TYPO3 frontend will have the timestamp embedded in the filename, for example, filename.1676276352.js. This will make browsers and proxies reload the files, if they change (thus avoiding caching issues).

Attention

This feature requires extra .htaccess rules to work (please refer to the EXT:install/Resources/Private/FolderStructureTemplateFiles/root-htaccess file shipped with TYPO3).

If disabled, the last modification date of the file will be appended as a query string.

contentRenderingTemplates ¶

$GLOBALS['TYPO3_CONF_VARS']['FE']['contentRenderingTemplates']¶

Type: array
Default: []

Array to define the TypoScript parts that define the main content rendering.

Extensions like fluid_styled_content provide content rendering templates. Other extensions like felogin or indexed search extend these templates and their TypoScript parts are added directly after the content templates.

See EXT:fluid_styled_content/ext_localconf.php and EXT:core/Classes/TypoScript/IncludeTree/TreeBuilder.php

ContentObjects ¶

Changed in version 12.0: The global variable $GLOBALS['TYPO3_CONF_VARS']['FE']['ContentObjects'] has no effect anymore in TYPO3 v12.0 and above. It can be defined to achieve backward compatibility with TYPO3 version 11 and below.

TypoScript content objects (cObject) like TEXT or HMENU are registered as services:

EXT:my_extension/Configuration/Services.yaml¶

services:
  # ...
  MyCompany\MyPackage\ContentObject\CustomContentObject:
    tags:
      - name: frontend.contentobject
        identifier: 'MY_OBJ'

typolinkBuilder ¶

$GLOBALS['TYPO3_CONF_VARS']['FE']['typolinkBuilder']¶

Type: array

Matches the LinkService implementations for generating URLs and link texts via typolink. This configuration value can be used to register a custom link builder for the frontend generation of links.

Default value of $GLOBALS['TYPO3_CONF_VARS']['FE']['typolinkBuilder']¶

[
      'page' => \TYPO3\CMS\Frontend\Typolink\PageLinkBuilder::class,
      'file' => \TYPO3\CMS\Frontend\Typolink\FileOrFolderLinkBuilder::class,
      'folder' => \TYPO3\CMS\Frontend\Typolink\FileOrFolderLinkBuilder::class,
      'url' => \TYPO3\CMS\Frontend\Typolink\ExternalUrlLinkBuilder::class,
      'email' => \TYPO3\CMS\Frontend\Typolink\EmailLinkBuilder::class,
      'record' => \TYPO3\CMS\Frontend\Typolink\DatabaseRecordLinkBuilder::class,
      'telephone' => \TYPO3\CMS\Frontend\Typolink\TelephoneLinkBuilder::class,
      'unknown' => \TYPO3\CMS\Frontend\Typolink\LegacyLinkBuilder::class,
  ]

passwordHashing ¶

className ¶

$GLOBALS['TYPO3_CONF_VARS']['FE']['passwordHashing']['className']¶

Type

string

Default

\TYPO3\CMS\Core\Crypto\PasswordHashing\Argon2iPasswordHash::class

AllowedValues

\TYPO3\CMS\Core\Crypto\PasswordHashing\Argon2iPasswordHash::class: Good password hash mechanism. Used by default if available.
\TYPO3\CMS\Core\Crypto\PasswordHashing\Argon2idPasswordHash::class: Good password hash mechanism.
\TYPO3\CMS\Core\Crypto\PasswordHashing\BcryptPasswordHash::class: Good password hash mechanism.
\TYPO3\CMS\Core\Crypto\PasswordHashing\Pbkdf2PasswordHash::class: Fallback hash mechanism if argon and bcrypt are not available.
\TYPO3\CMS\Core\Crypto\PasswordHashing\PhpassPasswordHash::class: Fallback hash mechanism if none of the above are available.

options ¶

$GLOBALS['TYPO3_CONF_VARS']['FE']['passwordHashing']['options']¶

Type: array
Default: []

Special settings for specific hashes.

passwordPolicy ¶

New in version 12.0.

$GLOBALS['TYPO3_CONF_VARS']['FE']['passwordPolicy']¶

Type: string
Default: default

Defines the password policy in frontend context.

exposeRedirectInformation ¶

$GLOBALS['TYPO3_CONF_VARS']['FE']['exposeRedirectInformation']¶

Type: bool
Default: false

If set, redirects executed by TYPO3 publicly expose the page ID in the HTTP header. As this is an internal information about the TYPO3 system, it should only be enabled for debugging purposes.

contentSecurityPolicyReportingUrl ¶

New in version 12.3.

$GLOBALS['TYPO3_CONF_VARS']['FE']['contentSecurityPolicyReportingUrl']¶

Type: string
Default: ''

Configure the reporting HTTP endpoint of Content Security Policy violations in the frontend; if it is empty, the TYPO3 endpoint will be used.

Example:

$GLOBALS['TYPO3_CONF_VARS']['FE']['contentSecurityPolicyReportingUrl']
    = 'https://csp-violation.example.org/';