README

Contao Crawler Authenticator

Allows the Contao Crawler to be logged in as a front end member via Basic Authentication in order to index protected pages.

Usage

1. Install the extension (zero configuration necessary in the Contao Managed Edition).
2. Create a front end member specifically for the Contao Crawler or re-use an existing one where you know the password.
3. Assign the member to the appropriate member groups.
4. Now choose one of the following options (replace <username> and <password> with the member's credentials):
   • Pass the member's username and password for every contao:crawl execution:

     CRAWLER_AUTH=<username>:<password> vendor/bin/contao-console contao:crawl --subscribers=search-index --max-depth=3
     

   • Define the member's username and password in the .env.local:

     # .env.local
     CRAWLER_AUTH=<username>:<password>

     These will then get used automatically every time you execute contao:crawl (unless overridden by the former command). Make sure you also have a .env file, otherwise the .env.local will not be loaded of course.

Note: be aware that the member's password will be put unencrypted into the bash history in the former case and into the .env.local in the latter case.