schliesser/sitecrawler

TYPO3 sitemap crawler

v3.0.0 2024-05-14 22:10 UTC

Requires

• php: ^8.1
• ext-simplexml: *
• ext-zlib: *
• typo3/cms-core: ^12.4 || ^v13.0

Requires (Dev)

• donatj/mock-webserver: ^2.7
• friendsofphp/php-cs-fixer: ^3.0
• php-parallel-lint/php-parallel-lint: ^1.2
• saschaegerer/phpstan-typo3: dev-master
• typo3/cms-composer-installers: ^5.0
• typo3/testing-framework: ^8.0

GPL-2.0-or-later

• André Buchmann

README

This extension provides a Symfony command to crawl any sitemap including all sub sitemaps. It gathers all available urls and then calls each url. This way you can warm up the TYPO3 page cache. Any standard sitemap can be crawled: TYPO3, Shopware, ...

You can provide custom request headers in json format. For basic auth you need to base64 encode user:password in the header.

Since version 1.1.0 the sitecrawler can read robots.txt files to fetch all defined sitemaps from it.

Version 3.0.0 supports now gzipped sub sitemaps and TYPO3 v13. Dropped support for TYPO3 v11 and older.

Examples

Composer based:

bin/typo3 sitecrawler:crawl 'https://www.example.com/sitemap.xml'

# with custom request headers
bin/typo3 sitecrawler:crawl 'https://www.example.com/sitemap.xml' '{"Authorization": "Basic dXNlcjpwYXNzd29yZA==", "Cache-Control": "no-cache"}'

# Only list all gathered urls
bin/typo3 sitecrawler:crawl 'https://www.example.com/sitemap.xml' --list=txt

# Only list all gathered urls as json
bin/typo3 sitecrawler:crawl 'https://www.example.com/sitemap.xml' --list=json

Non composer:

typo3/sysext/core/bin/typo3 sitecrawler:crawl 'https://www.example.com/sitemap.xml'

Development

• Clone project and cd into the extension folder
• Install dependencies for tests: composer install
• Run tests with: composer run test