PHPackages                             scottboms/link-scanner - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. [API Development](/categories/api)
4. /
5. scottboms/link-scanner

ActiveKirby-plugin[API Development](/categories/api)

scottboms/link-scanner
======================

Link Scanner plugin for Kirby

1.0.3(2mo ago)52[9 issues](https://github.com/scottboms/kirby-link-scanner/issues)MITJavaScriptPHP >=8.3.0

Since Mar 27Pushed 2mo ago1 watchersCompare

[ Source](https://github.com/scottboms/kirby-link-scanner)[ Packagist](https://packagist.org/packages/scottboms/link-scanner)[ Docs](https://github.com/scottboms/kirby-link-scanner)[ RSS](/packages/scottboms-link-scanner/feed)WikiDiscussions main Synced 1w ago

READMEChangelog (4)Dependencies (2)Versions (5)Used By (0)

Link Scanner for Kirby
======================

[](#link-scanner-for-kirby)

[![Plugin Preview](src/assets/kirby-link-scanner-plugin.jpg)](src/assets/kirby-link-scanner-plugin.jpg)

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
------------

[](#installation)

### [Kirby CLI](https://github.com/getkirby/cli)

[](#kirby-cli)

```
kirby plugin:install scottboms/kirby-link-scanner
```

### Composer

[](#composer)

```
composer require scottboms/link-scanner
```

### Git submodule

[](#git-submodule)

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

### Copy and Paste

[](#copy-and-paste)

1. [Download](https://github.com/scottboms/kirby-link-scanner/archive/master.zip) 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
---------------------

[](#configuration-options)

PropertyDefaultReq?Descriptionscottboms.link-scanner.timeout`8`NoTimeout for the scanner processscottboms.link-scanner.userAgent`Kirby Link Scanner`NoSet a custom UserAgent stringExample Config:

```