CONFIG & config

If set, the string is prepended to all relative links that TYPO3 generates.

config.absRefPrefix = auto lets TYPO3 autodetect the site root based on path prefixes and not based on host name variables from the server, making this value safe for multi-domain environments.

If the option config.forceAbsoluteUrls is enabled, absRefPrefix is overridden.

Using an URI in absRefPrefix will require additional conditions if you use different domains for your deployment stages in CI environments.

If you are working on a server where you have different domain names or different path segments leading to the same page (e.g. for internal and external access), you may do yourself a favor and set absRefPrefix to the URL and path of your site, e.g. https://example.org/. If you do not, you risk to render pages to cache from the internal network and thereby prefix image references and links with a wrong path or a path not accessible from outside.

By means of config.additionalHeaders as series of additional HTTP headers can be configured. An entry has the following structure:

10.header = the header string

This value is required.

10.replace = 0 | 1

Optional, boolean, default is 1. If 1, the header will replace an existing one that has the same name.

10.httpResponseCode = 201

Optional, integer, a http status code that the page should return.

By default TYPO3 sends a "Content-Type" header with the defined encoding. It then sends cache headers, if configured via Properties of 'config'. Then additional headers are send, plus finally a "Content-Length" header, if enabled via Properties of 'config'.

config.admPanel = 1 can be used to enable the admin panel. See Configuration in the Admin Panel manual.

Additional parameters to all links in TYPO3 (excluding menu-links).

Determine the maximum cache lifetime of a page.

The maximum cache lifetime of a page can not only be determined by the start and stop times of content elements on the page itself, but also by arbitrary records on any other page. However, the page has to be configured so that TYPO3 knows the start and stop times of which records to include. Otherwise, the cache entry will be used although a start/stop date already passed by.

To include records of type <table name> on page <pid> into the cache lifetime calculation of page <page-id>, add the following TypoScript:

config.cache.<page-id> = <table name>:<storage-pid>

Multiple record sources can be added as comma-separated list, see the examples.

You can use the keyword "all" instead of a <page-id> to consider records for the cache lifetime of all pages.

You can use the keyword "current" instead of a <storage-pid> to consider records on the current page for the cache life of itself.

With this setting the cache always expires at midnight of the day, the page is scheduled to expire.

The number of second a page may remain in cache.

This value is overridden by the value set in the page-record field="cache_timeout" if this value is greater than zero.

If set, CSS files referenced in page.includeCSS and the like will be minified and compressed. Does not work on files, which are referenced in page.headerData.

Minification will remove all excess space. The more significant compression step (using gzip compression) requires $GLOBALS['TYPO3_CONF_VARS']['FE']['compressionLevel'] to be enabled in the Install Tool. For this to work you also need to activate the gzip- related compressionLevel options in .htaccess, as otherwise the compressed files will not be readable by the user agent.

TYPO3 comes with a built-in compression handler, but you can also register your own one using $GLOBALS['TYPO3_CONF_VARS']['FE']['cssCompressHandler'] .

$GLOBALS['TYPO3_CONF_VARS']['FE']['cssCompressHandler'] =
   \TYPO3\CMS\Core\Extension\ExtensionManager::extPath('my_extension') .
   'Classes/CssCompressHandler.php:MyVendor\MyExtensionen\CssCompressHandler->compressCss';

Enabling this option together with $GLOBALS['TYPO3_CONF_VARS']['FE']['compressionLevel'] in the Install Tool delivers Frontend JavaScript files referenced in page.includeJS and the like using GZIP compression. Does not work on files, which are referenced in page.headerData.

Please note that this requires .htaccess to be adjusted, as otherwise the files will not be readable by the user agent. Please see the description of $GLOBALS['TYPO3_CONF_VARS']['FE']['compressionLevel'] in the Install Tool.

TYPO3 comes with a built-in compression handler, but you can also register your own one using $GLOBALS['TYPO3_CONF_VARS']['FE']['jsCompressHandler'] .

$GLOBALS['TYPO3_CONF_VARS']['FE']['jsCompressHandler'] =
    \TYPO3\CMS\Core\Extension\ExtensionManager::extPath('my_extension') .
    'Classes/JsCompressHandler.php:MyVendor\MyExtension\JsCompressHandler->compressJs';

Setting config.concatenateCss merges Stylesheet files referenced in the Frontend in page.includeCSS and the like together. Files are merged only, if their media attribute has the same value, e.g. if it is "all" for several files. Does not work on files, which are referenced in page.headerData.

TYPO3 comes with a built-in concatenation handler, but you can also register your own one using $GLOBALS['TYPO3_CONF_VARS']['FE']['cssConcatenateHandler'] .

$GLOBALS['TYPO3_CONF_VARS']['FE']['cssCompressHandler'] =
    \TYPO3\CMS\Core\Extension\ExtensionManager::extPath('my_extension') .
    'Classes/CssCompressHandler.php:MyVendor\MyExtension\CssCompressHandler->compressCss';

Setting config.concatenateJs merges JavaScript files referenced in the Frontend in page.includeJS and the like together. Does not work on files, which are referenced in page.headerData.

If all files to be concatenated are marked with the async flag, the async attribute is assigned to the script tag.

TYPO3 comes with a built-in concatenation handler, but you can also register your own one using $GLOBALS['TYPO3_CONF_VARS']['FE']['jsConcatenateHandler'] .

$GLOBALS['TYPO3_CONF_VARS']['FE']['jsConcatenateHandler'] =
       \TYPO3\CMS\Core\Extension\ExtensionManager::extPath('my_extension') .
       'Classes/JsConcatenateHandler.php:MyVendor\MyExtension\JsConcatenateHandler->concatenateJs';

Exceptions which occur during rendering of content objects (typically plugins) will be caught by default in production context and an error message is shown along with the rendered output.

If this is done, the page will remain available while the section of the page that produces an error (i.e. throws an exception) will show a configurable error message. By default this error message contains a random code which references the exception and is also logged by the logging framework for developer reference.

To get rid of the error message not only the actual error needs to be fixed, but the cache must be cleared for this page.

If set, then debug information in the TypoScript code is sent. This applies e.g. to menu objects and the parsetime output. The parsetime will be sent as HTTP response header X-TYPO3-Parsetime.

If this is not set or set to 0, the PAGE object automatically outputs a HTML skeleton, see Output of the PAGE object.

To disable this default behaviour set disableAllHeaderCode = 1. The page outputs only the result of the cObject array (1,2,3,4...) of the PAGE object.

Use this feature in templates supplying other content-types than HTML. That could be an image, a RSS-feed, an ajax request in a format like XML or JSON.

This property can also be used to generate the complete HTML page, including the <html> and <body> tags manually.

If this option is set, the TYPO3 core will not generate the opening <body ...> part of the body tag. The closing </body> is not affected and will still be issued.

disableBodyTag takes precedence over the PAGE properties bodyTagCObject, bodyTag and bodyTagAdd. With config.disableBodyTag = 1 the others are ignored and don't have any effect.

When the system extension SEO is installed, canonical tags are generated automatically to prevent duplicate content. A good canonical is added in many cases by default. For edge cases, you might want to disable the rendering of this tag. You can do this by setting this property to 1.

When the system extension SEO is installed, hreflang tags are generated automatically in multi-language setups. By settings this option to 1 the rendering of those tags will be skipped.

If set, the stdWrap property prefixComment will be disabled, thus preventing any revealing and space-consuming comments in the HTML source code.

Disables the "preview" notification box completely.

TYPO3 by default sends a Content-language: XX HTTP header, where "XX" is the ISO code of the according language. The value is based on the language defined in the Site Configuration.

If config.disableLanguageHeader is set, this header will not be sent.

If set, then a document type declaration (and an XML prologue) will be generated. The value can either be a complete doctype or one of the following keywords:

xhtml_trans

for the XHTML 1.0 Transitional doctype.

xhtml_strict

for the XHTML 1.0 Strict doctype.

xhtml_basic

for the XHTML basic doctype.

xhtml_11

for the XHTML 1.1 doctype.

xhtml+rdfa_10

for the XHTML+RDFa 1.0 doctype.

html5

for the HTML5 doctype.

none

for no doctype at all.

See config.htmlTag_setParams for more details on the effect on the HTML tag.

Default is the HTML 5 doctype:

<!DOCTYPE html>

If set, a header "content-length: [bytes of content]" is sent.

If a backend user is logged in, this is disabled. The reason is that the content length header cannot include the length of these objects and the content-length will cut off the length of the document in some browsers.

Default external target. Used by typolink if no extTarget is set.

Default file link target. Used by typolink if no fileTarget is set.

If this option is set, all links, reference to images or assets previously built with a relative or absolute path (for example, /fileadmin/my-pdf.pdf) will be rendered as absolute URLs with the site prefix / current domain.

Examples for such use cases are the generation of a complete static version of a TYPO3 site for sending a page via email.

Force the &type value of all TYPO3 generated links to a specific value (except if overruled by local forceTypeValue values).

Useful if you run a template with special content at - say &type=95 - but still wants to keep your targets neutral. Then you set your targets to blank and this value to the type value you wish.

The content is added before the "TYPO3 Content Management Framework" comment in the <head> section of the page. Use this to insert a note like that "Programmed by My-Agency".

Sets the attributes for the <html> tag on the page. Allows to override and add custom attributes via TypoScript without having to re-add the existing attributes generated by SiteHandling.

This property supersedes the previous config.htmlTag_setParams option by providing a more flexible API to add attributes.

Sets the attributes for the <html> tag on the page. If you set Properties of 'config' to a keyword enabling XHTML then some attributes are already set. This property allows you to override any preset attributes with your own content if needed.

Special: If you set it to "none" then no attributes will be set at any event.

If you are using htmlTag.attributes this property (htmlTag_setParams) will not have any effect.

Modify the whole <html> tag with stdWrap functionality. This can be used to extend or override this tag.

This indicates how many chars to preserve as description for an indexed page. This may be used in the search result display.

Enables cached pages to be indexed.

Automatically enabled when indexed_search is enabled.

If set, external media linked to on the pages is indexed as well.

Automatically enabled when indexed_search is enabled.

This allows to turn on or off the indexing of metatags. It is turned on by default.

If set, the inline styles TYPO3 controls in the core are written to a file, typo3temp/assets/css/stylesheet_[hashstring].css, and the header will only contain the link to the stylesheet.

The file hash is based solely on the content of the styles.

Default internal target. Used by typolink if no target is set.

HTTP_GET_VARS, which should be passed on with links in TYPO3. This is compiled into a string stored in $GLOBALS['TSFE']->linkVars

The values are rawurlencoded in PHP.

You can specify a range of valid values by appending a () after each value. If this range does not match, the variable won't be appended to links. This is very important to prevent that the cache system gets flooded with forged values.

The range may contain one of these values:

[a]-[b]

A range of allowed integer values

int

Only integer values are allowed

[a]\|[b]\|[c]

A list of allowed strings (whitespaces will be removed)

/[regex]/

Match against a regular expression (PCRE style)

You can use the pipe character (|) to access nested properties.

Alternative message in HTML that appears when the preview function is active.

Alternative message in HTML that appears when the preview function is active in a draft workspace. You can use sprintf() placeholders for Workspace title (first) and number (second).

If set, all JavaScript (includes and inline) will be moved to the bottom of the HTML document, which is after the content and before the closing body tag.

Allows you to set a list of page id numbers which will always have a certain "&MP=..." parameter added.

Imagine you have a TYPO3 site with several mount points, and you need certain pages to always include a specific mount point parameter for correct content rendering. By configuring :typoscriptMP_defaults, you ensure consistency and reduce the risk of broken links or incorrect content being displayed due to missing parameters.

If set, the typolink function will not try to find the closest MP value for the id.

Defines a list of ID numbers from which the MP-vars are automatically calculated for the branch.

The result is used just like MP_defaults are used to find MP-vars if none has been specified prior to the call to \TYPO3\CMS\Frontend\Typolink\PageLinkBuilder.

You can specify root as a special keyword in the list of IDs and that will create a map-tree for the whole site (but this may be VERY processing intensive if there are many pages!).

The order of IDs specified may have a significance; Any ID in a branch which is processed already (by a previous ID root point) will not be processed again.

The configured IDs have to be the uids of Mount Point pages itself, not the targets.

This property enables you to add XML namespaces (xmlns) to the <html> tag. This is especially useful if you want to add RDFa or microformats to your HTML.

If this is set to 1, it disables the pages cache, meaning that the rendered result/response will not be saved to cache.

If set to 0, it's ignored. Rendered result (e.g. full html of a page) is stored in the pages cache.

Other parameters may have set it to true for other reasons. Note that setting this to 1 doesn't disable other TYPO3 caches. Instead of setting config.no_cache you might consider changing dynamic (non-cacheable) content from USER to USER_INT (COA to COA_INT).

For more information about cache types see cache types chapter.

If you only want to have the site name (from the template record) in your <title> tag, set this to 1. If the value is 2 then the <title> tag is not printed at all.

Please take note that this tag is required for (X)HTML compliant output, so you should only disable this tag if you generate it manually already.

Sets the template for page renderer class \TYPO3\CMS\Core\Page\PageRenderer .

stdWrap for the page title. This option will be executed after all other processing options like Properties of 'config'.

TYPO3 by default prints a title tag in the format "website: page title".

If pageTitleFirst is set (and if the page title is printed), then the page title will be printed IN FRONT OF the template title. So it will look like "page title: website".

In order to keep setting the titles in control, an API to set the page title is available. The API uses PageTitleProviders to define the page title based on page record and the content on the page.

Based on the priority of the providers, the PageTitleProviderManager will check the providers if a title is given by the provider. It will start with the highest priority PageTitleProviders and will end with the lowest in priority.

The signs which should be printed in the title tag between the website name and the page title. If pageTitleSeparator is set, but no sub-properties are defined, then a space will be added to the end of the separator. stdWrap is useful to adjust whitespaces at the beginning and the end of the separator.

Remove CSS generated by _CSS_DEFAULT_STYLE configuration of extensions. (_CSS_DEFAULT_STYLE outputs a set of default styles, just because an extension is installed.)

If set, the default JavaScript in the header will be removed.

The default JavaScript is the decryption function for email addresses.

Special case: If the value is the string external, then the default JavaScript is written to a temporary file and included from that file. See inlineStyle2TempFile example.

If set, TYPO3 will output cache-control headers to the client based mainly on whether the page was cached internally. This feature allows client browsers and/or reverse proxies to take load off TYPO3 websites.

The conditions for allowing client caching are:

• page was cached
• No *_INT or *_EXT objects were on the page (e.g. USER and USER_INT)
• No frontend user is logged in
• No backend user is logged in

If these conditions are met, the headers sent are:

• Last-Modified [SYS_LASTCHANGED of page id]
• Expires [expire time of page cache]
• ETag [md5 of content]
• Cache-Control: max-age: [seconds til expiretime]
• Pragma: public

In case caching is not allowed, these headers are sent to avoid client caching:

• Cache-Control: private, no-store

Notice that enabling the browser caches means you have to consider how log files are written. Because when a page is cached on the client it will not invoke a request to the webserver, thus not writing the request to the log. There should be ways to circumvent these problems but they are outside the domain of TYPO3 in any case.

Tip: Enabling cache-control headers might confuse editors seeing old content served from the browser cache. "Shift-Reload" will bypass both browser- and reverse-proxy caches and even make TYPO3 regenerate the page. Teach them that trick!

When working with proxies, it is much helpful to take load off of TYPO3 / the webserver by keeping a cached version for a period of time and answering requests from the client, while still telling the client to not cache the response inside the browser cache.

This is achieved by setting config.sendCacheHeadersForSharedCaches = auto.

With this option enabled, TYPO3 evaluates if the current TYPO3 Frontend request is executed behind a reverse proxy, and if so, TYPO3 sends the following HTTP Response Headers at a cached response:

Expires: Thu, 26 Aug 2024 08:52:00 GMT
ETag: "d41d8cd98f00b204ecs00998ecf8427e"
Cache-Control: max-age=0, s-maxage=86400
Pragma: public

With config.sendCacheHeadersForSharedCaches = force the reverse proxy evaluation can be omitted, which can be used for local webserver internal caches.

See https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Cache-Control for details and if your reverse proxy supports this directive.

The option can be used to specify whether the website title defined in the site configuration should be added to the page title (used for the <title> tag, for example).

By default, the website title is added. To omit the website title, the option has to be set to 0.

If set, then all email addresses in typolinks will be encrypted so that it is harder for spam bots to detect them.

If you set this value to a number, then the encryption is an offset of character values. If you set this value to "-2" then all characters will have their ASCII value offset by "-2". To make this possible, a little JavaScript code is added to every generated web page!

(It is recommended to set the value in the range from -5 to 1 since setting it to >= 2 means a "z" is converted to "|" which is a special character in TYPO3 tables syntax – and that might confuse columns in tables.)

It is required to enable the default JavaScript and not disable it. (see removeDefaultJS)

Substitute label for the at-sign (@).

Substitute label for the last dot in the email address.

Configuration space for extensions. This can be used – for example – by plugins that need some TypoScript configuration, but that don't actually display anything in the frontend (i.e. don't receive their configuration as an argument from the frontend rendering process).

If set, typolinks pointing to access restricted pages will still link to the page even though the page cannot be accessed. If the value of this setting is an integer it will be interpreted as a page id to which the link will be directed.

If the value is NONE the original link to the page will be kept although it will generate a page-not-found situation (which can of course be picked up properly by the page-not-found handler and present a nice login form).

See showAccessRestrictedPages for menu objects as well (similar feature for menus)

typolinkLinkAccessRestrictedPages.ATagParams Add custom attributes to the anchor tag.

See Define custom styling for access restricted page links above.

If empty (not set) then the default XML 1.0 prologue is set, when the doctype is set to a known keyword (e.g. xhtml_11):

<?xml version="1.0" encoding="utf-8">

If set to one of the following keywords then a standard prologue will be set:

xml_10:

XML 1.0 prologue (see above)

xml_11:

XML 1.1 prologue

none:

The default XML prologue is not set.

Any other string is used as the XML prologue itself.