TSconfig Reference

This is what is sent as "User-Agent" to the external site when checking external URLs. It should contain a working URL with contact information.

User-Agent = Mozilla/5.0 (compatible; Mysite LinkChecker/1.1; +https://mysite.com/imprint.html

Comma separated list of hooks to load.

Possible values:

db: Check links to database records (pages, content elements).

file: Check links to files located in your local TYPO3 installation.

external: Check links to external files.

This list may be extended by other extensions providing a linktype checker.

Comma separated list of table fields in which to check for broken links. Broken Link Fixer only checks fields that have been defined in searchFields.

Broken Link Fixer ships with sensible defaults that work well for the TYPO3 core. Not all fields which contain links are currently checked though. You can configure additional fields for extensions.

Only check for bodytext in tt_content:

mod.brofix.searchFields.tt_content = bodytext

Add checks for news and calendarize events:

mod.brofix.searchFields.tx_news_domain_model_news = bodytext
mod.brofix.searchFields.tx_calendarize_domain_model_event = description

Comma separated list of page types on which content should not be checked. This still means the pages will get checked.

This is for example by default the cause for the page types shortcut and external link.

Whether links to hidden records should be treated as broken links.

The pid of the storage folder which contains the excluded link target records. If you want to enable editors to add URLs to list of excluded URLs, you must change this (it must be != 0).

Create a central folder to store the excluded URLs or create one for each site.

Excluded link targets (=URLs) are treated as valid URLs. This can be used for the rare case that an URL is detected as broken, but is not broken. This may be the case for some sites which require login credentials, but also for common sites where the automatic link checking mechanism yields false results.

Allowed link types which can be excluded. By default, it is only possible to exclude external URLs. If you would like to make this available for page links too, add additional link types, e.g.

allowed = external,db

You can set it to empty to disable the "exclude URL" functionality:

allowed =

When the link target cache expires in seconds. Whenever an external URL is checked or rechecked, the link target cache is used. Once the cache expires, the URL must be checked again.

The value means that the information for external URLs is retained for that time without having to access the external site.

2 different values are used for expiresLow and expiresHigh so that the target will usually not expire during the on-the-fly checking which would lead to delays.

As a rule of thumb, use the interval for full checking (e.g. 1 day for once a day checking) and multiply that with a factor of 1 to 10 for expiresLow. Add another interval for expiresHigh.

The interval for expiresLow will be used for full checking via the console command.

# checking links daily, use 7 as factor:
#  1 day * 7 * (seconds per day)
#  1 * 7 * 24*60*60
linkTargetCache.expiresLow = 604800
#  1 * 8 * 24*60*60
linkTargetCache.expiresHigh = 691200

The minimum number of seconds that must have passed between checking 2 URL for the same domain.

If the required time has already passed since an URL of the same domain was last checked, the wait is not performed.

This helps to prevent that external sites are bombarded with requests from our site.

This is a pragmatic approach to make sure that a minimum delay is used when checking URLs of the same site. As a site may have multiple domains or several domains may be used by the same site, this will not always get the desired result, but it is a "good enough" approach.

This will not be used for on-the-fly checking, only for checking via the console command task.

crawlDelay.seconds = 10

Do not use the crawlDelay.seconds wait period for these domains

crawlDelay.nodelay = example.org,example.com

Add a documentation URL. This will add an "i" button to the broken link report with a link to the documentation.

Add a link to the official documentation:

report.docsurl = https://docs.typo3.org/p/sypets/brofix/main/en-us/Index.html

Whether to show the "Check links" button. By default, the button is available for "admin" users, but not for regular editors.

Deactivate the button for non-admin users (default):

mod.brofix.report.recheckButton = -1

Activate button if depth=0 (current page) is selected:

mod.brofix.report.recheckButton = 0

Enable the button in User TSconfig with depth "infinite" (for a user or group):

page.mod.brofix.report.recheckButton = 999

If the current depth <= recheckButton, the button will be displayed. This makes it possible to not only control whether checking is possible, but also the depth

Enable sending an email when the brofix:checkLinks console command is excecuted. This can be overridden via command line arguments (-e). Possible values:

• "never" : never send email (previously: 0)
• "always": send email (previously: 1)
• "any" : send email if any broken links were found
• "new" : send email if new broken links were found