README

Adds a panel area with the ability to scan your site's content files for broken links. The plugin can traverse internal Kirby UUID links and external links in various formats reporting back those that return 404 or 500-level errors with a quick means to go to the source page and update or remove them.

Installation

Kirby CLI

kirby plugin:install scottboms/kirby-link-scanner

Composer

composer require scottboms/link-scanner

Git submodule

git submodule add https://github.com/scottboms/kirby-link-scanner.git site/plugins/link-scanner

Copy and Paste

1. Download the contents of this repository as Zip file.
2. Rename the extracted folder to link-scanner and copy it into the site/plugins/ directory in your Kirby project.

The plugin supports both Composer installs and direct plugin-folder installs. When installed without Composer, it falls back to Kirby's built-in class loader.

Configuration Options

Example Config:

<?php
  return [
	  'scottboms.link-scanner' => [
      'timeout'    => 10,
      'userAgent'  => 'Kirby Link Scanner',
    ]
  ]

Compatibility

• Kirby 5.x
• PHP 8.3+ with cURL and php cli exec()
• Be sure that Kirby's Vue template compiler is not disabled

Disclaimer

This plugin is provided "as is" with no guarantee. Use it at your own risk and always test before using it in a production environment. If you identify an issue, typo, etc, please create a new issue so I can investigate.

License

MIT