Diplo.LinkChecker 1.3.0

Diplo Link Checker

Enables Umbraco editors to be able to check their Umbraco site for broken links.
Features

- Able to check an entire site, or just a section or even a single page
- Completely asychnronous so can check multiple links simultaneously and provide real-time feedback
- Caches link status so only checks each unique link once (within a short period)
- Works for all types of links - external, internal, HTML, files, images and even CSS and JavaScript files
- Provides feedback on errors with help dialogue and an overview of HTTP status codes
- Quick edit facilty allows you to easily edit the page that contains the broken link directly within Umbraco
- Advanced options allow you to set the timeout period, toggle between viewing all checked links and only links that have problems
- You can whitelist HTTP codes and only report on those
- You can also configure it to ignore ports (if you are behind a reverse proxy, for example)

Install-Package Diplo.LinkChecker -Version 1.3.0
dotnet add package Diplo.LinkChecker --version 1.3.0
<PackageReference Include="Diplo.LinkChecker" Version="1.3.0" />
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add Diplo.LinkChecker --version 1.3.0
The NuGet Team does not provide support for this client. Please contact its maintainers for support.

GETTING STARTED

Link Checker can be used to check for broken or invalid links within some or all of the pages within your Umbraco site.

To get started click Start Check and then select the page you want to start checking from. The checker will then start and will check your chosen page and all the descendant pages.

Note: The more pages you chose to check, the longer it will take. Checking your site in smaller sections might be a better idea for large sites.

CONFIGURATION

If you are a developer you can edit the config.js file in /App_Plugins/DiploLinkChecker/ folder to set the default values.

VIEWING RESULTS

The Checker will then display every page that has been checked and will indicate how many links have been checked (grey), how many are OK (green) and how many have errored (red). In the Action column you can also select to View the page that has been checked or Edit it within Umbraco.

You can then click View Results to display all the links that have been checked and their status.

To view more details about any link you can click it and a dialogue (like this one) will show you further details about the link and it's status.

INTERPRETING RESULTS

Not all links that are highlighted as problematic are necessarily "broken". Sometimes a link may be temporarily unavailable or a slow server might not respond in time.

Some servers might even reject the link checker request. It is always a good idea to manually check a link to see how it works for you or re-run the checker on the page for a second time.

OPTIONS

  • Only show errors - tick to just show pages and links that have been detected as problematic.

  • Check entire document - by default Link Checker just checks the main page body. To check the entire page, including hidden metadata, select this option.

  • Timeout - this is the value (in seconds) for how long Link Checker will wait for a server to respond. Higher values help eliminate "false positives" with slow loading pages but will make the checker take longer.

  • Show search box - ticking this option adds a search option above all links to help further filter the results

  • Only check internal links - tick to only check links within your website (ie. not external links to other sites)

  • Status codes - add a comma-separated list of HTTP status codes to limit results to just those codes eg. 404,500

GETTING STARTED

Link Checker can be used to check for broken or invalid links within some or all of the pages within your Umbraco site.

To get started click Start Check and then select the page you want to start checking from. The checker will then start and will check your chosen page and all the descendant pages.

Note: The more pages you chose to check, the longer it will take. Checking your site in smaller sections might be a better idea for large sites.

CONFIGURATION

If you are a developer you can edit the config.js file in /App_Plugins/DiploLinkChecker/ folder to set the default values.

VIEWING RESULTS

The Checker will then display every page that has been checked and will indicate how many links have been checked (grey), how many are OK (green) and how many have errored (red). In the Action column you can also select to View the page that has been checked or Edit it within Umbraco.

You can then click View Results to display all the links that have been checked and their status.

To view more details about any link you can click it and a dialogue (like this one) will show you further details about the link and it's status.

INTERPRETING RESULTS

Not all links that are highlighted as problematic are necessarily "broken". Sometimes a link may be temporarily unavailable or a slow server might not respond in time.

Some servers might even reject the link checker request. It is always a good idea to manually check a link to see how it works for you or re-run the checker on the page for a second time.

OPTIONS

  • Only show errors - tick to just show pages and links that have been detected as problematic.

  • Check entire document - by default Link Checker just checks the main page body. To check the entire page, including hidden metadata, select this option.

  • Timeout - this is the value (in seconds) for how long Link Checker will wait for a server to respond. Higher values help eliminate "false positives" with slow loading pages but will make the checker take longer.

  • Show search box - ticking this option adds a search option above all links to help further filter the results

  • Only check internal links - tick to only check links within your website (ie. not external links to other sites)

  • Status codes - add a comma-separated list of HTTP status codes to limit results to just those codes eg. 404,500

Version History

Version Downloads Last updated
1.3.0 477 7/25/2018